rate-limiting 1.0.3 → 1.0.4

data/lib/rate-limiting/version.rb

@@ -1,5 +1,5 @@
 module Rate
   module Limiting
-    VERSION = "1.0.3"
+    VERSION = "1.0.4"
   end
 end

data/lib/rate_limiting.rb

@@ -5,6 +5,7 @@ class RateLimiting
 
   def initialize(app, &block)
     @app = app
+    @logger =  nil
     @rules = []
     @cache = {}
     block.call(self)
@@ -12,6 +13,7 @@ class RateLimiting
 
   def call(env)
     request = Rack::Request.new(env)
+    @logger = env['rack.logger']
     (limit_header = allowed?(request)) ? respond(env, limit_header) : rate_limit_exceeded(env['HTTP_ACCEPT'])
   end
 
@@ -22,9 +24,9 @@ class RateLimiting
 
   def rate_limit_exceeded(accept)
     case accept.gsub(/;.*/, "").split(',')[0]
-    when "text/xml"         then message, type  = xml_error("403", "Rate Limit Exceeded"), "text/xml" 
+    when "text/xml"         then message, type  = xml_error("403", "Rate Limit Exceeded"), "text/xml"
     when "application/json" then  message, type  = ["Rate Limit Exceeded"].to_json, "application/json"
-    else 
+    else
       message, type  = ["Rate Limit Exceeded"], "text/html"
     end
     [403, {"Content-Type" => type}, message]
@@ -46,11 +48,13 @@ class RateLimiting
   end
 
   def cache_has?(key)
-    case 
+    case
     when cache.respond_to?(:has_key?)
       cache.has_key?(key)
     when cache.respond_to?(:get)
       cache.get(key) rescue false
+    when cache.respond_to?(:exist?)
+      cache.exist?(key)
     else false
     end
   end
@@ -61,6 +65,8 @@ class RateLimiting
       return cache[key]
     when cache.respond_to?(:get)
       return cache.get(key) || nil
+    when cache.respond_to?(:fetch)
+      return cache.fetch(key)
     end
   end
 
@@ -74,11 +80,22 @@ class RateLimiting
       end
     when cache.respond_to?(:set)
       cache.set(key, value)
+    when cache.respond_to?(:write)
+      begin
+        cache.write(key, value)
+      rescue TypeError => e
+        cache.write(key, value.to_s)
+      end
     end
   end
 
+  def logger
+    @logger || Rack::NullLogger.new(nil)
+  end
+
   def allowed?(request)
     if rule = find_matching_rule(request)
+      logger.debug "[#{self}] #{request.ip}:#{request.path}: Rate limiting rule matched."
       apply_rule(request, rule)
     else
       true
@@ -96,30 +113,35 @@ class RateLimiting
     key = rule.get_key(request)
     if cache_has?(key)
       record = cache_get(key)
-      if (reset = record.split(':')[1]) > Time.now.strftime("%d%m%y%H%M%S")
-        if (times = record.split(':')[0].to_i) < rule.limit
+      logger.debug "[#{self}] #{request.ip}:#{request.path}: Rate limiting entry: '#{key}' => #{record}"
+      if (reset = Time.at(record.split(':')[1].to_i)) > Time.now
+        # rule hasn't been reset yet
+        times = record.split(':')[0].to_i
+        cache_set(key, "#{times + 1}:#{reset.to_i}")
+        if (times) < rule.limit
+          # within rate limit
           response = get_header(times + 1, reset, rule.limit)
-          record = record.gsub(/.*:/, "#{times + 1}:")
         else
+          logger.debug "[#{self}] #{request.ip}:#{request.path}: Rate limited; request rejected."
           return false
         end
       else
-        response = get_header(1, reset = rule.get_expiration, rule.limit)
-        cache_set(key, "1:" + rule.get_expiration)
+        response = get_header(1, rule.get_expiration, rule.limit)
+        cache_set(key, "1:#{rule.get_expiration.to_i}")
       end
     else
-      response = get_header(1, reset = rule.get_expiration, rule.limit)
-      cache_set(key, "1:" + rule.get_expiration)
+      response = get_header(1, rule.get_expiration, rule.limit)
+      cache_set(key, "1:#{rule.get_expiration.to_i}")
     end
     response
   end
 
   def get_header(times, reset, limit)
-    {'x-RateLimit-Limit' => limit.to_s, 'x-RateLimit-Remaining' => (limit - times).to_s, 'x-RateLimit-Reset' => reset.to_s }
+    {'x-RateLimit-Limit' => limit.to_s, 'x-RateLimit-Remaining' => (limit - times).to_s, 'x-RateLimit-Reset' => reset.strftime("%d%m%y%H%M%S") }
   end
 
   def xml_error(code, message)
     "<?xml version=\"1.0\"?>\n<error>\n  <code>#{code}</code>\n  <message>#{message}</message>\n</error>"
   end
