grape 0.12.0 → 0.14.0

data/spec/grape/endpoint_spec.rb

@@ -11,15 +11,15 @@ describe Grape::Endpoint do
     after { Grape::Endpoint.before_each(nil) }
 
     it 'should be settable via block' do
-      block = lambda { |_endpoint| 'noop' }
+      block = ->(_endpoint) { 'noop' }
       Grape::Endpoint.before_each(&block)
-      expect(Grape::Endpoint.before_each).to eq(block)
+      expect(Grape::Endpoint.before_each.first).to eq(block)
     end
 
     it 'should be settable via reference' do
-      block = lambda { |_endpoint| 'noop' }
+      block = ->(_endpoint) { 'noop' }
       Grape::Endpoint.before_each block
-      expect(Grape::Endpoint.before_each).to eq(block)
+      expect(Grape::Endpoint.before_each.first).to eq(block)
     end
 
     it 'should be able to override a helper' do
@@ -36,6 +36,28 @@ describe Grape::Endpoint do
       Grape::Endpoint.before_each(nil)
       expect { get '/' }.to raise_error(NameError)
     end
+
+    it 'should be able to stack helper' do
+      subject.get('/') do
+        authenticate_user!
+        current_user
+      end
+      expect { get '/' }.to raise_error(NameError)
+
+      Grape::Endpoint.before_each do |endpoint|
+        allow(endpoint).to receive(:current_user).and_return('Bob')
+      end
+
+      Grape::Endpoint.before_each do |endpoint|
+        allow(endpoint).to receive(:authenticate_user!).and_return(true)
+      end
+
+      get '/'
+      expect(last_response.body).to eq('Bob')
+
+      Grape::Endpoint.before_each(nil)
+      expect { get '/' }.to raise_error(NameError)
+    end
   end
 
   describe '#initialize' do
@@ -239,6 +261,16 @@ describe Grape::Endpoint do
       end
     end
 
+    it 'does not work in a before filter' do
+      subject.before do
+        declared(params)
+      end
+      subject.get('/declared') { declared(params) }
+
+      expect { get('/declared') }.to raise_error(
+        Grape::DSL::InsideRoute::MethodNotYetAvailable)
+    end
+
     it 'has as many keys as there are declared params' do
       inner_params = nil
       subject.get '/declared' do
@@ -742,7 +774,7 @@ describe Grape::Endpoint do
       get '/hey'
       expect(last_response.status).to eq 302
       expect(last_response.headers['Location']).to eq '/ha'
-      expect(last_response.body).to eq ''
+      expect(last_response.body).to eq 'This resource has been moved temporarily to /ha.'
     end
 
     it 'has status code 303 if it is not get request and it is http 1.1' do
@@ -752,6 +784,7 @@ describe Grape::Endpoint do
       post '/hey', {}, 'HTTP_VERSION' => 'HTTP/1.1'
       expect(last_response.status).to eq 303
       expect(last_response.headers['Location']).to eq '/ha'
+      expect(last_response.body).to eq 'An alternate resource is located at /ha.'
     end
 
     it 'support permanent redirect' do
@@ -761,7 +794,15 @@ describe Grape::Endpoint do
       get '/hey'
       expect(last_response.status).to eq 301
       expect(last_response.headers['Location']).to eq '/ha'
-      expect(last_response.body).to eq ''
+      expect(last_response.body).to eq 'This resource has been moved permanently to /ha.'
+    end
+
+    it 'allows for an optional redirect body override' do
+      subject.get('/hey') do
+        redirect '/ha', body: 'test body'
+      end
+      get '/hey'
+      expect(last_response.body).to eq 'test body'
     end
   end
 
@@ -941,4 +982,87 @@ describe Grape::Endpoint do
       expect(last_response.body).to eq File.read(__FILE__)
     end
   end
+
+  context 'validation errors' do
+    before do
+      subject.before do
+        header['Access-Control-Allow-Origin'] = '*'
+      end
+      subject.params do
+        requires :id, type: String
+      end
+      subject.get do
+        'should not get here'
+      end
+    end
+
+    it 'returns the errors, and passes headers' do
+      get '/'
+      expect(last_response.status).to eq 400
+      expect(last_response.body).to eq 'id is missing'
+      expect(last_response.headers['Access-Control-Allow-Origin']).to eq('*')
+    end
+  end
+
+  context 'instrumentation' do
+    before do
+      subject.before do
+        # Placeholder
+      end
+      subject.get do
+        'hello'
+      end
+
+      @events = []
+      @subscriber = ActiveSupport::Notifications.subscribe(/grape/) do |*args|
+        @events << ActiveSupport::Notifications::Event.new(*args)
+      end
+    end
+
+    after do
+      ActiveSupport::Notifications.unsubscribe(@subscriber)
+    end
+
+    it 'notifies AS::N' do
+      get '/'
+
+      # In order that the events finalized (time each block ended)
+      expect(@events).to contain_exactly(
+        have_attributes(name: 'endpoint_run_filters.grape', payload: { endpoint: a_kind_of(Grape::Endpoint),
+                                                                       filters: a_collection_containing_exactly(an_instance_of(Proc)),
+                                                                       type: :before }),
+        have_attributes(name: 'endpoint_run_filters.grape', payload: { endpoint: a_kind_of(Grape::Endpoint),
+                                                                       filters: [],
+                                                                       type: :before_validation }),
+        have_attributes(name: 'endpoint_run_filters.grape', payload: { endpoint: a_kind_of(Grape::Endpoint),
+                                                                       filters: [],
+                                                                       type: :after_validation }),
+        have_attributes(name: 'endpoint_render.grape',      payload: { endpoint: a_kind_of(Grape::Endpoint) }),
+        have_attributes(name: 'endpoint_run_filters.grape', payload: { endpoint: a_kind_of(Grape::Endpoint),
+                                                                       filters: [],
+                                                                       type: :after }),
+        have_attributes(name: 'endpoint_run.grape', payload: { endpoint: a_kind_of(Grape::Endpoint),
+                                                               env: an_instance_of(Hash) })
+      )
+
+      # In order that events were initialized
+      expect(@events.sort_by(&:time)).to contain_exactly(
+        have_attributes(name: 'endpoint_run.grape', payload: { endpoint: a_kind_of(Grape::Endpoint),
+                                                               env: an_instance_of(Hash) }),
+        have_attributes(name: 'endpoint_run_filters.grape', payload: { endpoint: a_kind_of(Grape::Endpoint),
+                                                                       filters: a_collection_containing_exactly(an_instance_of(Proc)),
+                                                                       type: :before }),
+        have_attributes(name: 'endpoint_run_filters.grape', payload: { endpoint: a_kind_of(Grape::Endpoint),
+                                                                       filters: [],
+                                                                       type: :before_validation }),
+        have_attributes(name: 'endpoint_run_filters.grape', payload: { endpoint: a_kind_of(Grape::Endpoint),
+                                                                       filters: [],
+                                                                       type: :after_validation }),
+        have_attributes(name: 'endpoint_render.grape',      payload: { endpoint: a_kind_of(Grape::Endpoint) }),
+        have_attributes(name: 'endpoint_run_filters.grape', payload: { endpoint: a_kind_of(Grape::Endpoint),
+                                                                       filters: [],
+                                                                       type: :after })
+      )
+    end
+  end
 end

data/spec/grape/entity_spec.rb

@@ -45,22 +45,24 @@ describe Grape::Entity do
       entity = Class.new(Grape::Entity)
       allow(entity).to receive(:represent).and_return('Hiya')
 
-      class TestObject
-      end
+      module EntitySpec
+        class TestObject
+        end
 
-      class FakeCollection
-        def first
-          TestObject.new
+        class FakeCollection
+          def first
+            TestObject.new
+          end
         end
       end
 
-      subject.represent TestObject, with: entity
+      subject.represent EntitySpec::TestObject, with: entity
       subject.get '/example' do
