Merge pull request #149 from DexterHarrison/3.x

Add Exception for Exceeding Forge API Rate Limit

Author: jbrooksuk

src/Exceptions/RateLimitExceededException.php

@@ -0,0 +1,28 @@
+<?php
+
+namespace Laravel\Forge\Exceptions;
+
+use Exception;
+
+class RateLimitExceededException extends Exception
+{
+    /**
+     * The timestamp that the rate limit will be reset.
+     *
+     * @var int|null
+     */
+    public $rateLimitResetsAt;
+
+    /**
+     * Create a new exception instance.
+     *
+     * @param  int|null  $rateLimitReset
+     * @return void
+     */
+    public function __construct($rateLimitReset)
+    {
+        parent::__construct('Too Many Requests.');
+
+        $this->rateLimitResetsAt = $rateLimitReset;
+    }
+}

src/MakesHttpRequests.php

@@ -5,6 +5,7 @@
 use Exception;
 use Laravel\Forge\Exceptions\FailedActionException;
 use Laravel\Forge\Exceptions\NotFoundException;
+use Laravel\Forge\Exceptions\RateLimitExceededException;
 use Laravel\Forge\Exceptions\TimeoutException;
 use Laravel\Forge\Exceptions\ValidationException;
 use Psr\Http\Message\ResponseInterface;
@@ -97,6 +98,7 @@ protected function request($verb, $uri, array $payload = [])
      * @throws \Laravel\Forge\Exceptions\FailedActionException
      * @throws \Laravel\Forge\Exceptions\NotFoundException
      * @throws \Laravel\Forge\Exceptions\ValidationException
+     * @throws \Laravel\Forge\Exceptions\RateLimitExceededException
      */
     protected function handleRequestError(ResponseInterface $response)
     {
@@ -112,6 +114,14 @@ protected function handleRequestError(ResponseInterface $response)
             throw new FailedActionException((string) $response->getBody());
         }
 
+        if ($response->getStatusCode() === 429) {
+            throw new RateLimitExceededException(
+                $response->hasHeader('x-ratelimit-reset')
+                    ? (int) $response->getHeader('x-ratelimit-reset')[0]
+                    : null
+            );
+        }
+
         throw new Exception((string) $response->getBody());
     }
 

tests/ForgeSDKTest.php

@@ -6,6 +6,7 @@
 use GuzzleHttp\Psr7\Response;
 use Laravel\Forge\Exceptions\FailedActionException;
 use Laravel\Forge\Exceptions\NotFoundException;
+use Laravel\Forge\Exceptions\RateLimitExceededException;
 use Laravel\Forge\Exceptions\TimeoutException;
 use Laravel\Forge\Exceptions\ValidationException;
 use Laravel\Forge\Forge;
@@ -174,4 +175,38 @@ public function testRetryHandlesFalseyArrayResultFromClosure()
             $this->assertSame([], $e->output());
         }
     }
+
+    public function testRateLimitExceededWithHeaderSet()
+    {
+        $forge = new Forge('123', $http = Mockery::mock(Client::class));
+
+        $timestamp = strtotime(date('Y-m-d H:i:s'));
+
+        $http->shouldReceive('request')->once()->with('GET', 'recipes', [])->andReturn(
+            new Response(429, [
+                'x-ratelimit-reset' => $timestamp,
+            ], 'Too Many Attempts.')
+        );
+
+        try {
+            $forge->recipes();
+        } catch (RateLimitExceededException $e) {
+            $this->assertSame($timestamp, $e->rateLimitResetsAt);
+        }
+    }
+
+    public function testRateLimitExceededWithHeaderNotAvailable()
+    {
+        $forge = new Forge('123', $http = Mockery::mock(Client::class));
+
+        $http->shouldReceive('request')->once()->with('GET', 'recipes', [])->andReturn(
+            new Response(429, [], 'Too Many Attempts.')
+        );
+
+        try {
+            $forge->recipes();
+        } catch (RateLimitExceededException $e) {
+            $this->assertNull($e->rateLimitResetsAt);
+        }
+    }
 }