grape 1.5.3 → 1.7.1

data/spec/shared/versioning_examples.rb

@@ -35,14 +35,14 @@ shared_examples_for 'versioning' do
     end
 
     versioned_get '/awesome', 'v1', **macro_options
-    expect(last_response.status).to eql 404
+    expect(last_response.status).to be 404
 
     versioned_get '/awesome', 'v2', **macro_options
-    expect(last_response.status).to eql 200
+    expect(last_response.status).to be 200
     versioned_get '/legacy', 'v1', **macro_options
-    expect(last_response.status).to eql 200
+    expect(last_response.status).to be 200
     versioned_get '/legacy', 'v2', **macro_options
-    expect(last_response.status).to eql 404
+    expect(last_response.status).to be 404
   end
 
   it 'is able to specify multiple versions' do
@@ -52,11 +52,11 @@ shared_examples_for 'versioning' do
     end
 
     versioned_get '/awesome', 'v1', **macro_options
-    expect(last_response.status).to eql 200
+    expect(last_response.status).to be 200
     versioned_get '/awesome', 'v2', **macro_options
-    expect(last_response.status).to eql 200
+    expect(last_response.status).to be 200
     versioned_get '/awesome', 'v3', **macro_options
-    expect(last_response.status).to eql 404
+    expect(last_response.status).to be 404
   end
 
   context 'with different versions for the same endpoint' do
@@ -70,7 +70,7 @@ shared_examples_for 'versioning' do
 
         subject.version 'v1', macro_options do
           get 'version' do
-            'version ' + request.env['api.version']
+            "version #{request.env['api.version']}"
           end
         end
 
@@ -94,7 +94,7 @@ shared_examples_for 'versioning' do
 
         subject.version 'v1', macro_options do
           get 'version' do
-            'version ' + request.env['api.version']
+            "version #{request.env['api.version']}"
           end
         end
 
@@ -117,6 +117,7 @@ shared_examples_for 'versioning' do
         before do
           @output ||= 'v2-'
         end
+
         get 'version' do
           @output += 'version'
         end
@@ -126,6 +127,7 @@ shared_examples_for 'versioning' do
         before do
           @output ||= 'v1-'
         end
+
         get 'version' do
           @output += 'version'
         end
@@ -170,6 +172,7 @@ shared_examples_for 'versioning' do
       end
       klass
     end
+
     before do
       subject.format :txt
 

data/spec/spec_helper.rb

@@ -5,17 +5,24 @@ $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), 'support'))
 
 require 'grape'
+require 'test_prof/recipes/rspec/let_it_be'
+
+class NullAdapter
+  def begin_transaction; end
+
+  def rollback_transaction; end
+end
+
+TestProf::BeforeAll.adapter = NullAdapter.new
 
 require 'rubygems'
 require 'bundler'
 Bundler.require :default, :test
 
-Dir["#{File.dirname(__FILE__)}/support/*.rb"].each do |file|
+Dir["#{File.dirname(__FILE__)}/support/*.rb"].sort.each do |file|
   require file
 end
 
-eager_load!
-
 # The default value for this setting is true in a standard Rails app,
 # so it should be set to true here as well to reflect that.
 I18n.enforce_available_locales = true
@@ -27,11 +34,19 @@ RSpec.configure do |config|
   config.filter_run_when_matching :focus
   config.warnings = true
 
-  config.before(:each) { Grape::Util::InheritableSetting.reset_global! }
+  config.before(:all) { Grape::Util::InheritableSetting.reset_global! }
+  config.before { Grape::Util::InheritableSetting.reset_global! }
 
   # Enable flags like --only-failures and --next-failure
   config.example_status_persistence_file_path = '.rspec_status'
 end
 
-require 'coveralls'
-Coveralls.wear!
+require 'simplecov'
+require 'simplecov-lcov'
+SimpleCov::Formatter::LcovFormatter.config do |c|
+  c.report_with_single_file = true
+  c.single_report_path = 'coverage/lcov.info'
+end
+
+SimpleCov.formatter = SimpleCov::Formatter::LcovFormatter
+SimpleCov.start

