rack-api 0.2.2 → 0.3.0

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rack-api (0.2.2)
+    rack-api (0.3.0)
       activesupport (>= 3.0.0)
       rack (>= 1.0.0)
       rack-mount (>= 0.6.0)

data/examples/helpers.rb

@@ -0,0 +1,25 @@
+$:.push(File.dirname(__FILE__) + "/../lib")
+
+# Just run `ruby examples/basic_auth.rb` and then use something like
+# `curl http://localhost:2345/api/v1/` or
+# `curl http://localhost:2345/api/v1/This%20is%20so%20cool`.
+
+require "rack/api"
+
+Rack::API.app do
+  prefix "api"
+
+  helper do
+    def default_message
+      "Hello from Rack API"
+    end
+  end
+
+  version :v1 do
+    get "/(:message)" do
+      {:message => params.fetch(:message, default_message)}
+    end
+  end
+end
+
+Rack::Handler::Thin.run Rack::API, :Port => 2345

data/examples/rescue_from.rb

@@ -0,0 +1,33 @@
+$:.push(File.dirname(__FILE__) + "/../lib")
+
+# Just run `ruby examples/simple.rb` and then use something like
+# `curl http://localhost:2345/api/v1/`.
+
+require "rack/api"
+require "logger"
+
+$logger = Logger.new(STDOUT)
+
+# Simulate ActiveRecord's exception.
+module ActiveRecord
+  class RecordNotFound < StandardError
+  end
+end
+
+Rack::API.app do
+  prefix "api"
+
+  rescue_from ActiveRecord::RecordNotFound, :status => 404
+  rescue_from Exception do |error|
+    $logger.error error.message
+    [500, {"Content-Type" => "text/plain"}, []]
+  end
+
+  version :v1 do
+    get "/" do
+      raise "Oh no! Something is really wrong!"
+    end
+  end
+end
+
+Rack::Handler::Thin.run Rack::API, :Port => 2345

data/lib/rack/api/app.rb

@@ -48,6 +48,11 @@ module Rack
       #
       attr_accessor :url_options
 
+      # Hold handlers, that will wrap exceptions
+      # into a normalized response.
+      #
+      attr_accessor :rescuers
+
       def initialize(options)
         options.each do |name, value|
           instance_variable_set("@#{name}", value)
@@ -158,6 +163,8 @@ module Rack
         end
 
         response.respond_to?(:to_rack) ? response.to_rack : response
+      rescue Exception => exception
+        handle_exception exception
       end
 
       # Return response content type based on extension.
@@ -229,6 +236,21 @@ module Rack
           throw :error, Response.new(:status => 406, :message => "Unknown format")
         end
       end
+
+      def handle_exception(error) # :nodoc:
+        rescuer = rescuers.find do |r|
+          error_class = eval("::#{r[:class_name]}") rescue nil
+          error_class && error.kind_of?(error_class)
+        end
+
+        raise error unless rescuer
+
+        if rescuer[:block]
+          instance_exec(error, &rescuer[:block])
+        else
+          [rescuer[:options].fetch(:status, 500), {"Content-Type" => "text/plain"}, []]
+        end
+      end
     end
   end
 end

data/lib/rack/api/runner.rb

@@ -4,7 +4,7 @@ module Rack
       HTTP_METHODS = %w[get post put delete head]
 
       DELEGATE_METHODS = %w[
-        version use prefix basic_auth
+        version use prefix basic_auth rescue_from
         helper respond_to default_url_options
       ]
 
@@ -14,11 +14,13 @@ module Rack
         @settings = {
           :middlewares => [],
           :helpers => [],
+          :rescuers => [],
           :global => {
-            :prefix      => "/",
-            :formats     => %w[json jsonp],
+            :prefix => "/",
+            :formats => %w[json jsonp],
             :middlewares => [],
-            :helpers     => []
+            :helpers => [],
+            :rescuers => []
           }
         }
       end
@@ -234,6 +236,19 @@ module Rack
         RUBY
       end
 
+      # Rescue from the specified exception.
+      #
+      #   rescue_from ActiveRecord::RecordNotFound, :status => 404
+      #   rescue_from Exception, :status => 500
+      #   rescue_from Exception do
+      #     $logger.error error.inspect
+      #     [500, {"Content-Type" => "text/plain"}, []]
+      #   end
+      #
+      def rescue_from(exception, options = {}, &block)
+        set :rescuers, {:class_name => exception.name, :options => options, :block => block}, :append
+      end
+
       private
       def mount_path(path) # :nodoc:
         Rack::Mount::Utils.normalize_path([option(:prefix), settings[:version], path].join("/"))
@@ -249,7 +264,8 @@ module Rack
           :default_format => default_format,
           :version        => option(:version),
           :prefix         => option(:prefix),
-          :url_options    => option(:url_options)
+          :url_options    => option(:url_options),
+          :rescuers       => option(:rescuers, :merge).reverse
         })
 
         builder = Rack::Builder.new

data/lib/rack/api/version.rb

@@ -2,8 +2,8 @@ module Rack
   class API
     module Version
       MAJOR = 0
