openapi_first 2.2.0 → 2.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b6f86609c16829b7f0f94d837167a44e4cf93b38a392ac34b93a9ff9d7a794fc
-  data.tar.gz: 1524298280aa89e6cbae16ce80259ed1d0928b4018747eb6c3385ebed0e8db8b
+  metadata.gz: de3cced92ef56a41399e4baa7aaf2b42250d2d3e532a22b245edd70d2b7446d2
+  data.tar.gz: b433a7d18c02176dda8ce12ff41636d4f19bd99632cbc0085879e34b3090cb76
 SHA512:
-  metadata.gz: a0d30f3482838dd995f44b5ede610ada74ff1a5d2c2e29a1b3fa109da98cbc5cd42bf8616b4f7e6c79b558d1c16b77ca1eb85b4fc82bcbd9e40c6dcf75aea927
-  data.tar.gz: 7f87349cd6fa98cef19f929db3deeb1c94a9b2eed759f23f592ba145c315726cfe8ff3f5fb3f50444b566a5d95b94370439015fd995554ecececc7029adff9ec
+  metadata.gz: 58613cfd3648073dee3189cfced111adcdfd4471ee67a07517d3c800c69aded0ab46b50a69d56fda453a2af9078db74ee45c260c601c16cdd2896428d330068b
+  data.tar.gz: ae57aa8b109569165e9bb9ce3e9eb380e387a0eb1afb3cde850f7a2d3979391dc62ebe567cacb51492aefe4d9ef2db2db8963c4ca2b256cbf0c5b3e9491a2de3

data/CHANGELOG.md

@@ -2,6 +2,15 @@
 
 ## Unreleased
 
+## 2.2.2
+
+- Fix parsing parameters with referenced schemas (https://github.com/ahx/openapi_first/issues/316)
+
+## 2.2.1
+
+- Fix issue with $ref resolving paths poiting outside directories `$ref: '../a/b.yaml'` (https://github.com/ahx/openapi_first/issues/313)
+- Remove warning about missing assertions when using assert_api_conform ([https://github.com/ahx/openapi_first/issues/313](https://github.com/ahx/openapi_first/issues/312))
+
 ## 2.2.0
 
 - Fix support for discriminator in response bodies if no mapping is defined (https://github.com/ahx/openapi_first/issues/285)

data/lib/openapi_first/builder.rb

@@ -47,10 +47,11 @@ module OpenapiFirst
     def router # rubocop:disable Metrics/MethodLength
       router = OpenapiFirst::Router.new
       @contents.fetch('paths').each do |path, path_item_object|
+        path_parameters = resolve_parameters(path_item_object['parameters'])
         path_item_object.resolved.keys.intersection(REQUEST_METHODS).map do |request_method|
           operation_object = path_item_object[request_method]
-          parameters = operation_object['parameters']&.resolved.to_a.chain(path_item_object['parameters']&.resolved.to_a)
-          parameters = parse_parameters(parameters)
+          operation_parameters = resolve_parameters(operation_object['parameters'])
+          parameters = parse_parameters(operation_parameters.chain(path_parameters))
 
           build_requests(path:, request_method:, operation_object:,
                          parameters:).each do |request|
@@ -89,6 +90,14 @@ module OpenapiFirst
       )
     end
 
+    def resolve_parameters(parameters)
+      parameters&.map do |parameter|
+        result = parameter.resolved
+        result['schema'] = parameter['schema'].resolved
+        result
+      end.to_a
+    end
+
     def build_parameter_schema(parameters)
       schema = build_parameters_schema(parameters)
 

data/lib/openapi_first/json.rb

@@ -22,5 +22,4 @@ begin
   end
 rescue LoadError
   require 'json'
-  puts 'openapi_first uses the default json gem'
 end

data/lib/openapi_first/ref_resolver.rb

@@ -40,7 +40,7 @@ module OpenapiFirst
       def initialize(value, context: value, dir: nil)
         @value = value
         @context = context
-        @dir = dir
+        @dir = (dir && File.absolute_path(dir)) || Dir.pwd
       end
 
       # The value of this node
@@ -108,15 +108,17 @@ module OpenapiFirst
 
       def schema(options = {})
         ref_resolver = JSONSchemer::CachedResolver.new do |uri|
-          FileLoader.load(File.join(dir, uri.path))
+          FileLoader.load(uri.path)
         end
-        root = JSONSchemer::Schema.new(context, ref_resolver:, **options)
-        JSONSchemer::Schema.new(value, nil, root, **options)
+        base_uri = URI::File.build({ path: "#{dir}/" })
+        root = JSONSchemer::Schema.new(context, base_uri:, ref_resolver:, **options)
+        JSONSchemer::Schema.new(value, nil, root, base_uri:, **options)
       end
     end
 
     # @visibility private
     class Array
+      include Enumerable
       include Resolvable
       include Diggable
 
@@ -127,6 +129,12 @@ module OpenapiFirst
         RefResolver.for(item, dir:, context:)
       end
 
+      def each
+        resolved.each do |item|
+          yield RefResolver.for(item, dir:, context:)
+        end
+      end
+
       def resolved
         value.map do |item|
           if item.respond_to?(:key?) && item.key?('$ref')

data/lib/openapi_first/test/methods.rb

@@ -1,20 +1,19 @@
 # frozen_string_literal: true
 
+require_relative 'minitest_helpers'
+require_relative 'plain_helpers'
+
 module OpenapiFirst
+  # Test integration
   module Test
     # Methods to use in integration tests
     module Methods
-      def assert_api_conform(status: nil, api: :default)
-        api = OpenapiFirst::Test[api]
-        request = respond_to?(:last_request) ? last_request : @request
-        response = respond_to?(:last_response) ? last_response : @response
-        if status && status != response.status
-          raise OpenapiFirst::Error,
-                "Expected status #{status}, but got #{response.status} " \
-                "from #{request.request_method.upcase} #{request.path}."
+      def self.included(base)
+        if Test.minitest?(base)
+          base.include(OpenapiFirst::Test::MinitestHelpers)
+        else
+          base.include(OpenapiFirst::Test::PlainHelpers)
         end
-        api.validate_request(request, raise_error: true)
-        api.validate_response(request, response, raise_error: true)
       end
     end
   end

data/lib/openapi_first/test/minitest_helpers.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module OpenapiFirst
+  module Test
+    # Assertion methods for Minitest
+    module MinitestHelpers
+      # :nocov:
+      def assert_api_conform(status: nil, api: :default)
+        api = OpenapiFirst::Test[api]
+        request = respond_to?(:last_request) ? last_request : @request
+        response = respond_to?(:last_response) ? last_response : @response
+
+        if status
+          assert_equal status, response.status,
+                       "Expected status #{status}, but got #{response.status} " \
+                       "from #{request.request_method.upcase} #{request.path}."
+        end
+
+        validated_request = api.validate_request(request, raise_error: false)
+        validated_response = api.validate_response(request, response, raise_error: false)
+
+        assert validated_request.valid?, validated_request.error&.exception_message
+        assert validated_response.valid?, validated_response.error&.exception_message
+      end
+      # :nocov:
+    end
+  end
+end

data/lib/openapi_first/test/plain_helpers.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module OpenapiFirst
+  module Test
+    # Assertion methods to use when no known test framework was found
+    # These methods just raise an exception if an error was found
+    module PlainHelpers
+      def assert_api_conform(status: nil, api: :default)
+        api = OpenapiFirst::Test[api]
+        # :nocov:
+        request = respond_to?(:last_request) ? last_request : @request
+        response = respond_to?(:last_response) ? last_response : @response
+        # :nocov:
+
+        if status && status != response.status
+          raise OpenapiFirst::Error,
+                "Expected status #{status}, but got #{response.status} " \
+                "from #{request.request_method.upcase} #{request.path}."
+        end
+
+        api.validate_request(request, raise_error: true)
+        api.validate_response(request, response, raise_error: true)
+      end
+    end
+  end
+end

data/lib/openapi_first/test.rb

@@ -5,6 +5,12 @@ require_relative 'test/methods'
 module OpenapiFirst
   # Test integration
   module Test
+    def self.minitest?(base)
+      base.include?(::Minitest::Assertions)
+    rescue NameError
+      false
+    end
+
     class NotRegisteredError < StandardError; end
 
     DEFINITIONS = {} # rubocop:disable Style/MutableConstant

data/lib/openapi_first/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module OpenapiFirst
-  VERSION = '2.2.0'
+  VERSION = '2.2.2'
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: openapi_first
 version: !ruby/object:Gem::Version
-  version: 2.2.0
+  version: 2.2.2
 platform: ruby
 authors:
 - Andreas Haller
 bindir: bin
 cert_chain: []
-date: 2025-01-11 00:00:00.000000000 Z
+date: 2025-01-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hana
@@ -124,6 +124,8 @@ files:
 - lib/openapi_first/schema/validation_result.rb
 - lib/openapi_first/test.rb
 - lib/openapi_first/test/methods.rb
+- lib/openapi_first/test/minitest_helpers.rb
+- lib/openapi_first/test/plain_helpers.rb
 - lib/openapi_first/validated_request.rb
 - lib/openapi_first/validated_response.rb
 - lib/openapi_first/validators/request_body.rb