grape 1.5.2 → 1.7.0

data/spec/grape/middleware/exception_spec.rb

@@ -1,78 +1,82 @@
 # frozen_string_literal: true
 
-require 'spec_helper'
-
 describe Grape::Middleware::Error do
-  # raises a text exception
-  module ExceptionSpec
-    class ExceptionApp
+  let(:exception_app) do
+    Class.new do
       class << self
         def call(_env)
           raise 'rain!'
         end
       end
     end
+  end
 
-    # raises a non-StandardError (ScriptError) exception
-    class OtherExceptionApp
+  let(:other_exception_app) do
+    Class.new do
       class << self
         def call(_env)
           raise NotImplementedError, 'snow!'
         end
       end
     end
+  end
 
-    # raises a hash error
-    class ErrorHashApp
+  let(:custom_error_app) do
+    Class.new do
       class << self
-        def error!(message, status)
-          throw :error, message: { error: message, detail: 'missing widget' }, status: status
-        end
+        class CustomError < Grape::Exceptions::Base; end
 
         def call(_env)
-          error!('rain!', 401)
+          raise CustomError.new(status: 400, message: 'failed validation')
         end
       end
     end
+  end
 
-    # raises an error!
-    class AccessDeniedApp
+  let(:error_hash_app) do
+    Class.new do
       class << self
         def error!(message, status)
-          throw :error, message: message, status: status
+          throw :error, message: { error: message, detail: 'missing widget' }, status: status
         end
 
         def call(_env)
-          error!('Access Denied', 401)
+          error!('rain!', 401)
         end
       end
     end
+  end
 
-    # raises a custom error
-    class CustomError < Grape::Exceptions::Base
-    end
-
-    class CustomErrorApp
+  let(:access_denied_app) do
+    Class.new do
       class << self
+        def error!(message, status)
+          throw :error, message: message, status: status
+        end
+
         def call(_env)
-          raise CustomError.new(status: 400, message: 'failed validation')
+          error!('Access Denied', 401)
         end
       end
     end
   end
 
-  def app
-    subject
+  let(:app) do
+    builder = Rack::Builder.new
+    builder.use Spec::Support::EndpointFaker
+    if options.any?
+      builder.use described_class, options
+    else
+      builder.use described_class
+    end
+    builder.run running_app
+    builder.to_app
   end
 
   context 'with defaults' do
-    subject do
-      Rack::Builder.app do
-        use Spec::Support::EndpointFaker
-        use Grape::Middleware::Error
-        run ExceptionSpec::ExceptionApp
-      end
-    end
+    let(:running_app) { exception_app }
+    let(:options) { {} }
+
     it 'does not trap errors by default' do
       expect { get '/' }.to raise_error(RuntimeError, 'rain!')
     end
@@ -80,17 +84,14 @@ describe Grape::Middleware::Error do
 
   context 'with rescue_all' do
     context 'StandardError exception' do
-      subject do
-        Rack::Builder.app do
-          use Spec::Support::EndpointFaker
-          use Grape::Middleware::Error, rescue_all: true
-          run ExceptionSpec::ExceptionApp
-        end
-      end
+      let(:running_app) { exception_app }
+      let(:options) { { rescue_all: true } }
+
       it 'sets the message appropriately' do
         get '/'
         expect(last_response.body).to eq('rain!')
       end
+
       it 'defaults to a 500 status' do
         get '/'
         expect(last_response.status).to eq(500)
@@ -98,13 +99,9 @@ describe Grape::Middleware::Error do
     end
 
     context 'Non-StandardError exception' do
-      subject do
-        Rack::Builder.app do
-          use Spec::Support::EndpointFaker
-          use Grape::Middleware::Error, rescue_all: true
-          run ExceptionSpec::OtherExceptionApp
-        end
-      end
+      let(:running_app) { other_exception_app }
+      let(:options) { { rescue_all: true } }
+
       it 'does not trap errors other than StandardError' do
         expect { get '/' }.to raise_error(NotImplementedError, 'snow!')
       end
@@ -113,13 +110,9 @@ describe Grape::Middleware::Error do
 
   context 'Non-StandardError exception with a provided rescue handler' do
     context 'default error response' do
-      subject do
-        Rack::Builder.app do
-          use Spec::Support::EndpointFaker
-          use Grape::Middleware::Error, rescue_handlers: { NotImplementedError => nil }
-          run ExceptionSpec::OtherExceptionApp
-        end
-      end
+      let(:running_app) { other_exception_app }
+      let(:options) { { rescue_handlers: { NotImplementedError => nil } } }
+
       it 'rescues the exception using the default handler' do
         get '/'
         expect(last_response.body).to eq('snow!')
@@ -127,13 +120,9 @@ describe Grape::Middleware::Error do
     end
 
     context 'custom error response' do
