Fixed Time Window Rate Limiter for Laravel
This package allows you to easily create and validate rate limiting using the fixed window algorithm.
This package makes use of Redis' atomic requests.
You can install the package via composer:
composer require beyondcode/laravel-fixed-window-limiter
You can create a new limiter instance by calling the
create method and pass it a CarbonInterval that represents the window of time, that will be used for the limiter.
The second argument is the maximum number of requests/attempts that your limiter will accept in that given time frame.
$limiter = FixedWindowLimiter::create(CarbonInterval::second(2), 2);
Running attempts against your limiter
Once your limiter is created, you can perform attempts against it to see if the call is within the usage limits that you specified.
Since your limiter can be used for multiple resources, you need to pass the resource that you want to attempt the call for in the
attempt method call.
Getting the usage count
When you want to read the number of attempts that were made for a given resource, you may call the
Note: This method will not return the number of attempts, but only the number of successful attempts. Use the
getRealUsage method, if you want to see all attempts, including those that were rejected.
$count = $limiter->getUsage('user_1');
Or as mentioned, to get the real usage of all attempts for the resource:
$count = $limiter->getRealUsage('user_1');
Reset the limiter
If you want to reset the attempts for a specific resource, you may call the
reset method on the limiter instance. This will reset the TTL to the given time frame and re-allow new attempts.
Sometimes you might want to store additional data inside of the resource hash in Redis. You can pass the initial data to the
$limiter->reset('user_1', [ 'key' => 'value' ]);
In order to retrieve the data, you may use the
$value = $limiter->getAdditionalData('user_1', 'key');
Please see CHANGELOG for more information what has changed recently.
Please see CONTRIBUTING for details.
If you discover any security related issues, please email firstname.lastname@example.org instead of using the issue tracker.
The MIT License (MIT). Please see License File for more information.