prop 0.3.3 → 0.3.4

data/README.rdoc

@@ -34,7 +34,15 @@ In many cases you will want to tie a specific key to a defined throttle, for exa
 
   Prop.throttle_mails_per_hour!(mail.from)
 
-If this method gets called more than "threshold" times within "interval in seconds" Prop throws a Prop::RateLimitExceededError. 
+If this method gets called more than "threshold" times within "interval in seconds" Prop throws a Prop::RateLimitExceededError. You can change the message of this error, which is handy when you are using Prop in multiple locations and want to be able to differentiate further up the stack. For example:
+
+  Prop.setup(:logins, :threshold => 5, :interval => 5.minutes, :message => "Too many invalid login attempts.")
+
+In Rails you can use this in e.g. ApplicationController:
+
+  rescue_from Prop::RateLimitExceededError do |exception|
+    render :status => 403, :message => exception.message
+  end
 
 You can chose to override the threshold for a given key:
 

data/VERSION

@@ -1 +1 @@
-0.3.3
+0.3.4

data/lib/prop.rb

@@ -8,6 +8,14 @@ end
 
 class Prop
   class RateLimitExceededError < RuntimeError
+    attr_reader :root_message, :retry_after
+
+    def initialize(key, threshold, message)
+      @root_message = "#{key} threshold #{threshold} exceeded"
+      @retry_after  = Time.now.to_i % threshold.to_i
+
+      super(message || @root_message)
+    end
   end
 
   class << self
@@ -46,7 +54,7 @@ class Prop
       counter = count(options)
 
       if counter >= options[:threshold]
-        raise Prop::RateLimitExceededError.new("#{options[:key]} threshold #{options[:threshold]} exceeded")
+        raise Prop::RateLimitExceededError.new(options[:key], options[:threshold], options[:message])
       else
         writer.call(sanitized_prop_key(options), counter + 1)
       end
@@ -73,7 +81,10 @@ class Prop
     # Sanitizes the option set and sets defaults
     def sanitized_prop_options(args, defaults)
       options = args.last.is_a?(Hash) ? args.pop : {}
-      { :key => normalize_cache_key(args), :threshold => defaults[:threshold].to_i, :interval => defaults[:interval].to_i }.merge(options)
+      return {
+        :key => normalize_cache_key(args), :message => defaults[:message],
+        :threshold => defaults[:threshold].to_i, :interval => defaults[:interval].to_i
+      }.merge(options)
     end
 
     # Simple key expansion only supports arrays and primitives

data/prop.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{prop}
-  s.version = "0.3.3"
+  s.version = "0.3.4"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Morten Primdahl"]

data/test/test_prop.rb

@@ -126,6 +126,15 @@ class TestProp < Test::Unit::TestCase
         assert_raises(Prop::RateLimitExceededError) do
           Prop.throttle!(:key => 'hello', :threshold => 5, :interval => 10)
         end
+
+        begin
+          Prop.throttle!(:key => 'hello', :threshold => 5, :interval => 10, :message => "Wibble")
+          fail
+        rescue Prop::RateLimitExceededError => e
+          assert_equal "Wibble", e.message
+          assert_equal "hello threshold 5 exceeded", e.root_message
+          assert e.retry_after
+        end
       end
     end
 

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: prop
 version: !ruby/object:Gem::Version 
-  hash: 21
+  hash: 27
   prerelease: false
   segments: 
   - 0
   - 3
-  - 3
-  version: 0.3.3
+  - 4
+  version: 0.3.4
 platform: ruby
 authors: 
 - Morten Primdahl