grape 1.1.0 → 1.7.1

data/spec/grape/entity_spec.rb

@@ -1,4 +1,5 @@
-require 'spec_helper'
+# frozen_string_literal: true
+
 require 'grape_entity'
 
 describe Grape::Entity do
@@ -30,7 +31,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
@@ -42,7 +43,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
@@ -73,7 +74,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)
@@ -88,7 +89,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
@@ -102,7 +103,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
@@ -114,8 +115,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
@@ -127,7 +128,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
 
@@ -171,7 +172,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
 
@@ -179,6 +180,7 @@ describe Grape::Entity do
         subject.get '/example' do
           c = Class.new do
             attr_reader :id
+
             def initialize(id)
               @id = id
             end
@@ -192,7 +194,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
 
@@ -200,6 +202,7 @@ describe Grape::Entity do
         subject.get '/examples' do
           c = Class.new do
             attr_reader :id
+
             def initialize(id)
               @id = id
             end
@@ -215,7 +218,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
 
@@ -224,6 +227,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
@@ -233,18 +237,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
 
@@ -253,6 +257,7 @@ XML
       subject.get '/example' do
         c = Class.new do
           attr_reader :name
+
           def initialize(args)
             @name = args[:name] || 'no name set'
           end
@@ -269,7 +274,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
 
@@ -282,6 +287,7 @@ XML
       subject.get '/example' do
         c = Class.new do
           attr_reader :name
+
           def initialize(args)
             @name = args[:name] || 'no name set'
           end
@@ -300,6 +306,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
@@ -307,7 +314,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
@@ -318,7 +325,7 @@ XML
         end
         get '/example'
         expect_response_json = {
-          'page'  => 1,
+          'page' => 1,
           'user1' => { 'name' => 'user1' },
           'user2' => { 'name' => 'user2' }
         }

data/spec/grape/exceptions/base_spec.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+describe Grape::Exceptions::Base do
+  describe '#to_s' do
+    subject { described_class.new(message: message).to_s }
+
+    let(:message) { 'a_message' }
+
+    it { is_expected.to eq(message) }
+  end
+
+  describe '#message' do
+    subject { described_class.new(message: message).message }
+
+    let(:message) { 'a_message' }
+
+    it { is_expected.to eq(message) }
+  end
+
+  describe '#compose_message' do
+    subject { described_class.new.send(:compose_message, key, **attributes) }
+
+    let(:key) { :invalid_formatter }
+    let(:attributes) { { klass: String, to_format: 'xml' } }
+
+    after do
+      I18n.enforce_available_locales = true
+      I18n.available_locales = %i[en]
+      I18n.locale = :en
+      I18n.default_locale = :en
+      I18n.reload!
+    end
+
+    context 'when I18n enforces available locales' do
+      before { I18n.enforce_available_locales = true }
+
+      context 'when the fallback locale is available' do
+        before do
+          I18n.available_locales = %i[de en]
+          I18n.default_locale = :de
+        end
+
+        it 'returns the translated message' do
+          expect(subject).to eq('cannot convert String to xml')
+        end
+      end
+
+      context 'when the fallback locale is not available' do
+        before do
+          I18n.available_locales = %i[de jp]
+          I18n.locale = :de
+          I18n.default_locale = :de
+        end
+
+        it 'returns the translation string' do
+          expect(subject).to eq("grape.errors.messages.#{key}")
+        end
+      end
+    end
+
+    context 'when I18n does not enforce available locales' do
+      before { I18n.enforce_available_locales = false }
+
+      context 'when the fallback locale is available' do
+        before { I18n.available_locales = %i[de en] }
+
+        it 'returns the translated message' do
+          expect(subject).to eq('cannot convert String to xml')
+        end
+      end
+
+      context 'when the fallback locale is not available' do
+        before { I18n.available_locales = %i[de jp] }
+
+        it 'returns the translated message' do
+          expect(subject).to eq('cannot convert String to xml')
+        end
+      end
+    end
+  end
+end

data/spec/grape/exceptions/body_parse_errors_spec.rb

@@ -1,8 +1,9 @@
-require 'spec_helper'
+# frozen_string_literal: true
 
 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
@@ -54,6 +55,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
@@ -91,6 +93,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

@@ -1,31 +1,37 @@
-require 'spec_helper'
+# frozen_string_literal: true
 
 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
   end
+
   shared_examples_for 'a cascaded request' do
     it 'does not find a matching route' do
       expect(last_response.status).to eq 404
     end
   end
+
   shared_examples_for 'a not-cascaded request' 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
   end
+
   shared_examples_for 'a rescued request' 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')
@@ -34,6 +40,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|
@@ -50,7 +57,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
@@ -59,13 +67,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
@@ -79,23 +89,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|
@@ -117,7 +132,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
@@ -126,13 +142,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
@@ -151,23 +169,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|
@@ -184,7 +207,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
@@ -193,20 +217,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
@@ -220,23 +248,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|
@@ -258,7 +291,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
@@ -267,20 +301,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
@@ -299,17 +337,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,4 +1,4 @@
-require 'spec_helper'
+# frozen_string_literal: true
 
 describe Grape::Exceptions::InvalidFormatter do
   describe '#message' do

data/spec/grape/exceptions/invalid_response_spec.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+describe Grape::Exceptions::InvalidResponse do
+  describe '#message' do
+    let(:error) { described_class.new }
+
+    it 'contains the problem in the message' do
+      expect(error.message).to include('Invalid response')
+    end
+  end
+end

data/spec/grape/exceptions/invalid_versioner_option_spec.rb

@@ -1,4 +1,4 @@
-require 'spec_helper'
+# frozen_string_literal: true
 
 describe Grape::Exceptions::InvalidVersionerOption do
   describe '#message' do
@@ -8,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,4 +1,4 @@
-require 'spec_helper'
+# frozen_string_literal: true
 
 describe Grape::Exceptions::MissingMimeType do
   describe '#message' do

data/spec/grape/exceptions/missing_option_spec.rb

@@ -1,4 +1,4 @@
-require 'spec_helper'
+# frozen_string_literal: true
 
 describe Grape::Exceptions::MissingOption do
   describe '#message' do
@@ -8,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,4 +1,4 @@
-require 'spec_helper'
+# frozen_string_literal: true
 
 describe Grape::Exceptions::UnknownOptions do
   describe '#message' do