grape 0.3.0 → 0.7.0

data/spec/grape/middleware/error_spec.rb

@@ -2,48 +2,44 @@ require 'spec_helper'
 
 describe Grape::Middleware::Error do
   class ErrApp
-    class << self    
+    class << self
       attr_accessor :error
       attr_accessor :format
-      
+
       def call(env)
-        throw :error, self.error
+        throw :error, error
       end
     end
   end
-  
+
   def app
     Rack::Builder.app do
-      use Grape::Middleware::Error, :default_message => 'Aww, hamburgers.'
+      use Grape::Middleware::Error, default_message: 'Aww, hamburgers.'
       run ErrApp
     end
   end
-  
+
   it 'sets the status code appropriately' do
-    ErrApp.error = {:status => 410}
+    ErrApp.error = { status: 410 }
     get '/'
     last_response.status.should == 410
   end
-  
+
   it 'sets the error message appropriately' do
-    ErrApp.error = {:message => 'Awesome stuff.'}
+    ErrApp.error = { message: 'Awesome stuff.' }
     get '/'
     last_response.body.should == 'Awesome stuff.'
   end
-  
-  it 'defaults to a 403 status' do
+
+  it 'defaults to a 500 status' do
     ErrApp.error = {}
     get '/'
-    last_response.status.should == 403
+    last_response.status.should == 500
   end
-  
+
   it 'has a default message' do
     ErrApp.error = {}
     get '/'
     last_response.body.should == 'Aww, hamburgers.'
   end
-  
-  context 'with formatting' do
-    
-  end
 end

data/spec/grape/middleware/exception_spec.rb

@@ -15,9 +15,10 @@ describe Grape::Middleware::Error do
   # raises a hash error
   class ErrorHashApp
     class << self
-      def error!(message, status=403)
-        throw :error, :message => { :error => message, :detail => "missing widget" }, :status => status
+      def error!(message, status)
+        throw :error, message: { error: message, detail: "missing widget" }, status: status
       end
+
       def call(env)
         error!("rain!", 401)
       end
@@ -27,9 +28,10 @@ describe Grape::Middleware::Error do
   # raises an error!
   class AccessDeniedApp
     class << self
-      def error!(message, status=403)
-        throw :error, :message => message, :status => status
+      def error!(message, status)
+        throw :error, message: message, status: status
       end
+
       def call(env)
         error!("Access Denied", 401)
       end
@@ -37,18 +39,18 @@ describe Grape::Middleware::Error do
   end
 
   # raises a custom error
-  class CustomError < Grape::Exceptions::Base; end
+  class CustomError < Grape::Exceptions::Base
+  end
+
   class CustomErrorApp
     class << self
       def call(env)
-        raise CustomError, :status => 400, :message => 'failed validation'
+        raise CustomError, status: 400, message: 'failed validation'
       end
     end
   end
 
-  def app
-    @app
-  end
+  attr_reader :app
 
   it 'does not trap errors by default' do
     @app ||= Rack::Builder.app do
@@ -61,25 +63,25 @@ describe Grape::Middleware::Error do
   context 'with rescue_all set to true' do
     it 'sets the message appropriately' do
       @app ||= Rack::Builder.app do
-        use Grape::Middleware::Error, :rescue_all => true
+        use Grape::Middleware::Error, rescue_all: true
         run ExceptionApp
       end
       get '/'
       last_response.body.should == "rain!"
     end
 
-    it 'defaults to a 403 status' do
+    it 'defaults to a 500 status' do
       @app ||= Rack::Builder.app do
-        use Grape::Middleware::Error, :rescue_all => true
+        use Grape::Middleware::Error, rescue_all: true
         run ExceptionApp
       end
       get '/'
-      last_response.status.should == 403
+      last_response.status.should == 500
     end
 
     it 'is possible to specify a different default status code' do
       @app ||= Rack::Builder.app do
-        use Grape::Middleware::Error, :rescue_all => true, :default_status => 500
+        use Grape::Middleware::Error, rescue_all: true, default_status: 500
         run ExceptionApp
       end
       get '/'
@@ -88,7 +90,7 @@ describe Grape::Middleware::Error do
 
     it 'is possible to return errors in json format' do
       @app ||= Rack::Builder.app do
