openapi_parameters 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b798ca1e80a551797f19f1b1f2242b7785af3158446c898d9b0aadaa9c520777
-  data.tar.gz: d8540ac316847320ace7b8379395514c5f2deee2b711ab097e8b73c22b2de14f
+  metadata.gz: 2c8fe7a86aaad928b6277f62969502db824f37ff92624c6f33abfa43dad15454
+  data.tar.gz: f8b36c4416ff14775bf9cb7ca05c5d6ad45589a5a1a390a6bcaa395142027241
 SHA512:
-  metadata.gz: c8c9011ca61153e8fb20f375aa3bda9f11f69a4bac614726cff883f1811e219eece7a4cad2ee384ead8d0688a6f327783ed1c156cc94505ad791341e22d0fc97
-  data.tar.gz: 1e5fe939d22288b0196ea0a85a7152f022f2f3e96a2f5ac65329f97cb7448517b1df0b13926cf0d4ef227346ca4f002e2727bc8a2e5ceacfadca857b9ffa3dbf
+  metadata.gz: f447c974255d4f21c3822c975b655ddb3f988a513bdb1684491a4bc0a60406f66d170378b8d5e2bc7d64eed5b94366716fdafa9f4074e90f5f1f1ad4567b0d2d
+  data.tar.gz: f3ac74f5faecfca7aa8513fe0e4ce901a5cca2ca42833e0f0c07e2b844e8e8ded7166ac99b492631d0d2173173cce438f4a8c37daa0b16491db0d7ddaf09aa1f

data/CHANGELOG.md

@@ -1,5 +1,20 @@
 ## [Unreleased]
 
+## [0.7.0] - 2025-09-12
+
+- Correctly handle `style:deepObject` with `explode: true` and parse into array
+  ```ruby
+  OpenapiParameters::Query.new(
+      [parameter],
+      explode: true
+  ).unpack('ids=1&ids=2')
+  # => { 'ids' => ['1', '2'] }
+  ```
+
+## [0.6.1] - 2025-06-23
+
+- Fix converting items of array parameters
+
 ## [0.6.0] - 2025-06-23
 
 - Array parameters without a value ("?ids=" or "?ids") return an empty array instead of nil or an empty string.

data/lib/openapi_parameters/array_converter.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module OpenapiParameters
+  # @visibility private
+  class ArrayConverter
+    def initialize(schema)
+      @schema = schema
+    end
+
+    attr_reader :schema
+
+    def call(value)
+      return [] if value.nil? || value.empty?
+
+      convert_array(value)
+    end
+
+    private
+
+    def convert_array(array)
+      return array unless array.is_a?(Array)
+
+      item_schema = schema['items']
+      prefix_schemas = schema['prefixItems']
+      return convert_array_with_prefixes(array, prefix_schemas, item_schema) if prefix_schemas
+
+      array.map { |item| Converter.convert(item, item_schema) }
+    end
+
+    def convert_array_with_prefixes(array, prefix_schemas, item_schema)
+      prefixes =
+        array
+        .slice(0, prefix_schemas.size)
+        .each_with_index
+        .map { |item, index| Converter.convert(item, prefix_schemas[index]) }
+      array =
+        array[prefix_schemas.size..].map! do |item|
+          Converter.convert(item, item_schema)
+        end
+      prefixes + array
+    end
+  end
+end

data/lib/openapi_parameters/converter.rb

@@ -1,11 +1,12 @@
 # frozen_string_literal: true
 
+require_relative 'array_converter'
+
 module OpenapiParameters
   # Tries to convert a request parameter value (string) to the type specified in the JSON Schema.
   # @visibility private
   module Converter
     class << self
-      ##
       # @param value [String, Hash, Array] the value to convert
       # @param schema [Hash] the schema to use for conversion.
       def convert(value, schema) # rubocop:disable Metrics
@@ -34,7 +35,7 @@ module OpenapiParameters
         when 'object'
           convert_object(value, schema)
         when 'array'
-          convert_array(value, schema)
+          ArrayConverter.new(schema).call(value)
         else
           if schema['properties']
             convert_object(value, schema)
@@ -48,7 +49,7 @@ module OpenapiParameters
         return value unless value.is_a?(Hash)
 
         value.each_with_object({}) do |(key, val), hsh|
-          hsh[key] = convert(val, schema['properties']&.fetch(key, nil))
+          hsh[key] = Converter.convert(val, schema['properties']&.fetch(key, nil))
         end
       end
 
@@ -57,29 +58,6 @@ module OpenapiParameters
       def type(schema)
         schema && schema['type']
       end
-
-      def convert_array(array, schema)
-        return array unless array.is_a?(Array)
-
-        item_schema = schema['items']
-        prefix_schemas = schema['prefixItems']
-        return convert_array_with_prefixes(array, prefix_schemas, item_schema) if prefix_schemas
-
-        array.map { |item| convert(item, item_schema) }
-      end
-
-      def convert_array_with_prefixes(array, prefix_schemas, item_schema)
-        prefixes =
-          array
-          .slice(0, prefix_schemas.size)
-          .each_with_index
-          .map { |item, index| convert(item, prefix_schemas[index]) }
-        array =
-          array[prefix_schemas.size..].map! do |item|
-            convert(item, item_schema)
-          end
-        prefixes + array
-      end
     end
   end
 end

data/lib/openapi_parameters/converters.rb

@@ -15,6 +15,8 @@ module OpenapiParameters
       def [](schema)
         type = schema && schema['type']
         converters.fetch(type) do
+          return ArrayConverter.new(schema) if type == 'array'
+
           ->(value) { Converter.convert(value, schema) }
         end
       end
@@ -26,12 +28,6 @@ module OpenapiParameters
       value
     end)
 
-    register('array', lambda do |value|
-      break [] if value.nil? || value.empty?
-
-      value
-    end)
-
     register('number', lambda do |value|
       Float(value)
     rescue StandardError

data/lib/openapi_parameters/parameter.rb

@@ -9,6 +9,7 @@ module OpenapiParameters
       @definition = definition
       @name = definition['name']
       @is_deep_object = style == 'deepObject'
+      @is_explode = explode?
       @converter = Converters[schema]
       check_supported!
     end

data/lib/openapi_parameters/query.rb

@@ -11,16 +11,21 @@ module OpenapiParameters
       @parameters = parameters.map { Parameter.new(_1) }
       @convert = convert
       @remove_array_brackets = rack_array_compat
+      @any_deep_object = @parameters.any?(&:deep_object?)
     end
 
-    def unpack(query_string) # rubocop:disable Metrics/AbcSize
+    def unpack(query_string) # rubocop:disable Metrics/AbcSize,Metrics/MethodLength
       parsed_query = parse_query(query_string)
+      parsed_nested_query = Rack::Utils.parse_nested_query(query_string) if any_deep_object?
       parameters.each_with_object({}) do |parameter, result|
         if parameter.deep_object?
-          parsed_nested_query = Rack::Utils.parse_nested_query(query_string)
           next unless parsed_nested_query.key?(parameter.name)
 
-          value = parsed_nested_query[parameter.name]
+          value = if parameter.explode?
+                    handle_deep_object_explode(parameter, parsed_nested_query[parameter.name], parsed_query)
+                  else
+                    parsed_nested_query[parameter.name]
+                  end
         else
           next unless parsed_query.key?(parameter.name)
 
@@ -40,6 +45,10 @@ module OpenapiParameters
 
     private
 
+    def any_deep_object?
+      @any_deep_object
+    end
+
     def parse_query(query_string)
       Rack::Utils.parse_query(query_string) do |s|
         Rack::Utils.unescape(s)
@@ -48,18 +57,31 @@ module OpenapiParameters
       end
     end
 
-    def convert_primitive(value, parameter)
-      return value unless @convert
-      return value if value == ''
+    def handle_deep_object_explode(parameter, value, parsed_query)
+      return value unless value.is_a?(Hash)
 
-      Converter.convert_primitive(value, parameter.schema)
-    end
+      schema_props = parameter.schema['properties'] || {}
+
+      array_prop_values = find_prop_matches(parameter.name, schema_props, parsed_query)
 
-    def convert(value, parameter)
-      return value unless @convert
-      return value if value == ''
+      schema_props.each_with_object(value) do |(prop, prop_schema), result|
+        next unless prop_schema['type'] == 'array'
 
-      Converter.convert(value, parameter.schema)
+        arr = array_prop_values[prop]
+        result[prop] = if arr.empty? && value.key?(prop)
+                         Array(value[prop])
+                       else
+                         arr
+                       end
+      end
+    end
+
+    def find_prop_matches(parameter_name, schema_props, parsed_query)
+      schema_props.each_key.with_object({}) do |prop, result|
+        key = "#{parameter_name}[#{prop}]"
+        value = Array(parsed_query[key])
+        result[prop] = value.map { |match| Rack::Utils.unescape(match) } if value.is_a?(Array)
+      end
     end
   end
 end

data/lib/openapi_parameters/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module OpenapiParameters
-  VERSION = '0.6.0'
+  VERSION = '0.7.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: openapi_parameters
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Andreas Haller
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-06-26 00:00:00.000000000 Z
+date: 2025-09-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -35,6 +35,7 @@ files:
 - CHANGELOG.md
 - README.md
 - lib/openapi_parameters.rb
+- lib/openapi_parameters/array_converter.rb
 - lib/openapi_parameters/converter.rb
 - lib/openapi_parameters/converters.rb
 - lib/openapi_parameters/cookie.rb