openapi_parameters 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8483c9c6b0071290af337487bdec6ae34c94904497c7dce5abb120c497eef94e
-  data.tar.gz: 78a862041af3c393e242185021eb52314f8d47e81c03160c41b46a2437379db7
+  metadata.gz: aa586602013f736682059c6e4615dbd4eb7e57daaa4633e6fb35982261a39e11
+  data.tar.gz: 772345d845efdf6d191c362176deac63036cf064fbd4145c8b375f9bf500faaf
 SHA512:
-  metadata.gz: 8234ded58769039d9366d94d0482be0ea0ba1ed22385ebb8d9f42ec9c1d93e3b3d5b295bc09cc049ba75613886dc7a1e8b7b6d83af953061591bb21d4c4ae80f
-  data.tar.gz: 1f0cac157a4601b405199bbddce07cb6bb41f701cb69570ef8e8ecd92ad610a504c066a834f9aad9da157ede3987bd27356e59dd5ecdd29ce3ac2074d6f7ffbc
+  metadata.gz: 8d21a6c44fc2a1d6d72a3b4cd2bab4804ee4ddfd62d5cf73d3407bf913583b0733b61e9b567da45dca13f9bf2007d58ac6b45fb71299ffa509385aaa1f05b18a
+  data.tar.gz: d7cc40c0551910ba432955e7008762950d8c65df0b06e45d094dca0f8b601c6bacc68e6ef8d223471d9f59c112f7a872fd2a5903a7f78de2d70f0580ccfc9115

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 ## [Unreleased]
 
+## [0.3.0] - 2023-10-27
+
+- Query parameters: Don't attempt to convert arras within deepObject objects. Behaviour is not defined in OpenApi 3.1.
+
+## [0.2.2] - 2023-06-01
+
+- Remove superflous validation of "in" property
+- Remove superfluous check for unsupported $ref inside parameter schema
+
 ## [0.2.1] - 2023-03-31
 
 - Fix links in gemspec

data/Gemfile

@@ -5,8 +5,8 @@ source 'https://rubygems.org'
 # Specify your gem's dependencies in OpenapiParameters.gemspec
 gemspec
 
+gem 'rack-test'
 gem 'rake', '~> 13.0'
-
 gem 'rspec', '~> 3.0'
 gem 'rspec-benchmark'
 gem 'rubocop'

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    openapi_parameters (0.2.1)
+    openapi_parameters (0.3.0)
       rack (>= 2.2)
       zeitwerk (~> 2.6)
 
@@ -14,14 +14,19 @@ GEM
     benchmark-trend (0.4.0)
     diff-lcs (1.5.0)
     json (2.6.3)
-    parallel (1.22.1)
-    parser (3.2.1.1)
+    language_server-protocol (3.17.0.3)
+    parallel (1.23.0)
+    parser (3.2.2.4)
       ast (~> 2.4.1)
-    rack (3.0.7)
+      racc
+    racc (1.7.1)
+    rack (3.0.8)
+    rack-test (2.1.0)
+      rack (>= 1.3)
     rainbow (3.1.1)
     rake (13.0.6)
-    regexp_parser (2.7.0)
-    rexml (3.2.5)
+    regexp_parser (2.8.2)
+    rexml (3.2.6)
     rspec (3.12.0)
       rspec-core (~> 3.12.0)
       rspec-expectations (~> 3.12.0)
@@ -31,35 +36,39 @@ GEM
       benchmark-perf (~> 0.6)
       benchmark-trend (~> 0.4)
       rspec (>= 3.0)
-    rspec-core (3.12.1)
+    rspec-core (3.12.2)
       rspec-support (~> 3.12.0)
-    rspec-expectations (3.12.2)
+    rspec-expectations (3.12.3)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.12.0)
-    rspec-mocks (3.12.5)
+    rspec-mocks (3.12.6)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.12.0)
-    rspec-support (3.12.0)
-    rubocop (1.48.1)
+    rspec-support (3.12.1)
+    rubocop (1.57.2)
       json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
       parallel (~> 1.10)
-      parser (>= 3.2.0.0)
+      parser (>= 3.2.2.4)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
       rexml (>= 3.2.5, < 4.0)
-      rubocop-ast (>= 1.26.0, < 2.0)
+      rubocop-ast (>= 1.28.1, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 2.4.0, < 3.0)
-    rubocop-ast (1.28.0)
+    rubocop-ast (1.30.0)
       parser (>= 3.2.1.0)
-    rubocop-capybara (2.17.1)
+    rubocop-capybara (2.19.0)
       rubocop (~> 1.41)
-    rubocop-rspec (2.19.0)
+    rubocop-factory_bot (2.24.0)
       rubocop (~> 1.33)
+    rubocop-rspec (2.25.0)
+      rubocop (~> 1.40)
       rubocop-capybara (~> 2.17)
+      rubocop-factory_bot (~> 2.22)
     ruby-progressbar (1.13.0)
-    unicode-display_width (2.4.2)
-    zeitwerk (2.6.7)
+    unicode-display_width (2.5.0)
+    zeitwerk (2.6.12)
 
 PLATFORMS
   arm64-darwin-21
@@ -69,6 +78,7 @@ PLATFORMS
 
 DEPENDENCIES
   openapi_parameters!
+  rack-test
   rake (~> 13.0)
   rspec (~> 3.0)
   rspec-benchmark

data/README.md

@@ -1,8 +1,10 @@
-# OpenapiParameters
+# openapi_parameters
 
-OpenapiParameters is an an [OpenAPI](https://www.openapis.org/) aware parameter parser.
+openapi_parameters is an an [OpenAPI](https://www.openapis.org/) aware parameter parser.
 
-OpenapiParameters unpacks HTTP/Rack (query / header / cookie) parameters exactly as described in an [OpenAPI](https://www.openapis.org/) definition. It supports `style`, `explode` and `schema` definitions according to OpenAPI 3.1 (or 3.0). The gem is mainly build to be used inside of other OpenAPI tooling.
+openapi_parameters unpacks HTTP/Rack query / path / header / cookie parameters exactly as described in an [OpenAPI](https://www.openapis.org/) definition. It supports `style`, `explode` and `schema` definitions according to OpenAPI 3.1 (or 3.0). The gem is mainly build to be used inside of other OpenAPI tooling like [openapi_first](https://github.com/ahx/openapi_first).
+
+[Learn about parameters in OpenAPI](https://spec.openapis.org/oas/latest.html#parameter-object).
 
 ## Synopsis
 
@@ -72,11 +74,11 @@ parameter.allow_reserved? # => false
 
 Install the gem and add to the application's Gemfile by executing:
 
-    $ bundle add OpenapiParameters
+    $ bundle add openapi_parameters
 
 If bundler is not being used to manage dependencies, install the gem by executing:
 
-    $ gem install OpenapiParameters
+    $ gem install openapi_parameters
 
 ## Development
 
@@ -86,4 +88,4 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/ahx/OpenapiParameters.
+Bug reports and pull requests are welcome on GitHub at https://github.com/ahx/openapi_parameters.

data/lib/openapi_parameters/converter.rb

@@ -3,97 +3,77 @@
 module OpenapiParameters
   ##
   # Tries to convert a request parameter value (string) to the type specified in the JSON Schema.
-  class Converter
-    ##
-    # @param input [String, Hash, Array] the value to convert
-    # @param schema [Hash] the schema to use for conversion.
-    def self.call(input, schema)
-      new(input, schema).call
-    end
-
-    def initialize(input, schema)
-      @input = input
-      @root_schema = schema
-    end
-
-    def call
-      convert(@input, @root_schema)
-    end
-
-    private
-
-    def convert(value, schema) # rubocop:disable Metrics/*
-      check_supported!(schema)
-      return if value.nil?
-      return value if schema.nil?
+  module Converter
+    class << self
+      ##
+      # @param input [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?
+        return value if schema.nil?
 
-      case type(schema)
-      when 'integer'
-        begin
-          Integer(value, 10)
-        rescue StandardError
-          value
-        end
-      when 'number'
-        begin
-          Float(value)
-        rescue StandardError
-          value
-        end
-      when 'boolean'
-        if value == 'true'
-          true
+        case type(schema)
+        when 'integer'
+          begin
+            Integer(value, 10)
+          rescue StandardError
+            value
+          end
+        when 'number'
+          begin
+            Float(value)
+          rescue StandardError
+            value
+          end
+        when 'boolean'
+          if value == 'true'
+            true
+          else
+            value == 'false' ? false : value
+          end
+        when 'object'
+          convert_object(value, schema)
+        when 'array'
+          convert_array(value, schema)
         else
-          value == 'false' ? false : value
+          value
         end
-      when 'object'
-        convert_object(value, schema)
-      when 'array'
-        convert_array(value, schema)
-      else
-        value
       end
-    end
 
-    REF = '$ref'
-    private_constant :REF
+      private
 
-    def check_supported!(schema)
-      return unless schema&.key?(REF)
-
-      raise NotSupportedError,
-            "$ref is not supported: #{@root_schema.inspect}"
-    end
-
-    def type(schema)
-      schema && schema['type']
-    end
+      def type(schema)
+        schema && schema['type']
+      end
 
-    def convert_object(object, schema)
-      object.each_with_object({}) do |(key, value), hsh|
-        hsh[key] = convert(value, schema['properties']&.fetch(key))
+      def convert_object(object, schema)
+        object.each_with_object({}) do |(key, value), hsh|
+          hsh[key] = convert(value, schema['properties']&.fetch(key))
+        end
       end
-    end
 
-    def convert_array(array, schema)
-      item_schema = schema['items']
-      prefix_schemas = schema['prefixItems']
-      return convert_array_with_prefixes(array, prefix_schemas, item_schema) if prefix_schemas
+      def convert_array(array, schema)
+        return array unless array.is_a?(Array)
 
-      array.map { |item| convert(item, item_schema) }
-    end
+        item_schema = schema['items']
+        prefix_schemas = schema['prefixItems']
+        return convert_array_with_prefixes(array, prefix_schemas, item_schema) if prefix_schemas
 
-    def convert_array_with_prefixes(array, prefix_schemas, item_schema)
-      prefixes =
-        array
-        .slice(0, prefix_schemas.size)
-        .each_with_index
-        .map { |item, index| convert(item, prefix_schemas[index]) }
-      array =
-        array[prefix_schemas.size..].map! do |item|
-          convert(item, item_schema)
-        end
-      prefixes + array
+        array.map { |item| convert(item, item_schema) }
+      end
+
+      def convert_array_with_prefixes(array, prefix_schemas, item_schema)
+        prefixes =
+          array
+          .slice(0, prefix_schemas.size)
+          .each_with_index
+          .map { |item, index| convert(item, prefix_schemas[index]) }
+        array =
+          array[prefix_schemas.size..].map! do |item|
+            convert(item, item_schema)
+          end
+        prefixes + array
+      end
     end
   end
 end

data/lib/openapi_parameters/cookie.rb

@@ -20,8 +20,8 @@ module OpenapiParameters
         next unless cookies.key?(parameter.name)
 
         result[parameter.name] = catch :skip do
-          value = unpack_parameter(parameter, cookies)
-          @convert ? Converter.call(value, parameter.schema) : value
+          value = Unpacker.unpack_value(parameter, cookies[parameter.name])
+          @convert ? Converter.convert(value, parameter.schema) : value
         end
       end
     end
@@ -29,33 +29,5 @@ module OpenapiParameters
     private
 
     attr_reader :parameters
-
-    def unpack_parameter(parameter, cookies)
-      value = cookies[parameter.name]
-      return if value.nil?
-      return unpack_object(parameter, value) if parameter.object?
-      return unpack_array(value) if parameter.array?
-
-      value
-    end
-
-    def unpack_array(value)
-      value.split(ARRAY_DELIMER)
-    end
-
-    ARRAY_DELIMER = ','
-    OBJECT_EXPLODE_SPLITTER = Regexp.union(',', '=').freeze
-
-    def unpack_object(parameter, value)
-      entries =
-        if parameter.explode?
-          value.split(OBJECT_EXPLODE_SPLITTER)
-        else
-          value.split(ARRAY_DELIMER)
-        end
-      throw :skip, value if entries.length.odd?
-
-      Hash[*entries]
-    end
   end
 end

data/lib/openapi_parameters/header.rb

@@ -17,8 +17,8 @@ module OpenapiParameters
         next unless headers.key?(parameter.name)
 
         result[parameter.name] = catch :skip do
-          value = unpack_parameter(parameter, headers)
-          @convert ? Converter.call(value, parameter.schema) : value
+          value = Unpacker.unpack_value(parameter, headers[parameter.name])
+          @convert ? Converter.convert(value, parameter.schema) : value
         end
       end
     end
@@ -28,33 +28,5 @@ module OpenapiParameters
     end
 
     attr_reader :parameters
-
-    private
-
-    def unpack_parameter(parameter, headers)
-      value = headers[parameter.name]
-      return value if parameter.primitive?
-      return unpack_object(parameter, value) if parameter.object?
-      return unpack_array(value) if parameter.array?
-    end
-
-    def unpack_array(value)
-      value.split(ARRAY_DELIMER)
-    end
-
-    ARRAY_DELIMER = ','
-    OBJECT_EXPLODE_SPLITTER = Regexp.union(',', '=').freeze
-
-    def unpack_object(parameter, value)
-      entries =
-        if parameter.explode?
-          value.split(OBJECT_EXPLODE_SPLITTER)
-        else
-          value.split(ARRAY_DELIMER)
-        end
-      throw :skip, value if entries.length.odd?
-
-      Hash[*entries]
-    end
   end
 end

data/lib/openapi_parameters/parameter.rb

@@ -4,6 +4,7 @@ module OpenapiParameters
   ##
   # Represents a parameter in an OpenAPI operation.
   class Parameter
+    # @param definition [Hash] The parameter definition. A string keyed Hash.
     def initialize(definition)
       check_supported!(definition)
       @definition = definition
@@ -86,22 +87,14 @@ module OpenapiParameters
     }.freeze
     private_constant :DEFAULT_STYLE
 
-    VALID_LOCATIONS = Set.new(%w[query header path cookie]).freeze
-    private_constant :VALID_LOCATIONS
-
     REF = '$ref'
     private_constant :REF
 
     def check_supported!(definition)
-      if definition.values.any? { |v| v.is_a?(Hash) && v.key?(REF) }
-        raise NotSupportedError,
-              "Parameter schema with $ref is not supported: #{definition.inspect}"
-      end
-      return if VALID_LOCATIONS.include?(definition['in'])
-
-      raise ArgumentError,
-            %(Parameter definition must have an 'in' property defined
-               which should be one of #{VALID_LOCATIONS.join(', ')}).freeze
+      return unless definition.values.any? { |v| v.is_a?(Hash) && v.key?(REF) }
+
+      raise NotSupportedError,
+            "Parameter schema with $ref is not supported: #{definition.inspect}"
     end
   end
 end

data/lib/openapi_parameters/path.rb

@@ -3,72 +3,28 @@
 require 'rack'
 
 module OpenapiParameters
-  # Parses OpenAPI path parameters from path template strings and the request path.
+  # Parses OpenAPI path parameters from a route params Hash that is usually provided by your Rack webframework
   class Path
     # @param parameters [Array<Hash>] The OpenAPI path parameters.
-    # @param path [String] The OpenAPI path template string.
     # @param convert [Boolean] Whether to convert the values to the correct type.
     def initialize(parameters, convert: true)
       @parameters = parameters
       @convert = convert
     end
 
-    attr_reader :parameters, :path
+    attr_reader :parameters
 
+    # @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)
         next unless path_params.key?(parameter.name)
 
         result[parameter.name] = catch :skip do
-          value = unpack_parameter(parameter, path_params)
-          @convert ? Converter.call(value, parameter.schema) : value
+          value = Unpacker.unpack_value(parameter, path_params[parameter.name])
+          @convert ? Converter.convert(value, parameter.schema) : value
         end
       end
     end
-
-    private
-
-    def unpack_parameter(parameter, parsed_path)
-      value = parsed_path[parameter.name]
-      return value if parameter.primitive? || value.nil?
-      return unpack_array(parameter, value) if parameter.array?
-      return unpack_object(parameter, value) if parameter.object?
-    end
-
-    def unpack_array(parameter, value)
-      return value if value.empty?
-      return unpack_matrix(parameter, value) if parameter.style == 'matrix'
-
-      value = value[1..] if PREFIXED.key?(parameter.style)
-      value.split(ARRAY_DELIMITER[parameter.style])
-    end
-
-    def unpack_matrix(parameter, value)
-      result = Rack::Utils.parse_query(value, ';')[parameter.name]
-      return result if parameter.explode?
-
-      result.split(',')
-    end
-
-    def unpack_object(parameter, value)
-      return Rack::Utils.parse_query(value, ',') if parameter.explode?
-
-      array = unpack_array(parameter, value)
-      throw :skip, value if array.length.odd?
-
-      Hash[*array]
-    end
-
-    PREFIXED = {
-      'label' => '.',
-      'matrix' => ';'
-    }.freeze
-
-    ARRAY_DELIMITER = {
-      'label' => '.',
-      'simple' => ','
-    }.freeze
-    private_constant :ARRAY_DELIMITER
   end
 end

data/lib/openapi_parameters/query.rb

@@ -24,8 +24,8 @@ module OpenapiParameters
         else
           next unless parsed_query.key?(parameter.name)
 
-          unpacked = unpack_parameter(parameter, parsed_query)
-          result[parameter.name] = convert(unpacked, parameter)
+          value = Unpacker.unpack_value(parameter, parsed_query[parameter.name])
+          result[parameter.name] = convert(value, parameter)
         end
       end
     end
@@ -34,49 +34,18 @@ module OpenapiParameters
 
     private
 
-    def convert(value, parameter)
+    def convert_primitive(value, parameter)
       return value unless @convert
       return value if value == ''
 
-      Converter.call(value, parameter.schema)
-    end
-
-    QUERY_PARAMETER_DELIMETER = '&'
-    ARRAY_DELIMER = ','
-
-    def unpack_parameter(parameter, parsed_query)
-      value = parsed_query[parameter.name]
-      return value if parameter.primitive? || value.nil?
-      return unpack_array(parameter, parsed_query) if parameter.array?
-      return unpack_object(parameter, parsed_query) if parameter.object?
-    end
-
-    def unpack_array(parameter, parsed_query)
-      value = parsed_query[parameter.name]
-      return value if value.empty?
-      return Array(value) if parameter.explode?
-
-      value.split(array_delimiter(parameter.style))
+      Converter.convert_primitive(value, parameter.schema)
     end
 
-    def unpack_object(parameter, parsed_query)
-      return parsed_query[parameter.name] if parameter.explode?
-
-      array = parsed_query[parameter.name]&.split(ARRAY_DELIMER)
-      return array if array.length.odd?
-
-      Hash[*array]
-    end
-
-    DELIMERS = {
-      'pipeDelimited' => '|',
-      'spaceDelimited' => ' ',
-      'form' => ',',
-      'simple' => ','
-    }.freeze
+    def convert(value, parameter)
+      return value unless @convert
+      return value if value == ''
 
-    def array_delimiter(style)
-      DELIMERS.fetch(style, ARRAY_DELIMER)
+      Converter.convert(value, parameter.schema)
     end
   end
 end

data/lib/openapi_parameters/unpacker.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+module OpenapiParameters
+  ## Unpacks a paramexter value from a string as defined in the OpenAPI specification.
+  # @visibility private
+  module Unpacker
+    class << self
+      def unpack_value(parameter, value)
+        return value if value.nil?
+        return unpack_array(parameter, value) if parameter.array?
+        return unpack_object(parameter, value) if parameter.object?
+
+        value
+      end
+
+      def unpack_array(parameter, value)
+        return value if value.is_a?(Array)
+        return value if value.empty?
+        return unpack_matrix(parameter, value) if parameter.style == 'matrix'
+
+        value = value[1..] if PREFIXED.key?(parameter.style)
+        value.split(ARRAY_DELIMITER[parameter.style])
+      end
+
+      def unpack_matrix(parameter, value)
+        result = Rack::Utils.parse_query(value, ';')[parameter.name]
+        return result if parameter.explode?
+
+        result.split(',')
+      end
+
+      OBJECT_EXPLODE_SPLITTER = Regexp.union(',', '=').freeze
+      private_constant :OBJECT_EXPLODE_SPLITTER
+
+      def unpack_object(parameter, value)
+        return unpack_object_path(parameter, value) if parameter.location == 'path'
+
+        entries =
+          if parameter.explode?
+            value.split(OBJECT_EXPLODE_SPLITTER)
+          else
+            value.split(ARRAY_DELIMITER[parameter.style])
+          end
+        throw :skip, value if entries.length.odd?
+
+        Hash[*entries]
+      end
+
+      def unpack_object_path(parameter, value)
+        return Rack::Utils.parse_query(value, ',') if parameter.explode?
+
+        array = unpack_array(parameter, value)
+        throw :skip, value if array.length.odd?
+
+        Hash[*array]
+      end
+
+      PREFIXED = {
+        'label' => '.',
+        'matrix' => ';'
+      }.freeze
+
+      ARRAY_DELIMITER = {
+        'label' => '.',
+        'simple' => ',',
+        'form' => ',',
+        'pipeDelimited' => '|',
+        'spaceDelimited' => ' '
+      }.freeze
+      private_constant :ARRAY_DELIMITER
+    end
+  end
+end

data/lib/openapi_parameters/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: openapi_parameters
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Andreas Haller
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-03-31 00:00:00.000000000 Z
+date: 2023-10-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -64,6 +64,7 @@ files:
 - lib/openapi_parameters/parameter.rb
 - lib/openapi_parameters/path.rb
 - lib/openapi_parameters/query.rb
+- lib/openapi_parameters/unpacker.rb
 - lib/openapi_parameters/version.rb
 - openapi_parameters.gemspec
 - sig/openapi_parameters.rbs