Commit graph

111 commits

Author SHA1 Message Date
Gonzalo Rodriguez
ef7fe67b5e
docs: fix typo 2018-10-30 10:27:46 -03:00
Leo Arnold
b0da52a1bd Move Wiki examples into version control. Closes #324 2018-10-28 19:21:43 +01:00
Leo Arnold
95d536414a Add table of contents to README. Closes #335 2018-10-08 18:15:07 +02:00
Gonzalo Rodriguez
ef21932760
Update README: Mailing list no longer user 2018-09-03 18:35:08 -03:00
Kurtis Rainbolt-Greene
ea58ccbb6a
Forgot to match the header 2018-08-16 10:32:02 -07:00
Kurtis Rainbolt-Greene
3e5a4607cd
Prefer to not use X- style headers for clarity
The IETF decided the X- style custom headers have caused more headache than the value: https://tools.ietf.org/html/rfc6648 so this tool (which is very popular and much loved) shouldn't suggest using an old style.
2018-08-16 08:11:30 -07:00
Carlos Contreras
711ba9bf99 Fix copy on safelist description 2018-07-31 15:38:16 -05:00
Gonzalo Rodriguez
73bc739d5a
Merge remote-tracking branch 'doliveirakn/master' 2018-06-29 11:17:19 -03:00
Gonzalo Rodriguez
8802ebfbaf
Merge branch '255-correct-object-for-instrumentation' 2018-06-28 16:40:08 -03:00
Spencer Norman
f56967f923 fixed spelling issue, returna to return (#334)
* fixed spelling issue, returna to returns

* fixed the spelling properly this time, returns to return
2018-04-06 10:19:53 -03:00
Gonzalo Rodriguez
2d6ad830ac
docs: provide some advice for users willing to contribute to the project 2018-03-30 15:29:16 -03:00
Koen Rouwhorst
0457bf22f9 Updated all non-secure HTTP URLs to HTTPS. 2018-03-29 18:41:40 +02:00
Gonzalo Rodriguez
4c1aa8b312
[Fixes #318] Attempt to improve README a bit (#323)
* docs: Improve Getting Started section

* docs: Following Getting Started show Usage to the README reader

* docs: Move the configuration tip to the Usage section

* docs: Move the cache store configuration comment to Usage

* docs: Clarify Responses title

* docs: allow2ban also uses the cache store

* docs: Improve Usage docs for blocking, safelisting and throttling

* docs: Don't give the impression that the gem is not being maintained when it actually is

* docs: Be a bit more clear about cache store in README

* docs: Attempt to be a bit more concise in the README intro

* docs: Clarify sentence
2018-03-29 11:42:27 -03:00
Domenoth
5004b04ac7 Change object type yielded to ActiveSupport::Subscribers
https://github.com/kickstarter/rack-attack/issues/255

Change the object type from instances of type Rack::Attack::Request to
instances of type Hash. (`req` becomes `request: req`).
2018-03-21 11:32:09 -07:00
Gonzalo Rodriguez
43eec3ab78
Merge pull request #248 from amirshadaab/add-requires-to-README
add require lines in README.md file
2018-03-12 11:47:50 -03:00
Amir Shadaab Mohammed
83ac0f7b0d add require lines in README.md file 2018-03-09 15:04:27 -06:00
Gonzalo Rodriguez
71c10d1ebe
Merge pull request #279 from tjnet/surpress_rubocop_complains_about_initalizer_file_name
fix rubocop complains about initializer file name (use snake_case)
2018-03-07 20:27:41 -03:00
Alex Taylor
993d724b64
Mention 'match_discriminator' in README.md 2018-03-05 17:21:36 -08:00
Kyle d'Oliveira
9dbece5272 Add an reader for the epoch_time variable in the cache so that it can also be returned in the data from the throttle.
This is allows access to the same time that the cache uses for the count. This can be important for clients that want to provide rate limit information for well-behaved clients
2018-02-15 14:45:35 -08:00
jun_tanaka555
70a4c1f933 fix rubocop complains about initializer file name 2018-02-04 16:18:54 +09:00
Gonzalo Rodriguez
16af283d28 Don't make README examples depend on activesupport 2018-01-31 19:12:52 -03:00
Gonzalo Rodriguez
34ee066eac Drop support for Rails 3 2018-01-23 16:12:16 -03:00
Gonzalo
aeca8e52b3 Update to new ruby hash syntax in docs 2018-01-17 11:05:22 -03:00
Aaron Suggs
dc308add10 README: add section for maintainers 2017-02-09 22:26:57 -05:00
Olle Jonsson
7285e721aa README: Badges as SVG not PNG 2017-01-16 12:24:25 +01:00
Julian Doherty (madlep)
2c853bae9d it's minitest, not rspec 2016-08-04 22:51:14 +10:00
Julian Doherty (madlep)
9402908db9 added discussion about how to run test suite 2016-08-04 21:49:43 +10:00
Aaron Suggs
b07537d51e README: add example for returning X-RateLimit-* headers 2016-08-03 14:04:00 -04:00
Aaron Suggs
eb9331fb8c whitespace 2016-07-04 21:42:44 -04:00
Aaron Suggs
f5f08d56e5 More safelist/blocklist refactoring
- Add Rack::Attack namespace to deprecation warning.
- Add deprecated Rack::Attack.blacklisted_response attr methods.
2016-07-04 21:42:41 -04:00
Renée Hendricksen
e1a0c804e1 suggesting changing whitelist/blacklist language to less controversial safelist/blocklist language
add deprication warnings

fix the method signatures
2016-07-01 21:44:45 -04:00
Aaron Suggs
3bbf9b0b5b Copyright Kickstarter, PBC 2016-05-18 06:27:47 -04:00
Leslie Zhang
7af55447cc Fix typo in README.md 2016-01-08 15:33:44 +08:00
Aaron Suggs
2b75edacfd Merge pull request #149 from watsonbox/readme-scoping-fail2ban
Add note to README.md about scoping of Fail2Ban filters
2015-12-18 09:00:03 -05:00
Aaron Suggs
b32148e0be README: add ipv6 example
Per #151
2015-11-30 10:52:15 -05:00
Howard Wilson
4d5e859a12 Add note to README.md about scoping of Fail2Ban filters 2015-11-09 13:43:50 +01:00
jamesprior
6d787147db Updating readme
Setting up example for multiple filter support, adding note to documentation
2015-11-06 10:01:54 -05:00
jamesprior
c8f8f85af2 Updating the readme
- Notes that the rails cache is also used for fail2ban
- Notes that all fail2ban filters use the same cache for counting and banning
- Expands sample fail2ban filter example to include more matches
2015-10-23 15:57:04 -04:00
Aaron Suggs
85968904ee Add Code of Conduct
From Contributor Covenant: http://contributor-covenant.org
2015-07-07 14:27:10 -04:00
Hayley Anderson
e1e315181a Fix typos
* Change "you Gemfile" to "your Gemfile"
* Change "config/initalizers" to "config/initializers"
2015-05-13 11:30:25 -04:00
Jun Jiang
0b3c638409 Update README.md 2015-04-19 06:14:03 +08:00
Aaron Suggs
77d0493bc4 README: link to Rack::Request documentation 2015-03-06 15:47:32 -05:00
Lucas "medk" Pinto
5fbe7de686 Change Rack::Request URL in the README 2015-03-06 13:37:33 +01:00
Aaron Suggs
e7efe1cf5f Merge pull request #91 from gsamokovarov/call-responses
Invoke Rack:::{blacklisted,throttled}_response with #call
2014-10-02 14:25:42 -04:00
Genadi Samokovarov
a161176142 Invoke {blacklisted,throttled}_response with #call
I have a response which is a class. While I can still have my class
implement `#[]`, it does look a bit off. On the other side, having
objects, responding to #call, that are not procs is pretty common.

So I propose to invoke the responses with `#call` to let users override
it with response objects, that respond to `#call` instead of `#[]`.
2014-09-25 23:21:02 +02:00
Genadi Samokovarov
d9a5587676 Allow throttle period option to be a proc
I need to filter requests on a period I need to get dynamically out of
information I have in the requests. Currently, I can work out the limit,
as it can be a `Proc`, however I can't do that with the period.

This PR adds support for that. Tried to do it in a way that doesn't
brake backwards compatibility, as periods are coerced to numbers during
`Rack::Throttle` initialization.
2014-09-19 19:32:39 +02:00
brchristian
4a724d8c8b Fix typo in README.md 2014-08-15 09:03:38 -07:00
Aaron Suggs
7820986d9c Merge pull request #74 from zmillman/readme-request
Improve documentation of Rack::Attack::Request
2014-08-01 14:43:53 -04:00
Zach Millman
882221212a Fix formatting of note on Rack::Attack::Request 2014-06-17 11:38:50 -07:00
Zach Millman
5c78f84be2 Improve documentation of Rack::Attack::Request
https://github.com/kickstarter/rack-attack/issues/73
2014-06-17 11:37:25 -07:00