grape 0.1.4 → 0.1.5

data/.gitignore

@@ -19,5 +19,6 @@ coverage
 pkg
 .rvmrc
 .bundle
+dist
 
 ## PROJECT::SPECIFIC

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    grape (0.1.4)
+    grape (0.1.5)
       multi_json
       multi_xml
       rack
@@ -11,41 +11,42 @@ PATH
 GEM
   remote: http://rubygems.org/
   specs:
+    ZenTest (4.5.0)
     diff-lcs (1.1.2)
-    json_pure (1.4.3)
+    json_pure (1.5.2)
     maruku (0.6.0)
       syntax (>= 1.0.0)
-    mg (0.0.8)
-      rake
-    multi_json (0.0.5)
+    multi_json (1.0.3)
     multi_xml (0.2.2)
-    rack (1.2.1)
-    rack-jsonp (1.1.0)
+    rack (1.3.0)
+    rack-jsonp (1.2.0)
       rack
-    rack-mount (0.7.1)
+    rack-mount (0.8.1)
       rack (>= 1.0.0)
-    rack-test (0.5.4)
+    rack-test (0.6.0)
       rack (>= 1.0)
-    rake (0.8.7)
-    rspec (2.5.0)
-      rspec-core (~> 2.5.0)
-      rspec-expectations (~> 2.5.0)
-      rspec-mocks (~> 2.5.0)
-    rspec-core (2.5.1)
-    rspec-expectations (2.5.0)
+    rake (0.9.2)
+    rspec (2.6.0)
+      rspec-core (~> 2.6.0)
+      rspec-expectations (~> 2.6.0)
+      rspec-mocks (~> 2.6.0)
+    rspec-core (2.6.4)
+    rspec-expectations (2.6.0)
       diff-lcs (~> 1.1.2)
-    rspec-mocks (2.5.0)
+    rspec-mocks (2.6.0)
     syntax (1.0.0)
-    yard (0.6.1)
+    yard (0.7.1)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
+  ZenTest
+  bundler
   grape!
   json_pure
   maruku
-  mg
   rack-test
-  rspec (~> 2.5.0)
+  rake
+  rspec (~> 2.6.0)
   yard

data/README.markdown

@@ -1,4 +1,5 @@
 # Grape
