prop 0.3.1 → 0.3.2

data/README.rdoc

@@ -38,7 +38,7 @@ If this method gets called more than "threshold" times within "interval in secon
 
 You can chose to override the threshold for a given key:
 
-  Prop.mails_per_hour(mail.from, :threshold => account.mail_throttle_threshold)
+  Prop.throttle_mails_per_hour!(mail.from, :threshold => account.mail_throttle_threshold)
 
 If you wish to reset a specific throttle, you can do that like so:
 
@@ -49,7 +49,9 @@ When the threshold are invoked without argument, the key is nil and as such a sc
 Lastly you can use Prop without registering the thresholds up front:
 
   Prop.throttle!(:key => 'nuisance@example.com', :threshold => 100, :interval -> 1.hour)
+  Prop.throttle?(:key => 'nuisance@example.com', :threshold => 100, :interval -> 1.hour)
   Prop.reset(:key => 'nuisance@example.com', :threshold => 100, :interval -> 1.hour)
+  Prop.count(:key => 'nuisance@example.com', :threshold => 100, :interval -> 1.hour)
 
 It's up to you to pass an appropriate key which reflects the scope you're rate limiting. The interval is tied to the underlying key generating mechanism, so if you change that between calls and have all other things equal, then that will result in different throttles being set.
 

data/VERSION

@@ -1 +1 @@
-0.3.1
+0.3.2

data/lib/prop.rb

@@ -39,18 +39,16 @@ class Prop
     end
 
     def throttle?(options)
-      cache_key = sanitized_prop_key(options)
-      reader.call(cache_key).to_i >= options[:threshold]
+      count(options) >= options[:threshold]
     end
 
     def throttle!(options)
-      cache_key = sanitized_prop_key(options)
-      counter   = reader.call(cache_key).to_i
+      counter = count(options)
 
       if counter >= options[:threshold]
         raise Prop::RateLimitExceededError.new("#{options[:key]} threshold #{options[:threshold]} exceeded")
       else
-        writer.call(cache_key, counter + 1)
+        writer.call(sanitized_prop_key(options), counter + 1)
       end
     end
 
@@ -66,18 +64,30 @@ class Prop
 
     private
 
+    # Builds the expiring cache key
     def sanitized_prop_key(options)
-      cache_key = "#{options[:key]}/#{Time.now.to_i / options[:interval]}"
+      cache_key = "#{normalize_cache_key(options[:key])}/#{Time.now.to_i / options[:interval]}"
       "prop/#{Digest::MD5.hexdigest(cache_key)}"
     end
-    
+
+    # Sanitizes the option set and sets defaults
     def sanitized_prop_options(handle, args, defaults)
       key  = handle.to_s
-      key << "/#{args.first}" if args.first
+      key << "/#{normalize_cache_key(args.first)}" if args.first
 
       options = { :key => key, :threshold => defaults[:threshold].to_i, :interval => defaults[:interval].to_i }
       options = options.merge(args.last) if args.last.is_a?(Hash)
       options
     end
+
+    # Simple key expansion only supports arrays and primitives
+    def normalize_cache_key(key)
+      if key.is_a?(Array)
+        key.map { |part| normalize_cache_key(part) }.join('/')
+      else
+        key.to_s
+      end
+    end
+
   end
 end

data/prop.gemspec

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

data/test/test_prop.rb

@@ -26,6 +26,8 @@ class TestProp < Test::Unit::TestCase
       should "accept a handle and an options hash" do
         Prop.setup :hello_there, :threshold => 40, :interval => 100
         assert Prop.respond_to?(:throttle_hello_there!)
+        assert Prop.respond_to?(:throttle_hello_there?)
+        assert Prop.respond_to?(:reset_hello_there)
       end
 
       should "result in a default handle" do
@@ -38,9 +40,14 @@ class TestProp < Test::Unit::TestCase
         assert_equal 5, Prop.throttle_hello_there!('some key', :threshold => 20)
       end
 
-      should "create a handle accepts integer keys" do
+      should "create a handle accepts various cache key types" do
         Prop.setup :hello_there, :threshold => 4, :interval => 10
-        assert Prop.throttle_hello_there!(5)
+        assert_equal 1, Prop.throttle_hello_there!(5)
+        assert_equal 2, Prop.throttle_hello_there!(5)
+        assert_equal 1, Prop.throttle_hello_there!('mister')
+        assert_equal 2, Prop.throttle_hello_there!('mister')
+        assert_equal 1, Prop.throttle_hello_there!(['mister', 5])
+        assert_equal 2, Prop.throttle_hello_there!(['mister', 5])
       end
 
       should "not shadow undefined methods" do

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: prop
 version: !ruby/object:Gem::Version 
-  hash: 17
+  hash: 23
   prerelease: false
   segments: 
   - 0
   - 3
-  - 1
-  version: 0.3.1
+  - 2
+  version: 0.3.2
 platform: ruby
 authors: 
 - Morten Primdahl
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-07-21 00:00:00 -07:00
+date: 2010-07-22 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency