Add custom period of blocking time

Annotation/RateLimit.php

@@ -26,6 +26,11 @@ class RateLimit extends ConfigurationAnnotation
      */
     protected $period = 3600;
 
+    /**
+     * @var int Amount of seconds when the calls aren't available
+     */
+    protected $blockPeriod = 0;
+
     /**
      * Returns the alias name for an annotated configuration.
      *
@@ -93,4 +98,20 @@ public function setPeriod($period)
     {
         $this->period = $period;
     }
+
+    /**
+     * @return int
+     */
+    public function getBlockPeriod()
+    {
+        return $this->blockPeriod;
+    }
+
+    /**
+     * @param int $blockPeriod
+     */
+    public function setBlockPeriod($blockPeriod)
+    {
+        $this->blockPeriod = $blockPeriod;
+    }
 }

DependencyInjection/Configuration.php

@@ -129,6 +129,10 @@ public function getConfigTreeBuilder()
                                 ->isRequired()
                                 ->min(0)
                             ->end()
+                            ->integerNode('block_period')
+                                ->defaultValue(0)
+                                ->min(0)
+                            ->end()
                         ->end()
                     ->end()
                 ->end()

EventListener/RateLimitAnnotationListener.php

@@ -3,7 +3,9 @@
 namespace Noxlogic\RateLimitBundle\EventListener;
 
 use Noxlogic\RateLimitBundle\Annotation\RateLimit;
+use Noxlogic\RateLimitBundle\Events\BlockEvent;
 use Noxlogic\RateLimitBundle\Events\GenerateKeyEvent;
+use Noxlogic\RateLimitBundle\Events\GetResponseEvent;
 use Noxlogic\RateLimitBundle\Events\RateLimitEvents;
 use Noxlogic\RateLimitBundle\Service\RateLimitService;
 use Noxlogic\RateLimitBundle\Util\PathLimitProcessor;
@@ -40,6 +42,7 @@ public function __construct(
         RateLimitService $rateLimitService,
         PathLimitProcessor $pathLimitProcessor
     ) {
+        //todo:use an event dispatcher passed into onKernelController
         $this->eventDispatcher = $eventDispatcher;
         $this->rateLimitService = $rateLimitService;
         $this->pathLimitProcessor = $pathLimitProcessor;
@@ -89,7 +92,7 @@ public function onKernelController(FilterControllerEvent $event)
         $request->attributes->set('rate_limit_info', $rateLimitInfo);
 
         // Reset the rate limits
-        if(time() >= $rateLimitInfo->getResetTimestamp()) {
+        if(!$rateLimitInfo->isBlocked() && time() >= $rateLimitInfo->getResetTimestamp()) {
             $this->rateLimitService->resetRate($key);
             $rateLimitInfo = $this->rateLimitService->createRate($key, $rateLimit->getLimit(), $rateLimit->getPeriod());
             if (! $rateLimitInfo) {
@@ -100,19 +103,35 @@ public function onKernelController(FilterControllerEvent $event)
         }
 
         // When we exceeded our limit, return a custom error response
-        if ($rateLimitInfo->getCalls() > $rateLimitInfo->getLimit()) {
+        if (!$rateLimitInfo->isBlocked() && $rateLimitInfo->getCalls() > $rateLimitInfo->getLimit()) {
+            $this->rateLimitService->setBlock(
+                $rateLimitInfo,
+                $rateLimit->getBlockPeriod() > 0 ? $rateLimit->getBlockPeriod() : $rateLimit->getPeriod()
+            );
+            $this->eventDispatcher->dispatch(RateLimitEvents::BLOCK_AFTER, new BlockEvent($rateLimitInfo, $request));
+        }
 
+        if ($rateLimitInfo->isBlocked()) {
             // 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) {
+            $response = new Response(
+                $this->getParameter('rate_response_message'),
+                $this->getParameter('rate_response_code')
+            );
+
+            $eventResponse = new GetResponseEvent($request, $rateLimitInfo);
+            $this->eventDispatcher->dispatch(RateLimitEvents::RESPONSE_SENDING_BEFORE, $eventResponse);
+            if ($eventResponse->hasResponse()) {
+                $response = $eventResponse->getResponse();
+            }
+
+            $event->setController(function () use ($response) {
                 // @codeCoverageIgnoreStart
-                return new Response($message, $code);
+                return $response;
                 // @codeCoverageIgnoreEnd
             });
             $event->stopPropagation();

Events/BlockEvent.php

@@ -0,0 +1,49 @@
+<?php
+
+namespace Noxlogic\RateLimitBundle\Events;
+
+use Noxlogic\RateLimitBundle\Service\RateLimitInfo;
+use Symfony\Component\EventDispatcher\Event;
+use Symfony\Component\HttpFoundation\Request;
+
+class BlockEvent extends Event
+{
+    /**
+     * @var RateLimitInfo
+     */
+    private $rateLimitInfo;
+
+    /**
+     * @var Request
+     */
+    private $request;
+
+    /**
+     * BlockEvent constructor.
+     *
+     * @param RateLimitInfo $rateLimitInfo
+     * @param Request       $request
+     */
+    public function __construct(RateLimitInfo $rateLimitInfo, Request $request)
+    {
+        $this->rateLimitInfo = $rateLimitInfo;
+        $this->request = $request;
+    }
+
+
+    /**
+     * @return RateLimitInfo
+     */
+    public function getRateLimitInfo()
+    {
+        return $this->rateLimitInfo;
+    }
+
+    /**
+     * @return Request
+     */
+    public function getRequest()
+    {
+        return $this->request;
+    }
+}

Events/GetResponseEvent.php

@@ -0,0 +1,79 @@
+<?php
+
+namespace Noxlogic\RateLimitBundle\Events;
+
+use Noxlogic\RateLimitBundle\Service\RateLimitInfo;
+use Symfony\Component\EventDispatcher\Event;
+use Symfony\Component\HttpFoundation\Request;
+use Symfony\Component\HttpFoundation\Response;
+
+class GetResponseEvent extends Event
+{
+    /**
+     * @var Response
+     */
+    private $response;
+
+    /**
+     * @var Request
+     */
+    private $request;
+
+    /**
+     * @var RateLimitInfo
+     */
+    private $rateLimitInfo;
+
+    /**
+     * GetResponseEvent constructor.
+     *
+     * @param Request       $request
+     * @param RateLimitInfo $rateLimitInfo
+     */
+    public function __construct(Request $request, RateLimitInfo $rateLimitInfo)
+    {
+        $this->request = $request;
+        $this->rateLimitInfo = $rateLimitInfo;
+    }
+
+
+    /**
+     * @return Response
+     */
+    public function getResponse()
+    {
+        return $this->response;
+    }
+
+    /**
+     * @param Response $response
+     */
+    public function setResponse(Response $response)
+    {
+        $this->response = $response;
+    }
+
+    /**
+     * @return bool
+     */
+    public function hasResponse()
+    {
+        return null !== $this->response;
+    }
+
+    /**
+     * @return Request
+     */
+    public function getRequest()
+    {
+        return $this->request;
+    }
+
+    /**
+     * @return RateLimitInfo
+     */
+    public function getRateLimitInfo()
+    {
+        return $this->rateLimitInfo;
+    }
+}

Events/RateLimitEvents.php

@@ -4,5 +4,18 @@
 
 final class RateLimitEvents
 {
-        const GENERATE_KEY = 'ratelimit.generate.key';
+    /**
+     * This event is dispatched when generating a key is doing
+     */
+    const GENERATE_KEY = 'ratelimit.generate.key';
+
+    /**
+     * This event is dispatched after a block happened
+     */
+    const BLOCK_AFTER = 'ratelimit.block.after';
+
+    /**
+     * This event is dispatched before response is sent
+     */
+    const RESPONSE_SENDING_BEFORE = 'ratelimit.response.sending.before';
 }