Adjusted code structure, added translations, adjusted documentation, added basic tests, adjusted dependencies and package naming (#3)

Adjusted code structure, added translations, adjusted documentation, added basic tests, adjusted dependencies and package naming

Author: nowiko

.travis-memcached.ini

@@ -0,0 +1 @@
+extension="memcached.so"

.travis.yml

@@ -1,12 +1,15 @@
 language: php
+
 php:
-  - 5.5
-  - 5.6
   - 7.0
   - 7.1
+  - 7.2
+  - 7.3
 
 before_script:
+  - phpenv config-add .travis-memcached.ini
+  - composer self-update
   - composer install
 
 script:
-  - vendor/bin/phpunit
+  - ./vendor/bin/phpunit

Command/MySQLProviderSetupCommand.php

@@ -3,35 +3,42 @@
 namespace NV\RequestLimitBundle\Command;
 
 use Doctrine\DBAL\Connection;
+use Doctrine\DBAL\DBALException;
 use Symfony\Bundle\FrameworkBundle\Command\ContainerAwareCommand;
 use Symfony\Component\Console\Input\InputInterface;
 use Symfony\Component\Console\Output\OutputInterface;
 
+/**
+ * Class MySQLProviderSetupCommand
+ * @package NV\RequestLimitBundle\Command
+ * @author Novikov Viktor
+ */
 class MySQLProviderSetupCommand extends ContainerAwareCommand
 {
+    /**
+     * {@inheritdoc}
+     */
     protected function configure()
     {
         $this
             ->setName('nv:request-limit:mysql-init')
             ->setDescription('Creates a table in your project database to store keys')
-            ->setHelp('This command initialize MySQL provider workflow')
-        ;
+            ->setHelp('This command initializes MySQL provider workflow');
     }
 
     /**
      * @param InputInterface $input
      * @param OutputInterface $output
      * @return int|null|void
-     * @throws \Doctrine\DBAL\DBALException
+     * @throws DBALException
      */
     protected function execute(InputInterface $input, OutputInterface $output)
     {
         /** @var Connection $connection */
         $connection = $this->getContainer()->get('doctrine.orm.default_entity_manager')->getConnection();
-        $connection->exec('CREATE TABLE nv_request_limit_items (
-            item_key VARCHAR(30) PRIMARY KEY,
-            expires_at TIMESTAMP
-            );');
+        $connection->exec(
+            'CREATE TABLE nv_request_limit_items (item_key VARCHAR(30) PRIMARY KEY, expires_at TIMESTAMP);'
+        );
         $connection->close();
     }
 }

DataCollector/RestrictionsCollector.php

@@ -7,6 +7,11 @@
 use Symfony\Component\HttpFoundation\Response;
 use Symfony\Component\HttpKernel\DataCollector\DataCollectorInterface;
 
+/**
+ * Class RestrictionsCollector
+ * @package NV\RequestLimitBundle\DataCollector
+ * @author Novikov Viktor
+ */
 class RestrictionsCollector implements DataCollectorInterface
 {
     /**
@@ -18,7 +23,7 @@ class RestrictionsCollector implements DataCollectorInterface
     private $storageManager;
 
     /**
-     * @inheritdoc
+     * {@inheritdoc}
      */
     public function collect(Request $request, Response $response, \Exception $exception = null)
     {
@@ -69,7 +74,7 @@ public function __sleep()
     }
 
     /**
-     * @inheritdoc
+     * {@inheritdoc}
      */
     public function reset()
     {

DependencyInjection/Compiler/StoragePass.php

@@ -5,9 +5,16 @@
 use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
 
+/**
+ * Class StoragePass
+ * @package NV\RequestLimitBundle\DependencyInjection\Compiler
+ * @author Novikov Viktor
+ */
 class StoragePass implements CompilerPassInterface
 {
     /**
+     * {@inheritdoc}
+     *
      * @param ContainerBuilder $container
      */
     public function process(ContainerBuilder $container)

DependencyInjection/Configuration.php

@@ -5,16 +5,22 @@
 use Symfony\Component\Config\Definition\Builder\TreeBuilder;
 use Symfony\Component\Config\Definition\ConfigurationInterface;
 
+/**
+ * Class Configuration
+ * @package NV\RequestLimitBundle\DependencyInjection
+ * @author Novikov Viktor
+ */
 class Configuration implements ConfigurationInterface
 {
     /**
-     * @inheritdoc
+     * {@inheritdoc}
+     *
+     * @return TreeBuilder
      */
     public function getConfigTreeBuilder()
     {
         $treeBuilder = new TreeBuilder();
         $rootNode = $treeBuilder->root('request_limit');
-
         $rootNode
             ->children()
                 ->integerNode('restriction_time')->end()

DependencyInjection/NVRequestLimitExtension.php

@@ -6,25 +6,32 @@
 use Symfony\Component\Config\FileLocator;
 use Symfony\Component\DependencyInjection\Loader\XmlFileLoader;
 use Symfony\Component\HttpKernel\DependencyInjection\Extension;
+use \Exception;
 
+/**
+ * Class NVRequestLimitExtension
+ * @package NV\RequestLimitBundle\DependencyInjection
+ * @author Novikov Viktor
+ */
 class NVRequestLimitExtension extends Extension
 {
     /**
      * Loads a specific configuration.
      *
      * @param array $configs
      * @param ContainerBuilder $container
-     * @throws \Exception
+     * @throws Exception
      */
-    public function load(array $configs, ContainerBuilder $container) {
+    public function load(array $configs, ContainerBuilder $container)
+    {
         $loader = new XmlFileLoader($container, new FileLocator(__DIR__ . '/../Resources/config'));
         $loader->load('services.xml');
 
-        $configuration         = new Configuration();
-        $config                = $this->processConfiguration($configuration, $configs);
-        $providerType          = $config['provider_type'];
+        $configuration = new Configuration();
+        $config = $this->processConfiguration($configuration, $configs);
+        $providerType = $config['provider_type'];
         $providerConfiguration = $config['provider_configuration'];
-        $restrictionTime       = $config['restriction_time'];
+        $restrictionTime = $config['restriction_time'];
 
         $container->setParameter('nv_request_limit.provider_type', $providerType);
         $container->setParameter('nv_request_limit.provider_configuration', $providerConfiguration);

Exception/RequestLimitReachedException.php

@@ -4,13 +4,18 @@
 
 use Throwable;
 
+/**
+ * Class RequestLimitReachedException
+ * @package NV\RequestLimitBundle\Exception
+ * @author Novikov Viktor
+ */
 class RequestLimitReachedException extends \Exception
 {
     /**
-     * @inheritdoc
+     * {@inheritdoc}
      */
     public function __construct(
-        $message = "You reached defined requests limit, please try again later",
+        $message = "You reached the defined requests limit. Please, try again later.",
         $code = 403,
         Throwable $previous = null
     ) {

NVRequestLimitBundle.php

@@ -6,15 +6,19 @@
 use Symfony\Component\HttpKernel\Bundle\Bundle;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
 
+/**
+ * Class NVRequestLimitBundle
+ * @package NV\RequestLimitBundle
+ * @author Novikov Viktor
+ */
 class NVRequestLimitBundle extends Bundle
 {
     /**
-     * @inheritdoc
+     * {@inheritdoc}
      */
     public function build(ContainerBuilder $container)
     {
         parent::build($container);
-
         $container->addCompilerPass(new StoragePass());
     }
 }

README.md

@@ -6,56 +6,64 @@ RequestLimitBundle
 This bundle is a simple solution to restrict user access
 to some controller for a specified timeline.
 
-This could be used for different cases when you need to pre
-
+This functionality could be used for different cases when you need to:
 - prevent flood - pushing users of irrelevant data;
-- prevent user to visit page very often, etc.
+- prevent a user from accessing the certain endpoint very often, etc.
 
 Installation
 =============
 
-1) Require bundle with:
+1) Install package via:
 ```bash
-    composer require 
+    composer require nv/request-limit-bundle
+```
+
+2) Register bundle :
+
+In `app/AppKernel.php` prior to Symfony version `4.0`:
+```php
+public function registerBundles()
+{
+    $bundles = [
+        // ... ,
+        new NV\RequestLimitBundle\NVRequestLimitBundle()
+    ];
+
+    // ...
+    return $bundles;
+}
 ```
 
-2) Register bundle in AppKernel:
+In `config/bundles.php` when Symfony version is `4.0` and higher
 ```php
- public function registerBundles()
-    {
-        $bundles = [
-            ... ,
-            new NV\RequestLimitBundle\NVRequestLimitBundle()
-        ];
-    ...
-    }
+return [
+    //... other bundles
+    NV\RequestLimitBundle\NVRequestLimitBundle::class => ['all' => true]
+];
 ```
 
-3) Configure bundle according to provider you use:
- - [Memcached](https://github.com/NovikovViktor/RequestLimitBundle/blob/master/Resources/docs/memcached.md)
- - [MySQL](https://github.com/NovikovViktor/RequestLimitBundle/blob/master/Resources/docs/mysql.md)
+3) Configure the bundle according to the provider you would like to use.
+Out of the box, we provide the Memcached and MySQL providers. To see configuration options, see the docs below.
+   
+ - [Memcached provider configuration](https://github.com/NovikovViktor/RequestLimitBundle/blob/master/Resources/docs/memcached.md)
+ - [MySQL provider configuration](https://github.com/NovikovViktor/RequestLimitBundle/blob/master/Resources/docs/mysql.md)
+
+If you want to use other storage, you can implement your provider.
 
 4) Specify `restriction_time` in seconds:
 ```yml
 nv_request_limit:
-    restriction_time: 5
+    #... options for provider configuration
+    restriction_time: 5  # 5 seconds
 ```
 
 Usage
 =============
 
-In your controller action add following line to restrict user access by user id:
-```php
-$this->get('nv.request_limit.request_restrictor')->restrictRequestByUserId($userId);
-```
-or following to restrict by user IP:
+In your action, add the following line to restrict access by some specific application user artifact (e.g., user id, user IP, etc.):
 ```php
-$this->get('nv.request_limit.request_restrictor')->restrictRequestByIp($userIp);
+$artifact = 'e.g. get user id or IP here';
+$this->get('nv.request_limit.restrictor')->blockBy($artifact);
 ```
 
-These will restrict user access to the action for 10 minutes.
-
-TODO
-=========
-
-1) Write tests
+These will restrict user access for a time frame specified in your configuration (5 seconds accordingly to).