grape 1.3.3 → 1.6.2

data/spec/grape/entity_spec.rb

@@ -32,7 +32,7 @@ describe Grape::Entity do
     end
 
     it 'pulls a representation from the class options if it exists' do
-      entity = Class.new(Grape::Entity)
+      entity = Class.new(described_class)
       allow(entity).to receive(:represent).and_return('Hiya')
 
       subject.represent Object, with: entity
@@ -44,7 +44,7 @@ describe Grape::Entity do
     end
 
     it 'pulls a representation from the class options if the presented object is a collection of objects' do
-      entity = Class.new(Grape::Entity)
+      entity = Class.new(described_class)
       allow(entity).to receive(:represent).and_return('Hiya')
 
       module EntitySpec
@@ -75,7 +75,7 @@ describe Grape::Entity do
     end
 
     it 'pulls a representation from the class ancestor if it exists' do
-      entity = Class.new(Grape::Entity)
+      entity = Class.new(described_class)
       allow(entity).to receive(:represent).and_return('Hiya')
 
       subclass = Class.new(Object)
@@ -90,7 +90,7 @@ describe Grape::Entity do
 
     it 'automatically uses Klass::Entity if that exists' do
       some_model = Class.new
-      entity = Class.new(Grape::Entity)
+      entity = Class.new(described_class)
       allow(entity).to receive(:represent).and_return('Auto-detect!')
 
       some_model.const_set :Entity, entity
@@ -104,7 +104,7 @@ describe Grape::Entity do
 
     it 'automatically uses Klass::Entity based on the first object in the collection being presented' do
       some_model = Class.new
-      entity = Class.new(Grape::Entity)
+      entity = Class.new(described_class)
       allow(entity).to receive(:represent).and_return('Auto-detect!')
 
       some_model.const_set :Entity, entity
@@ -116,8 +116,8 @@ describe Grape::Entity do
       expect(last_response.body).to eq('Auto-detect!')
     end
 
-    it 'does not run autodetection for Entity when explicitely provided' do
-      entity = Class.new(Grape::Entity)
+    it 'does not run autodetection for Entity when explicitly provided' do
+      entity = Class.new(described_class)
       some_array = []
 
       subject.get '/example' do
@@ -129,7 +129,7 @@ describe Grape::Entity do
     end
 
     it 'does not use #first method on ActiveRecord::Relation to prevent needless sql query' do
-      entity = Class.new(Grape::Entity)
+      entity = Class.new(described_class)
       some_relation = Class.new
       some_model = Class.new
 
@@ -173,7 +173,7 @@ describe Grape::Entity do
 
     %i[json serializable_hash].each do |format|
       it "presents with #{format}" do
-        entity = Class.new(Grape::Entity)
+        entity = Class.new(described_class)
         entity.root 'examples', 'example'
         entity.expose :id
 
@@ -181,6 +181,7 @@ describe Grape::Entity do
         subject.get '/example' do
           c = Class.new do
             attr_reader :id
+
             def initialize(id)
               @id = id
             end
@@ -194,7 +195,7 @@ describe Grape::Entity do
       end
 
       it "presents with #{format} collection" do
-        entity = Class.new(Grape::Entity)
+        entity = Class.new(described_class)
         entity.root 'examples', 'example'
         entity.expose :id
 
@@ -202,6 +203,7 @@ describe Grape::Entity do
         subject.get '/examples' do
           c = Class.new do
             attr_reader :id
+
             def initialize(id)
               @id = id
             end
@@ -217,7 +219,7 @@ describe Grape::Entity do
     end
 
     it 'presents with xml' do
-      entity = Class.new(Grape::Entity)
+      entity = Class.new(described_class)
       entity.root 'examples', 'example'
       entity.expose :name
 
@@ -226,6 +228,7 @@ describe Grape::Entity do
       subject.get '/example' do
         c = Class.new do
           attr_reader :name
+
           def initialize(args)
             @name = args[:name] || 'no name set'
           end
@@ -235,18 +238,18 @@ describe Grape::Entity do
       get '/example'
       expect(last_response.status).to eq(200)
       expect(last_response.headers['Content-type']).to eq('application/xml')
-      expect(last_response.body).to eq <<-XML
-<?xml version="1.0" encoding="UTF-8"?>
-<hash>
-  <example>
-    <name>johnnyiller</name>
-  </example>
-</hash>
-XML
+      expect(last_response.body).to eq <<~XML
+        <?xml version="1.0" encoding="UTF-8"?>
+        <hash>
+          <example>
+            <name>johnnyiller</name>
+          </example>
+        </hash>
+      XML
     end
 
     it 'presents with json' do
-      entity = Class.new(Grape::Entity)
+      entity = Class.new(described_class)
       entity.root 'examples', 'example'
       entity.expose :name
 
@@ -255,6 +258,7 @@ XML
       subject.get '/example' do
         c = Class.new do
           attr_reader :name
+
           def initialize(args)
             @name = args[:name] || 'no name set'
           end
@@ -271,7 +275,7 @@ XML
       # Include JSONP middleware
       subject.use Rack::JSONP
 
-      entity = Class.new(Grape::Entity)
+      entity = Class.new(described_class)
       entity.root 'examples', 'example'
       entity.expose :name
 
@@ -284,6 +288,7 @@ XML
       subject.get '/example' do
         c = Class.new do
           attr_reader :name
+
           def initialize(args)
             @name = args[:name] || 'no name set'
           end
@@ -302,6 +307,7 @@ XML
       it 'present with multiple entities using optional symbol' do
         user = Class.new do
           attr_reader :name
+
           def initialize(args)
             @name = args[:name] || 'no name set'
           end
@@ -309,7 +315,7 @@ XML
         user1 = user.new(name: 'user1')
         user2 = user.new(name: 'user2')
 
-        entity = Class.new(Grape::Entity)
+        entity = Class.new(described_class)
         entity.expose :name
 
         subject.format :json
@@ -320,7 +326,7 @@ XML
         end
         get '/example'
         expect_response_json = {
-          'page'  => 1,
+          'page' => 1,
           'user1' => { 'name' => 'user1' },
           'user2' => { 'name' => 'user2' }
         }

data/spec/grape/exceptions/body_parse_errors_spec.rb

@@ -5,6 +5,7 @@ require 'spec_helper'
 describe Grape::Exceptions::ValidationErrors do
   context 'api with rescue_from :all handler' do
     subject { Class.new(Grape::API) }
+
     before do
       subject.rescue_from :all do |_e|
         rack_response 'message was processed', 400
@@ -56,6 +57,7 @@ describe Grape::Exceptions::ValidationErrors do
 
   context 'api with rescue_from :grape_exceptions handler' do
     subject { Class.new(Grape::API) }
+
     before do
       subject.rescue_from :all do |_e|
         rack_response 'message was processed', 400
@@ -93,6 +95,7 @@ describe Grape::Exceptions::ValidationErrors do
 
   context 'api without a rescue handler' do
     subject { Class.new(Grape::API) }
+
     before do
       subject.params do
         requires :beer

data/spec/grape/exceptions/invalid_accept_header_spec.rb

@@ -7,6 +7,7 @@ describe Grape::Exceptions::InvalidAcceptHeader 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 +21,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 +30,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 +39,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 +56,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 +66,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 +88,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 +131,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 +141,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 +168,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 +206,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 +216,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 +247,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 +290,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 +300,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 +336,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/validation_errors_spec.rb

@@ -5,30 +5,31 @@ 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 +38,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 +49,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 +68,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

@@ -4,16 +4,18 @@ 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 eq(nil)
     end
   end
 end

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

@@ -10,10 +10,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 +21,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 +31,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 +69,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