cellard/throttle

This package is abandoned and no longer maintained. No replacement package was suggested.

Laravel Throttle Service may throttle any events, not only requests

1.0.4 2020-08-04 11:07 UTC

Requires

• php: >=7.0
• laravel/framework: >=6.0

MIT

• Cellard

• sms
• throttle
• laravel
• limitation

README

Laravel built-in throttling allows to rate limit access to routes. But what about other processes, e.g. sending sms?

For example, you may need to limit amount of sms, user allowed to receive from your service. Or maybe you need to limit number of comments, user allowed to write in some time period.

This service can throttle any event you need:

try {
    throttle('sms')
        ->subject('[phone]')
        ->try();

    // Your code to send SMS here

} catch (\Cellard\Throttle\ThrottlingException $exception) {
    // No, You Don't
}

Installation

composer require Cellard/throttle

Register Service Provider in config/app.php file.

'providers' => [
    /**
     * Third Party Service Providers...
     */
    Cellard\Throttle\ThrottleServiceProvider::class
],

Publish the package config file and migrations to your application. Run these commands inside your terminal.

php artisan vendor:publish --provider="Cellard\Throttle\ThrottleServiceProvider"

And also run migrations.

php artisan migrate

Setup

Set up your throttle service.

class ThrottleSms extends Cellard\Throttle\ThrottleService
{
    public function rules()
    {
        return [
            '1:60', // one sms per minute
            '3:300', // 3 sms per 5 minutes
            '5:86400', // maximum 5 sms every day
        ];
    }
}

Exactly the same, but with helpers.

class ThrottleSms extends Cellard\Throttle\ThrottleService
{
    public function rules()
    {
        return [
            $this->everyMinute(),
            $this->everyFiveMinutes(3),
            $this->daily(5)
        ];
    }
}

Then register your service in config/throttle.php.

return [
    'events' => [
        'sms' => ThrottleSms::class
    ]
];

Error messages

By default error messages looks like Next :event after :interval

Next sms after 23 hours 32 minutes 13 seconds

You may define custom error messages.

class ThrottleSms extends Cellard\Throttle\ThrottleService
{
    public function rules()
    {
        return [
            '1:60' => 'You may send only one SMS per minute',
            '3:300' => 'You may send no more than three SMS in five minutes'
        ];
    }
}

Placeholders:

• limit — number of events (defined in rule)
• seconds — number of seconds (defined in rule)
• event — name of service (defined in config file)
• interval - CarbonInterval object (time left to the next allowed hit)

Usage

$throttle = Throttle::event('sms')->subject('[phone]');

if ($throttle->allow()) {

    // Your code to send SMS here


    // Do not forget to register an event
    $throttle->hit();

} else {

    // Show error message
    $throttle->error();

    // Show the time, next sms is allowed
    $throttle->next();

}

Or in try-catch style

try {

    Throttle::event('sms')
        ->subject('[phone]')
        ->try();

    // Your code to send SMS here

} catch (\Cellard\Throttle\ThrottlingException $exception) {

    // Show error message
    $exception->getMessage();

    // Show the time, next sms is allowed
    $exception->getNext();
}

Also you may use helper function.

throttle('sms')
    ->subject('[phone]')
    ->try();

What is subject?

Subject is a scope.

You may check availability without subject.

Throttle::event('sms')->try();

It means that service will check limitations without reference to the exact phone number.

Subject means that service will check limitations per phone.

Throttle::event('sms')->subject('[phone]')->try();

Pick up your room before you go out

Throttle Service stores records in its table, and you may want to clear it.

php artisan throttle:clean

Will remove obsolete records.

You may schedule it to run once a day or week...