-      MINOR = 2
-      PATCH = 2
+      MINOR = 3
+      PATCH = 0
       STRING = "#{MAJOR}.#{MINOR}.#{PATCH}"
     end
   end

data/spec/rack-api/method_delegation_spec.rb

@@ -9,4 +9,5 @@ describe Rack::API, "delegators" do
   it { should respond_to(:basic_auth) }
   it { should respond_to(:helper) }
   it { should respond_to(:default_url_options) }
+  it { should respond_to(:rescue_from) }
 end

data/spec/rack-api/rescue_from_spec.rb

@@ -0,0 +1,103 @@
+require "spec_helper"
+
+describe Rack::API, "Rescue from exceptions" do
+  class NotFound < StandardError; end
+
+  it "rescues from NotFound exception" do
+    Rack::API.app do
+      rescue_from NotFound, :status => 404
+
+      version :v1 do
+        get("/404") { raise NotFound }
+      end
+    end
+
+    get "/v1/404"
+    last_response.headers["Content-Type"].should == "text/plain"
+    last_response.body.should == ""
+    last_response.status.should == 404
+  end
+
+  it "rescues from all exceptions" do
+    Rack::API.app do
+      rescue_from Exception
+
+      version :v1 do
+        get("/500") { raise "Oops!" }
+      end
+    end
+
+    get "/v1/500"
+    last_response.headers["Content-Type"].should == "text/plain"
+    last_response.body.should == ""
+    last_response.status.should == 500
+  end
+
+  it "rescues from exception by using a block" do
+    Rack::API.app do
+      rescue_from Exception do
+        [501, {"Content-Type" => "application/json"}, [{:error => true}.to_json]]
+      end
+
+      version :v1 do
+        get("/501") { raise "Oops!" }
+      end
+    end
+
+    get "/v1/501"
+    last_response.headers["Content-Type"].should == "application/json"
+    last_response.body.should == {:error => true}.to_json
+    last_response.status.should == 501
+  end
+
+  it "rescues from exception by using inner handler" do
+    Rack::API.app do
+      rescue_from Exception
+
+      version :v1 do
+        rescue_from Exception do
+          [500, {"Content-Type" => "text/plain"}, ["inner handler"]]
+        end
+
+        get("/500") { raise "Oops!" }
+      end
+    end
+
+    get "/v1/500"
+    last_response.body.should == "inner handler"
+  end
+
+  it "rescues from exception in app's context" do
+    Rack::API.app do
+      rescue_from Exception
+
+      version :v1 do
+        rescue_from Exception do
+          [500, {"Content-Type" => "text/plain"}, [self.class.name]]
+        end
+
+        get("/500") { raise "Oops!" }
+      end
+    end
+
+    get "/v1/500"
+    last_response.body.should == "Rack::API::App"
+  end
+
+  it "yields the exception object" do
+    Rack::API.app do
+      rescue_from Exception
+
+      version :v1 do
+        rescue_from Exception do |error|
+          [500, {"Content-Type" => "text/plain"}, [error.message]]
+        end
+
+        get("/500") { raise "Oops!" }
+      end
+    end
+
+    get "/v1/500"
+    last_response.body.should == "Oops!"
+  end
+end

data/spec/rack-api/runner_spec.rb

@@ -3,7 +3,7 @@ require "spec_helper"
 describe Rack::API::Runner do
   specify "sanity check for delegate methods" do
     # remember to update spec/method_delegation_spec.rb
-    Rack::API::Runner::DELEGATE_METHODS.size.should == 7
+    Rack::API::Runner::DELEGATE_METHODS.size.should == 8
   end
 
   it "responds to http methods" do

metadata

@@ -2,7 +2,7 @@
 name: rack-api
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.2.2
+  version: 0.3.0
 platform: ruby
 authors: 
 - Nando Vieira
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-06-08 00:00:00 Z
+date: 2011-06-09 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: rack
@@ -110,9 +110,11 @@ files:
 - examples/custom_format.rb
 - examples/custom_headers.rb
 - examples/formats.rb
+- examples/helpers.rb
 - examples/middleware.rb
 - examples/multiple_versions.rb
 - examples/params.rb
+- examples/rescue_from.rb
 - examples/simple.rb
 - lib/rack/api.rb
 - lib/rack/api/app.rb
@@ -138,6 +140,7 @@ files:
 - spec/rack-api/middlewares_spec.rb
 - spec/rack-api/params_spec.rb
 - spec/rack-api/paths_spec.rb
+- spec/rack-api/rescue_from_spec.rb
 - spec/rack-api/runner_spec.rb
 - spec/rack-api/settings_spec.rb
 - spec/rack-api/short_circuit_spec.rb
@@ -188,6 +191,7 @@ test_files:
 - spec/rack-api/middlewares_spec.rb
 - spec/rack-api/params_spec.rb
 - spec/rack-api/paths_spec.rb
+- spec/rack-api/rescue_from_spec.rb
 - spec/rack-api/runner_spec.rb
 - spec/rack-api/settings_spec.rb
 - spec/rack-api/short_circuit_spec.rb