openapi_parameters 0.8.0 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ee2751342867fef145f12b7b8cd681cca155ba396a89c69f6c476d5566967cff
-  data.tar.gz: 7f00815807f40d26a66b9aac7c58565ad568adb4a7d91b497805168d9b4e9def
+  metadata.gz: 6e4a1690610c9bbbd5f901f5521b8d5c417d5679b2d3c22bf7c3b4fe5863a9a4
+  data.tar.gz: 37cadc3d8d9ff17c11082d1fe14db177b1778d14f0b89698fe5ad2292b5927db
 SHA512:
-  metadata.gz: 27e43f8835d7759baef4deb7969a6517fedcf6e7456916369c4d6aeae4ff624ce77eaff7968c5ab01f36edbcd92b1bbc9388d3af14170d8c0130c874621f882d
-  data.tar.gz: 107e3ffa3b290342b68ae3a6228a4b780e2cbd7be26c12ee42aa276d1be0128a4f024b724424f6e2330578d833995644a23e0f9907b3cf145f1978f8916acb4b
+  metadata.gz: b842ce9afd9246033103fddc51a26e888d9154eb4e694722f55c3ad3cb6a8226b3315e738411e71a21c516b5ef4f3bd8d86699d4638016b7c5aa5cec52b252c8
+  data.tar.gz: '09dd12da6978846a76a680fb22a859f339fb398bc3733682bf5924ff42d6de39e13b3f2f231552f777e175a1894fe9a915cd449dc7157b0ae2d37de21bd7b1b9'

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 ## [Unreleased]
 
+## [0.9.0] - 2025-11-07
+
+- Add support for unpacking query parameters that use deepObject and oneOf,andOf,anyOf,if-them-else
+
 ## [0.8.0] - 2025-09-17
 
 - No longer parse more than one level of nested objects when parsing `deepObject` parameters. This is actually in line with what `deepObject` supports.

data/lib/openapi_parameters/array_converter.rb

@@ -2,13 +2,7 @@
 
 module OpenapiParameters
   # @visibility private
-  class ArrayConverter
-    def initialize(schema)
-      @schema = schema
-    end
-
-    attr_reader :schema
-
+  ArrayConverter = Data.define(:schema) do
     def call(value)
       return [] if value.nil? || value.empty?
 

data/lib/openapi_parameters/converter.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require_relative 'array_converter'
+require_relative 'object_converter'
 
 module OpenapiParameters
   # Tries to convert a request parameter value (string) to the type specified in the JSON Schema.
@@ -33,26 +34,18 @@ module OpenapiParameters
             value == 'false' ? false : value
           end
         when 'object'
-          convert_object(value, schema)
+          ObjectConverter.new(schema).call(value)
         when 'array'
           ArrayConverter.new(schema).call(value)
         else
-          if schema['properties']
-            convert_object(value, schema)
+          if schema['properties'] || schema['oneOf'] || schema['allOf'] || schema['anyOf']
+            ObjectConverter.new(schema).call(value)
           else
             value
           end
         end
       end
 
-      def convert_object(value, schema)
-        return value unless value.is_a?(Hash)
-
-        value.each_with_object({}) do |(key, val), hsh|
-          hsh[key] = Converter.convert(val, schema['properties']&.fetch(key, nil))
-        end
-      end
-
       private
 
       def type(schema)

