Rolling::Limit

A redis-backed rate limiter, using redis sorted sets.

require 'rolling/limit'

rl = Rolling::Limit.new(redis: connection, key: "unique key",
                        max_operations: 5, timespan: 60)

rl.remaining # => 4
rl.remaining # => 3
rl.remaining # => 2
rl.remaining # => 1
rl.remaining # => 0
rl.remaining # => false
# ... 61s later
rl.remaining # => 4

Installation

Add this line to your application's Gemfile:

gem 'rolling-limit'

And then execute:

$ bundle

Or install it yourself as:

$ gem install rolling-limit

Usage

TODO: Write usage instructions here

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/livelink/rolling-limit.