improved-rack-throttle 0.6.0 → 0.7.0

data/Gemfile

@@ -1,6 +1,6 @@
 source "http://rubygems.org"
 
-gem "rack", "~> 1.0.0"
+gem "rack", ">= 1.0.0"
 
 group :development, :test do
   gem 'timecop',   '~> 0.5.2'

data/Gemfile.lock

@@ -9,7 +9,7 @@ GEM
       rake
       rdoc
     json (1.7.5)
-    rack (1.0.1)
+    rack (1.4.1)
     rack-test (0.6.2)
       rack (>= 1.0)
     rake (0.9.2.2)
@@ -31,7 +31,7 @@ PLATFORMS
 
 DEPENDENCIES
   jeweler
-  rack (~> 1.0.0)
+  rack (>= 1.0.0)
   rack-test (~> 0.6.2)
   rake
   rspec (~> 2.11.0)

data/improved-rack-throttle.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "improved-rack-throttle"
-  s.version = "0.6.0"
+  s.version = "0.7.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Ben Somers", "Arto Bendiken", "Brendon Murphy"]
-  s.date = "2012-10-03"
+  s.date = "2012-10-05"
   s.description = "Rack middleware for rate-limiting incoming HTTP requests."
   s.email = "somers.ben@gmail.com"
   s.extra_rdoc_files = [
@@ -31,24 +31,26 @@ Gem::Specification.new do |s|
     "etc/redis.ru",
     "improved-rack-throttle.gemspec",
     "lib/rack/throttle.rb",
-    "lib/rack/throttle/daily.rb",
-    "lib/rack/throttle/hourly.rb",
-    "lib/rack/throttle/interval.rb",
-    "lib/rack/throttle/limiter.rb",
-    "lib/rack/throttle/matcher.rb",
+    "lib/rack/throttle/limiters/daily.rb",
+    "lib/rack/throttle/limiters/hourly.rb",
+    "lib/rack/throttle/limiters/interval.rb",
+    "lib/rack/throttle/limiters/limiter.rb",
+    "lib/rack/throttle/limiters/sliding_window.rb",
+    "lib/rack/throttle/limiters/time_window.rb",
+    "lib/rack/throttle/matchers/matcher.rb",
     "lib/rack/throttle/matchers/method_matcher.rb",
     "lib/rack/throttle/matchers/url_matcher.rb",
     "lib/rack/throttle/matchers/user_agent_matcher.rb",
-    "lib/rack/throttle/time_window.rb",
     "lib/rack/throttle/version.rb",
-    "spec/daily_spec.rb",
-    "spec/hourly_spec.rb",
-    "spec/interval_spec.rb",
-    "spec/limiter_spec.rb",
-    "spec/method_matcher_spec.rb",
-    "spec/spec_helper.rb",
-    "spec/url_matcher_spec.rb",
-    "spec/user_agent_matcher_spec.rb"
+    "spec/limiters/daily_spec.rb",
+    "spec/limiters/hourly_spec.rb",
+    "spec/limiters/interval_spec.rb",
+    "spec/limiters/limiter_spec.rb",
+    "spec/limiters/sliding_window_spec.rb",
+    "spec/matchers/method_matcher_spec.rb",
+    "spec/matchers/url_matcher_spec.rb",
+    "spec/matchers/user_agent_matcher_spec.rb",
+    "spec/spec_helper.rb"
   ]
   s.homepage = "http://github.com/bensomers/improved-rack-throttle"
   s.licenses = ["Public Domain"]
@@ -60,7 +62,7 @@ Gem::Specification.new do |s|
     s.specification_version = 3
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<rack>, ["~> 1.0.0"])
+      s.add_runtime_dependency(%q<rack>, [">= 1.0.0"])
       s.add_development_dependency(%q<timecop>, ["~> 0.5.2"])
       s.add_development_dependency(%q<rack-test>, ["~> 0.6.2"])
       s.add_development_dependency(%q<rspec>, ["~> 2.11.0"])
@@ -68,7 +70,7 @@ Gem::Specification.new do |s|
       s.add_development_dependency(%q<rake>, [">= 0"])
       s.add_development_dependency(%q<jeweler>, [">= 0"])
     else
-      s.add_dependency(%q<rack>, ["~> 1.0.0"])
+      s.add_dependency(%q<rack>, [">= 1.0.0"])
       s.add_dependency(%q<timecop>, ["~> 0.5.2"])
       s.add_dependency(%q<rack-test>, ["~> 0.6.2"])
       s.add_dependency(%q<rspec>, ["~> 2.11.0"])
@@ -77,7 +79,7 @@ Gem::Specification.new do |s|
       s.add_dependency(%q<jeweler>, [">= 0"])
     end
   else
-    s.add_dependency(%q<rack>, ["~> 1.0.0"])
+    s.add_dependency(%q<rack>, [">= 1.0.0"])
     s.add_dependency(%q<timecop>, ["~> 0.5.2"])
     s.add_dependency(%q<rack-test>, ["~> 0.6.2"])
     s.add_dependency(%q<rspec>, ["~> 2.11.0"])

data/lib/rack/throttle/{limiter.rb → limiters/limiter.rb}

@@ -20,7 +20,6 @@ module Rack; module Throttle
     # @option options [String]  :key_prefix (nil)
     # @option options [Integer] :code       (403)
     # @option options [String]  :message    ("Rate Limit Exceeded")
-    # @option options [Regexp]  :url_rule   (nil)
     def initialize(app, options = {})
       rules = options.delete(:rules) || {}
       @app, @options, @matchers = app, options, []

data/lib/rack/throttle/limiters/sliding_window.rb

@@ -0,0 +1,79 @@
+module Rack; module Throttle
+  ##
+  # This rate limiter strategy throttles the application with
+  # a sliding window (implemented as a leaky bucket). It operates
+  # on second-level resolution. It takes :burst and :average 
+  # options, which correspond to the maximum size of a traffic 
+  # burst, and the maximum allowed average traffic level.
+  class SlidingWindow < Limiter
+    ##
+    # @param  [#call]                    app
+    # @param  [Hash{Symbol => Object}]   options
+    # @option options [Integer] :burst   5
+    # @option options [Float] :average   1
+    def initialize(app, options = {})
+      super
+      options[:burst] ||= 5
+      options[:average] ||= 1
+    end
+
+    ##
+    # Returns `true` if sufficient time (equal to or more than
+    # {#minimum_interval}) has passed since the last request and the given
+    # present `request`.
+    #
+    # @param  [Rack::Request] request
+    # @return [Boolean]
+    def allowed?(request)
+      t1 = request_start_time(request)
+      key = cache_key(request)
+      bucket = cache_get(key) rescue nil
+      bucket ||= LeakyBucket.new(options[:burst], options[:average])
+      bucket.maximum, bucket.outflow = options[:burst], options[:average]
+      bucket.leak! 
+      bucket.increment!
+      allowed = !bucket.full?
+      begin
+        cache_set(key, bucket)
+        allowed
+      rescue StandardError => e
+        allowed = true
+        # If an error occurred while trying to update the timestamp stored
+        # in the cache, we will fall back to allowing the request through.
+        # This prevents the Rack application blowing up merely due to a
+        # backend cache server (Memcached, Redis, etc.) being offline.
+      end
+    end
+
+    class LeakyBucket
+      attr_accessor :maximum, :outflow
+      attr_reader :count, :last_touched
+
+      def initialize(maximum, outflow)
+        @maximum, @outflow = maximum, outflow
+        @count, @last_touched = 0, Time.now
+      end
+
+      def leak!
+        t = Time.now
+        time = t - last_touched
+        loss = (outflow * time).to_f
+        if loss > 0
+          @count -= loss
+          @last_touched = t 
+        end
+      end
+
+      def increment!
+        @count = 0 if count < 0
+        @count += 1
+        @count = maximum if count > maximum
+      end
+
+      def full?
+        count == maximum
+      end
+    end
+
+  end
+end; end