data/spec/support/basic_auth_encode_helpers.rb

@@ -4,7 +4,7 @@ module Spec
   module Support
     module Helpers
       def encode_basic_auth(username, password)
-        'Basic ' + Base64.encode64("#{username}:#{password}")
+        "Basic #{Base64.encode64("#{username}:#{password}")}"
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: grape
 version: !ruby/object:Gem::Version
-  version: 1.5.3
+  version: 1.7.1
 platform: ruby
 authors:
 - Michael Bleigh
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-03-07 00:00:00.000000000 Z
+date: 2023-05-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -73,6 +73,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.3.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -80,6 +83,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.3.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
 - !ruby/object:Gem::Dependency
   name: rack-accept
   requirement: !ruby/object:Gem::Requirement
@@ -115,6 +121,7 @@ files:
 - lib/grape/config.rb
 - lib/grape/content_types.rb
 - lib/grape/cookies.rb
+- lib/grape/dry_types.rb
 - lib/grape/dsl/api.rb
 - lib/grape/dsl/callbacks.rb
 - lib/grape/dsl/configuration.rb
@@ -151,6 +158,7 @@ files:
 - lib/grape/exceptions/missing_mime_type.rb
 - lib/grape/exceptions/missing_option.rb
 - lib/grape/exceptions/missing_vendor_option.rb
+- lib/grape/exceptions/too_many_multipart_files.rb
 - lib/grape/exceptions/unknown_options.rb
 - lib/grape/exceptions/unknown_parameter.rb
 - lib/grape/exceptions/unknown_validator.rb
@@ -201,6 +209,7 @@ files:
 - lib/grape/serve_stream/file_body.rb
 - lib/grape/serve_stream/sendfile_response.rb
 - lib/grape/serve_stream/stream_response.rb
+- lib/grape/types/invalid_value.rb
 - lib/grape/util/base_inheritable.rb
 - lib/grape/util/cache.rb
 - lib/grape/util/endpoint_configuration.rb
@@ -217,6 +226,7 @@ files:
 - lib/grape/util/strict_hash_configuration.rb
 - lib/grape/util/xml.rb
 - lib/grape/validations.rb
+- lib/grape/validations/attributes_doc.rb
 - lib/grape/validations/attributes_iterator.rb
 - lib/grape/validations/multiple_attributes_iterator.rb
 - lib/grape/validations/params_scope.rb
@@ -235,25 +245,26 @@ files:
 - lib/grape/validations/types/set_coercer.rb
 - lib/grape/validations/types/variant_collection_coercer.rb
 - lib/grape/validations/validator_factory.rb
-- lib/grape/validations/validators/all_or_none.rb
-- lib/grape/validations/validators/allow_blank.rb
-- lib/grape/validations/validators/as.rb
-- lib/grape/validations/validators/at_least_one_of.rb
+- lib/grape/validations/validators/all_or_none_of_validator.rb
+- lib/grape/validations/validators/allow_blank_validator.rb
+- lib/grape/validations/validators/as_validator.rb
+- lib/grape/validations/validators/at_least_one_of_validator.rb
 - lib/grape/validations/validators/base.rb
-- lib/grape/validations/validators/coerce.rb
-- lib/grape/validations/validators/default.rb
-- lib/grape/validations/validators/exactly_one_of.rb
-- lib/grape/validations/validators/except_values.rb
+- lib/grape/validations/validators/coerce_validator.rb
+- lib/grape/validations/validators/default_validator.rb
+- lib/grape/validations/validators/exactly_one_of_validator.rb
+- lib/grape/validations/validators/except_values_validator.rb
 - lib/grape/validations/validators/multiple_params_base.rb