-        use Grape::Middleware::Error, :rescue_all => true, :format => :json
+        use Grape::Middleware::Error, rescue_all: true, format: :json
         run ExceptionApp
       end
       get '/'
@@ -97,7 +99,26 @@ describe Grape::Middleware::Error do
 
     it 'is possible to return hash errors in json format' do
       @app ||= Rack::Builder.app do
-        use Grape::Middleware::Error, :rescue_all => true, :format => :json
+        use Grape::Middleware::Error, rescue_all: true, format: :json
+        run ErrorHashApp
+      end
+      get '/'
+      ['{"error":"rain!","detail":"missing widget"}',
+       '{"detail":"missing widget","error":"rain!"}'].should include(last_response.body)
+    end
+
+    it 'is possible to return errors in jsonapi format' do
+      @app ||= Rack::Builder.app do
+        use Grape::Middleware::Error, rescue_all: true, format: :jsonapi
+        run ExceptionApp
+      end
+      get '/'
+      last_response.body.should == '{"error":"rain!"}'
+    end
+
+    it 'is possible to return hash errors in jsonapi format' do
+      @app ||= Rack::Builder.app do
+        use Grape::Middleware::Error, rescue_all: true, format: :jsonapi
         run ErrorHashApp
       end
       get '/'
@@ -107,7 +128,7 @@ describe Grape::Middleware::Error do
 
     it 'is possible to return errors in xml format' do
       @app ||= Rack::Builder.app do
-        use Grape::Middleware::Error, :rescue_all => true, :format => :xml
+        use Grape::Middleware::Error, rescue_all: true, format: :xml
         run ExceptionApp
       end
       get '/'
@@ -116,7 +137,7 @@ describe Grape::Middleware::Error do
 
     it 'is possible to return hash errors in xml format' do
       @app ||= Rack::Builder.app do
-        use Grape::Middleware::Error, :rescue_all => true, :format => :xml
+        use Grape::Middleware::Error, rescue_all: true, format: :xml
         run ErrorHashApp
       end
       get '/'
@@ -126,14 +147,13 @@ describe Grape::Middleware::Error do
 
     it 'is possible to specify a custom formatter' do
       @app ||= Rack::Builder.app do
-        use Grape::Middleware::Error,
-          :rescue_all => true,
-          :format => :custom,
-          :error_formatters => {
-            :custom => lambda { |message, backtrace, options, env|
-              { :custom_formatter => message }.inspect
-            }
-          }
+        use Grape::Middleware::Error, rescue_all: true,
+                                      format: :custom,
+                                      error_formatters: {
+                                        custom: lambda { |message, backtrace, options, env|
+                                          { custom_formatter: message }.inspect
+                                        }
+                                      }
         run ExceptionApp
       end
       get '/'
@@ -151,7 +171,7 @@ describe Grape::Middleware::Error do
 
     it 'responds to custom Grape exceptions appropriately' do
       @app ||= Rack::Builder.app do
-        use Grape::Middleware::Error, :rescue_all => false
+        use Grape::Middleware::Error, rescue_all: false
         run CustomErrorApp
       end
 

data/spec/grape/middleware/formatter_spec.rb

@@ -1,16 +1,16 @@
 require 'spec_helper'
 
 describe Grape::Middleware::Formatter do
-  subject{ Grape::Middleware::Formatter.new(app) }
-  before{ subject.stub!(:dup).and_return(subject) }
+  subject { Grape::Middleware::Formatter.new(app) }
+  before { subject.stub(:dup).and_return(subject) }
 
-  let(:app){ lambda{|env| [200, {}, [@body || { "foo" => "bar" }]]} }
+  let(:app) { lambda { |env| [200, {}, [@body || { "foo" => "bar" }]] } }
 
   context 'serialization' do
     it 'looks at the bodies for possibly serializable data' do
-      @body = {"abc" => "def"}
-      status, headers, bodies = *subject.call({'PATH_INFO' => '/somewhere', 'HTTP_ACCEPT' => 'application/json'})
-      bodies.each{|b| b.should == MultiJson.dump(@body) }
+      @body = { "abc" => "def" }
+      _, _, bodies = *subject.call('PATH_INFO' => '/somewhere', 'HTTP_ACCEPT' => 'application/json')
+      bodies.each { |b| b.should == MultiJson.dump(@body) }
     end
 
     it 'calls #to_json since default format is json' do
@@ -21,7 +21,18 @@ describe Grape::Middleware::Formatter do
         end
       end
 
-      subject.call({'PATH_INFO' => '/somewhere', 'HTTP_ACCEPT' => 'application/json'}).last.each{|b| b.should == '"bar"'}
+      subject.call('PATH_INFO' => '/somewhere', 'HTTP_ACCEPT' => 'application/json').last.each { |b| b.should == '"bar"' }
+    end
+
+    it 'calls #to_json if the content type is jsonapi' do
+      @body = { 'foos' => [{ 'bar' => 'baz' }] }
+      @body.instance_eval do
+        def to_json
+          "{\"foos\":[{\"bar\":\"baz\"}] }"
+        end
+      end
+
+      subject.call('PATH_INFO' => '/somewhere', 'HTTP_ACCEPT' => 'application/vnd.api+json').last.each { |b| b.should == '{"foos":[{"bar":"baz"}] }' }
     end
 
     it 'calls #to_xml if the content type is xml' do
@@ -32,98 +43,124 @@ describe Grape::Middleware::Formatter do
         end
       end
 
-      subject.call({'PATH_INFO' => '/somewhere.xml', 'HTTP_ACCEPT' => 'application/json'}).last.each{|b| b.should == '<bar/>'}
+      subject.call('PATH_INFO' => '/somewhere.xml', 'HTTP_ACCEPT' => 'application/json').last.each { |b| b.should == '<bar/>' }
+    end
+  end
+
+  context 'error handling' do
+    let(:formatter) { double(:formatter) }
+    before do
+      Grape::Formatter::Base.stub(:formatter_for) { formatter }
+    end
+
+    it 'rescues formatter-specific exceptions' do
+      formatter.stub(:call) { raise Grape::Exceptions::InvalidFormatter.new(String, 'xml') }
+
+      expect {
+        catch(:error) { subject.call('PATH_INFO' => '/somewhere.xml', 'HTTP_ACCEPT' => 'application/json') }
+      }.to_not raise_error
+    end
+
+    it 'does not rescue other exceptions' do
+      formatter.stub(:call) { raise StandardError }
+
+      expect {
+        catch(:error) { subject.call('PATH_INFO' => '/somewhere.xml', 'HTTP_ACCEPT' => 'application/json') }
+      }.to raise_error
     end
   end
 
   context 'detection' do
 
-    it 'uses the extension if one is provided' do
-      subject.call({'PATH_INFO' => '/info.xml'})
+    it 'uses the xml extension if one is provided' do
+      subject.call('PATH_INFO' => '/info.xml')
       subject.env['api.format'].should == :xml
-      subject.call({'PATH_INFO' => '/info.json'})
+    end
+
+    it 'uses the json extension if one is provided' do
+      subject.call('PATH_INFO' => '/info.json')
       subject.env['api.format'].should == :json
     end
 
     it 'uses the format parameter if one is provided' do
-      subject.call({'PATH_INFO' => '/info','QUERY_STRING' => 'format=json'})
+      subject.call('PATH_INFO' => '/info', 'QUERY_STRING' => 'format=json')
       subject.env['api.format'].should == :json
-      subject.call({'PATH_INFO' => '/info','QUERY_STRING' => 'format=xml'})
+      subject.call('PATH_INFO' => '/info', 'QUERY_STRING' => 'format=xml')
       subject.env['api.format'].should == :xml
     end
 
     it 'uses the default format if none is provided' do
-      subject.call({'PATH_INFO' => '/info'})
+      subject.call('PATH_INFO' => '/info')
       subject.env['api.format'].should == :txt
     end
 
     it 'uses the requested format if provided in headers' do
-      subject.call({'PATH_INFO' => '/info', 'HTTP_ACCEPT' => 'application/json'})
+      subject.call('PATH_INFO' => '/info', 'HTTP_ACCEPT' => 'application/json')
       subject.env['api.format'].should == :json
     end
 
     it 'uses the file extension format if provided before headers' do
-      subject.call({'PATH_INFO' => '/info.txt', 'HTTP_ACCEPT' => 'application/json'})
+      subject.call('PATH_INFO' => '/info.txt', 'HTTP_ACCEPT' => 'application/json')
       subject.env['api.format'].should == :txt
     end
   end
 
   context 'accept header detection' do
     it 'detects from the Accept header' do
-      subject.call({'PATH_INFO' => '/info', 'HTTP_ACCEPT' => 'application/xml'})
+      subject.call('PATH_INFO' => '/info', 'HTTP_ACCEPT' => 'application/xml')
       subject.env['api.format'].should == :xml
     end
 
     it 'looks for case-indifferent headers' do
-      subject.call({'PATH_INFO' => '/info', 'http_accept' => 'application/xml'})
+      subject.call('PATH_INFO' => '/info', 'http_accept' => 'application/xml')
       subject.env['api.format'].should == :xml
     end
 
     it 'uses quality rankings to determine formats' do
-      subject.call({'PATH_INFO' => '/info', 'HTTP_ACCEPT' => 'application/json; q=0.3,application/xml; q=1.0'})
+      subject.call('PATH_INFO' => '/info', 'HTTP_ACCEPT' => 'application/json; q=0.3,application/xml; q=1.0')
       subject.env['api.format'].should == :xml
-      subject.call({'PATH_INFO' => '/info', 'HTTP_ACCEPT' => 'application/json; q=1.0,application/xml; q=0.3'})
+      subject.call('PATH_INFO' => '/info', 'HTTP_ACCEPT' => 'application/json; q=1.0,application/xml; q=0.3')
       subject.env['api.format'].should == :json
     end
 
     it 'handles quality rankings mixed with nothing' do
-      subject.call({'PATH_INFO' => '/info', 'HTTP_ACCEPT' => 'application/json,application/xml; q=1.0'})
+      subject.call('PATH_INFO' => '/info', 'HTTP_ACCEPT' => 'application/json,application/xml; q=1.0')
       subject.env['api.format'].should == :xml
     end
 
     it 'parses headers with other attributes' do
-      subject.call({'PATH_INFO' => '/info', 'HTTP_ACCEPT' => 'application/json; abc=2.3; q=1.0,application/xml; q=0.7'})
+      subject.call('PATH_INFO' => '/info', 'HTTP_ACCEPT' => 'application/json; abc=2.3; q=1.0,application/xml; q=0.7')
       subject.env['api.format'].should == :json
     end
 
     it 'parses headers with vendor and api version' do
-      subject.call({'PATH_INFO' => '/info', 'HTTP_ACCEPT' => 'application/vnd.test-v1+xml'})
+      subject.call('PATH_INFO' => '/info', 'HTTP_ACCEPT' => 'application/vnd.test-v1+xml')
       subject.env['api.format'].should == :xml
     end
 
     it 'parses headers with symbols as hash keys' do
-      subject.call({'PATH_INFO' => '/info', 'http_accept' => 'application/xml', :system_time => '091293'})
+      subject.call('PATH_INFO' => '/info', 'http_accept' => 'application/xml', system_time: '091293')
       subject.env[:system_time].should == '091293'
     end
   end
 
   context 'content-type' do
     it 'is set for json' do
-      _, headers, _ = subject.call({'PATH_INFO' => '/info.json'})
+      _, headers, _ = subject.call('PATH_INFO' => '/info.json')
       headers['Content-type'].should == 'application/json'
     end
     it 'is set for xml' do
-      _, headers, _ = subject.call({'PATH_INFO' => '/info.xml'})
+      _, headers, _ = subject.call('PATH_INFO' => '/info.xml')
       headers['Content-type'].should == 'application/xml'
     end
     it 'is set for txt' do
-      _, headers, _ = subject.call({'PATH_INFO' => '/info.txt'})
+      _, headers, _ = subject.call('PATH_INFO' => '/info.txt')
       headers['Content-type'].should == 'text/plain'
     end
     it 'is set for custom' do
       subject.options[:content_types] = {}
       subject.options[:content_types][:custom] = 'application/x-custom'
-      _, headers, _ = subject.call({'PATH_INFO' => '/info.custom'})
+      _, headers, _ = subject.call('PATH_INFO' => '/info.custom')
       headers['Content-type'].should == 'application/x-custom'
     end
   end
