rack-defense 0.2.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e7bada9c179abe1e025f6c215e373df5cb17927c
-  data.tar.gz: 04be29b5ea39a050be5d75fe6e03b1c4383a9681
+  metadata.gz: dd445dc72ae32d2d2c249b55e5e43134d5693520
+  data.tar.gz: fca8260313829448c683a6f2f0fc3585d33c413b
 SHA512:
-  metadata.gz: 3cc00287d01a0a63ae7b9864a27e7266dcb023cf1fe3fc2eef5b9bced4ed203606f0b477f846f5431b5136ee76b934a259e99a39eacebe6f1424386a4d9e71a6
-  data.tar.gz: f957e905c4ed10a0228550d082bc7919bf035081e4775d952151aff170ca6124c289d40ab9db2df97a9d09bbf3340dd3b934ee34d82798fd016a48d3b84d6e82
+  metadata.gz: 6dc5a88acda42bccaa4df59a65810ea0c8ec26452d044516d07ea7d7bcebcc92cf2895a0f9c7bc169aaedb70ecfd855ec67ebfcb68fae40c1708c2395e6bcb1a
+  data.tar.gz: d11ad7a9acdcca424ef644287aa74a8337e791233f8a23cf4698bbf0ec1a133ab401b4c20430bc82e7d4b97f7682ae130a886e7c7ce95261d9b40c4373f9c157

data/README.md

@@ -11,9 +11,9 @@ A Rack middleware for throttling and filtering requests.
 
 Rack::Defense is a Rack middleware that allows to easily add request rate limiting and request filtering to your Rack based application (Ruby On Rails, Sinatra etc.).
 
-* Request throttling (aka rate limiting) happens on __sliding window__ using the provided period, request criteria and maximum request number. It uses Redis to track the request rate.
+* [Request throttling](#throttling) (aka rate limiting) happens on __sliding window__ using the provided period, request criteria and maximum request number. It uses Redis to track the request rate.
 
-* Request filtering bans (rejects) requests based on provided criteria.
+* [Request filtering](#filtering) bans (rejects) requests based on provided criteria.
 
 Rack::Defense has a small footprint and only two dependencies: [rack](https://github.com/rack/rack) and [redis](https://github.com/redis/redis-rb).
 
@@ -116,7 +116,7 @@ Rack::Defense can reject requests based on arbitrary properties of the request.
 
 ### Examples
 
-Allow only a whitelist of ips for a given path:
+Allow only a whitelist of IPs for a given path:
 
 ```ruby
 Rack::Defense.setup do |config|
@@ -126,6 +126,17 @@ Rack::Defense.setup do |config|
 end
 ```
 
+Deny access to a blacklist of application users. Again, we assume here that 
+[Warden](https://github.com/hassox/warden) or any Warden based authentication wrapper, like [Devise](https://github.com/plataformatec/devise), is used:
+
+```ruby
+Rack::Defense.setup do |config|
+  config.ban('user_blacklist') do |req|
+    ['hacker@example.com', 'badguy@example.com'].include? req.env['warden'].user.email
+  end 
+end
+```
+
 Allow only requests with a known API authorization token:
 
 ```ruby
@@ -178,6 +189,35 @@ Rack::Defense.setup do |config|
 end
 ```
 
+## Advanced Examples
+
+### Temporarily suspend access to suspicious IPs
+
+In this example, when an IP is exceeding the permitted request rate, we would like to ban this IP for a given period of time:
+
+```ruby
+Rack::Defense.setup do |config|
+  config.throttle('reset_password', 10, 10.minutes.in_milliseconds) do |req|
+    req.ip if req.path == '/api/users/password' && req.post?
+  end
+
+  config.after_throttle do |req, rules|
+    config.store.setex("ban:ip:#{req.ip}", 1.hour, 1) if rules.key? 'reset_password'
+  end
+
+  config.ban('blacklist') do |req|
+    config.store.exists("ban:ip:#{req.ip}")
+  end
+end
+```
+
+The first rule named `reset_password` defines the maximum permitted rate per IP for post requests on path
+`/api/users/password`. Once a user exceeds this limit, it gets throttled and denied access to the resource.
+This raises a throttle event and triggers the `after_throttle` callback defined above. The callback sets a key in the redis store post-fixed with the user IP and having 1 hour an expiration time.
+
+The last rule named `blacklist` looks up each incoming request IP and checks if it has a corresponding ban key
+in redis. If the request IP matches a ban key it gets denied.
+
 ## License
 
 Licensed under the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -1,7 +1,8 @@
 require 'rake/testtask'
+require 'bundler/gem_tasks'
 
 Rake::TestTask.new(:test) do |t|
-  t.pattern = "spec/*_spec.rb"
+  t.pattern = 'spec/*_spec.rb'
 end
 
-task :default => :test
+task default: :test

data/lib/rack/defense/version.rb

@@ -1,5 +1,5 @@
 module Rack
   class Defense
-    VERSION = '0.2.1'
+    VERSION = '0.2.2'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rack-defense
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors:
 - Chaker Nakhli
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-30 00:00:00.000000000 Z
+date: 2015-07-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack