grape 1.5.3 → 1.7.0

data/spec/grape/exceptions/invalid_accept_header_spec.rb

@@ -1,12 +1,11 @@
 # frozen_string_literal: true
 
-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
@@ -20,6 +19,7 @@ describe Grape::Exceptions::InvalidAcceptHeader 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
@@ -28,6 +28,7 @@ describe Grape::Exceptions::InvalidAcceptHeader 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')
@@ -36,6 +37,7 @@ describe Grape::Exceptions::InvalidAcceptHeader do
 
   context 'API with cascade=false and rescue_from :all handler' do
     subject { Class.new(Grape::API) }
+
     before do
       subject.version 'v99', using: :header, vendor: 'vendorname', format: :json, cascade: false
       subject.rescue_from :all do |e|
@@ -52,7 +54,8 @@ describe Grape::Exceptions::InvalidAcceptHeader do
 
     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'
+
+      it_behaves_like 'a valid request'
     end
 
     context 'that receives' do
@@ -61,13 +64,15 @@ describe Grape::Exceptions::InvalidAcceptHeader do
           get '/beer', {}, 'HTTP_ACCEPT' => 'application/vnd.invalidvendor-v99',
                            'CONTENT_TYPE' => 'application/json'
         end
-        it_should_behave_like 'a rescued request'
+
+        it_behaves_like 'a rescued request'
       end
     end
   end
 
   context 'API with cascade=false and without a rescue handler' do
     subject { Class.new(Grape::API) }
+
     before do
       subject.version 'v99', using: :header, vendor: 'vendorname', format: :json, cascade: false
       subject.get '/beer' do
@@ -81,23 +86,28 @@ describe Grape::Exceptions::InvalidAcceptHeader do
 
     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'
+
+      it_behaves_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'
+
+        it_behaves_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'
+
+        it_behaves_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 do
       subject.version 'v99', using: :header, vendor: 'vendorname', format: :json, cascade: false
       subject.rescue_from :all do |e|
@@ -119,7 +129,8 @@ describe Grape::Exceptions::InvalidAcceptHeader do
 
     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'
+
+      it_behaves_like 'a valid request'
     end
 
     context 'that receives' do
@@ -128,13 +139,15 @@ describe Grape::Exceptions::InvalidAcceptHeader do
           get '/beer', {}, 'HTTP_ACCEPT' => 'application/vnd.invalidvendor-v99',
                            'CONTENT_TYPE' => 'application/json'
         end
-        it_should_behave_like 'a rescued request'
+
+        it_behaves_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 do
       subject.version 'v99', using: :header, vendor: 'vendorname', format: :json, cascade: false
       subject.desc 'Get beer' do
@@ -153,23 +166,28 @@ describe Grape::Exceptions::InvalidAcceptHeader do
 
     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'
+
+      it_behaves_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'
+
+        it_behaves_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'
+
+        it_behaves_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 do
       subject.version 'v99', using: :header, vendor: 'vendorname', format: :json, cascade: true
       subject.rescue_from :all do |e|
@@ -186,7 +204,8 @@ describe Grape::Exceptions::InvalidAcceptHeader do
 
     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'
+
+      it_behaves_like 'a valid request'
     end
 
     context 'that receives' do
@@ -195,20 +214,24 @@ describe Grape::Exceptions::InvalidAcceptHeader do
           get '/beer', {}, 'HTTP_ACCEPT' => 'application/vnd.vendorname-v77',
                            'CONTENT_TYPE' => 'application/json'
         end
-        it_should_behave_like 'a cascaded request'
+
+        it_behaves_like 'a cascaded request'
       end
+
       context 'an invalid vendor in the request' do
         before do
           get '/beer', {}, 'HTTP_ACCEPT' => 'application/vnd.invalidvendor-v99',
                            'CONTENT_TYPE' => 'application/json'
         end
-        it_should_behave_like 'a cascaded request'
+
+        it_behaves_like 'a cascaded request'
       end
     end
   end
 
   context 'API with cascade=true and without a rescue handler' do
     subject { Class.new(Grape::API) }
+
     before do
       subject.version 'v99', using: :header, vendor: 'vendorname', format: :json, cascade: true
       subject.get '/beer' do
@@ -222,23 +245,28 @@ describe Grape::Exceptions::InvalidAcceptHeader do
 
     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'
+
+      it_behaves_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'
+
+        it_behaves_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'
+
+        it_behaves_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 do
       subject.version 'v99', using: :header, vendor: 'vendorname', format: :json, cascade: true
       subject.rescue_from :all do |e|
@@ -260,7 +288,8 @@ describe Grape::Exceptions::InvalidAcceptHeader do
 
     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'
+
+      it_behaves_like 'a valid request'
     end
 
     context 'that receives' do
@@ -269,20 +298,24 @@ describe Grape::Exceptions::InvalidAcceptHeader do
           get '/beer', {}, 'HTTP_ACCEPT' => 'application/vnd.vendorname-v77',
                            'CONTENT_TYPE' => 'application/json'
         end
-        it_should_behave_like 'a cascaded request'
+
+        it_behaves_like 'a cascaded request'
       end
+
       context 'an invalid vendor in the request' do
         before do
           get '/beer', {}, 'HTTP_ACCEPT' => 'application/vnd.invalidvendor-v99',
                            'CONTENT_TYPE' => 'application/json'
         end
-        it_should_behave_like 'a cascaded request'
+
+        it_behaves_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 do
       subject.version 'v99', using: :header, vendor: 'vendorname', format: :json, cascade: true
       subject.desc 'Get beer' do
@@ -301,17 +334,21 @@ describe Grape::Exceptions::InvalidAcceptHeader do
 
     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'
+
+      it_behaves_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'
+
+        it_behaves_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'
+
+        it_behaves_like 'a cascaded request'
       end
     end
   end

data/spec/grape/exceptions/invalid_formatter_spec.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'spec_helper'
-
 describe Grape::Exceptions::InvalidFormatter do
   describe '#message' do
     let(:error) do

data/spec/grape/exceptions/invalid_response_spec.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'spec_helper'
-
 describe Grape::Exceptions::InvalidResponse do
   describe '#message' do
     let(:error) { described_class.new }

data/spec/grape/exceptions/invalid_versioner_option_spec.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'spec_helper'
-
 describe Grape::Exceptions::InvalidVersionerOption do
   describe '#message' do
     let(:error) do
@@ -10,7 +8,7 @@ describe Grape::Exceptions::InvalidVersionerOption do
 
     it 'contains the problem in the message' do
       expect(error.message).to include(
-        'Unknown :using for versioner: headers'
+        'unknown :using for versioner: headers'
       )
     end
   end

data/spec/grape/exceptions/missing_group_type_spec.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+RSpec.describe Grape::Exceptions::MissingGroupType do
+  describe '#message' do
+    subject { described_class.new.message }
+
+    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
+
+      subject
+    end
+  end
+end

data/spec/grape/exceptions/missing_mime_type_spec.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'spec_helper'
-
 describe Grape::Exceptions::MissingMimeType do
   describe '#message' do
     let(:error) do

data/spec/grape/exceptions/missing_option_spec.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'spec_helper'
-
 describe Grape::Exceptions::MissingOption do
   describe '#message' do
     let(:error) do
@@ -10,7 +8,7 @@ describe Grape::Exceptions::MissingOption do
 
     it 'contains the problem in the message' do
       expect(error.message).to include(
-        'You must specify :path options.'
+        'you must specify :path options'
       )
     end
   end

data/spec/grape/exceptions/unknown_options_spec.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'spec_helper'
-
 describe Grape::Exceptions::UnknownOptions do
   describe '#message' do
     let(:error) do

data/spec/grape/exceptions/unknown_validator_spec.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'spec_helper'
-
 describe Grape::Exceptions::UnknownValidator do
   describe '#message' do
     let(:error) do

data/spec/grape/exceptions/unsupported_group_type_spec.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+RSpec.describe Grape::Exceptions::UnsupportedGroupType do
+  subject { described_class.new }
+
+  describe '#message' do
+    subject { described_class.new.message }
+
+    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
+
+      subject
+    end
+  end
+end

data/spec/grape/exceptions/validation_errors_spec.rb

@@ -1,34 +1,34 @@
 # frozen_string_literal: true
 
-require 'spec_helper'
 require 'ostruct'
 
 describe Grape::Exceptions::ValidationErrors do
   let(:validation_message) { 'FooBar is invalid' }
-  let(:validation_error) { OpenStruct.new(params: [validation_message]) }
+  let(:validation_error) { instance_double Grape::Exceptions::Validation, params: [validation_message], message: '' }
 
   context 'initialize' do
+    subject do
+      described_class.new(errors: [validation_error], headers: headers)
+    end
+
     let(:headers) do
       {
         'A-Header-Key' => 'A-Header-Value'
       }
     end
 
-    subject do
-      described_class.new(errors: [validation_error], headers: headers)
-    end
-
-    it 'should assign headers through base class' do
+    it 'assigns headers through base class' do
       expect(subject.headers).to eq(headers)
     end
   end
 
   context 'message' do
     context 'is not repeated' do
+      subject(:message) { error.message.split(',').map(&:strip) }
+
       let(:error) do
         described_class.new(errors: [validation_error, validation_error])
       end
-      subject(:message) { error.message.split(',').map(&:strip) }
 
       it { expect(message).to include validation_message }
       it { expect(message.size).to eq 1 }
@@ -37,9 +37,10 @@ describe Grape::Exceptions::ValidationErrors do
 
   describe '#full_messages' do
     context 'with errors' do
+      subject { described_class.new(errors: [validation_error_1, validation_error_2]).full_messages }
+
       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
         expect(subject).to contain_exactly('id is missing', 'name is missing')
@@ -47,9 +48,10 @@ describe Grape::Exceptions::ValidationErrors do
     end
 
     context 'when attributes is an array of symbols' do
-      let(:validation_error) { Grape::Exceptions::Validation.new(params: [:admin_field], message: 'Can not set admin-only field') }
       subject { described_class.new(errors: [validation_error]).full_messages }
 
+      let(:validation_error) { Grape::Exceptions::Validation.new(params: [:admin_field], message: 'Can not set admin-only field') }
+
       it 'returns an array with an error full message' do
         expect(subject.first).to eq('admin_field Can not set admin-only field')
       end
@@ -65,7 +67,7 @@ describe Grape::Exceptions::ValidationErrors do
 
     it 'can return structured json with separate fields' do
       subject.format :json
-      subject.rescue_from Grape::Exceptions::ValidationErrors do |e|
+      subject.rescue_from described_class do |e|
         error!(e, 400)
       end
       subject.params do

data/spec/grape/exceptions/validation_spec.rb

@@ -1,19 +1,19 @@
 # frozen_string_literal: true
 
-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(ArgumentError, /missing keyword:.+?params/)
+    expect { described_class.new(message: 'presence') }.to raise_error(ArgumentError, /missing keyword:.+?params/)
   end
+
   context 'when message is a symbol' do
     it 'stores message_key' do
-      expect(Grape::Exceptions::Validation.new(params: ['id'], message: :presence).message_key).to eq(:presence)
+      expect(described_class.new(params: ['id'], message: :presence).message_key).to eq(:presence)
     end
   end
+
   context 'when message is a String' do
     it 'does not store the message_key' do
-      expect(Grape::Exceptions::Validation.new(params: ['id'], message: 'presence').message_key).to eq(nil)
+      expect(described_class.new(params: ['id'], message: 'presence').message_key).to be_nil
     end
   end
 end

data/spec/grape/extensions/param_builders/hash_spec.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'spec_helper'
-
 describe Grape::Extensions::Hash::ParamBuilder do
   subject { Class.new(Grape::API) }
 
@@ -10,10 +8,10 @@ describe Grape::Extensions::Hash::ParamBuilder do
   end
 
   describe 'in an endpoint' do
-    context '#params' do
+    describe '#params' do
       before do
         subject.params do
-          build_with Grape::Extensions::Hash::ParamBuilder
+          build_with Grape::Extensions::Hash::ParamBuilder # rubocop:disable RSpec/DescribedClass
         end
 
         subject.get do
@@ -21,7 +19,7 @@ describe Grape::Extensions::Hash::ParamBuilder do
         end
       end
 
-      it 'should be of type Hash' do
+      it 'is of type Hash' do
         get '/'
         expect(last_response.status).to eq(200)
         expect(last_response.body).to eq('Hash')
@@ -31,17 +29,17 @@ describe Grape::Extensions::Hash::ParamBuilder do
 
   describe 'in an api' do
     before do
-      subject.send(:include, Grape::Extensions::Hash::ParamBuilder)
+      subject.send(:include, Grape::Extensions::Hash::ParamBuilder) # rubocop:disable RSpec/DescribedClass
     end
 
-    context '#params' do
+    describe '#params' do
       before do
         subject.get do
           params.class
         end
       end
 
-      it 'should be Hash' do
+      it 'is Hash' do
         get '/'
         expect(last_response.status).to eq(200)
         expect(last_response.body).to eq('Hash')
@@ -69,7 +67,7 @@ describe Grape::Extensions::Hash::ParamBuilder do
 
     it 'symbolizes the params' do
       subject.params do
-        build_with Grape::Extensions::Hash::ParamBuilder
+        build_with Grape::Extensions::Hash::ParamBuilder # rubocop:disable RSpec/DescribedClass
         requires :a, type: String
       end
 

data/spec/grape/extensions/param_builders/hash_with_indifferent_access_spec.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'spec_helper'
-
 describe Grape::Extensions::ActiveSupport::HashWithIndifferentAccess::ParamBuilder do
   subject { Class.new(Grape::API) }
 
@@ -10,10 +8,10 @@ describe Grape::Extensions::ActiveSupport::HashWithIndifferentAccess::ParamBuild
   end
 
   describe 'in an endpoint' do
-    context '#params' do
+    describe '#params' do
       before do
         subject.params do
-          build_with Grape::Extensions::ActiveSupport::HashWithIndifferentAccess::ParamBuilder
+          build_with Grape::Extensions::ActiveSupport::HashWithIndifferentAccess::ParamBuilder # rubocop:disable RSpec/DescribedClass
         end
 
         subject.get do
@@ -21,7 +19,7 @@ describe Grape::Extensions::ActiveSupport::HashWithIndifferentAccess::ParamBuild
         end
       end
 
-      it 'should be of type Hash' do
+      it 'is of type Hash' do
         get '/'
         expect(last_response.status).to eq(200)
         expect(last_response.body).to eq('ActiveSupport::HashWithIndifferentAccess')
@@ -31,10 +29,10 @@ describe Grape::Extensions::ActiveSupport::HashWithIndifferentAccess::ParamBuild
 
   describe 'in an api' do
     before do
-      subject.send(:include, Grape::Extensions::ActiveSupport::HashWithIndifferentAccess::ParamBuilder)
+      subject.send(:include, Grape::Extensions::ActiveSupport::HashWithIndifferentAccess::ParamBuilder) # rubocop:disable RSpec/DescribedClass
     end
 
-    context '#params' do
+    describe '#params' do
       before do
         subject.get do
           params.class
@@ -49,7 +47,7 @@ describe Grape::Extensions::ActiveSupport::HashWithIndifferentAccess::ParamBuild
 
       it 'parses sub hash params' do
         subject.params do
-          build_with Grape::Extensions::ActiveSupport::HashWithIndifferentAccess::ParamBuilder
+          build_with Grape::Extensions::ActiveSupport::HashWithIndifferentAccess::ParamBuilder # rubocop:disable RSpec/DescribedClass
 
           optional :a, type: Hash do
             optional :b, type: Hash do
@@ -70,7 +68,7 @@ describe Grape::Extensions::ActiveSupport::HashWithIndifferentAccess::ParamBuild
 
       it 'params are indifferent to symbol or string keys' do
         subject.params do
-          build_with Grape::Extensions::ActiveSupport::HashWithIndifferentAccess::ParamBuilder
+          build_with Grape::Extensions::ActiveSupport::HashWithIndifferentAccess::ParamBuilder # rubocop:disable RSpec/DescribedClass
           optional :a, type: Hash do
             optional :b, type: Hash do
               optional :c, type: String
@@ -90,7 +88,7 @@ describe Grape::Extensions::ActiveSupport::HashWithIndifferentAccess::ParamBuild
 
       it 'responds to string keys' do
         subject.params do
-          build_with Grape::Extensions::ActiveSupport::HashWithIndifferentAccess::ParamBuilder
+          build_with Grape::Extensions::ActiveSupport::HashWithIndifferentAccess::ParamBuilder # rubocop:disable RSpec/DescribedClass
           requires :a, type: String
         end