grape 0.10.1 → 0.11.0

data/spec/grape/exceptions/invalid_accept_header_spec.rb

@@ -0,0 +1,330 @@
+require 'spec_helper'
+
+describe Grape::Exceptions::InvalidAcceptHeader do
+  shared_examples_for 'a valid request' do
+    it 'does return with status 200' do
+      expect(last_response.status).to eq 200
+    end
+    it 'does return the expected result' do
+      expect(last_response.body).to eq('beer received')
+    end
+  end
+  shared_examples_for 'a cascaded request' do
+    it 'does not find a matching route' do
+      expect(last_response.status).to eq 404
+    end
+  end
+  shared_examples_for 'a not-cascaded request' do
+    it 'does not include the X-Cascade=pass header' do
+      expect(last_response.headers['X-Cascade']).to be_nil
+    end
+    it 'does not accept the request' do
+      expect(last_response.status).to eq 406
+    end
+  end
+  shared_examples_for 'a rescued request' do
+    it 'does not include the X-Cascade=pass header' do
+      expect(last_response.headers['X-Cascade']).to be_nil
+    end
+    it 'does show rescue handler processing' do
+      expect(last_response.status).to eq 400
+      expect(last_response.body).to eq('message was processed')
+    end
+  end
+
+  context 'API with cascade=false and rescue_from :all handler' do
+    subject { Class.new(Grape::API) }
+    before {
+      subject.version 'v99', using: :header, vendor: 'vendorname', format: :json, cascade: false
+      subject.rescue_from :all do |e|
+        rack_response 'message was processed', 400, e[:headers]
+      end
+      subject.get '/beer' do
+        'beer received'
+      end
+    }
+
+    def app
+      subject
+    end
+
+    context 'that received a request with correct vendor and version' do
+      before { get '/beer', {}, 'HTTP_ACCEPT' => 'application/vnd.vendorname-v99' }
+      it_should_behave_like 'a valid request'
+    end
+
+    context 'that receives' do
+      context 'an invalid version in the request' do
+        before {
+          get '/beer', {}, 'HTTP_ACCEPT' => 'application/vnd.vendorname-v77',
+                           'CONTENT_TYPE' => 'application/json'
+        }
+        it_should_behave_like 'a rescued request'
+      end
+      context 'an invalid vendor in the request' do
+        before {
+          get '/beer', {}, 'HTTP_ACCEPT' => 'application/vnd.invalidvendor-v99',
+                           'CONTENT_TYPE' => 'application/json'
+        }
+        it_should_behave_like 'a rescued request'
+      end
+    end
+  end
+
+  context 'API with cascade=false and without a rescue handler' do
+    subject { Class.new(Grape::API) }
+    before {
+      subject.version 'v99', using: :header, vendor: 'vendorname', format: :json, cascade: false
+      subject.get '/beer' do
+        'beer received'
+      end
+    }
+
+    def app
+      subject
+    end
+
+    context 'that received a request with correct vendor and version' do
+      before { get '/beer', {}, 'HTTP_ACCEPT' => 'application/vnd.vendorname-v99' }
+      it_should_behave_like 'a valid request'
+    end
+
+    context 'that receives' do
+      context 'an invalid version in the request' do
+        before { get '/beer', {}, 'HTTP_ACCEPT' => 'application/vnd.vendorname-v77' }
+        it_should_behave_like 'a not-cascaded request'
+      end
+      context 'an invalid vendor in the request' do
+        before { get '/beer', {}, 'HTTP_ACCEPT' => 'application/vnd.invalidvendor-v99' }
+        it_should_behave_like 'a not-cascaded request'
+      end
+    end
+  end
+
+  context 'API with cascade=false and with rescue_from :all handler and http_codes' do
+    subject { Class.new(Grape::API) }
+    before {
+      subject.version 'v99', using: :header, vendor: 'vendorname', format: :json, cascade: false
+      subject.rescue_from :all do |e|
+        rack_response 'message was processed', 400, e[:headers]
+      end
+      subject.desc 'Get beer' do
+        failure [[400, 'Bad Request'], [401, 'Unauthorized'], [403, 'Forbidden'],
+                 [404, 'Resource not found'], [406, 'API vendor or version not found'],
+                 [500, 'Internal processing error']]
+      end
+      subject.get '/beer' do
+        'beer received'
+      end
+    }
+
+    def app
+      subject
+    end
+
+    context 'that received a request with correct vendor and version' do
+      before { get '/beer', {}, 'HTTP_ACCEPT' => 'application/vnd.vendorname-v99' }
+      it_should_behave_like 'a valid request'
+    end
+
+    context 'that receives' do
+      context 'an invalid version in the request' do
+        before {
+          get '/beer', {}, 'HTTP_ACCEPT' => 'application/vnd.vendorname-v77',
+                           'CONTENT_TYPE' => 'application/json'
+        }
+        it_should_behave_like 'a rescued request'
+      end
+      context 'an invalid vendor in the request' do
+        before {
+          get '/beer', {}, 'HTTP_ACCEPT' => 'application/vnd.invalidvendor-v99',
+                           'CONTENT_TYPE' => 'application/json'
+        }
+        it_should_behave_like 'a rescued request'
+      end
+    end
+  end
+
+  context 'API with cascade=false, http_codes but without a rescue handler' do
+    subject { Class.new(Grape::API) }
+    before {
+      subject.version 'v99', using: :header, vendor: 'vendorname', format: :json, cascade: false
+      subject.desc 'Get beer' do
+        failure [[400, 'Bad Request'], [401, 'Unauthorized'], [403, 'Forbidden'],
+                 [404, 'Resource not found'], [406, 'API vendor or version not found'],
+                 [500, 'Internal processing error']]
+      end
+      subject.get '/beer' do
+        'beer received'
+      end
+    }
+
+    def app
+      subject
+    end
+
+    context 'that received a request with correct vendor and version' do
+      before { get '/beer', {}, 'HTTP_ACCEPT' => 'application/vnd.vendorname-v99' }
+      it_should_behave_like 'a valid request'
+    end
+
+    context 'that receives' do
+      context 'an invalid version in the request' do
+        before { get '/beer', {}, 'HTTP_ACCEPT' => 'application/vnd.vendorname-v77' }
+        it_should_behave_like 'a not-cascaded request'
+      end
+      context 'an invalid vendor in the request' do
+        before { get '/beer', {}, 'HTTP_ACCEPT' => 'application/vnd.invalidvendor-v99' }
+        it_should_behave_like 'a not-cascaded request'
+      end
+    end
+  end
+
+  context 'API with cascade=true and rescue_from :all handler' do
+    subject { Class.new(Grape::API) }
+    before {
+      subject.version 'v99', using: :header, vendor: 'vendorname', format: :json, cascade: true
+      subject.rescue_from :all do |e|
+        rack_response 'message was processed', 400, e[:headers]
+      end
+      subject.get '/beer' do
+        'beer received'
+      end
+    }
+
+    def app
+      subject
+    end
+
+    context 'that received a request with correct vendor and version' do
+      before { get '/beer', {}, 'HTTP_ACCEPT' => 'application/vnd.vendorname-v99' }
+      it_should_behave_like 'a valid request'
+    end
+
+    context 'that receives' do
+      context 'an invalid version in the request' do
+        before {
+          get '/beer', {}, 'HTTP_ACCEPT' => 'application/vnd.vendorname-v77',
+                           'CONTENT_TYPE' => 'application/json'
+        }
+        it_should_behave_like 'a cascaded request'
+      end
+      context 'an invalid vendor in the request' do
+        before {
+          get '/beer', {}, 'HTTP_ACCEPT' => 'application/vnd.invalidvendor-v99',
+                           'CONTENT_TYPE' => 'application/json'
+        }
+        it_should_behave_like 'a cascaded request'
+      end
+    end
+  end
+
+  context 'API with cascade=true and without a rescue handler' do
+    subject { Class.new(Grape::API) }
+    before {
+      subject.version 'v99', using: :header, vendor: 'vendorname', format: :json, cascade: true
+      subject.get '/beer' do
+        'beer received'
+      end
+    }
+
+    def app
+      subject
+    end
+
+    context 'that received a request with correct vendor and version' do
+      before { get '/beer', {}, 'HTTP_ACCEPT' => 'application/vnd.vendorname-v99' }
+      it_should_behave_like 'a valid request'
+    end
+
+    context 'that receives' do
+      context 'an invalid version in the request' do
+        before { get '/beer', {}, 'HTTP_ACCEPT' => 'application/vnd.vendorname-v77' }
+        it_should_behave_like 'a cascaded request'
+      end
+      context 'an invalid vendor in the request' do
+        before { get '/beer', {}, 'HTTP_ACCEPT' => 'application/vnd.invalidvendor-v99' }
+        it_should_behave_like 'a cascaded request'
+      end
+    end
+  end
+
+  context 'API with cascade=true and with rescue_from :all handler and http_codes' do
+    subject { Class.new(Grape::API) }
+    before {
+      subject.version 'v99', using: :header, vendor: 'vendorname', format: :json, cascade: true
+      subject.rescue_from :all do |e|
+        rack_response 'message was processed', 400, e[:headers]
+      end
+      subject.desc 'Get beer' do
+        failure [[400, 'Bad Request'], [401, 'Unauthorized'], [403, 'Forbidden'],
+                 [404, 'Resource not found'], [406, 'API vendor or version not found'],
+                 [500, 'Internal processing error']]
+      end
+      subject.get '/beer' do
+        'beer received'
+      end
+    }
+
+    def app
+      subject
+    end
+
+    context 'that received a request with correct vendor and version' do
+      before { get '/beer', {}, 'HTTP_ACCEPT' => 'application/vnd.vendorname-v99' }
+      it_should_behave_like 'a valid request'
+    end
+
+    context 'that receives' do
+      context 'an invalid version in the request' do
+        before {
+          get '/beer', {}, 'HTTP_ACCEPT' => 'application/vnd.vendorname-v77',
+                           'CONTENT_TYPE' => 'application/json'
+        }
+        it_should_behave_like 'a cascaded request'
+      end
+      context 'an invalid vendor in the request' do
+        before {
+          get '/beer', {}, 'HTTP_ACCEPT' => 'application/vnd.invalidvendor-v99',
+                           'CONTENT_TYPE' => 'application/json'
+        }
+        it_should_behave_like 'a cascaded request'
+      end
+    end
+  end
+
+  context 'API with cascade=true, http_codes but without a rescue handler' do
+    subject { Class.new(Grape::API) }
+    before {
+      subject.version 'v99', using: :header, vendor: 'vendorname', format: :json, cascade: true
+      subject.desc 'Get beer' do
+        failure [[400, 'Bad Request'], [401, 'Unauthorized'], [403, 'Forbidden'],
+                 [404, 'Resource not found'], [406, 'API vendor or version not found'],
+                 [500, 'Internal processing error']]
+      end
+      subject.get '/beer' do
+        'beer received'
+      end
+    }
+
+    def app
+      subject
+    end
+
+    context 'that received a request with correct vendor and version' do
+      before { get '/beer', {}, 'HTTP_ACCEPT' => 'application/vnd.vendorname-v99' }
+      it_should_behave_like 'a valid request'
+    end
+
+    context 'that receives' do
+      context 'an invalid version in the request' do
+        before { get '/beer', {},  'HTTP_ACCEPT' => 'application/vnd.vendorname-v77' }
+        it_should_behave_like 'a cascaded request'
+      end
+      context 'an invalid vendor in the request' do
+        before { get '/beer', {}, 'HTTP_ACCEPT' => 'application/vnd.invalidvendor-v99' }
+        it_should_behave_like 'a cascaded request'
+      end
+    end
+  end
+end

data/spec/grape/integration/rack_spec.rb

@@ -0,0 +1,32 @@
+require 'spec_helper'
+
+describe Rack do
+  it 'correctly populates params from a Tempfile' do
+    input = Tempfile.new 'rubbish'
+    begin
+      app = Class.new(Grape::API) do
+        format :json
+        post do
+          { params_keys: params.keys }
+        end
+      end
+      input.write({ test: '123' * 10_000 }.to_json)
+      input.rewind
+      options = {
+        input: input,
+        method: 'POST',
+        'CONTENT_TYPE' => 'application/json'
+      }
+      env = Rack::MockRequest.env_for('/', options)
+
+      # requires Rack 1.6.0 to pass
+      # can't check explicitly version of Rack because of https://github.com/rack/rack/issues/773
+      pending 'Rack 1.6.0 is required' unless ::Rack.const_defined?(:TempfileReaper) || RUBY_PLATFORM == 'java'
+
+      expect(JSON.parse(app.call(env)[2].body.first)['params_keys']).to match_array('test')
+    ensure
+      input.close
+      input.unlink
+    end
+  end
+end

data/spec/grape/middleware/base_spec.rb

@@ -34,6 +34,26 @@ describe Grape::Middleware::Base do
     expect(subject.response).to be_kind_of(Rack::Response)
   end
 
