https://github.com/ejfinneran/ratelimit

A Redis-backed rate limiter written in Ruby
https://github.com/ejfinneran/ratelimit

rate-limits redis ruby

Last synced: about 2 months ago
JSON representation

A Redis-backed rate limiter written in Ruby

• Host: GitHub
• URL: https://github.com/ejfinneran/ratelimit
• Owner: ejfinneran
• License: mit
• Created: 2011-09-19T06:09:10.000Z (about 13 years ago)
• Default Branch: master
• Last Pushed: 2024-01-18T17:10:26.000Z (8 months ago)
• Last Synced: 2024-04-24T16:19:14.064Z (5 months ago)
• Topics: rate-limits, redis, ruby
• Language: Ruby
• Homepage:
• Size: 65.4 KB
• Stars: 250
• Watchers: 10
• Forks: 53
• Open Issues: 11
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
# Ratelimit: Slow your roll

[![Code Climate](https://codeclimate.com/github/ejfinneran/ratelimit.png)](https://codeclimate.com/github/ejfinneran/ratelimit)

[![Coverage Status](https://img.shields.io/coveralls/ejfinneran/ratelimit.svg)](https://coveralls.io/r/ejfinneran/ratelimit)

Ratelimit provides a way to rate limit actions across multiple servers using Redis.  This is a port of RateLimit.js found [here](https://github.com/chriso/redback/blob/master/lib/advanced_structures/RateLimit.js) and inspired by [this post](https://gist.github.com/chriso/54dd46b03155fcf555adccea822193da).

## Installation

Add this line to your application's Gemfile:

``` rb

gem 'ratelimit'

```

And then execute:

``` sh

$ bundle

```

Or install it yourself as:

``` sh

$ gem install ratelimit

```

## Usage

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.

``` rb

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.

``` rb

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.

``` rb

ratelimit.exec_within_threshold phone_number, threshold: 10, interval: 30 do

  some_rate_limited_code

  ratelimit.add(phone_number)

end

```

## Documentation

Full documentation can be found [here.](http://rubydoc.info/github/ejfinneran/ratelimit/frames)

## Contributing

1. Fork it ( https://github.com/ejfinneran/ratelimit/fork )

2. Create your feature branch (`git checkout -b my-new-feature`)

3. Commit your changes (`git commit -am 'Add some feature'`)

4. Push to the branch (`git push origin my-new-feature`)

5. Create a new Pull Request