-- lib/grape/validations/validators/mutual_exclusion.rb
-- lib/grape/validations/validators/presence.rb
-- lib/grape/validations/validators/regexp.rb
-- lib/grape/validations/validators/same_as.rb
-- lib/grape/validations/validators/values.rb
+- lib/grape/validations/validators/mutual_exclusion_validator.rb
+- lib/grape/validations/validators/presence_validator.rb
+- lib/grape/validations/validators/regexp_validator.rb
+- lib/grape/validations/validators/same_as_validator.rb
+- lib/grape/validations/validators/values_validator.rb
 - lib/grape/version.rb
 - spec/grape/api/custom_validations_spec.rb
 - spec/grape/api/deeply_included_options_spec.rb
 - spec/grape/api/defines_boolean_in_params_spec.rb
+- spec/grape/api/documentation_spec.rb
 - spec/grape/api/inherited_helpers_spec.rb
 - spec/grape/api/instance_spec.rb
 - spec/grape/api/invalid_format_spec.rb
@@ -272,7 +283,6 @@ files:
 - spec/grape/api_spec.rb
 - spec/grape/config_spec.rb
 - spec/grape/dsl/callbacks_spec.rb
-- spec/grape/dsl/configuration_spec.rb
 - spec/grape/dsl/desc_spec.rb
 - spec/grape/dsl/headers_spec.rb
 - spec/grape/dsl/helpers_spec.rb
@@ -293,10 +303,12 @@ files:
 - spec/grape/exceptions/invalid_formatter_spec.rb
 - spec/grape/exceptions/invalid_response_spec.rb
 - spec/grape/exceptions/invalid_versioner_option_spec.rb
+- spec/grape/exceptions/missing_group_type_spec.rb
 - spec/grape/exceptions/missing_mime_type_spec.rb
 - spec/grape/exceptions/missing_option_spec.rb
 - spec/grape/exceptions/unknown_options_spec.rb
 - spec/grape/exceptions/unknown_validator_spec.rb
+- spec/grape/exceptions/unsupported_group_type_spec.rb
 - spec/grape/exceptions/validation_errors_spec.rb
 - spec/grape/exceptions/validation_spec.rb
 - spec/grape/extensions/param_builders/hash_spec.rb
@@ -330,7 +342,7 @@ files:
 - spec/grape/util/reverse_stackable_values_spec.rb
 - spec/grape/util/stackable_values_spec.rb
 - spec/grape/util/strict_hash_configuration_spec.rb
-- spec/grape/validations/attributes_iterator_spec.rb
+- spec/grape/validations/attributes_doc_spec.rb
 - spec/grape/validations/instance_behaivour_spec.rb
 - spec/grape/validations/multiple_attributes_iterator_spec.rb
 - spec/grape/validations/params_scope_spec.rb
@@ -361,7 +373,6 @@ files:
 - 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
 - spec/support/file_streamer.rb
 - spec/support/integer_helpers.rb
@@ -371,10 +382,10 @@ licenses:
 - MIT
 metadata:
   bug_tracker_uri: https://github.com/ruby-grape/grape/issues
-  changelog_uri: https://github.com/ruby-grape/grape/blob/v1.5.3/CHANGELOG.md
-  documentation_uri: https://www.rubydoc.info/gems/grape/1.5.3
-  source_code_uri: https://github.com/ruby-grape/grape/tree/v1.5.3
-post_install_message:
+  changelog_uri: https://github.com/ruby-grape/grape/blob/v1.7.1/CHANGELOG.md
+  documentation_uri: https://www.rubydoc.info/gems/grape/1.7.1
+  source_code_uri: https://github.com/ruby-grape/grape/tree/v1.7.1
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -382,15 +393,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.4.0
+      version: 2.6.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.3
-signing_key:
+rubygems_version: 3.0.3
+signing_key: 
 specification_version: 4
 summary: A simple Ruby framework for building REST-like APIs.
 test_files:
@@ -405,7 +416,6 @@ test_files:
 - spec/support/file_streamer.rb
 - spec/support/versioned_helpers.rb
 - spec/support/content_type_helpers.rb
-- spec/support/eager_load.rb
 - spec/support/integer_helpers.rb
 - spec/grape/middleware/error_spec.rb
 - spec/grape/middleware/globals_spec.rb
