grape 0.13.0 → 0.14.0

data/spec/grape/middleware/exception_spec.rb

@@ -3,48 +3,50 @@ require 'active_support/core_ext/hash'
 
 describe Grape::Middleware::Error do
   # raises a text exception
-  class ExceptionApp
-    class << self
-      def call(_env)
-        fail 'rain!'
+  module ExceptionSpec
+    class ExceptionApp
+      class << self
+        def call(_env)
+          fail 'rain!'
+        end
       end
     end
-  end
 
-  # raises a hash error
-  class ErrorHashApp
-    class << self
-      def error!(message, status)
-        throw :error, message: { error: message, detail: 'missing widget' }, status: status
-      end
+    # raises a hash error
+    class ErrorHashApp
+      class << self
+        def error!(message, status)
+          throw :error, message: { error: message, detail: 'missing widget' }, status: status
+        end
 
-      def call(_env)
-        error!('rain!', 401)
+        def call(_env)
+          error!('rain!', 401)
+        end
       end
     end
-  end
 
-  # raises an error!
-  class AccessDeniedApp
-    class << self
-      def error!(message, status)
-        throw :error, message: message, status: status
-      end
+    # raises an error!
+    class AccessDeniedApp
+      class << self
+        def error!(message, status)
+          throw :error, message: message, status: status
+        end
 
-      def call(_env)
-        error!('Access Denied', 401)
+        def call(_env)
+          error!('Access Denied', 401)
+        end
       end
     end
-  end
 
-  # raises a custom error
-  class CustomError < Grape::Exceptions::Base
-  end
+    # raises a custom error
+    class CustomError < Grape::Exceptions::Base
+    end
 
-  class CustomErrorApp
-    class << self
-      def call(_env)
-        fail CustomError, status: 400, message: 'failed validation'
+    class CustomErrorApp
+      class << self
+        def call(_env)
+          fail CustomError, status: 400, message: 'failed validation'
+        end
       end
     end
   end
@@ -55,7 +57,7 @@ describe Grape::Middleware::Error do
     @app ||= Rack::Builder.app do
       use Spec::Support::EndpointFaker
       use Grape::Middleware::Error
-      run ExceptionApp
+      run ExceptionSpec::ExceptionApp
     end
     expect { get '/' }.to raise_error
   end
@@ -65,7 +67,7 @@ describe Grape::Middleware::Error do
       @app ||= Rack::Builder.app do
         use Spec::Support::EndpointFaker
         use Grape::Middleware::Error, rescue_all: true
-        run ExceptionApp
+        run ExceptionSpec::ExceptionApp
       end
       get '/'
       expect(last_response.body).to eq('rain!')
@@ -75,7 +77,7 @@ describe Grape::Middleware::Error do
       @app ||= Rack::Builder.app do
         use Spec::Support::EndpointFaker
         use Grape::Middleware::Error, rescue_all: true
-        run ExceptionApp
+        run ExceptionSpec::ExceptionApp
       end
       get '/'
       expect(last_response.status).to eq(500)
@@ -85,7 +87,7 @@ describe Grape::Middleware::Error do
       @app ||= Rack::Builder.app do
         use Spec::Support::EndpointFaker
         use Grape::Middleware::Error, rescue_all: true, default_status: 500
-        run ExceptionApp
+        run ExceptionSpec::ExceptionApp
       end
       get '/'
       expect(last_response.status).to eq(500)
@@ -95,7 +97,7 @@ describe Grape::Middleware::Error do
       @app ||= Rack::Builder.app do
         use Spec::Support::EndpointFaker
         use Grape::Middleware::Error, rescue_all: true, format: :json
-        run ExceptionApp
+        run ExceptionSpec::ExceptionApp
       end
       get '/'
       expect(last_response.body).to eq('{"error":"rain!"}')
@@ -105,7 +107,7 @@ describe Grape::Middleware::Error do
       @app ||= Rack::Builder.app do
         use Spec::Support::EndpointFaker
         use Grape::Middleware::Error, rescue_all: true, format: :json
