prop 0.3.5 → 0.3.6

data/VERSION

@@ -1 +1 @@
-0.3.5
+0.3.6

data/lib/prop.rb

@@ -13,7 +13,7 @@ class Prop
     def self.create(key, threshold, message)
       default = "#{key} threshold #{threshold} exceeded"
       error   = new(message || default)
-      error.retry_after  = threshold - Time.now.to_i % threshold
+      error.retry_after  = threshold - Time.now.to_i % threshold if threshold > 0
       error.root_message = default
 
       raise error
@@ -46,6 +46,10 @@ class Prop
       define_prop_class_method "reset_#{handle}" do |*args|
         reset(sanitized_prop_options([ handle ] + args, defaults))
       end
+
+      define_prop_class_method "count_#{handle}" do |*args|
+        count(sanitized_prop_options([ handle ] + args, defaults))
+      end
     end
 
     def throttle?(options)
@@ -56,6 +60,9 @@ class Prop
       counter = count(options)
 
       if counter >= options[:threshold]
+        if options[:progressive]
+          writer.call(sanitized_prop_key(options.merge(:window_modifier => 1)), counter) 
+        end
         raise Prop::RateLimitExceededError.create(options[:key], options[:threshold], options[:message])
       else
         writer.call(sanitized_prop_key(options), counter + 1)
@@ -76,7 +83,8 @@ class Prop
 
     # Builds the expiring cache key
     def sanitized_prop_key(options)
-      cache_key = "#{normalize_cache_key(options[:key])}/#{Time.now.to_i / options[:interval]}"
+      window    = (Time.now.to_i / options[:interval]) + options[:window_modifier].to_i
+      cache_key = "#{normalize_cache_key(options[:key])}/#{ window }"
       "prop/#{Digest::MD5.hexdigest(cache_key)}"
     end
 
@@ -84,7 +92,7 @@ class Prop
     def sanitized_prop_options(args, defaults)
       options = args.last.is_a?(Hash) ? args.pop : {}
       return {
-        :key => normalize_cache_key(args), :message => defaults[:message],
+        :key => normalize_cache_key(args), :message => defaults[:message], :progressive => defaults[:progressive],
         :threshold => defaults[:threshold].to_i, :interval => defaults[:interval].to_i
       }.merge(options)
     end

data/prop.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{prop}
-  s.version = "0.3.5"
+  s.version = "0.3.6"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Morten Primdahl"]
-  s.date = %q{2010-07-22}
+  s.date = %q{2010-08-03}
   s.description = %q{A gem for implementing rate limiting}
   s.email = %q{morten@zendesk.com}
   s.extra_rdoc_files = [

data/test/test_prop.rb

@@ -111,6 +111,35 @@ class TestProp < Test::Unit::TestCase
         end
       end
 
+      should "not reset counter when violations happen during the time window for a progressive cache" do
+        start = Time.parse("2006-05-04 03:02:01")
+        Time.stubs(:now).returns(start)
+
+        Prop.setup :not_progressive, :threshold => 5, :interval => 10
+
+        assert_raises(Prop::RateLimitExceededError) do
+          6.times { Prop.throttle_not_progressive! }
+        end
+
+        Time.stubs(:now).returns(start + 5)
+        assert_raises(Prop::RateLimitExceededError) { Prop.throttle_not_progressive! }
+        Time.stubs(:now).returns(start + 15)
+        assert Prop.throttle_not_progressive!
+
+        Time.stubs(:now).returns(start)
+        Prop.setup :progressive, :threshold => 5, :interval => 10, :progressive => true
+
+        assert_raises(Prop::RateLimitExceededError) do
+          6.times { Prop.throttle_progressive! }
+        end
+
+        Time.stubs(:now).returns(start + 5)
+        assert_raises(Prop::RateLimitExceededError) { Prop.throttle_progressive! }
+
+        Time.stubs(:now).returns(start + 11)
+        assert_raises(Prop::RateLimitExceededError) { Prop.throttle_progressive! }
+      end
+
       should "not increment the counter beyon the threshold" do
         10.times do |i|
           Prop.throttle!(:key => 'hello', :threshold => 5, :interval => 10) rescue nil

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: prop
 version: !ruby/object:Gem::Version 
-  hash: 25
+  hash: 31
   prerelease: false
   segments: 
   - 0
   - 3
-  - 5
-  version: 0.3.5
+  - 6
+  version: 0.3.6
 platform: ruby
 authors: 
 - Morten Primdahl
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-07-22 00:00:00 -07:00
+date: 2010-08-03 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency