grape 1.3.0 → 1.5.0

data/spec/grape/entity_spec.rb

@@ -181,6 +181,7 @@ describe Grape::Entity do
         subject.get '/example' do
           c = Class.new do
             attr_reader :id
+
             def initialize(id)
               @id = id
             end
@@ -202,6 +203,7 @@ describe Grape::Entity do
         subject.get '/examples' do
           c = Class.new do
             attr_reader :id
+
             def initialize(id)
               @id = id
             end
@@ -226,6 +228,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
@@ -255,6 +258,7 @@ XML
       subject.get '/example' do
         c = Class.new do
           attr_reader :name
+
           def initialize(args)
             @name = args[:name] || 'no name set'
           end
@@ -284,6 +288,7 @@ XML
       subject.get '/example' do
         c = Class.new do
           attr_reader :name
+
           def initialize(args)
             @name = args[:name] || 'no name set'
           end
@@ -302,6 +307,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

data/spec/grape/exceptions/validation_errors_spec.rb

@@ -81,8 +81,8 @@ describe Grape::Exceptions::ValidationErrors do
       expect(last_response.status).to eq(400)
       expect(JSON.parse(last_response.body)).to eq(
         [
-          'params' => %w[beer wine juice],
-          'messages' => ['are missing, exactly one parameter must be provided']
+          'params' => %w[beer wine],
+          'messages' => ['are mutually exclusive']
         ]
       )
     end

data/spec/grape/integration/rack_sendfile_spec.rb

@@ -4,12 +4,16 @@ require 'spec_helper'
 
 describe Rack::Sendfile do
   subject do
-    send_file = file_streamer
+    content_object = file_object
     app = Class.new(Grape::API) do
       use Rack::Sendfile
       format :json
       get do
-        file send_file
+        if content_object.is_a?(String)
+          sendfile content_object
+        else
+          stream content_object
+        end
       end
     end
 
@@ -22,9 +26,9 @@ describe Rack::Sendfile do
     app.call(env)
   end
 
-  context do
-    let(:file_streamer) do
-      double(:file_streamer, to_path: '/accel/mapping/some/path')
+  context 'when calling sendfile' do
+    let(:file_object) do
+      '/accel/mapping/some/path'
     end
 
     it 'contains Sendfile headers' do
@@ -33,9 +37,9 @@ describe Rack::Sendfile do
     end
   end
 
-  context do
-    let(:file_streamer) do
-      double(:file_streamer)
+  context 'when streaming non file content' do
+    let(:file_object) do
+      double(:file_object, each: nil)
     end
 
     it 'not contains Sendfile headers' do

data/spec/grape/middleware/auth/strategies_spec.rb

@@ -36,7 +36,7 @@ describe Grape::Middleware::Auth::Strategies do
     RSpec::Matchers.define :be_challenge do
       match do |actual_response|
         actual_response.status == 401 &&
-          actual_response['WWW-Authenticate'] =~ /^Digest / &&
+          actual_response['WWW-Authenticate'].start_with?('Digest ') &&
           actual_response.body.empty?
       end
     end

data/spec/grape/middleware/error_spec.rb

@@ -30,7 +30,7 @@ describe Grape::Middleware::Error do
     opts = options
     Rack::Builder.app do
       use Spec::Support::EndpointFaker
-      use Grape::Middleware::Error, opts
+      use Grape::Middleware::Error, **opts
       run ErrorSpec::ErrApp
     end
   end

data/spec/grape/middleware/formatter_spec.rb

@@ -380,7 +380,7 @@ describe Grape::Middleware::Formatter do
 
   context 'send file' do
     let(:file) { double(File) }
-    let(:file_body) { Grape::ServeFile::FileResponse.new(file) }
+    let(:file_body) { Grape::ServeStream::StreamResponse.new(file) }
     let(:app) { ->(_env) { [200, {}, file_body] } }
 
     it 'returns a file response' do
@@ -402,10 +402,10 @@ 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::CONTENT_TYPES.delete(:invalid)
+      Grape::ContentTypes.default_elements.delete(:invalid)
       Grape::Formatter.default_elements.delete(:invalid)
     end
 

data/spec/grape/middleware/stack_spec.rb

@@ -8,6 +8,7 @@ describe Grape::Middleware::Stack do
     class BarMiddleware; end
     class BlockMiddleware
       attr_reader :block
+
       def initialize(&block)
         @block = block
       end
@@ -34,7 +35,8 @@ describe Grape::Middleware::Stack do
       expect { subject.use StackSpec::BarMiddleware, false, my_arg: 42 }
         .to change { subject.size }.by(1)
       expect(subject.last).to eq(StackSpec::BarMiddleware)
-      expect(subject.last.args).to eq([false, { my_arg: 42 }])
+      expect(subject.last.args).to eq([false])
+      expect(subject.last.opts).to eq(my_arg: 42)
     end
 
     it 'pushes a middleware class with block arguments onto the stack' do
@@ -111,6 +113,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/path_spec.rb

@@ -87,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
@@ -109,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/validations/instance_behaivour_spec.rb

@@ -6,7 +6,7 @@ describe 'Validator with instance variables' do
   let(:validator_type) do
     Class.new(Grape::Validations::Base) do
       def validate_param!(_attr_name, _params)
-        if @instance_variable
+        if instance_variable_defined?(:@instance_variable) && @instance_variable
           raise Grape::Exceptions::Validation.new(params: ['params'],
                                                   message: 'This should never happen')
         end

data/spec/grape/validations/params_scope_spec.rb

@@ -633,6 +633,32 @@ describe Grape::Validations::ParamsScope do
       expect(last_response.status).to eq(200)
     end
 
+    it 'detect unmet nested dependency' do
+      subject.params do
+        requires :a, type: String, allow_blank: false, values: %w[x y z]
+        given a: ->(val) { val == 'z' } do
+          requires :inner3, type: Array, allow_blank: false do
+            requires :bar, type: String, allow_blank: false
+            given bar: ->(val) { val == 'b' } do
+              requires :baz, type: Array do
+                optional :baz_category, type: String
+              end
+            end
+            given bar: ->(val) { val == 'c' } do
+              requires :baz, type: Array do
+                requires :baz_category, type: String
+              end
+            end
+          end
+        end
+      end
+      subject.get('/nested-dependency') { declared(params).to_json }
+
+      get '/nested-dependency', a: 'z', inner3: [{ bar: 'c', baz: [{ unrelated: 'nope' }] }]
+      expect(last_response.status).to eq(400)
+      expect(last_response.body).to eq 'inner3[0][baz][0][baz_category] is missing'
+    end
+
     it 'includes the parameter within #declared(params)' do
       get '/test', a: true, b: true
 

data/spec/grape/validations/types/array_coercer_spec.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Grape::Validations::Types::ArrayCoercer do
+  subject { described_class.new(type) }
+
+  describe '#call' do
+    context 'an array of primitives' do
+      let(:type) { Array[String] }
+
+      it 'coerces elements in the array' do
+        expect(subject.call([10, 20])).to eq(%w[10 20])
+      end
+    end
+
+    context 'an array of arrays' do
+      let(:type) { Array[Array[Integer]] }
+
+      it 'coerces elements in the nested array' do
+        expect(subject.call([%w[10 20]])).to eq([[10, 20]])
+        expect(subject.call([['10'], ['20']])).to eq([[10], [20]])
+      end
+    end
+
+    context 'an array of sets' do
+      let(:type) { Array[Set[Integer]] }
+
+      it 'coerces elements in the nested set' do
+        expect(subject.call([%w[10 20]])).to eq([Set[10, 20]])
+        expect(subject.call([['10'], ['20']])).to eq([Set[10], Set[20]])
+      end
+    end
+  end
+end

data/spec/grape/validations/types/primitive_coercer_spec.rb

@@ -0,0 +1,135 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Grape::Validations::Types::PrimitiveCoercer do
+  let(:strict) { false }
+
+  subject { described_class.new(type, strict) }
+
+  describe '#call' do
+    context 'BigDecimal' do
+      let(:type) { BigDecimal }
+
+      it 'coerces to BigDecimal' do
+        expect(subject.call(5)).to eq(BigDecimal(5))
+      end
+
+      it 'coerces an empty string to nil' do
+        expect(subject.call('')).to be_nil
+      end
+    end
+
+    context 'Boolean' do
+      let(:type) { Grape::API::Boolean }
+
+      [true, 'true', 1].each do |val|
+        it "coerces '#{val}' to true" do
+          expect(subject.call(val)).to eq(true)
+        end
+      end
+
+      [false, 'false', 0].each do |val|
+        it "coerces '#{val}' to false" do
+          expect(subject.call(val)).to eq(false)
+        end
+      end
+
+      it 'returns an error when the given value cannot be coerced' do
+        expect(subject.call(123)).to be_instance_of(Grape::Validations::Types::InvalidValue)
+      end
+
+      it 'coerces an empty string to nil' do
+        expect(subject.call('')).to be_nil
+      end
+    end
+
+    context 'DateTime' do
+      let(:type) { DateTime }
+
+      it 'coerces an empty string to nil' do
+        expect(subject.call('')).to be_nil
+      end
+    end
+
+    context 'Float' do
+      let(:type) { Float }
+
+      it 'coerces an empty string to nil' do
+        expect(subject.call('')).to be_nil
+      end
+    end
+
+    context 'Integer' do
+      let(:type) { Integer }
+
+      it 'coerces an empty string to nil' do
+        expect(subject.call('')).to be_nil
+      end
+    end
+
+    context 'Numeric' do
+      let(:type) { Numeric }
+
+      it 'coerces an empty string to nil' do
+        expect(subject.call('')).to be_nil
+      end
+    end
+
+    context 'Time' do
+      let(:type) { Time }
+
+      it 'coerces an empty string to nil' do
+        expect(subject.call('')).to be_nil
+      end
+    end
+
+    context 'String' do
+      let(:type) { String }
+
+      it 'coerces to String' do
+        expect(subject.call(10)).to eq('10')
+      end
+
+      it 'does not coerce an empty string to nil' do
+        expect(subject.call('')).to eq('')
+      end
+    end
+
+    context 'Symbol' do
+      let(:type) { Symbol }
+
+      it 'coerces an empty string to nil' do
+        expect(subject.call('')).to be_nil
+      end
+    end
+
+    context 'the strict mode' do
+      let(:strict) { true }
+
+      context 'Boolean' do
+        let(:type) { Grape::API::Boolean }
+
+        it 'returns an error when the given value is not Boolean' do
+          expect(subject.call(1)).to be_instance_of(Grape::Validations::Types::InvalidValue)
+        end
+
+        it 'returns a value as it is when the given value is Boolean' do
+          expect(subject.call(true)).to eq(true)
+        end
+      end
+
+      context 'BigDecimal' do
+        let(:type) { BigDecimal }
+
+        it 'returns an error when the given value is not BigDecimal' do
+          expect(subject.call(1)).to be_instance_of(Grape::Validations::Types::InvalidValue)
+        end
+
+        it 'returns a value as it is when the given value is BigDecimal' do
+          expect(subject.call(BigDecimal(0))).to eq(BigDecimal(0))
+        end
+      end
+    end
+  end
+end

data/spec/grape/validations/types/set_coercer_spec.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Grape::Validations::Types::SetCoercer do
+  subject { described_class.new(type) }
+
+  describe '#call' do
+    context 'a set of primitives' do
+      let(:type) { Set[String] }
+
+      it 'coerces elements to the set' do
+        expect(subject.call([10, 20])).to eq(Set['10', '20'])
+      end
+    end
+
+    context 'a set of sets' do
+      let(:type) { Set[Set[Integer]] }
+
+      it 'coerces elements in the nested set' do
+        expect(subject.call([%w[10 20]])).to eq(Set[Set[10, 20]])
+        expect(subject.call([['10'], ['20']])).to eq(Set[Set[10], Set[20]])
+      end
+    end
+
+    context 'a set of sets of arrays' do
+      let(:type) { Set[Set[Array[Integer]]] }
+
+      it 'coerces elements in the nested set' do
+        expect(subject.call([[['10'], ['20']]])).to eq(Set[Set[Array[10], Array[20]]])
+      end
+    end
+  end
+end