Merge pull request dingo#1202 from lucasmichot/feature/master/rfc8565

Update RateLimit exception response to RFC6585 specifications

Author: hskrasek

src/Exception/RateLimitExceededException.php

@@ -0,0 +1,28 @@
+<?php
+
+namespace Dingo\Api\Exception;
+
+use Exception;
+use Symfony\Component\HttpKernel\Exception\HttpException;
+
+class RateLimitExceededException extends HttpException
+{
+    /**
+     * Create a new rate limit exceeded exception instance.
+     *
+     * @param string     $message
+     * @param \Exception $previous
+     * @param array      $headers
+     * @param int        $code
+     *
+     * @return void
+     */
+    public function __construct($message = null, Exception $previous = null, $headers = [], $code = 0)
+    {
+        if (array_key_exists('X-RateLimit-Reset', $headers)) {
+            $headers['Retry-After'] = $headers['X-RateLimit-Reset'] - time();
+        }
+
+        parent::__construct(429, $message ?: 'You have exceeded your rate limit.', $previous, $headers, $code);
+    }
+}

src/Http/Middleware/RateLimit.php

@@ -7,7 +7,7 @@
 use Dingo\Api\Routing\Router;
 use Dingo\Api\Http\InternalRequest;
 use Dingo\Api\Http\RateLimit\Handler;
-use Symfony\Component\HttpKernel\Exception\HttpException;
+use Dingo\Api\Exception\RateLimitExceededException;
 
 class RateLimit
 {
@@ -64,7 +64,7 @@ public function handle($request, Closure $next)
         $this->handler->rateLimitRequest($request, $route->getRateLimit(), $route->getRateLimitExpiration());
 
         if ($this->handler->exceededRateLimit()) {
-            throw new HttpException(403, 'You have exceeded your rate limit.', null, $this->getHeaders());
+            throw new RateLimitExceededException('You have exceeded your rate limit.', null, $this->getHeaders());
         }
 
         $response = $next($request);

tests/Http/Middleware/RateLimitTest.php

@@ -14,6 +14,7 @@
 use Dingo\Api\Http\RateLimit\Handler;
 use Dingo\Api\Tests\Stubs\ThrottleStub;
 use Dingo\Api\Http\Middleware\RateLimit;
+use Dingo\Api\Exception\RateLimitExceededException;
 use Symfony\Component\HttpKernel\Exception\HttpException;
 
 class RateLimitTest extends PHPUnit_Framework_TestCase
@@ -125,11 +126,15 @@ public function testRateLimitingFailsAndHeadersAreSetOnException()
                 return new Response('foo');
             });
         } catch (HttpException $exception) {
-            $this->assertSame(403, $exception->getStatusCode());
+            $this->assertInstanceOf(RateLimitExceededException::class, $exception);
+            $this->assertSame(429, $exception->getStatusCode());
             $this->assertSame('You have exceeded your rate limit.', $exception->getMessage());
-            $this->assertArrayHasKey('X-RateLimit-Limit', $exception->getHeaders());
-            $this->assertArrayHasKey('X-RateLimit-Remaining', $exception->getHeaders());
-            $this->assertArrayHasKey('X-RateLimit-Reset', $exception->getHeaders());
+
+            $headers = $exception->getHeaders();
+            $this->assertSame($headers['X-RateLimit-Reset'] - time(), $headers['Retry-After']);
+            $this->assertArrayHasKey('X-RateLimit-Limit', $headers);
+            $this->assertArrayHasKey('X-RateLimit-Remaining', $headers);
+            $this->assertArrayHasKey('X-RateLimit-Reset', $headers);
         }
     }