rack-throttle 0.3.0 → 0.4.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    MDNkYTliNDNmN2ExYWQ1OWY3NjkyZDNkZTk0OTQ0ZGZiODk1ZWFiNw==
+  data.tar.gz: !binary |-
+    ODdlYzYyOGQwYzY2OGZiNDgyNzc4NWY3OTEzNDc2ZDFlYzZhZjE1ZA==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    NjUxNmJmMTBlNWU1MDk3ZjM2Zjc1YmEzNWJlYTYyYzBlMWQxNDFiOTgzMGMx
+    YjM1OGQ5Mzk1ZjRlZDQxYzQxZjNiZDdlN2IzMjM2NDU3ZGRjZWUwZGJiYmQw
+    ZDQ3NGYxNDNhZGJhZmQ3MzcyZGU4ZDgwYTg5OTE1NmNmYzZhMDg=
+  data.tar.gz: !binary |-
+    OTRmNWNlN2VkYWU0ODAyMTAzMmRjMmE0ZTllMmE3OTliODA5MmFkMTQxOGRm
+    YjUzOTc0MTNlZjliZmZhN2Q2NWMyNzliYTk1MGMyMTJhYTliMDE5M2I1ZDdh
+    NTRmMWNlYzEyMDhiOWNhYzY0YmFhZGFiZWQxNjI0ZmRjMWE3Nzk=

data/AUTHORS

@@ -1,2 +1 @@
-* Arto Bendiken <arto.bendiken@gmail.com>
-* Brendon Murphy <disposable.20.xternal@spamourmet.com>
+* Arto Bendiken <arto@bendiken.net>

data/README

@@ -3,18 +3,18 @@ HTTP Request Rate Limiter for Rack Applications
 
 This is [Rack][] middleware that provides logic for rate-limiting incoming
 HTTP requests to Rack applications. You can use `Rack::Throttle` with any
-Ruby web framework based on Rack, including with Ruby on Rails 3.0 and with
+Ruby web framework based on Rack, including with Ruby on Rails and with
 Sinatra.
 
-* <http://github.com/datagraph/rack-throttle>
+* <https://github.com/bendiken/rack-throttle>
 
 Features
 --------
 
 * Throttles a Rack application by enforcing a minimum time interval between
   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).
+  a maximum number of allowed HTTP requests per a given time period (per minute, 
+  hourly, or daily).
 * 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
@@ -28,18 +28,42 @@ Features
 Examples
 --------
 
-### Adding throttling to a Rackup application
+### Adding throttling to a Rails application
 
+    # config/application.rb
     require 'rack/throttle'
+    
+    class Application < Rails::Application
+      config.middleware.use Rack::Throttle::Interval
+    end
 
+### Adding throttling to a Sinatra application
+
+    #!/usr/bin/env ruby -rubygems
+    require 'sinatra'
+    require 'rack/throttle'
+    
     use Rack::Throttle::Interval
+    
+    get('/hello') { "Hello, world!\n" }
 
+### Adding throttling to a Rackup application
+
+    #!/usr/bin/env rackup
+    require 'rack/throttle'
+    
+    use Rack::Throttle::Interval
+    
     run lambda { |env| [200, {'Content-Type' => 'text/plain'}, "Hello, world!\n"] }
 
 ### Enforcing a minimum 3-second interval between requests
 
     use Rack::Throttle::Interval, :min => 3.0
 
+### Allowing a maximum of 60 requests per minute
+
+    use Rack::Throttle::Minute,   :max => 60
+
 ### Allowing a maximum of 100 requests per hour
 
     use Rack::Throttle::Hourly,   :max => 100
@@ -52,6 +76,7 @@ Examples
 
     use Rack::Throttle::Daily,    :max => 1000  # requests
     use Rack::Throttle::Hourly,   :max => 100   # requests
+    use Rack::Throttle::Minute,   :max => 60    # requests
     use Rack::Throttle::Interval, :min => 3.0   # seconds
 
 ### Storing the rate-limiting counters in a GDBM database
@@ -136,16 +161,6 @@ otherwise, `Rack::Throttle` does allow you to override the returned HTTP
 status code by passing in a `:code => 503` option when constructing a
 `Rack::Throttle::Limiter` instance.
 
-Documentation
--------------
-
-<http://datagraph.rubyforge.org/rack-throttle/>
-
-* {Rack::Throttle}
-  * {Rack::Throttle::Interval}
-  * {Rack::Throttle::Daily}
-  * {Rack::Throttle::Hourly}
-
 Dependencies
 ------------
 
@@ -154,34 +169,47 @@ Dependencies
 Installation
 ------------
 
-The recommended installation method is via RubyGems. To install the latest
-official release, do:
+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
 
-Download
---------
-
-To get a local working copy of the development repository, do:
+Authors
+-------
 
-    % git clone git://github.com/datagraph/rack-throttle.git
+* [Arto Bendiken](https://gratipay.com/bendiken) - <http://ar.to/>
 
-Alternatively, you can download the latest development version as a tarball
-as follows:
+Contributors
+------------
 
-    % wget http://github.com/datagraph/rack-throttle/tarball/master
+* [Brendon Murphy](https://github.com/bemurphy)
+* [Hendrik Kleinwaechter](https://github.com/hendricius)
+* [Karel Minarik](https://github.com/karmi)
+* [Keita Urashima](https://github.com/ursm)
+* [Leonid Beder](https://github.com/lbeder)
+* [TJ Singleton](https://github.com/tjsingleton)
+* [Winfield Peterson](https://github.com/wpeterson)
 
-Authors
--------
+Contributing
+------------
 
-* [Arto Bendiken](mailto:arto.bendiken@gmail.com) - <http://ar.to/>
-* [Brendon Murphy](mailto:disposable.20.xternal@spamourmet.com>) - <http://www.techfreak.net/>
+* Do your best to adhere to the existing coding conventions and idioms.
+* Don't use hard tabs, and don't leave trailing whitespace on any line.
+  Before committing, run `git diff --check` to make sure of this.
+* Do document every method you add using [YARD][] annotations. Read the
+  [tutorial][YARD-GS] or just look at the existing code for examples.
+* Don't touch the gemspec or `VERSION` files. If you need to change them,
+  do so on your private branch only.
+* Do feel free to add yourself to the `CREDITS` file and the
+  corresponding list in the the `README`. Alphabetical order applies.
+* Don't touch the `AUTHORS` file. If your contributions are significant
+  enough, be assured we will eventually add you in there.
 
 License
 -------
 
-`Rack::Throttle` is free and unencumbered public domain software. For more
-information, see <http://unlicense.org/> or the accompanying UNLICENSE file.
+This is free and unencumbered public domain software. For more information,
+see <http://unlicense.org/> or the accompanying `UNLICENSE` file.
 
 [Rack]:            http://rack.rubyforge.org/
 [gdbm]:            http://ruby-doc.org/stdlib/libdoc/gdbm/rdoc/classes/GDBM.html
@@ -191,3 +219,5 @@ 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
+[YARD]:            http://yardoc.org/
+[YARD-GS]:         http://rubydoc.info/docs/yard/file/docs/GettingStarted.md

data/VERSION

@@ -1 +1 @@
-0.3.0
+0.4.0

data/lib/rack/throttle.rb

@@ -7,6 +7,7 @@ module Rack
     autoload :TimeWindow, 'rack/throttle/time_window'
     autoload :Daily,      'rack/throttle/daily'
     autoload :Hourly,     'rack/throttle/hourly'
+    autoload :Minute,     'rack/throttle/minute'
     autoload :VERSION,    'rack/throttle/version'
   end
 end

data/lib/rack/throttle/limiter.rb

@@ -31,7 +31,7 @@ module Rack; module Throttle
     # @see    http://rack.rubyforge.org/doc/SPEC.html
     def call(env)
       request = Rack::Request.new(env)
-      allowed?(request) ? app.call(env) : rate_limit_exceeded
+      allowed?(request) ? app.call(env) : rate_limit_exceeded(request)
     end
 
     ##
@@ -124,7 +124,7 @@ module Rack; module Throttle
         when cache.respond_to?(:[]=)
           begin
             cache[key] = value
-          rescue TypeError => e
+          rescue TypeError
             # GDBM throws a "TypeError: can't convert Float into String"
             # exception when trying to store a Float. On the other hand, we
             # don't want to unnecessarily coerce the value to a String for
@@ -162,11 +162,12 @@ module Rack; module Throttle
     # @param  [Rack::Request] request
     # @return [Float]
     def request_start_time(request)
-      case
-        when request.env.has_key?('HTTP_X_REQUEST_START')
-          request.env['HTTP_X_REQUEST_START'].to_f / 1000
-        else
-          Time.now.to_f
+      # Check whether HTTP_X_REQUEST_START or HTTP_X_QUEUE_START exist and parse its value (for
+      # example, when having nginx in your stack, it's going to be in the "t=\d+" format).
+      if val = (request.env['HTTP_X_REQUEST_START'] || request.env['HTTP_X_QUEUE_START'])
+        val[/(?:^t=)?(\d+)/, 1].to_f / 1000
+      else
+        Time.now.to_f
       end
     end
 
@@ -174,7 +175,8 @@ module Rack; module Throttle
     # Outputs a `Rate Limit Exceeded` error.
     #
     # @return [Array(Integer, Hash, #each)]
-    def rate_limit_exceeded
+    def rate_limit_exceeded(request)
+      options[:rate_limit_exceeded_callback].call(request) if options[:rate_limit_exceeded_callback]
       headers = respond_to?(:retry_after) ? {'Retry-After' => retry_after.to_f.ceil.to_s} : {}
       http_error(options[:code] || 403, options[:message] || 'Rate Limit Exceeded', headers)
     end
@@ -188,7 +190,7 @@ module Rack; module Throttle
     # @return [Array(Integer, Hash, #each)]
     def http_error(code, message = nil, headers = {})
       [code, {'Content-Type' => 'text/plain; charset=utf-8'}.merge(headers),
-        http_status(code) + (message.nil? ? "\n" : " (#{message})\n")]
+        [http_status(code), (message.nil? ? "\n" : " (#{message})\n")]]
     end
 
     ##

data/lib/rack/throttle/minute.rb

@@ -0,0 +1,43 @@
+module Rack; module Throttle
+  ##
+  # This rate limiter strategy throttles the application by defining a
+  # maximum number of allowed HTTP requests per minute (by default, 60
+  # requests per minute, which works out to an average of 1 request per
+  # second).
+  #
+  # Note that this strategy doesn't use a sliding time window, but rather
+  # tracks requests per distinct minute. This means that the throttling
+  # counter is reset every minute.
+  #
+  # @example Allowing up to 60 requests/minute
+  #   use Rack::Throttle::Minute
+  #
+  # @example Allowing up to 100 requests per hour
+  #   use Rack::Throttle::Minute, :max => 100
+  #
+  class Minute < TimeWindow
+    ##
+    # @param  [#call]                  app
+    # @param  [Hash{Symbol => Object}] options
+    # @option options [Integer] :max   (60)
+    def initialize(app, options = {})
+      super
+    end
+
+    ##
+    def max_per_minute
+      @max_per_hour ||= options[:max_per_minute] || options[:max] || 60
+    end
+
+    alias_method :max_per_window, :max_per_minute
+
+    protected
+
+    ##
+    # @param  [Rack::Request] request
+    # @return [String]
+    def cache_key(request)
+      [super, Time.now.strftime('%Y-%m-%dT%H:%M')].join(':')
+    end
+  end
+end; end

data/lib/rack/throttle/time_window.rb

@@ -8,8 +8,9 @@ module Rack; module Throttle
     # @param  [Rack::Request] request
     # @return [Boolean]
     def allowed?(request)
+      return true if whitelisted?(request)
       count = cache_get(key = cache_key(request)).to_i + 1 rescue 1
-      allowed = count <= max_per_window
+      allowed = count <= max_per_window.to_i
       begin
         cache_set(key, count)
         allowed

metadata

@@ -1,88 +1,91 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: rack-throttle
-version: !ruby/object:Gem::Version 
-  prerelease: false
-  segments: 
-  - 0
-  - 3
-  - 0
-  version: 0.3.0
+version: !ruby/object:Gem::Version
+  version: 0.4.0
 platform: ruby
-authors: 
+authors:
 - Arto Bendiken
-- Brendon Murphy
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2010-03-22 00:00:00 +01:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2014-11-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: rack-test
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        - 5
-        - 3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
         version: 0.5.3
   type: :development
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: rspec
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 1
-        - 3
-        - 0
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.5.3
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
         version: 1.3.0
   type: :development
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+- !ruby/object:Gem::Dependency
   name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.5.5
+  type: :development
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        - 5
-        - 3
-        version: 0.5.3
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.5.5
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.3.4
   type: :development
-  version_requirements: *id003
-- !ruby/object:Gem::Dependency 
-  name: rack
   prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 1
-        - 0
-        - 0
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.3.4
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
         version: 1.0.0
   type: :runtime
-  version_requirements: *id004
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
 description: Rack middleware for rate-limiting incoming HTTP requests.
-email: arto.bendiken@gmail.com
+email: arto@bendiken.net
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - AUTHORS
 - README
 - UNLICENSE
@@ -91,40 +94,33 @@ files:
 - lib/rack/throttle/hourly.rb
 - lib/rack/throttle/interval.rb
 - lib/rack/throttle/limiter.rb
+- lib/rack/throttle/minute.rb
 - lib/rack/throttle/time_window.rb
 - lib/rack/throttle/version.rb
 - lib/rack/throttle.rb
-has_rdoc: false
-homepage: http://github.com/datagraph
-licenses: 
+homepage: https://github.com/bendiken/rack-throttle
+licenses:
 - Public Domain
+metadata: {}
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 1
-      - 8
-      - 2
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
       version: 1.8.2
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 0
-      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
-rubyforge_project: datagraph
-rubygems_version: 1.3.6
+rubyforge_project: 
+rubygems_version: 2.0.3
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: HTTP request rate limiter for Rack applications.
 test_files: []
-
+has_rdoc: false