data/lib/rack/throttle/version.rb

@@ -1,7 +1,7 @@
 module Rack; module Throttle
   module VERSION
     MAJOR = 0
-    MINOR = 6
+    MINOR = 7
     TINY  = 0
     EXTRA = nil
 

data/lib/rack/throttle.rb

@@ -2,15 +2,16 @@ require 'rack'
 
 module Rack
   module Throttle
-    autoload :Limiter,       'rack/throttle/limiter'
-    autoload :Interval,      'rack/throttle/interval'
-    autoload :TimeWindow,    'rack/throttle/time_window'
-    autoload :Daily,         'rack/throttle/daily'
-    autoload :Hourly,        'rack/throttle/hourly'
-    autoload :VERSION,       'rack/throttle/version'
-    autoload :Matcher,       'rack/throttle/matcher'
-    autoload :UrlMatcher,    'rack/throttle/matchers/url_matcher'
-    autoload :MethodMatcher, 'rack/throttle/matchers/method_matcher'
+    autoload :Limiter,          'rack/throttle/limiters/limiter'
+    autoload :Interval,         'rack/throttle/limiters/interval'
+    autoload :TimeWindow,       'rack/throttle/limiters/time_window'
+    autoload :Daily,            'rack/throttle/limiters/daily'
+    autoload :Hourly,           'rack/throttle/limiters/hourly'
+    autoload :SlidingWindow,    'rack/throttle/limiters/sliding_window'
+    autoload :VERSION,          'rack/throttle/version'
+    autoload :Matcher,          'rack/throttle/matchers/matcher'
+    autoload :UrlMatcher,       'rack/throttle/matchers/url_matcher'
+    autoload :MethodMatcher,    'rack/throttle/matchers/method_matcher'
     autoload :UserAgentMatcher, 'rack/throttle/matchers/user_agent_matcher'
   end
 end

data/spec/{daily_spec.rb → limiters/daily_spec.rb}

@@ -1,4 +1,4 @@
-require File.dirname(__FILE__) + '/spec_helper'
+require File.join(File.dirname(__FILE__), '..', 'spec_helper')
 
 describe Rack::Throttle::Daily do
   include Rack::Test::Methods

data/spec/{hourly_spec.rb → limiters/hourly_spec.rb}

@@ -1,4 +1,4 @@
-require File.dirname(__FILE__) + '/spec_helper'
+require File.join(File.dirname(__FILE__), '..', 'spec_helper')
 
 describe Rack::Throttle::Hourly do
   include Rack::Test::Methods

data/spec/{interval_spec.rb → limiters/interval_spec.rb}

@@ -1,4 +1,4 @@
-require File.dirname(__FILE__) + '/spec_helper'
+require File.join(File.dirname(__FILE__), '..', 'spec_helper')
 
 
 describe Rack::Throttle::Interval do

data/spec/{limiter_spec.rb → limiters/limiter_spec.rb}

@@ -1,4 +1,4 @@
-require File.dirname(__FILE__) + '/spec_helper'
+require File.join(File.dirname(__FILE__), '..', 'spec_helper')
 
 describe Rack::Throttle::Limiter do
   include Rack::Test::Methods

data/spec/limiters/sliding_window_spec.rb

@@ -0,0 +1,67 @@
+require File.join(File.dirname(__FILE__), '..', 'spec_helper')
+
+describe Rack::Throttle::SlidingWindow do
+  include Rack::Test::Methods
+
+  def app
+    @target_app ||= example_target_app
+    @app ||= Rack::Throttle::SlidingWindow.new(@target_app, :burst => 2, :average => 1)
+  end
+
+  before(:each) do
+    @time = Time.now
+    Timecop.freeze
+  end
+
+  after(:each) do
+    Timecop.return
+  end
+
+  it "should allow the request if the source has not been seen at all" do
+    get "/foo"
+    last_response.body.should show_allowed_response
+  end
+  
+  it "should allow the request if the rate is above-average but within the burst rule" do
+    Timecop.freeze(@time) { get "/foo" }
+    Timecop.freeze(@time + 0.5) { get "/foo" }
+    last_response.body.should show_allowed_response
+  end
+
+   it "should not allow the request if the rate is greater than the burst rule" do
+    Timecop.freeze(@time) { get "/foo" }
+    Timecop.freeze(@time + 0.3) { get "/foo" }
+    Timecop.freeze(@time + 0.6) { get "/foo" }
+    last_response.body.should show_throttled_response
+  end
+  
+  it "should allow the request if the rate is less than the average" do
+    Timecop.freeze(@time) { get "/foo" }
+    Timecop.freeze(@time + 0.5) { get "/foo" }
+    Timecop.freeze(@time + 2) { get "/foo" }
+
+    last_response.body.should show_allowed_response
+  end
+
+  it "should not allow the request if the rate is more than the average" do
+    Timecop.freeze(@time) { get "/foo" }
+    Timecop.freeze(@time + 0.5) { get "/foo" }
+    Timecop.freeze(@time + 1) { get "/foo" }
+    Timecop.freeze(@time + 1.5) { get "/foo" }
+
+    last_response.body.should show_throttled_response
+  end
+
+  it "should gracefully allow the request if the cache bombs on getting" do
+    app.should_receive(:cache_get).and_raise(StandardError)
+    get "/foo"
+    last_response.body.should show_allowed_response
+  end
+  
+  it "should gracefully allow the request if the cache bombs on setting" do
+    app.should_receive(:cache_set).and_raise(StandardError)
+    get "/foo"
+    last_response.body.should show_allowed_response
+  end
+end
+

data/spec/{method_matcher_spec.rb → matchers/method_matcher_spec.rb}

@@ -1,4 +1,4 @@
-require File.dirname(__FILE__) + '/spec_helper'
+require File.join(File.dirname(__FILE__), '..', 'spec_helper')
 
 describe Rack::Throttle::MethodMatcher do
   include Rack::Test::Methods
@@ -25,5 +25,3 @@ describe Rack::Throttle::MethodMatcher do
     app.send(:cache_key, last_request).should == "127.0.0.1:meth-post"
   end
 end
-
-

data/spec/{url_matcher_spec.rb → matchers/url_matcher_spec.rb}

@@ -1,4 +1,4 @@
-require File.dirname(__FILE__) + '/spec_helper'
+require File.join(File.dirname(__FILE__), '..', 'spec_helper')
 
 describe Rack::Throttle::UrlMatcher do
   include Rack::Test::Methods

data/spec/{user_agent_matcher_spec.rb → matchers/user_agent_matcher_spec.rb}

@@ -1,4 +1,4 @@
-require File.dirname(__FILE__) + '/spec_helper'
+require File.join(File.dirname(__FILE__), '..', 'spec_helper')
 
 describe Rack::Throttle::UserAgentMatcher do
   include Rack::Test::Methods
@@ -13,7 +13,7 @@ describe Rack::Throttle::UserAgentMatcher do
     get "/foo"
     last_response.body.should show_allowed_response
   end
-  
+
   it "should check if the path matches the rule" do
     app.should_receive(:allowed?).and_return(false)
     header 'User-Agent', 'blahdeblah GoogleBot owns your soul'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: improved-rack-throttle
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
   prerelease: 
 platform: ruby
 authors:
@@ -11,22 +11,22 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-03 00:00:00.000000000 Z
+date: 2012-10-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
-  requirement: &70147455830820 !ruby/object:Gem::Requirement
+  requirement: &70296124961520 !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: 1.0.0
   type: :runtime
   prerelease: false
-  version_requirements: *70147455830820
+  version_requirements: *70296124961520
 - !ruby/object:Gem::Dependency
   name: timecop
-  requirement: &70147455830340 !ruby/object:Gem::Requirement
+  requirement: &70296124960800 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -34,10 +34,10 @@ dependencies:
         version: 0.5.2
   type: :development
   prerelease: false
-  version_requirements: *70147455830340
+  version_requirements: *70296124960800
 - !ruby/object:Gem::Dependency
   name: rack-test
-  requirement: &70147455829840 !ruby/object:Gem::Requirement
+  requirement: &70296124960000 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -45,10 +45,10 @@ dependencies:
         version: 0.6.2
   type: :development
   prerelease: false
-  version_requirements: *70147455829840
+  version_requirements: *70296124960000
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70147455829140 !ruby/object:Gem::Requirement
+  requirement: &70296124959520 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -56,10 +56,10 @@ dependencies:
         version: 2.11.0
   type: :development
   prerelease: false
-  version_requirements: *70147455829140
+  version_requirements: *70296124959520
 - !ruby/object:Gem::Dependency
   name: yard
-  requirement: &70147455828360 !ruby/object:Gem::Requirement
+  requirement: &70296124958980 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -67,10 +67,10 @@ dependencies:
         version: 0.5.5
   type: :development
   prerelease: false
-  version_requirements: *70147455828360
+  version_requirements: *70296124958980
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70147455844160 !ruby/object:Gem::Requirement
+  requirement: &70296124958220 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -78,10 +78,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70147455844160
+  version_requirements: *70296124958220
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &70147455843680 !ruby/object:Gem::Requirement
+  requirement: &70296124957640 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -89,7 +89,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70147455843680
+  version_requirements: *70296124957640
 description: Rack middleware for rate-limiting incoming HTTP requests.
 email: somers.ben@gmail.com
 executables: []
@@ -112,24 +112,26 @@ files:
 - etc/redis.ru
 - improved-rack-throttle.gemspec
 - lib/rack/throttle.rb
-- lib/rack/throttle/daily.rb
-- lib/rack/throttle/hourly.rb
-- lib/rack/throttle/interval.rb
-- lib/rack/throttle/limiter.rb
-- lib/rack/throttle/matcher.rb
+- lib/rack/throttle/limiters/daily.rb
+- lib/rack/throttle/limiters/hourly.rb
+- lib/rack/throttle/limiters/interval.rb
+- lib/rack/throttle/limiters/limiter.rb
+- lib/rack/throttle/limiters/sliding_window.rb
+- lib/rack/throttle/limiters/time_window.rb
+- lib/rack/throttle/matchers/matcher.rb
 - lib/rack/throttle/matchers/method_matcher.rb
 - lib/rack/throttle/matchers/url_matcher.rb
 - lib/rack/throttle/matchers/user_agent_matcher.rb
-- lib/rack/throttle/time_window.rb
 - lib/rack/throttle/version.rb
-- spec/daily_spec.rb
-- spec/hourly_spec.rb
-- spec/interval_spec.rb
-- spec/limiter_spec.rb
-- spec/method_matcher_spec.rb
+- spec/limiters/daily_spec.rb
+- spec/limiters/hourly_spec.rb
+- spec/limiters/interval_spec.rb
+- spec/limiters/limiter_spec.rb
+- spec/limiters/sliding_window_spec.rb
+- spec/matchers/method_matcher_spec.rb
+- spec/matchers/url_matcher_spec.rb
+- spec/matchers/user_agent_matcher_spec.rb
 - spec/spec_helper.rb
-- spec/url_matcher_spec.rb
-- spec/user_agent_matcher_spec.rb
 homepage: http://github.com/bensomers/improved-rack-throttle
 licenses:
 - Public Domain
@@ -145,7 +147,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1924272463384256508
+      hash: 3964473901145440251
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: