improved-rack-throttle 0.5.0 → 0.6.0

data/README.md

@@ -15,10 +15,13 @@ Features
   subsequent HTTP requests from a particular client, as well as by defining
   a maximum number of allowed HTTP requests per a given time period (hourly
   or daily).
+* Scopes throttling rules by request path, http method, or user_agent
+  for applications that need a variety of rules
 * Compatible with any Rack application and any Rack-based framework.
 * Stores rate-limiting counters in any key/value store implementation that
   responds to `#[]`/`#[]=` (like Ruby's hashes) or to `#get`/`#set` (like
-  memcached or Redis).
+  memcached or Redis). This makes it easy to use global counters across
+  multiple web servers.
 * Compatible with the [gdbm][] binding included in Ruby's standard library.
 * Compatible with the [memcached][], [memcache-client][], [memcache][] and
   [redis][] gems.
@@ -92,6 +95,10 @@ Examples
     
     use Rack::Throttle::Interval, :cache => Redis.new, :key_prefix => :throttle
 
+### Scoping the rate-limit to a specific path and method
+
+    use Rack::Throttle::Interval, :rules => {:url => /api/, :method => :post}
+
 Throttling Strategies
 ---------------------
 
@@ -115,6 +122,17 @@ significantly more complex than what we've provided for, you can also define
 entirely new kinds of throttling strategies by subclassing the
 `Rack::Throttle::Limiter` base class directly.
 
+Scoping Rules
+-------------
+Rack::Throttle ships with a Rack::Throttle::Matcher base class, and three
+implementations of it. Rack::Throttle::UrlMatcher and
+Rack::Throttle::UserAgentMatcher allow you to pass in regular expressions
+for request path and user agent, while Rack::Throttle::MethodMatcher
+will filter by request method when passed a Symbol :get, :post, :put, or
+:delete. These rules are additive, so you can throttle just POST
+requests to your '/login' page, for example.
+
+
 HTTP Client Identification
 --------------------------
 
@@ -158,6 +176,7 @@ status code by passing in a `:code => 503` option when constructing a
 
 Documentation
 -------------
+OUT OF DATE
 
 <http://datagraph.rubyforge.org/rack-throttle/>
 
@@ -177,23 +196,23 @@ Installation
 The recommended installation method is via [RubyGems](http://rubygems.org/).
 To install the latest official release of the gem, do:
 
-    % [sudo] gem install rack-throttle
+    % [sudo] gem install improved-rack-throttle
 
 Download
 --------
 
 To get a local working copy of the development repository, do:
 
-    % git clone git://github.com/datagraph/rack-throttle.git
+    % git clone git://github.com/bensomers/improved-rack-throttle.git
 
 Alternatively, you can download the latest development version as a tarball
 as follows:
 
-    % wget http://github.com/datagraph/rack-throttle/tarball/master
+    % wget http://github.com/bensomers/improved-rack-throttle/tarball/master
 
 Authors
 -------
-
+* [Ben Somers](mailto:somers.ben@gmail.com) - <http://www.somanyrobots.com>
 * [Arto Bendiken](mailto:arto.bendiken@gmail.com) - <http://ar.to/>
 * [Brendon Murphy](mailto:disposable.20.xternal@spamourmet.com>) - <http://www.techfreak.net/>
 
@@ -211,3 +230,8 @@ information, see <http://unlicense.org/> or the accompanying UNLICENSE file.
 [redis]:           http://rubygems.org/gems/redis
 [Heroku]:          http://heroku.com/
 [Heroku memcache]: http://docs.heroku.com/memcache
+
+Support
+-------
+
+Recent work on improved-rack-throttle has been funded by Rafter, Inc.

data/improved-rack-throttle.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = "improved-rack-throttle"
-  s.version = "0.5.0"
+  s.version = "0.6.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Ben Somers", "Arto Bendiken", "Brendon Murphy"]
@@ -13,10 +13,12 @@ Gem::Specification.new do |s|
   s.description = "Rack middleware for rate-limiting incoming HTTP requests."
   s.email = "somers.ben@gmail.com"
   s.extra_rdoc_files = [
-    "UNLICENSE",
     "README.md"
   ]
   s.files = [
+    ".document",
+    "Gemfile",
+    "Gemfile.lock",
     "README.md",
     "Rakefile",
     "UNLICENSE",
@@ -27,15 +29,16 @@ Gem::Specification.new do |s|
     "etc/memcache.ru",
     "etc/memcached.ru",
     "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/matchers/ip_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",
@@ -44,7 +47,8 @@ Gem::Specification.new do |s|
     "spec/limiter_spec.rb",
     "spec/method_matcher_spec.rb",
     "spec/spec_helper.rb",
-    "spec/url_matcher_spec.rb"
+    "spec/url_matcher_spec.rb",
+    "spec/user_agent_matcher_spec.rb"
   ]
   s.homepage = "http://github.com/bensomers/improved-rack-throttle"
   s.licenses = ["Public Domain"]

