rack-ratelimit 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e01063bca7c6d18ab0206611063a339dc7ddfad6
-  data.tar.gz: ffb944f15efc8239948306e4948f25c8d488e07c
+  metadata.gz: 21689cc38cfc536f64e5edb837ca4ebbf3953d85
+  data.tar.gz: 9fca02872a124ec27453904600765afe10c000cc
 SHA512:
-  metadata.gz: b64f78b469c570ade7cb6f03e301c70550adb7486b3e5a2e36de522db35d80ce769ddd7f18e18274c6a5a6da2a2a5224244268a2a6378e5e9f8e91228ab6e7b7
-  data.tar.gz: 0b4929fb74cd3da4a727e1ef5c0e5fbf160704e06be4e4e639df7be98e28f1dd6dada78918bd72cd2ee85d17efceb57cb123223777fda4b83a59dbcb27f7c763
+  metadata.gz: ffc295ecfec0dcbeb293452e1d14983c3448d0b78fd3343e953b2661695857462f154ca7d0069eb1974c63e03b8dd527d38a0fa7271044011366a6754e4c7823
+  data.tar.gz: 06758a18ce4773e37c8ce7503f700e10f0f11dfb76995f2158a167d3be97c4b4ab21410fb96f88507f6a22fef17bdc4b654cd66c42bd14c3c3e53d9f8793d8b7

data/lib/rack/ratelimit.rb

@@ -1,4 +1,3 @@
-require 'dalli'
 require 'logger'
 require 'time'
 
@@ -10,9 +9,9 @@ module Rack
   # * Apply each rate limit by request characteristics: IP, subdomain, OAuth2 token, etc.
   # * Flexible time window to limit burst traffic vs hourly or daily traffic:
   #     100 requests per 10 sec, 500 req/minute, 10000 req/hour, etc.
-  # * Fast, low-overhead implementation using memcache counters per time window:
+  # * Fast, low-overhead implementation using counters per time window:
   #     timeslice = window * ceiling(current time / window)
-  #     memcache.incr(counter for timeslice)
+  #     store.incr(timeslice)
   class Ratelimit
     # Takes a block that classifies requests for rate limiting. Given a
     # Rack env, return a string such as IP address, API token, etc. If the
@@ -21,7 +20,12 @@ module Rack
     #
     # Required configuration:
     #   rate: an array of [max requests, period in seconds]: [500, 5.minutes]
-    #   cache: a Dalli::Client instance, or an object that quacks like it.
+    # and one of
+    #   cache: a Dalli::Client instance
+    #   redis: a Redis instance
+    #   counter: Your own custom counter. Must respond to
+    #     `#increment(classification_string, end_of_time_window_timestamp)`
+    #     and return the counter value after increment.
     #
     # Optional configuration:
     #   name: name of the rate limiter. Defaults to 'HTTP'. Used in messages.
@@ -51,7 +55,7 @@ module Rack
     #   use(Rack::Ratelimit, name: 'API',
     #     conditions: ->(env) { env['REMOTE_USER'] },
     #     rate:   [1000, 1.hour],
-    #     cache:  Dalli::Client.new,
+    #     redis:  Redis.new(ratelimit_redis_config),
     #     logger: Rails.logger) { |env| env['REMOTE_USER'] }
     def initialize(app, options, &classifier)
       @app, @classifier = app, classifier
@@ -61,7 +65,17 @@ module Rack
       @max, @period = options.fetch(:rate)
       @status = options.fetch(:status, 429)
 
-      @counter = Counter.new(options.fetch(:cache), @name, @period)
+      @counter =
+        if counter = options[:counter]
+          raise ArgumentError, 'Counter must respond to #increment' unless counter.respond_to?(:increment)
+          counter
+        elsif cache = options[:cache]
+          MemcachedCounter.new(cache, @name, @period)
+        elsif redis = options[:redis]
+          RedisCounter.new(redis, @name, @period)
+        else
+          raise ArgumentError, ':cache, :redis, or :counter is required'
+        end
 
       @logger = options[:logger]
       @error_message = options.fetch(:error_message, "#{@name} rate limit exceeded. Please wait #{@period} seconds then retry your request.")
@@ -140,7 +154,7 @@ module Rack
       end
     end
 
-    class Counter
+    class MemcachedCounter
       def initialize(cache, name, period)
         @cache, @name, @period = cache, name, period
       end
@@ -163,5 +177,23 @@ module Rack
         end
       end
     end
+
+    class RedisCounter
+      def initialize(redis, name, period)
+        @redis, @name, @period = redis, name, period
+      end
+
+      # Increment the request counter and return the current count.
+      def increment(classification, timestamp)
+        key = 'rack-ratelimit/%s/%s/%i' % [@name, classification, timestamp]
+
+        # Returns [count, expire_ok] response for each multi command.
+        # Return the first, the count.
+        @redis.multi do |redis|
+          redis.incr key
+          redis.expire key, @period
+        end.first
+      end
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rack-ratelimit
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
-- Jeremy Kemper
+- Jeremy Daer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-21 00:00:00.000000000 Z
+date: 2016-04-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -31,7 +31,21 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -67,7 +81,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 5.3.0
 description: 
-email: jeremy@bitsweat.net
+email: jeremydaer@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -94,7 +108,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.0
+rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
 summary: Flexible rate limits for your Rack apps