Ratelimit: Slow your roll
Add this line to your application's Gemfile:
And then execute:
Or install it yourself as:
$ gem install ratelimit
My example use case is bulk processing data against an external API. This will allow you to limit multiple processes across multiple servers as long as they all use the same Redis database.
Add to the count for a given subject via add with a unique key. I've used the example of a phone number below but anything unique would work (URL, email address, etc.)
You can then fetch the number of executions for given interval in seconds via the count method.
ratelimit = Ratelimit.new("messages") 5.times do ratelimit.add(phone_number) end ratelimit.count(phone_number, 30) # => 5
You can check if a given threshold has been exceeded or not. The following code checks if the currently rate is over 10 executions in the last 30 seconds or not.
ratelimit.exceeded?(phone_number, threshold: 10, interval: 30) # => false ratelimit.within_bounds?(phone_number, threshold: 10, interval: 30) # => true
You can also pass a block that will only get executed if the given threshold is within bounds. Beware, this code blocks until the block can be run.
ratelimit.exec_within_threshold phone_number, threshold: 10, interval: 30 do some_rate_limited_code ratelimit.add(phone_number) end
Full documentation can be found here.
- Fork it ( https://github.com/ejfinneran/ratelimit/fork )
- Create your feature branch (
git checkout -b my-new-feature)
- Commit your changes (
git commit -am 'Add some feature')
- Push to the branch (
git push origin my-new-feature)
- Create a new Pull Request