prop 0.7.0 → 0.7.1

data/README.md

@@ -60,10 +60,31 @@ If the throttle! method gets called more than "threshold" times within "interval
       if e.handle == :authorization_attempt
         render :status => :forbidden, :message => I18n.t(e.description)
       elsif ...
-    
+
       end
     end
 
+### Using the Middleware
+
+Prop ships with a built in Rack middleware that you can use to do all the exception handling. When a `Prop::RateLimited` error is caught, it will build an HTTP [429 Too Many Requests](http://tools.ietf.org/html/draft-nottingham-http-new-status-02#section-4) response and set the following headers:
+
+    Retry-After: 32
+    Content-Type: text/plain
+    Content-Length: 72
+
+Where `Retry-After` is the number of seconds the client has to wait before retrying this end point. The body of this response is whatever description Prop has configured for the throttle that got violated, or a default string if there's none configured.
+
+If you wish to do manual error messaging in these cases, you can define an error handler in your Prop configuration. Here's how the default error handler looks, feel free to replace it with your own - you can set the error handler to anything that responds to `.call` and takes a `RateLimited` instance as argument:
+
+    error_handler = Proc.new do |error|
+      body    = error.description || "This action has been rate limited"
+      headers = { "Content-Type" => "text/plain", "Content-Length" => body.size, "Retry-After" => error.retry_after }
+
+      [ 429, headers, [ body ]]
+    end
+
+    ActionController::Dispatcher.middleware.insert_before(ActionController::ParamsParser, :error_handler => error_handler)
+
 ## Disabling Prop
 
 In case you need to perform e.g. a manual bulk operation:

data/lib/prop.rb

@@ -2,7 +2,7 @@ require "prop/limiter"
 require "forwardable"
 
 module Prop
-  VERSION = "0.7.0"
+  VERSION = "0.7.1"
 
   # Short hand for accessing Prop::Limiter methods
   class << self

data/lib/prop/middleware.rb

@@ -1,23 +1,32 @@
 module Prop
+
   # Convenience middleware that conveys the message configured on a Prop handle as well
   # as time left before the current window has passed in a Retry-After header.
   class Middleware
 
-    def initialize(app)
-      @app = app
+    # Default error handler
+    class DefaultErrorHandler
+      def self.call(error)
+        body    = error.description || "This action has been rate limited"
+        headers = { "Content-Type" => "text/plain", "Content-Length" => body.size, "Retry-After" => error.retry_after }
+
+        [ 429, headers, [ body ]]
+      end
+    end
+
+    def initialize(app, options = {})
+      @app     = app
+      @options = options
+      @handler = options[:error_handler] || DefaultErrorHandler
     end
 
-    def call(env, options = {})
+    def call(env)
       begin
         @app.call(env)
       rescue Prop::RateLimited => e
-        body    = e.description || "This action has been rate limited"
-
-        headers = { "Content-Type" => "text/plain", "Content-Length" => body.size }
-        headers["Retry-After"] = e.retry_after if e.retry_after > 0
-
-        [ 429, headers, [ body ]]
+        @handler.call(e)
       end
     end
   end
+
 end

data/prop.gemspec

@@ -13,7 +13,7 @@ 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.7.0'
+  s.version           = '0.7.1'
   s.date              = '2012-04-06'
   s.rubyforge_project = 'prop'
 

data/test/test_middleware.rb

@@ -32,6 +32,16 @@ class TestMiddleware < Test::Unit::TestCase
         assert_equal 429, response[0]
         assert_equal ["Boom!"], response[2]
       end
+
+      context "with a custom error handler" do
+        setup do
+          @middleware = Prop::Middleware.new(@app, :error_handler => Proc.new { |error| "Oops" })
+        end
+
+        should "allow setting a custom error handler" do
+          assert_equal "Oops", @middleware.call(@env)
+        end
+      end
     end
   end
 end

data/test/test_options.rb

@@ -35,7 +35,11 @@ class TestOptions < Test::Unit::TestCase
 
         should "raise when not given a key" do
           @args.delete(:key)
-          assert_raises(IndexError) { Prop::Options.build(@args) }
+          begin
+            Prop::Options.build(@args)
+            fail "Should puke when not given a valid key"
+          rescue
+          end
         end
       end
     end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: prop
 version: !ruby/object:Gem::Version 
-  hash: 3
+  hash: 1
   prerelease: 
   segments: 
   - 0
   - 7
-  - 0
-  version: 0.7.0
+  - 1
+  version: 0.7.1
 platform: ruby
 authors: 
 - Morten Primdahl