grape 0.14.0 → 0.15.0

data/spec/grape/endpoint_spec.rb

@@ -10,19 +10,19 @@ describe Grape::Endpoint do
   describe '.before_each' do
     after { Grape::Endpoint.before_each(nil) }
 
-    it 'should be settable via block' do
+    it 'is settable via block' do
       block = ->(_endpoint) { 'noop' }
       Grape::Endpoint.before_each(&block)
       expect(Grape::Endpoint.before_each.first).to eq(block)
     end
 
-    it 'should be settable via reference' do
+    it 'is settable via reference' do
       block = ->(_endpoint) { 'noop' }
       Grape::Endpoint.before_each block
       expect(Grape::Endpoint.before_each.first).to eq(block)
     end
 
-    it 'should be able to override a helper' do
+    it 'is able to override a helper' do
       subject.get('/') { current_user }
       expect { get '/' }.to raise_error(NameError)
 
@@ -37,7 +37,7 @@ describe Grape::Endpoint do
       expect { get '/' }.to raise_error(NameError)
     end
 
-    it 'should be able to stack helper' do
+    it 'is able to stack helper' do
       subject.get('/') do
         authenticate_user!
         current_user
@@ -887,13 +887,64 @@ describe Grape::Endpoint do
         expect(last_response.body).to eq('body')
       end
     end
+
+    it 'allows adding to response with present' do
+      subject.format :json
+      subject.before { present :before, 'before' }
+      subject.before_validation { present :before_validation, 'before_validation' }
+      subject.after_validation { present :after_validation, 'after_validation' }
+      subject.after { present :after, 'after' }
+      subject.get :all_filters do
+        present :endpoint, 'endpoint'
+      end
+
+      get '/all_filters'
+      json = JSON.parse(last_response.body)
+      expect(json.keys).to match_array %w(before before_validation after_validation endpoint after)
+    end
+
+    context 'when terminating the response with error!' do
+      it 'breaks normal call chain' do
+        called = []
+        subject.before { called << 'before' }
+        subject.before_validation { called << 'before_validation' }
+        subject.after_validation { error! :oops, 500 }
+        subject.after { called << 'after' }
+        subject.get :error_filters do
+          called << 'endpoint'
+          ''
+        end
+
+        get '/error_filters'
+        expect(last_response.status).to eql 500
+        expect(called).to match_array %w(before before_validation)
+      end
+
+      it 'allows prior and parent filters of same type to run' do
+        called = []
+        subject.before { called << 'parent' }
+        subject.namespace :parent do
+          before { called << 'prior' }
+          before { error! :oops, 500 }
+          before { called << 'subsequent' }
+          get :hello do
+            called << :endpoint
+            'Hello!'
+          end
+        end
+
+        get '/parent/hello'
+        expect(last_response.status).to eql 500
+        expect(called).to match_array %w(parent prior)
+      end
+    end
   end
 
   context 'anchoring' do
     verbs = %w(post get head delete put options patch)
 
     verbs.each do |verb|
-      it 'allows for the anchoring option with a #{verb.upcase} method' do
+      it "allows for the anchoring option with a #{verb.upcase} method" do
         subject.send(verb, '/example', anchor: true) do
           verb
         end
@@ -901,7 +952,7 @@ describe Grape::Endpoint do
         expect(last_response.status).to eql 404
       end
 
-      it 'anchors paths by default for the #{verb.upcase} method' do
+      it "anchors paths by default for the #{verb.upcase} method" do
         subject.send(verb, '/example') do
           verb
         end
@@ -909,7 +960,7 @@ describe Grape::Endpoint do
         expect(last_response.status).to eql 404
       end
 
-      it 'responds to /example/and/some/more for the non-anchored #{verb.upcase} method' do
+      it "responds to /example/and/some/more for the non-anchored #{verb.upcase} method" do
         subject.send(verb, '/example', anchor: false) do
           verb
         end
@@ -921,7 +972,7 @@ describe Grape::Endpoint do
   end
 
   context 'request' do
-    it 'should be set to the url requested' do
+    it 'is set to the url requested' do
       subject.get('/url') do
         request.url
       end
@@ -929,7 +980,7 @@ describe Grape::Endpoint do
       expect(last_response.body).to eq('http://example.org/url')
     end
     ['v1', :v1].each do |version|
-      it 'should include version #{version}' do
+      it "should include version #{version}" do
         subject.version version, using: :path
         subject.get('/url') do
           request.url

data/spec/grape/exceptions/validation_errors_spec.rb

@@ -35,8 +35,8 @@ describe Grape::Exceptions::ValidationErrors do
 
   describe '#full_messages' do
     context 'with errors' do
-      let(:validation_error_1) { Grape::Exceptions::Validation.new(params: ['id'], message_key: 'presence') }
-      let(:validation_error_2) { Grape::Exceptions::Validation.new(params: ['name'], message_key: 'presence') }
+      let(:validation_error_1) { Grape::Exceptions::Validation.new(params: ['id'], message: :presence) }
+      let(:validation_error_2) { Grape::Exceptions::Validation.new(params: ['name'], message: :presence) }
       subject { described_class.new(errors: [validation_error_1, validation_error_2]).full_messages }
 
       it 'returns an array with each errors full message' do

data/spec/grape/exceptions/validation_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+describe Grape::Exceptions::Validation do
+  it 'fails when params are missing' do
+    expect { Grape::Exceptions::Validation.new(message: 'presence') }.to raise_error(RuntimeError, 'Params are missing:')
+  end
+end

data/spec/grape/integration/rack_sendfile_spec.rb

@@ -0,0 +1,44 @@
+require 'spec_helper'
+
+describe Rack::Sendfile do
+  subject do
+    send_file = file_streamer
+    app = Class.new(Grape::API) do
+      use Rack::Sendfile
+      format :json
+      get do
+        file send_file
+      end
+    end
+
+    options = {
+      method: 'GET',
+      'HTTP_X_SENDFILE_TYPE' => 'X-Accel-Redirect',
+      'HTTP_X_ACCEL_MAPPING' => '/accel/mapping/=/replaced/'
+    }
+    env = Rack::MockRequest.env_for('/', options)
+    app.call(env)
+  end
+
+  context do
+    let(:file_streamer) do
+      double(:file_streamer, to_path: '/accel/mapping/some/path')
+    end
+
+    it 'contains Sendfile headers' do
+      headers = subject[1]
+      expect(headers).to include('X-Accel-Redirect')
+    end
+  end
+
+  context do
+    let(:file_streamer) do
+      double(:file_streamer)
+    end
+
+    it 'not contains Sendfile headers' do
+      headers = subject[1]
+      expect(headers).to_not include('X-Accel-Redirect')
+    end
+  end
+end

data/spec/grape/middleware/base_spec.rb

@@ -29,6 +29,44 @@ describe Grape::Middleware::Base do
     after { subject.call!({}) }
   end
 
+  context 'callbacks on error' do
+    let(:blank_app) { ->(_) { fail StandardError } }
+
+    it 'calls #after' do
+      expect(subject).to receive(:after)
+      expect { subject.call({}) }.to raise_error(StandardError)
+    end
+  end
+
+  context 'after callback' do
+    before do
+      allow(subject).to receive(:after).and_return([200, {}, 'Hello from after callback'])
+    end
+
+    it 'overwrites application response' do
+      expect(subject.call!({}).last).to eq('Hello from after callback')
+    end
+  end
+
+  context 'after callback with errors' do
+    it 'does not overwrite the application response' do
+      expect(subject.call({})).to eq([200, {}, 'Hi there.'])
+    end
+
+    context 'with patched warnings' do
+      before do
+        @warnings = warnings = []
+        allow_any_instance_of(Grape::Middleware::Base).to receive(:warn) { |m| warnings << m }
+        allow(subject).to receive(:after).and_raise(StandardError)
+      end
+
+      it 'does show a warning' do
+        expect { subject.call({}) }.to raise_error(StandardError)
+        expect(@warnings).not_to be_empty
+      end
+    end
+  end
+
   it 'is able to access the response' do
     subject.call({})
     expect(subject.response).to be_kind_of(Rack::Response)
@@ -99,4 +137,66 @@ describe Grape::Middleware::Base do
       end
     end
   end
+
+  context 'header' do
+    module HeaderSpec
+      class ExampleWare < Grape::Middleware::Base
+        def before
+          header 'X-Test-Before', 'Hi'
+        end
+
+        def after
+          header 'X-Test-After', 'Bye'
+          nil
+        end
+      end
+    end
+
+    def app
+      Rack::Builder.app do
+        use HeaderSpec::ExampleWare
+        run ->(_) { [200, {}, ['Yeah']] }
+      end
+    end
+
+    it 'is able to set a header' do
+      get '/'
+      expect(last_response.headers['X-Test-Before']).to eq('Hi')
+      expect(last_response.headers['X-Test-After']).to eq('Bye')
+    end
+  end
+
+  context 'header overwrite' do
+    module HeaderOverwritingSpec
+      class ExampleWare < Grape::Middleware::Base
+        def before
+          header 'X-Test-Overwriting', 'Hi'
+        end
+
+        def after
+          header 'X-Test-Overwriting', 'Bye'
+          nil
+        end
+      end
+
+      class API < Grape::API
+        get('/') do
+          header 'X-Test-Overwriting', 'Yeah'
+          'Hello'
+        end
+      end
+    end
+
+    def app
+      Rack::Builder.app do
+        use HeaderOverwritingSpec::ExampleWare
+        run HeaderOverwritingSpec::API.new
+      end
+    end
+
+    it 'overwrites header by after headers' do
+      get '/'
+      expect(last_response.headers['X-Test-Overwriting']).to eq('Bye')
+    end
+  end
 end

data/spec/grape/middleware/exception_spec.rb

@@ -1,5 +1,4 @@
 require 'spec_helper'
-require 'active_support/core_ext/hash'
 
 describe Grape::Middleware::Error do
   # raises a text exception
@@ -59,7 +58,7 @@ describe Grape::Middleware::Error do
       use Grape::Middleware::Error
       run ExceptionSpec::ExceptionApp
     end
-    expect { get '/' }.to raise_error
+    expect { get '/' }.to raise_error(RuntimeError, 'rain!')
   end
 
   context 'with rescue_all set to true' do

data/spec/grape/middleware/formatter_spec.rb

@@ -50,7 +50,7 @@ describe Grape::Middleware::Formatter do
   context 'error handling' do
     let(:formatter) { double(:formatter) }
     before do
-      allow(Grape::Formatter::Base).to receive(:formatter_for) { formatter }
+      allow(Grape::Formatter).to receive(:formatter_for) { formatter }
     end
 
     it 'rescues formatter-specific exceptions' do
@@ -66,7 +66,7 @@ describe Grape::Middleware::Formatter do
 
       expect do
         catch(:error) { subject.call('PATH_INFO' => '/somewhere.xml', 'HTTP_ACCEPT' => 'application/json') }
-      end.to raise_error
+      end.to raise_error(StandardError)
     end
   end
 
@@ -282,4 +282,14 @@ describe Grape::Middleware::Formatter do
       end
     end
   end
+
+  context 'send file' do
+    let(:app) { ->(_env) { [200, {}, @body] } }
+
+    it 'returns Grape::Uril::SendFileReponse' do
+      @body = Grape::Util::FileResponse.new('file')
+      env = { 'PATH_INFO' => '/somewhere', 'HTTP_ACCEPT' => 'application/json' }
+      expect(subject.call(env)).to be_a(Grape::Util::SendfileResponse)
+    end
+  end
 end

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

@@ -85,7 +85,7 @@ describe Grape::Middleware::Versioner::AcceptVersionHeader do
     end
   end
 
-  context 'when :strict and :cascade=>false are set' do
+  context 'when :strict and cascade: false' do
     before do
       @options[:versions] = ['v1']
       @options[:version_options][:strict] = true

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

@@ -189,7 +189,7 @@ describe Grape::Middleware::Versioner::Header do
     end
   end
 
-  context 'when :strict and :cascade=>false are set' do
+  context 'when :strict and cascade: false' do
     before do
       @options[:versions] = ['v1']
       @options[:version_options][:strict] = true
@@ -224,6 +224,16 @@ describe Grape::Middleware::Versioner::Header do
       end
     end
 
+    it 'fails with 406 Not Acceptable if header contains a single invalid accept' do
+      expect { subject.call('HTTP_ACCEPT' => 'application/json;application/vnd.vendor-v1+json').first }
+        .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('API vendor or version not found.')
+      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

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

@@ -22,7 +22,7 @@ describe Grape::Middleware::Versioner::Param do
   end
 
   context 'with specified parameter name' do
-    before { @options = { parameter: 'v' } }
+    before { @options = { version_options: { parameter: 'v' } } }
     it 'sets the API version based on the custom parameter name' do
       env = Rack::MockRequest.env_for('/awesome', params: { 'v' => 'v1' })
       expect(subject.call(env)[1]['api.version']).to eq('v1')
@@ -53,4 +53,108 @@ describe Grape::Middleware::Versioner::Param do
     env = Rack::MockRequest.env_for('/awesome', params: {})
     expect(subject.call(env).first).to eq(200)
   end
+
+  context 'when there are multiple versions without a custom param' do
+    subject { Class.new(Grape::API) }
+
+    let(:v1_app) do
+      Class.new(Grape::API) do
+        version 'v1', using: :param
+        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
+    end
+
+    let(:v2_app) do
+      Class.new(Grape::API) do
+        version 'v2', using: :param
+        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
+    end
+
+    def app
+      subject.mount v2_app
+      subject.mount v1_app
+      subject
+    end
+
+    it 'responds correctly to a v1 request' do
+      versioned_get '/users/hello', 'v1', using: :param, parameter: :apiver
+      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: :param, parameter: :apiver
+      expect(last_response.body).to eq('two')
+      expect(last_response.body).not_to include('API vendor or version not found')
+    end
+  end
+
+  context 'when there are multiple versions with a custom param' do
+    subject { Class.new(Grape::API) }
+
+    let(:v1_app) do
+      Class.new(Grape::API) do
+        version 'v1', using: :param, parameter: 'v'
+        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
+    end
+
+    let(:v2_app) do
+      Class.new(Grape::API) do
+        version 'v2', using: :param, parameter: 'v'
+        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
+    end
+
+    def app
+      subject.mount v2_app
+      subject.mount v1_app
+      subject
+    end
+
+    it 'responds correctly to a v1 request' do
+      versioned_get '/users/hello', 'v1', using: :param, parameter: 'v'
+      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: :param, parameter: 'v'
+      expect(last_response.body).to eq('two')
+      expect(last_response.body).not_to include('API vendor or version not found')
+    end
+  end
 end