Merge branch 'exceptions-and-format'

Author: dblock

README.markdown

@@ -66,25 +66,14 @@ Serialization takes place automatically. For more detailed usage information, pl
 
 The default behavior of Grape is to rescue all exceptions and to return a 403 status code with the exception's message in the response body. 
 
-It's possible to disable this behavior and pass exceptions further up the stack. This usually means displaying the web server's error page as a result.
+It's possible to trap all exceptions by setting `rescue_all_errors true`. This prevents displaying the web server's error page as a result. You may also change the error format to JSON by using `error_format :json` and set the default error status to 200 with `default_error_status 200`.
 
     class Twitter::API < Grape::API
-      use Grape::Middleware::Error, :rescue => false
-      ...
-    end
-
-It's also common to change the error format to JSON. 
+      rescue_all_errors false
+      error_format :json
+      default_error_status 200
 
-    class Twitter::API < Grape::API
-      use Grape::Middleware::Error, :format => :json
-      ...
-    end
-
-Finally, you can specify your own error formatter. The following example returns a custom error message in the JSON format.
-
-    class Twitter::API < Grape::API
-      use Grape::Middleware::Error, :format => :custom, :formatters = { lambda { |message| { :custom => "the error message was: #{message}" } }
-      ...
+      # api methods
     end
 
 ## Note on Patches/Pull Requests

lib/grape/api.rb

@@ -50,7 +50,7 @@ def set(key, value)
       def prefix(prefix = nil)
         prefix ? set(:root_prefix, prefix) : settings[:root_prefix]
       end
-      
+
       # Specify an API version.
       #
       # @example API with legacy support.
@@ -79,6 +79,22 @@ def default_format(new_format = nil)
         new_format ? set(:default_format, new_format.to_sym) : settings[:default_format]
       end
 
+      # Specify the format for error messages.
+      # May be `:json` or `:txt` (default).
+      def error_format(new_format = nil)
+        new_format ? set(:error_format, new_format.to_sym) : settings[:error_format]
+      end
+
+      # Specify the default status code for errors.
+      def default_error_status(new_status = nil)
+        new_status ? set(:default_error_status, new_status) : settings[:default_error_status]
+      end
+
+      # Specify whether to rescue all errors.
+      def rescue_all_errors(new_value = true)
+        set(:rescue_all_errors, new_value)
+      end
+
       # Add helper methods that will be accessible from any
       # endpoint within this namespace (and child namespaces).
       #
@@ -217,7 +233,7 @@ def nest(*blocks, &block)
 
       def build_endpoint(&block)
         b = Rack::Builder.new
-        b.use Grape::Middleware::Error
+        b.use Grape::Middleware::Error, :default_status => settings[:default_error_status] || 403, :rescue => settings[:rescue_all_errors], :format => settings[:error_format] || :txt
         b.use Rack::Auth::Basic, settings[:auth][:realm], &settings[:auth][:proc] if settings[:auth] && settings[:auth][:type] == :http_basic
         b.use Grape::Middleware::Prefixer, :prefix => prefix if prefix        
         b.use Grape::Middleware::Versioner, :versions => (version if version.is_a?(Array)) if version

spec/grape/api_spec.rb

@@ -20,7 +20,7 @@ def app; subject end
       last_response.status.should eql 404
     end
   end
-  
+
   describe '.version' do
     it 'should set the API version' do
       subject.version 'v1'
@@ -471,4 +471,79 @@ def two
       last_response.status.should eql 200
     end
   end
+  
+  describe ".rescue_all_errors" do
+    it 'should not rescue all errors when rescue_all_errors is false' do
+      subject.rescue_all_errors false
+      subject.get '/exception' do
+        raise "rain!"
+      end    
+      lambda { get '/exception' }.should raise_error
+    end
+    it 'should rescue all errors' do
+      subject.rescue_all_errors true
+      subject.get '/exception' do
+        raise "rain!"
+      end
+      get '/exception'
+      last_response.status.should eql 403
+    end
+  end
+  
+  describe ".error_format" do
+    it 'should return :txt' do
+      subject.rescue_all_errors true
+      subject.error_format :txt
+      subject.get '/exception' do
+        raise "rain!"
+      end    
+      get '/exception'
+      last_response.body.should eql "rain!"
+    end
+    it 'should rescue all errors' do
+      subject.rescue_all_errors true
+      subject.error_format :json
+      subject.get '/exception' do
+        raise "rain!"
+      end    
+      get '/exception'
+      last_response.body.should eql '{:error=>"rain!"}'
+    end
+    it 'should rescue all errors' do
+      subject.error_format :txt
+      subject.get '/error' do
+        error!("Access Denied", 401)
+      end    
+      get '/error'
+      last_response.body.should eql "Access Denied"
+    end
+    it 'should rescue all errors' do
+      subject.error_format :json
+      subject.get '/error' do
+        error!("Access Denied", 401)
+      end    
+      get '/error'
+      last_response.body.should eql '{:error=>"Access Denied"}'
+    end
+  end
+  
+  describe ".default_error_status" do
+    it 'should allow setting default_error_status' do
+      subject.rescue_all_errors true
+      subject.default_error_status 200
+      subject.get '/exception' do
+        raise "rain!"
+      end    
+      get '/exception'
+      last_response.status.should eql 200
+    end
+    it 'should have a default error status' do
+      subject.rescue_all_errors true
+      subject.get '/exception' do
+        raise "rain!"
+      end    
+      get '/exception'
+      last_response.status.should eql 403
+    end
+  end
 end