openapi_parameters 0.3.3 → 0.3.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e010a357f13e7452f8945d95e7c277fc35c87d1cc713e41dccae68a20d37db03
-  data.tar.gz: 763b4eed6e0e11c4f0ff839afa366cadc6569c371a4ccd5490a7b3368f8849fc
+  metadata.gz: fa336f02dcfc58d656659606710c5fed70335b7a5e101f42228a24913e12325b
+  data.tar.gz: e81f400174546397953abe62d23c26f07fbf14f594ca2297ad129118847a4709
 SHA512:
-  metadata.gz: 49a1e95d33f513346408826aa1954d9a8c58b7a656d23b1643f8f5664e3747ab04589586d8c6ffcd9392022ff85ad2f4722dd9e541f569399ff8a7bd2226ecb6
-  data.tar.gz: 6bc8eadb1948050b12ab6561c8e412ab124d0bfd64d94414506f71d5c1549d963c2d765ce0e9ebea1908c258ef30d17b7f8c4db3bd9c81643897c0bac86ad487
+  metadata.gz: b30a7b111b652c9dbc12e0c19ef5f9dc74a5ba9b6eebc0a7392ba0d5070d7c19578017a64e8948e8dd235b57e8784202e37765c62be015c5520940278def939f
+  data.tar.gz: 1e91216f5bff01be794c5eec6a469cea42162472568c2d881afa3267aa036257d0afab0e97534edd57f074217122c96abac08e3e6d4a14c139348bb0ae81fd8e

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 ## [Unreleased]
 
+## [0.3.4] - 2024-06-14
+
+- Fix handling invalid object query parameters (String vs Hash)
+
 ## [0.3.3] - 2023-04-13
 
 - Remove zeitwerk. It's awesome, but not needed here

data/README.md

@@ -13,22 +13,20 @@ Note that OpenAPI supportes parameter definition on path and operation objects.
 ### Unpack query/path/header/cookie parameters from HTTP requests according to their OpenAPI definition
 
 ```ruby
-parameters = [{
+
+query_parameters = OpenapiParameters::Query.new([{
   'name' => 'ids',
   'required' => true,
-  'in' => 'query', # or 'path', 'header', 'cookie'
+  'in' => 'query', # Note that we only pass query parameters here
   'schema' => {
     'type' => 'array',
     'items' => {
       'type' => 'integer'
     }
   }
-}]
-
-query_parameters = OpenapiParameters::Query.new(parameters)
+}])
 query_string = env['QUERY_STRING'] # => 'ids=1&ids=2'
 query_parameters.unpack(query_string) # => { 'ids' => [1, 2] }
-query_parameters.unpack(query_string, convert: false) # => { 'ids' => ['1', '2'] }
 
 path_parameters = OpenapiParameters::Path.new(parameters)
 route_params = env['route.params'] # This depends on the webframework you are using

data/lib/openapi_parameters/converter.rb

@@ -5,7 +5,7 @@ module OpenapiParameters
   module Converter
     class << self
       ##
-      # @param input [String, Hash, Array] the value to convert
+      # @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
         return if value.nil?
@@ -43,9 +43,11 @@ module OpenapiParameters
         end
       end
 
-      def convert_object(object, schema)
-        object.each_with_object({}) do |(key, value), hsh|
-          hsh[key] = convert(value, schema['properties']&.fetch(key, nil))
+      def convert_object(value, schema)
+        return value unless value.is_a?(Hash)
+
+        value.each_with_object({}) do |(key, val), hsh|
+          hsh[key] = convert(val, schema['properties']&.fetch(key, nil))
         end
       end
 

data/lib/openapi_parameters/cookie.rb

@@ -6,7 +6,7 @@ module OpenapiParameters
     # @param parameters [Array<Hash>] The OpenAPI parameter definitions.
     # @param convert [Boolean] Whether to convert the values to the correct type.
     def initialize(parameters, convert: true)
-      @parameters = parameters
+      @parameters = parameters.map { Parameter.new(_1) }
       @convert = convert
     end
 
@@ -14,7 +14,6 @@ module OpenapiParameters
     def unpack(cookie_string)
       cookies = Rack::Utils.parse_cookies_header(cookie_string)
       parameters.each_with_object({}) do |parameter, result|
-        parameter = Parameter.new(parameter)
         next unless cookies.key?(parameter.name)
 
         result[parameter.name] = catch :skip do

data/lib/openapi_parameters/header.rb

@@ -6,14 +6,13 @@ module OpenapiParameters
     # @param parameters [Array<Hash>] The OpenAPI parameters
     # @param convert [Boolean] Whether to convert the values to the correct type.
     def initialize(parameters, convert: true)
-      @parameters = parameters
+      @parameters = parameters.map { Parameter.new(_1) }
       @convert = convert
     end
 
     # @param headers [Hash] The headers from the request. Use HeadersHash to convert a Rack env to a Hash.
     def unpack(headers)
       parameters.each_with_object({}) do |parameter, result|
-        parameter = Parameter.new(parameter)
         next unless headers.key?(parameter.name)
 
         result[parameter.name] = catch :skip do

data/lib/openapi_parameters/path.rb

@@ -8,7 +8,7 @@ module OpenapiParameters
     # @param parameters [Array<Hash>] The OpenAPI path parameters.
     # @param convert [Boolean] Whether to convert the values to the correct type.
     def initialize(parameters, convert: true)
-      @parameters = parameters
+      @parameters = parameters.map { Parameter.new(_1) }
       @convert = convert
     end
 
@@ -16,8 +16,7 @@ module OpenapiParameters
 
     # @param path_params [Hash] The path parameters from the Rack request. The keys are strings.
     def unpack(path_params)
-      parameters.each_with_object({}) do |param, result|
-        parameter = Parameter.new(param)
+      parameters.each_with_object({}) do |parameter, result|
         next unless path_params.key?(parameter.name)
 
         result[parameter.name] = catch :skip do

data/lib/openapi_parameters/query.rb

@@ -8,14 +8,13 @@ module OpenapiParameters
     # @param parameters [Array<Hash>] The OpenAPI query parameter definitions.
     # @param convert [Boolean] Whether to convert the values to the correct type.
     def initialize(parameters, convert: true)
-      @parameters = parameters
+      @parameters = parameters.map { Parameter.new(_1) }
       @convert = convert
     end
 
     def unpack(query_string) # rubocop:disable Metrics/AbcSize
       parsed_query = Rack::Utils.parse_query(query_string)
       parameters.each_with_object({}) do |parameter, result|
-        parameter = Parameter.new(parameter)
         if parameter.deep_object?
           parsed_nested_query = Rack::Utils.parse_nested_query(query_string)
           next unless parsed_nested_query.key?(parameter.name)

data/lib/openapi_parameters/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: openapi_parameters
 version: !ruby/object:Gem::Version
-  version: 0.3.3
+  version: 0.3.4
 platform: ruby
 authors:
 - Andreas Haller
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-04-13 00:00:00.000000000 Z
+date: 2024-06-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack