rack-attack 1.2.0 → 1.3.0

data/README.md

@@ -60,7 +60,9 @@ Note that `req` is a [Rack::Request](http://rack.rubyforge.org/doc/classes/Rack/
 
     # Throttle requests to 5 requests per second per ip
     Rack::Attack.throttle('req/ip', :limit => 5, :period => 1.second) do |req|
-      # If the return value is truthy, the cache key for "rack::attack:req/ip:#{req.ip}" is incremented and checked.
+      # If the return value is truthy, the cache key for
+      # "rack::attack:#{Time.now.to_i/1.second}:req/ip:#{req.ip}"
+      # is incremented and compared with the limit.
       # If falsy, the cache key is neither incremented or checked.
       req.ip
     end
@@ -100,6 +102,11 @@ Similarly for blacklisted responses:
       [ 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 }
+
 ## Logging & Instrumentation
 
 Rack::Attack uses the [ActiveSupport::Notifications](http://api.rubyonrails.org/classes/ActiveSupport/Notifications.html) API if available.

data/lib/rack/attack/cache.rb

@@ -8,12 +8,12 @@ module Rack
         @prefix = 'rack::attack'
       end
 
-      def count(unprefixed_key, expires_in)
-        key = "#{prefix}:#{unprefixed_key}"
-        result = store.increment(key, 1, :expires_in => expires_in)
+      def count(unprefixed_key, period)
+        key = "#{prefix}:#{Time.now.to_i/period}:#{unprefixed_key}"
+        result = store.increment(key, 1)
         # NB: Some stores return nil when incrementing uninitialized values
         if result.nil?
-          store.write(key, 1, :expires_in => expires_in)
+          store.write(key, 1)
         end
         result || 1
       end

data/lib/rack/attack/throttle.rb

@@ -21,11 +21,18 @@ module Rack
 
         key = "#{name}:#{discriminator}"
         count = cache.count(key, period)
+        data = {
+          :count => count,
+          :period => period,
+          :limit => limit
+        }
+        (req.env['rack.attack.throttle_data'] ||= {})[name] = data
+
         (count > limit).tap do |throttled|
           if throttled
             req.env['rack.attack.matched']    = name
             req.env['rack.attack.match_type'] = :throttle
-            req.env['rack.attack.match_data'] = {:count => count, :period => period, :limit => limit}
+            req.env['rack.attack.match_data'] = data
             Rack::Attack.instrument(req)
           end
         end

data/lib/rack/attack/version.rb

@@ -1,5 +1,5 @@
 module Rack
   module Attack
-    VERSION = '1.2.0'
+    VERSION = '1.3.0'
   end
 end

data/spec/rack_attack_spec.rb

@@ -67,8 +67,9 @@ describe 'Rack::Attack' do
 
   describe 'with a throttle' do
     before do
+      @period = 60 # Use a long period; failures due to cache key rotation less likely
       Rack::Attack.cache.store = ActiveSupport::Cache::MemoryStore.new
-      Rack::Attack.throttle('ip/sec', :limit => 1, :period => 1) { |req| req.ip }
+      Rack::Attack.throttle('ip/sec', :limit => 1, :period => @period) { |req| req.ip }
     end
 
     it('should have a throttle'){ Rack::Attack.throttles.key?('ip/sec') }
@@ -77,7 +78,13 @@ describe 'Rack::Attack' do
     describe 'a single request' do
       before { get '/', {}, 'REMOTE_ADDR' => '1.2.3.4' }
       it 'should set the counter for one request' do
-        Rack::Attack.cache.store.read('rack::attack:ip/sec:1.2.3.4').must_equal 1
+        key = "rack::attack:#{Time.now.to_i/@period}:ip/sec:1.2.3.4"
+        Rack::Attack.cache.store.read(key).must_equal 1
+      end
+
+      it 'should populate throttle data' do
+        data = { :count => 1, :limit => 1, :period => @period }
+        last_request.env['rack.attack.throttle_data']['ip/sec'].must_equal data
       end
     end
     describe "with 2 requests" do
@@ -90,10 +97,10 @@ describe 'Rack::Attack' do
       it 'should tag the env' do
         last_request.env['rack.attack.matched'].must_equal 'ip/sec'
         last_request.env['rack.attack.match_type'].must_equal :throttle
-        last_request.env['rack.attack.match_data'].must_equal({:count => 2, :limit => 1, :period => 1})
+        last_request.env['rack.attack.match_data'].must_equal({:count => 2, :limit => 1, :period => @period})
       end
       it 'should set a Retry-After header' do
-        last_response.headers['Retry-After'].must_equal '1'
+        last_response.headers['Retry-After'].must_equal @period.to_s
       end
     end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rack-attack
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-08-06 00:00:00.000000000 Z
+date: 2012-08-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack