openapi_parameters 0.3.3 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e010a357f13e7452f8945d95e7c277fc35c87d1cc713e41dccae68a20d37db03
-  data.tar.gz: 763b4eed6e0e11c4f0ff839afa366cadc6569c371a4ccd5490a7b3368f8849fc
+  metadata.gz: c0d1127ef2e34d916ca293835143d6267d1baf9cfb6f51ca12384e712f57eef0
+  data.tar.gz: ced0820dba10352ab2a460b4c621c5fcbd2f79400008aef3081d442027189113
 SHA512:
-  metadata.gz: 49a1e95d33f513346408826aa1954d9a8c58b7a656d23b1643f8f5664e3747ab04589586d8c6ffcd9392022ff85ad2f4722dd9e541f569399ff8a7bd2226ecb6
-  data.tar.gz: 6bc8eadb1948050b12ab6561c8e412ab124d0bfd64d94414506f71d5c1549d963c2d765ce0e9ebea1908c258ef30d17b7f8c4db3bd9c81643897c0bac86ad487
+  metadata.gz: 1d3bbef2747984f498d259cd838ff5e9acbfd8f5417ad8718f7ac9d8ea078a72af94b3835f6307c967803c447ff3e7be0eb6b4b1cae9bb3d2afd1138226e8091
+  data.tar.gz: 6d17518118d5df6dc5376e8bed4b131f65077c5ed71293fe41425f788c0ecddc7fbbd476a1e93cf28e022d522fb8973b1afe0090be9ab71b3b2b08b036aa70a3

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 ## [Unreleased]
 
+## [0.3.4] - 2024-12-17
+
+- Add Parameter#convert(value)
+- Slight performance optimization
+
+## [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

@@ -2,10 +2,11 @@
 
 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 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 +44,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/converters.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module OpenapiParameters
+  # Home for all converters
+  module Converters
+    @converters = {}
+
+    class << self
+      attr_reader :converters
+
+      def register(type, converter)
+        converters[type] = converter
+      end
+
+      def [](schema)
+        type = schema && schema['type']
+        converters.fetch(type) do
+          ->(value) { Converter.convert(value, schema) }
+        end
+      end
+    end
+
+    register('integer', lambda do |value|
+      Integer(value, 10)
+    rescue StandardError
+      value
+    end)
+
+    register('number', lambda do |value|
+      Float(value)
+    rescue StandardError
+      value
+    end)
+
+    register('boolean', lambda do |value|
+      if value == 'true'
+        true
+      else
+        value == 'false' ? false : value
+      end
+    end)
+  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,12 +14,11 @@ 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
           value = Unpacker.unpack_value(parameter, cookies[parameter.name])
-          @convert ? Converter.convert(value, parameter.schema) : value
+          @convert ? parameter.convert(value) : value
         end
       end
     end

data/lib/openapi_parameters/header.rb

@@ -6,19 +6,18 @@ 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
           value = Unpacker.unpack_value(parameter, headers[parameter.name])
-          @convert ? Converter.convert(value, parameter.schema) : value
+          @convert ? parameter.convert(value) : value
         end
       end
     end

data/lib/openapi_parameters/parameter.rb

@@ -9,11 +9,16 @@ module OpenapiParameters
       @definition = definition
       @name = definition['name']
       @is_deep_object = style == 'deepObject'
+      @converter = Converters[schema]
       check_supported!
     end
 
     attr_reader :definition, :name
 
+    def convert(value)
+      @converter.call(value)
+    end
+
     def deep_object?
       @is_deep_object
     end

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,13 +16,12 @@ 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
           value = Unpacker.unpack_value(parameter, path_params[parameter.name])
-          @convert ? Converter.convert(value, parameter.schema) : value
+          @convert ? parameter.convert(value) : value
         end
       end
     end

data/lib/openapi_parameters/query.rb

@@ -8,25 +8,24 @@ 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)
 
-          result[parameter.name] = convert(parsed_nested_query[parameter.name], parameter)
+          value = parsed_nested_query[parameter.name]
         else
           next unless parsed_query.key?(parameter.name)
 
           value = Unpacker.unpack_value(parameter, parsed_query[parameter.name])
-          result[parameter.name] = convert(value, parameter)
         end
+        result[parameter.name] = @convert ? parameter.convert(value) : value
       end
     end
 

data/lib/openapi_parameters/version.rb

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

data/lib/openapi_parameters.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'rack'
+require_relative 'openapi_parameters/converters'
 require_relative 'openapi_parameters/converter'
 require_relative 'openapi_parameters/cookie'
 require_relative 'openapi_parameters/error'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: openapi_parameters
 version: !ruby/object:Gem::Version
-  version: 0.3.3
+  version: 0.4.0
 platform: ruby
 authors:
 - Andreas Haller
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-04-13 00:00:00.000000000 Z
+date: 2024-12-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -36,6 +36,7 @@ files:
 - README.md
 - lib/openapi_parameters.rb
 - lib/openapi_parameters/converter.rb
+- lib/openapi_parameters/converters.rb
 - lib/openapi_parameters/cookie.rb
 - lib/openapi_parameters/error.rb
 - lib/openapi_parameters/header.rb