nw/request-limit-bundle

This bundle provides a light way to restrict user access to some action for a specific time frame

v1.0 2020-12-16 08:38 UTC

Requires

• php: ^7
• ext-memcached: *
• ext-pdo: *
• doctrine/common: ~2.4
• symfony/symfony: >=3.0

Requires (Dev)

• doctrine/dbal: ~2.4
• doctrine/doctrine-bundle: ~1.4
• doctrine/orm: ~2.4,>=2.4.5
• friendsofphp/php-cs-fixer: *
• phpspec/phpspec: *
• phpunit/phpunit: ~5.0

MIT

• Viktor Novikov

• symfony
• post
• request
• get
• restrict
• http verbs
• Limitations

README

RequestLimitBundle

This bundle is a simple solution to restrict user access to some controller for a specified timeline.

This functionality could be used for different cases when you need to:

• prevent flood - pushing users of irrelevant data;
• prevent a user from accessing the certain endpoint very often, etc.

Installation

1. Install package via:

    composer require nw/request-limit-bundle

1. Register bundle :

In app/AppKernel.php prior to Symfony version 4.0:

public function registerBundles()
{
    $bundles = [
        // ... ,
        new NW\RequestLimitBundle\NWRequestLimitBundle()
    ];

    // ...
    return $bundles;
}

In config/bundles.php when Symfony version is 4.0 and higher

return [
    //... other bundles
    NW\RequestLimitBundle\NWRequestLimitBundle::class => ['all' => true]
];

1. 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
• MySQL provider configuration

If you want to use other storage, you can implement your provider.

1. Specify restriction_time in seconds:

nw_request_limit:
    #... options for provider configuration
    restriction_time: 5  # 5 seconds

Usage

In your action, add the following line to restrict access by some specific application user artifact (e.g., user id, user IP, etc.):

$artifact = 'e.g. get user id or IP here';
$this->get('nw.request_limit.restrictor')->blockBy($artifact);

These will restrict user access for a time frame specified in your configuration (5 seconds accordingly to).