grape 1.6.2 → 1.7.0

data/spec/grape/api/required_parameters_in_route_spec.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'spec_helper'
-
 describe Grape::Endpoint do
   subject { Class.new(Grape::API) }
 

data/spec/grape/api/required_parameters_with_invalid_method_spec.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'spec_helper'
-
 describe Grape::Endpoint do
   subject { Class.new(Grape::API) }
 

data/spec/grape/api/routes_with_requirements_spec.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'spec_helper'
-
 describe Grape::Endpoint do
   subject { Class.new(Grape::API) }
 

data/spec/grape/api/shared_helpers_exactly_one_of_spec.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'spec_helper'
-
 describe Grape::API::Helpers do
   let(:app) do
     Class.new(Grape::API) do

data/spec/grape/api/shared_helpers_spec.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'spec_helper'
-
 describe Grape::API::Helpers do
   subject do
     shared_params = Module.new do

data/spec/grape/api_remount_spec.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 
-require 'spec_helper'
 require 'shared/versioning_examples'
 
 describe Grape::API do

data/spec/grape/api_spec.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 
-require 'spec_helper'
 require 'shared/versioning_examples'
 
 describe Grape::API do
@@ -1217,7 +1216,7 @@ describe Grape::API do
 
     it 'does not set Cache-Control' do
       get '/foo'
-      expect(last_response.headers['Cache-Control']).to eq(nil)
+      expect(last_response.headers['Cache-Control']).to be_nil
     end
 
     it 'sets content type for xml' do
@@ -1242,7 +1241,7 @@ describe Grape::API do
 
     it 'returns raw data when content type binary' do
       image_filename = 'grape.png'
-      file = File.open(image_filename, 'rb', &:read)
+      file = File.binread(image_filename)
       subject.format :binary
       subject.get('/binary_file') { File.binread(image_filename) }
       get '/binary_file'
@@ -1274,7 +1273,7 @@ describe Grape::API do
       get '/stream', {}, 'HTTP_VERSION' => 'HTTP/1.1', 'SERVER_PROTOCOL' => 'HTTP/1.1'
 
       expect(last_response.headers['Content-Type']).to eq('text/plain')
-      expect(last_response.headers['Content-Length']).to eq(nil)
+      expect(last_response.headers['Content-Length']).to be_nil
       expect(last_response.headers['Cache-Control']).to eq('no-cache')
       expect(last_response.headers['Transfer-Encoding']).to eq('chunked')
 
@@ -2292,7 +2291,7 @@ describe Grape::API do
       subject.rescue_from :all, with: :not_exist_method
       subject.get('/rescue_method') { raise StandardError }
 
-      expect { get '/rescue_method' }.to raise_error(NoMethodError, /^undefined method `not_exist_method'/)
+      expect { get '/rescue_method' }.to raise_error(NoMethodError, /^undefined method 'not_exist_method'/)
     end
 
     it 'correctly chooses exception handler if :all handler is specified' do
@@ -4158,6 +4157,20 @@ describe Grape::API do
     end
   end
 
+  context 'with non-UTF-8 characters in specified format' do
+    it 'converts the characters' do
+      subject.format :json
+      subject.content_type :json, 'application/json'
+      subject.get '/something' do
+        'foo'
+      end
+      get '/something?format=%0A%0B%BF'
+      expect(last_response.status).to eq(406)
+      message = "The requested format '\n\u000b\357\277\275' is not supported."
+      expect(last_response.body).to eq({ error: message }.to_json)
+    end
+  end
+
   context 'body' do
     context 'false' do
       before do

data/spec/grape/config_spec.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'spec_helper'
-
 describe '.configure' do
   before do
     Grape.configure do |config|

data/spec/grape/dsl/callbacks_spec.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'spec_helper'
-
 module Grape
   module DSL
     module CallbacksSpec

data/spec/grape/dsl/configuration_spec.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'spec_helper'
-
 module Grape
   module DSL
     module ConfigurationSpec

data/spec/grape/dsl/desc_spec.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'spec_helper'
-
 module Grape
   module DSL
     module DescSpec

data/spec/grape/dsl/headers_spec.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'spec_helper'
-
 module Grape
   module DSL
     module HeadersSpec
@@ -54,8 +52,8 @@ module Grape
       context 'when no headers are set' do
         describe '#header' do
           it 'returns nil' do
-            expect(subject.header['First Key']).to be nil
-            expect(subject.header('First Key')).to be nil
+            expect(subject.header['First Key']).to be_nil
+            expect(subject.header('First Key')).to be_nil
           end
         end
       end

data/spec/grape/dsl/helpers_spec.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'spec_helper'
-
 module Grape
   module DSL
     module HelpersSpec

data/spec/grape/dsl/inside_route_spec.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'spec_helper'
-
 module Grape
   module DSL
     module InsideRouteSpec
@@ -25,7 +23,7 @@ describe Grape::Endpoint do
 
   describe '#version' do
     it 'defaults to nil' do
-      expect(subject.version).to be nil
+      expect(subject.version).to be_nil
     end
 
     it 'returns env[api.version]' do
@@ -167,7 +165,7 @@ describe Grape::Endpoint do
     end
 
     it 'returns default' do
-      expect(subject.content_type).to be nil
+      expect(subject.content_type).to be_nil
     end
   end
 
@@ -200,7 +198,7 @@ describe Grape::Endpoint do
     end
 
     it 'returns default' do
-      expect(subject.body).to be nil
+      expect(subject.body).to be_nil
     end
   end
 
@@ -315,7 +313,7 @@ describe Grape::Endpoint do
     end
 
     it 'returns default' do
-      expect(subject.sendfile).to be nil
+      expect(subject.sendfile).to be_nil
     end
   end
 
@@ -362,13 +360,13 @@ describe Grape::Endpoint do
         it 'sets Content-Length header to nil' do
           subject.stream file_path
 
-          expect(subject.header['Content-Length']).to eq nil
+          expect(subject.header['Content-Length']).to be_nil
         end
 
         it 'sets Transfer-Encoding header to nil' do
           subject.stream file_path
 
-          expect(subject.header['Transfer-Encoding']).to eq nil
+          expect(subject.header['Transfer-Encoding']).to be_nil
         end
       end
 
@@ -406,13 +404,13 @@ describe Grape::Endpoint do
         it 'sets Content-Length header to nil' do
           subject.stream stream_object
 
-          expect(subject.header['Content-Length']).to eq nil
+          expect(subject.header['Content-Length']).to be_nil
         end
 
         it 'sets Transfer-Encoding header to nil' do
           subject.stream stream_object
 
-          expect(subject.header['Transfer-Encoding']).to eq nil
+          expect(subject.header['Transfer-Encoding']).to be_nil
         end
       end
 
@@ -426,8 +424,8 @@ describe Grape::Endpoint do
     end
 
     it 'returns default' do
-      expect(subject.stream).to be nil
-      expect(subject.header['Cache-Control']).to eq nil
+      expect(subject.stream).to be_nil
+      expect(subject.header['Cache-Control']).to be_nil
     end
   end
 

data/spec/grape/dsl/logger_spec.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'spec_helper'
-
 describe Grape::DSL::Logger do
   subject { Class.new(dummy_logger) }
 

data/spec/grape/dsl/middleware_spec.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'spec_helper'
-
 module Grape
   module DSL
     module MiddlewareSpec

data/spec/grape/dsl/parameters_spec.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'spec_helper'
-
 module Grape
   module DSL
     module ParametersSpec

data/spec/grape/dsl/request_response_spec.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'spec_helper'
-
 module Grape
   module DSL
     module RequestResponseSpec
@@ -162,34 +160,34 @@ module Grape
 
         describe 'list of exceptions is passed' do
           it 'sets hash of exceptions as rescue handlers' do
-            expect(subject).to receive(:namespace_reverse_stackable).with(:rescue_handlers, StandardError => nil)
+            expect(subject).to receive(:namespace_reverse_stackable).with(:rescue_handlers, { StandardError => nil })
             expect(subject).to receive(:namespace_stackable).with(:rescue_options, {})
             subject.rescue_from StandardError
           end
 
           it 'rescues only base handlers if rescue_subclasses: false option is passed' do
-            expect(subject).to receive(:namespace_reverse_stackable).with(:base_only_rescue_handlers, StandardError => nil)
-            expect(subject).to receive(:namespace_stackable).with(:rescue_options, rescue_subclasses: false)
+            expect(subject).to receive(:namespace_reverse_stackable).with(:base_only_rescue_handlers, { StandardError => nil })
+            expect(subject).to receive(:namespace_stackable).with(:rescue_options, { rescue_subclasses: false })
             subject.rescue_from StandardError, rescue_subclasses: false
           end
 
           it 'sets given proc as rescue handler for each key in hash' do
             rescue_handler_proc = proc {}
-            expect(subject).to receive(:namespace_reverse_stackable).with(:rescue_handlers, StandardError => rescue_handler_proc)
+            expect(subject).to receive(:namespace_reverse_stackable).with(:rescue_handlers, { StandardError => rescue_handler_proc })
             expect(subject).to receive(:namespace_stackable).with(:rescue_options, {})
             subject.rescue_from StandardError, rescue_handler_proc
           end
 
           it 'sets given block as rescue handler for each key in hash' do
             rescue_handler_proc = proc {}
-            expect(subject).to receive(:namespace_reverse_stackable).with(:rescue_handlers, StandardError => rescue_handler_proc)
+            expect(subject).to receive(:namespace_reverse_stackable).with(:rescue_handlers, { StandardError => rescue_handler_proc })
             expect(subject).to receive(:namespace_stackable).with(:rescue_options, {})
             subject.rescue_from StandardError, &rescue_handler_proc
           end
 
           it 'sets a rescue handler declared through :with option for each key in hash' do
             with_block = -> { 'hello' }
-            expect(subject).to receive(:namespace_reverse_stackable).with(:rescue_handlers, StandardError => an_instance_of(Proc))
+            expect(subject).to receive(:namespace_reverse_stackable).with(:rescue_handlers, { StandardError => an_instance_of(Proc) })
             expect(subject).to receive(:namespace_stackable).with(:rescue_options, {})
             subject.rescue_from StandardError, with: with_block
           end

data/spec/grape/dsl/routing_spec.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'spec_helper'
-
 module Grape
   module DSL
     module RoutingSpec
@@ -21,7 +19,7 @@ module Grape
         it 'sets a version for route' do
           version = 'v1'
           expect(subject).to receive(:namespace_inheritable).with(:version, [version])
-          expect(subject).to receive(:namespace_inheritable).with(:version_options, using: :path)
+          expect(subject).to receive(:namespace_inheritable).with(:version_options, { using: :path })
           expect(subject.version(version)).to eq(version)
         end
       end

data/spec/grape/dsl/settings_spec.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'spec_helper'
-
 module Grape
   module DSL
     module SettingsSpec

data/spec/grape/dsl/validations_spec.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'spec_helper'
-
 module Grape
   module DSL
     module ValidationsSpec
@@ -38,10 +36,6 @@ module Grape
           expect(subject.namespace_stackable(:params)).to eq []
         end
 
-        it 'resets documentation params' do
-          expect(subject.route_setting(:description)[:params]).to be_nil
-        end
-
         it 'does not reset documentation description' do
           expect(subject.route_setting(:description)[:description]).to eq 'lol'
         end
@@ -56,17 +50,6 @@ module Grape
           expect { subject.params { raise 'foo' } }.to raise_error RuntimeError, 'foo'
         end
       end
-
-      describe '.document_attribute' do
-        before do
-          subject.document_attribute([full_name: 'xxx'], foo: 'bar')
-        end
-
-        it 'creates a param documentation' do
-          expect(subject.namespace_stackable(:params)).to eq(['xxx' => { foo: 'bar' }])
-          expect(subject.route_setting(:description)).to eq(params: { 'xxx' => { foo: 'bar' } })
-        end
-      end
     end
   end
 end

data/spec/grape/endpoint/declared_spec.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'spec_helper'
-
 describe Grape::Endpoint do
   subject { Class.new(Grape::API) }
 
@@ -249,7 +247,7 @@ describe Grape::Endpoint do
       end
       get '/declared?first=one&other=two'
       expect(last_response.status).to eq(200)
-      expect(JSON.parse(last_response.body).key?(:other)).to eq false
+      expect(JSON.parse(last_response.body).key?(:other)).to be false
     end
 
     it 'stringifies if that option is passed' do
@@ -522,7 +520,7 @@ describe Grape::Endpoint do
       json = JSON.parse(last_response.body, symbolize_names: true)
 
       expect(json[:declared_params][:id]).to eq 123
-      expect(json[:declared_params_no_parent][:id]).to eq nil
+      expect(json[:declared_params_no_parent][:id]).to be_nil
     end
   end
 

data/spec/grape/endpoint_spec.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'spec_helper'
-
 describe Grape::Endpoint do
   subject { Class.new(Grape::API) }
 
@@ -434,7 +432,28 @@ describe Grape::Endpoint do
         end
         post '/upload', { file: '' }, 'CONTENT_TYPE' => 'multipart/form-data; boundary=foobar'
         expect(last_response.status).to eq(400)
-        expect(last_response.body).to eq('Empty message body supplied with multipart/form-data; boundary=foobar content-type')
+        expect(last_response.body).to eq('empty message body supplied with multipart/form-data; boundary=foobar content-type')
+      end
+    end
+
+    context 'when the limit on multipart files is exceeded' do
+      around do |example|
+        limit = Rack::Utils.multipart_part_limit
+        Rack::Utils.multipart_part_limit = 1
+        example.run
+        Rack::Utils.multipart_part_limit = limit
+      end
+
+      it 'returns a 413 if given too many multipart files' do
+        subject.params do
+          requires :file, type: Rack::Multipart::UploadedFile
+        end
+        subject.post '/upload' do
+          params[:file][:filename]
+        end
+        post '/upload', { file: Rack::Test::UploadedFile.new(__FILE__, 'text/plain'), extra: Rack::Test::UploadedFile.new(__FILE__, 'text/plain') }
+        expect(last_response.status).to eq(413)
+        expect(last_response.body).to eq("the number of uploaded files exceeded the system's configured limit (1)")
       end
     end
 

data/spec/grape/entity_spec.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 
-require 'spec_helper'
 require 'grape_entity'
 
 describe Grape::Entity do

data/spec/grape/exceptions/base_spec.rb

@@ -1,8 +1,22 @@
 # frozen_string_literal: true
 
-require 'spec_helper'
-
 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) }
 

data/spec/grape/exceptions/body_parse_errors_spec.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'spec_helper'
-
 describe Grape::Exceptions::ValidationErrors do
   context 'api with rescue_from :all handler' do
     subject { Class.new(Grape::API) }

data/spec/grape/exceptions/invalid_accept_header_spec.rb

@@ -1,7 +1,5 @@
 # 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

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,6 +1,5 @@
 # frozen_string_literal: true
 
-require 'spec_helper'
 require 'ostruct'
 
 describe Grape::Exceptions::ValidationErrors do