rack-attack 4.0.1 → 4.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b2ad64c34913ec247b9f1952ec77a38762742151
-  data.tar.gz: f953e23413add27445c65ef5d058afc0c5dc2cb7
+  metadata.gz: 459c5b823f0b03b1d839e5577d1d57fc14332d2c
+  data.tar.gz: e8e15fe0e7619b07a9710160cd429dab4499f6c1
 SHA512:
-  metadata.gz: e2c8ebf7e34dae93d31c300ca035723794f1f185fecaa008fdf1f305697c6d1f36614ae6e5c1135be3722cbfd68b7ea1ef809d6f045f7858e6674dca837cbcc0
-  data.tar.gz: 6b8d3632cae6db709922e400e681b7e0742067baaf3596957af962ab13be55a5a445fee534b40279ae19ab3f50ae2cd8776d473359e06d8889c4b8b5e0b3dab0
+  metadata.gz: 67aad493c5a2b719de12f17a099e9e3ffabfe32fb33ba2d11b9c8149918a78e300fad9c56b786fcca2e328f898a022f0da158becf81304eba42928f1119a5f74
+  data.tar.gz: 4cc797bcb7a7e88fe7b9df2c016b6aeb766dc71007d8124b3d3cd4b1e7da4e6d0695de0465f21afc798aafc81f0b6ac3dbe5f8cdc4f05e856bca49a69e49ce70

data/README.md

@@ -39,7 +39,7 @@ use Rack::Attack
 Add a `rack-attack.rb` file to `config/initalizers/`:
 ```ruby
 # In config/initializers/rack-attack.rb
-module Rack::Attack
+class Rack::Attack
   # your custom configuration...
 end
 ```
@@ -188,11 +188,16 @@ end
 ### Tracks
 
 ```ruby
-# Track requests from a special user agent
+# Track requests from a special user agent.
 Rack::Attack.track("special_agent") do |req|
   req.user_agent == "SpecialAgent"
 end
 
+# Supports optional limit and period, triggers the notification only when the limit is reached.
+Rack::Attack.track("special_agent", :limit 6, :period => 60.seconds) do |req|
+  req.user_agent == "SpecialAgent"
+end
+
 # Track it using ActiveSupport::Notification
 ActiveSupport::Notifications.subscribe("rack.attack") do |name, start, finish, request_id, req|
   if req.env['rack.attack.matched'] == "special_agent" && req.env['rack.attack.match_type'] == :track

data/lib/rack/attack.rb

@@ -31,8 +31,8 @@ class Rack::Attack
       self.throttles[name] = Throttle.new(name, options, block)
     end
 
-    def track(name, &block)
-      self.tracks[name] = Track.new(name, block)
+    def track(name, options = {}, &block)
+      self.tracks[name] = Track.new(name, options, block)
     end
 
     def whitelists; @whitelists ||= {}; end
@@ -73,17 +73,17 @@ class Rack::Attack
     end
 
     def clear!
-      @whitelists, @blacklists, @throttles = {}, {}, {}
+      @whitelists, @blacklists, @throttles, @tracks = {}, {}, {}, {}
     end
 
   end
 
   # Set defaults
   @notifier             = ActiveSupport::Notifications if defined?(ActiveSupport::Notifications)
-  @blacklisted_response = lambda {|env| [403, {}, ["Forbidden\n"]] }
+  @blacklisted_response = lambda {|env| [403, {'Content-Type' => 'text/plain'}, ["Forbidden\n"]] }
   @throttled_response   = lambda {|env|
     retry_after = env['rack.attack.match_data'][:period] rescue nil
-    [429, {'Retry-After' => retry_after.to_s}, ["Retry later\n"]]
+    [429, {'Content-Type' => 'text/plain', 'Retry-After' => retry_after.to_s}, ["Retry later\n"]]
   }
 
   def initialize(app)

data/lib/rack/attack/check.rb

@@ -2,9 +2,9 @@ module Rack
   class Attack
     class Check
       attr_reader :name, :block, :type
-      def initialize(name, block)
+      def initialize(name, options = {}, block)
         @name, @block = name, block
-        @type = nil
+        @type = options.fetch(:type, nil)
       end
 
       def [](req)

data/lib/rack/attack/throttle.rb

@@ -2,7 +2,7 @@ module Rack
   class Attack
     class Throttle
       MANDATORY_OPTIONS = [:limit, :period]
-      attr_reader :name, :limit, :period, :block
+      attr_reader :name, :limit, :period, :block, :type
       def initialize(name, options, block)
         @name, @block = name, block
         MANDATORY_OPTIONS.each do |opt|
@@ -10,6 +10,7 @@ module Rack
         end
         @limit  = options[:limit]
         @period = options[:period].to_i
+        @type   = options.fetch(:type, :throttle)
       end
 
       def cache
@@ -34,7 +35,7 @@ module Rack
           if throttled
             req.env['rack.attack.matched']             = name
             req.env['rack.attack.match_discriminator'] = discriminator
-            req.env['rack.attack.match_type']          = :throttle
+            req.env['rack.attack.match_type']          = type
             req.env['rack.attack.match_data']          = data
             Rack::Attack.instrument(req)
           end

data/lib/rack/attack/track.rb

@@ -1,10 +1,21 @@
 module Rack
   class Attack
-    class Track < Check
-      def initialize(name, block)
-        super
-        @type = :track
+    class Track
+      extend Forwardable
+
+      attr_reader :filter
+
+      def initialize(name, options = {}, block)
+        options[:type] = :track
+
+        if options[:limit] && options[:period]
+          @filter = Throttle.new(name, options, block)
+        else
+          @filter = Check.new(name, options, block)
+        end
       end
+
+      def_delegator :@filter, :[]
     end
   end
 end

data/lib/rack/attack/version.rb

@@ -1,5 +1,5 @@
 module Rack
   class Attack
-    VERSION = '4.0.1'
+    VERSION = '4.1.0'
   end
 end

data/spec/rack_attack_track_spec.rb

@@ -41,4 +41,18 @@ describe 'Rack::Attack.track' do
       Counter.check.must_equal 2
     end
   end
+
+  describe "without limit and period options" do
+    it "should assign the track filter to a Check instance" do
+      tracker = Rack::Attack.track("homepage") { |req| req.path == "/"}
+      tracker.filter.class.must_equal Rack::Attack::Check
+    end
+  end
+
+  describe "with limit and period options" do
+    it "should assign the track filter to a Throttle instance" do
+      tracker = Rack::Attack.track("homepage", :limit => 10, :period => 10) { |req| req.path == "/"}
+      tracker.filter.class.must_equal Rack::Attack::Throttle
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rack-attack
 version: !ruby/object:Gem::Version
-  version: 4.0.1
+  version: 4.1.0
 platform: ruby
 authors:
 - Aaron Suggs
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-14 00:00:00.000000000 Z
+date: 2014-05-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack