Merge pull request #72 from GetStream/feature/ratelimitinfo

Add ratelimit methods to StreamFeedException

Author: tbarbugli

README.md

@@ -174,6 +174,23 @@ $token = $userFeed->getToken();
 $readonlyToken = $userFeed->getReadonlyToken();
 ```
 
+RateLimits:
+
+If your app hits a ratelimit, a StreamFeedException is thrown. You can
+get additional info by catching the exception and calling the
+following methods:
+
+```php
+
+try {
+    $client->updateActivity($activity);
+}catch(StreamFeedException $e){
+    $limit = $e->getRateLimitLimit();
+    $remaining = $e->getRateLimitRemaining();
+    $reset = $e->getRateLimitReset(); // a unix timestamp
+}
+```
+
 Again, our full documentation with all options and methods, is available at [https://getstream.io/docs/php/](https://getstream.io/docs/php/).
 
 ### Framework integration

lib/GetStream/Stream/Collections.php

@@ -69,7 +69,11 @@ public function select($collectionName, array $ids)
         try {
             $response = $this->client->request('GET', 'meta/?'.http_build_query($queryParams));
         } catch (ClientException $e) {
-            throw new StreamFeedException($e->getResponse()->getBody());
+            $response = $e->getResponse();
+            $msg = $response->getBody();
+            $code = $response->getStatusCode();
+            $previous = $e;
+            throw new StreamFeedException($msg, $code, $previous);
         }
 
         $body = $response->getBody()->getContents();
@@ -90,7 +94,11 @@ public function upsert($collectionName, array $data)
         try {
             $response = $this->client->request('POST', 'meta/', $options);
         } catch (ClientException $e) {
-            throw new StreamFeedException($e->getResponse()->getBody());
+            $response = $e->getResponse();
+            $msg = $response->getBody();
+            $code = $response->getStatusCode();
+            $previous = $e;
+            throw new StreamFeedException($msg, $code, $previous);
         }
 
         $body = $response->getBody()->getContents();
@@ -112,7 +120,11 @@ public function delete($collectionName, array $ids)
         try {
             $response = $this->client->request('DELETE', 'meta/?'.http_build_query($queryParams));
         } catch (ClientException $e) {
-            throw new StreamFeedException($e->getResponse()->getBody());
+            $response = $e->getResponse();
+            $msg = $response->getBody();
+            $code = $response->getStatusCode();
+            $previous = $e;
+            throw new StreamFeedException($msg, $code, $previous);
         }
 
         $body = $response->getBody()->getContents();

lib/GetStream/Stream/Feed.php

@@ -97,7 +97,11 @@ public function makeHttpRequest($uri, $method, $data = [], $query_params = [], $
         try {
             $response = $client->request($method, $uri, $options);
         } catch (ClientException $e) {
-            throw new StreamFeedException($e->getResponse()->getBody());
+            $response = $e->getResponse();
+            $msg = $response->getBody();
+            $code = $response->getStatusCode();
+            $previous = $e;
+            throw new StreamFeedException($msg, $code, $previous);
         }
 
         $body = $response->getBody()->getContents();

lib/GetStream/Stream/Personalization.php

@@ -94,7 +94,11 @@ private function request($method, $resource, array $params)
         try {
             $response = $this->client->request($method, $uri);
         } catch (ClientException $e) {
-            throw new StreamFeedException($e->getResponse()->getBody());
+            $response = $e->getResponse();
+            $msg = $response->getBody();
+            $code = $response->getStatusCode();
+            $previous = $e;
+            throw new StreamFeedException($msg, $code, $previous);
         }
 
         $body = $response->getBody()->getContents();

lib/GetStream/Stream/StreamFeedException.php

@@ -3,4 +3,31 @@
 
 class StreamFeedException extends \Exception
 {
+
+    private function getRateLimitValue($headerName){
+        /* Sample headers
+
+           x-ratelimit-limit: 2000
+           x-ratelimit-remaining: 1998
+           x-ratelimit-reset: 1543604520
+
+        */
+        $e = $this->getPrevious();
+        if($e){
+            return (string)$e->getResponse()->getHeader("x-ratelimit-" . $headerName)[0];
+        }
+    }
+
+    public function getRateLimitLimit(){
+        return $this->getRateLimitValue("limit");
+    }
+
+    public function getRateLimitRemaining(){
+        return $this->getRateLimitValue("remaining");
+    }
+
+    public function getRateLimitReset(){
+        return $this->getRateLimitValue("reset");
+    }
+
 }