openapi_parameters 0.3.2 → 0.3.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ce377792c0096d9aba455f83d129162c636f6cab951e43221de7dfbfb9e67227
-  data.tar.gz: e8f320696d3af924bd25496c6f98e19222af638365bfd39d5199b0da27104002
+  metadata.gz: fa336f02dcfc58d656659606710c5fed70335b7a5e101f42228a24913e12325b
+  data.tar.gz: e81f400174546397953abe62d23c26f07fbf14f594ca2297ad129118847a4709
 SHA512:
-  metadata.gz: 67bf514be29731af8936dbab3ec1dfcb61b1091332487f4602c56bab7a708dd9637925b8e58c819d9d39d75e4bf861800dfaf407608837f846f2ed3b09f6cf2d
-  data.tar.gz: cf4f96c5a4e0f4c0b025eaa116dd3e38d040f6e1ef2be0cde8b3a2b1f871d5b027454ed1d57ca69ccb3310ae84162488c4111797985cf9ec3a0b321c2f30d717
+  metadata.gz: b30a7b111b652c9dbc12e0c19ef5f9dc74a5ba9b6eebc0a7392ba0d5070d7c19578017a64e8948e8dd235b57e8784202e37765c62be015c5520940278def939f
+  data.tar.gz: 1e91216f5bff01be794c5eec6a469cea42162472568c2d881afa3267aa036257d0afab0e97534edd57f074217122c96abac08e3e6d4a14c139348bb0ae81fd8e

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 ## [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
+
 ## [0.3.2] - 2023-11-14
 
 - Assume that schemas with `properties` or `style: deepObject` describe Objects and therefore convert it's values.

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

@@ -1,12 +1,11 @@
 # frozen_string_literal: true
 
 module OpenapiParameters
-  ##
   # Tries to convert a request parameter value (string) to the type specified in the JSON Schema.
   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?
@@ -44,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

@@ -1,14 +1,12 @@
 # frozen_string_literal: true
 
-require 'rack'
-
 module OpenapiParameters
   # Cookie parses OpenAPI cookie parameters from a cookie string.
   class Cookie
     # @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
 
@@ -16,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/parameter.rb

@@ -6,17 +6,18 @@ module OpenapiParameters
   class Parameter
     # @param definition [Hash] The parameter definition. A string keyed Hash.
     def initialize(definition)
-      check_supported!(definition)
       @definition = definition
+      @name = definition['name']
+      @is_deep_object = style == 'deepObject'
+      check_supported!
     end
 
-    attr_reader :definition
+    attr_reader :definition, :name
 
-    def name
-      definition['name']
+    def deep_object?
+      @is_deep_object
     end
 
-    ##
     # @return [String] The location of the parameter in the request, "path", "query", "header" or "cookie".
     def location
       definition['in']
@@ -90,8 +91,8 @@ module OpenapiParameters
     REF = '$ref'
     private_constant :REF
 
-    def check_supported!(definition)
-      return unless definition.values.any? { |v| v.is_a?(Hash) && v.key?(REF) }
+    def check_supported!
+      return unless schema&.key?(REF)
 
       raise NotSupportedError,
             "Parameter schema with $ref is not supported: #{definition.inspect}"

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,15 +8,14 @@ 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.style == 'deepObject'
+        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/unpacker.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module OpenapiParameters
-  ## Unpacks a paramexter value from a string as defined in the OpenAPI specification.
+  # Unpacks a parameter value from a string as defined in the OpenAPI specification.
   # @visibility private
   module Unpacker
     class << self

data/lib/openapi_parameters/version.rb

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

data/lib/openapi_parameters.rb

@@ -1,9 +1,17 @@
 # frozen_string_literal: true
 
-require 'zeitwerk'
+require 'rack'
+require_relative 'openapi_parameters/converter'
+require_relative 'openapi_parameters/cookie'
+require_relative 'openapi_parameters/error'
+require_relative 'openapi_parameters/header'
+require_relative 'openapi_parameters/headers_hash'
+require_relative 'openapi_parameters/not_supported_error'
+require_relative 'openapi_parameters/parameter'
+require_relative 'openapi_parameters/path'
+require_relative 'openapi_parameters/query'
+require_relative 'openapi_parameters/unpacker'
 
 # OpenapiParameters is a gem that parses OpenAPI parameters from Rack
 module OpenapiParameters
-  LOADER = Zeitwerk::Loader.for_gem
-  LOADER.setup
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: openapi_parameters
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.3.4
 platform: ruby
 authors:
 - Andreas Haller
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-11-14 00:00:00.000000000 Z
+date: 2024-06-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -24,20 +24,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '2.2'
-- !ruby/object:Gem::Dependency
-  name: zeitwerk
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.6'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.6'
 description: This parses HTTP query/path/header/cookie parameters exactly as described
   in an OpenAPI API description.
 email:
@@ -46,15 +32,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".rspec"
-- ".rubocop.yml"
-- ".tool-versions"
 - CHANGELOG.md
-- Gemfile
-- Gemfile.lock
-- LICENSE
 - README.md
-- Rakefile
 - lib/openapi_parameters.rb
 - lib/openapi_parameters/converter.rb
 - lib/openapi_parameters/cookie.rb
@@ -67,8 +46,6 @@ files:
 - lib/openapi_parameters/query.rb
 - lib/openapi_parameters/unpacker.rb
 - lib/openapi_parameters/version.rb
-- openapi_parameters.gemspec
-- sig/openapi_parameters.rbs
 homepage: https://github.com/ahx/openapi_parameters
 licenses:
 - MIT

