grape 1.5.2 → 1.6.2

data/spec/grape/middleware/formatter_spec.rb

@@ -3,7 +3,8 @@
 require 'spec_helper'
 
 describe Grape::Middleware::Formatter do
-  subject { Grape::Middleware::Formatter.new(app) }
+  subject { described_class.new(app) }
+
   before { allow(subject).to receive(:dup).and_return(subject) }
 
   let(:body) { { 'foo' => 'bar' } }
@@ -11,6 +12,7 @@ describe Grape::Middleware::Formatter do
 
   context 'serialization' do
     let(:body) { { 'abc' => 'def' } }
+
     it 'looks at the bodies for possibly serializable data' do
       _, _, bodies = *subject.call('PATH_INFO' => '/somewhere', 'HTTP_ACCEPT' => 'application/json')
       bodies.each { |b| expect(b).to eq(::Grape::Json.dump(body)) }
@@ -18,9 +20,10 @@ describe Grape::Middleware::Formatter do
 
     context 'default format' do
       let(:body) { ['foo'] }
+
       it 'calls #to_json since default format is json' do
         body.instance_eval do
-          def to_json
+          def to_json(*_args)
             '"bar"'
           end
         end
@@ -31,9 +34,10 @@ describe Grape::Middleware::Formatter do
 
     context 'jsonapi' do
       let(:body) { { 'foos' => [{ 'bar' => 'baz' }] } }
+
       it 'calls #to_json if the content type is jsonapi' do
         body.instance_eval do
-          def to_json
+          def to_json(*_args)
             '{"foos":[{"bar":"baz"}] }'
           end
         end
@@ -44,6 +48,7 @@ describe Grape::Middleware::Formatter do
 
     context 'xml' do
       let(:body) { +'string' }
+
       it 'calls #to_xml if the content type is xml' do
         body.instance_eval do
           def to_xml
@@ -58,6 +63,7 @@ describe Grape::Middleware::Formatter do
 
   context 'error handling' do
     let(:formatter) { double(:formatter) }
+
     before do
       allow(Grape::Formatter).to receive(:formatter_for) { formatter }
     end
@@ -67,7 +73,7 @@ describe Grape::Middleware::Formatter do
 
       expect do
         catch(:error) { subject.call('PATH_INFO' => '/somewhere.xml', 'HTTP_ACCEPT' => 'application/json') }
-      end.to_not raise_error
+      end.not_to raise_error
     end
 
     it 'does not rescue other exceptions' do
@@ -147,7 +153,7 @@ describe Grape::Middleware::Formatter do
         subject.options[:content_types][:custom] = 'application/vnd.test+json'
       end
 
-      it 'it uses the custom type' do
+      it 'uses the custom type' do
         subject.call('PATH_INFO' => '/info', 'HTTP_ACCEPT' => 'application/vnd.test+json')
         expect(subject.env['api.format']).to eq(:custom)
       end
@@ -164,26 +170,31 @@ describe Grape::Middleware::Formatter do
       _, headers, = subject.call('PATH_INFO' => '/info.json')
       expect(headers['Content-type']).to eq('application/json')
     end
+
     it 'is set for xml' do
       _, headers, = subject.call('PATH_INFO' => '/info.xml')
       expect(headers['Content-type']).to eq('application/xml')
     end
+
     it 'is set for txt' do
       _, headers, = subject.call('PATH_INFO' => '/info.txt')
       expect(headers['Content-type']).to eq('text/plain')
     end
+
     it 'is set for custom' do
       subject.options[:content_types] = {}
       subject.options[:content_types][:custom] = 'application/x-custom'
       _, headers, = subject.call('PATH_INFO' => '/info.custom')
       expect(headers['Content-type']).to eq('application/x-custom')
     end
+
     it 'is set for vendored with registered type' do
       subject.options[:content_types] = {}
       subject.options[:content_types][:custom] = 'application/vnd.test+json'
       _, headers, = subject.call('PATH_INFO' => '/info', 'HTTP_ACCEPT' => 'application/vnd.test+json')
       expect(headers['Content-type']).to eq('application/vnd.test+json')
     end
+
     it 'is set to closest generic for custom vendored/versioned without registered type' do
       _, headers, = subject.call('PATH_INFO' => '/info', 'HTTP_ACCEPT' => 'application/vnd.test+json')
       expect(headers['Content-type']).to eq('application/json')
@@ -198,13 +209,16 @@ describe Grape::Middleware::Formatter do
       _, _, body = subject.call('PATH_INFO' => '/info.custom')
       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(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')
@@ -272,6 +286,7 @@ describe Grape::Middleware::Formatter do
 
       context 'when body is nil' do
         let(:io) { double }
+
         before do
           allow(io).to receive_message_chain(:rewind, :read).and_return(nil)
         end
@@ -290,6 +305,7 @@ describe Grape::Middleware::Formatter do
 
       context 'when body is empty' do
         let(:io) { double }
+
         before do
           allow(io).to receive_message_chain(:rewind, :read).and_return('')
         end
@@ -334,6 +350,7 @@ describe Grape::Middleware::Formatter do
         expect(subject.env['rack.request.form_hash']['is_boolean']).to be true
         expect(subject.env['rack.request.form_hash']['string']).to eq('thing')
       end
+
       it 'rewinds IO' do
         io = StringIO.new('{"is_boolean":true,"string":"thing"}')
         io.read
@@ -347,6 +364,7 @@ describe Grape::Middleware::Formatter do
         expect(subject.env['rack.request.form_hash']['is_boolean']).to be true
         expect(subject.env['rack.request.form_hash']['string']).to eq('thing')
       end
+
       it "parses the body from an xml #{method} and copies values into rack.request.from_hash" do
         io = StringIO.new('<thing><name>Test</name></thing>')
         subject.call(
@@ -362,6 +380,7 @@ describe Grape::Middleware::Formatter do
           expect(subject.env['rack.request.form_hash']['thing']['name']['__content__']).to eq('Test')
         end
       end
+
       [Rack::Request::FORM_DATA_MEDIA_TYPES, Rack::Request::PARSEABLE_DATA_MEDIA_TYPES].flatten.each do |content_type|
         it "ignores #{content_type}" do
           io = StringIO.new('name=Other+Test+Thing')
@@ -400,10 +419,12 @@ describe Grape::Middleware::Formatter do
       end
     end
     let(:app) { ->(_env) { [200, {}, ['']] } }
+
     before do
       Grape::Formatter.register :invalid, InvalidFormatter
       Grape::ContentTypes.register :invalid, 'application/x-invalid'
     end
+
     after do
       Grape::ContentTypes.default_elements.delete(:invalid)
       Grape::Formatter.default_elements.delete(:invalid)
@@ -418,7 +439,7 @@ describe Grape::Middleware::Formatter do
 
   context 'custom parser raises exception and rescue options are enabled for backtrace and original_exception' do
     it 'adds the backtrace and original_exception to the error output' do
-      subject = Grape::Middleware::Formatter.new(
+      subject = described_class.new(
         app,
         rescue_options: { backtrace: true, original_exception: true },
         parsers: { json: ->(_object, _env) { raise StandardError, 'fail' } }

data/spec/grape/middleware/globals_spec.rb

@@ -3,7 +3,8 @@
 require 'spec_helper'
 
 describe Grape::Middleware::Globals do
-  subject { Grape::Middleware::Globals.new(blank_app) }
+  subject { described_class.new(blank_app) }
+
   before { allow(subject).to receive(:dup).and_return(subject) }
 
   let(:blank_app) { ->(_env) { [200, {}, 'Hi there.'] } }
@@ -13,15 +14,17 @@ describe Grape::Middleware::Globals do
   end
 
   context 'environment' do
-    it 'should set the grape.request environment' do
+    it 'sets the grape.request environment' do
       subject.call({})
       expect(subject.env['grape.request']).to be_a(Grape::Request)
     end
-    it 'should set the grape.request.headers environment' do
+
+    it 'sets the grape.request.headers environment' do
       subject.call({})
       expect(subject.env['grape.request.headers']).to be_a(Hash)
     end
-    it 'should set the grape.request.params environment' do
+
+    it 'sets the grape.request.params environment' do
       subject.call('QUERY_STRING' => 'test=1', 'rack.input' => StringIO.new)
       expect(subject.env['grape.request.params']).to be_a(Hash)
     end

data/spec/grape/middleware/stack_spec.rb

@@ -5,7 +5,9 @@ require 'spec_helper'
 describe Grape::Middleware::Stack do
   module StackSpec
     class FooMiddleware; end
+
     class BarMiddleware; end
+
     class BlockMiddleware
       attr_reader :block
 
@@ -15,10 +17,10 @@ describe Grape::Middleware::Stack do
     end
   end
 
-  let(:proc) { ->() {} }
-  let(:others) { [[:use, StackSpec::BarMiddleware], [:insert_before, StackSpec::BarMiddleware, StackSpec::BlockMiddleware, proc]] }
+  subject { described_class.new }
 
-  subject { Grape::Middleware::Stack.new }
+  let(:proc) { -> {} }
+  let(:others) { [[:use, StackSpec::BarMiddleware], [:insert_before, StackSpec::BarMiddleware, StackSpec::BlockMiddleware, proc]] }
 
   before do
     subject.use StackSpec::FooMiddleware
@@ -27,20 +29,20 @@ describe Grape::Middleware::Stack do
   describe '#use' do
     it 'pushes a middleware class onto the stack' do
       expect { subject.use StackSpec::BarMiddleware }
-        .to change { subject.size }.by(1)
+        .to change(subject, :size).by(1)
       expect(subject.last).to eq(StackSpec::BarMiddleware)
     end
 
     it 'pushes a middleware class with arguments onto the stack' do
       expect { subject.use StackSpec::BarMiddleware, false, my_arg: 42 }
-        .to change { subject.size }.by(1)
+        .to change(subject, :size).by(1)
       expect(subject.last).to eq(StackSpec::BarMiddleware)
       expect(subject.last.args).to eq([false, { my_arg: 42 }])
     end
 
     it 'pushes a middleware class with block arguments onto the stack' do
       expect { subject.use StackSpec::BlockMiddleware, &proc }
-        .to change { subject.size }.by(1)
+        .to change(subject, :size).by(1)
       expect(subject.last).to eq(StackSpec::BlockMiddleware)
       expect(subject.last.args).to eq([])
       expect(subject.last.block).to eq(proc)
@@ -50,7 +52,7 @@ describe Grape::Middleware::Stack do
   describe '#insert' do
     it 'inserts a middleware class at the integer index' do
       expect { subject.insert 0, StackSpec::BarMiddleware }
-        .to change { subject.size }.by(1)
+        .to change(subject, :size).by(1)
       expect(subject[0]).to eq(StackSpec::BarMiddleware)
       expect(subject[1]).to eq(StackSpec::FooMiddleware)
     end
@@ -59,7 +61,7 @@ describe Grape::Middleware::Stack do
   describe '#insert_before' do
     it 'inserts a middleware before another middleware class' do
       expect { subject.insert_before StackSpec::FooMiddleware, StackSpec::BarMiddleware }
-        .to change { subject.size }.by(1)
+        .to change(subject, :size).by(1)
       expect(subject[0]).to eq(StackSpec::BarMiddleware)
       expect(subject[1]).to eq(StackSpec::FooMiddleware)
     end
@@ -68,7 +70,7 @@ describe Grape::Middleware::Stack do
       subject.use Class.new(StackSpec::BlockMiddleware)
 
       expect { subject.insert_before StackSpec::BlockMiddleware, StackSpec::BarMiddleware }
-        .to change { subject.size }.by(1)
+        .to change(subject, :size).by(1)
 
       expect(subject[1]).to eq(StackSpec::BarMiddleware)
       expect(subject[2]).to eq(StackSpec::BlockMiddleware)
@@ -83,7 +85,7 @@ describe Grape::Middleware::Stack do
   describe '#insert_after' do
     it 'inserts a middleware after another middleware class' do
       expect { subject.insert_after StackSpec::FooMiddleware, StackSpec::BarMiddleware }
-        .to change { subject.size }.by(1)
+        .to change(subject, :size).by(1)
       expect(subject[1]).to eq(StackSpec::BarMiddleware)
       expect(subject[0]).to eq(StackSpec::FooMiddleware)
     end
@@ -92,7 +94,7 @@ describe Grape::Middleware::Stack do
       subject.use Class.new(StackSpec::BlockMiddleware)
 
       expect { subject.insert_after StackSpec::BlockMiddleware, StackSpec::BarMiddleware }
-        .to change { subject.size }.by(1)
+        .to change(subject, :size).by(1)
 
       expect(subject[1]).to eq(StackSpec::BlockMiddleware)
       expect(subject[2]).to eq(StackSpec::BarMiddleware)
@@ -107,7 +109,7 @@ describe Grape::Middleware::Stack do
   describe '#merge_with' do
     it 'applies a collection of operations and middlewares' do
       expect { subject.merge_with(others) }
-        .to change { subject.size }.by(2)
+        .to change(subject, :size).by(2)
       expect(subject[0]).to eq(StackSpec::FooMiddleware)
       expect(subject[1]).to eq(StackSpec::BlockMiddleware)
       expect(subject[2]).to eq(StackSpec::BarMiddleware)

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

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

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

@@ -3,8 +3,9 @@
 require 'spec_helper'
 
 describe Grape::Middleware::Versioner::Header do
+  subject { described_class.new(app, **(@options || {})) }
+
   let(:app) { ->(env) { [200, env, env] } }
-  subject { Grape::Middleware::Versioner::Header.new(app, **(@options || {})) }
 
   before do
     @options = {
@@ -47,7 +48,7 @@ describe Grape::Middleware::Versioner::Header do
 
     it 'is nil if not provided' do
       status, _, env = subject.call('HTTP_ACCEPT' => 'application/vnd.vendor')
-      expect(env['api.format']).to eql nil
+      expect(env['api.format']).to be nil
       expect(status).to eq(200)
     end
 
@@ -65,7 +66,7 @@ describe Grape::Middleware::Versioner::Header do
 
         it 'is nil if not provided' do
           status, _, env = subject.call('HTTP_ACCEPT' => 'application/vnd.vendor-v1')
-          expect(env['api.format']).to eql nil
+          expect(env['api.format']).to be nil
           expect(status).to eq(200)
         end
       end
@@ -90,7 +91,7 @@ describe Grape::Middleware::Versioner::Header do
         .to raise_exception do |exception|
           expect(exception).to be_a(Grape::Exceptions::InvalidAcceptHeader)
           expect(exception.headers).to eql('X-Cascade' => 'pass')
-          expect(exception.status).to eql 406
+          expect(exception.status).to be 406
           expect(exception.message).to include 'API vendor not found'
         end
     end
@@ -117,7 +118,7 @@ describe Grape::Middleware::Versioner::Header do
           .to raise_exception do |exception|
             expect(exception).to be_a(Grape::Exceptions::InvalidAcceptHeader)
             expect(exception.headers).to eql('X-Cascade' => 'pass')
-            expect(exception.status).to eql 406
+            expect(exception.status).to be 406
             expect(exception.message).to include('API vendor not found')
           end
       end
@@ -145,7 +146,7 @@ describe Grape::Middleware::Versioner::Header do
       expect { subject.call('HTTP_ACCEPT' => 'application/vnd.vendor-v2+json').last }.to raise_exception do |exception|
         expect(exception).to be_a(Grape::Exceptions::InvalidVersionHeader)
         expect(exception.headers).to eql('X-Cascade' => 'pass')
-        expect(exception.status).to eql 406
+        expect(exception.status).to be 406
         expect(exception.message).to include('API version not found')
       end
     end
@@ -178,7 +179,7 @@ describe Grape::Middleware::Versioner::Header do
       expect { subject.call({}).last }.to raise_exception do |exception|
         expect(exception).to be_a(Grape::Exceptions::InvalidAcceptHeader)
         expect(exception.headers).to eql('X-Cascade' => 'pass')
-        expect(exception.status).to eql 406
+        expect(exception.status).to be 406
         expect(exception.message).to include('Accept header must be set.')
       end
     end
@@ -187,7 +188,7 @@ describe Grape::Middleware::Versioner::Header do
       expect { subject.call('HTTP_ACCEPT' => '').last }.to raise_exception do |exception|
         expect(exception).to be_a(Grape::Exceptions::InvalidAcceptHeader)
         expect(exception.headers).to eql('X-Cascade' => 'pass')
-        expect(exception.status).to eql 406
+        expect(exception.status).to be 406
         expect(exception.message).to include('Accept header must be set.')
       end
     end
@@ -208,7 +209,7 @@ describe Grape::Middleware::Versioner::Header do
       expect { subject.call({}).last }.to raise_exception do |exception|
         expect(exception).to be_a(Grape::Exceptions::InvalidAcceptHeader)
         expect(exception.headers).to eql({})
-        expect(exception.status).to eql 406
+        expect(exception.status).to be 406
         expect(exception.message).to include('Accept header must be set.')
       end
     end
@@ -218,7 +219,7 @@ describe Grape::Middleware::Versioner::Header do
         .to raise_exception do |exception|
         expect(exception).to be_a(Grape::Exceptions::InvalidAcceptHeader)
         expect(exception.headers).to eql({})
-        expect(exception.status).to eql 406
+        expect(exception.status).to be 406
         expect(exception.message).to include('API vendor or version not found.')
       end
     end
@@ -227,7 +228,7 @@ describe Grape::Middleware::Versioner::Header do
       expect { subject.call('HTTP_ACCEPT' => '').last }.to raise_exception do |exception|
         expect(exception).to be_a(Grape::Exceptions::InvalidAcceptHeader)
         expect(exception.headers).to eql({})
-        expect(exception.status).to eql 406
+        expect(exception.status).to be 406
         expect(exception.message).to include('Accept header must be set.')
       end
     end
@@ -237,7 +238,7 @@ describe Grape::Middleware::Versioner::Header do
         .to raise_exception do |exception|
         expect(exception).to be_a(Grape::Exceptions::InvalidAcceptHeader)
         expect(exception.headers).to eql({})
-        expect(exception.status).to eql 406
+        expect(exception.status).to be 406
         expect(exception.message).to include('API vendor or version not found.')
       end
     end
@@ -264,7 +265,7 @@ describe Grape::Middleware::Versioner::Header do
       expect { subject.call('HTTP_ACCEPT' => 'application/vnd.vendor-v3+json') }.to raise_exception do |exception|
         expect(exception).to be_a(Grape::Exceptions::InvalidVersionHeader)
         expect(exception.headers).to eql('X-Cascade' => 'pass')
-        expect(exception.status).to eql 406
+        expect(exception.status).to be 406
         expect(exception.message).to include('API version not found')
       end
     end

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

@@ -3,9 +3,10 @@
 require 'spec_helper'
 
 describe Grape::Middleware::Versioner::Param do
+  subject { described_class.new(app, **options) }
+
   let(:app) { ->(env) { [200, env, env['api.version']] } }
   let(: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' })
@@ -26,10 +27,12 @@ describe Grape::Middleware::Versioner::Param do
 
   context 'with specified parameter name' do
     let(:options) { { version_options: { parameter: 'v' } } }
+
     it 'sets the API version based on the custom parameter name' do
       env = Rack::MockRequest.env_for('/awesome', params: { 'v' => 'v1' })
       expect(subject.call(env)[1]['api.version']).to eq('v1')
     end
+
     it 'does not set the API version based on the default param' do
       env = Rack::MockRequest.env_for('/awesome', params: { 'apiver' => 'v1' })
       expect(subject.call(env)[1]['api.version']).to be_nil
@@ -38,10 +41,12 @@ describe Grape::Middleware::Versioner::Param do
 
   context 'with specified versions' do
     let(:options) { { versions: %w[v1 v2] } }
+
     it 'throws an error if a non-allowed version is specified' do
       env = Rack::MockRequest.env_for('/awesome', params: { 'apiver' => 'v3' })
       expect(catch(:error) { subject.call(env) }[:status]).to eq(404)
     end
+
     it 'allows versions that have been specified' do
       env = Rack::MockRequest.env_for('/awesome', params: { 'apiver' => 'v1' })
       expect(subject.call(env)[1]['api.version']).to eq('v1')
@@ -55,6 +60,7 @@ describe Grape::Middleware::Versioner::Param do
         version_options: { using: :header }
       }
     end
+
     it 'returns a 200 (matches the first version found)' do
       env = Rack::MockRequest.env_for('/awesome', params: {})
       expect(subject.call(env).first).to eq(200)

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

@@ -3,9 +3,10 @@
 require 'spec_helper'
 
 describe Grape::Middleware::Versioner::Path do
+  subject { described_class.new(app, **options) }
+
   let(:app) { ->(env) { [200, env, env['api.version']] } }
   let(: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')
@@ -21,6 +22,7 @@ describe Grape::Middleware::Versioner::Path do
 
   context 'with a pattern' do
     let(:options) { { pattern: /v./i } }
+
     it 'sets the version if it matches' do
       expect(subject.call('PATH_INFO' => '/v1/awesome').last).to eq('v1')
     end
@@ -46,6 +48,7 @@ describe Grape::Middleware::Versioner::Path do
 
   context 'with prefix, but requested version is not matched' do
     let(:options) { { prefix: '/v1', pattern: /v./i } }
+
     it 'recognizes potential version' do
       expect(subject.call('PATH_INFO' => '/v3/foo').last).to eq('v3')
     end
@@ -53,6 +56,7 @@ describe Grape::Middleware::Versioner::Path do
 
   context 'with mount path' do
     let(:options) { { mount_path: '/mounted', versions: [:v1] } }
+
     it 'recognizes potential version' do
       expect(subject.call('PATH_INFO' => '/mounted/v1/foo').last).to eq('v1')
     end

data/spec/grape/middleware/versioner_spec.rb

@@ -3,7 +3,7 @@
 require 'spec_helper'
 
 describe Grape::Middleware::Versioner do
-  let(:klass) { Grape::Middleware::Versioner }
+  let(:klass) { described_class }
 
   it 'recognizes :path' do
     expect(klass.using(:path)).to eq(Grape::Middleware::Versioner::Path)

data/spec/grape/parser_spec.rb

@@ -26,6 +26,7 @@ describe Grape::Parser do
 
     context 'with :parsers option' do
       let(:parsers) { { customized: Class.new } }
+
       it 'includes passed :parsers values' do
         expect(subject.parsers(parsers: parsers)).to include(parsers)
       end
@@ -33,7 +34,9 @@ describe Grape::Parser do
 
     context 'with added parser by using `register` keyword' 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)
       end
@@ -54,6 +57,7 @@ describe Grape::Parser do
 
     context 'when parser is available' do
       before { subject.register :customized_json, Grape::Parser::Json }
+
       it 'returns registered parser if available' do
         expect(subject.parser_for(:customized_json)).to eq(Grape::Parser::Json)
       end