Merge pull request #16 from jaytaph/exception

Exception
jaytaph · Nov 17, 2014 · e5990ef · e5990ef
2 parents 9c1e46e + 17794ee
commit e5990ef
Show file tree

Hide file tree

Showing 7 changed files with 106 additions and 0 deletions.
diff --git a/DependencyInjection/Configuration.php b/DependencyInjection/Configuration.php
@@ -4,6 +4,7 @@
 
 use Symfony\Component\Config\Definition\Builder\TreeBuilder;
 use Symfony\Component\Config\Definition\ConfigurationInterface;
+use Symfony\Component\Config\Definition\Exception\InvalidConfigurationException;
 
 /**
  * This is the class that validates and merges configuration from your app/config files
@@ -41,6 +42,17 @@ public function getConfigTreeBuilder()
                     ->defaultValue(static::HTTP_TOO_MANY_REQUESTS)
                     ->info('The HTTP status code to return when a client hits the rate limit')
                 ->end()
+                ->scalarNode('rate_response_exception')
+                    ->defaultNull()
+                    ->info('Optional exception class that will be returned when a client hits the rate limit')
+                    ->validate()
+                        ->always(function ($item) {
+                            if (! is_subclass_of($item, '\Exception')) {
+                                throw new InvalidConfigurationException(sprintf("'%s' must inherit the \\Exception class", $item));
+                            }
+                        })
+                    ->end()
+                ->end()
                 ->scalarNode('rate_response_message')
                     ->defaultValue('You exceeded the rate limit')
                     ->info('The HTTP message to return when a client hits the rate limit')

diff --git a/DependencyInjection/NoxlogicRateLimitExtension.php b/DependencyInjection/NoxlogicRateLimitExtension.php
@@ -30,6 +30,7 @@ public function load(array $configs, ContainerBuilder $container)
 
     private function loadServices(ContainerBuilder $container, array $config)
     {
+        $container->setParameter('noxlogic_rate_limit.rate_response_exception', $config['rate_response_exception']);
         $container->setParameter('noxlogic_rate_limit.rate_response_code', $config['rate_response_code']);
         $container->setParameter('noxlogic_rate_limit.rate_response_message', $config['rate_response_message']);
 

diff --git a/EventListener/RateLimitAnnotationListener.php b/EventListener/RateLimitAnnotationListener.php
@@ -89,6 +89,13 @@ public function onKernelController(FilterControllerEvent $event)
 
         // When we exceeded our limit, return a custom error response
         if ($rateLimitInfo->getCalls() > $rateLimitInfo->getLimit()) {
+
+            // Throw an exception if configured.
+            if ($this->getParameter('rate_response_exception')) {
+                $class = $this->getParameter('rate_response_exception');
+                throw new $class($this->getParameter('rate_response_message'), $this->getParameter('rate_response_code'));
+            }
+
             $message = $this->getParameter('rate_response_message');
             $code = $this->getParameter('rate_response_code');
             $event->setController(function () use ($message, $code) {

diff --git a/README.md b/README.md
@@ -223,6 +223,13 @@ class RateLimitGenerateKeyListener
 
 Make sure to generate a key based on what is rate limited in your controllers.
 
+
+## Throwing exceptions
+
+Instead of returning a Response object when a rate limit has exceeded, it's also possible to throw an exception. This 
+allows you to easily handle the rate limit on another level, for instance by capturing the ``kernel.exception`` event. 
+
+
 ## Running tests
 
 If you want to run the tests use:

diff --git a/Resources/config/services.xml b/Resources/config/services.xml
@@ -43,6 +43,10 @@
                 <argument>rate_response_message</argument>
                 <argument>%noxlogic_rate_limit.rate_response_message%</argument>
             </call>
+            <call method="setParameter">
+                <argument>rate_response_exception</argument>
+                <argument>%noxlogic_rate_limit.rate_response_exception%</argument>
+            </call>
         </service>
 
         <service id="noxlogic_rate_limit.header_modification_listener" class="%noxlogic_rate_limit.header_modification_listener.class%">

diff --git a/Tests/DependencyInjection/ConfigurationTest.php b/Tests/DependencyInjection/ConfigurationTest.php
@@ -38,6 +38,7 @@ public function testUnconfiguredConfiguration()
             'redis_client' => 'default_client',
             'memcache_client' => 'default',
             'rate_response_code' => 429,
+            'rate_response_exception' => null,
             'rate_response_message' => 'You exceeded the rate limit',
             'display_headers' => true,
             'headers' => array(
@@ -126,4 +127,25 @@ public function testDefaultPathLimitMethods()
         $this->assertArrayHasKey('path_limits', $configuration);
         $this->assertEquals($pathLimits, $configuration['path_limits']);
     }
+
+    /**
+     * @expectedException \Symfony\Component\Config\Definition\Exception\InvalidConfigurationException
+     */
+    public function testMustBeBasedOnExceptionClass()
+    {
+        $configuration = $this->getConfigs(array('rate_response_exception' => '\StdClass'));
+    }
+
+    /**
+     *
+     */
+    public function testMustBeBasedOnExceptionClass2()
+    {
+        $configuration = $this->getConfigs(array('rate_response_exception' => '\InvalidArgumentException'));
+
+        # no exception triggered is ok.
+        $this->assertTrue(true);
+    }
+
+
 }
diff --git a/Tests/EventListener/RateLimitAnnotationListenerTest.php b/Tests/EventListener/RateLimitAnnotationListenerTest.php
@@ -9,6 +9,7 @@
 use Noxlogic\RateLimitBundle\Tests\TestCase;
 use ReflectionMethod;
 use Symfony\Component\HttpFoundation\Request;
+use Symfony\Component\HttpFoundation\Response;
 use Symfony\Component\HttpKernel\Event\FilterControllerEvent;
 use Symfony\Component\HttpKernel\HttpKernelInterface;
 
@@ -326,4 +327,56 @@ protected function createListener($expects)
             $this->mockPathLimitProcessor
         );
     }
+
+
+    /**
+     * @expectedException \BadFunctionCallException
+     * @expectedExceptionCode 123
+     * @expectedExceptionMessage a message
+     */
+    public function testRateLimitThrottlingWithException()
+    {
+        $listener = $this->createListener($this->any());
+        $listener->setParameter('rate_response_exception', '\BadFunctionCallException');
+        $listener->setParameter('rate_response_code', 123);
+        $listener->setParameter('rate_response_message', 'a message');
+
+        $event = $this->createEvent();
+        $event->getRequest()->attributes->set('_x-rate-limit', array(
+                new RateLimit(array('limit' => 5, 'period' => 3)),
+        ));
+
+        // Throttled
+        $storage = $this->getMockStorage();
+        $storage->createMockRate(':Noxlogic\RateLimitBundle\EventListener\Tests\MockController:mockAction', 5, 10, 6);
+        $listener->onKernelController($event);
+    }
+
+    public function testRateLimitThrottlingWithMessages()
+    {
+        $listener = $this->createListener($this->any());
+        $listener->setParameter('rate_response_code', 123);
+        $listener->setParameter('rate_response_message', 'a message');
+
+        $event = $this->createEvent();
+        $event->getRequest()->attributes->set('_x-rate-limit', array(
+                new RateLimit(array('limit' => 5, 'period' => 3)),
+        ));
+
+        // Throttled
+        $storage = $this->getMockStorage();
+        $storage->createMockRate(':Noxlogic\RateLimitBundle\EventListener\Tests\MockController:mockAction', 5, 10, 6);
+
+        /** @var Response $response */
+        $listener->onKernelController($event);
+
+        // Call the controller, it will return a response object
+        $a = $event->getController();
+        $response = $a();
+
+        $this->assertEquals($response->getStatusCode(), 123);
+        $this->assertEquals($response->getContent(), "a message");
+    }
+
+
 }