data/lib/rack/throttle.rb

@@ -11,5 +11,6 @@ module Rack
     autoload :Matcher,       'rack/throttle/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/lib/rack/throttle/matchers/url_matcher.rb

@@ -7,7 +7,7 @@ module Rack; module Throttle
     end
 
     def identifier
-      "url" + @rule.inspect
+      "url-" + @rule.inspect
     end
   end
 

data/lib/rack/throttle/matchers/{ip_matcher.rb → user_agent_matcher.rb}

@@ -1,13 +1,13 @@
 module Rack; module Throttle
   ###
   # IpMatchers take RegExp objects and compare the request ip against them
-  class IpMatcher < Matcher
+  class UserAgentMatcher < Matcher
     def match?(request)
-      !!(@rule =~ request.ip)
+      !!(@rule =~ request.user_agent)
     end
 
     def identifier
-      "ip" + @rule.inspect
+      "ua-" + @rule.inspect
     end
   end
 

data/lib/rack/throttle/version.rb

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

data/spec/url_matcher_spec.rb

@@ -22,7 +22,7 @@ describe Rack::Throttle::UrlMatcher do
 
   it "should append the rule to the cache key" do
     get "/foo"
-    app.send(:cache_key, last_request).should == "127.0.0.1:url/foo/"
+    app.send(:cache_key, last_request).should == "127.0.0.1:url-/foo/"
   end
 end
 

data/spec/user_agent_matcher_spec.rb

@@ -0,0 +1,28 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe Rack::Throttle::UserAgentMatcher do
+  include Rack::Test::Methods
+
+  def app
+    @target_app ||= example_target_app
+    @app ||= Rack::Throttle::Limiter.new(@target_app, :rules => {:user_agent => /google/i})
+  end
+
+  it "should not bother checking if the path doesn't match the rule" do
+    app.should_not_receive(:allowed?)
+    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'
+    get "/foo"
+    last_response.body.should show_throttled_response
+  end
+
+  it "should append the rule to the cache key" do
+    get "/foo"
+    app.send(:cache_key, last_request).should == "127.0.0.1:ua-/google/i"
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: improved-rack-throttle
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
   prerelease: 
 platform: ruby
 authors:
@@ -15,7 +15,7 @@ date: 2012-10-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
-  requirement: &70364343200440 !ruby/object:Gem::Requirement
+  requirement: &70147455830820 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -23,10 +23,10 @@ dependencies:
         version: 1.0.0
   type: :runtime
   prerelease: false
-  version_requirements: *70364343200440
+  version_requirements: *70147455830820
 - !ruby/object:Gem::Dependency
   name: timecop
-  requirement: &70364343199340 !ruby/object:Gem::Requirement
+  requirement: &70147455830340 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -34,10 +34,10 @@ dependencies:
         version: 0.5.2
   type: :development
   prerelease: false
-  version_requirements: *70364343199340
+  version_requirements: *70147455830340
 - !ruby/object:Gem::Dependency
   name: rack-test
-  requirement: &70364343198560 !ruby/object:Gem::Requirement
+  requirement: &70147455829840 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -45,10 +45,10 @@ dependencies:
         version: 0.6.2
   type: :development
   prerelease: false
-  version_requirements: *70364343198560
+  version_requirements: *70147455829840
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70364343197860 !ruby/object:Gem::Requirement
+  requirement: &70147455829140 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -56,10 +56,10 @@ dependencies:
         version: 2.11.0
   type: :development
   prerelease: false
-  version_requirements: *70364343197860
+  version_requirements: *70147455829140
 - !ruby/object:Gem::Dependency
   name: yard
-  requirement: &70364343213300 !ruby/object:Gem::Requirement
+  requirement: &70147455828360 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -67,10 +67,10 @@ dependencies:
         version: 0.5.5
   type: :development
   prerelease: false
-  version_requirements: *70364343213300
+  version_requirements: *70147455828360
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70364343212560 !ruby/object:Gem::Requirement
+  requirement: &70147455844160 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -78,10 +78,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70364343212560
+  version_requirements: *70147455844160
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &70364343211840 !ruby/object:Gem::Requirement
+  requirement: &70147455843680 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -89,7 +89,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70364343211840
+  version_requirements: *70147455843680
 description: Rack middleware for rate-limiting incoming HTTP requests.
 email: somers.ben@gmail.com
 executables: []
@@ -117,9 +117,9 @@ files:
 - lib/rack/throttle/interval.rb
 - lib/rack/throttle/limiter.rb
 - lib/rack/throttle/matcher.rb
-- lib/rack/throttle/matchers/ip_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
@@ -129,6 +129,7 @@ files:
 - spec/method_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
@@ -144,7 +145,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1128518403050699337
+      hash: -1924272463384256508
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: