rate-limiting 1.0.2 → 1.0.3

data/lib/rate-limiting/version.rb

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

data/lib/rule.rb

@@ -7,6 +7,7 @@ class Rule
       :type => :frequency,
       :limit => 100,
       :per_ip => true,
+      :per_url => false,
       :token => false
     }   
     @options = default_options.merge(options)
@@ -48,7 +49,7 @@ class Rule
   end
 
   def get_key(request)
-    key = request.path
+    key = (@options[:per_url] ? request.path : @options[:match].to_s)
     key = key + request.ip.to_s if @options[:per_ip]
     key = key + request.params[@options[:token].to_s] if @options[:token]
     key

data/readme.md

@@ -1,32 +1,57 @@
 Rate Limiting
 ===============
 
+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.
+
+
 
 How to use it
 ----------------
 
 **Adding to Rails 3.x**
 
-\# config/application.rb
+Gemfile
+
+     gem 'rate-limiting'
+
+config/application.rb
+
+     require "rate_limiting"
+
+     class Application < Rails::Application
+
+       config.middleware.use RateLimiting do |r|
+
+         # 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 => '/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)
+         r.define_rule(:match => '/token', :limit => 1, :token => :id, :per_ip => false)
+         r.define_rule(:match => '/fixed/rpm', :metric => :rpm, :type => :fixed, :limit => 1)
+         r.define_rule(:match => '/fixed/rph', :metric => :rph, :type => :fixed, :limit => 1)
+         r.define_rule(:match => '/fixed/rpd', :metric => :rpd, :type => :fixed, :limit => 1)
+         r.define_rule(:match => '/freq/rpm', :metric => :rpm, :type => :frequency, :limit => 1)
+         r.define_rule(:match => '/freq/rph', :metric => :rph, :type => :frequency, :limit => 60)
+         r.define_rule(:match => '/freq/rpd', :metric => :rpd, :type => :frequency, :limit => 1440)
+         r.define_rule(:match => '/header', :metric => :rph, :type => :frequency, :limit => 60)
+
+       end
+
+     end
 
->     class Application < Rails::Application
->
->       config.middleware.use RateLimiting do |r|
->
->         r.define_rule( :match => '/resource', :type => :fixed, :metric => :rph, :limit => 300 )
->
->       end
->
->     end
 
 Rule Options
 ----------------
 
-**match**
+### match
 
 Accepts aimed resource path or Regexp like '/resource' or "/resource/.*"
 
-**metric**
+### metric
 
 :rpd  -  Requests per Day
 
@@ -34,17 +59,28 @@ Accepts aimed resource path or Regexp like '/resource' or "/resource/.*"
 
 :rpm  -  Requests per Minute
 
-**type**
+### type
 
 :frequency  -  1 request per (time/limit)
 
 :fixed - limit requests per time
 
-**token**
+Examples: 
+
+      r.define_rule(:match => "/resource", :metric => :rph, :type => :frequency, :limit => 3)
+
+      => 1 request every 20 min
+
+      r.define_rule(:match => "/resource", :metric => :rph, :type => :fixed, :limit => 3)
+
+      => 3 request every 60 min
+
+
+### token
 
 :foo - limit by request parameter 'foo'
 
-**per_ip**
+### per_ip
 
 Boolean, true = limit by IP
 

data/spec/headers_spec.rb

@@ -21,11 +21,11 @@ describe "response headers" do
     end
     
     it 'should have the right limit' do
-      last_response.header['x-RateLimit-Limit'].should == 1
+      last_response.header['x-RateLimit-Limit'].should == "1"
     end
 
     it 'should have the right remaining' do
-      last_response.header['x-RateLimit-Remaining'].should == 0
+      last_response.header['x-RateLimit-Remaining'].should == "0"
     end
 
   end

data/spec/per_url_spec.rb

@@ -0,0 +1,34 @@
+require "spec_helper"
+
+describe "per_url rule" do
+  include Rack::Test::Methods
+
+  context "true" do
+
+    it 'should not allow equal urls' do
+      get '/per_url/url1', {}, {'HTTP_ACCEPT' => "text/html"}
+      get '/per_url/url1', {}, {'HTTP_ACCEPT' => "text/html"}
+      last_response.body.should show_not_allowed_response
+    end
+    
+    it 'should allow different urls' do
+      get '/per_url/url1', {}, {'HTTP_ACCEPT' => "text/html"}
+      get '/per_url/url2', {}, {'HTTP_ACCEPT' => "text/html"}
+      last_response.body.should show_allowed_response
+    end
+
+  end
+
+  context "false" do
+
+    it 'should not allow different urls' do
+      get '/per_match/url1', {}, {'HTTP_ACCEPT' => "text/html"}
+      get '/per_match/url2', {}, {'HTTP_ACCEPT' => "text/html"}
+      last_response.body.should show_not_allowed_response
+    end
+  
+  end
+
+  
+
+end

data/spec/spec_helper.rb

@@ -23,6 +23,8 @@ def app
     r.define_rule(:match => '/freq/rph', :metric => :rph, :type => :frequency, :limit => 60)
     r.define_rule(:match => '/freq/rpd', :metric => :rpd, :type => :frequency, :limit => 1440)
     r.define_rule(:match => '/header', :metric => :rph, :type => :frequency, :limit => 60)
+    r.define_rule(:match => '/per_match/.*', :metric => :rph, :type => :frequency, :limit => 60, :per_url => false)
+    r.define_rule(:match => '/per_url/.*', :metric => :rph, :type => :frequency, :limit => 60, :per_url => true)
   end 
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rate-limiting
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-05-21 00:00:00.000000000 Z
+date: 2012-05-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -85,6 +85,7 @@ files:
 - spec/headers_spec.rb
 - spec/html_request_spec.rb
 - spec/json_request_spec.rb
+- spec/per_url_spec.rb
 - spec/spec_helper.rb
 - spec/token_spec.rb
 - spec/xml_request_spec.rb
@@ -122,6 +123,7 @@ test_files:
 - spec/headers_spec.rb
 - spec/html_request_spec.rb
 - spec/json_request_spec.rb
+- spec/per_url_spec.rb
 - spec/spec_helper.rb
 - spec/token_spec.rb
 - spec/xml_request_spec.rb