data/lib/openapi_parameters/object_converter.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module OpenapiParameters
+  # @visibility private
+  ObjectConverter = Data.define(:schema) do
+    def self.get_properties(schema) # rubocop:disable Metrics
+      return nil if schema.nil? || schema.empty?
+
+      direct_props = schema['properties']
+      additional_props = schema['additionalProperties']
+
+      composition_props = []
+
+      %w[allOf oneOf anyOf].each do |keyword|
+        next unless (array = schema[keyword])
+
+        array.each do |sub_schema|
+          if (props = sub_schema['properties'])
+            composition_props << props
+          end
+        end
+      end
+
+      %w[then else].each do |keyword|
+        next unless (sub_schema = schema[keyword])
+
+        if (props = sub_schema['properties'])
+          composition_props << props
+        end
+        if (add_props = sub_schema['additionalProperties']) && add_props.is_a?(Hash) && !add_props.empty?
+          composition_props << add_props
+        end
+      end
+
+      composition_props << additional_props if additional_props.is_a?(Hash) && !additional_props.empty?
+
+      return direct_props if composition_props.empty? && direct_props
+      return nil if direct_props.nil? && composition_props.empty?
+
+      result = direct_props ? direct_props.dup : {}
+      composition_props.each { |props| result.merge!(props) }
+      result
+    end
+
+    def call(value)
+      return value unless value.is_a?(Hash)
+
+      properties = self.class.get_properties(schema)
+
+      value.each_with_object({}) do |(key, val), hsh|
+        hsh[key] = Converter.convert(val, properties&.fetch(key, nil))
+      end
+    end
+  end
+end

data/lib/openapi_parameters/query.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'rack'
+require_relative 'converter'
 
 module OpenapiParameters
   # Query parses query parameters from a http query strings.
@@ -11,7 +12,6 @@ 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
@@ -35,14 +35,10 @@ module OpenapiParameters
     end
 
     attr_reader :parameters
-    private attr_reader :remove_array_brackets
+    private attr_reader :remove_array_brackets, :parameter_property_schemas
 
     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)
@@ -51,22 +47,34 @@ module OpenapiParameters
       end
     end
 
+    def build_properties_schema(parameter)
+      schema = parameter.schema
+      ObjectConverter.get_properties(schema) if schema
+    end
+
+    DEEP_PROP = '\[([\w-]+)\]$'
+    private_constant :DEEP_PROP
+
     def parse_deep_object(parameter, parsed_query)
-      schema_props = parameter.schema['properties'] || {}
       name = parameter.name
-      schema_props.each.with_object({}) do |(prop, schema), result|
-        key = "#{name}[#{prop}]"
+      prop_regx = /^#{name}#{DEEP_PROP}/
+      properties_schema = build_properties_schema(parameter)
+
+      parsed_query.each.with_object({}) do |(key, value), result|
         next unless parsed_query.key?(key)
 
-        value = explode_value(parsed_query[key], parameter, schema)
-        result[prop] = value
+        prop_key = key.match(prop_regx)&.[](1)
+        next if prop_key.nil?
+
+        is_array = properties_schema&.dig(prop_key, 'type') == 'array'
+        value = explode_value(value, parameter, is_array)
+        result[prop_key] = value
       end
     end
 
-    def explode_value(value, parameter, schema)
-      type = schema['type']
+    def explode_value(value, parameter, is_array)
       value = Array(value).map! { |v| Rack::Utils.unescape(v) }
-      if type == 'array'
+      if is_array
         return value if parameter.explode?
 
         return [value.last]

data/lib/openapi_parameters/version.rb

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

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: openapi_parameters
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.9.0
 platform: ruby
 authors:
 - Andreas Haller
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-09-17 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -43,6 +42,7 @@ files:
 - lib/openapi_parameters/header.rb
 - lib/openapi_parameters/headers_hash.rb
 - lib/openapi_parameters/not_supported_error.rb
+- lib/openapi_parameters/object_converter.rb
 - lib/openapi_parameters/parameter.rb
 - lib/openapi_parameters/path.rb
 - lib/openapi_parameters/query.rb
@@ -56,7 +56,6 @@ metadata:
   source_code_uri: https://github.com/ahx/openapi_parameters
   changelog_uri: https://github.com/ahx/openapi_parameters/blob/main/CHANGELOG.md
   rubygems_mfa_required: 'true'
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -64,15 +63,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.1.0
+      version: 3.2.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.6
-signing_key:
+rubygems_version: 3.6.7
 specification_version: 4
 summary: openapi_parameters is an OpenAPI aware parameter parser
 test_files: []