grape 1.7.1 → 1.8.0

data/spec/grape/dsl/desc_spec.rb

@@ -1,101 +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,
-            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]
+    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
-            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
+      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

@@ -138,10 +138,9 @@ 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' => '',
-        'Version' => 'HTTP/1.0'
+        'Cookie' => ''
       )
     end
 
@@ -174,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',
@@ -199,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
@@ -214,7 +214,7 @@ 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").to_h 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
@@ -238,7 +238,7 @@ 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").to_h 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

data/spec/grape/exceptions/body_parse_errors_spec.rb

@@ -91,6 +91,46 @@ describe Grape::Exceptions::ValidationErrors do
     end
   end
 
+  context 'api with rescue_from :grape_exceptions handler with block' do
+    subject { Class.new(Grape::API) }
+
+    before do
+      subject.rescue_from :grape_exceptions do |e|
+        rack_response "Custom Error Contents, Original Message: #{e.message}", 400
+      end
+
+      subject.params do
+        requires :beer
+      end
+
+      subject.post '/beer' do
+        'beer received'
+      end
+    end
+
+    def app
+      subject
+    end
+
+    context 'with content_type json' do
+      it 'returns body parsing error message' do
+        post '/beer', 'test', 'CONTENT_TYPE' => 'application/json'
+        expect(last_response.status).to eq 400
+        expect(last_response.body).to include 'message body does not match declared format'
+        expect(last_response.body).to include 'Custom Error Contents, Original Message'
+      end
+    end
+
+    context 'with content_type xml' do
+      it 'returns body parsing error message' do
+        post '/beer', 'test', 'CONTENT_TYPE' => 'application/xml'
+        expect(last_response.status).to eq 400
+        expect(last_response.body).to include 'message body does not match declared format'
+        expect(last_response.body).to include 'Custom Error Contents, Original Message'
+      end
+    end
+  end
+
   context 'api without a rescue handler' do
     subject { Class.new(Grape::API) }
 

data/spec/grape/exceptions/missing_group_type_spec.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'shared/deprecated_class_examples'
+
 RSpec.describe Grape::Exceptions::MissingGroupType do
   describe '#message' do
     subject { described_class.new.message }
@@ -7,15 +9,9 @@ RSpec.describe Grape::Exceptions::MissingGroupType do
     it { is_expected.to include 'group type is required' }
   end
 
-  describe 'deprecated Grape::Exceptions::MissingGroupTypeError' do
-    subject { Grape::Exceptions::MissingGroupTypeError.new }
-
-    it 'puts a deprecation warning' do
-      expect(Warning).to receive(:warn) do |message|
-        expect(message).to include('`Grape::Exceptions::MissingGroupTypeError` is deprecated')
-      end
+  describe 'Grape::Exceptions::MissingGroupTypeError' do
+    let(:deprecated_class) { Grape::Exceptions::MissingGroupTypeError }
 
-      subject
-    end
+    it_behaves_like 'deprecated class'
   end
 end

data/spec/grape/exceptions/unsupported_group_type_spec.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'shared/deprecated_class_examples'
+
 RSpec.describe Grape::Exceptions::UnsupportedGroupType do
   subject { described_class.new }
 
@@ -9,15 +11,9 @@ RSpec.describe Grape::Exceptions::UnsupportedGroupType do
     it { is_expected.to include 'group type must be Array, Hash, JSON or Array[JSON]' }
   end
 
-  describe 'deprecated Grape::Exceptions::UnsupportedGroupTypeError' do
-    subject { Grape::Exceptions::UnsupportedGroupTypeError.new }
-
-    it 'puts a deprecation warning' do
-      expect(Warning).to receive(:warn) do |message|
-        expect(message).to include('`Grape::Exceptions::UnsupportedGroupTypeError` is deprecated')
-      end
+  describe 'Grape::Exceptions::UnsupportedGroupTypeError' do
+    let(:deprecated_class) { Grape::Exceptions::UnsupportedGroupTypeError }
 
-      subject
-    end
+    it_behaves_like 'deprecated class'
   end
 end

data/spec/grape/grape_spec.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+RSpec.describe Grape do
+  describe '.config' do
+    subject { described_class.config }
+
+    it { is_expected.to eq(param_builder: Grape::Extensions::ActiveSupport::HashWithIndifferentAccess::ParamBuilder) }
+  end
+end

data/spec/grape/middleware/formatter_spec.rb

@@ -405,7 +405,7 @@ describe Grape::Middleware::Formatter do
       env = { 'PATH_INFO' => '/somewhere', 'HTTP_ACCEPT' => 'application/json' }
       status, headers, body = subject.call(env)
       expect(status).to be == 200
-      expect(headers).to be == { 'Content-Type' => 'application/json' }
+      expect(headers.transform_keys(&:downcase)).to be == { 'content-type' => 'application/json' }
       expect(read_chunks(body)).to be == ['data']
     end
   end

data/spec/grape/request_spec.rb

@@ -62,29 +62,19 @@ module Grape
       end
     end
 
-    describe 'when the param_builder is set to Hashie' do
+    describe 'when the build_params_with is set to Hashie' do
       subject(:request_params) { described_class.new(env, **opts).params }
 
-      before do
-        Grape.configure do |config|
-          config.param_builder = Grape::Extensions::Hashie::Mash::ParamBuilder
-        end
-      end
-
-      after do
-        Grape.config.reset
-      end
-
       context 'when the API does not include a specific param builder' do
         let(:opts) { {} }
 
-        it { is_expected.to be_a(Hashie::Mash) }
+        it { is_expected.to be_a(Hash) }
       end
 
       context 'when the API includes a specific param builder' do
-        let(:opts) { { build_params_with: Grape::Extensions::Hash::ParamBuilder } }
+        let(:opts) { { build_params_with: Grape::Extensions::Hashie::Mash::ParamBuilder } }
 
-        it { is_expected.to be_a(Hash) }
+        it { is_expected.to be_a(Hashie::Mash) }
       end
     end
 

data/spec/grape/validations/multiple_attributes_iterator_spec.rb

@@ -12,8 +12,8 @@ describe Grape::Validations::MultipleAttributesIterator do
         { first: 'string', second: 'string' }
       end
 
-      it 'yields the whole params hash and the skipped flag without the list of attrs' do
-        expect { |b| iterator.each(&b) }.to yield_with_args(params, false)
+      it 'yields the whole params hash without the list of attrs' do
+        expect { |b| iterator.each(&b) }.to yield_with_args(params)
       end
     end
 
@@ -23,17 +23,15 @@ describe Grape::Validations::MultipleAttributesIterator do
       end
 
       it 'yields each element of the array without the list of attrs' do
-        expect { |b| iterator.each(&b) }.to yield_successive_args([params[0], false], [params[1], false])
+        expect { |b| iterator.each(&b) }.to yield_successive_args(params[0], params[1])
       end
     end
 
     context 'when params is empty optional placeholder' do
-      let(:params) do
-        [Grape::DSL::Parameters::EmptyOptionalValue, { first: 'string2', second: 'string2' }]
-      end
+      let(:params) { [Grape::DSL::Parameters::EmptyOptionalValue] }
 
-      it 'yields each element of the array without the list of attrs' do
-        expect { |b| iterator.each(&b) }.to yield_successive_args([Grape::DSL::Parameters::EmptyOptionalValue, true], [params[1], false])
+      it 'does not yield it' do
+        expect { |b| iterator.each(&b) }.to yield_successive_args
       end
     end
   end

data/spec/grape/validations/single_attribute_iterator_spec.rb

@@ -14,7 +14,7 @@ describe Grape::Validations::SingleAttributeIterator do
 
       it 'yields params and every single attribute from the list' do
         expect { |b| iterator.each(&b) }
-          .to yield_successive_args([params, :first, false, false], [params, :second, false, false])
+          .to yield_successive_args([params, :first, false], [params, :second, false])
       end
     end
 
@@ -25,8 +25,8 @@ describe Grape::Validations::SingleAttributeIterator do
 
       it 'yields every single attribute from the list for each of the array elements' do
         expect { |b| iterator.each(&b) }.to yield_successive_args(
-          [params[0], :first, false, false], [params[0], :second, false, false],
-          [params[1], :first, false, false], [params[1], :second, false, false]
+          [params[0], :first, false], [params[0], :second, false],
+          [params[1], :first, false], [params[1], :second, false]
         )
       end
 
@@ -35,9 +35,9 @@ describe Grape::Validations::SingleAttributeIterator do
 
         it 'marks params with empty values' do
           expect { |b| iterator.each(&b) }.to yield_successive_args(
-            [params[0], :first, true, false], [params[0], :second, true, false],
-            [params[1], :first, true, false], [params[1], :second, true, false],
-            [params[2], :first, false, false], [params[2], :second, false, false]
+            [params[0], :first, true], [params[0], :second, true],
+            [params[1], :first, true], [params[1], :second, true],
+            [params[2], :first, false], [params[2], :second, false]
           )
         end
       end
@@ -45,10 +45,9 @@ describe Grape::Validations::SingleAttributeIterator do
       context 'when missing optional value' do
         let(:params) { [Grape::DSL::Parameters::EmptyOptionalValue, 10] }
 
-        it 'marks params with skipped values' do
+        it 'does not yield skipped values' do
           expect { |b| iterator.each(&b) }.to yield_successive_args(
-            [params[0], :first, false, true], [params[0], :second, false, true],
-            [params[1], :first, false, false], [params[1], :second, false, false]
+            [params[1], :first, false], [params[1], :second, false]
           )
         end
       end

data/spec/grape/validations/validators/base_spec.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+RSpec.describe Grape::Validations::Validators::Base do
+  describe '#inherited' do
+    context 'when validator is anonymous' do
+      subject(:custom_validator) { Class.new(described_class) }
+
+      it 'does not register the validator' do
+        expect(Grape::Validations).not_to receive(:register_validator)
+        custom_validator
+      end
+    end
+
+    # Anonymous class does not have a name and class A < B would leak.
+    # Simulates inherited callback
+    context "when validator's underscored name does not end with _validator" do
+      subject(:custom_validator) { described_class.inherited(TestModule::CustomValidatorABC) }
+
+      before { stub_const('TestModule::CustomValidatorABC', Class.new) }
+
+      it 'registers the custom validator with a short name' do
+        expect(Grape::Validations).to receive(:register_validator).with('custom_validator_abc', TestModule::CustomValidatorABC)
+        custom_validator
+      end
+    end
+
+    context "when validator's underscored name ends with _validator" do
+      subject(:custom_validator) { described_class.inherited(TestModule::CustomValidator) }
+
+      before { stub_const('TestModule::CustomValidator', Class.new) }
+
+      it 'registers the custom validator with short name not ending with validator' do
+        expect(Grape::Validations).to receive(:register_validator).with('custom', TestModule::CustomValidator)
+        custom_validator
+      end
+    end
+  end
+end