prop 0.5.1 → 0.6.0

data/README.rdoc

@@ -15,9 +15,9 @@ To get going with Prop you first define the read and write operations. These def
 
 You can choose to rely on a database or Moneta or Redis or whatever you'd like to use for transient storage. Prop does not do any sort of clean up of its key space, so you would have to implement that manually should you be using anything but an LRU cache.
 
-Once the read and write operations are defined, you can optionally define some preconfigured default thresholds. If for example, you want to have a threshold on accepted emails per hour from a given user, you could define a threshold and interval (in seconds) for this like so:
+Once the read and write operations are defined, you can optionally define thresholds. If for example, you want to have a threshold on accepted emails per hour from a given user, you could define a threshold and interval (in seconds) for this like so:
 
-  Prop.defaults(:mails_per_hour, :threshold => 100, :interval => 1.hour)
+  Prop.configure(:mails_per_hour, :threshold => 100, :interval => 1.hour)
 
 You can now put the throttle to work with this values, by passing the "handle" to the respective methods in Prop:
 
@@ -50,7 +50,7 @@ If the throttle! method gets called more than "threshold" times within "interval
   THROTTLE_MESSAGES[:login] = "Too many invalid login attempts. Try again later."
 
   rescue_from Prop::RateLimitExceededError do |exception|
-    render :status => 403, :message => THROTTLE_MESSAGES[exception.handle]
+    render :status => 403, :message => I18n.t(THROTTLE_MESSAGES[exception.handle])
   end
 
 You can chose to override the threshold for a given key:
@@ -72,7 +72,7 @@ The default (and smallest possible) increment is 1, you can set that to any inte
 Prop uses the interval to define a window of time using simple div arithmetic. This means that it's a worst case throttle that will allow up to 2 times the specified requests within the specified interval.
 
 == Note on Patches/Pull Requests
- 
+
 * Fork the project.
 * Make your feature addition or bug fix.
 * Add tests for it. This is important so I don't break it in a
@@ -81,6 +81,3 @@ Prop uses the interval to define a window of time using simple div arithmetic. T
   (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
 * Send me a pull request. Bonus points for topic branches.
 
-== Copyright
-
-Copyright (c) 2010 Morten Primdahl. See LICENSE for details.

data/VERSION

@@ -1 +1 @@
-0.5.1
+0.6.0

data/lib/prop.rb

@@ -29,7 +29,7 @@ class Prop
       self.writer = blk
     end
 
-    def defaults(handle, defaults)
+    def configure(handle, defaults)
       raise RuntimeError.new("Invalid threshold setting") unless defaults[:threshold].to_i > 0
       raise RuntimeError.new("Invalid interval setting")  unless defaults[:interval].to_i > 0
 

data/prop.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{prop}
-  s.version = "0.5.1"
+  s.version = "0.6.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Morten Primdahl"]
-  s.date = %q{2011-02-03}
+  s.date = %q{2011-08-18}
   s.description = %q{A gem for implementing rate limiting}
   s.email = %q{morten@zendesk.com}
   s.extra_rdoc_files = [
@@ -30,15 +30,10 @@ Gem::Specification.new do |s|
   ]
   s.homepage = %q{http://github.com/morten/prop}
   s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.7}
+  s.rubygems_version = %q{1.6.2}
   s.summary = %q{Puts a cork in their requests}
-  s.test_files = [
-    "test/helper.rb",
-    "test/test_prop.rb"
-  ]
 
   if s.respond_to? :specification_version then
-    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
     s.specification_version = 3
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then

data/test/test_prop.rb

@@ -15,16 +15,16 @@ class TestProp < Test::Unit::TestCase
     context "#defaults" do
       should "raise errors on invalid configuation" do
         assert_raises(RuntimeError) do
-          Prop.defaults :hello_there, :threshold => 20, :interval => 'hello'
+          Prop.configure :hello_there, :threshold => 20, :interval => 'hello'
         end
 
         assert_raises(RuntimeError) do
-          Prop.defaults :hello_there, :threshold => 'wibble', :interval => 100
+          Prop.configure :hello_there, :threshold => 'wibble', :interval => 100
         end
       end
 
       should "result in a default handle" do
-        Prop.defaults :hello_there, :threshold => 4, :interval => 10
+        Prop.configure :hello_there, :threshold => 4, :interval => 10
         4.times do |i|
           assert_equal (i + 1), Prop.throttle!(:hello_there, 'some key')
         end
@@ -34,7 +34,7 @@ class TestProp < Test::Unit::TestCase
       end
 
       should "create a handle accepts various cache key types" do
-        Prop.defaults :hello_there, :threshold => 4, :interval => 10
+        Prop.configure :hello_there, :threshold => 4, :interval => 10
         assert_equal 1, Prop.throttle!(:hello_there, 5)
         assert_equal 2, Prop.throttle!(:hello_there, 5)
         assert_equal 1, Prop.throttle!(:hello_there, '6')
@@ -46,7 +46,7 @@ class TestProp < Test::Unit::TestCase
 
     context "#reset" do
       setup do
-        Prop.defaults :hello, :threshold => 10, :interval => 10
+        Prop.configure :hello, :threshold => 10, :interval => 10
 
         5.times do |i|
           assert_equal (i + 1), Prop.throttle!(:hello)
@@ -68,7 +68,7 @@ class TestProp < Test::Unit::TestCase
 
     context "#throttled?" do
       should "return true once the threshold has been reached" do
-        Prop.defaults(:hello, :threshold => 2, :interval => 10)
+        Prop.configure(:hello, :threshold => 2, :interval => 10)
         Prop.throttle!(:hello)
         assert !Prop.throttled?(:hello)
         Prop.throttle!(:hello)
@@ -96,7 +96,7 @@ class TestProp < Test::Unit::TestCase
       end
 
       should "not increment the counter beyond the threshold" do
-        Prop.defaults(:hello, :threshold => 5, :interval => 1)
+        Prop.configure(:hello, :threshold => 5, :interval => 1)
         10.times do |i|
           Prop.throttle!(:hello) rescue nil
         end
@@ -105,7 +105,7 @@ class TestProp < Test::Unit::TestCase
       end
 
       should "support custom increments" do
-        Prop.defaults(:hello, :threshold => 100, :interval => 10)
+        Prop.configure(:hello, :threshold => 100, :interval => 10)
 
         Prop.throttle!(:hello)
         Prop.throttle!(:hello)

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: prop
 version: !ruby/object:Gem::Version 
-  hash: 9
-  prerelease: false
+  hash: 7
+  prerelease: 
   segments: 
   - 0
-  - 5
-  - 1
-  version: 0.5.1
+  - 6
+  - 0
+  version: 0.6.0
 platform: ruby
 authors: 
 - Morten Primdahl
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-02-03 00:00:00 -08:00
+date: 2011-08-18 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -98,10 +98,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.7
+rubygems_version: 1.6.2
 signing_key: 
 specification_version: 3
 summary: Puts a cork in their requests
-test_files: 
-- test/helper.rb
-- test/test_prop.rb
+test_files: []
+