throttling 0.3.0 → 0.3.1

data/CHANGELOG.md

@@ -1,3 +1,14 @@
+## 0.3.1 (April 13, 2012)
+
+Features:
+
+  - When limit is omitted, no limits will be enforced (`check` always returns true)
+
+Bugfixes:
+
+  - Fixed bug when action was allowed `limit + 1` times
+  - When limit is 0, `check` should always return `false`
+
 ## 0.3.0 (April 13, 2012)
 
 Features:

data/lib/throttling/base.rb

@@ -35,11 +35,11 @@ module Throttling
 
       limits.each do |period_name, params|
         period = params[:period].to_i
-        limit  = params[:limit].to_i
+        limit  = params[:limit].nil? ? nil : 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
+        raise ArgumentError, "Invalid or no 'period' parameter in the limits[#{action}][#{period_name}] config: #{limit.inspect}" if period < 1
+        raise ArgumentError, "Invalid 'limit' parameter in the limits[#{action}][#{period_name}] config: #{limit.inspect}" if !limit.nil? && limit < 0
 
         key = hits_store_key(check_type, check_value, period_name, period)
 
@@ -56,7 +56,7 @@ module Throttling
           end
         else
           # Over limit?
-          return false if hits > limit
+          return false if !limit.nil? && hits >= limit
         end
 
         Throttling.storage.increment(key) if auto_increment

data/lib/throttling/version.rb

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

data/spec/base_spec.rb

@@ -18,9 +18,16 @@ describe Throttling do
           @t.send(check_method, nil).should be_true
         end
 
-        it 'should raise an exception if no limit specified in configs' do
+        it 'should return true if no limit specified in configs' do
           Throttling.limits['foo']['limit'] = nil
-          lambda { @t.send(check_method, valid_value) }.should raise_error(ArgumentError)
+          @storage.should_receive(:fetch).and_return(1000)
+          @t.send(check_method, valid_value).should be_true
+        end
+
+        it 'should return false if limit is 0' do
+          Throttling.limits['foo']['limit'] = 0
+          @storage.should_receive(:fetch).and_return(0)
+          @t.send(check_method, valid_value).should be_false
         end
 
         it 'should raise an exception if no period specified in configs' do
@@ -53,17 +60,23 @@ describe Throttling do
             @t.send(check_method, valid_value)
           end
 
-          it 'should increase hit counter when values equals to limit' do
+          it 'should not increase hit counter when values equals to limit' do
             @storage.should_receive(:fetch).and_return(Throttling.limits['foo']['limit'])
-            @storage.should_receive(:increment)
+            @storage.should_not_receive(:increment)
             @t.send(check_method, valid_value)
           end
 
-          it 'should increase hit counter when values equals to limit + 1' do
+          it 'should not increase hit counter when values equals to limit + 1' do
             @storage.should_receive(:fetch).and_return(Throttling.limits['foo']['limit'] + 1)
             @storage.should_not_receive(:increment)
             @t.send(check_method, valid_value)
           end
+
+          it 'should allow exactly limit actions' do
+            5.times { @t.send(check_method, valid_value).should be_true }
+            @storage.should_not_receive(:increment)
+            @t.send(check_method, valid_value).should be_false
+          end
         end
       end
     end

data/spec/spec_helper.rb

@@ -8,8 +8,9 @@ class TestStorage
   def fetch(key, options = {}, &block)
     @values ||= {}
     value = @values.fetch(key, &block)
-    @values[key] = options.merge(:value => value.to_s)
-    value
+    value = { :value => value.to_s } unless Hash === value
+    @values[key] = value.merge(options)
+    value[:value]
   end
 
   def increment(key)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: throttling
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
   prerelease: 
 platform: ruby
 authors:
@@ -14,7 +14,7 @@ date: 2012-04-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70192665062020 !ruby/object:Gem::Requirement
+  requirement: &70097466944080 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -22,10 +22,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70192665062020
+  version_requirements: *70097466944080
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70192665061600 !ruby/object:Gem::Requirement
+  requirement: &70097466943660 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -33,10 +33,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70192665061600
+  version_requirements: *70097466943660
 - !ruby/object:Gem::Dependency
   name: timecop
-  requirement: &70192665061180 !ruby/object:Gem::Requirement
+  requirement: &70097466943240 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -44,10 +44,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70192665061180
+  version_requirements: *70097466943240
 - !ruby/object:Gem::Dependency
   name: guard-rspec
-  requirement: &70192665060760 !ruby/object:Gem::Requirement
+  requirement: &70097466942820 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -55,10 +55,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70192665060760
+  version_requirements: *70097466942820
 - !ruby/object:Gem::Dependency
   name: rb-fsevent
-  requirement: &70192665060340 !ruby/object:Gem::Requirement
+  requirement: &70097466942400 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -66,10 +66,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70192665060340
+  version_requirements: *70097466942400
 - !ruby/object:Gem::Dependency
   name: growl
-  requirement: &70192665059920 !ruby/object:Gem::Requirement
+  requirement: &70097466941980 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -77,7 +77,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70192665059920
+  version_requirements: *70097466941980
 description: Throttling gem provides basic, but very powerful way to throttle various
   user actions in your application
 email: