grape 2.1.0 → 2.2.0

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

@@ -7,20 +7,25 @@ module Grape
         def initialize(attrs, options, required, scope, **opts)
           @min = options[:min]
           @max = options[:max]
+          @is = options[:is]
 
           super
 
           raise ArgumentError, 'min must be an integer greater than or equal to zero' if !@min.nil? && (!@min.is_a?(Integer) || @min.negative?)
           raise ArgumentError, 'max must be an integer greater than or equal to zero' if !@max.nil? && (!@max.is_a?(Integer) || @max.negative?)
           raise ArgumentError, "min #{@min} cannot be greater than max #{@max}" if !@min.nil? && !@max.nil? && @min > @max
+
+          return if @is.nil?
+          raise ArgumentError, 'is must be an integer greater than zero' if !@is.is_a?(Integer) || !@is.positive?
+          raise ArgumentError, 'is cannot be combined with min or max' if !@min.nil? || !@max.nil?
         end
 
         def validate_param!(attr_name, params)
           param = params[attr_name]
 
-          raise ArgumentError, "parameter #{param} does not support #length" unless param.respond_to?(:length)
+          return unless param.respond_to?(:length)
 
-          return unless (!@min.nil? && param.length < @min) || (!@max.nil? && param.length > @max)
+          return unless (!@min.nil? && param.length < @min) || (!@max.nil? && param.length > @max) || (!@is.nil? && param.length != @is)
 
           raise Grape::Exceptions::Validation.new(params: [@scope.full_name(attr_name)], message: build_message)
         end
@@ -32,8 +37,10 @@ module Grape
             format I18n.t(:length, scope: 'grape.errors.messages'), min: @min, max: @max
           elsif @min
             format I18n.t(:length_min, scope: 'grape.errors.messages'), min: @min
-          else
+          elsif @max
             format I18n.t(:length_max, scope: 'grape.errors.messages'), max: @max
+          else
+            format I18n.t(:length_is, scope: 'grape.errors.messages'), is: @is
           end
         end
       end

data/lib/grape/version.rb

@@ -2,5 +2,5 @@
 
 module Grape
   # The current version of Grape.
-  VERSION = '2.1.0'
+  VERSION = '2.2.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: grape
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.2.0
 platform: ruby
 authors:
 - Michael Bleigh
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-06-15 00:00:00.000000000 Z
+date: 2024-09-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -172,6 +172,7 @@ files:
 - lib/grape/middleware/versioner/header.rb
 - lib/grape/middleware/versioner/param.rb
 - lib/grape/middleware/versioner/path.rb
+- lib/grape/middleware/versioner_helpers.rb
 - lib/grape/namespace.rb
 - lib/grape/parser.rb
 - lib/grape/parser/json.rb
@@ -189,8 +190,6 @@ files:
 - lib/grape/serve_stream/sendfile_response.rb
 - lib/grape/serve_stream/stream_response.rb
 - lib/grape/types/invalid_value.rb
-- lib/grape/util/accept/header.rb
-- lib/grape/util/accept_header_handler.rb
 - lib/grape/util/base_inheritable.rb
 - lib/grape/util/cache.rb
 - lib/grape/util/endpoint_configuration.rb
@@ -204,7 +203,6 @@ files:
 - lib/grape/util/lazy/value_enumerable.rb
 - lib/grape/util/lazy/value_hash.rb
 - lib/grape/util/media_type.rb
-- lib/grape/util/registrable.rb
 - lib/grape/util/reverse_stackable_values.rb
 - lib/grape/util/stackable_values.rb
 - lib/grape/util/strict_hash_configuration.rb
@@ -252,9 +250,10 @@ licenses:
 - MIT
 metadata:
   bug_tracker_uri: https://github.com/ruby-grape/grape/issues
-  changelog_uri: https://github.com/ruby-grape/grape/blob/v2.1.0/CHANGELOG.md
-  documentation_uri: https://www.rubydoc.info/gems/grape/2.1.0
-  source_code_uri: https://github.com/ruby-grape/grape/tree/v2.1.0
+  changelog_uri: https://github.com/ruby-grape/grape/blob/v2.2.0/CHANGELOG.md
+  documentation_uri: https://www.rubydoc.info/gems/grape/2.2.0
+  source_code_uri: https://github.com/ruby-grape/grape/tree/v2.2.0
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -270,7 +269,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.7
+rubygems_version: 3.5.13
 signing_key:
 specification_version: 4
 summary: A simple Ruby framework for building REST-like APIs.

data/lib/grape/util/accept/header.rb

@@ -1,19 +0,0 @@
-# frozen_string_literal: true
-
-module Grape
-  module Util
-    module Accept
-      module Header
-        ALLOWED_CHARACTERS = %r{^([a-z*]+)/([a-z0-9*&\^\-_#{$ERROR_INFO}.+]+)(?:;([a-z0-9=;]+))?$}.freeze
-        class << self
-          # Corrected version of https://github.com/mjackson/rack-accept/blob/master/lib/rack/accept/header.rb#L40-L44
-          def parse_media_type(media_type)
-            # see http://tools.ietf.org/html/rfc6838#section-4.2 for allowed characters in media type names
-            m = media_type&.match(ALLOWED_CHARACTERS)
-            m ? [m[1], m[2], m[3] || ''] : []
-          end
-        end
-      end
-    end
-  end
-end

data/lib/grape/util/accept_header_handler.rb

@@ -1,105 +0,0 @@
-# frozen_string_literal: true
-
-module Grape
-  module Util
-    class AcceptHeaderHandler
-      attr_reader :accept_header, :versions, :vendor, :strict, :cascade
-
-      def initialize(accept_header:, versions:, **options)
-        @accept_header = accept_header
-        @versions = versions
-        @vendor = options.fetch(:vendor, nil)
-        @strict = options.fetch(:strict, false)
-        @cascade = options.fetch(:cascade, true)
-      end
-
-      def match_best_quality_media_type!(content_types: Grape::ContentTypes::CONTENT_TYPES, allowed_methods: nil)
-        return unless vendor
-
-        strict_header_checks!
-        media_type = Grape::Util::MediaType.best_quality(accept_header, available_media_types(content_types))
-        if media_type
-          yield media_type
-        else
-          fail!(allowed_methods)
-        end
-      end
-
-      private
-
-      def strict_header_checks!
-        return unless strict
-
-        accept_header_check!
-        version_and_vendor_check!
-      end
-
-      def accept_header_check!
-        return if accept_header.present?
-
-        invalid_accept_header!('Accept header must be set.')
-      end
-
-      def version_and_vendor_check!
-        return if versions.blank? || version_and_vendor?
-
-        invalid_accept_header!('API vendor or version not found.')
-      end
-
-      def q_values_mime_types
-        @q_values_mime_types ||= Rack::Utils.q_values(accept_header).map(&:first)
-      end
-
-      def version_and_vendor?
-        q_values_mime_types.any? { |mime_type| Grape::Util::MediaType.match?(mime_type) }
-      end
-
-      def invalid_accept_header!(message)
-        raise Grape::Exceptions::InvalidAcceptHeader.new(message, error_headers)
-      end
-
-      def invalid_version_header!(message)
-        raise Grape::Exceptions::InvalidVersionHeader.new(message, error_headers)
-      end
-
-      def fail!(grape_allowed_methods)
-        return grape_allowed_methods if grape_allowed_methods.present?
-
-        media_types = q_values_mime_types.map { |mime_type| Grape::Util::MediaType.parse(mime_type) }
-        vendor_not_found!(media_types) || version_not_found!(media_types)
-      end
-
-      def vendor_not_found!(media_types)
-        return unless media_types.all? { |media_type| media_type&.vendor && media_type.vendor != vendor }
-
-        invalid_accept_header!('API vendor not found.')
-      end
-
-      def version_not_found!(media_types)
-        return unless media_types.all? { |media_type| media_type&.version && versions.exclude?(media_type.version) }
-
-        invalid_version_header!('API version not found.')
-      end
-
-      def error_headers
-        cascade ? { Grape::Http::Headers::X_CASCADE => 'pass' } : {}
-      end
-
-      def available_media_types(content_types)
-        [].tap do |available_media_types|
-          base_media_type = "application/vnd.#{vendor}"
-          content_types.each_key do |extension|
-            versions&.reverse_each do |version|
-              available_media_types << "#{base_media_type}-#{version}+#{extension}"
-              available_media_types << "#{base_media_type}-#{version}"
-            end
-            available_media_types << "#{base_media_type}+#{extension}"
-          end
-
-          available_media_types << base_media_type
-          available_media_types.concat(content_types.values.flatten)
-        end
-      end
-    end
-  end
-end

data/lib/grape/util/registrable.rb

@@ -1,15 +0,0 @@
-# frozen_string_literal: true
-
-module Grape
-  module Util
-    module Registrable
-      def default_elements
-        @default_elements ||= {}
-      end
-
-      def register(format, element)
-        default_elements[format] = element unless default_elements[format]
-      end
-    end
-  end
-end