openapi_parameters 0.1.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 97605d112ff65a874f5fa63dc7ecd13d3ca37468e559dbf7980a1f6c55e37274
-  data.tar.gz: 280fe6bc55862118dc65e77a6e29c6a3f27ee3c3d07f1361003c9cbd52fdc660
+  metadata.gz: 8483c9c6b0071290af337487bdec6ae34c94904497c7dce5abb120c497eef94e
+  data.tar.gz: 78a862041af3c393e242185021eb52314f8d47e81c03160c41b46a2437379db7
 SHA512:
-  metadata.gz: e1cff00125ffb1ea81548a6e8f5bee73b1cedc29ccb2569296e0f869a9ac3412cc9c683afcba2f48bcc6cca06287a1fba251068b4c831e2d4933497268a58da8
-  data.tar.gz: 6177d8425f16f678af64f4059ecc1fecf70e954ce0edd95ce2e38a7b5bbd1efe801951fffb9ca8932d7d4d258100af0070623c5c04672d1e539caee1cbc8204e
+  metadata.gz: 8234ded58769039d9366d94d0482be0ea0ba1ed22385ebb8d9f42ec9c1d93e3b3d5b295bc09cc049ba75613886dc7a1e8b7b6d83af953061591bb21d4c4ae80f
+  data.tar.gz: 1f0cac157a4601b405199bbddce07cb6bb41f701cb69570ef8e8ecd92ad610a504c066a834f9aad9da157ede3987bd27356e59dd5ecdd29ce3ac2074d6f7ffbc

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 ## [Unreleased]
 
-## [0.1.0] - 2032-03-25
+## [0.2.1] - 2023-03-31
+
+- Fix links in gemspec
+
+## [0.2.0] - 2023-03-30
+
+- Breaking: Path parameters are unpacked from a hash, which is usually available from the used Rack web framework. This is much simpler and more performant.
+
+## [0.1.0] - 2023-03-25
 
 - Initial release

data/Gemfile

@@ -8,5 +8,6 @@ gemspec
 gem 'rake', '~> 13.0'
 
 gem 'rspec', '~> 3.0'
+gem 'rspec-benchmark'
 gem 'rubocop'
 gem 'rubocop-rspec'

data/Gemfile.lock

@@ -1,55 +1,64 @@
 PATH
   remote: .
   specs:
-    openapi_parameters (0.1.0)
+    openapi_parameters (0.2.1)
       rack (>= 2.2)
-      uri_template (>= 0.7, < 2.0)
       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.2)
+    json (2.6.3)
     parallel (1.22.1)
-    parser (3.1.2.1)
+    parser (3.2.1.1)
       ast (~> 2.4.1)
-    rack (3.0.0)
+    rack (3.0.7)
     rainbow (3.1.1)
     rake (13.0.6)
-    regexp_parser (2.6.1)
+    regexp_parser (2.7.0)
     rexml (3.2.5)
     rspec (3.12.0)
       rspec-core (~> 3.12.0)
       rspec-expectations (~> 3.12.0)
       rspec-mocks (~> 3.12.0)
-    rspec-core (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.1)
       rspec-support (~> 3.12.0)
-    rspec-expectations (3.12.0)
+    rspec-expectations (3.12.2)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.12.0)
-    rspec-mocks (3.12.0)
+    rspec-mocks (3.12.5)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.12.0)
     rspec-support (3.12.0)
-    rubocop (1.39.0)
+    rubocop (1.48.1)
       json (~> 2.3)
       parallel (~> 1.10)
-      parser (>= 3.1.2.1)
+      parser (>= 3.2.0.0)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
       rexml (>= 3.2.5, < 4.0)
-      rubocop-ast (>= 1.23.0, < 2.0)
+      rubocop-ast (>= 1.26.0, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.23.0)
-      parser (>= 3.1.1.0)
-    rubocop-rspec (2.11.1)
-      rubocop (~> 1.19)
-    ruby-progressbar (1.11.0)
-    unicode-display_width (2.3.0)
-    uri_template (0.7.0)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.28.0)
+      parser (>= 3.2.1.0)
+    rubocop-capybara (2.17.1)
+      rubocop (~> 1.41)
+    rubocop-rspec (2.19.0)
+      rubocop (~> 1.33)
+      rubocop-capybara (~> 2.17)
+    ruby-progressbar (1.13.0)
+    unicode-display_width (2.4.2)
     zeitwerk (2.6.7)
 
 PLATFORMS
@@ -62,6 +71,7 @@ DEPENDENCIES
   openapi_parameters!
   rake (~> 13.0)
   rspec (~> 3.0)
+  rspec-benchmark
   rubocop
   rubocop-rspec
 

data/README.md

@@ -2,7 +2,7 @@
 
 OpenapiParameters 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).
+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.
 
 ## Synopsis
 
@@ -28,9 +28,9 @@ 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, '/pets/ids')
-path_info = env['PATH_INFO'] # => '/pets/1,2,3'
-path_parameters.unpack(path_info) # => { 'ids' => [1, 2, 3] }
+path_parameters = OpenapiParameters::Path.new(parameters)
+route_params = env['route.params'] # This depends on the webframework you are using
+path_parameters.unpack(route_params) # => { 'ids' => [1, 2, 3] }
 
 header_parameters = OpenapiParameters::Header.new(parameters)
 header_parameters.unpack_env(env)

data/lib/openapi_parameters/converter.rb

@@ -22,9 +22,7 @@ module OpenapiParameters
 
     private
 
-    require 'json'
-
-    def convert(value, schema)
+    def convert(value, schema) # rubocop:disable Metrics/*
       check_supported!(schema)
       return if value.nil?
       return value if schema.nil?
@@ -57,7 +55,7 @@ module OpenapiParameters
       end
     end
 
