Allow access to rate limiter headers

Author: Dominic Scheirlinck

src/IntercomClient.php

@@ -55,6 +55,9 @@ class IntercomClient
     /** @var IntercomNotes $notes */
     public $notes;
 
+    /** @var int[] $rateLimitDetails */
+    protected $rateLimitDetails;
+
     /**
      * IntercomClient constructor.
      * @param string $usernamePart App ID.
@@ -202,8 +205,37 @@ public function getAuth()
      */
     private function handleResponse(Response $response)
     {
+        $this->setRateLimitDetails($response);
+
         $stream = stream_for($response->getBody());
         $data = json_decode($stream);
         return $data;
     }
+
+    /**
+     * @param Response $response
+     * @return void
+     */
+    private function setRateLimitDetails(Response $response)
+    {
+        $this->rateLimitDetails = [
+            'limit' => $response->hasHeader('X-RateLimit-Limit')
+                ? (int)$response->getHeader('X-RateLimit-Limit')
+                : null,
+            'remaining' => $response->hasHeader('X-RateLimit-Remaining')
+                ? (int)$response->getHeader('X-RateLimit-Remaining')
+                : null,
+            'reset_at' => $response->hasHeader('X-RateLimit-Reset')
+                ? (new \DateTimeImmutable())->setTimestamp((int)$response->getHeader('X-RateLimit-Reset'))
+                : null,
+        ];
+    }
+
+    /**
+     * @return int[]
+     */
+    public function getRateLimitDetails()
+    {
+        return $this->rateLimitDetails;
+    }
 }

test/IntercomClientTest.php

@@ -61,4 +61,30 @@ public function testPaginationHelper()
     }
   }
 
+  public function testRateLimitDetails()
+  {
+    $mock = new MockHandler([
+        new Response(200, ['X-RateLimit-Limit' => '83', 'X-RateLimit-Remaining' => '2', 'X-RateLimit-Reset' => time() + 7], "{\"foo\":\"bar\"}")
+    ]);
+
+    $container = [];
+    $history = Middleware::history($container);
+    $stack = HandlerStack::create($mock);
+    $stack->push($history);
+
+    $http_client = new Client(['handler' => $stack]);
+
+    $client = new IntercomClient('u', 'p');
+    $client->setClient($http_client);
+
+    $client->users->create([
+        'email' => '[email protected]'
+    ]);
+
+    $rateLimitDetails = $client->getRateLimitDetails();
+    $this->assertInternalType('array', $rateLimitDetails);
+    $this->assertArrayHasKey('limit', $rateLimitDetails);
+    $this->assertArrayHasKey('remaining', $rateLimitDetails);
+    $this->assertArrayHasKey('reset_at', $rateLimitDetails);
+  }
 }