throttling 0.2.0 → 0.3.0

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+## 0.3.0 (April 13, 2012)
+
+Features:
+
+  - Added ability to retrieve custom value based on number of actions performed in a period of time
+
 ## 0.2.0 (April 12, 2012)
 
 Bugfixes:

data/README.md

@@ -46,6 +46,34 @@ The basic structure of the file is:
         limit: 10000
         period: 86400
 
+    request_priority:
+      period: 86400
+      default_value: 25
+      values:
+        high_priority:
+          limit: 5
+          value: 10
+        medium_priority:
+          limit: 15
+          value: 15
+        low_priority:
+          limit: 100
+          value: 20
+
+This example covers three different scenarios:
+
+1. Single period. In this case only 20 actions will be allowed in a period of
+   one hour (3600 seconds).
+
+2. Multiple periods. Action will be allowed to perform 300 times in 10 minutes,
+   1000 times an hour, and 10000 times a day.
+
+3. This special case covers following scenario: based on the number of actions,
+   it returns a value, or default value when largest limit is reached. In this
+   case it will return 10, when there were 5 or less requests (including current one),
+   15 for up to 15 requests, 20 for up to 100 requests, and 25 when there were
+   more than 100 requests.
+
 You can also specify limits as a Hash:
 
     Throttling.limits = {
@@ -100,6 +128,59 @@ You can add more helpers like this:
       end
     end
 
+## Use cases
+
+### Limiting number of sign-ups
+
+    user_signup:
+      limit: 20
+      period: 3600
+
+Limit the number of sign-ups to 20 per hour per IP address:
+
+    Throttling.for('user_signup').check_ip(request.remote_ip)
+
+### Limiting number of document uploads
+
+    document_uploads:
+      minutely:
+        limit: 5
+        period: 600
+      hourly:
+        limit: 10
+        period: 3600
+      daily:
+        limit: 50
+        period: 86400
+
+In this case user will be allowed to upload 5 documents in 10 minutes, 10 documents
+in an hour, or 50 documents a day:
+
+    Throttling.for('document_uploads').check_user_id(current_user.id)
+
+### Prioritizing uploads based on number of uploads
+
+    document_priorities:
+      period: 86400
+      default_value: 25
+      values:
+        high_priority:
+          limit: 5
+          value: 10
+        medium_priority:
+          limit: 15
+          value: 15
+        low_priority:
+          limit: 100
+          value: 20
+
+All documents could be prioritized based on the number of uploads: if user uploads
+less than 5 documents a day, they all will have priority 10. Next 10 documents
+(first five keep their original priority) will receive priority 15. Documents
+16 to 100 will get priority 20, and everything else will get priority 25.
+
+    Throttling.for('document_priorities').check_user_id(current_user.id)
+
 ## Contributing
 
 1. Fork it

data/lib/throttling/base.rb

@@ -11,7 +11,10 @@ module Throttling
       raise ArgumentError, "No Throttling.limits[#{action}] section found" unless limits
 
       # Convert simple limits to a hash
-      if @limits[:limit] && @limits[:period]
+      if @limits[:period]
+        if @limits[:values]
+          @limits[:values] = @limits[:values].sort_by { |name, params| params && params[:limit] }
+        end
         @limits = [[ 'global', @limits ]]
       else
         @limits = @limits.sort_by { |name, params| params && params[:period] }
@@ -31,19 +34,33 @@ module Throttling
       return true if !Throttling.enabled? || check_value.nil?
 
       limits.each do |period_name, params|
-        raise ArgumentError, "Invalid or no 'period' parameter in the limits[#{period_name}] config" if params[:period].to_i < 1
-        raise ArgumentError, "Invalid or no 'limit' parameter in the limits[#{period_name}] config" if params[:limit].nil? || params[:limit].to_i < 0
-
         period = params[:period].to_i
+        limit  = params[:limit].to_i
+        values = params[:values]
+
+        raise ArgumentError, "Invalid or no 'period' parameter in the limits[#{period_name}] config" if period < 1
+        raise ArgumentError, "Invalid or no 'limit' parameter in the limits[#{period_name}] config"  if limit < 1 && !values
+
         key = hits_store_key(check_type, check_value, period_name, period)
 
         # Retrieve current value
-        hits = Throttling.storage.fetch(key, :expires_in => hits_store_ttl(period), :raw => true) { '0' }
+        hits = Throttling.storage.fetch(key, :expires_in => hits_store_ttl(period), :raw => true) { '0' }.to_i
 
-        # Over limit?
-        return false if hits.to_i > params[:limit].to_i
+        if values
+          value = params[:default_value] || false
+          values.each do |value_name, value_params|
+            if hits < value_params[:limit].to_i
+              value = value_params[:value] || value_params[:default_value] || false
+              break
+            end
+          end
+        else
+          # Over limit?
+          return false if hits > limit
+        end
 
         Throttling.storage.increment(key) if auto_increment
+        return value if values
       end
 
       return true

data/lib/throttling/version.rb

@@ -1,3 +1,3 @@
 module Throttling
-  VERSION = '0.2.0'
+  VERSION = '0.3.0'
 end

data/spec/base_spec.rb

@@ -97,6 +97,50 @@ describe Throttling do
     end
   end
 
+  context 'with values specified' do
+    before do
+      Throttling.limits_config = File.expand_path('../fixtures/throttling.yml', __FILE__)
+    end
+
+    it 'should return value when limit is not reached' do
+      @storage.should_receive(:fetch).and_return(0)
+      Throttling.for('request_priority').check_ip('127.0.0.1').should == 10
+      @storage.should_receive(:fetch).and_return(4)
+      Throttling.for('request_priority').check_ip('127.0.0.1').should == 10
+
+      @storage.should_receive(:fetch).and_return(5)
+      Throttling.for('request_priority').check_ip('127.0.0.1').should == 15
+      @storage.should_receive(:fetch).and_return(14)
+      Throttling.for('request_priority').check_ip('127.0.0.1').should == 15
+
+      @storage.should_receive(:fetch).and_return(15)
+      Throttling.for('request_priority').check_ip('127.0.0.1').should == 20
+      @storage.should_receive(:fetch).and_return(99)
+      Throttling.for('request_priority').check_ip('127.0.0.1').should == 20
+
+      @storage.should_receive(:fetch).and_return(100)
+      Throttling.for('request_priority').check_ip('127.0.0.1').should == 25
+      @storage.should_receive(:fetch).and_return(1000)
+      Throttling.for('request_priority').check_ip('127.0.0.1').should == 25
+    end
+
+    it 'should increase hit counter' do
+      @storage.should_receive(:fetch).and_return(4)
+      @storage.should_receive(:increment)
+      Throttling.for('request_priority').check_ip('127.0.0.1')
+
+      @storage.should_receive(:fetch).and_return(1000)
+      @storage.should_receive(:increment)
+      Throttling.for('request_priority').check_ip('127.0.0.1')
+    end
+
+    it 'should return false when highest limit reached' do
+      Throttling.limits['request_priority'].delete('default_value')
+      @storage.should_receive(:fetch).and_return(1000)
+      Throttling.for('request_priority').check_ip('127.0.0.1').should be_false
+    end
+  end
+
   context do
     before do
       Throttling.limits = { 'foo' => {'limit' => 5, 'period' => 86400} }

data/spec/fixtures/throttling.yml

@@ -12,3 +12,17 @@ search_requests:
   daily:
     limit: 10000
     period: 86400
+
+request_priority:
+  period: 86400
+  default_value: 25
+  values:
+    high_priority:
+      limit: 5
+      value: 10
+    medium_priority:
+      limit: 15
+      value: 15
+    low_priority:
+      limit: 100
+      value: 20

data/throttling.gemspec

@@ -15,9 +15,9 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency 'rb-fsevent'
   gem.add_development_dependency 'growl'
 
-  gem.files         = `git ls-files`.split($\)
+  gem.files         = `git ls-files`.split($\) - %w[.travis.yml]
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
-  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/}) + %w[Guardfile]
   gem.name          = "throttling"
   gem.require_paths = ["lib"]
   gem.version       = Throttling::VERSION

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: throttling
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -10,11 +10,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-04-12 00:00:00.000000000 Z
+date: 2012-04-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70166425496360 !ruby/object:Gem::Requirement
+  requirement: &70192665062020 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -22,10 +22,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70166425496360
+  version_requirements: *70192665062020
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70166425495940 !ruby/object:Gem::Requirement
+  requirement: &70192665061600 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -33,10 +33,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70166425495940
+  version_requirements: *70192665061600
 - !ruby/object:Gem::Dependency
   name: timecop
-  requirement: &70166425495520 !ruby/object:Gem::Requirement
+  requirement: &70192665061180 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -44,10 +44,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70166425495520
+  version_requirements: *70192665061180
 - !ruby/object:Gem::Dependency
   name: guard-rspec
-  requirement: &70166425495100 !ruby/object:Gem::Requirement
+  requirement: &70192665060760 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -55,10 +55,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70166425495100
+  version_requirements: *70192665060760
 - !ruby/object:Gem::Dependency
   name: rb-fsevent
-  requirement: &70166425494680 !ruby/object:Gem::Requirement
+  requirement: &70192665060340 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -66,10 +66,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70166425494680
+  version_requirements: *70192665060340
 - !ruby/object:Gem::Dependency
   name: growl
-  requirement: &70166425494260 !ruby/object:Gem::Requirement
+  requirement: &70192665059920 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -77,7 +77,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70166425494260
+  version_requirements: *70192665059920
 description: Throttling gem provides basic, but very powerful way to throttle various
   user actions in your application
 email:
@@ -87,7 +87,6 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
-- .travis.yml
 - CHANGELOG.md
 - Gemfile
 - Guardfile
@@ -132,3 +131,4 @@ test_files:
 - spec/fixtures/throttling.yml
 - spec/spec_helper.rb
 - spec/throttling_spec.rb
+- Guardfile

data/.travis.yml

@@ -1,9 +0,0 @@
-rvm:
-  - 1.8.7
-  - 1.9.3
-  - ree
-  - jruby
-
-notifications:
-  recipients:
-    - kpumuk@kpumuk.info