-    REF = '$ref'.freeze
+    REF = '$ref'
     private_constant :REF
 
     def check_supported!(schema)

data/lib/openapi_parameters/parameter.rb

@@ -86,11 +86,10 @@ module OpenapiParameters
     }.freeze
     private_constant :DEFAULT_STYLE
 
-
     VALID_LOCATIONS = Set.new(%w[query header path cookie]).freeze
     private_constant :VALID_LOCATIONS
 
-    REF = '$ref'.freeze
+    REF = '$ref'
     private_constant :REF
 
     def check_supported!(definition)

data/lib/openapi_parameters/path.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'uri_template'
+require 'rack'
 
 module OpenapiParameters
   # Parses OpenAPI path parameters from path template strings and the request path.
@@ -8,65 +8,67 @@ module OpenapiParameters
     # @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, path, convert: true)
+    def initialize(parameters, convert: true)
       @parameters = parameters
-      @path = path
       @convert = convert
     end
 
     attr_reader :parameters, :path
 
-    def unpack(path_info)
-      parsed_path = URITemplate.new(url_template).extract(path_info) || {}
-      parameters.each_with_object(parsed_path) do |param, result|
+    def unpack(path_params)
+      parameters.each_with_object({}) do |param, result|
         parameter = Parameter.new(param)
-        next unless parsed_path.key?(parameter.name)
+        next unless path_params.key?(parameter.name)
 
         result[parameter.name] = catch :skip do
-          value = unpack_parameter(parameter, result)
+          value = unpack_parameter(parameter, path_params)
           @convert ? Converter.call(value, parameter.schema) : value
         end
       end
     end
 
+    private
+
     def unpack_parameter(parameter, parsed_path)
       value = parsed_path[parameter.name]
-      if parameter.object? && value.is_a?(Array)
-        throw :skip, value if value.length.odd?
-        return Hash[*value]
-      end
-      value
+      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 url_template
-      @url_template ||=
-        begin
-          path = @path.dup
-          parameters.each do |p|
-            param = Parameter.new(p)
-            next unless param.array? || param.object?
-
-            path.gsub!(
-              "{#{param.name}}",
-              "{#{operator(param)}#{param.name}#{modifier(param)}}"
-            )
-          end
-          path
-        end
-    end
+    def unpack_array(parameter, value)
+      return value if value.empty?
+      return unpack_matrix(parameter, value) if parameter.style == 'matrix'
 
-    private
+      value = value[1..] if PREFIXED.key?(parameter.style)
+      value.split(ARRAY_DELIMITER[parameter.style])
+    end
 
-    LIST_OPS = { 'simple' => nil, 'label' => '.', 'matrix' => ';' }.freeze
-    private_constant :LIST_OPS
+    def unpack_matrix(parameter, value)
+      result = Rack::Utils.parse_query(value, ';')[parameter.name]
+      return result if parameter.explode?
 
-    def operator(param)
-      LIST_OPS[param.style]
+      result.split(',')
     end
 
-    def modifier(param)
-      return '*' if param.explode?
-      return if param.style == 'matrix' && !param.explode?
+    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/version.rb

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

data/openapi_parameters.gemspec

@@ -8,15 +8,15 @@ Gem::Specification.new do |spec|
   spec.authors = ['Andreas Haller']
   spec.email = ['andreas.haller@posteo.de']
 
-  spec.summary = 'OpenapiParameters is an OpenAPI aware parameter parser'
+  spec.summary = 'openapi_parameters is an OpenAPI aware parameter parser'
   spec.description =
-    'OpenapiParameters parses HTTP query parameters exactly as described in an OpenAPI API description.'
-  spec.homepage = 'https://github.com/ahx/OpenapiParameters'
+    '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/OpenapiParameters'
+  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'
@@ -38,7 +38,6 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   spec.add_dependency 'rack', '>= 2.2'
-  spec.add_dependency 'uri_template', '>= 0.7', '< 2.0'
   spec.add_dependency 'zeitwerk', '~> 2.6'
 
   # For more information and examples about making a new gem, check out our

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: openapi_parameters
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Andreas Haller
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-03-25 00:00:00.000000000 Z
+date: 2023-03-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -24,26 +24,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '2.2'
-- !ruby/object:Gem::Dependency
-  name: uri_template
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0.7'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '2.0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0.7'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: zeitwerk
   requirement: !ruby/object:Gem::Requirement
@@ -58,8 +38,8 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.6'
-description: OpenapiParameters parses HTTP query parameters exactly as described in
-  an OpenAPI API description.
+description: This parses HTTP query/path/header/cookie parameters exactly as described
+  in an OpenAPI API description.
 email:
 - andreas.haller@posteo.de
 executables: []
@@ -87,12 +67,12 @@ files:
 - lib/openapi_parameters/version.rb
 - openapi_parameters.gemspec
 - sig/openapi_parameters.rbs
-homepage: https://github.com/ahx/OpenapiParameters
+homepage: https://github.com/ahx/openapi_parameters
 licenses:
 - MIT
 metadata:
-  homepage_uri: https://github.com/ahx/OpenapiParameters
-  source_code_uri: https://github.com/ahx/OpenapiParameters
+  homepage_uri: https://github.com/ahx/openapi_parameters
+  source_code_uri: https://github.com/ahx/openapi_parameters
   changelog_uri: https://github.com/ahx/openapi_parameters/blob/main/CHANGELOG.md
   rubygems_mfa_required: 'true'
 post_install_message:
@@ -113,5 +93,5 @@ requirements: []
 rubygems_version: 3.4.6
 signing_key:
 specification_version: 4
-summary: OpenapiParameters is an OpenAPI aware parameter parser
+summary: openapi_parameters is an OpenAPI aware parameter parser
 test_files: []