sjs/rack-attack
1
0
Fork 0
mirror of https://github.com/samsonjs/rack-attack.git synced 2026-04-27 15:07:41 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Merge pull request #377 from krainboltgreene/patch-1

Browse source 
Prefer to not use X- style headers for clarity
This commit is contained in:
Gonzalo Rodriguez 2018-08-16 15:05:47 -03:00 committed by GitHub
commit 264770451b
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 5 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
README.md
View file

@ -295,12 +295,12 @@ Rack::Attack.throttled_response = lambda do |env|
end end
``` ```
### X-RateLimit headers for well-behaved clients ### RateLimit headers for well-behaved clients
While Rack::Attack's primary focus is minimizing harm from abusive clients, it While Rack::Attack's primary focus is minimizing harm from abusive clients, it
can also be used to return rate limit data that's helpful for well-behaved clients. can also be used to return rate limit data that's helpful for well-behaved clients.
Here's an example response that includes conventional `X-RateLimit-*` headers: Here's an example response that includes conventional `RateLimit-*` headers:
```ruby ```ruby
Rack::Attack.throttled_response = lambda do |env| Rack::Attack.throttled_response = lambda do |env|
@ -308,9 +308,9 @@ Rack::Attack.throttled_response = lambda do |env|
now = match_data[:epoch_time] now = match_data[:epoch_time]
headers = { headers = {
'X-RateLimit-Limit' => match_data[:limit].to_s, 'RateLimit-Limit' => match_data[:limit].to_s,
'X-RateLimit-Remaining' => '0', 'RateLimit-Remaining' => '0',
'X-RateLimit-Reset' => (now + (match_data[:period] - now % match_data[:period])).to_s 'RateLimit-Reset' => (now + (match_data[:period] - now % match_data[:period])).to_s
} }
[ 429, headers, ["Throttled\n"]] [ 429, headers, ["Throttled\n"]]