+  describe '#response' do
+    subject { Grape::Middleware::Base.new(response) }
+    let(:response) { lambda { |_| [204, { abc: 1 }, 'test'] } }
+
+    it 'status' do
+      subject.call({})
+      expect(subject.response.status).to eq(204)
+    end
+
+    it 'body' do
+      subject.call({})
+      expect(subject.response.body).to eq(['test'])
+    end
+
+    it 'header' do
+      subject.call({})
+      expect(subject.response.header).to have_key(:abc)
+    end
+  end
+
   context 'options' do
     it 'persists options passed at initialization' do
       expect(Grape::Middleware::Base.new(blank_app, abc: true).options[:abc]).to be true

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

@@ -84,14 +84,13 @@ describe Grape::Middleware::Versioner::Header do
     end
 
     it 'fails with 406 Not Acceptable if vendor is invalid' do
-      expect do
-        subject.call('HTTP_ACCEPT' => 'application/vnd.othervendor+json').last
-      end.to throw_symbol(
-        :error,
-        status: 406,
-        headers: { 'X-Cascade' => 'pass' },
-        message: 'API vendor or version not found.'
-      )
+      expect { subject.call('HTTP_ACCEPT' => 'application/vnd.othervendor+json').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 'API vendor or version not found'
+        end
     end
 
     context 'when version is set' do
@@ -112,14 +111,13 @@ describe Grape::Middleware::Versioner::Header do
       end
 
       it 'fails with 406 Not Acceptable if vendor is invalid' do
-        expect do
-          subject.call('HTTP_ACCEPT' => 'application/vnd.othervendor-v1+json').last
-        end.to throw_symbol(
-          :error,
-          status: 406,
-          headers: { 'X-Cascade' => 'pass' },
-          message: 'API vendor or version not found.'
-        )
+        expect { subject.call('HTTP_ACCEPT' => 'application/vnd.othervendor-v1+json').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('API vendor or version not found')
+          end
       end
     end
   end
@@ -142,14 +140,12 @@ describe Grape::Middleware::Versioner::Header do
     end
 
     it 'fails with 406 Not Acceptable if version is invalid' do
-      expect do
-        subject.call('HTTP_ACCEPT' => 'application/vnd.vendor-v2+json').last
-      end.to throw_symbol(
-        :error,
-        status: 406,
-        headers: { 'X-Cascade' => 'pass' },
-        message: 'API vendor or version not found.'
-      )
+      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.headers).to eql('X-Cascade' => 'pass')
+        expect(exception.status).to eql 406
+        expect(exception.message).to include('API vendor or version not found')
+      end
     end
   end
 
@@ -171,47 +167,39 @@ describe Grape::Middleware::Versioner::Header do
     end
 
     it 'fails with 406 Not Acceptable if header is not set' do
-      expect do
-        subject.call({}).last
-      end.to throw_symbol(
-        :error,
-        status: 406,
-        headers: { 'X-Cascade' => 'pass' },
-        message: 'Accept header must be set.'
-      )
+      expect { subject.call({}).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 be set.')
+      end
     end
 
     it 'fails with 406 Not Acceptable if header is empty' do
-      expect do
-        subject.call('HTTP_ACCEPT' => '').last
-      end.to throw_symbol(
-        :error,
-        status: 406,
-        headers: { 'X-Cascade' => 'pass' },
-        message: 'Accept header must be set.'
-      )
+      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 be set.')
+      end
     end
 
     it 'fails with 406 Not Acceptable if type is a range' do
-      expect do
-        subject.call('HTTP_ACCEPT' => '*/*').last
-      end.to throw_symbol(
-        :error,
-        status: 406,
-        headers: { 'X-Cascade' => 'pass' },
-        message: 'Accept header must not contain ranges ("*").'
-      )
+      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 do
-        subject.call('HTTP_ACCEPT' => 'application/*').last
-      end.to throw_symbol(
-        :error,
-        status: 406,
-        headers: { 'X-Cascade' => 'pass' },
-        message: 'Accept header must not contain ranges ("*").'
-      )
+      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
@@ -227,47 +215,39 @@ describe Grape::Middleware::Versioner::Header do
     end
 
     it 'fails with 406 Not Acceptable if header is not set' do
-      expect do
-        subject.call({}).last
-      end.to throw_symbol(
-        :error,
-        status: 406,
-        headers: {},
-        message: 'Accept header must be set.'
-      )
+      expect { subject.call({}).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 header is empty' do
-      expect do
-        subject.call('HTTP_ACCEPT' => '').last
-      end.to throw_symbol(
-        :error,
-        status: 406,
-        headers: {},
-        message: 'Accept header must be set.'
-      )
+      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 do
-        subject.call('HTTP_ACCEPT' => '*/*').last
-      end.to throw_symbol(
-        :error,
-        status: 406,
-        headers: {},
-        message: 'Accept header must not contain ranges ("*").'
-      )
+      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 ("*").')
+      end
     end
 
     it 'fails with 406 Not Acceptable if subtype is a range' do
-      expect do
-        subject.call('HTTP_ACCEPT' => 'application/*').last
-      end.to throw_symbol(
-        :error,
-        status: 406,
-        headers: {},
-        message: 'Accept header must not contain ranges ("*").'
-      )
+      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({})
+        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
@@ -289,14 +269,12 @@ describe Grape::Middleware::Versioner::Header do
     end
 
     it 'fails with another version' do
-      expect do
-        subject.call('HTTP_ACCEPT' => 'application/vnd.vendor-v3+json')
-      end.to throw_symbol(
-        :error,
-        status: 406,
-        headers: { 'X-Cascade' => 'pass' },
-        message: 'API vendor or version not found.'
-      )
+      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.headers).to eql('X-Cascade' => 'pass')
+        expect(exception.status).to eql 406
+        expect(exception.message).to include('API vendor or version not found')
+      end
     end
   end
 end