sjs/rack-attack
1
0
Fork 0
mirror of https://github.com/samsonjs/rack-attack.git synced 2026-03-25 09:25:49 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Clarify readme

Browse source
This commit is contained in:
Aaron Suggs 2012-08-08 15:25:13 -04:00
parent 5a9f991b6e
commit 0656975d98
1 changed files with 7 additions and 10 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

17
README.md
View file

@ -83,7 +83,11 @@ Note that `req` is a [Rack::Request](http://rack.rubyforge.org/doc/classes/Rack/
## Responses
Customize the response of throttled requests using an object that adheres to the [Rack app interface](http://rack.rubyforge.org/doc/SPEC.html).
Customize the response of blacklisted and throttled requests using an object that adheres to the [Rack app interface](http://rack.rubyforge.org/doc/SPEC.html).
Rack:Attack.blacklisted_response = lambda do |env|
[ 503, {}, ['Blocked']]
end
Rack:Attack.throttled_response = lambda do |env|
# name and other data about the matched throttle
@ -96,16 +100,9 @@ Customize the response of throttled requests using an object that adheres to the
[ 503, {}, [body]]
end
Similarly for blacklisted responses:
For responses that did not exceed a throttle limit, Rack::Attack annotates the env with match data:
Rack:Attack.blacklisted_response = lambda do |env|
[ 503, {}, ['Blocked']]
end
For responses that did not exceed a throttle limit, Rack::Attack annotates the environment with match data.
For example, in out `reqs/ip` throttle above, a matching request would have:
request.env['rack.attack.throttle_data']['req/ip'] # => { :period => 1, :limit => 5, :count => n }
request.env['rack.attack.throttle_data'][name] # => { :count => n, :period => p, :limit => l }
## Logging & Instrumentation