openapi_parameters 0.9.0.beta1 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 333fd99034d125536a4a747d4c611e474ba8f2c41aa84d9c983f0cd7425b13cb
-  data.tar.gz: '067223459914938a710d91de39125b4e8c7a7dc820b637fa5c3fa2bc1502465e'
+  metadata.gz: 52bca4aebd3d66fa0a3edc68d3ce71a24a223a31be135677a8fb9ea09a4055bc
+  data.tar.gz: '03230596b824ee0a59ca68048bcfc68e884af2cbbb3b14ea3952c1f917a7d87b'
 SHA512:
-  metadata.gz: 653a7d0631784ed6ce34187307a973f08fee2560dceb93390d4d509f49c68acb6101d4cd1a274eb009df9020a81a0081089c24af4aeb6f64be43f4f46a9bdbfc
-  data.tar.gz: e458b12c372881a3e2503e891348da76ad735fc197f66343c6ff74fd1dd8107d2054c553b246959c7ef3a793e52b4432ca2e3c2d955ef7b66d6f59968f2bd1ab
+  metadata.gz: e5bf0752ef3be5d397cd5f5cee010a5e89fc4c1a1821ec0b86411fb1a97bfae8e81be46f5fa94d5bd47940c921f0a0dab9641f591f6ceddecfc856dd881f34d7
+  data.tar.gz: 8244a7c1c93ef4c0c2ee88374c4bb72f3f6295a11637fff60b02ad96e9015e702b284251eff003309ebdc0bb8f6ccf38f85334a9be7d6801bcd0b6f48cc5e808

data/CHANGELOG.md

@@ -1,6 +1,13 @@
 ## [Unreleased]
 
-- Add basic support unpacking query paramters that use deepObject and oneOf
+## [0.10.0] - 2025-11-23
+
+- remove `OpenapiParameters::Parameter#definition` to clean up interface
+- Add `OpenapiParameters::Query#unknown_values` to find unknown query parameters
+
+## [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
 

data/README.md

@@ -28,6 +28,10 @@ query_parameters = OpenapiParameters::Query.new([{
 query_string = env['QUERY_STRING'] # => 'ids=1&ids=2'
 query_parameters.unpack(query_string) # => { 'ids' => [1, 2] }
 
+# Find unknown query parameters
+# Note that this does only return unknown top-level values 
+query_parameters.unknown_values('ids=1&ids=2&foo=bar') # => { 'foo' => 'bar' }
+
 path_parameters = OpenapiParameters::Path.new(parameters)
 route_params = env['route.params'] # This depends on the webframework you are using
 path_parameters.unpack(route_params) # => { 'ids' => [1, 2, 3] }

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/parameter.rb

@@ -13,7 +13,8 @@ module OpenapiParameters
       check_supported!
     end
 
-    attr_reader :definition, :name
+    attr_reader :name
+    private attr_reader :definition
 
     def convert(value)
       @converter.call(value)

data/lib/openapi_parameters/query.rb

@@ -34,6 +34,24 @@ module OpenapiParameters
       end
     end
 
+    def unknown_values(query_string)
+      parsed_query = parse_query(query_string)
+      known_parameter_names = parameters.to_set(&:name)
+
+      unknown = parsed_query.each_with_object({}) do |(key, value), result|
+        # Skip parameters that are defined in the schema
+        next if known_parameter_names.include?(key)
+
+        # Skip deep object parameters that might belong to defined parameters
+        next if parameters.any? { |param| param.deep_object? && key.start_with?("#{param.name}[") }
+
+        result[key] = value
+      end
+      return if unknown.empty?
+
+      unknown
+    end
+
     attr_reader :parameters
     private attr_reader :remove_array_brackets, :parameter_property_schemas
 
@@ -49,18 +67,7 @@ module OpenapiParameters
 
     def build_properties_schema(parameter)
       schema = parameter.schema
-      return unless schema
-
-      props = schema['properties']
-      return props if props
-
-      combinations = schema.slice('allOf', 'oneOf', 'anyOf')
-      if combinations.any?
-        props = combinations.values.flat_map { |value| value.map { |sub| sub['properties'] }.compact }
-        return {}.merge(*props.compact)
-      end
-
-      schema
+      ObjectConverter.get_properties(schema) if schema
     end
 
     DEEP_PROP = '\[([\w-]+)\]$'
@@ -69,13 +76,15 @@ module OpenapiParameters
     def parse_deep_object(parameter, parsed_query)
       name = parameter.name
       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)
 
         prop_key = key.match(prop_regx)&.[](1)
         next if prop_key.nil?
 
-        is_array = parameter.schema&.dig('properties', prop_key, 'type') == 'array'
+        is_array = properties_schema&.dig(prop_key, 'type') == 'array'
         value = explode_value(value, parameter, is_array)
         result[prop_key] = value
       end

data/lib/openapi_parameters/version.rb

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

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: openapi_parameters
 version: !ruby/object:Gem::Version
-  version: 0.9.0.beta1
+  version: 0.10.0
 platform: ruby
 authors:
 - Andreas Haller
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-11-05 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: 1.3.1
+      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: []