Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/vbrazo/rate_limiter
Rate Limiter engine for Rails APIs
https://github.com/vbrazo/rate_limiter
Last synced: about 1 month ago
JSON representation
Rate Limiter engine for Rails APIs
- Host: GitHub
- URL: https://github.com/vbrazo/rate_limiter
- Owner: vbrazo
- Created: 2021-03-30T13:46:18.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2021-10-01T22:01:30.000Z (about 3 years ago)
- Last Synced: 2024-05-21T12:10:45.439Z (6 months ago)
- Language: Ruby
- Homepage:
- Size: 73.2 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Rate Limiter for Rails APIs
[]()
[](https://badge.fury.io/rb/rate_limiter_engine)
Rate Limiter is a Rails engine that can easily limit requests per client in your Rails APIs.
## Problem
Rate limiting is the act of limiting the number of requests sent to or from a system. It's most often used to limit the number of incoming requests in order to prevent `DoS attacks` and can be enforced at the IP-address level, at the user-account level, or at the region level, for example.
#### DoS attack
Short for "denial-of-service attack", a DoS attack is an attack in which a malicious user tries to bring down or damage a system in order to render it unavailable to users. Much of the time, it consists of flooding it with traffic. Some DoS attacks are easily preventable with rate limiting, while others can be far trickier to defend against.
#### DDoS attack
Short for "distributed denial-of-service attack", a DDoS attack is a DoS attack in which the traffic flooding the target system comes from many different sources (like thousands of machines), making it much harder to defend against.
## Approach
In order to control the Rate Limiting, this Rails Engine proposes to use Redis and its in-memory key-value store. Redis offers some persistent storage options but is typically used as a really fast, best-effort caching solution. Redis is also often used to implement rate limiting.
### Installation
- Add this line to your application's Gemfile:
```ruby
gem 'rate_limiter_engine', 'X.Y.Z'
```
and run `bundle` to install your dependencies.
- Create an initializer for your Rate Limiter engine and set the default properties:
```ruby
RateLimiter.configure do |config|
config.rate_default = 2
config.period_default = 2
config.force_rate_limit = 100
config.force_period = 2
end
```
### Usage
To add a Rate Limiter, all you have to do is `include RateLimiter::RateLimit` in `ApplicationController` to have it on all your controllers using default settings of 100 request per hour (100 seconds).
You can also add it directly to the controller you want to be rate limited.
To customize, just use helper methods `rate` and `period`, as following:
```ruby
class ApplicationController < ActionController::Base
include RateLimiter::RateLimit
rate 100
period 100
…
end
```
## Available Docker commands
I built this engine with Docker so I'd suggest using it. All available commands are:
| Command | Description |
|--------------|----------------------------------------|
| make build | Build the application |
| make specs | Run all the specs |
| make bash | access the bash inside the container |