RedisRateLimit
Action rate limits are applied at a per-key basis in unit time (minutes, hourly, daily ...). By using Redis, this library allows to control actions across multiple servers
Installation
Add this line to your application's Gemfile:
gem 'redis_rate_limit'
And then execute:
$ bundle
Or install it yourself as:
$ gem install redis_rate_limit
Usage
Example 1
Get an access when the rate limit is not exeeded.
Restrict access for 127.0.0.1 ip address. The number of access will not exceed 60 per minute
$ redis = Redis.new
$ client = "127.0.0.1"
$ ratelimit = MinuteRateLimit.new('clients', redis: redis)
$ ratelimit.get_access(client)
Response
{
'pass' => true,
'RateLimit' =>
{
'X-RateLimit-Limit' => 60,
'X-RateLimit-Remaining' => 59,
'X-RateLimit-Counter' => 1,
'X-RateLimit-Reset' => 'Mon, 27 Feb 2017 15:59:11 UTC +00:00'
}
}
Development
After checking out the repo, run bin/setup
to install dependencies. Then, run rake spec
to run the tests. You can also run bin/console
for an interactive prompt that will allow you to experiment.
To install this gem onto your local machine, run bundle exec rake install
. To release a new version, update the version number in version.rb
, and then run bundle exec rake release
, which will create a git tag for the version, push git commits and tags, and push the .gem
file to rubygems.org.
Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/redis_rate_limit.
License
The gem is available as open source under the terms of the MIT License.