Merge pull request sendgrid#23 from budirec/feature/rate_limi

Automatically retry when rate limit is reached

Author: thinkingserious

Diff for: examples/example.php

@@ -18,6 +18,15 @@
 echo $response->body();
 echo $response->headers();
 
+// GET with auto retry on rate limit
+$query_params = ['limit' => 100, 'offset' => 0];
+$request_headers = ['X-Mock: 200'];
+$retryOnLimit = true;
+$response = $client->api_keys()->get(null, $query_params, $request_headers, $retryOnLimit);
+echo $response->statusCode();
+echo $response->body();
+echo $response->headers();
+
 // POST
 $request_body = [
     'name' => 'My PHP API Key',

Diff for: lib/Client.php

@@ -32,17 +32,20 @@ class Client
     protected $curlOptions;
     /** @var array */
     private $methods;
+    /** @var bool */
+    private $retryOnLimit;
 
     /**
       * Initialize the client
       *
-      * @param string $host        the base url (e.g. https://api.sendgrid.com)
-      * @param array  $headers     global request headers
-      * @param string $version     api version (configurable)
-      * @param array  $path        holds the segments of the url path
-      * @param array  $curlOptions extra options to set during curl initialization
+      * @param string  $host          the base url (e.g. https://api.sendgrid.com)
+      * @param array   $headers       global request headers
+      * @param string  $version       api version (configurable)
+      * @param array   $path          holds the segments of the url path
+      * @param array   $curlOptions   extra options to set during curl initialization
+      * @param bool    $retryOnLimit  set default retry on limit flag
       */
-    public function __construct($host, $headers = null, $version = null, $path = null, $curlOptions = null)
+    public function __construct($host, $headers = null, $version = null, $path = null, $curlOptions = null, $retryOnLimit = false)
     {
         $this->host = $host;
         $this->headers = $headers ?: [];
@@ -51,6 +54,8 @@ public function __construct($host, $headers = null, $version = null, $path = nul
         $this->curlOptions = $curlOptions ?: [];
         // These are the supported HTTP verbs
         $this->methods = ['delete', 'get', 'patch', 'post', 'put'];
+
+        $this->retryOnLimit = $retryOnLimit;
     }
 
     /**
@@ -134,10 +139,11 @@ private function buildUrl($queryParams = null)
       * @param string $url     the final url to call
       * @param array  $body    request body
       * @param array  $headers any additional request headers
+      * @param bool   $retryOnLimit should retry if rate limit is reach?
       *
       * @return Response object
       */
-    public function makeRequest($method, $url, $body = null, $headers = null)
+    public function makeRequest($method, $url, $body = null, $headers = null, $retryOnLimit = false)
     {
         $curl = curl_init($url);
 
@@ -169,8 +175,17 @@ public function makeRequest($method, $url, $body = null, $headers = null)
         $responseHeaders = array_map('trim', $responseHeaders);
 
         curl_close($curl);
+     
+        $response = new Response($statusCode, $responseBody, $responseHeaders);
+
+        if ($statusCode == 429 && $retryOnLimit) {
+            $headers = $response->headers(true);
+            $sleepDurations = $headers['X-Ratelimit-Reset'] - time();
+            sleep($sleepDurations > 0 ? $sleepDurations : 0);
+            return $this->makeRequest($method, $url, $body, $headers, false);
+        }
 
-        return new Response($statusCode, $responseBody, $responseHeaders);
+        return $response;
     }
 
     /**
@@ -211,7 +226,8 @@ public function __call($name, $args)
             $queryParams = isset($args[1]) ? $args[1] : null;
             $url = $this->buildUrl($queryParams);
             $headers = isset($args[2]) ? $args[2] : null;
-            return $this->makeRequest($name, $url, $body, $headers);
+            $retryOnLimit = isset($args[3]) ? $args[3] : $this->retryOnLimit;
+            return $this->makeRequest($name, $url, $body, $headers, $retryOnLimit);
         }
 
         return $this->_($name);

Diff for: test/unit/MockClient.php

@@ -10,11 +10,11 @@ class MockClient extends Client
     protected $requestHeaders;
     protected $url;
 
-    public function makeRequest($method, $url, $requestBody = null, $requestHeaders = null)
+    public function makeRequest($method, $url, $requestBody = null, $requestHeaders = null, $retryOnLimit = false)
     {
         $this->requestBody = $requestBody;
         $this->requestHeaders = $requestHeaders;
         $this->url = $url;
         return $this;
     }
-}
+}