-        run ErrorHashApp
+        run ExceptionSpec::ErrorHashApp
       end
       get '/'
       expect(['{"error":"rain!","detail":"missing widget"}',
@@ -116,7 +118,7 @@ describe Grape::Middleware::Error do
       @app ||= Rack::Builder.app do
         use Spec::Support::EndpointFaker
         use Grape::Middleware::Error, rescue_all: true, format: :jsonapi
-        run ExceptionApp
+        run ExceptionSpec::ExceptionApp
       end
       get '/'
       expect(last_response.body).to eq('{"error":"rain!"}')
@@ -126,7 +128,7 @@ describe Grape::Middleware::Error do
       @app ||= Rack::Builder.app do
         use Spec::Support::EndpointFaker
         use Grape::Middleware::Error, rescue_all: true, format: :jsonapi
-        run ErrorHashApp
+        run ExceptionSpec::ErrorHashApp
       end
       get '/'
       expect(['{"error":"rain!","detail":"missing widget"}',
@@ -137,7 +139,7 @@ describe Grape::Middleware::Error do
       @app ||= Rack::Builder.app do
         use Spec::Support::EndpointFaker
         use Grape::Middleware::Error, rescue_all: true, format: :xml
-        run ExceptionApp
+        run ExceptionSpec::ExceptionApp
       end
       get '/'
       expect(last_response.body).to eq("<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<error>\n  <message>rain!</message>\n</error>\n")
@@ -147,7 +149,7 @@ describe Grape::Middleware::Error do
       @app ||= Rack::Builder.app do
         use Spec::Support::EndpointFaker
         use Grape::Middleware::Error, rescue_all: true, format: :xml
-        run ErrorHashApp
+        run ExceptionSpec::ErrorHashApp
       end
       get '/'
       expect(["<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<error>\n  <detail>missing widget</detail>\n  <error>rain!</error>\n</error>\n",
@@ -164,7 +166,7 @@ describe Grape::Middleware::Error do
                                           { custom_formatter: message }.inspect
                                         end
                                       }
-        run ExceptionApp
+        run ExceptionSpec::ExceptionApp
       end
       get '/'
       expect(last_response.body).to eq('{:custom_formatter=>"rain!"}')
@@ -174,7 +176,7 @@ describe Grape::Middleware::Error do
       @app ||= Rack::Builder.app do
         use Spec::Support::EndpointFaker
         use Grape::Middleware::Error
-        run AccessDeniedApp
+        run ExceptionSpec::AccessDeniedApp
       end
       get '/'
       expect(last_response.status).to eq(401)
@@ -184,7 +186,7 @@ describe Grape::Middleware::Error do
       @app ||= Rack::Builder.app do
         use Spec::Support::EndpointFaker
         use Grape::Middleware::Error, rescue_all: false
-        run CustomErrorApp
+        run ExceptionSpec::CustomErrorApp
       end
 
       get '/'

data/spec/grape/middleware/formatter_spec.rb

@@ -132,6 +132,18 @@ describe Grape::Middleware::Formatter do
       expect(subject.env['api.format']).to eq(:xml)
     end
 
+    context 'with custom vendored content types' do
+      before do
+        subject.options[:content_types] = {}
+        subject.options[:content_types][:custom] = 'application/vnd.test+json'
+      end
+
+      it 'it uses the custom type' do
+        subject.call('PATH_INFO' => '/info', 'HTTP_ACCEPT' => 'application/vnd.test+json')
+        expect(subject.env['api.format']).to eq(:custom)
+      end
+    end
+
     it 'parses headers with symbols as hash keys' do
       subject.call('PATH_INFO' => '/info', 'http_accept' => 'application/xml', system_time: '091293')
       expect(subject.env[:system_time]).to eq('091293')
@@ -157,6 +169,16 @@ describe Grape::Middleware::Formatter do
       _, headers, = subject.call('PATH_INFO' => '/info.custom')
       expect(headers['Content-type']).to eq('application/x-custom')
     end
+    it 'is set for vendored with registered type' do
+      subject.options[:content_types] = {}
+      subject.options[:content_types][:custom] = 'application/vnd.test+json'
+      _, headers, = subject.call('PATH_INFO' => '/info', 'HTTP_ACCEPT' => 'application/vnd.test+json')
+      expect(headers['Content-type']).to eq('application/vnd.test+json')
+    end
+    it 'is set to closest generic for custom vendored/versioned without registered type' do
+      _, headers, = subject.call('PATH_INFO' => '/info', 'HTTP_ACCEPT' => 'application/vnd.test+json')
+      expect(headers['Content-type']).to eq('application/json')
+    end
   end
 
   context 'format' do
@@ -179,6 +201,18 @@ describe Grape::Middleware::Formatter do
     end
   end
 
+  context 'no content responses' do
+    let(:no_content_response) { ->(status) { [status, {}, ['']] } }
+
+    Rack::Utils::STATUS_WITH_NO_ENTITY_BODY.each do |status|
+      it "does not modify a #{status} response" do
+        expected_response = no_content_response[status]
+        allow(app).to receive(:call).and_return(expected_response)
+        expect(subject.call({})).to eq(expected_response)
+      end
+    end
+  end
+
   context 'input' do
     %w(POST PATCH PUT DELETE).each do |method|
       ['application/json', 'application/json; charset=utf-8'].each do |content_type|

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

@@ -56,13 +56,13 @@ describe Grape::Middleware::Versioner::Header do
         end
 
         it 'is set' do
-          status, _, env =  subject.call('HTTP_ACCEPT' => 'application/vnd.vendor-v1+json')
+          status, _, env = subject.call('HTTP_ACCEPT' => 'application/vnd.vendor-v1+json')
           expect(env['api.format']).to eql 'json'
           expect(status).to eq(200)
         end
 
         it 'is nil if not provided' do
-          status, _, env =  subject.call('HTTP_ACCEPT' => 'application/vnd.vendor-v1')
+          status, _, env = subject.call('HTTP_ACCEPT' => 'application/vnd.vendor-v1')
           expect(env['api.format']).to eql nil
           expect(status).to eq(200)
         end
@@ -72,13 +72,13 @@ describe Grape::Middleware::Versioner::Header do
 
   context 'api.vendor' do
     it 'is set' do
-      status, _, env =  subject.call('HTTP_ACCEPT' => 'application/vnd.vendor')
+      status, _, env = subject.call('HTTP_ACCEPT' => 'application/vnd.vendor')
       expect(env['api.vendor']).to eql 'vendor'
       expect(status).to eq(200)
     end
 
     it 'is set if format provided' do
-      status, _, env =  subject.call('HTTP_ACCEPT' => 'application/vnd.vendor+json')
+      status, _, env = subject.call('HTTP_ACCEPT' => 'application/vnd.vendor+json')
       expect(env['api.vendor']).to eql 'vendor'
       expect(status).to eq(200)
     end
@@ -89,7 +89,7 @@ describe Grape::Middleware::Versioner::Header do
           expect(exception).to be_a(Grape::Exceptions::InvalidAcceptHeader)
           expect(exception.headers).to eql('X-Cascade' => 'pass')
           expect(exception.status).to eql 406
-          expect(exception.message).to include 'API vendor or version not found'
+          expect(exception.message).to include 'API vendor not found'
         end
     end
 
@@ -99,13 +99,13 @@ describe Grape::Middleware::Versioner::Header do
       end
 
       it 'is set' do
-        status, _, env =  subject.call('HTTP_ACCEPT' => 'application/vnd.vendor-v1')
+        status, _, env = subject.call('HTTP_ACCEPT' => 'application/vnd.vendor-v1')
         expect(env['api.vendor']).to eql 'vendor'
         expect(status).to eq(200)
       end
 
       it 'is set if format provided' do
-        status, _, env =  subject.call('HTTP_ACCEPT' => 'application/vnd.vendor-v1+json')
+        status, _, env = subject.call('HTTP_ACCEPT' => 'application/vnd.vendor-v1+json')
         expect(env['api.vendor']).to eql 'vendor'
         expect(status).to eq(200)
       end
@@ -116,7 +116,7 @@ describe Grape::Middleware::Versioner::Header do
             expect(exception).to be_a(Grape::Exceptions::InvalidAcceptHeader)
             expect(exception.headers).to eql('X-Cascade' => 'pass')
             expect(exception.status).to eql 406
-            expect(exception.message).to include('API vendor or version not found')
+            expect(exception.message).to include('API vendor not found')
           end
       end
     end
@@ -128,23 +128,23 @@ describe Grape::Middleware::Versioner::Header do
     end
 
     it 'is set' do
-      status, _, env =  subject.call('HTTP_ACCEPT' => 'application/vnd.vendor-v1')
+      status, _, env = subject.call('HTTP_ACCEPT' => 'application/vnd.vendor-v1')
       expect(env['api.version']).to eql 'v1'
       expect(status).to eq(200)
     end
 
     it 'is set if format provided' do
-      status, _, env =  subject.call('HTTP_ACCEPT' => 'application/vnd.vendor-v1+json')
+      status, _, env = subject.call('HTTP_ACCEPT' => 'application/vnd.vendor-v1+json')
       expect(env['api.version']).to eql 'v1'
       expect(status).to eq(200)
     end
 
     it 'fails with 406 Not Acceptable if version is invalid' do
       expect { subject.call('HTTP_ACCEPT' => 'application/vnd.vendor-v2+json').last }.to raise_exception do |exception|
-        expect(exception).to be_a(Grape::Exceptions::InvalidAcceptHeader)
+        expect(exception).to be_a(Grape::Exceptions::InvalidVersionHeader)
         expect(exception.headers).to eql('X-Cascade' => 'pass')
         expect(exception.status).to eql 406
-        expect(exception.message).to include('API vendor or version not found')
+        expect(exception.message).to include('API version not found')
       end
     end
   end
@@ -184,24 +184,6 @@ describe Grape::Middleware::Versioner::Header do
       end
     end
 
-    it 'fails with 406 Not Acceptable if type is a range' do
-      expect { subject.call('HTTP_ACCEPT' => '*/*').last }.to raise_exception do |exception|
-        expect(exception).to be_a(Grape::Exceptions::InvalidAcceptHeader)
-        expect(exception.headers).to eql('X-Cascade' => 'pass')
-        expect(exception.status).to eql 406
-        expect(exception.message).to include('Accept header must not contain ranges ("*").')
-      end
-    end
-
-    it 'fails with 406 Not Acceptable if subtype is a range' do
-      expect { subject.call('HTTP_ACCEPT' => 'application/*').last }.to raise_exception do |exception|
-        expect(exception).to be_a(Grape::Exceptions::InvalidAcceptHeader)
-        expect(exception.headers).to eql('X-Cascade' => 'pass')
-        expect(exception.status).to eql 406
-        expect(exception.message).to include('Accept header must not contain ranges ("*").')
-      end
-    end
-
     it 'succeeds if proper header is set' do
       expect(subject.call('HTTP_ACCEPT' => 'application/vnd.vendor-v1+json').first).to eq(200)
     end
@@ -223,30 +205,22 @@ describe Grape::Middleware::Versioner::Header do
       end
     end
 
-    it 'fails with 406 Not Acceptable if header is empty' do
-      expect { subject.call('HTTP_ACCEPT' => '').last }.to raise_exception do |exception|
-        expect(exception).to be_a(Grape::Exceptions::InvalidAcceptHeader)
-        expect(exception.headers).to eql({})
-        expect(exception.status).to eql 406
-        expect(exception.message).to include('Accept header must be set.')
-      end
-    end
-
-    it 'fails with 406 Not Acceptable if type is a range' do
-      expect { subject.call('HTTP_ACCEPT' => '*/*').last }.to raise_exception do |exception|
+    it 'fails with 406 Not Acceptable if header is application/xml' do
+      expect { subject.call('HTTP_ACCEPT' => 'application/xml').last }
+        .to raise_exception do |exception|
         expect(exception).to be_a(Grape::Exceptions::InvalidAcceptHeader)
         expect(exception.headers).to eql({})
         expect(exception.status).to eql 406
-        expect(exception.message).to include('Accept header must not contain ranges ("*").')
+        expect(exception.message).to include('API vendor or version not found.')
       end
     end
 
-    it 'fails with 406 Not Acceptable if subtype is a range' do
-      expect { subject.call('HTTP_ACCEPT' => 'application/*').last }.to raise_exception do |exception|
+    it 'fails with 406 Not Acceptable if header is empty' do
+      expect { subject.call('HTTP_ACCEPT' => '').last }.to raise_exception do |exception|
         expect(exception).to be_a(Grape::Exceptions::InvalidAcceptHeader)
         expect(exception.headers).to eql({})
         expect(exception.status).to eql 406
-        expect(exception.message).to include('Accept header must not contain ranges ("*").')
+        expect(exception.message).to include('Accept header must be set.')
       end
     end
 
@@ -270,10 +244,68 @@ describe Grape::Middleware::Versioner::Header do
 
     it 'fails with another version' do
       expect { subject.call('HTTP_ACCEPT' => 'application/vnd.vendor-v3+json') }.to raise_exception do |exception|
-        expect(exception).to be_a(Grape::Exceptions::InvalidAcceptHeader)
+        expect(exception).to be_a(Grape::Exceptions::InvalidVersionHeader)
         expect(exception.headers).to eql('X-Cascade' => 'pass')
         expect(exception.status).to eql 406
-        expect(exception.message).to include('API vendor or version not found')
+        expect(exception.message).to include('API version not found')
+      end
+    end
+  end
+
+  context 'when there are multiple versions with complex vendor specified with rescue_from :all' do
+    subject {
+      Class.new(Grape::API) do
+        rescue_from :all
+      end
+    }
+
+    let(:v1_app) {
+      Class.new(Grape::API) do
+        version 'v1', using: :header, vendor: 'test.a-cool_resource', cascade: false, strict: true
+        content_type :v1_test, 'application/vnd.test.a-cool_resource-v1+json'
+        formatter :v1_test, ->(object, _) { object }
+        format :v1_test
+
+        resources :users do
+          get :hello do
+            'one'
+          end
+        end
+      end
+    }
+
+    let(:v2_app) {
+      Class.new(Grape::API) do
+        version 'v2', using: :header, vendor: 'test.a-cool_resource', strict: true
+        content_type :v2_test, 'application/vnd.test.a-cool_resource-v2+json'
+        formatter :v2_test, ->(object, _) { object }
+        format :v2_test
+
+        resources :users do
+          get :hello do
+            'two'
+          end
+        end
+      end
+    }
+
+    def app
+      subject.mount v2_app
+      subject.mount v1_app
+      subject
+    end
+
+    context 'with header versioned endpoints and a rescue_all block defined' do
+      it 'responds correctly to a v1 request' do
+        versioned_get '/users/hello', 'v1', using: :header, vendor: 'test.a-cool_resource'
+        expect(last_response.body).to eq('one')
+        expect(last_response.body).not_to include('API vendor or version not found')
+      end
+
+      it 'responds correctly to a v2 request' do
+        versioned_get '/users/hello', 'v2', using: :header, vendor: 'test.a-cool_resource'
+        expect(last_response.body).to eq('two')
+        expect(last_response.body).not_to include('API vendor or version not found')
       end
     end
   end