https://github.com/sirius248/scratch_rate_limitter
https://github.com/sirius248/scratch_rate_limitter
ruby ruby-on-rails
Last synced: 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/sirius248/scratch_rate_limitter
- Owner: sirius248
- Created: 2017-09-09T03:33:02.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2017-09-09T05:07:21.000Z (almost 9 years ago)
- Last Synced: 2025-05-14T02:52:06.534Z (about 1 year ago)
- Topics: ruby, ruby-on-rails
- Language: Ruby
- Homepage: https://scratch-rate-limitter.herokuapp.com/home/index
- Size: 29.3 KB
- Stars: 1
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Rails throttling example
[](https://codeclimate.com/github/kimquy/scratch_rate_limitter)
[](https://travis-ci.org/kimquy/scratch_rate_limitter)
# Intro
All the main implemnetation are in the following files:
```bash
app/middleware/rack/throttling.rb
config/initializers/throttling_config.rb
lib/simple_throttler.rb
```
# Usage of SimpleThrottler
Add `throttling_config.rb` into the `initializers`
Example:
```ruby
SimpleThrottler.configure do
throttle "/home/index", limit: 5, period: 1.hours
throttle "/testing", limit: 20, period: 2.hours
throttle "/awesome", limit: 100, period: 3.hours
end
```
# Improvement
At the moment the `SimpleThrottler` is super simple. The throttling algorithm only base on the IP address. And the storage only support `ActiveSupport::Cache::MemoryStore`
# Manual Testing
* Make a single request from command line with Curl
Simply copy the code below into command line. Curl is required.
```bash
curl https://scratch-rate-limitter.herokuapp.com/home/index
```
* Make multiple request from command line with Curl
```bash
for i in {1..5}; do curl https://scratch-rate-limitter.herokuapp.com/home/index; done
```
# Unit test
```ruby
bundle exec rspec
```