data/.rspec

@@ -1,3 +0,0 @@
---format documentation
---color
---require spec_helper

data/.rubocop.yml

@@ -1,19 +0,0 @@
-require:
-  - rubocop-rspec
-
-Naming/MethodParameterName:
-  Enabled: false
-
-AllCops:
-  NewCops: enable
-  SuggestExtensions: false
-  TargetRubyVersion: 3.1
-
-RSpec/ExampleLength:
-  Enabled: false
-
-RSpec/NestedGroups:
-  Max: 4
-
-Metrics/MethodLength:
-  Max: 20

data/.tool-versions

@@ -1 +0,0 @@
-ruby 3.2.1

data/Gemfile

@@ -1,13 +0,0 @@
-# frozen_string_literal: true
-
-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'
-gem 'rubocop-rspec'

data/Gemfile.lock

@@ -1,89 +0,0 @@
-PATH
-  remote: .
-  specs:
-    openapi_parameters (0.3.2)
-      rack (>= 2.2)
-      zeitwerk (~> 2.6)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    ast (2.4.2)
-    benchmark-malloc (0.2.0)
-    benchmark-perf (0.6.0)
-    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.4)
-      ast (~> 2.4.1)
-      racc
-    racc (1.7.3)
-    rack (3.0.8)
-    rack-test (2.1.0)
-      rack (>= 1.3)
-    rainbow (3.1.1)
-    rake (13.1.0)
-    regexp_parser (2.8.2)
-    rexml (3.2.6)
-    rspec (3.12.0)
-      rspec-core (~> 3.12.0)
-      rspec-expectations (~> 3.12.0)
-      rspec-mocks (~> 3.12.0)
-    rspec-benchmark (0.6.0)
-      benchmark-malloc (~> 0.2)
-      benchmark-perf (~> 0.6)
-      benchmark-trend (~> 0.4)
-      rspec (>= 3.0)
-    rspec-core (3.12.2)
-      rspec-support (~> 3.12.0)
-    rspec-expectations (3.12.3)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.12.0)
-    rspec-mocks (3.12.6)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.12.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.2.4)
-      rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 1.8, < 3.0)
-      rexml (>= 3.2.5, < 4.0)
-      rubocop-ast (>= 1.28.1, < 2.0)
-      ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 2.4.0, < 3.0)
-    rubocop-ast (1.30.0)
-      parser (>= 3.2.1.0)
-    rubocop-capybara (2.19.0)
-      rubocop (~> 1.41)
-    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.5.0)
-    zeitwerk (2.6.12)
-
-PLATFORMS
-  arm64-darwin-21
-  arm64-darwin-22
-  x86_64-darwin-20
-  x86_64-linux
-
-DEPENDENCIES
-  openapi_parameters!
-  rack-test
-  rake (~> 13.0)
-  rspec (~> 3.0)
-  rspec-benchmark
-  rubocop
-  rubocop-rspec
-
-BUNDLED WITH
-   2.3.10

data/LICENSE

@@ -1,21 +0,0 @@
-MIT License
-
-Copyright (c) 2023 Andreas Haller
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.

data/Rakefile

@@ -1,10 +0,0 @@
-# frozen_string_literal: true
-
-require 'bundler/gem_tasks'
-require 'rspec/core/rake_task'
-require 'rubocop/rake_task'
-
-RSpec::Core::RakeTask.new(:spec)
-RuboCop::RakeTask.new
-
-task default: %i[spec rubocop]

data/openapi_parameters.gemspec

@@ -1,46 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'lib/openapi_parameters/version'
-
-Gem::Specification.new do |spec|
-  spec.name = 'openapi_parameters'
-  spec.version = OpenapiParameters::VERSION
-  spec.authors = ['Andreas Haller']
-  spec.email = ['andreas.haller@posteo.de']
-
-  spec.summary = 'openapi_parameters is an OpenAPI aware parameter parser'
-  spec.description =
-    'This parses HTTP query/path/header/cookie parameters exactly as described in an OpenAPI API description.'
-  spec.homepage = 'https://github.com/ahx/openapi_parameters'
-  spec.required_ruby_version = '>= 3.1.0'
-  spec.licenses = ['MIT']
-
-  spec.metadata['homepage_uri'] = spec.homepage
-  spec.metadata['source_code_uri'] = 'https://github.com/ahx/openapi_parameters'
-  spec.metadata[
-    'changelog_uri'
-  ] = 'https://github.com/ahx/openapi_parameters/blob/main/CHANGELOG.md'
-
-  # Specify which files should be added to the gem when it is released.
-  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-  spec.files =
-    Dir.chdir(__dir__) do
-      `git ls-files -z`.split("\x0")
-                       .reject do |f|
-        (f == __FILE__) ||
-          f.match(
-            %r{\A(?:(?:bin|test|spec|features)/|\.(?:git|travis|circleci)|appveyor)}
-          )
-      end
-    end
-  spec.bindir = 'exe'
-  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
-  spec.require_paths = ['lib']
-
-  spec.add_dependency 'rack', '>= 2.2'
-  spec.add_dependency 'zeitwerk', '~> 2.6'
-
-  # For more information and examples about making a new gem, check out our
-  # guide at: https://bundler.io/guides/creating_gem.html
-  spec.metadata['rubygems_mfa_required'] = 'true'
-end

data/sig/openapi_parameters.rbs

@@ -1,4 +0,0 @@
-module OpenapiParameters
-  VERSION: String
-  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
-end