-        present [TestObject.new]
+        present [EntitySpec::TestObject.new]
       end
 
       subject.get '/example2' do
-        present FakeCollection.new
+        present EntitySpec::FakeCollection.new
       end
 
       get '/example'

data/spec/grape/exceptions/invalid_accept_header_spec.rb

@@ -54,13 +54,6 @@ describe Grape::Exceptions::InvalidAcceptHeader do
     end
 
     context 'that receives' do
-      context 'an invalid version in the request' do
-        before do
-          get '/beer', {}, 'HTTP_ACCEPT' => 'application/vnd.vendorname-v77',
-                           'CONTENT_TYPE' => 'application/json'
-        end
-        it_should_behave_like 'a rescued request'
-      end
       context 'an invalid vendor in the request' do
         before do
           get '/beer', {}, 'HTTP_ACCEPT' => 'application/vnd.invalidvendor-v99',
@@ -128,13 +121,6 @@ describe Grape::Exceptions::InvalidAcceptHeader do
     end
 
     context 'that receives' do
-      context 'an invalid version in the request' do
-        before do
-          get '/beer', {}, 'HTTP_ACCEPT' => 'application/vnd.vendorname-v77',
-                           'CONTENT_TYPE' => 'application/json'
-        end
-        it_should_behave_like 'a rescued request'
-      end
       context 'an invalid vendor in the request' do
         before do
           get '/beer', {}, 'HTTP_ACCEPT' => 'application/vnd.invalidvendor-v99',
@@ -318,7 +304,7 @@ describe Grape::Exceptions::InvalidAcceptHeader do
 
     context 'that receives' do
       context 'an invalid version in the request' do
-        before { get '/beer', {},  'HTTP_ACCEPT' => 'application/vnd.vendorname-v77' }
+        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

data/spec/grape/exceptions/validation_errors_spec.rb

@@ -5,6 +5,22 @@ describe Grape::Exceptions::ValidationErrors do
   let(:validation_message) { 'FooBar is invalid' }
   let(:validation_error) { OpenStruct.new(params: [validation_message]) }
 
+  context 'initialize' do
+    let(:headers) {
+      {
+        'A-Header-Key' => 'A-Header-Value'
+      }
+    }
+
+    subject do
+      described_class.new(errors: [validation_error], headers: headers)
+    end
+
+    it 'should assign headers through base class' do
+      expect(subject.headers).to eq(headers)
+    end
+  end
+
   context 'message' do
     context 'is not repeated' do
       let(:error) do
@@ -17,6 +33,18 @@ describe Grape::Exceptions::ValidationErrors do
     end
   end
 
+  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') }
+      subject { described_class.new(errors: [validation_error_1, validation_error_2]).full_messages }
+
+      it 'returns an array with each errors full message' do
+        expect(subject).to contain_exactly('id is missing', 'name is missing')
+      end
+    end
+  end
+
   context 'api' do
     subject { Class.new(Grape::API) }
 

data/spec/grape/integration/rack_spec.rb

@@ -20,8 +20,9 @@ describe Rack do
       env = Rack::MockRequest.env_for('/', options)
 
       unless RUBY_PLATFORM == 'java'
-        major, minor, release = Rack.release.split('.').map(&:to_i)
-        pending 'Rack 1.5.3 or 1.6.1 required' unless major >= 1 && ((minor == 5 && release >= 3) || (minor >= 6))
+        major, minor, patch = Rack.release.split('.').map(&:to_i)
+        patch ||= 0 # rack <= 1.5.2 does not specify patch version
+        pending 'Rack 1.5.3 or 1.6.1 required' unless major >= 1 && ((minor == 5 && patch >= 3) || (minor >= 6))
       end
 
       expect(JSON.parse(app.call(env)[2].body.first)['params_keys']).to match_array('test')

data/spec/grape/middleware/base_spec.rb

@@ -36,21 +36,43 @@ describe Grape::Middleware::Base do
 
   describe '#response' do
     subject { Grape::Middleware::Base.new(response) }
-    let(:response) { ->(_) { [204, { abc: 1 }, 'test'] } }
 
-    it 'status' do
-      subject.call({})
-      expect(subject.response.status).to eq(204)
-    end
+    context Array do
+      let(:response) { ->(_) { [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'])
+      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
 
-    it 'header' do
-      subject.call({})
-      expect(subject.response.header).to have_key(:abc)
+    context Rack::Response do
+      let(:response) { ->(_) { Rack::Response.new('test', 204, abc: 1) } }
+
+      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
   end
 
@@ -60,18 +82,20 @@ describe Grape::Middleware::Base do
     end
 
     context 'defaults' do
-      class ExampleWare < Grape::Middleware::Base
-        def default_options
-          { monkey: true }
+      module BaseSpec
+        class ExampleWare < Grape::Middleware::Base
+          def default_options
+            { monkey: true }
+          end
         end
       end
 
       it 'persists the default options' do
-        expect(ExampleWare.new(blank_app).options[:monkey]).to be true
+        expect(BaseSpec::ExampleWare.new(blank_app).options[:monkey]).to be true
       end
 
       it 'overrides default options when provided' do
-        expect(ExampleWare.new(blank_app, monkey: false).options[:monkey]).to be false
+        expect(BaseSpec::ExampleWare.new(blank_app, monkey: false).options[:monkey]).to be false
       end
     end
   end

data/spec/grape/middleware/error_spec.rb

@@ -11,14 +11,15 @@ describe Grape::Middleware::Error do
         'static text'
       end
     end
-  end
-  class ErrApp
-    class << self
-      attr_accessor :error
-      attr_accessor :format
 
-      def call(_env)
-        throw :error, error
+    class ErrApp
+      class << self
+        attr_accessor :error
+        attr_accessor :format
+
+        def call(_env)
+          throw :error, error
+        end
       end
     end
   end
@@ -28,32 +29,32 @@ describe Grape::Middleware::Error do
     Rack::Builder.app do
       use Spec::Support::EndpointFaker
       use Grape::Middleware::Error, opts
-      run ErrApp
+      run ErrorSpec::ErrApp
     end
   end
 
-  let(:options) {  { default_message: 'Aww, hamburgers.' } }
+  let(:options) { { default_message: 'Aww, hamburgers.' } }
 
   it 'sets the status code appropriately' do
-    ErrApp.error = { status: 410 }
+    ErrorSpec::ErrApp.error = { status: 410 }
     get '/'
     expect(last_response.status).to eq(410)
   end
 
   it 'sets the error message appropriately' do
-    ErrApp.error = { message: 'Awesome stuff.' }
+    ErrorSpec::ErrApp.error = { message: 'Awesome stuff.' }
     get '/'
     expect(last_response.body).to eq('Awesome stuff.')
   end
 
   it 'defaults to a 500 status' do
-    ErrApp.error = {}
+    ErrorSpec::ErrApp.error = {}
     get '/'
     expect(last_response.status).to eq(500)
   end
 
   it 'has a default message' do
-    ErrApp.error = {}
+    ErrorSpec::ErrApp.error = {}
     get '/'
     expect(last_response.body).to eq('Aww, hamburgers.')
   end
@@ -61,14 +62,14 @@ describe Grape::Middleware::Error do
   context 'with http code' do
     let(:options) {  { default_message: 'Aww, hamburgers.' } }
     it 'adds the status code if wanted' do
-      ErrApp.error = { message: { code: 200 } }
+      ErrorSpec::ErrApp.error = { message: { code: 200 } }
       get '/'
 
       expect(last_response.body).to eq({ code: 200 }.to_json)
     end
 
     it 'presents an error message' do
-      ErrApp.error = { message: { code: 200, with: ErrorSpec::ErrorEntity } }
+      ErrorSpec::ErrApp.error = { message: { code: 200, with: ErrorSpec::ErrorEntity } }
       get '/'
 
       expect(last_response.body).to eq({ code: 200, static: 'static text' }.to_json)

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 '/'