grape 1.7.0 → 1.8.0

data/spec/grape/api/custom_validations_spec.rb

@@ -1,48 +1,17 @@
 # frozen_string_literal: true
 
-describe Grape::Validations do
-  context 'deprecated Grape::Validations::Base' do
-    subject do
-      Class.new(Grape::API) do
-        params do
-          requires :text, validator_with_old_base: true
-        end
-        get do
-        end
-      end
-    end
-
-    let(:validator_with_old_base) do
-      Class.new(Grape::Validations::Base) do
-        def validate_param!(_attr_name, _params)
-          true
-        end
-      end
-    end
-
-    before do
-      described_class.register_validator('validator_with_old_base', validator_with_old_base)
-      allow(Warning).to receive(:warn)
-    end
+require 'shared/deprecated_class_examples'
 
-    after do
-      described_class.deregister_validator('validator_with_old_base')
-    end
-
-    def app
-      subject
+describe Grape::Validations do
+  describe 'Grape::Validations::Base' do
+    let(:deprecated_class) do
+      Class.new(Grape::Validations::Base)
     end
 
-    it 'puts a deprecation warning' do
-      expect(Warning).to receive(:warn) do |message|
-        expect(message).to include('`Grape::Validations::Base` is deprecated')
-      end
-
-      get '/'
-    end
+    it_behaves_like 'deprecated class'
   end
 
-  context 'using a custom length validator' do
+  describe 'using a custom length validator' do
     subject do
       Class.new(Grape::API) do
         params do
@@ -64,6 +33,7 @@ describe Grape::Validations do
         end
       end
     end
+    let(:app) { Rack::Builder.new(subject) }
 
     before do
       described_class.register_validator('default_length', default_length_validator)
@@ -73,10 +43,6 @@ describe Grape::Validations do
       described_class.deregister_validator('default_length')
     end
 
-    def app
-      subject
-    end
-
     it 'under 140 characters' do
       get '/', text: 'abc'
       expect(last_response.status).to eq 200
@@ -96,7 +62,7 @@ describe Grape::Validations do
     end
   end
 
-  context 'using a custom body-only validator' do
+  describe 'using a custom body-only validator' do
     subject do
       Class.new(Grape::API) do
         params do
@@ -115,6 +81,7 @@ describe Grape::Validations do
         end
       end
     end
+    let(:app) { Rack::Builder.new(subject) }
 
     before do
       described_class.register_validator('in_body', in_body_validator)
@@ -124,10 +91,6 @@ describe Grape::Validations do
       described_class.deregister_validator('in_body')
     end
 
-    def app
-      subject
-    end
-
     it 'allows field in body' do
       get '/', text: 'abc'
       expect(last_response.status).to eq 200
@@ -141,7 +104,7 @@ describe Grape::Validations do
     end
   end
 
-  context 'using a custom validator with message_key' do
+  describe 'using a custom validator with message_key' do
     subject do
       Class.new(Grape::API) do
         params do
@@ -160,6 +123,7 @@ describe Grape::Validations do
         end
       end
     end
+    let(:app) { Rack::Builder.new(subject) }
 
     before do
       described_class.register_validator('with_message_key', message_key_validator)
@@ -169,10 +133,6 @@ describe Grape::Validations do
       described_class.deregister_validator('with_message_key')
     end
 
-    def app
-      subject
-    end
-
     it 'fails with message' do
       get '/', text: 'foobar'
       expect(last_response.status).to eq 400
@@ -180,7 +140,7 @@ describe Grape::Validations do
     end
   end
 
-  context 'using a custom request/param validator' do
+  describe 'using a custom request/param validator' do
     subject do
       Class.new(Grape::API) do
         params do
@@ -208,6 +168,7 @@ describe Grape::Validations do
         end
       end
     end
+    let(:app) { Rack::Builder.new(subject) }
 
     before do
       described_class.register_validator('admin', admin_validator)
@@ -217,10 +178,6 @@ describe Grape::Validations do
       described_class.deregister_validator('admin')
     end
 
-    def app
-      subject
-    end
-
     it 'fail when non-admin user sets an admin field' do
       get '/', admin_field: 'tester', non_admin_field: 'toaster'
       expect(last_response.status).to eq 400

data/spec/grape/api_remount_spec.rb

@@ -147,6 +147,42 @@ describe Grape::API do
         end
       end
 
+      context 'when the params are configured via a configuration' do
+        subject(:a_remounted_api) do
+          Class.new(described_class) do
+            params do
+              requires configuration[:required_attr_name], type: String
+            end
+
+            get(mounted { configuration[:endpoint] }) do
+              status 200
+            end
+          end
+        end
+
+        context 'when the configured param is my_attr' do
+          it 'requires the configured params' do
+            root_api.mount a_remounted_api, with: {
+              required_attr_name: 'my_attr',
+              endpoint: 'test'
+            }
+            get 'test?another_attr=1'
+            expect(last_response.status).to eq 400
+            get 'test?my_attr=1'
+            expect(last_response.status).to eq 200
+
+            root_api.mount a_remounted_api, with: {
+              required_attr_name: 'another_attr',
+              endpoint: 'test_b'
+            }
+            get 'test_b?another_attr=1'
+            expect(last_response.status).to eq 200
+            get 'test_b?my_attr=1'
+            expect(last_response.status).to eq 400
+          end
+        end
+      end
+
       context 'when executing a standard block within a `mounted` block with all dynamic params' do
         subject(:a_remounted_api) do
           Class.new(described_class) do

data/spec/grape/api_spec.rb

@@ -103,22 +103,6 @@ describe Grape::API do
         }
       end
     end
-
-    # Behavior as defined by rfc2616 when no header is defined
-    # http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html
-    describe 'no specified accept header' do
-      # subject.version 'v1', using: :header
-      # subject.get '/hello' do
-      #   'hello'
-      # end
-
-      # it 'routes' do
-      #   get '/hello'
-      #   last_response.status.should eql 200
-      # end
-    end
-
-    # pending 'routes if any media type is allowed'
   end
 
   describe '.version using accept_version_header' do
@@ -448,9 +432,10 @@ describe Grape::API do
       expect(last_response.body).to eql 'hiya'
     end
 
+    objects = ['string', :symbol, 1, -1.1, {}, [], true, false, nil].freeze
     %i[put post].each do |verb|
       context verb.to_s do
-        ['string', :symbol, 1, -1.1, {}, [], true, false, nil].each do |object|
+        objects.each do |object|
           it "allows a(n) #{object.class} json object in params" do
             subject.format :json
             subject.send(verb) do
@@ -1601,7 +1586,7 @@ describe Grape::API do
 
       subject.get(:hello) { 'Hello, world.' }
       get '/hello', {}, 'HTTP_AUTHORIZATION' => encode_basic_auth('allow', 'whatever')
-      expect(basic_auth_context).to be_a_kind_of(Grape::Endpoint)
+      expect(basic_auth_context).to be_a(Grape::Endpoint)
     end
 
     it 'has access to helper methods' do
@@ -3067,7 +3052,7 @@ describe Grape::API do
       expect(route.description).to eq('first method')
       expect(route.route_foo).to be_nil
       expect(route.params).to eq({})
-      expect(route.options).to be_a_kind_of(Hash)
+      expect(route.options).to be_a(Hash)
     end
 
     it 'has params which does not include format and version as named captures' do
@@ -3326,7 +3311,7 @@ describe Grape::API do
       it 'is able to cascade' do
         subject.mount lambda { |env|
           headers = {}
-          headers['X-Cascade'] == 'pass' unless env['PATH_INFO'].include?('boo')
+          headers['X-Cascade'] == 'pass' if env['PATH_INFO'].exclude?('boo')
           [200, headers, ['Farfegnugen']]
         } => '/'
 
@@ -3725,7 +3710,7 @@ describe Grape::API do
     it 'sets the instance' do
       expect(subject.instance).to be_nil
       subject.compile
-      expect(subject.instance).to be_kind_of(subject.base_instance)
+      expect(subject.instance).to be_a(subject.base_instance)
     end
   end
 
@@ -4241,6 +4226,15 @@ describe Grape::API do
       end
     end
 
+    it 'does not override methods inherited from Class' do
+      Class.define_method(:test_method) {}
+      subclass = Class.new(described_class)
+      expect(subclass).not_to receive(:add_setup)
+      subclass.test_method
+    ensure
+      Class.remove_method(:test_method)
+    end
+
     context 'overriding via composition' do
       module Inherited
         def inherited(api)

data/spec/grape/dsl/desc_spec.rb

@@ -1,99 +1,98 @@
 # frozen_string_literal: true
 
-module Grape
-  module DSL
-    module DescSpec
-      class Dummy
-        extend Grape::DSL::Desc
-      end
+describe Grape::DSL::Desc do
+  subject { dummy_class }
+
+  let(:dummy_class) do
+    Class.new do
+      extend Grape::DSL::Desc
     end
-    describe Desc do
-      subject { Class.new(DescSpec::Dummy) }
+  end
 
-      describe '.desc' do
-        it 'sets a description' do
-          desc_text = 'The description'
-          options = { message: 'none' }
-          subject.desc desc_text, options
-          expect(subject.namespace_setting(:description)).to eq(options.merge(description: desc_text))
-          expect(subject.route_setting(:description)).to eq(options.merge(description: desc_text))
-        end
+  describe '.desc' do
+    it 'sets a description' do
+      desc_text = 'The description'
+      options = { message: 'none' }
+      subject.desc desc_text, options
+      expect(subject.namespace_setting(:description)).to eq(options.merge(description: desc_text))
+      expect(subject.route_setting(:description)).to eq(options.merge(description: desc_text))
+    end
 
-        it 'can be set with a block' do
-          expected_options = {
-            summary: 'summary',
-            description: 'The description',
-            detail: 'more details',
-            params: { first: :param },
-            entity: Object,
-            http_codes: [[401, 'Unauthorized', 'Entities::Error']],
-            named: 'My named route',
-            body_name: 'My body name',
-            headers: [
-              XAuthToken: {
-                description: 'Valdates your identity',
-                required: true
-              },
-              XOptionalHeader: {
-                description: 'Not really needed',
-                required: false
-              }
-            ],
-            hidden: false,
-            deprecated: false,
-            is_array: true,
-            nickname: 'nickname',
-            produces: %w[array of mime_types],
-            consumes: %w[array of mime_types],
-            tags: %w[tag1 tag2],
-            security: %w[array of security schemes]
+    it 'can be set with a block' do
+      expected_options = {
+        summary: 'summary',
+        description: 'The description',
+        detail: 'more details',
+        params: { first: :param },
+        entity: Object,
+        default: { code: 400, message: 'Invalid' },
+        http_codes: [[401, 'Unauthorized', 'Entities::Error']],
+        named: 'My named route',
+        body_name: 'My body name',
+        headers: [
+          XAuthToken: {
+            description: 'Valdates your identity',
+            required: true
+          },
+          XOptionalHeader: {
+            description: 'Not really needed',
+            required: false
           }
+        ],
+        hidden: false,
+        deprecated: false,
+        is_array: true,
+        nickname: 'nickname',
+        produces: %w[array of mime_types],
+        consumes: %w[array of mime_types],
+        tags: %w[tag1 tag2],
+        security: %w[array of security schemes]
+      }
 
-          subject.desc 'The description' do
-            summary 'summary'
-            detail 'more details'
-            params(first: :param)
-            success Object
-            failure [[401, 'Unauthorized', 'Entities::Error']]
-            named 'My named route'
-            body_name 'My body name'
-            headers [
-              XAuthToken: {
-                description: 'Valdates your identity',
-                required: true
-              },
-              XOptionalHeader: {
-                description: 'Not really needed',
-                required: false
-              }
-            ]
-            hidden false
-            deprecated false
-            is_array true
-            nickname 'nickname'
-            produces %w[array of mime_types]
-            consumes %w[array of mime_types]
-            tags %w[tag1 tag2]
-            security %w[array of security schemes]
-          end
+      subject.desc 'The description' do
+        summary 'summary'
+        detail 'more details'
+        params(first: :param)
+        success Object
+        default code: 400, message: 'Invalid'
+        failure [[401, 'Unauthorized', 'Entities::Error']]
+        named 'My named route'
+        body_name 'My body name'
+        headers [
+          XAuthToken: {
+            description: 'Valdates your identity',
+            required: true
+          },
+          XOptionalHeader: {
+            description: 'Not really needed',
+            required: false
+          }
+        ]
+        hidden false
+        deprecated false
+        is_array true
+        nickname 'nickname'
+        produces %w[array of mime_types]
+        consumes %w[array of mime_types]
+        tags %w[tag1 tag2]
+        security %w[array of security schemes]
+      end
 
-          expect(subject.namespace_setting(:description)).to eq(expected_options)
-          expect(subject.route_setting(:description)).to eq(expected_options)
-        end
+      expect(subject.namespace_setting(:description)).to eq(expected_options)
+      expect(subject.route_setting(:description)).to eq(expected_options)
+    end
 
-        it 'can be set with options and a block' do
-          expect(subject).to receive(:warn).with('[DEPRECATION] Passing a options hash and a block to `desc` is deprecated. Move all hash options to block.')
+    it 'can be set with options and a block' do
+      expect(ActiveSupport::Deprecation).to receive(:warn).with('Passing a options hash and a block to `desc` is deprecated. Move all hash options to block.')
 
-          desc_text = 'The description'
-          detail_text = 'more details'
-          options = { message: 'none' }
-          subject.desc desc_text, options do
-            detail detail_text
-          end
-          expect(subject.namespace_setting(:description)).to eq(description: desc_text, detail: detail_text)
-          expect(subject.route_setting(:description)).to eq(description: desc_text, detail: detail_text)
-        end
+      desc_text = 'The description'
+      detail_text = 'more details'
+      options = { message: 'none' }
+      subject.desc desc_text, options do
+        detail detail_text
       end
+      expect(subject.namespace_setting(:description)).to eq(description: desc_text, detail: detail_text)
+      expect(subject.route_setting(:description)).to eq(description: desc_text, detail: detail_text)
     end
   end
 end

data/spec/grape/dsl/inside_route_spec.rb

@@ -203,16 +203,12 @@ describe Grape::Endpoint do
   end
 
   describe '#file' do
-    before do
-      allow(subject).to receive(:warn)
-    end
-
     describe 'set' do
       context 'as file path' do
         let(:file_path) { '/some/file/path' }
 
         it 'emits a warning that this method is deprecated' do
-          expect(subject).to receive(:warn).with(/Use sendfile or stream/)
+          expect(ActiveSupport::Deprecation).to receive(:warn).with(/Use sendfile or stream/)
 
           subject.file file_path
         end
@@ -228,7 +224,7 @@ describe Grape::Endpoint do
         let(:file_object) { double('StreamerObject', each: nil) }
 
         it 'emits a warning that this method is deprecated' do
-          expect(subject).to receive(:warn).with(/Use stream to use a Stream object/)
+          expect(ActiveSupport::Deprecation).to receive(:warn).with(/Use stream to use a Stream object/)
 
           subject.file file_object
         end
@@ -243,7 +239,7 @@ describe Grape::Endpoint do
 
     describe 'get' do
       it 'emits a warning that this method is deprecated' do
-        expect(subject).to receive(:warn).with(/Use sendfile or stream/)
+        expect(ActiveSupport::Deprecation).to receive(:warn).with(/Use sendfile or stream/)
 
         subject.file
       end
@@ -273,7 +269,7 @@ describe Grape::Endpoint do
         end
 
         it 'sends no deprecation warnings' do
-          expect(subject).not_to receive(:warn)
+          expect(ActiveSupport::Deprecation).not_to receive(:warn)
 
           subject.sendfile file_path
         end
@@ -334,7 +330,7 @@ describe Grape::Endpoint do
         end
 
         it 'emits no deprecation warnings' do
-          expect(subject).not_to receive(:warn)
+          expect(ActiveSupport::Deprecation).not_to receive(:warn)
 
           subject.stream file_path
         end
@@ -384,7 +380,7 @@ describe Grape::Endpoint do
         end
 
         it 'emits no deprecation warnings' do
-          expect(subject).not_to receive(:warn)
+          expect(ActiveSupport::Deprecation).not_to receive(:warn)
 
           subject.stream stream_object
         end

data/spec/grape/dsl/request_response_spec.rb

@@ -148,13 +148,32 @@ module Grape
           it 'sets rescue all to true' do
             expect(subject).to receive(:namespace_inheritable).with(:rescue_all, true)
             expect(subject).to receive(:namespace_inheritable).with(:rescue_grape_exceptions, true)
+            expect(subject).to receive(:namespace_inheritable).with(:grape_exceptions_rescue_handler, nil)
             subject.rescue_from :grape_exceptions
           end
 
-          it 'sets rescue_grape_exceptions to true' do
+          it 'sets given proc as rescue handler' do
+            rescue_handler_proc = proc {}
             expect(subject).to receive(:namespace_inheritable).with(:rescue_all, true)
             expect(subject).to receive(:namespace_inheritable).with(:rescue_grape_exceptions, true)
-            subject.rescue_from :grape_exceptions
+            expect(subject).to receive(:namespace_inheritable).with(:grape_exceptions_rescue_handler, rescue_handler_proc)
+            subject.rescue_from :grape_exceptions, rescue_handler_proc
+          end
+
+          it 'sets given block as rescue handler' do
+            rescue_handler_proc = proc {}
+            expect(subject).to receive(:namespace_inheritable).with(:rescue_all, true)
+            expect(subject).to receive(:namespace_inheritable).with(:rescue_grape_exceptions, true)
+            expect(subject).to receive(:namespace_inheritable).with(:grape_exceptions_rescue_handler, rescue_handler_proc)
+            subject.rescue_from :grape_exceptions, &rescue_handler_proc
+          end
+
+          it 'sets a rescue handler declared through :with option' do
+            with_block = -> { 'hello' }
+            expect(subject).to receive(:namespace_inheritable).with(:rescue_all, true)
+            expect(subject).to receive(:namespace_inheritable).with(:rescue_grape_exceptions, true)
+            expect(subject).to receive(:namespace_inheritable).with(:grape_exceptions_rescue_handler, an_instance_of(Proc))
+            subject.rescue_from :grape_exceptions, with: with_block
           end
         end
 

data/spec/grape/endpoint_spec.rb

@@ -75,7 +75,7 @@ describe Grape::Endpoint do
   it 'sets itself in the env upon call' do
     subject.get('/') { 'Hello world.' }
     get '/'
-    expect(last_request.env['api.endpoint']).to be_kind_of(described_class)
+    expect(last_request.env['api.endpoint']).to be_a(described_class)
   end
 
   describe '#status' do
@@ -138,7 +138,7 @@ describe Grape::Endpoint do
 
     it 'includes request headers' do
       get '/headers'
-      expect(JSON.parse(last_response.body)).to eq(
+      expect(JSON.parse(last_response.body)).to include(
         'Host' => 'example.org',
         'Cookie' => ''
       )
@@ -173,7 +173,7 @@ describe Grape::Endpoint do
 
       get('/get/cookies')
 
-      expect(last_response.headers['Set-Cookie'].split("\n").sort).to eql [
+      expect(Array(last_response.headers['Set-Cookie']).flat_map { |h| h.split("\n") }.sort).to eql [
         'cookie3=symbol',
         'cookie4=secret+code+here',
         'my-awesome-cookie1=is+cool',
@@ -198,8 +198,9 @@ describe Grape::Endpoint do
       end
       get('/username', {}, 'HTTP_COOKIE' => 'username=user; sandbox=false')
       expect(last_response.body).to eq('user_test')
-      expect(last_response.headers['Set-Cookie']).to match(/username=user_test/)
-      expect(last_response.headers['Set-Cookie']).to match(/sandbox=true/)
+      cookies = Array(last_response.headers['Set-Cookie']).flat_map { |h| h.split("\n") }
+      expect(cookies.first).to match(/username=user_test/)
+      expect(cookies.second).to match(/sandbox=true/)
     end
 
     it 'deletes cookie' do
@@ -213,10 +214,10 @@ describe Grape::Endpoint do
       end
       get '/test', {}, 'HTTP_COOKIE' => 'delete_this_cookie=1; and_this=2'
       expect(last_response.body).to eq('3')
-      cookies = last_response.headers['Set-Cookie'].split("\n").map do |set_cookie|
+      cookies = Array(last_response.headers['Set-Cookie']).flat_map { |h| h.split("\n") }.to_h do |set_cookie|
         cookie = CookieJar::Cookie.from_set_cookie 'http://localhost/test', set_cookie
         [cookie.name, cookie]
-      end.to_h
+      end
       expect(cookies.size).to eq(2)
       %w[and_this delete_this_cookie].each do |cookie_name|
         cookie = cookies[cookie_name]
@@ -237,10 +238,10 @@ describe Grape::Endpoint do
       end
       get('/test', {}, 'HTTP_COOKIE' => 'delete_this_cookie=1; and_this=2')
       expect(last_response.body).to eq('3')
-      cookies = last_response.headers['Set-Cookie'].split("\n").map do |set_cookie|
+      cookies = Array(last_response.headers['Set-Cookie']).flat_map { |h| h.split("\n") }.to_h do |set_cookie|
         cookie = CookieJar::Cookie.from_set_cookie 'http://localhost/test', set_cookie
         [cookie.name, cookie]
-      end.to_h
+      end
       expect(cookies.size).to eq(2)
       %w[and_this delete_this_cookie].each do |cookie_name|
         cookie = cookies[cookie_name]
@@ -432,7 +433,7 @@ describe Grape::Endpoint do
         end
         post '/upload', { file: '' }, 'CONTENT_TYPE' => 'multipart/form-data; boundary=foobar'
         expect(last_response.status).to eq(400)
-        expect(last_response.body).to eq('empty message body supplied with multipart/form-data; boundary=foobar content-type')
+        expect(last_response.body).to eq('file is invalid')
       end
     end