douglasthwaites / deputy
Helps Saloon Caching and Rate Limiting play nice.
Requires
- php: ^8.3
- saloonphp/cache-plugin: ^3.0
- saloonphp/rate-limit-plugin: ^2.0
- saloonphp/saloon: ^3.0
Requires (Dev)
- laravel/pint: ^1.18
README
Deputy is a Saloon plugin to help with the combination of the official Saloon Caching and Rate Limit plugins.
Both the official Caching and Rate Limit plugins on there own work beautifully and as expected however when combined responses that have been cached will also increment the rate limiter meaning you could only be hitting the cache and throwing a rate limit exception.
This plugin does not override in anyway either of these plugins it works by registering a response middleware that if the request was a cached response it will then decrement the rate limiter by one negating the affects of adding cached responses to the rate limiter.
Installation
composer require douglasthwaites/deputy
Usage
To use this package add the traits and methods for Rate Limiting and Caching as per the official Saloon docs and then also add the HasRateCache trait to your connector or request.
<?php
namespace App\Http\Integrations\CoolIntegration;
use Saloon\Http\Connector;
use Deputy\Traits\HasRateCache;
use Saloon\CachePlugin\Traits\HasCaching;
use Saloon\RateLimitPlugin\Traits\HasRateLimits;
class CoolApiConnector extends Connector
{
use HasRateLimits;
use HasCaching;
use HasRateCache;
}
That's it 🤠
Thanks to Sam Carré and everyone who has contributed to Saloon ❤️