@@ -435,6 +445,8 @@ test_files:
 - spec/grape/integration/global_namespace_function_spec.rb
 - spec/grape/validations_spec.rb
 - spec/grape/entity_spec.rb
+- spec/grape/exceptions/missing_group_type_spec.rb
+- spec/grape/exceptions/unsupported_group_type_spec.rb
 - spec/grape/exceptions/validation_spec.rb
 - spec/grape/exceptions/invalid_accept_header_spec.rb
 - spec/grape/exceptions/missing_option_spec.rb
@@ -449,10 +461,10 @@ test_files:
 - spec/grape/exceptions/base_spec.rb
 - spec/grape/presenters/presenter_spec.rb
 - spec/grape/validations/single_attribute_iterator_spec.rb
-- spec/grape/validations/attributes_iterator_spec.rb
 - spec/grape/validations/types/primitive_coercer_spec.rb
 - spec/grape/validations/types/set_coercer_spec.rb
 - spec/grape/validations/types/array_coercer_spec.rb
+- spec/grape/validations/attributes_doc_spec.rb
 - spec/grape/validations/params_scope_spec.rb
 - spec/grape/validations/instance_behaivour_spec.rb
 - spec/grape/validations/multiple_attributes_iterator_spec.rb
@@ -493,12 +505,12 @@ test_files:
 - spec/grape/api/routes_with_requirements_spec.rb
 - spec/grape/api/custom_validations_spec.rb
 - spec/grape/api/optional_parameters_in_route_spec.rb
+- spec/grape/api/documentation_spec.rb
 - spec/grape/api_remount_spec.rb
 - spec/grape/named_api_spec.rb
 - spec/grape/dsl/request_response_spec.rb
 - spec/grape/dsl/desc_spec.rb
 - spec/grape/dsl/logger_spec.rb
-- spec/grape/dsl/configuration_spec.rb
 - spec/grape/dsl/validations_spec.rb
 - spec/grape/dsl/parameters_spec.rb
 - spec/grape/dsl/helpers_spec.rb

data/lib/grape/validations/validators/all_or_none.rb

@@ -1,15 +0,0 @@
-# frozen_string_literal: true
-
-require 'grape/validations/validators/multiple_params_base'
-
-module Grape
-  module Validations
-    class AllOrNoneOfValidator < MultipleParamsBase
-      def validate_params!(params)
-        keys = keys_in_common(params)
-        return if keys.empty? || keys.length == all_keys.length
-        raise Grape::Exceptions::Validation.new(params: all_keys, message: message(:all_or_none))
-      end
-    end
-  end
-end

data/lib/grape/validations/validators/allow_blank.rb

@@ -1,18 +0,0 @@
-# frozen_string_literal: true
-
-module Grape
-  module Validations
-    class AllowBlankValidator < Base
-      def validate_param!(attr_name, params)
-        return if (options_key?(:value) ? @option[:value] : @option) || !params.is_a?(Hash)
-
-        value = params[attr_name]
-        value = value.strip if value.respond_to?(:strip)
-
-        return if value == false || value.present?
-
-        raise Grape::Exceptions::Validation.new(params: [@scope.full_name(attr_name)], message: message(:blank))
-      end
-    end
-  end
-end

data/lib/grape/validations/validators/as.rb

@@ -1,16 +0,0 @@
-# frozen_string_literal: true
-
-module Grape
-  module Validations
-    class AsValidator < Base
-      def initialize(attrs, options, required, scope, **opts)
-        @renamed_options = options
-        super
-      end
-
-      def validate_param!(attr_name, params)
-        params[@renamed_options] = params[attr_name]
-      end
-    end
-  end
-end

data/lib/grape/validations/validators/at_least_one_of.rb

@@ -1,14 +0,0 @@
-# frozen_string_literal: true
-
-require 'grape/validations/validators/multiple_params_base'
-
-module Grape
-  module Validations
-    class AtLeastOneOfValidator < MultipleParamsBase
-      def validate_params!(params)
-        return unless keys_in_common(params).empty?
-        raise Grape::Exceptions::Validation.new(params: all_keys, message: message(:at_least_one))
-      end
-    end
-  end
-end

data/lib/grape/validations/validators/coerce.rb

@@ -1,91 +0,0 @@
-# frozen_string_literal: true
-
-module Grape
-  class API
-    class Boolean
-      def self.build(val)
-        return nil if val != true && val != false
-
-        new
-      end
-    end
-
-    class Instance
-      Boolean = Grape::API::Boolean
-    end
-  end
-
-  module Validations
-    class CoerceValidator < Base
-      def initialize(attrs, options, required, scope, **opts)
-        super
-
-        @converter = if type.is_a?(Grape::Validations::Types::VariantCollectionCoercer)
-                       type
-                     else
-                       Types.build_coercer(type, method: @option[:method])
-                     end
-      end
-
-      def validate(request)
-        super
-      end
-
-      def validate_param!(attr_name, params)
-        raise validation_exception(attr_name) unless params.is_a? Hash
-
-        new_value = coerce_value(params[attr_name])
-
-        raise validation_exception(attr_name, new_value.message) unless valid_type?(new_value)
-
-        # Don't assign a value if it is identical. It fixes a problem with Hashie::Mash
-        # which looses wrappers for hashes and arrays after reassigning values
-        #
-        #     h = Hashie::Mash.new(list: [1, 2, 3, 4])
-        #     => #<Hashie::Mash list=#<Hashie::Array [1, 2, 3, 4]>>
-        #     list = h.list
-        #     h[:list] = list
-        #     h
-        #     => #<Hashie::Mash list=[1, 2, 3, 4]>
-        return if params[attr_name].class == new_value.class && params[attr_name] == new_value
-
-        params[attr_name] = new_value
-      end
-
-      private
-
-      # @!attribute [r] converter
-      # Object that will be used for parameter coercion and type checking.
-      #
-      # See {Types.build_coercer}
-      #
-      # @return [Object]
-      attr_reader :converter
-
-      def valid_type?(val)
-        !val.is_a?(Types::InvalidValue)
-      end
-
-      def coerce_value(val)
-        converter.call(val)
-      # Some custom types might fail, so it should be treated as an invalid value
-      rescue StandardError
-        Types::InvalidValue.new
-      end
-
-      # Type to which the parameter will be coerced.
-      #
-      # @return [Class]
-      def type
-        @option[:type].is_a?(Hash) ? @option[:type][:value] : @option[:type]
-      end
-
-      def validation_exception(attr_name, custom_msg = nil)
-        Grape::Exceptions::Validation.new(
-          params: [@scope.full_name(attr_name)],
-          message: custom_msg || message(:coerce)
-        )
-      end
-    end
-  end
-end

data/lib/grape/validations/validators/default.rb

@@ -1,48 +0,0 @@
-# frozen_string_literal: true
-
-module Grape
-  module Validations
-    class DefaultValidator < Base
-      def initialize(attrs, options, required, scope, **opts)
-        @default = options
-        super
-      end
-
-      def validate_param!(attr_name, params)
-        params[attr_name] = if @default.is_a? Proc
-                              @default.call
-                            elsif @default.frozen? || !duplicatable?(@default)
-                              @default
-                            else
-                              duplicate(@default)
-                            end
-      end
-
-      def validate!(params)
-        attrs = SingleAttributeIterator.new(self, @scope, params)
-        attrs.each do |resource_params, attr_name|
-          next unless @scope.meets_dependency?(resource_params, params)
-          validate_param!(attr_name, resource_params) if resource_params.is_a?(Hash) && resource_params[attr_name].nil?
-        end
-      end
-
-      private
-
-      # return true if we might be able to dup this object
-      def duplicatable?(obj)
-        !obj.nil? &&
-          obj != true &&
-          obj != false &&
-          !obj.is_a?(Symbol) &&
-          !obj.is_a?(Numeric)
-      end
-
-      # make a best effort to dup the object
-      def duplicate(obj)
-        obj.dup
-      rescue TypeError
-        obj
-      end
-    end
-  end
-end

data/lib/grape/validations/validators/exactly_one_of.rb

@@ -1,16 +0,0 @@
-# frozen_string_literal: true
-
-require 'grape/validations/validators/multiple_params_base'
-
-module Grape
-  module Validations
-    class ExactlyOneOfValidator < MultipleParamsBase
-      def validate_params!(params)
-        keys = keys_in_common(params)
-        return if keys.length == 1
-        raise Grape::Exceptions::Validation.new(params: all_keys, message: message(:exactly_one)) if keys.length.zero?
-        raise Grape::Exceptions::Validation.new(params: keys, message: message(:mutual_exclusion))
-      end
-    end
-  end
-end

data/lib/grape/validations/validators/except_values.rb

@@ -1,22 +0,0 @@
-# frozen_string_literal: true
-
-module Grape
-  module Validations
-    class ExceptValuesValidator < Base
-      def initialize(attrs, options, required, scope, **opts)
-        @except = options.is_a?(Hash) ? options[:value] : options
-        super
-      end
-
-      def validate_param!(attr_name, params)
-        return unless params.respond_to?(:key?) && params.key?(attr_name)
-
-        excepts = @except.is_a?(Proc) ? @except.call : @except
-        return if excepts.nil?
-
-        param_array = params[attr_name].nil? ? [nil] : Array.wrap(params[attr_name])
-        raise Grape::Exceptions::Validation.new(params: [@scope.full_name(attr_name)], message: message(:except_values)) if param_array.any? { |param| excepts.include?(param) }
-      end
-    end
-  end
-end

data/lib/grape/validations/validators/mutual_exclusion.rb

@@ -1,15 +0,0 @@
-# frozen_string_literal: true
-
-require 'grape/validations/validators/multiple_params_base'
-
-module Grape
-  module Validations
-    class MutualExclusionValidator < MultipleParamsBase
-      def validate_params!(params)
-        keys = keys_in_common(params)
-        return if keys.length <= 1
-        raise Grape::Exceptions::Validation.new(params: keys, message: message(:mutual_exclusion))
-      end
-    end
-  end
-end

data/lib/grape/validations/validators/presence.rb

@@ -1,12 +0,0 @@
-# frozen_string_literal: true
-
-module Grape
-  module Validations
-    class PresenceValidator < Base
-      def validate_param!(attr_name, params)
-        return if params.respond_to?(:key?) && params.key?(attr_name)
-        raise Grape::Exceptions::Validation.new(params: [@scope.full_name(attr_name)], message: message(:presence))
-      end
-    end
-  end
-end

data/lib/grape/validations/validators/regexp.rb

@@ -1,13 +0,0 @@
-# frozen_string_literal: true
-
-module Grape
-  module Validations
-    class RegexpValidator < Base
-      def validate_param!(attr_name, params)
-        return unless params.respond_to?(:key?) && params.key?(attr_name)
-        return if Array.wrap(params[attr_name]).all? { |param| param.nil? || param.to_s.match?((options_key?(:value) ? @option[:value] : @option)) }
-        raise Grape::Exceptions::Validation.new(params: [@scope.full_name(attr_name)], message: message(:regexp))
-      end
-    end
-  end
-end

data/lib/grape/validations/validators/same_as.rb

@@ -1,26 +0,0 @@
-# frozen_string_literal: true
-
-module Grape
-  module Validations
-    class SameAsValidator < Base
-      def validate_param!(attr_name, params)
-        confirmation = options_key?(:value) ? @option[:value] : @option
-        return if params[attr_name] == params[confirmation]
-        raise Grape::Exceptions::Validation.new(
-          params: [@scope.full_name(attr_name)],
-          message: build_message
-        )
-      end
-
-      private
-
-      def build_message
-        if options_key?(:message)
-          @option[:message]
-        else
-          format I18n.t(:same_as, scope: 'grape.errors.messages'), parameter: @option
-        end
-      end
-    end
-  end
-end