@@ -133,60 +170,85 @@ describe Grape::Middleware::Formatter do
       subject.options[:content_types] = {}
       subject.options[:content_types][:custom] = "don't care"
       subject.options[:formatters][:custom] = lambda { |obj, env| 'CUSTOM FORMAT' }
-      _, _, body = subject.call({'PATH_INFO' => '/info.custom'})
+      _, _, body = subject.call('PATH_INFO' => '/info.custom')
       body.body.should == ['CUSTOM FORMAT']
     end
     it 'uses default json formatter' do
       @body = ['blah']
-      _, _, body = subject.call({'PATH_INFO' => '/info.json'})
+      _, _, body = subject.call('PATH_INFO' => '/info.json')
       body.body.should == ['["blah"]']
     end
     it 'uses custom json formatter' do
       subject.options[:formatters][:json] = lambda { |obj, env| 'CUSTOM JSON FORMAT' }
-      _, _, body = subject.call({'PATH_INFO' => '/info.json'})
+      _, _, body = subject.call('PATH_INFO' => '/info.json')
       body.body.should == ['CUSTOM JSON FORMAT']
     end
   end
 
   context 'input' do
-    [ "POST", "PATCH", "PUT" ].each do |method|
-      [ "application/json", "application/json; charset=utf-8" ].each do |content_type|
+    ["POST", "PATCH", "PUT", "DELETE"].each do |method|
+      ["application/json", "application/json; charset=utf-8"].each do |content_type|
         context content_type do
           it 'parses the body from #{method} and copies values into rack.request.form_hash' do
             io = StringIO.new('{"is_boolean":true,"string":"thing"}')
-            subject.call({
+            subject.call(
               'PATH_INFO' => '/info',
               'REQUEST_METHOD' => method,
               'CONTENT_TYPE' => content_type,
               'rack.input' => io,
               'CONTENT_LENGTH' => io.length
-            })
-            subject.env['rack.request.form_hash']['is_boolean'].should be_true
+            )
+            subject.env['rack.request.form_hash']['is_boolean'].should be true
             subject.env['rack.request.form_hash']['string'].should == 'thing'
           end
         end
       end
+      it "parses the chunked body from #{method} and copies values into rack.request.from_hash" do
+        io = StringIO.new('{"is_boolean":true,"string":"thing"}')
+        subject.call(
+          'PATH_INFO' => '/infol',
+          'REQUEST_METHOD' => method,
+          'CONTENT_TYPE' => 'application/json',
+          'rack.input' => io,
+          'HTTP_TRANSFER_ENCODING' => 'chunked'
+        )
+        subject.env['rack.request.form_hash']['is_boolean'].should be true
+        subject.env['rack.request.form_hash']['string'].should == 'thing'
+      end
+      it "rewinds IO" do
+        io = StringIO.new('{"is_boolean":true,"string":"thing"}')
+        io.read
+        subject.call(
+          'PATH_INFO' => '/infol',
+          'REQUEST_METHOD' => method,
+          'CONTENT_TYPE' => 'application/json',
+          'rack.input' => io,
+          'HTTP_TRANSFER_ENCODING' => 'chunked'
+        )
+        subject.env['rack.request.form_hash']['is_boolean'].should be true
+        subject.env['rack.request.form_hash']['string'].should == 'thing'
+      end
       it 'parses the body from an xml #{method} and copies values into rack.request.from_hash' do
         io = StringIO.new('<thing><name>Test</name></thing>')
-        subject.call({
+        subject.call(
           'PATH_INFO' => '/info.xml',
           'REQUEST_METHOD' => method,
           'CONTENT_TYPE' => 'application/xml',
           'rack.input' => io,
           'CONTENT_LENGTH' => io.length
-        })
+        )
         subject.env['rack.request.form_hash']['thing']['name'].should == 'Test'
       end
-      [ Rack::Request::FORM_DATA_MEDIA_TYPES, Rack::Request::PARSEABLE_DATA_MEDIA_TYPES ].flatten.each do |content_type|
+      [Rack::Request::FORM_DATA_MEDIA_TYPES, Rack::Request::PARSEABLE_DATA_MEDIA_TYPES].flatten.each do |content_type|
         it "ignores #{content_type}" do
           io = StringIO.new('name=Other+Test+Thing')