-  
+
 end

data/lib/rule.rb

@@ -1,7 +1,7 @@
 class Rule
 
   def initialize(options)
-    default_options = { 
+    default_options = {
       :match => /.*/,
       :metric => :rph,
       :type => :frequency,
@@ -9,9 +9,9 @@ class Rule
       :per_ip => true,
       :per_url => false,
       :token => false
-    }   
+    }
     @options = default_options.merge(options)
-  
+
   end
 
   def match
@@ -20,11 +20,11 @@ class Rule
 
   def limit
     (@options[:type] == :frequency ? 1 : @options[:limit])
-  end 
+  end
 
   def get_expiration
-    (Time.now + ( @options[:type] == :frequency ? get_frequency : get_fixed )).strftime("%d%m%y%H%M%S")
-  end 
+    (Time.now + ( @options[:type] == :frequency ? get_frequency : get_fixed ))
+  end
 
   def get_frequency
     case @options[:metric]

data/readme.md

@@ -1,7 +1,7 @@
 Rate Limiting
 ===============
 
-Rate Limiting is a rack middleware that rate-limit HTTP requests in many different ways. 
+Rate Limiting is a rack middleware that rate-limit HTTP requests in many different ways.
 It provides tools for creating rules which can rate-limit routes separately.
 
 
@@ -26,7 +26,7 @@ config/application.rb
          # Add your rules here, ex:
 
          r.define_rule( :match => '/resource', :type => :fixed, :metric => :rph, :limit => 300 )
-         r.define_rule(:match => '/html', :limit => 1)  
+         r.define_rule(:match => '/html', :limit => 1)
          r.define_rule(:match => '/json', :metric => :rph, :type => :frequency, :limit => 60)
          r.define_rule(:match => '/xml', :metric => :rph, :type => :frequency, :limit => 60)
          r.define_rule(:match => '/token/ip', :limit => 1, :token => :id, :per_ip => true)
@@ -65,7 +65,7 @@ Accepts aimed resource path or Regexp like '/resource' or "/resource/.*"
 
 :fixed - limit requests per time
 
-Examples: 
+Examples:
 
       r.define_rule(:match => "/resource", :metric => :rph, :type => :frequency, :limit => 3)
 
@@ -84,3 +84,50 @@ Examples:
 
 Boolean, true = limit by IP
 
+### per_url
+
+Option used when the match option is a Regexp.
+If true, it will limit every url catch separately.
+
+Example:
+
+    r.define_rule(:match => '/resource/.*', :metric => :rph, :type => :fixed, :limit => 1, :per_url => true)
+
+This example will let 1 request per hour for each url caught. ('/resource/url1', '/resource/url2', etc...)
+
+Limit Entry Storage
+----------------
+By default, the record store used to keep track of request matches is a hash stored as a class instance variable in app instance memory. For a distributed or concurrent application, this will not yeild desired results and should be changed to a different store.
+
+Set the cache by calling `set_cache` in the configuration block
+```
+r.set_store(Rails.cache)
+```
+
+Any traditional store will work, including Memcache, Redis, or an ActiveSupport::Cache::Store. Which is the best choice is an application specific decision, but a fast, shared store is highly recommended.
+
+A more robust cache configuration example:
+```
+store = case
+when ENV['REDIS_RATE_LIMIT_URL'].present?
+  # use a separate redis DB
+  Redis.new(url: ENV['REDIS_RATE_LIMIT_URL'])
+when ENV['REDIS_PROVIDER'].present?
+  # no separate redis DB available, share primary redis DB
+  Redis.new(url: ENV[ENV['REDIS_PROVIDER']])
+when (redis = Redis.new) && (redis.client.connect rescue false)
+  # a standard redis connection on port 6379 is available
+  redis
+when Rails.application.config.cache_store != :null_store
+  # no redis store is available, use the rails cache
+  Rails.cache
+else
+  # no distributed store available,
+  # a class instance variable will be used
+  nil
+end
+
+r.set_cache(store) if store.present?
+Rails.logger.debug "=> Rate Limiting Store Configured: #{r.cache}"
+```
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rate-limiting
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.0.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-05-24 00:00:00.000000000 Z
+date: 2013-06-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -109,7 +109,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: rate-limiting
-rubygems_version: 1.8.23
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Rack Rate-Limit Gem