prop 0.6.4 → 0.6.5

data/Gemfile

@@ -0,0 +1,3 @@
+source "http://rubygems.org"
+
+gemspec

data/{README.rdoc → README.md}

@@ -1,96 +1,96 @@
 
-= Prop
+# Prop [![Build Status](https://secure.travis-ci.org/morten/prop.png)](http://travis-ci.org/morten/prop)
 
 Prop is a simple gem for rate limiting requests of any kind. It allows you to configure hooks for registering certain actions, such that you can define thresholds, register usage and finally act on exceptions once thresholds get exceeded.
 
 To get going with Prop you first define the read and write operations. These define how you write a registered request and how to read the number of requests for a given action. For example do something like the below in a Rails initializer:
 
-  Prop.read do |key|
-    Rails.cache.read(key)
-  end
+    Prop.read do |key|
+      Rails.cache.read(key)
+    end
 
-  Prop.write do |key, value|
-    Rails.cache.write(key, value)
-  end
+    Prop.write do |key, value|
+      Rails.cache.write(key, value)
+    end
 
 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.
 
-== Defining thresholds
+## Defining thresholds
 
 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.configure(:mails_per_hour, :threshold => 100, :interval => 1.hour, :description => "Mail rate limit exceeded")
+    Prop.configure(:mails_per_hour, :threshold => 100, :interval => 1.hour, :description => "Mail rate limit exceeded")
 
 You can now put the throttle to work with this values, by passing the "handle" to the respective methods in Prop:
 
-  # Throws Prop::RateLimitExceededError if the threshold/interval has been reached
-  Prop.throttle!(:mails_per_hour)
+    # Throws Prop::RateLimitExceededError if the threshold/interval has been reached
+    Prop.throttle!(:mails_per_hour)
 
-  # Returns true if the threshold/interval has been reached
-  Prop.throttled?(:mails_per_hour)
+    # Returns true if the threshold/interval has been reached
+    Prop.throttled?(:mails_per_hour)
 
-  # Sets the throttle "count" to 0
-  Prop.reset(:mails_per_hour)
+    # Sets the throttle "count" to 0
+    Prop.reset(:mails_per_hour)
 
-  # Returns the value of this throttle, usually a count, but see below for more
-  Prop.query(:mails_per_hour)
+    # Returns the value of this throttle, usually a count, but see below for more
+    Prop.query(:mails_per_hour)
 
 Prop will raise a RuntimeError if you attempt to operate on an undefined handle.
 
-== Scoping a throttle
+## Scoping a throttle
 
 In many cases you will want to tie a specific key to a defined throttle, for example you can scope the throttling to a specific sender rather than running a global "mails per hour" throttle:
 
-  Prop.throttle!(:mails_per_hour, mail.from)
-  Prop.throttled?(:mails_per_hour, mail.from)
-  Prop.reset(:mails_per_hour, mail.from)
-  Prop.query(:mails_per_hour, mail.from)
+    Prop.throttle!(:mails_per_hour, mail.from)
+    Prop.throttled?(:mails_per_hour, mail.from)
+    Prop.reset(:mails_per_hour, mail.from)
+    Prop.query(:mails_per_hour, mail.from)
 
 The throttle scope can also be an array of values, e.g.:
 
-  Prop.throttle!(:mails_per_hour, [ account.id, mail.from ])
+    Prop.throttle!(:mails_per_hour, [ account.id, mail.from ])
 
-== Error handling
+## Error handling
 
 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::RateLimitExceededError. This exception contains a "handle" reference and a "description" if specified during the configuration. The handle allows you to rescue Prop::RateLimitExceededError 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|
-    if e.handle == :authorization_attempt
-      render :status => :forbidden, :message => I18n.t(e.description)
-    elsif ...
-
+    rescue_from Prop::RateLimitExceededError do |e|
+      if e.handle == :authorization_attempt
+        render :status => :forbidden, :message => I18n.t(e.description)
+      elsif ...
+    
+      end
     end
-  end
 
-== Disabling Prop
+## Disabling Prop
 
 In case you need to perform e.g. a manual bulk operation:
 
-  Prop.disabled do
-    # No throttles will be tested here
-  end
+    Prop.disabled do
+      # No throttles will be tested here
+    end
 
-== Threshold settings
+## Threshold settings
 
 You can chose to override the threshold for a given key:
 
-  Prop.throttle!(:mails_per_hour, mail.from, :threshold => current_account.mail_throttle_threshold)
+    Prop.throttle!(:mails_per_hour, mail.from, :threshold => current_account.mail_throttle_threshold)
 
 When the threshold are invoked without argument, the key is nil and as such a scope of its own, i.e. these are equivalent:
 
-  Prop.throttle!(:mails_per_hour)
-  Prop.throttle!(:mails_per_hour, nil)
+    Prop.throttle!(:mails_per_hour)
+    Prop.throttle!(:mails_per_hour, nil)
 
 The default (and smallest possible) increment is 1, you can set that to any integer value using :increment which is handy for building time based throttles:
 
-  Prop.setup(:execute_time, :threshold => 10, :interval => 1.minute)
-  Prop.throttle!(:execute_time, account.id, :increment => (Benchmark.realtime { execute }).to_i)
+    Prop.setup(:execute_time, :threshold => 10, :interval => 1.minute)
+    Prop.throttle!(:execute_time, account.id, :increment => (Benchmark.realtime { execute }).to_i)
 
-== How it works
+## How it works
 
 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
+## Note on Patches/Pull Requests
 
 * Fork the project.
 * Make your feature addition or bug fix.

data/lib/prop.rb

@@ -7,7 +7,7 @@ class Object
 end
 
 class Prop
-  VERSION = "0.6.4"
+  VERSION = "0.6.5"
 
   class RateLimitExceededError < RuntimeError
     attr_accessor :handle, :retry_after, :description
@@ -103,10 +103,11 @@ class Prop
 
       defaults = handles[handle]
       return {
-        :key       => normalize_cache_key(key),
-        :increment => defaults[:increment],
-        :threshold => defaults[:threshold].to_i,
-        :interval  => defaults[:interval].to_i
+        :key         => normalize_cache_key(key),
+        :increment   => defaults[:increment],
+        :description => defaults[:description],
+        :threshold   => defaults[:threshold].to_i,
+        :interval    => defaults[:interval].to_i
       }.merge(options)
     end
 

data/prop.gemspec

@@ -13,8 +13,8 @@ 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.6.4'
-  s.date              = '2011-11-30'
+  s.version           = '0.6.5'
+  s.date              = '2011-12-13'
   s.rubyforge_project = 'prop'
 
   ## Make sure your summary is short. The description may be as long
@@ -43,7 +43,7 @@ Gem::Specification.new do |s|
   ## Specify any RDoc options here. You'll want to add your README and
   ## LICENSE files to the extra_rdoc_files list.
   s.rdoc_options = ["--charset=UTF-8"]
-  s.extra_rdoc_files = %w[README.rdoc LICENSE]
+  s.extra_rdoc_files = %w[README.md LICENSE]
 
   ## List your runtime dependencies here. Runtime dependencies are those
   ## that are needed for an end user to actually USE your code.
@@ -61,8 +61,9 @@ Gem::Specification.new do |s|
   ## THE MANIFEST COMMENTS, they are used as delimiters by the task.
   # = MANIFEST =
   s.files = %w[
+    Gemfile
     LICENSE
-    README.rdoc
+    README.md
     Rakefile
     lib/prop.rb
     prop.gemspec

data/test/test_prop.rb

@@ -152,15 +152,17 @@ class TestProp < Test::Unit::TestCase
       end
 
       should "raise Prop::RateLimitExceededError when the threshold is exceeded" do
+        Prop.configure(:hello, :threshold => 5, :interval => 10, :description => "Boom!")
+
         5.times do |i|
-          Prop.throttle!(:hello, nil, :threshold => 5, :interval => 10)
+          Prop.throttle!(:hello, nil)
         end
         assert_raises(Prop::RateLimitExceededError) do
-          Prop.throttle!(:hello, nil, :threshold => 5, :interval => 10)
+          Prop.throttle!(:hello, nil)
         end
 
         begin
-          Prop.throttle!(:hello, nil, :threshold => 5, :interval => 10, :description => "Boom!")
+          Prop.throttle!(:hello, nil)
           fail
         rescue Prop::RateLimitExceededError => e
           assert_equal :hello, e.handle

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: prop
 version: !ruby/object:Gem::Version 
-  hash: 15
+  hash: 13
   prerelease: 
   segments: 
   - 0
   - 6
-  - 4
-  version: 0.6.4
+  - 5
+  version: 0.6.5
 platform: ruby
 authors: 
 - Morten Primdahl
@@ -15,13 +15,13 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-11-30 00:00:00 -08:00
+date: 2011-12-13 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: rake
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  type: :development
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -30,12 +30,12 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  type: :development
-  version_requirements: *id001
+  prerelease: false
+  requirement: *id001
 - !ruby/object:Gem::Dependency 
   name: bundler
-  prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  type: :development
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -44,12 +44,12 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  type: :development
-  version_requirements: *id002
+  prerelease: false
+  requirement: *id002
 - !ruby/object:Gem::Dependency 
   name: shoulda
-  prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  type: :development
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -58,12 +58,12 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  type: :development
-  version_requirements: *id003
+  prerelease: false
+  requirement: *id003
 - !ruby/object:Gem::Dependency 
   name: mocha
-  prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  type: :development
+  version_requirements: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -72,8 +72,8 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  type: :development
-  version_requirements: *id004
+  prerelease: false
+  requirement: *id004
 description: Gem for implementing rate limits.
 email: primdahl@me.com
 executables: []
@@ -81,11 +81,12 @@ executables: []
 extensions: []
 
 extra_rdoc_files: 
-- README.rdoc
+- README.md
 - LICENSE
 files: 
+- Gemfile
 - LICENSE
-- README.rdoc
+- README.md
 - Rakefile
 - lib/prop.rb
 - prop.gemspec