grape 1.4.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/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/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

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/validators/coerce_spec.rb

@@ -620,6 +620,30 @@ describe Grape::Validations::CoerceValidator do
         expect(JSON.parse(last_response.body)).to eq(%w[a b c d])
       end
 
+      it 'parses parameters with Array[Array[String]] type and coerce_with' do
+        subject.params do
+          requires :values, type: Array[Array[String]], coerce_with: ->(val) { val.is_a?(String) ? [val.split(/,/).map(&:strip)] : val }
+        end
+        subject.post '/coerce_nested_strings' do
+          params[:values]
+        end
+
+        post '/coerce_nested_strings', ::Grape::Json.dump(values: 'a,b,c,d'), 'CONTENT_TYPE' => 'application/json'
+        expect(last_response.status).to eq(201)
+        expect(JSON.parse(last_response.body)).to eq([%w[a b c d]])
+
+        post '/coerce_nested_strings', ::Grape::Json.dump(values: [%w[a c], %w[b]]), 'CONTENT_TYPE' => 'application/json'
+        expect(last_response.status).to eq(201)
+        expect(JSON.parse(last_response.body)).to eq([%w[a c], %w[b]])
+
+        post '/coerce_nested_strings', ::Grape::Json.dump(values: [[]]), 'CONTENT_TYPE' => 'application/json'
+        expect(last_response.status).to eq(201)
+        expect(JSON.parse(last_response.body)).to eq([[]])
+
+        post '/coerce_nested_strings', ::Grape::Json.dump(values: [['a', { bar: 0 }], ['b']]), 'CONTENT_TYPE' => 'application/json'
+        expect(last_response.status).to eq(400)
+      end
+
       it 'parses parameters with Array[Integer] type' do
         subject.params do
           requires :values, type: Array[Integer], coerce_with: ->(val) { val.split(/\s+/).map(&:to_i) }

data/spec/grape/validations/validators/default_spec.rb

@@ -419,4 +419,53 @@ describe Grape::Validations::DefaultValidator do
       end
     end
   end
+
+  context 'array with default values and given conditions' do
+    subject do
+      Class.new(Grape::API) do
+        default_format :json
+      end
+    end
+
+    def app
+      subject
+    end
+
+    it 'applies the default values only if the conditions are met' do
+      subject.params do
+        requires :ary, type: Array do
+          requires :has_value, type: Grape::API::Boolean
+          given has_value: ->(has_value) { has_value } do
+            optional :type, type: String, values: %w[str int], default: 'str'
+            given type: ->(type) { type == 'str' } do
+              optional :str, type: String, default: 'a'
+            end
+            given type: ->(type) { type == 'int' } do
+              optional :int, type: Integer, default: 1
+            end
+          end
+        end
+      end
+      subject.post('/nested_given_and_default') { declared(self.params) }
+
+      params = {
+        ary: [
+          { has_value: false },
+          { has_value: true, type: 'int', int: 123 },
+          { has_value: true, type: 'str', str: 'b' }
+        ]
+      }
+      expected = {
+        'ary' => [
+          { 'has_value' => false, 'type' => nil,   'int' => nil, 'str' => nil },
+          { 'has_value' => true,  'type' => 'int', 'int' => 123, 'str' => nil },
+          { 'has_value' => true,  'type' => 'str', 'int' => nil, 'str' => 'b' }
+        ]
+      }
+
+      post '/nested_given_and_default', params
+      expect(last_response.status).to eq(201)
+      expect(JSON.parse(last_response.body)).to eq(expected)
+    end
+  end
 end

data/spec/grape/validations/validators/except_values_spec.rb

@@ -8,6 +8,7 @@ describe Grape::Validations::ExceptValuesValidator do
       DEFAULT_EXCEPTS = ['invalid-type1', 'invalid-type2', 'invalid-type3'].freeze
       class << self
         attr_accessor :excepts
+
         def excepts
           @excepts ||= []
           [DEFAULT_EXCEPTS + @excepts].flatten.uniq

data/spec/spec_helper.rb

@@ -20,17 +20,7 @@ eager_load!
 # so it should be set to true here as well to reflect that.
 I18n.enforce_available_locales = true
 
-module Chunks
-  def read_chunks(body)
-    buffer = []
-    body.each { |chunk| buffer << chunk }
-
-    buffer
-  end
-end
-
 RSpec.configure do |config|
-  config.include Chunks
   config.include Rack::Test::Methods
   config.include Spec::Support::Helpers
   config.raise_errors_for_deprecations!

data/spec/support/chunks.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Chunks
+  def read_chunks(body)
+    buffer = []
+    body.each { |chunk| buffer << chunk }
+
+    buffer
+  end
+end
+
+RSpec.configure do |config|
+  config.include Chunks
+end

data/spec/support/versioned_helpers.rb

@@ -6,7 +6,7 @@ module Spec
     module Helpers
       # Returns the path with options[:version] prefixed if options[:using] is :path.
       # Returns normal path otherwise.
-      def versioned_path(options = {})
+      def versioned_path(**options)
         case options[:using]
         when :path
           File.join('/', options[:prefix] || '', options[:version], options[:path])
@@ -43,13 +43,11 @@ module Spec
         end
       end
 
-      def versioned_get(path, version_name, version_options = {})
+      def versioned_get(path, version_name, **version_options)
         path    = versioned_path(version_options.merge(version: version_name, path: path))
         headers = versioned_headers(**version_options.merge(version: version_name))
         params = {}
-        if version_options[:using] == :param
-          params = { version_options[:parameter] => version_name }
-        end
+        params = { version_options[:parameter] => version_name } if version_options[:using] == :param
         get path, params, headers
       end
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: grape
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.5.0
 platform: ruby
 authors:
 - Michael Bleigh
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-07-10 00:00:00.000000000 Z
+date: 2020-10-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -282,6 +282,7 @@ files:
 - spec/grape/dsl/routing_spec.rb
 - spec/grape/dsl/settings_spec.rb
 - spec/grape/dsl/validations_spec.rb
+- spec/grape/endpoint/declared_spec.rb
 - spec/grape/endpoint_spec.rb
 - spec/grape/entity_spec.rb
 - spec/grape/exceptions/base_spec.rb
@@ -356,6 +357,7 @@ files:
 - spec/shared/versioning_examples.rb
 - spec/spec_helper.rb
 - spec/support/basic_auth_encode_helpers.rb
+- spec/support/chunks.rb
 - spec/support/content_type_helpers.rb
 - spec/support/eager_load.rb
 - spec/support/endpoint_faker.rb
@@ -367,9 +369,9 @@ licenses:
 - MIT
 metadata:
   bug_tracker_uri: https://github.com/ruby-grape/grape/issues
-  changelog_uri: https://github.com/ruby-grape/grape/blob/v1.4.0/CHANGELOG.md
-  documentation_uri: https://www.rubydoc.info/gems/grape/1.4.0
-  source_code_uri: https://github.com/ruby-grape/grape/tree/v1.4.0
+  changelog_uri: https://github.com/ruby-grape/grape/blob/v1.5.0/CHANGELOG.md
+  documentation_uri: https://www.rubydoc.info/gems/grape/1.5.0
+  source_code_uri: https://github.com/ruby-grape/grape/tree/v1.5.0
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -397,6 +399,7 @@ test_files:
 - spec/shared/versioning_examples.rb
 - spec/support/basic_auth_encode_helpers.rb
 - spec/support/endpoint_faker.rb
+- spec/support/chunks.rb
 - spec/support/file_streamer.rb
 - spec/support/versioned_helpers.rb
 - spec/support/content_type_helpers.rb
@@ -470,6 +473,7 @@ test_files:
 - spec/grape/extensions/param_builders/hash_with_indifferent_access_spec.rb
 - spec/grape/parser_spec.rb
 - spec/grape/request_spec.rb
+- spec/grape/endpoint/declared_spec.rb
 - spec/grape/api/parameters_modification_spec.rb
 - spec/grape/api/patch_method_helpers_spec.rb
 - spec/grape/api/required_parameters_with_invalid_method_spec.rb