prop 0.3.6 → 0.4.1

data/README.rdoc

@@ -54,6 +54,15 @@ If you wish to reset a specific throttle, you can do that like so:
 
 When the threshold are invoked without argument, the key is nil and as such a scope of its own.
 
+The default (and smallest possible) increment is 1, you can of course set that to any integer value using :increment
+
+  Prop.setup(:execution_time_ms, :threshold => 1000, :interval => 1.minute)
+  Prop.throttle_execution_time_ms!(:increment => (Benchmark.realtime { execute } * 1000).to_i)
+
+You can gauge the current value of a throttle using count:
+
+  Prop.count_mails_per_hour!(mail.from)
+
 Lastly you can use Prop without registering the thresholds up front:
 
   Prop.throttle!(:key => 'nuisance@example.com', :threshold => 100, :interval -> 1.hour)

data/VERSION

@@ -1 +1 @@
-0.3.6
+0.4.1

data/lib/prop.rb

@@ -65,7 +65,7 @@ class Prop
         end
         raise Prop::RateLimitExceededError.create(options[:key], options[:threshold], options[:message])
       else
-        writer.call(sanitized_prop_key(options), counter + 1)
+        writer.call(sanitized_prop_key(options), counter + [ 1, options[:increment].to_i ].max)
       end
     end
 
@@ -93,7 +93,7 @@ class Prop
       options = args.last.is_a?(Hash) ? args.pop : {}
       return {
         :key => normalize_cache_key(args), :message => defaults[:message], :progressive => defaults[:progressive],
-        :threshold => defaults[:threshold].to_i, :interval => defaults[:interval].to_i
+        :threshold => defaults[:threshold].to_i, :interval => defaults[:interval].to_i, :increment => defaults[:increment]
       }.merge(options)
     end
 

data/prop.gemspec

@@ -1,41 +1,39 @@
 # Generated by jeweler
 # DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in rakefile, and run the gemspec command
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
 
 Gem::Specification.new do |s|
   s.name = %q{prop}
-  s.version = "0.3.6"
+  s.version = "0.4.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Morten Primdahl"]
-  s.date = %q{2010-08-03}
+  s.date = %q{2010-12-08}
   s.description = %q{A gem for implementing rate limiting}
   s.email = %q{morten@zendesk.com}
   s.extra_rdoc_files = [
     "LICENSE",
-     "README.rdoc"
+    "README.rdoc"
   ]
   s.files = [
     ".document",
-     ".gitignore",
-     "LICENSE",
-     "README.rdoc",
-     "Rakefile",
-     "VERSION",
-     "lib/prop.rb",
-     "prop.gemspec",
-     "test/helper.rb",
-     "test/test_prop.rb"
+    "LICENSE",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "lib/prop.rb",
+    "prop.gemspec",
+    "test/helper.rb",
+    "test/test_prop.rb"
   ]
   s.homepage = %q{http://github.com/morten/prop}
-  s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
   s.rubygems_version = %q{1.3.7}
   s.summary = %q{Puts a cork in their requests}
   s.test_files = [
     "test/helper.rb",
-     "test/test_prop.rb"
+    "test/test_prop.rb"
   ]
 
   if s.respond_to? :specification_version then

data/test/helper.rb

@@ -2,6 +2,7 @@ require 'rubygems'
 require 'test/unit'
 require 'shoulda'
 require 'mocha'
+require 'time'
 
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 $LOAD_PATH.unshift(File.dirname(__FILE__))

data/test/test_prop.rb

@@ -140,7 +140,7 @@ class TestProp < Test::Unit::TestCase
         assert_raises(Prop::RateLimitExceededError) { Prop.throttle_progressive! }
       end
 
-      should "not increment the counter beyon the threshold" do
+      should "not increment the counter beyond the threshold" do
         10.times do |i|
           Prop.throttle!(:key => 'hello', :threshold => 5, :interval => 10) rescue nil
         end
@@ -148,6 +148,17 @@ class TestProp < Test::Unit::TestCase
         assert_equal 5, Prop.count(:key => 'hello', :threshold => 5, :interval => 10)
       end
 
+      should "support custom increments" do
+        Prop.throttle!(:key => 'hello', :threshold => 100, :interval => 10)
+        Prop.throttle!(:key => 'hello', :threshold => 100, :interval => 10)
+
+        assert_equal 2, Prop.count(:key => 'hello', :threshold => 100, :interval => 10)
+
+        Prop.throttle!(:key => 'hello', :threshold => 100, :interval => 10, :increment => 48)
+
+        assert_equal 50, Prop.count(:key => 'hello', :threshold => 100, :interval => 10)
+      end
+
       should "raise Prop::RateLimitExceededError when the threshold is exceeded" do
         5.times do |i|
           Prop.throttle!(:key => 'hello', :threshold => 5, :interval => 10)

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: prop
 version: !ruby/object:Gem::Version 
-  hash: 31
+  hash: 13
   prerelease: false
   segments: 
   - 0
-  - 3
-  - 6
-  version: 0.3.6
+  - 4
+  - 1
+  version: 0.4.1
 platform: ruby
 authors: 
 - Morten Primdahl
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-08-03 00:00:00 -07:00
+date: 2010-12-08 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -59,7 +59,6 @@ extra_rdoc_files:
 - README.rdoc
 files: 
 - .document
-- .gitignore
 - LICENSE
 - README.rdoc
 - Rakefile
@@ -73,8 +72,8 @@ homepage: http://github.com/morten/prop
 licenses: []
 
 post_install_message: 
-rdoc_options: 
-- --charset=UTF-8
+rdoc_options: []
+
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 

data/.gitignore

@@ -1,21 +0,0 @@
-## MAC OS
-.DS_Store
-
-## TEXTMATE
-*.tmproj
-tmtags
-
-## EMACS
-*~
-\#*
-.\#*
-
-## VIM
-*.swp
-
-## PROJECT::GENERAL
-coverage
-rdoc
-pkg
-
-## PROJECT::SPECIFIC