prop 0.7.2 → 0.7.3

data/README.md

@@ -56,7 +56,7 @@ The throttle scope can also be an array of values, e.g.:
 
 If the throttle! method gets called more than "threshold" times within "interval in seconds" for a given handle and key combination, Prop throws a Prop::RateLimited error which is a subclass of StandardError. This exception contains a "handle" reference and a "description" if specified during the configuration. The handle allows you to rescue Prop::RateLimited and differentiate action depending on the handle. For example, in Rails you can use this in e.g. ApplicationController:
 
-    rescue_from Prop::RateLimitExceededError do |e|
+    rescue_from Prop::RateLimited do |e|
       if e.handle == :authorization_attempt
         render :status => :forbidden, :message => I18n.t(e.description)
       elsif ...

data/lib/prop.rb

@@ -2,7 +2,7 @@ require "prop/limiter"
 require "forwardable"
 
 module Prop
-  VERSION = "0.7.2"
+  VERSION = "0.7.3"
 
   # Short hand for accessing Prop::Limiter methods
   class << self

data/lib/prop/limiter.rb

@@ -45,19 +45,26 @@ module Prop
       # handle  - the registered handle associated with the action
       # key     - a custom request specific key, e.g. [ account.id, "download", request.remote_ip ]
       # options - request specific overrides to the defaults configured for this handle
+      # blk     - an optional block of code that this throttle is guarding
       #
       # Raises Prop::RateLimited if the number if the threshold for this handle has been reached
-      def throttle!(handle, key = nil, options = {})
+      # Returns the value of the block if given a such, otherwise the current count of the throttle
+      def throttle!(handle, key = nil, options = {}, &blk)
         options, cache_key = prepare(handle, key, options)
-
         counter = reader.call(cache_key).to_i
 
-        return counter if disabled?
+        unless disabled?
+          if at_threshold?(counter, options[:threshold])
+            raise Prop::RateLimited.new(options.merge(:cache_key => cache_key, :handle => handle))
+          else
+            counter = writer.call(cache_key, counter + [ 1, options[:increment].to_i ].max)
+          end
+        end
 
-        if counter >= options[:threshold]
-          raise Prop::RateLimited.new(options.merge(:cache_key => cache_key, :handle => handle))
+        if block_given?
+          yield
         else
-          writer.call(cache_key, counter + [ 1, options[:increment].to_i ].max)
+          counter
         end
       end
 
@@ -97,6 +104,10 @@ module Prop
 
       private
 
+      def at_threshold?(mark, threshold)
+        mark >= threshold
+      end
+
       def disabled?
         !!@disabled
       end

data/prop.gemspec

@@ -13,7 +13,7 @@ Gem::Specification.new do |s|
   ## If your rubyforge_project name is different, then edit it and comment out
   ## the sub! line in the Rakefile
   s.name              = 'prop'
-  s.version           = '0.7.2'
+  s.version           = '0.7.3'
   s.date              = '2012-04-06'
   s.rubyforge_project = 'prop'
 
@@ -74,6 +74,7 @@ Gem::Specification.new do |s|
     prop.gemspec
     test/helper.rb
     test/test_key.rb
+    test/test_limiter.rb
     test/test_middleware.rb
     test/test_options.rb
     test/test_prop.rb

data/test/test_limiter.rb

@@ -0,0 +1,83 @@
+require 'helper'
+
+class TestLimiter < Test::Unit::TestCase
+
+  context Prop::Limiter do
+    setup do
+      @store = {}
+
+      Prop::Limiter.read  { |key| @store[key] }
+      Prop::Limiter.write { |key, value| @store[key] = value }
+      Prop::Limiter.configure(:something, :threshold => 10, :interval => 10)
+
+      @start = Time.now
+      Time.stubs(:now).returns(@start)
+    end
+
+    context "#throttle!" do
+      setup do
+        Prop.reset(:something)
+      end
+
+      context "when disabled" do
+        setup { Prop::Limiter.expects(:disabled?).returns(true) }
+
+        [ true, false ].each do |threshold_reached|
+          context "and threshold has #{"not " unless threshold_reached}been reached" do
+            setup { Prop::Limiter.stubs(:at_threshold?).returns(threshold_reached) }
+
+            context "given a block" do
+              should "execute that block" do
+                assert_equal "wibble", Prop.throttle!(:something) { "wibble" }
+              end
+            end
+
+            context "not given a block" do
+              should "return the current throttle count" do
+                assert_equal Prop.count(:something), Prop.throttle!(:something)
+              end
+            end
+          end
+        end
+      end
+
+      context "when not disabled" do
+        setup { Prop::Limiter.expects(:disabled?).returns(false) }
+
+        context "and threshold has been reached" do
+          setup { Prop::Limiter.expects(:at_threshold?).returns(true) }
+
+          context "given a block" do
+            should "raise Prop::RateLimited" do
+              assert_raises(Prop::RateLimited) { Prop.throttle!(:something) { "wibble" }}
+            end
+          end
+
+          context "not given a block" do
+            should "raise Prop::RateLimited" do
+              assert_raises(Prop::RateLimited) { Prop.throttle!(:something) }
+            end
+          end
+        end
+
+        context "and threshold has not been reached" do
+          setup do
+            Prop::Limiter.expects(:at_threshold?).returns(false)
+          end
+
+          context "given a block" do
+            should "execute that block" do
+              assert_equal "wibble", Prop.throttle!(:something) { "wibble" }
+            end
+          end
+
+          context "not given a block" do
+            should "return the updated throttle count" do
+              assert_equal Prop.count(:something) + 1, Prop.throttle!(:something)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/test/test_prop.rb

@@ -1,5 +1,6 @@
 require 'helper'
 
+# Integration level tests
 class TestProp < Test::Unit::TestCase
 
   context "Prop" do

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: prop
 version: !ruby/object:Gem::Version 
-  hash: 7
+  hash: 5
   prerelease: 
   segments: 
   - 0
   - 7
-  - 2
-  version: 0.7.2
+  - 3
+  version: 0.7.3
 platform: ruby
 authors: 
 - Morten Primdahl
@@ -96,6 +96,7 @@ files:
 - prop.gemspec
 - test/helper.rb
 - test/test_key.rb
+- test/test_limiter.rb
 - test/test_middleware.rb
 - test/test_options.rb
 - test/test_prop.rb
@@ -135,6 +136,7 @@ specification_version: 2
 summary: Gem for implementing rate limits.
 test_files: 
 - test/test_key.rb
+- test/test_limiter.rb
 - test/test_middleware.rb
 - test/test_options.rb
 - test/test_prop.rb