rack-throttle 0.4.0 → 0.4.1

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!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=
+SHA1:
+  metadata.gz: 9f46ec6236e6ad3bcfc8e36c2825e34ba8c55cf5
+  data.tar.gz: cdfc85da172a8f7dc4c9d2576d242d5712d0dc8d
+SHA512:
+  metadata.gz: 35ea7f5d3aecf567b4cf58b1b333430fc72a52a773d7b78b0249390a8d8937b8e11c3ea1504daa5b9ac6ae00ed01d69defd82fd3b3f56b93fd2a2db034295cd5
+  data.tar.gz: eca3055ef3b4525c10d2aeeb9040a836dd5911cd783624eb716192ca4a96caa4aea85e1bf2e551b329d34fab0e70824dbcfbd0bf759b23175b4a0e36a5c23845

data/README

@@ -0,0 +1 @@
+README.md

data/VERSION

@@ -1 +1 @@
-0.4.0
+0.4.1

data/lib/rack/throttle.rb

@@ -2,12 +2,13 @@ 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 :Minute,     'rack/throttle/minute'
-    autoload :VERSION,    'rack/throttle/version'
+    autoload :Limiter,    ::File.expand_path(::File.dirname(__FILE__)) + '/throttle/limiter'
+    autoload :Interval,   ::File.expand_path(::File.dirname(__FILE__)) + '/throttle/interval'
+    autoload :TimeWindow, ::File.expand_path(::File.dirname(__FILE__)) + '/throttle/time_window'
+    autoload :Daily,      ::File.expand_path(::File.dirname(__FILE__)) + '/throttle/daily'
+    autoload :Hourly,     ::File.expand_path(::File.dirname(__FILE__)) + '/throttle/hourly'
+    autoload :Minute,     ::File.expand_path(::File.dirname(__FILE__)) + '/throttle/minute'
+    autoload :Second,     ::File.expand_path(::File.dirname(__FILE__)) + '/throttle/second'
+    autoload :VERSION,    ::File.expand_path(::File.dirname(__FILE__)) + '/throttle/version'
   end
 end

data/lib/rack/throttle/limiter.rb

@@ -21,6 +21,7 @@ module Rack; module Throttle
     # @option options [String]  :key_prefix (nil)
     # @option options [Integer] :code       (403)
     # @option options [String]  :message    ("Rate Limit Exceeded")
+    # @option options [String]  :type       ("text/plain; charset=utf-8")
     def initialize(app, options = {})
       @app, @options = app, options
     end
@@ -189,8 +190,12 @@ module Rack; module Throttle
     # @param  [Hash{String => String}] headers
     # @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")]]
+      contentType = 'text/plain; charset=utf-8'
+      if options[:type]
+        contentType = options[:type]
+      end
+      [code, {'Content-Type' => contentType}.merge(headers),
+        [message]]
     end
 
     ##

data/lib/rack/throttle/minute.rb

@@ -12,7 +12,7 @@ module Rack; module Throttle
   # @example Allowing up to 60 requests/minute
   #   use Rack::Throttle::Minute
   #
-  # @example Allowing up to 100 requests per hour
+  # @example Allowing up to 100 requests per minute
   #   use Rack::Throttle::Minute, :max => 100
   #
   class Minute < TimeWindow
@@ -26,7 +26,7 @@ module Rack; module Throttle
 
     ##
     def max_per_minute
-      @max_per_hour ||= options[:max_per_minute] || options[:max] || 60
+      @max_per_minute ||= options[:max_per_minute] || options[:max] || 60
     end
 
     alias_method :max_per_window, :max_per_minute

data/lib/rack/throttle/second.rb

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

metadata

@@ -1,15 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: rack-throttle
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.1
 platform: ruby
 authors:
 - Arto Bendiken
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-14 00:00:00.000000000 Z
+date: 2016-09-28 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
 - !ruby/object:Gem::Dependency
   name: rack-test
   requirement: !ruby/object:Gem::Requirement
@@ -25,33 +53,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 0.5.3
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.3.0
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.3.0
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: yard
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '='
       - !ruby/object:Gem::Version
-        version: 0.5.5
+        version: 1.3.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '='
       - !ruby/object:Gem::Version
-        version: 0.5.5
+        version: 1.3.0
 - !ruby/object:Gem::Dependency
   name: timecop
   requirement: !ruby/object:Gem::Requirement
@@ -67,19 +95,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 0.3.4
 - !ruby/object:Gem::Dependency
-  name: rack
+  name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.0.0
-  type: :runtime
+        version: 0.5.5
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: 0.5.5
 description: Rack middleware for rate-limiting incoming HTTP requests.
 email: arto@bendiken.net
 executables: []