+[![Build Status](http://travis-ci.org/intridea/grape.png)](http://travis-ci.org/intridea/grape)
 
 Grape is a REST-like API micro-framework for Ruby. It is built to complement existing web application frameworks such as Rails and Sinatra by providing a simple DSL to easily provide APIs. It has built-in support for common conventions such as multiple formats, subdomain/prefix restriction, and versioning.
 
@@ -62,6 +63,26 @@ And would respond to the following routes:
     
 Serialization takes place automatically. For more detailed usage information, please visit the [Grape Wiki](http://github.com/intridea/grape/wiki).
     
+## Raising Errors
+
+You can raise errors explicitly.
+
+    error!("Access Denied", 401)
+
+You can also return JSON formatted objects explicitly by raising error! and passing a hash instead of a message.
+
+    error!({ "error" => "unexpected error", "detail" => "missing widget" }, 500)
+
+## Exception Handling
+
+Grape can be told to rescue certain (or all) exceptions in your
+application and instead display them in text or json form. To do this,
+you simply use the `rescue_from` method inside your API declaration:
+
+    class Twitter::API < Grape::API
+      rescue_from ArgumentError, NotImplementedError # :all for all errors
+    end
+
 ## Note on Patches/Pull Requests
  
 * Fork the project.

data/Rakefile

@@ -2,8 +2,7 @@ require 'rubygems'
 require 'bundler'
 Bundler.setup :default, :test, :development
 
-require 'mg'
-MG.new('grape.gemspec')
+Bundler::GemHelper.install_tasks
 
 require 'rspec/core/rake_task'
 RSpec::Core::RakeTask.new(:spec) do |spec|

data/grape.gemspec

@@ -19,12 +19,14 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency 'multi_json'
   s.add_runtime_dependency 'multi_xml'
 
-  s.add_development_dependency 'mg'
+  s.add_development_dependency 'rake'
   s.add_development_dependency 'maruku'
   s.add_development_dependency 'yard'
   s.add_development_dependency 'rack-test'
-  s.add_development_dependency 'rspec', '~> 2.5.0'
+  s.add_development_dependency 'rspec', '~> 2.6.0'
   s.add_development_dependency 'json_pure'
+  s.add_development_dependency 'ZenTest'
+  s.add_development_dependency 'bundler'
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")

data/lib/grape.rb

@@ -17,6 +17,7 @@ module Grape
     module Auth
       autoload :OAuth2, 'grape/middleware/auth/oauth2'
       autoload :Basic,  'grape/middleware/auth/basic'
+      autoload :Digest,	'grape/middleware/auth/digest'
     end
   end
 end

data/lib/grape/api.rb

@@ -1,5 +1,6 @@
 require 'rack/mount'
 require 'rack/auth/basic'
+require 'rack/auth/digest/md5'
 require 'logger'
 
 module Grape
@@ -50,7 +51,7 @@ module Grape
       def prefix(prefix = nil)
         prefix ? set(:root_prefix, prefix) : settings[:root_prefix]
       end
-      
+
       # Specify an API version.
       #
       # @example API with legacy support.
@@ -79,6 +80,39 @@ module Grape
         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
+
+      # Allows you to rescue certain exceptions that occur to return
+      # a grape error rather than raising all the way to the
+      # server level.
+      #
+      # @example Rescue from custom exceptions
+      #     class ExampleAPI < Grape::API
+      #       class CustomError < StandardError; end
+      #
+      #       rescue_from CustomError
+      #     end
+      #
+      # @overload rescue_from(*exception_classes, options = {})
+      #   @param [Array] exception_classes A list of classes that you want to rescue, or
+      #     the symbol :all to rescue from all exceptions.
+      #   @param [Hash] options Options for the rescue usage.
+      #   @option options [Boolean] :backtrace Include a backtrace in the rescue response.
+      def rescue_from(*args)
+        set(:rescue_options, args.pop) if args.last.is_a?(Hash)
+        set(:rescue_all, true) and return if args.include?(:all)
+        set(:rescued_errors, args)
+      end
+
       # Add helper methods that will be accessible from any
       # endpoint within this namespace (and child namespaces).
       #
@@ -105,7 +139,7 @@ module Grape
       end
       
       # Add an authentication type to the API. Currently
-      # only `:http_basic` is supported.
+      # only `:http_basic`, `:http_digest` and `:oauth2` are supported.
       def auth(type = nil, options = {}, &block)
         if type
           set(:auth, {:type => type.to_sym, :proc => block}.merge(options))
@@ -122,6 +156,12 @@ module Grape
         options[:realm] ||= "API Authorization"
         auth :http_basic, options, &block
       end
+
+      def http_digest(options = {}, &block)
+        options[:realm] ||= "API Authorization"
+	options[:opaque] ||= "secret"
+        auth :http_digest, options, &block
+      end
       
       # Defines a route that will be recognized
       # by the Grape API.
@@ -217,8 +257,14 @@ module Grape
       
       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_all => settings[:rescue_all], 
+          :rescued_errors => settings[:rescued_errors], 
+          :format => settings[:error_format] || :txt, 
+          :rescue_options => settings[:rescue_options]
         b.use Rack::Auth::Basic, settings[:auth][:realm], &settings[:auth][:proc] if settings[:auth] && settings[:auth][:type] == :http_basic
+	b.use Rack::Auth::Digest::MD5, settings[:auth][:realm], settings[:auth][:opaque], &settings[:auth][:proc] if settings[:auth] && settings[:auth][:type] == :http_digest
         b.use Grape::Middleware::Prefixer, :prefix => prefix if prefix        
         b.use Grape::Middleware::Versioner, :versions => (version if version.is_a?(Array)) if version
         b.use Grape::Middleware::Formatter, :default_format => default_format || :json

data/lib/grape/middleware/auth/digest.rb

@@ -0,0 +1,30 @@
+require 'rack/auth/digest/md5'
+
+module Grape
+  module Middleware
+    module Auth
+      class Digest < Grape::Middleware::Base
+        attr_reader :authenticator
+        
+        def initialize(app, options = {}, &authenticator)
+          super(app, options)
+          @authenticator = authenticator
+        end
+        
+        def digest_request
+          Rack::Auth::Digest::Request.new(env)
+        end
+        
+        def credentials
+          digest_request.provided?? digest_request.credentials : [nil, nil]
+        end
+        
+        def before
+          unless authenticator.call(*credentials)
+            throw :error, :status => 401, :message => "API Authorization Failed."
+          end
+        end
+      end
+    end
+  end
+end

data/lib/grape/middleware/auth/oauth2.rb

@@ -1,18 +1,42 @@
 module Grape::Middleware::Auth
+  # OAuth 2.0 authorization for Grape APIs.
   class OAuth2 < Grape::Middleware::Base
     def default_options
       {
         :token_class => 'AccessToken',
-        :realm => 'OAuth API'
+        :realm => 'OAuth API',
+        :parameter => %w(bearer_token oauth_token),
+        :accepted_headers => %w(HTTP_AUTHORIZATION X_HTTP_AUTHORIZATION X-HTTP_AUTHORIZATION REDIRECT_X_HTTP_AUTHORIZATION),
+        :header => [/Bearer (.*)/i, /OAuth (.*)/i]
       }
     end
     
     def before
-      if request['oauth_token']
-        verify_token(request['oauth_token'])
-      elsif env['Authorization'] && t = parse_authorization_header
-        verify_token(t)
+      verify_token(token_parameter || token_header)
+    end
+
+    def token_parameter
+      Array(options[:parameter]).each do |p|
+        return request[p] if request[p]
+      end
+      nil
+    end
+
+    def token_header
+      return false unless authorization_header
+      Array(options[:header]).each do |regexp|
+        if authorization_header =~ regexp
+          return $1
+        end
+      end
+      nil
+    end
+
+    def authorization_header
+      options[:accepted_headers].each do |head|
+        return env[head] if env[head]
       end
+      nil
     end
     
     def token_class
@@ -21,10 +45,10 @@ module Grape::Middleware::Auth
     
     def verify_token(token)
       if token = token_class.verify(token)
-        if token.expired?
+        if token.respond_to?(:expired?) && token.expired?
           error_out(401, 'expired_token')
         else
-          if token.permission_for?(env)
+          if !token.respond_to?(:permission_for?) || token.permission_for?(env)
             env['api.token'] = token
           else
             error_out(403, 'insufficient_scope')
@@ -35,15 +59,9 @@ module Grape::Middleware::Auth
       end
     end
     
-    def parse_authorization_header
-      if env['Authorization'] =~ /oauth (.*)/i
-        $1
-      end
-    end
-    
     def error_out(status, error)
       throw :error, {
-        :message => 'The token provided has expired.',
+        :message => error,
         :status => status,
         :headers => {
           'WWW-Authenticate' => "OAuth realm='#{options[:realm]}', error='#{error}'"
@@ -52,4 +70,4 @@ module Grape::Middleware::Auth
     end
   end
 end
-    
+    

data/lib/grape/middleware/base.rb

@@ -2,7 +2,7 @@ module Grape
   module Middleware
     class Base
       attr_reader :app, :env, :options
-      
+
       # @param [Rack Application] app The standard argument for a Rack middleware.
       # @param [Hash] options A hash of options, simply stored for use by subclasses.
       def initialize(app, options = {})
@@ -38,6 +38,52 @@ module Grape
       def response
         Rack::Response.new(@app_response)
       end
+
+
+      module Formats
+
+        CONTENT_TYPES = {
+          :xml => 'application/xml',
+          :json => 'application/json',
+          :atom => 'application/atom+xml',
+          :rss => 'application/rss+xml',
+          :txt => 'text/plain'
+        }
+        FORMATTERS = {
+          :json => :encode_json,
+          :txt => :encode_txt,
+        }
+
+        def formatters
+          FORMATTERS.merge(options[:formatters] || {})
+        end
+
+        def content_types
+          CONTENT_TYPES.merge(options[:content_types] || {})
+        end
+
+        def content_type
+          content_types[options[:format]] || 'text/html'
+        end
+
+        def mime_types
+          content_types.invert
+        end
+
+        def formatter_for(api_format)
+          spec = formatters[api_format]
+          case spec
+          when nil
+            lambda { |obj| obj }
+          when Symbol
+            method(spec)
+          else
+            spec
+          end
+        end
+
+      end
+
     end
   end
-end
+end

data/lib/grape/middleware/error.rb

@@ -1,21 +1,70 @@
 require 'grape/middleware/base'
+require 'multi_json'
 
 module Grape
   module Middleware
     class Error < Base
+      include Formats
+
+      def default_options
+      { 
+        :default_status => 403, # default status returned on error
+        :default_message => "",
+        :format => :txt,
+        :formatters => {},
+
+        :rescue_all => false, # true to rescue all exceptions        
+        :rescue_options => {:backtrace => false}, # true to display backtrace
+        :rescued_errors => []
+      }
+      end
+
+      def encode_json(message, backtrace)
+        result = message.is_a?(Hash) ? message : { :error => message }
+        if (options[:rescue_options] || {})[:backtrace] && backtrace && ! backtrace.empty?
+          result = result.merge({ :backtrace => backtrace })
+        end
+        MultiJson.encode(result)
+      end
+      
+      def encode_txt(message, backtrace)
+        result = message.is_a?(Hash) ? MultiJson.encode(message) : message
+        if (options[:rescue_options] || {})[:backtrace] && backtrace && ! backtrace.empty?
+          result += "\r\n "
+          result += backtrace.join("\r\n ")
+        end
+        result
+      end
+
       def call!(env)
         @env = env
-        result = catch :error do
-          @app.call(@env)
+        
+        begin
+          error_response(catch(:error){ 
+            return @app.call(@env) 
+          })
+        rescue Exception => e
+          raise unless options[:rescue_all] || (options[:rescued_errors] || []).include?(e.class)
+          error_response({ :message => e.message, :backtrace => e.backtrace })
         end
         
-        result ||= {}
-        result.is_a?(Hash) ? error_response(result) : result
       end
       
       def error_response(error = {})
-        Rack::Response.new([(error[:message] || options[:default_message])], error[:status] || 403, error[:headers] || {}).finish
+        status = error[:status] || options[:default_status]
+        message = error[:message] || options[:default_message]
+        headers = {'Content-Type' => content_type}
+        headers.merge!(error[:headers]) if error[:headers].is_a?(Hash)
+        backtrace = error[:backtrace] || []
+        Rack::Response.new([format_message(message, backtrace, status)], status, headers).finish
       end
+      
+      def format_message(message, backtrace, status)
+        formatter = formatter_for(options[:format])
+        throw :error, :status => 406, :message => "The requested format #{options[:format]} is not supported." unless formatter        
+        formatter.call(message, backtrace)
+      end
+      
     end
   end
 end

data/lib/grape/middleware/formatter.rb

@@ -4,18 +4,8 @@ require 'multi_json'
 module Grape
   module Middleware
     class Formatter < Base
-      CONTENT_TYPES = {
-        :xml => 'application/xml',
-        :json => 'application/json',
-        :atom => 'application/atom+xml',
-        :rss => 'application/rss+xml',
-        :txt => 'text/plain'
-      }
-      FORMATTERS = {
-        :json => :encode_json,
-        :txt => :encode_txt,
-      }
-      
+      include Formats
+
       def default_options
         { 
           :default_format => :txt,
@@ -24,18 +14,6 @@ module Grape
         }
       end
       
-      def content_types
-        CONTENT_TYPES.merge(options[:content_types])
-      end
-
-      def formatters
-        FORMATTERS.merge(options[:formatters])
-      end
-      
-      def mime_types
-        content_types.invert
-      end
-      
       def headers
         env.dup.inject({}){|h,(k,v)| h[k.downcase] = v; h}
       end
@@ -92,18 +70,6 @@ module Grape
         Rack::Response.new(bodymap, status, headers).to_a
       end
 
-      def formatter_for(api_format)
-        spec = formatters[api_format]
-        case spec
-        when nil
-          lambda { |obj| obj }
-        when Symbol
-          method(spec)
-        else
-          spec
-        end
-      end
-      
       def encode_json(object)
         if object.respond_to? :serializable_hash
           MultiJson.encode(object.serializable_hash)

data/lib/grape/version.rb

@@ -1,3 +1,3 @@
 module Grape
-  VERSION = '0.1.4'
+  VERSION = '0.1.5'
 end

data/spec/grape/api_spec.rb

@@ -20,7 +20,7 @@ describe Grape::API do
       last_response.status.should eql 404
     end
   end
-  
+
   describe '.version' do
     it 'should set the API version' do
       subject.version 'v1'
@@ -276,6 +276,35 @@ describe Grape::API do
       last_response.body.should eql 'Created'
     end
   end
+
+  context 'format' do
+    before do
+      subject.get("/foo") { "bar" }
+    end
+
+    it 'should set content type for txt format' do
+      get '/foo'
+      last_response.headers['Content-Type'].should eql 'text/plain'
+    end
+
+    it 'should set content type for json' do
+      get '/foo.json'
+      last_response.headers['Content-Type'].should eql 'application/json'
+    end
+
+    it 'should set content type for error' do
+      subject.get('/error') { error!('error in plain text', 500) }
+      get '/error'
+      last_response.headers['Content-Type'].should eql 'text/plain'
+    end
+
+    it 'should set content type for error' do
+      subject.error_format :json
+      subject.get('/error') { error!('error in json', 500) }
+      get '/error.json'
+      last_response.headers['Content-Type'].should eql 'application/json'
+    end
+  end
   
   context 'custom middleware' do
     class PhonyMiddleware
@@ -471,4 +500,112 @@ describe Grape::API do
       last_response.status.should eql 200
     end
   end
+  
+  describe ".rescue_from" do
+    it 'should not rescue errors when rescue_from is not set' do
+      subject.get '/exception' do
+        raise "rain!"
+      end    
+      lambda { get '/exception' }.should raise_error
+    end
+
+    it 'should rescue all errors if rescue_from :all is called' do
+      subject.rescue_from :all
+      subject.get '/exception' do
+        raise "rain!"
+      end
+      get '/exception'
+      last_response.status.should eql 403
+    end
+
+    it 'should rescue only certain errors if rescue_from is called with specific errors' do
+      subject.rescue_from ArgumentError
+      subject.get('/rescued'){ raise ArgumentError }
+      subject.get('/unrescued'){ raise "beefcake" }
+
+      get '/rescued'
+      last_response.status.should eql 403
+      
+      lambda{ get '/unrescued' }.should raise_error
+    end
+  end
+  
+  describe ".error_format" do
+    it 'should rescue all errors and return :txt' do
+      subject.rescue_from :all
+      subject.error_format :txt
+      subject.get '/exception' do
+        raise "rain!"
+      end    
+      get '/exception'
+      last_response.body.should eql "rain!"
+    end
+
+    it 'should rescue all errros and return :txt with backtrace' do
+      subject.rescue_from :all, :backtrace => true
+      subject.error_format :txt
+      subject.get '/exception' do
+        raise "rain!"
+      end    
+      get '/exception'
+      last_response.body.start_with?("rain!\r\n").should be_true
+    end
+
+    it 'should rescue all errors and return :json' do
+      subject.rescue_from :all
+      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 and return :json with backtrace' do
+      subject.rescue_from :all, :backtrace => true
+      subject.error_format :json
+      subject.get '/exception' do
+        raise "rain!"
+      end    
+      get '/exception'
+      json = JSON.parse(last_response.body)
+      json["error"].should eql 'rain!'
+      json["backtrace"].length.should > 0
+    end
+    it 'should rescue error! and return txt' 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 error! and return json' 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_from :all
+      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_from :all
+      subject.get '/exception' do
+        raise "rain!"
+      end    
+      get '/exception'
+      last_response.status.should eql 403
+    end
+  end
 end

data/spec/grape/endpoint_spec.rb

@@ -73,8 +73,6 @@ describe Grape::Endpoint do
     end
 
     it 'should accept an object and render it in format' do
-      pending
-
       subject.get '/hey' do
         error!({'dude' => 'rad'}, 403)
       end

data/spec/grape/middleware/auth/digest_spec.rb

@@ -0,0 +1,49 @@
+require 'spec_helper'
+
+RSpec::Matchers.define :be_challenge do
+  match do |actual_response|
+    actual_response.status == 401 &&
+    actual_response['WWW-Authenticate'] =~ /^Digest / &&
+    actual_response.body.empty?
+  end
+end
+
+class Test < Grape::API
+  version '1'
+  
+  http_digest({:realm => 'Test Api', :opaque => 'secret'}) do |username|
+    {'foo' => 'bar'}[username]
+  end
+
+  get '/test' do
+    [{:hey => 'you'},{:there => 'bar'},{:foo => 'baz'}]
+  end
+end
+
+describe Grape::Middleware::Auth::Digest do
+  def app
+    Test
+  end
+  
+  it 'should be a digest authentication challenge' do
+    get '/1/test'
+    last_response.should be_challenge
+  end
+  
+  it 'should throw a 401 if no auth is given' do
+    get '/1/test'
+    last_response.status.should == 401
+  end
+
+  it 'should authenticate if given valid creds' do
+    digest_authorize "foo", "bar"
+    get '/1/test'
+    last_response.status.should == 200
+  end
+
+  it 'should throw a 401 if given invalid creds' do
+    digest_authorize "bar", "foo"
+    get '/1/test'
+    last_response.status.should == 401
+  end
+end

data/spec/grape/middleware/auth/oauth2_spec.rb

@@ -65,9 +65,11 @@ describe Grape::Middleware::Auth::OAuth2 do
     it { @err[:headers]['WWW-Authenticate'].should == "OAuth realm='OAuth API', error='expired_token'" }
   end
   
-  context 'with the token in the header' do
-    before { get '/awesome', {}, 'Authorization' => 'OAuth g123' }
-    it { last_response.body.should == 'g123' }
+  %w(HTTP_AUTHORIZATION X_HTTP_AUTHORIZATION X-HTTP_AUTHORIZATION REDIRECT_X_HTTP_AUTHORIZATION).each do |head|  
+    context "with the token in the #{head} header" do
+      before { get '/awesome', {}, head => 'OAuth g123' }
+      it { last_response.body.should == 'g123' }
+    end
   end
   
   context 'with the token in the POST body' do
@@ -85,4 +87,4 @@ describe Grape::Middleware::Auth::OAuth2 do
     it { @err[:headers]['WWW-Authenticate'].should == "OAuth realm='OAuth API', error='insufficient_scope'" }
     it { @err[:status].should == 403 }
   end
-end
+end

data/spec/grape/middleware/error_spec.rb

@@ -46,4 +46,4 @@ describe Grape::Middleware::Error do
   context 'with formatting' do
     
   end
-end
+end

data/spec/grape/middleware/exception_spec.rb

@@ -0,0 +1,120 @@
+require 'spec_helper'
+
+describe Grape::Middleware::Error do
+  
+  # raises a text exception
+  class ExceptionApp
+    class << self
+      def call(env)
+        raise "rain!"
+      end
+    end
+  end
+  
+  # raises a hash error
+  class ErrorHashApp
+    class << self
+      def error!(message, status=403)
+        throw :error, :message => { :error => message, :detail => "missing widget" }, :status => status
+      end
+      def call(env)
+        error!("rain!", 401)
+      end
+    end
+  end
+  
+  # raises an error!
+  class AccessDeniedApp    
+    class << self
+      def error!(message, status=403)
+        throw :error, :message => message, :status => status
+      end
+      def call(env)
+        error!("Access Denied", 401)
+      end
+    end
+  end
+  
+  def app
+    @app
+  end
+ 
+  it 'should not trap errors by default' do
+    @app ||= Rack::Builder.app do
+      use Grape::Middleware::Error
+      run ExceptionApp
+    end
+    lambda { get '/' }.should raise_error
+  end
+
+  context 'with rescue_all set to true' do
+    it 'should set the message appropriately' do
+      @app ||= Rack::Builder.app do
+        use Grape::Middleware::Error, :rescue_all => true
+        run ExceptionApp
+      end
+      get '/'
+      last_response.body.should == "rain!"
+    end
+
+    it 'should default to a 403 status' do
+      @app ||= Rack::Builder.app do
+        use Grape::Middleware::Error, :rescue_all => true
+        run ExceptionApp
+      end
+      get '/'
+      last_response.status.should == 403
+    end
+
+    it 'should be possible to specify a different default status code' do
+      @app ||= Rack::Builder.app do
+        use Grape::Middleware::Error, :rescue_all => true, :default_status => 500
+        run ExceptionApp
+      end
+      get '/'
+      last_response.status.should == 500
+    end
+       
+    it 'should be possible to return errors in json format' do
+      @app ||= Rack::Builder.app do
+        use Grape::Middleware::Error, :rescue_all => true, :format => :json
+        run ExceptionApp
+      end
+      get '/'
+      last_response.body.should == '{"error":"rain!"}'
+    end
+
+    it 'should be possible to return hash errors in json format' do
+      @app ||= Rack::Builder.app do
+        use Grape::Middleware::Error, :rescue_all => true, :format => :json
+        run ErrorHashApp
+      end
+      get '/'
+      ['{"error":"rain!","detail":"missing widget"}',
+       '{"detail":"missing widget","error":"rain!"}'].should be_include(last_response.body)
+    end
+
+    it 'should be possible to specify a custom formatter' do
+      @app ||= Rack::Builder.app do
+        use Grape::Middleware::Error, 
+          :rescue_all => true,
+          :format => :custom, 
+          :formatters => { 
+            :custom => lambda { |message, backtrace| { :custom_formatter => message }.inspect }  
+          }
+        run ExceptionApp
+      end
+      get '/'
+      last_response.body.should == '{:custom_formatter=>"rain!"}'
+    end
+    
+    it 'should not trap regular error! codes' do
+      @app ||= Rack::Builder.app do
+        use Grape::Middleware::Error
+        run AccessDeniedApp
+      end
+      get '/'
+      last_response.status.should == 401    
+    end 
+  end 
+end

metadata

@@ -2,7 +2,7 @@
 name: grape
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors: 
 - Michael Bleigh
@@ -10,11 +10,12 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-04-08 00:00:00 -05:00
+date: 2011-07-14 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: rack
+  prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -22,10 +23,10 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: "0"
   type: :runtime
-  prerelease: false
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
   name: rack-mount
+  prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -33,10 +34,10 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: "0"
   type: :runtime
-  prerelease: false
   version_requirements: *id002
 - !ruby/object:Gem::Dependency 
   name: rack-jsonp
+  prerelease: false
   requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -44,10 +45,10 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: "0"
   type: :runtime
-  prerelease: false
   version_requirements: *id003
 - !ruby/object:Gem::Dependency 
   name: multi_json
+  prerelease: false
   requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -55,10 +56,10 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: "0"
   type: :runtime
-  prerelease: false
   version_requirements: *id004
 - !ruby/object:Gem::Dependency 
   name: multi_xml
+  prerelease: false
   requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -66,10 +67,10 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: "0"
   type: :runtime
-  prerelease: false
   version_requirements: *id005
 - !ruby/object:Gem::Dependency 
-  name: mg
+  name: rake
+  prerelease: false
   requirement: &id006 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -77,10 +78,10 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: "0"
   type: :development
-  prerelease: false
   version_requirements: *id006
 - !ruby/object:Gem::Dependency 
   name: maruku
+  prerelease: false
   requirement: &id007 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -88,10 +89,10 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: "0"
   type: :development
-  prerelease: false
   version_requirements: *id007
 - !ruby/object:Gem::Dependency 
   name: yard
+  prerelease: false
   requirement: &id008 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -99,10 +100,10 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: "0"
   type: :development
-  prerelease: false
   version_requirements: *id008
 - !ruby/object:Gem::Dependency 
   name: rack-test
+  prerelease: false
   requirement: &id009 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -110,21 +111,21 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: "0"
   type: :development
-  prerelease: false
   version_requirements: *id009
 - !ruby/object:Gem::Dependency 
   name: rspec
+  prerelease: false
   requirement: &id010 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        version: 2.5.0
+        version: 2.6.0
   type: :development
-  prerelease: false
   version_requirements: *id010
 - !ruby/object:Gem::Dependency 
   name: json_pure
+  prerelease: false
   requirement: &id011 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -132,8 +133,29 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: "0"
   type: :development
-  prerelease: false
   version_requirements: *id011
+- !ruby/object:Gem::Dependency 
+  name: ZenTest
+  prerelease: false
+  requirement: &id012 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id012
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  prerelease: false
+  requirement: &id013 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id013
 description: A Ruby framework for rapid API development with great conventions.
 email: 
 - michael@intridea.com
@@ -259,6 +281,7 @@ files:
 - lib/grape/api.rb
 - lib/grape/endpoint.rb
 - lib/grape/middleware/auth/basic.rb
+- lib/grape/middleware/auth/digest.rb
 - lib/grape/middleware/auth/oauth2.rb
 - lib/grape/middleware/base.rb
 - lib/grape/middleware/error.rb
@@ -269,9 +292,11 @@ files:
 - spec/grape/api_spec.rb
 - spec/grape/endpoint_spec.rb
 - spec/grape/middleware/auth/basic_spec.rb
+- spec/grape/middleware/auth/digest_spec.rb
 - spec/grape/middleware/auth/oauth2_spec.rb
 - spec/grape/middleware/base_spec.rb
 - spec/grape/middleware/error_spec.rb
+- spec/grape/middleware/exception_spec.rb
 - spec/grape/middleware/formatter_spec.rb
 - spec/grape/middleware/prefixer_spec.rb
 - spec/grape/middleware/versioner_spec.rb
@@ -291,18 +316,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: -2709592695038958113
-      segments: 
-      - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: -2709592695038958113
-      segments: 
-      - 0
       version: "0"
 requirements: []
 
@@ -315,9 +334,11 @@ test_files:
 - spec/grape/api_spec.rb
 - spec/grape/endpoint_spec.rb
 - spec/grape/middleware/auth/basic_spec.rb
+- spec/grape/middleware/auth/digest_spec.rb
 - spec/grape/middleware/auth/oauth2_spec.rb
 - spec/grape/middleware/base_spec.rb
 - spec/grape/middleware/error_spec.rb
+- spec/grape/middleware/exception_spec.rb
 - spec/grape/middleware/formatter_spec.rb
 - spec/grape/middleware/prefixer_spec.rb
 - spec/grape/middleware/versioner_spec.rb