Resolve string based throttles from the container and properly type-hint against the contract.

Signed-off-by: Jason Lewis <[email protected]>

Author: jasonlewis

src/Http/RateLimit/Handler.php

@@ -6,6 +6,8 @@
 use Illuminate\Cache\CacheManager;
 use Illuminate\Support\Collection;
 use Illuminate\Container\Container;
+use Dingo\Api\Http\RateLimit\Throttle\Route;
+use Dingo\Api\Contract\Http\RateLimit\Throttle;
 
 class Handler
 {
@@ -33,7 +35,7 @@ class Handler
     /**
      * Throttle used for rate limiting.
      *
-     * @var \Dingo\Api\Http\RateLimit\Throttle\Throttle
+     * @var \Dingo\Api\Contract\Http\RateLimit\Throttle
      */
     protected $throttle;
 
@@ -89,14 +91,14 @@ public function rateLimitRequest(Request $request, $limit = 0, $expires = 0)
 
         // If the throttle instance is already set then we'll just carry on as
         // per usual.
-        if ($this->throttle instanceof Throttle\Throttle) {
+        if ($this->throttle instanceof Throttle) {
             //
 
         // If the developer specified a certain amount of requests or expiration
         // time on a specific route then we'll always use the route specific
         // throttle with the given values.
         } elseif ($limit > 0 || $expires > 0) {
-            $this->throttle = new Throttle\Route(['limit' => $limit, 'expires' => $expires]);
+            $this->throttle = new Route(['limit' => $limit, 'expires' => $expires]);
 
             $this->keyPrefix = md5($request->path());
 
@@ -256,7 +258,7 @@ public function setRateLimiter(callable $limiter)
     /**
      * Set the throttle to use for rate limiting.
      *
-     * @param string|\Dingo\Api\Http\RateLimit\Throttle\Throttle
+     * @param string|\Dingo\Api\Contract\Http\RateLimit\Throttle
      *
      * @return void
      */
@@ -272,7 +274,7 @@ public function setThrottle($throttle)
     /**
      * Get the throttle used to rate limit the request.
      *
-     * @return \Dingo\Api\Http\RateLimit\Throttle\Throttle
+     * @return \Dingo\Api\Contract\Http\RateLimit\Throttle
      */
     public function getThrottle()
     {

src/Routing/Route.php

@@ -167,6 +167,10 @@ protected function setupThrottle()
         $this->findControllerOptions('throttles', function ($value) {
             $this->throttle = $value['throttle'];
         });
+
+        if (is_string($this->throttle)) {
+            $this->throttle = $this->container->make($this->throttle);
+        }
     }
 
     /**

tests/Routing/RouteTest.php

@@ -34,7 +34,7 @@ public function testCreatingNewRoute()
                 'providers' => ['foo'],
                 'limit' => 5,
                 'expires' => 10,
-                'throttle' => 'Foo',
+                'throttle' => 'Dingo\Api\Tests\Stubs\BasicThrottleStub',
                 'version' => ['v1'],
                 'conditionalRequest' => false,
             ],
@@ -45,7 +45,7 @@ public function testCreatingNewRoute()
         $this->assertEquals(5, $route->getRateLimit(), 'Route did not setup rate limit correctly.');
         $this->assertEquals(10, $route->getRateExpiration(), 'Route did not setup rate limit expiration correctly.');
         $this->assertTrue($route->hasThrottle(), 'Route did not setup throttle correctly.');
-        $this->assertEquals('Foo', $route->getThrottle(), 'Route did not setup throttle correctly.');
+        $this->assertInstanceOf('Dingo\Api\Tests\Stubs\BasicThrottleStub', $route->getThrottle(), 'Route did not setup throttle correctly.');
         $this->assertFalse($route->requestIsConditional(), 'Route did not setup conditional request correctly.');
     }
 
@@ -73,6 +73,6 @@ public function testControllerOptionsMergeAndOverrideRouteOptions()
         $this->assertEquals(10, $route->getRateLimit(), 'Route did not setup rate limit correctly.');
         $this->assertEquals(20, $route->getRateExpiration(), 'Route did not setup rate limit expiration correctly.');
         $this->assertTrue($route->hasThrottle(), 'Route did not setup throttle correctly.');
-        $this->assertEquals('Zippy', $route->getThrottle(), 'Route did not setup throttle correctly.');
+        $this->assertInstanceOf('Dingo\Api\Tests\Stubs\BasicThrottleStub', $route->getThrottle(), 'Route did not setup throttle correctly.');
     }
 }

tests/Routing/RouterTest.php

@@ -6,6 +6,7 @@
 use Dingo\Api\Http;
 use Dingo\Api\Routing\Router;
 use Illuminate\Container\Container;
+use Dingo\Api\Tests\Stubs\ThrottleStub;
 use Symfony\Component\HttpKernel\Exception\HttpException;
 
 class RouterTest extends Adapter\BaseAdapterTest
@@ -41,7 +42,7 @@ public function testRouteOptionsMergeCorrectly()
         $request = $this->createRequest('baz', 'GET', ['accept' => 'application/vnd.api.v1+json']);
         $this->router->dispatch($request);
 
-        $this->router->version('v2', ['providers' => 'foo', 'throttle' => 'Bar', 'namespace' => 'Dingo\Api\Tests'], function () {
+        $this->router->version('v2', ['providers' => 'foo', 'throttle' => new ThrottleStub(['limit' => 10, 'expires' => 15]), 'namespace' => 'Dingo\Api\Tests'], function () {
             $this->router->get('foo', 'Stubs\RoutingControllerStub@index');
         });
 
@@ -54,7 +55,7 @@ public function testRouteOptionsMergeCorrectly()
         $this->assertEquals(['foo', 'red', 'black'], $route->getAuthProviders());
         $this->assertEquals(10, $route->getRateLimit());
         $this->assertEquals(20, $route->getRateExpiration());
-        $this->assertEquals('Zippy', $route->getThrottle());
+        $this->assertInstanceOf('Dingo\Api\Tests\Stubs\BasicThrottleStub', $route->getThrottle());
     }
 
     /**

tests/Stubs/BasicThrottleStub.php

@@ -0,0 +1,24 @@
+<?php
+
+namespace Dingo\Api\Tests\Stubs;
+
+use Illuminate\Container\Container;
+use Dingo\Api\Contract\Http\RateLimit\Throttle;
+
+class BasicThrottleStub implements Throttle
+{
+    public function match(Container $app)
+    {
+        return true;
+    }
+
+    public function getLimit()
+    {
+        return 15;
+    }
+
+    public function getExpires()
+    {
+        return 10;
+    }
+}

tests/Stubs/RoutingControllerStub.php

@@ -17,7 +17,7 @@ public function __construct()
 
         $this->rateLimit(10, 20);
 
-        $this->throttle('Zippy');
+        $this->throttle('Dingo\Api\Tests\Stubs\BasicThrottleStub');
     }
 
     public function index()