@@ -90,14 +118,15 @@ files:
 - README
 - UNLICENSE
 - VERSION
+- 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/minute.rb
+- lib/rack/throttle/second.rb
 - lib/rack/throttle/time_window.rb
 - lib/rack/throttle/version.rb
-- lib/rack/throttle.rb
 homepage: https://github.com/bendiken/rack-throttle
 licenses:
 - Public Domain
@@ -108,19 +137,18 @@ require_paths:
 - lib
 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
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: HTTP request rate limiter for Rack applications.
 test_files: []
-has_rdoc: false

data/README

@@ -1,223 +0,0 @@
-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 and with
-Sinatra.
-
-* <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 (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
-  memcached or Redis).
-* Compatible with the [gdbm][] binding included in Ruby's standard library.
-* Compatible with the [memcached][], [memcache-client][], [memcache][] and
-  [redis][] gems.
-* Compatible with [Heroku][]'s [memcached add-on][Heroku memcache]
-  (currently available as a free beta service).
-
-Examples
---------
-
-### 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
-
-### Allowing a maximum of 1,000 requests per day
-
-    use Rack::Throttle::Daily,    :max => 1000
-
-### Combining various throttling constraints into one overall policy
-
-    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
-
-    require 'gdbm'
-    
-    use Rack::Throttle::Interval, :cache => GDBM.new('tmp/throttle.db')
-
-### Storing the rate-limiting counters on a Memcached server
-
-    require 'memcached'
-    
-    use Rack::Throttle::Interval, :cache => Memcached.new, :key_prefix => :throttle
-
-### Storing the rate-limiting counters on a Redis server
-
-    require 'redis'
-    
-    use Rack::Throttle::Interval, :cache => Redis.new, :key_prefix => :throttle
-
-Throttling Strategies
----------------------
-
-`Rack::Throttle` supports three built-in throttling strategies:
-
-* `Rack::Throttle::Interval`: Throttles the application by enforcing a
-  minimum interval (by default, 1 second) between subsequent HTTP requests.
-* `Rack::Throttle::Hourly`: Throttles the application by defining a
-  maximum number of allowed HTTP requests per hour (by default, 3,600
-  requests per 60 minutes, which works out to an average of 1 request per
-  second).
-* `Rack::Throttle::Daily`: Throttles the application by defining a
-  maximum number of allowed HTTP requests per day (by default, 86,400
-  requests per 24 hours, which works out to an average of 1 request per
-  second).
-
-You can fully customize the implementation details of any of these strategies
-by simply subclassing one of the aforementioned default implementations.
-And, of course, should your application-specific requirements be
-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.
-
-HTTP Client Identification
---------------------------
-
-The rate-limiting counters stored and maintained by `Rack::Throttle` are
-keyed to unique HTTP clients.
-
-By default, HTTP clients are uniquely identified by their IP address as
-returned by `Rack::Request#ip`. If you wish to instead use a more granular,
-application-specific identifier such as a session key or a user account
-name, you need only subclass a throttling strategy implementation and
-override the `#client_identifier` method.
-
-HTTP Response Codes and Headers
--------------------------------
-
-### 403 Forbidden (Rate Limit Exceeded)
-
-When a client exceeds their rate limit, `Rack::Throttle` by default returns
-a "403 Forbidden" response with an associated "Rate Limit Exceeded" message
-in the response body.
-
-An HTTP 403 response means that the server understood the request, but is
-refusing to respond to it and an accompanying message will explain why.
-This indicates an error on the client's part in exceeding the rate limits
-outlined in the acceptable use policy for the site, service, or API.
-
-### 503 Service Unavailable (Rate Limit Exceeded)
-
-However, there exists a widespread practice of instead returning a "503
-Service Unavailable" response when a client exceeds the set rate limits.
-This is technically dubious because it indicates an error on the server's
-part, which is certainly not the case with rate limiting - it was the client
-that committed the oops, not the server.
-
-An HTTP 503 response would be correct in situations where the server was
-genuinely overloaded and couldn't handle more requests, but for rate
-limiting an HTTP 403 response is more appropriate. Nonetheless, if you think
-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.
-
-Dependencies
-------------
-
-* [Rack](http://rubygems.org/gems/rack) (>= 1.0.0)
-
-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
-
-Authors
--------
-
-* [Arto Bendiken](https://gratipay.com/bendiken) - <http://ar.to/>
-
-Contributors
-------------
-
-* [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)
-
-Contributing
-------------
-
-* 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
--------
-
-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
-[memcached]:       http://rubygems.org/gems/memcached
-[memcache-client]: http://rubygems.org/gems/memcache-client
-[memcache]:        http://rubygems.org/gems/memcache
-[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