openapi_parameters 0.2.2 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d08c51fd9da86ddf6ef26a0e0778031b33224475091f21bf212cbdda65dd0b80
-  data.tar.gz: b8c2d56ad760c556cb51996e694d7bb8dbfe3d6188f4407702f698e8ca49b720
+  metadata.gz: 25ce53f3254aebc92f56f59faf54a0b82a26a9908956c5f9ef1e6696f42d5ef9
+  data.tar.gz: 134af6813487d225ded3b84040f7039276f64906d2d4be635ac2681689035553
 SHA512:
-  metadata.gz: fdb3cf5fd14b1decad231f881229d9344020a59722c07086e5a79c0ee6f58bbad335f982a8847d60e64fb9e62c066636a142f514239ca78a7ec5de0916663abd
-  data.tar.gz: affa943a27552eb4a9a1495272d80d5d8cb2f591145b79758056c2d2eb93949d61e63524733a0474a3596d1a7d0bc4c77c5187e0a7d4bd9cd02e41cbd88e6706
+  metadata.gz: b5229198046f5e0455ed437110c170024131b5046aaaea598471080804a3e56774997640f323b463567e197308668874633c8186cbf518871a013cfbe4bd1593
+  data.tar.gz: 517df02187fe286fb67d21f9bd807fdc07bcdea04e62df0fce16a32bb994215d6706b47c97f6ec32e59c439edccee23e13a993b3b59c390b623f4f53f28850a6

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 ## [Unreleased]
 
+## [0.3.1] - 2023-11-09
+- Make it work with Zeitwerk's `eager_load`
+
+## [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

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.2)
+    openapi_parameters (0.3.1)
       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)
+    language_server-protocol (3.17.0.3)
     parallel (1.23.0)
-    parser (3.2.2.1)
+    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.8.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)
@@ -36,33 +41,34 @@ GEM
     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.51.0)
+    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.28.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.1)
+    rubocop-ast (1.30.0)
       parser (>= 3.2.1.0)
-    rubocop-capybara (2.18.0)
+    rubocop-capybara (2.19.0)
       rubocop (~> 1.41)
-    rubocop-factory_bot (2.23.1)
-      rubocop (~> 1.33)
-    rubocop-rspec (2.22.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.8)
+    unicode-display_width (2.5.0)
+    zeitwerk (2.6.12)
 
 PLATFORMS
   arm64-darwin-21
@@ -72,6 +78,7 @@ PLATFORMS
 
 DEPENDENCIES
   openapi_parameters!
+  rack-test
   rake (~> 13.0)
   rspec (~> 3.0)
   rspec-benchmark

data/lib/openapi_parameters/converter.rb

@@ -3,87 +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
+  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?
 
-    def convert(value, schema) # rubocop:disable Metrics/*
-      # check_supported!(schema)
-      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
 
-    def type(schema)
-      schema && schema['type']
-    end
+      private
 
-    def convert_object(object, schema)
-      object.each_with_object({}) do |(key, value), hsh|
-        hsh[key] = convert(value, schema['properties']&.fetch(key))
+      def type(schema)
+        schema && schema['type']
       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_object(object, schema)
+        object.each_with_object({}) do |(key, value), hsh|
+          hsh[key] = convert(value, schema['properties']&.fetch(key))
+        end
+      end
 
-      array.map { |item| convert(item, item_schema) }
-    end
+      def convert_array(array, schema)
+        return array unless array.is_a?(Array)
 
-    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
+        item_schema = schema['items']
+        prefix_schemas = schema['prefixItems']
+        return convert_array_with_prefixes(array, prefix_schemas, item_schema) if prefix_schemas
+
+        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

@@ -21,7 +21,7 @@ module OpenapiParameters
 
         result[parameter.name] = catch :skip do
           value = Unpacker.unpack_value(parameter, cookies[parameter.name])
-          @convert ? Converter.call(value, parameter.schema) : value
+          @convert ? Converter.convert(value, parameter.schema) : value
         end
       end
     end

data/lib/openapi_parameters/error.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module OpenapiParameters
+  class Error < StandardError
+  end
+end

data/lib/openapi_parameters/header.rb

@@ -18,7 +18,7 @@ module OpenapiParameters
 
         result[parameter.name] = catch :skip do
           value = Unpacker.unpack_value(parameter, headers[parameter.name])
-          @convert ? Converter.call(value, parameter.schema) : value
+          @convert ? Converter.convert(value, parameter.schema) : value
         end
       end
     end

data/lib/openapi_parameters/{errors.rb → not_supported_error.rb}

@@ -1,9 +1,6 @@
 # frozen_string_literal: true
 
 module OpenapiParameters
-  class Error < StandardError
-  end
-
   class NotSupportedError < Error
   end
 end

data/lib/openapi_parameters/path.rb

@@ -22,7 +22,7 @@ module OpenapiParameters
 
         result[parameter.name] = catch :skip do
           value = Unpacker.unpack_value(parameter, path_params[parameter.name])
-          @convert ? Converter.call(value, parameter.schema) : value
+          @convert ? Converter.convert(value, parameter.schema) : value
         end
       end
     end

data/lib/openapi_parameters/query.rb

@@ -34,11 +34,18 @@ module OpenapiParameters
 
     private
 
+    def convert_primitive(value, parameter)
+      return value unless @convert
+      return value if value == ''
+
+      Converter.convert_primitive(value, parameter.schema)
+    end
+
     def convert(value, parameter)
       return value unless @convert
       return value if value == ''
 
-      Converter.call(value, parameter.schema)
+      Converter.convert(value, parameter.schema)
     end
   end
 end

data/lib/openapi_parameters/version.rb

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

data/lib/openapi_parameters.rb

@@ -1,11 +1,9 @@
 # frozen_string_literal: true
 
 require 'zeitwerk'
-loader = Zeitwerk::Loader.for_gem
-loader.setup
 
 # OpenapiParameters is a gem that parses OpenAPI parameters from Rack
 module OpenapiParameters
+  LOADER = Zeitwerk::Loader.for_gem
+  LOADER.setup
 end
-
-require_relative 'openapi_parameters/errors'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: openapi_parameters
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.1
 platform: ruby
 authors:
 - Andreas Haller
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-06-01 00:00:00.000000000 Z
+date: 2023-11-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -58,9 +58,10 @@ files:
 - lib/openapi_parameters.rb
 - lib/openapi_parameters/converter.rb
 - lib/openapi_parameters/cookie.rb
-- lib/openapi_parameters/errors.rb
+- lib/openapi_parameters/error.rb
 - lib/openapi_parameters/header.rb
 - lib/openapi_parameters/headers_hash.rb
+- lib/openapi_parameters/not_supported_error.rb
 - lib/openapi_parameters/parameter.rb
 - lib/openapi_parameters/path.rb
 - lib/openapi_parameters/query.rb