0.0
No commit activity in last 3 years
No release in over 3 years
limit the number of requests made to your api using the solid leaky bucket algorithm
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
 Dependencies

Development

~> 1.15
~> 5.0
~> 10.0
 Project Readme

LeakyBucket

If you are running a busy application in production, you should limit the number of requests a user can make per time unit. LeakyBucket helps you do just that, easily.

Installation

Add this line to your application's Gemfile:

gem 'leaky_bucket'

And then execute:

$ bundle

Or install it yourself as:

$ gem install leaky_bucket

Then create a leaky_bucket.rb initializer file in config/initializers with :

LeakyBucket.cache = Rails.cache # or memcached

Usage

to limit the requests to an action, use the throttle method:

def create
  LeakyBucket::Throttler.throttle(request.ip)
  #other code that will run if the user has not reached the maximum threshold.
end

the throttle method will raise an exception and return and 429 response code if the user has made too many requests.

By default, the threshold is 100 requests/hour, to override it, just provide the params:

# allow maximum 50 requests per minute.
LeakyBucket::Throttler.throttle(ip, threshold: 50, interval: 60, burst: 10)

threhold is the number of requests.

interval is in seconds.

burst is the number of requests the user is allowed to make at once, when the burst is exhausted, the user will have to wait until the sometime has passed to make another request.

Development

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]/leaky_bucket. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

License

The gem is available as open source under the terms of the MIT License.

Code of Conduct

Everyone interacting in the LeakyBucket project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.