-      subject do
-        Rack::Builder.app do
-          use Spec::Support::EndpointFaker
-          use Grape::Middleware::Error, rescue_handlers: { NotImplementedError => -> { Rack::Response.new('rescued', 200, {}) } }
-          run ExceptionSpec::OtherExceptionApp
-        end
-      end
+      let(:running_app) { other_exception_app }
+      let(:options) { { rescue_handlers: { NotImplementedError => -> { Rack::Response.new('rescued', 200, {}) } } } }
+
       it 'rescues the exception using the provided handler' do
         get '/'
         expect(last_response.body).to eq('rescued')
@@ -142,13 +131,9 @@ describe Grape::Middleware::Error do
   end
 
   context do
-    subject do
-      Rack::Builder.app do
-        use Spec::Support::EndpointFaker
-        use Grape::Middleware::Error, rescue_all: true, default_status: 500
-        run ExceptionSpec::ExceptionApp
-      end
-    end
+    let(:running_app) { exception_app }
+    let(:options) { { rescue_all: true, default_status: 500 } }
+
     it 'is possible to specify a different default status code' do
       get '/'
       expect(last_response.status).to eq(500)
@@ -156,13 +141,9 @@ describe Grape::Middleware::Error do
   end
 
   context do
-    subject do
-      Rack::Builder.app do
-        use Spec::Support::EndpointFaker
-        use Grape::Middleware::Error, rescue_all: true, format: :json
-        run ExceptionSpec::ExceptionApp
-      end
-    end
+    let(:running_app) { exception_app }
+    let(:options) { { rescue_all: true, format: :json } }
+
     it 'is possible to return errors in json format' do
       get '/'
       expect(last_response.body).to eq('{"error":"rain!"}')
@@ -170,13 +151,9 @@ describe Grape::Middleware::Error do
   end
 
   context do
-    subject do
-      Rack::Builder.app do
-        use Spec::Support::EndpointFaker
-        use Grape::Middleware::Error, rescue_all: true, format: :json
-        run ExceptionSpec::ErrorHashApp
-      end
-    end
+    let(:running_app) { error_hash_app }
+    let(:options) { { rescue_all: true, format: :json } }
+
     it 'is possible to return hash errors in json format' do
       get '/'
       expect(['{"error":"rain!","detail":"missing widget"}',
@@ -185,13 +162,9 @@ describe Grape::Middleware::Error do
   end
 
   context do
-    subject do
-      Rack::Builder.app do
-        use Spec::Support::EndpointFaker
-        use Grape::Middleware::Error, rescue_all: true, format: :jsonapi
-        run ExceptionSpec::ExceptionApp
-      end
-    end
+    let(:running_app) { exception_app }
+    let(:options) { { rescue_all: true, format: :jsonapi } }
+
     it 'is possible to return errors in jsonapi format' do
       get '/'
       expect(last_response.body).to eq('{&quot;error&quot;:&quot;rain!&quot;}')
@@ -199,13 +172,8 @@ describe Grape::Middleware::Error do
   end
 
   context do
-    subject do
-      Rack::Builder.app do
-        use Spec::Support::EndpointFaker
-        use Grape::Middleware::Error, rescue_all: true, format: :jsonapi
-        run ExceptionSpec::ErrorHashApp
-      end
-    end
+    let(:running_app) { error_hash_app }
+    let(:options) { { rescue_all: true, format: :jsonapi } }
 
     it 'is possible to return hash errors in jsonapi format' do
       get '/'
@@ -215,13 +183,9 @@ describe Grape::Middleware::Error do
   end
 
   context do
-    subject do
-      Rack::Builder.app do
-        use Spec::Support::EndpointFaker
-        use Grape::Middleware::Error, rescue_all: true, format: :xml
-        run ExceptionSpec::ExceptionApp
-      end
-    end
+    let(:running_app) { exception_app }
+    let(:options) { { rescue_all: true, format: :xml } }
+
     it 'is possible to return errors in xml format' do
       get '/'
       expect(last_response.body).to eq("<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<error>\n  <message>rain!</message>\n</error>\n")
@@ -229,13 +193,9 @@ describe Grape::Middleware::Error do
   end
 
   context do
-    subject do
-      Rack::Builder.app do
-        use Spec::Support::EndpointFaker
-        use Grape::Middleware::Error, rescue_all: true, format: :xml
-        run ExceptionSpec::ErrorHashApp
-      end
-    end
+    let(:running_app) { error_hash_app }
+    let(:options) { { rescue_all: true, format: :xml } }
+
     it 'is possible to return hash errors in xml format' do
       get '/'
       expect(["<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<error>\n  <detail>missing widget</detail>\n  <error>rain!</error>\n</error>\n",
@@ -244,20 +204,19 @@ describe Grape::Middleware::Error do
   end
 
   context do
-    subject do
-      Rack::Builder.app do
-        use Spec::Support::EndpointFaker
-        use Grape::Middleware::Error,
-            rescue_all: true,
-            format: :custom,
-            error_formatters: {
-              custom: lambda do |message, _backtrace, _options, _env, _original_exception|
-                { custom_formatter: message }.inspect
-              end
-            }
-        run ExceptionSpec::ExceptionApp
-      end
+    let(:running_app) { exception_app }
+    let(:options) do
+      {
+        rescue_all: true,
+        format: :custom,
+        error_formatters: {
+          custom: lambda do |message, _backtrace, _options, _env, _original_exception|
+            { custom_formatter: message }.inspect
+          end
+        }
+      }
     end
+
     it 'is possible to specify a custom formatter' do
       get '/'
       expect(last_response.body).to eq('{:custom_formatter=&gt;&quot;rain!&quot;}')
@@ -265,13 +224,9 @@ describe Grape::Middleware::Error do
   end
 
   context do
-    subject do
-      Rack::Builder.app do
-        use Spec::Support::EndpointFaker
-        use Grape::Middleware::Error
-        run ExceptionSpec::AccessDeniedApp
-      end
-    end
+    let(:running_app) { access_denied_app }
+    let(:options) { {} }
+
     it 'does not trap regular error! codes' do
       get '/'
       expect(last_response.status).to eq(401)
@@ -279,13 +234,9 @@ describe Grape::Middleware::Error do
   end
 
   context do
-    subject do
-      Rack::Builder.app do
-        use Spec::Support::EndpointFaker
-        use Grape::Middleware::Error, rescue_all: false
-        run ExceptionSpec::CustomErrorApp
-      end
-    end
+    let(:running_app) { custom_error_app }
+    let(:options) { { rescue_all: false } }
+
     it 'responds to custom Grape exceptions appropriately' do
       get '/'
       expect(last_response.status).to eq(400)
@@ -294,16 +245,15 @@ describe Grape::Middleware::Error do
   end
 
   context 'with rescue_options :backtrace and :exception set to true' do
-    subject do
-      Rack::Builder.app do
-        use Spec::Support::EndpointFaker
-        use Grape::Middleware::Error,
-            rescue_all: true,
-            format: :json,
-            rescue_options: { backtrace: true, original_exception: true }
-        run ExceptionSpec::ExceptionApp
-      end
+    let(:running_app) { exception_app }
+    let(:options) do
+      {
+        rescue_all: true,
+        format: :json,
+        rescue_options: { backtrace: true, original_exception: true }
+      }
     end
+
     it 'is possible to return the backtrace and the original exception in json format' do
       get '/'
       expect(last_response.body).to include('error', 'rain!', 'backtrace', 'original_exception', 'RuntimeError')
@@ -311,16 +261,15 @@ describe Grape::Middleware::Error do
   end
 
   context do
-    subject do
-      Rack::Builder.app do
-        use Spec::Support::EndpointFaker
-        use Grape::Middleware::Error,
-            rescue_all: true,
-            format: :xml,
-            rescue_options: { backtrace: true, original_exception: true }
-        run ExceptionSpec::ExceptionApp
-      end
+    let(:running_app) { exception_app }
+    let(:options) do
+      {
+        rescue_all: true,
+        format: :xml,
+        rescue_options: { backtrace: true, original_exception: true }
+      }
     end
+
     it 'is possible to return the backtrace and the original exception in xml format' do
       get '/'
       expect(last_response.body).to include('error', 'rain!', 'backtrace', 'original-exception', 'RuntimeError')
@@ -328,16 +277,15 @@ describe Grape::Middleware::Error do
   end
 
   context do
-    subject do
-      Rack::Builder.app do
-        use Spec::Support::EndpointFaker
-        use Grape::Middleware::Error,
-            rescue_all: true,
-            format: :txt,
-            rescue_options: { backtrace: true, original_exception: true }
-        run ExceptionSpec::ExceptionApp
-      end
+    let(:running_app) { exception_app }
+    let(:options) do
+      {
+        rescue_all: true,
+        format: :txt,
+        rescue_options: { backtrace: true, original_exception: true }
+      }
     end
+
     it 'is possible to return the backtrace and the original exception in txt format' do
       get '/'
       expect(last_response.body).to include('error', 'rain!', 'backtrace', 'original exception', 'RuntimeError')

data/spec/grape/middleware/formatter_spec.rb

@@ -1,9 +1,8 @@
 # frozen_string_literal: true
 
-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 +10,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 +18,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 +32,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 +46,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 +61,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 +71,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 +151,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 +168,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 +207,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 +284,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 +303,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 +348,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 +362,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 +378,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 +417,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 +437,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

@@ -1,9 +1,8 @@
 # frozen_string_literal: true
 
-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 +12,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