-          subject.call({
+          subject.call(
             'PATH_INFO' => '/info',
             'REQUEST_METHOD' => method,
             'CONTENT_TYPE' => content_type,
             'rack.input' => io,
             'CONTENT_LENGTH' => io.length
-          })
+          )
           subject.env['rack.request.form_hash'].should be_nil
         end
       end

data/spec/grape/middleware/versioner/accept_version_header_spec.rb

@@ -0,0 +1,121 @@
+require 'spec_helper'
+
+describe Grape::Middleware::Versioner::AcceptVersionHeader do
+  let(:app) { lambda { |env| [200, env, env] } }
+  subject { Grape::Middleware::Versioner::AcceptVersionHeader.new(app, @options || {}) }
+
+  before do
+    @options = {
+      version_options: {
+        using: :accept_version_header
+      },
+    }
+  end
+
+  context 'api.version' do
+    before do
+      @options[:versions] = ['v1']
+    end
+
+    it 'is set' do
+      status, _, env = subject.call('HTTP_ACCEPT_VERSION' => 'v1')
+      env['api.version'].should eql 'v1'
+      status.should == 200
+    end
+
+    it 'is set if format provided' do
+      status, _, env = subject.call('HTTP_ACCEPT_VERSION' => 'v1')
+      env['api.version'].should eql 'v1'
+      status.should == 200
+    end
+
+    it 'fails with 406 Not Acceptable if version is not supported' do
+      expect {
+        subject.call('HTTP_ACCEPT_VERSION' => 'v2').last
+      }.to throw_symbol(
+        :error,
+        status: 406,
+        headers: { 'X-Cascade' => 'pass' },
+        message: 'The requested version is not supported.'
+      )
+    end
+  end
+
+  it 'succeeds if :strict is not set' do
+    subject.call('HTTP_ACCEPT_VERSION' => '').first.should == 200
+    subject.call({}).first.should == 200
+  end
+
+  it 'succeeds if :strict is set to false' do
+    @options[:version_options][:strict] = false
+    subject.call('HTTP_ACCEPT_VERSION' => '').first.should == 200
+    subject.call({}).first.should == 200
+  end
+
+  context 'when :strict is set' do
+    before do
+      @options[:versions] = ['v1']
+      @options[:version_options][:strict] = true
+    end
+
+    it 'fails with 406 Not Acceptable if header is not set' do
+      expect {
+        subject.call({}).last
+      }.to throw_symbol(
+        :error,
+        status: 406,
+        headers: { 'X-Cascade' => 'pass' },
+        message: 'Accept-Version header must be set.'
+      )
+    end
+
+    it 'fails with 406 Not Acceptable if header is empty' do
+      expect {
+        subject.call('HTTP_ACCEPT_VERSION' => '').last
+      }.to throw_symbol(
+        :error,
+        status: 406,
+        headers: { 'X-Cascade' => 'pass' },
+        message: 'Accept-Version header must be set.'
+      )
+    end
+
+    it 'succeeds if proper header is set' do
+      subject.call('HTTP_ACCEPT_VERSION' => 'v1').first.should == 200
+    end
+  end
+
+  context 'when :strict and :cascade=>false are set' do
+    before do
+      @options[:versions] = ['v1']
+      @options[:version_options][:strict] = true
+      @options[:version_options][:cascade] = false
+    end
+
+    it 'fails with 406 Not Acceptable if header is not set' do
+      expect {
+        subject.call({}).last
+      }.to throw_symbol(
+        :error,
+        status: 406,
+        headers: {},
+        message: 'Accept-Version header must be set.'
+      )
+    end
+
+    it 'fails with 406 Not Acceptable if header is empty' do
+      expect {
+        subject.call('HTTP_ACCEPT_VERSION' => '').last
+      }.to throw_symbol(
+        :error,
+        status: 406,
+        headers: {},
+        message: 'Accept-Version header must be set.'
+      )
+    end
+
+    it 'succeeds if proper header is set' do
+      subject.call('HTTP_ACCEPT_VERSION' => 'v1').first.should == 200
+    end
+  end
+end