openapi_parameters 0.3.4 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fa336f02dcfc58d656659606710c5fed70335b7a5e101f42228a24913e12325b
-  data.tar.gz: e81f400174546397953abe62d23c26f07fbf14f594ca2297ad129118847a4709
+  metadata.gz: 778cfe7ccd40119158a3c158b5cf1dcf8000436a4c747a1ecfa349782ffa99d1
+  data.tar.gz: ebdb7a20b68b881e526e11fd30e05458ed8dd5dea34b16f94115e522dfa1801f
 SHA512:
-  metadata.gz: b30a7b111b652c9dbc12e0c19ef5f9dc74a5ba9b6eebc0a7392ba0d5070d7c19578017a64e8948e8dd235b57e8784202e37765c62be015c5520940278def939f
-  data.tar.gz: 1e91216f5bff01be794c5eec6a469cea42162472568c2d881afa3267aa036257d0afab0e97534edd57f074217122c96abac08e3e6d4a14c139348bb0ae81fd8e
+  metadata.gz: 61c5e95989223be85f4965355aede74739ac71a3f07ebeba9b6486ef56acf45a64093ffa23b680d1ccad28f7abbbcc4d94a6135acf4575f87f7e67773ccdd97c
+  data.tar.gz: 82fe0b18f8a79e758b5b3a3a496a8de373cc7a47079a3944cd5a6843130c03c1ca6b5173d479a8c2c0a14697e106f2d1aa407d6181e1feac8e5b2cdd074bb4bd

data/CHANGELOG.md

@@ -1,5 +1,21 @@
 ## [Unreleased]
 
+## [0.5.0] - 2025-04-01
+
+- Add option to remove "[]" from unpacked query openapi_parameters
+  ```ruby
+  OpenapiParameters::Query.new(
+    [parameter],
+    rack_array_compat: true
+  ).unpack('ids[]=2')
+  # => { 'ids' => ['2'] }
+  ```
+
+## [0.4.0] - 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)

data/lib/openapi_parameters/converter.rb

@@ -2,6 +2,7 @@
 
 module OpenapiParameters
   # Tries to convert a request parameter value (string) to the type specified in the JSON Schema.
+  # @visibility private
   module Converter
     class << self
       ##

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

@@ -18,7 +18,7 @@ module OpenapiParameters
 
         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/error.rb

@@ -3,4 +3,7 @@
 module OpenapiParameters
   class Error < StandardError
   end
+
+  class NotSupportetError < Error
+  end
 end

data/lib/openapi_parameters/header.rb

@@ -17,7 +17,7 @@ module OpenapiParameters
 
         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
@@ -47,6 +52,13 @@ module OpenapiParameters
       type == 'array'
     end
 
+    EMPTY_BRACKETS = '[]'
+    private_constant :EMPTY_BRACKETS
+
+    def bracket_array?
+      @bracket_array ||= array? && name.end_with?(EMPTY_BRACKETS)
+    end
+
     def object?
       type == 'object' || style == 'deepObject' || schema&.key?('properties')
     end

data/lib/openapi_parameters/path.rb

@@ -21,7 +21,7 @@ module OpenapiParameters
 
         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

@@ -7,9 +7,10 @@ module OpenapiParameters
   class Query
     # @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)
+    def initialize(parameters, convert: true, rack_array_compat: false)
       @parameters = parameters.map { Parameter.new(_1) }
       @convert = convert
+      @remove_array_brackets = rack_array_compat
     end
 
     def unpack(query_string) # rubocop:disable Metrics/AbcSize
@@ -19,17 +20,23 @@ module OpenapiParameters
           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
+        key = if remove_array_brackets && parameter.bracket_array?
+                parameter.name.delete_suffix('[]')
+              else
+                parameter.name
+              end
+        result[key] = @convert ? parameter.convert(value) : value
       end
     end
 
     attr_reader :parameters
+    private attr_reader :remove_array_brackets
 
     private
 

data/lib/openapi_parameters/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module OpenapiParameters
-  VERSION = '0.3.4'
+  VERSION = '0.5.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.4
+  version: 0.5.0
 platform: ruby
 authors:
 - Andreas Haller
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-06-14 00:00:00.000000000 Z
+date: 2025-04-01 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