spiral-packages/rate-limiter

A simple to use rate limiting abstraction which, in conjunction with your application's cache, provides an easy way to limit any action during a specified window of time.

dev-master 2022-06-23 15:36 UTC

Requires

• php: ^8.1
• psr/simple-cache: ^3.0
• spiral/boot: ^3.0
• spiral/cache: ^3.0
• spiral/http: ^3.0

Requires (Dev)

• spiral/framework: ^3.0
• spiral/testing: ^2.0
• vimeo/psalm: ^4.9

MIT

• butschster

• spiral
• rate-limiter
• spiral-packages

README

This is where your description should go. Limit it to a paragraph or two. Consider adding a small example.

Requirements

Make sure that your server is configured with following PHP version and extensions:

• PHP 8.1+
• Spiral framework 3.0+

Installation

You can install the package via composer:

composer require spiral-packages/rate-limiter

After package install you need to register bootloader from the package.

protected const LOAD = [
    // ...
    \Spiral\RateLimiter\Bootloader\RateLimiterBootloader::class,
];

Note: if you are using spiral-packages/discoverer, you don't need to register bootloader by yourself.

Testing

composer test

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

• butschster
• All Contributors

License

The MIT License (MIT). Please see License File for more information.