grape 1.1.0 → 1.5.3

data/spec/grape/middleware/exception_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe Grape::Middleware::Error do
@@ -53,7 +55,7 @@ describe Grape::Middleware::Error do
     class CustomErrorApp
       class << self
         def call(_env)
-          raise CustomError, status: 400, message: 'failed validation'
+          raise CustomError.new(status: 400, message: 'failed validation')
         end
       end
     end
@@ -128,7 +130,7 @@ describe Grape::Middleware::Error do
       subject do
         Rack::Builder.app do
           use Spec::Support::EndpointFaker
-          use Grape::Middleware::Error, rescue_handlers: { NotImplementedError => -> { [200, {}, 'rescued'] } }
+          use Grape::Middleware::Error, rescue_handlers: { NotImplementedError => -> { Rack::Response.new('rescued', 200, {}) } }
           run ExceptionSpec::OtherExceptionApp
         end
       end

data/spec/grape/middleware/formatter_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe Grape::Middleware::Formatter do
@@ -41,7 +43,7 @@ describe Grape::Middleware::Formatter do
     end
 
     context 'xml' do
-      let(:body) { 'string' }
+      let(:body) { +'string' }
       it 'calls #to_xml if the content type is xml' do
         body.instance_eval do
           def to_xml
@@ -194,26 +196,32 @@ describe Grape::Middleware::Formatter do
       subject.options[:content_types][:custom] = "don't care"
       subject.options[:formatters][:custom] = ->(_obj, _env) { 'CUSTOM FORMAT' }
       _, _, body = subject.call('PATH_INFO' => '/info.custom')
-      expect(body.body).to eq(['CUSTOM FORMAT'])
+      expect(read_chunks(body)).to eq(['CUSTOM FORMAT'])
     end
     context 'default' do
       let(:body) { ['blah'] }
       it 'uses default json formatter' do
         _, _, body = subject.call('PATH_INFO' => '/info.json')
-        expect(body.body).to eq(['["blah"]'])
+        expect(read_chunks(body)).to eq(['["blah"]'])
       end
     end
     it 'uses custom json formatter' do
       subject.options[:formatters][:json] = ->(_obj, _env) { 'CUSTOM JSON FORMAT' }
       _, _, body = subject.call('PATH_INFO' => '/info.json')
-      expect(body.body).to eq(['CUSTOM JSON FORMAT'])
+      expect(read_chunks(body)).to eq(['CUSTOM JSON FORMAT'])
     end
   end
 
   context 'no content responses' do
     let(:no_content_response) { ->(status) { [status, {}, ['']] } }
 
-    Rack::Utils::STATUS_WITH_NO_ENTITY_BODY.each do |status|
+    STATUSES_WITHOUT_BODY = if Gem::Version.new(Rack.release) >= Gem::Version.new('2.1.0')
+                              Rack::Utils::STATUS_WITH_NO_ENTITY_BODY.keys
+                            else
+                              Rack::Utils::STATUS_WITH_NO_ENTITY_BODY
+                            end
+
+    STATUSES_WITHOUT_BODY.each do |status|
       it "does not modify a #{status} response" do
         expected_response = no_content_response[status]
         allow(app).to receive(:call).and_return(expected_response)
@@ -247,7 +255,7 @@ describe Grape::Middleware::Formatter do
           let(:content_type) { 'application/atom+xml' }
 
           it 'returns a 415 HTTP error status' do
-            error = catch(:error) {
+            error = catch(:error) do
               subject.call(
                 'PATH_INFO' => '/info',
                 'REQUEST_METHOD' => method,
@@ -255,7 +263,7 @@ describe Grape::Middleware::Formatter do
                 'rack.input' => io,
                 'CONTENT_LENGTH' => io.length
               )
-            }
+            end
             expect(error[:status]).to eq(415)
             expect(error[:message]).to eq("The provided content-type 'application/atom+xml' is not supported.")
           end
@@ -371,12 +379,17 @@ describe Grape::Middleware::Formatter do
   end
 
   context 'send file' do
-    let(:body) { Grape::ServeFile::FileResponse.new('file') }
-    let(:app) { ->(_env) { [200, {}, body] } }
+    let(:file) { double(File) }
+    let(:file_body) { Grape::ServeStream::StreamResponse.new(file) }
+    let(:app) { ->(_env) { [200, {}, file_body] } }
 
-    it 'returns Grape::Uril::SendFileReponse' do
+    it 'returns a file response' do
+      expect(file).to receive(:each).and_yield('data')
       env = { 'PATH_INFO' => '/somewhere', 'HTTP_ACCEPT' => 'application/json' }
-      expect(subject.call(env)).to be_a(Grape::ServeFile::SendfileResponse)
+      status, headers, body = subject.call(env)
+      expect(status).to be == 200
+      expect(headers).to be == { 'Content-Type' => 'application/json' }
+      expect(read_chunks(body)).to be == ['data']
     end
   end
 
@@ -389,13 +402,17 @@ describe Grape::Middleware::Formatter do
     let(:app) { ->(_env) { [200, {}, ['']] } }
     before do
       Grape::Formatter.register :invalid, InvalidFormatter
-      Grape::ContentTypes::CONTENT_TYPES[:invalid] = 'application/x-invalid'
+      Grape::ContentTypes.register :invalid, 'application/x-invalid'
+    end
+    after do
+      Grape::ContentTypes.default_elements.delete(:invalid)
+      Grape::Formatter.default_elements.delete(:invalid)
     end
 
     it 'returns response by invalid formatter' do
       env = { 'PATH_INFO' => '/hello.invalid', 'HTTP_ACCEPT' => 'application/x-invalid' }
-      _, _, bodies = *subject.call(env)
-      expect(bodies.body.first).to eq({ message: 'invalid' }.to_json)
+      _, _, body = *subject.call(env)
+      expect(read_chunks(body).join).to eq({ message: 'invalid' }.to_json)
     end
   end
 
@@ -407,7 +424,7 @@ describe Grape::Middleware::Formatter do
         parsers: { json: ->(_object, _env) { raise StandardError, 'fail' } }
       )
       io = StringIO.new('{invalid}')
-      error = catch(:error) {
+      error = catch(:error) do
         subject.call(
           'PATH_INFO' => '/info',
           'REQUEST_METHOD' => 'POST',
@@ -415,7 +432,7 @@ describe Grape::Middleware::Formatter do
           'rack.input' => io,
           'CONTENT_LENGTH' => io.length
         )
-      }
+      end
 
       expect(error[:message]).to eq 'fail'
       expect(error[:backtrace].size).to be >= 1

data/spec/grape/middleware/globals_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe Grape::Middleware::Globals do

data/spec/grape/middleware/stack_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe Grape::Middleware::Stack do
@@ -6,6 +8,7 @@ describe Grape::Middleware::Stack do
     class BarMiddleware; end
     class BlockMiddleware
       attr_reader :block
+
       def initialize(&block)
         @block = block
       end
@@ -109,6 +112,15 @@ describe Grape::Middleware::Stack do
       expect(subject[1]).to eq(StackSpec::BlockMiddleware)
       expect(subject[2]).to eq(StackSpec::BarMiddleware)
     end
+
+    context 'middleware spec with proc declaration exists' do
+      let(:middleware_spec_with_proc) { [:use, StackSpec::FooMiddleware, proc] }
+
+      it 'properly forwards spec arguments' do
+        expect(subject).to receive(:use).with(StackSpec::FooMiddleware)
+        subject.merge_with([middleware_spec_with_proc])
+      end
+    end
   end
 
   describe '#build' do

data/spec/grape/middleware/versioner/accept_version_header_spec.rb

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe Grape::Middleware::Versioner::AcceptVersionHeader do
   let(:app) { ->(env) { [200, env, env] } }
-  subject { Grape::Middleware::Versioner::AcceptVersionHeader.new(app, @options || {}) }
+  subject { Grape::Middleware::Versioner::AcceptVersionHeader.new(app, **(@options || {})) }
 
   before do
     @options = {

data/spec/grape/middleware/versioner/header_spec.rb

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe Grape::Middleware::Versioner::Header do
   let(:app) { ->(env) { [200, env, env] } }
-  subject { Grape::Middleware::Versioner::Header.new(app, @options || {}) }
+  subject { Grape::Middleware::Versioner::Header.new(app, **(@options || {})) }
 
   before do
     @options = {
@@ -160,6 +162,12 @@ describe Grape::Middleware::Versioner::Header do
     expect(subject.call({}).first).to eq(200)
   end
 
+  it 'succeeds if :strict is set to false and given an invalid header' do
+    @options[:version_options][:strict] = false
+    expect(subject.call('HTTP_ACCEPT' => 'yaml').first).to eq(200)
+    expect(subject.call({}).first).to eq(200)
+  end
+
   context 'when :strict is set' do
     before do
       @options[:versions] = ['v1']

data/spec/grape/middleware/versioner/param_spec.rb

@@ -1,9 +1,11 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe Grape::Middleware::Versioner::Param do
   let(:app) { ->(env) { [200, env, env['api.version']] } }
   let(:options) { {} }
-  subject { Grape::Middleware::Versioner::Param.new(app, options) }
+  subject { Grape::Middleware::Versioner::Param.new(app, **options) }
 
   it 'sets the API version based on the default param (apiver)' do
     env = Rack::MockRequest.env_for('/awesome', params: { 'apiver' => 'v1' })

data/spec/grape/middleware/versioner/path_spec.rb

@@ -1,9 +1,11 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe Grape::Middleware::Versioner::Path do
   let(:app) { ->(env) { [200, env, env['api.version']] } }
   let(:options) { {} }
-  subject { Grape::Middleware::Versioner::Path.new(app, options) }
+  subject { Grape::Middleware::Versioner::Path.new(app, **options) }
 
   it 'sets the API version based on the first path' do
     expect(subject.call('PATH_INFO' => '/v1/awesome').last).to eq('v1')

data/spec/grape/middleware/versioner_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe Grape::Middleware::Versioner do

data/spec/grape/named_api_spec.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe 'A named API' do
+  subject(:api_name) { NamedAPI.endpoints.last.options[:for].to_s }
+
+  let(:api) do
+    Class.new(Grape::API) do
+      get 'test' do
+        'response'
+      end
+    end
+  end
+
+  before { stub_const('NamedAPI', api) }
+
+  it 'can access the name of the API' do
+    expect(api_name).to eq 'NamedAPI'
+  end
+end

data/spec/grape/parser_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe Grape::Parser do
@@ -15,11 +17,11 @@ describe Grape::Parser do
 
   describe '.parsers' do
     it 'returns an instance of Hash' do
-      expect(subject.parsers({})).to be_an_instance_of(Hash)
+      expect(subject.parsers(**{})).to be_an_instance_of(Hash)
     end
 
     it 'includes built-in parsers' do
-      expect(subject.parsers({})).to include(subject.builtin_parsers)
+      expect(subject.parsers(**{})).to include(subject.builtin_parsers)
     end
 
     context 'with :parsers option' do
@@ -33,7 +35,7 @@ describe Grape::Parser do
       let(:added_parser) { Class.new }
       before { subject.register :added, added_parser }
       it 'includes added parser' do
-        expect(subject.parsers({})).to include(added: added_parser)
+        expect(subject.parsers(**{})).to include(added: added_parser)
       end
     end
   end
@@ -42,8 +44,8 @@ describe Grape::Parser do
     let(:options) { {} }
 
     it 'calls .parsers' do
-      expect(subject).to receive(:parsers).with(options).and_return(subject.builtin_parsers)
-      subject.parser_for(:json, options)
+      expect(subject).to receive(:parsers).with(any_args).and_return(subject.builtin_parsers)
+      subject.parser_for(:json, **options)
     end
 
     it 'returns parser correctly' do

data/spec/grape/path_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 module Grape
@@ -85,12 +87,12 @@ module Grape
     describe '#namespace?' do
       it 'is false when the namespace is nil' do
         path = Path.new(anything, nil, anything)
-        expect(path.namespace?).to be nil
+        expect(path.namespace?).to be_falsey
       end
 
       it 'is false when the namespace starts with whitespace' do
         path = Path.new(anything, ' /foo', anything)
-        expect(path.namespace?).to be nil
+        expect(path.namespace?).to be_falsey
       end
 
       it 'is false when the namespace is the root path' do
@@ -107,12 +109,12 @@ module Grape
     describe '#path?' do
       it 'is false when the path is nil' do
         path = Path.new(nil, anything, anything)
-        expect(path.path?).to be nil
+        expect(path.path?).to be_falsey
       end
 
       it 'is false when the path starts with whitespace' do
         path = Path.new(' /foo', anything, anything)
-        expect(path.path?).to be nil
+        expect(path.path?).to be_falsey
       end
 
       it 'is false when the path is the root path' do

data/spec/grape/presenters/presenter_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 module Grape

data/spec/grape/request_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 module Grape
@@ -62,6 +64,30 @@ module Grape
       end
     end
 
+    describe 'when the param_builder is set to Hashie' do
+      before do
+        Grape.configure do |config|
+          config.param_builder = Grape::Extensions::Hashie::Mash::ParamBuilder
+        end
+      end
+
+      after do
+        Grape.config.reset
+      end
+
+      subject(:request_params) { Grape::Request.new(env, **opts).params }
+
+      context 'when the API does not include a specific param builder' do
+        let(:opts) { {} }
+        it { is_expected.to be_a(Hashie::Mash) }
+      end
+
+      context 'when the API includes a specific param builder' do
+        let(:opts) { { build_params_with: Grape::Extensions::Hash::ParamBuilder } }
+        it { is_expected.to be_a(Hash) }
+      end
+    end
+
     describe '#headers' do
       let(:options) do
         default_options.merge(request_headers)

data/spec/grape/util/inheritable_setting_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 module Grape
   module Util

data/spec/grape/util/inheritable_values_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 module Grape
   module Util

data/spec/grape/util/reverse_stackable_values_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 module Grape
   module Util

data/spec/grape/util/stackable_values_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 module Grape
   module Util
@@ -6,7 +8,7 @@ module Grape
       subject { StackableValues.new(parent) }
 
       describe '#keys' do
-        it 'returns all key' do
+        it 'returns all keys' do
           subject[:some_thing] = :foo_bar
           subject[:some_thing_else] = :foo_bar
           expect(subject.keys).to eq %i[some_thing some_thing_else].sort

data/spec/grape/util/strict_hash_configuration_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 module Grape
   module Util