Download the PHP package abolaradev/livewire-rate-limiter without Composer

Livewire Rate Limiter

Rate Limiting is a technique used to control how many requests a user or client can make within a specific period of time. It helps protect applications from excessive requests, abuse, brute-force attempts, and unnecessary resource consumption.

Livewire Rate Limiter provides a simple way to apply Rate Limiting to Livewire Actions without having to implement the Rate Limiting logic manually.

Features

• Apply Rate Limiting to Livewire Actions using a PHP Attribute.
• Customize Rate Limiting settings for individual Actions.
• Apply Rate Limiting using the LivewireRateLimiter Facade.
• Define custom behavior when the Rate Limit is exceeded.
• Get the remaining time until the Rate Limit expires.
• Display custom content using the @limitation Blade directive.
• Automatically return an HTTP 429 (Too Many Requests) response when the Rate Limit is exceeded.

Installation

You can install the package via Composer:

You can publish the configuration file with:

Configuration

The package configuration is located at config/livewire-rate-limiter.php:

Usage

Using the RateLimiter Attribute

To enable Rate Limiting for a Livewire Action, simply add the RateLimiter PHP Attribute to the desired method.

By default, the RateLimiter Attribute uses the values defined in the config/livewire-rate-limiter.php configuration file.

Custom Rate Limiting

You can customize the Rate Limiting settings for a specific Livewire Action by passing values directly to the RateLimiter Attribute.

The maxAttempts argument defines the maximum number of allowed attempts, while decaySeconds specifies the number of seconds before the attempt counter is reset.

For example, the following Action allows 5 attempts within a 120-second period:

Rate Limit Response

When the Rate Limit is exceeded, the package automatically returns an HTTP 429 (Too Many Requests) response and prevents the Livewire Action from continuing its execution.

Using the LivewireRateLimiter Facade

The package also provides an alternative way to apply Rate Limiting to Livewire Actions using the LivewireRateLimiter Facade.

Call the handle method within the desired Livewire Action. The onAction argument accepts a Closure containing the logic that should be executed when the request is allowed.

Custom Limit Handling

The Facade-based approach allows you to define custom behavior when the Rate Limit is exceeded.

Pass a Closure to the handle method using the onLimit argument. This Closure is executed when the Rate Limit is exceeded.

This allows you to return a custom response or perform any additional process when the Rate Limit is exceeded.

Getting the Remaining Time

You may need to know how many seconds remain until the current Rate Limit expires. The getAvailableIn() method returns the remaining time in seconds.

Blade Directive

The package also provides a Blade conditional directive called @limitation.

It allows you to display custom content while the current Rate Limit is active.

If you find this package useful, please don't forget to give it a ⭐ on GitHub. ❤️

Testing

Run the test suite with:

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 for information on how to report security vulnerabilities.

Credits

• abolaradev
• All Contributors

License

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