openapi_first 2.2.2 → 2.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: de3cced92ef56a41399e4baa7aaf2b42250d2d3e532a22b245edd70d2b7446d2
-  data.tar.gz: b433a7d18c02176dda8ce12ff41636d4f19bd99632cbc0085879e34b3090cb76
+  metadata.gz: d85c4425401207c7ff52f921d34c77c7ee6c6ee5671ecfbac36ca5619685cdb6
+  data.tar.gz: afcb639314fd7f049b93d29dd89cbb88260abbcb66f1e5a20b8c1c01ade063b2
 SHA512:
-  metadata.gz: 58613cfd3648073dee3189cfced111adcdfd4471ee67a07517d3c800c69aded0ab46b50a69d56fda453a2af9078db74ee45c260c601c16cdd2896428d330068b
-  data.tar.gz: ae57aa8b109569165e9bb9ce3e9eb380e387a0eb1afb3cde850f7a2d3979391dc62ebe567cacb51492aefe4d9ef2db2db8963c4ca2b256cbf0c5b3e9491a2de3
+  metadata.gz: 8c9e2fadb4ba81ab68026b5b2f6c44daf9710d3e3fc27e32175f9691f885839f6fda6cd1f477c7e347b88ce0d27e933bd30642d1773665301613049df092e7a5
+  data.tar.gz: 493dcfa9384f1462b7ab713dcc8c3c9b7cb2c6f63a4977f0ed3485d65811a3cd0869c2ddc5f8dc9cd5efacaa773836b0290d2be7f88b4af20de9adad2aa7c7b6

data/CHANGELOG.md

@@ -2,6 +2,15 @@
 
 ## Unreleased
 
+## 2.2.4
+
+- Fix request validation file uploads in multipart/form-data requests with nested fields (https://github.com/ahx/openapi_first/issues/324)
+- Add more error details to validation result (https://github.com/ahx/openapi_first/pull/322)
+
+## 2.2.3
+
+- Respect global JSONSchemer configuration (https://github.com/ahx/openapi_first/pull/318)
+
 ## 2.2.2
 
 - Fix parsing parameters with referenced schemas (https://github.com/ahx/openapi_first/issues/316)

data/lib/openapi_first/builder.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 require 'json_schemer'
-require_relative 'json_pointer'
 require_relative 'ref_resolver'
 
 module OpenapiFirst
@@ -18,10 +17,10 @@ module OpenapiFirst
     end
 
     def initialize(contents, filepath:, config:)
-      @schemer_configuration = JSONSchemer::Configuration.new(
-        meta_schema: detect_meta_schema(contents, filepath),
-        insert_property_defaults: true
-      )
+      @schemer_configuration = JSONSchemer.configuration.clone
+      @schemer_configuration.meta_schema = detect_meta_schema(contents, filepath)
+      @schemer_configuration.insert_property_defaults = true
+
       @config = config
       @contents = RefResolver.for(contents, dir: filepath && File.dirname(filepath))
     end

data/lib/openapi_first/rack/test.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+# Integration for rack-test
+
+require 'rack/test'

data/lib/openapi_first/ref_resolver.rb

@@ -55,7 +55,7 @@ module OpenapiFirst
           value = Hana::Pointer.new(pointer[1..]).eval(context)
           raise "Unknown reference #{pointer} in #{context}" unless value
 
-          return RefResolver.for(value, dir:)
+          return RefResolver.for(value, dir:, context:)
         end
 
         relative_path, file_pointer = pointer.split('#')
@@ -65,7 +65,7 @@ module OpenapiFirst
         file_contents = FileLoader.load(full_path)
         new_dir = File.dirname(full_path)
         value = Hana::Pointer.new(file_pointer).eval(file_contents)
-        RefResolver.for(value, dir: new_dir)
+        RefResolver.for(value, dir: new_dir, context: file_contents)
       end
     end
 

data/lib/openapi_first/request_body_parsers.rb

@@ -36,11 +36,28 @@ module OpenapiFirst
       Failure.fail!(:invalid_body, message: 'Failed to parse request body as JSON')
     end)
 
-    register('multipart/form-data', lambda { |request|
-      request.POST.transform_values do |value|
-        value.is_a?(Hash) && value[:tempfile] ? value[:tempfile].read : value
+    # Parses multipart/form-data requests and currently puts the contents of a file upload at the parsed hash values.
+    # NOTE: This behavior will probably change in the next major version.
+    #       The uploaded file should not be read during request validation.
+    module MultipartBodyParser
+      def self.call(request)
+        request.POST.transform_values do |value|
+          unpack_value(value)
+        end
       end
-    })
+
+      def self.unpack_value(value)
+        return value.map { unpack_value(_1) } if value.is_a?(Array)
+        return value unless value.is_a?(Hash)
+        return value[:tempfile]&.read if value.key?(:tempfile)
+
+        value.transform_values do |v|
+          unpack_value(v)
+        end
+      end
+    end
+
+    register('multipart/form-data', MultipartBodyParser)
 
     register('application/x-www-form-urlencoded', lambda(&:POST))
   end

data/lib/openapi_first/schema/validation_error.rb

@@ -3,7 +3,7 @@
 module OpenapiFirst
   class Schema
     # One of multiple validation errors. Returned by Schema::ValidationResult#errors.
-    ValidationError = Data.define(:message, :data_pointer, :schema_pointer, :type, :details) do
+    ValidationError = Data.define(:value, :message, :data_pointer, :schema_pointer, :type, :details, :schema) do
       # @deprecated Please use {#message} instead
       def error
         warn 'OpenapiFirst::Schema::ValidationError#error is deprecated. Use #message instead.'

data/lib/openapi_first/schema/validation_result.rb

@@ -16,11 +16,13 @@ module OpenapiFirst
       def errors
         @errors ||= @validation.map do |err|
           ValidationError.new(
+            value: err['data'],
             message: err['error'],
             data_pointer: err['data_pointer'],
             schema_pointer: err['schema_pointer'],
             type: err['type'],
-            details: err['details']
+            details: err['details'],
+            schema: err['schema']
           )
         end
       end

data/lib/openapi_first/test/plain_helpers.rb

@@ -18,8 +18,13 @@ module OpenapiFirst
                 "from #{request.request_method.upcase} #{request.path}."
         end
 
-        api.validate_request(request, raise_error: true)
-        api.validate_response(request, response, raise_error: true)
+        validated = api.validate_request(request, raise_error: false)
+        # :nocov:
+        raise validated.error.exception if validated.invalid?
+
+        validated = api.validate_response(request, response, raise_error: false)
+        raise validated.error.exception if validated.invalid?
+        # :nocov:
       end
     end
   end

data/lib/openapi_first/version.rb

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

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: openapi_first
 version: !ruby/object:Gem::Version
-  version: 2.2.2
+  version: 2.2.4
 platform: ruby
 authors:
 - Andreas Haller
 bindir: bin
 cert_chain: []
-date: 2025-01-21 00:00:00.000000000 Z
+date: 2025-02-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hana
@@ -93,7 +93,6 @@ files:
 - LICENSE.txt
 - README.md
 - lib/openapi_first.rb
-- lib/openapi_first/body_parser.rb
 - lib/openapi_first/builder.rb
 - lib/openapi_first/configuration.rb
 - lib/openapi_first/definition.rb
@@ -104,9 +103,9 @@ files:
 - lib/openapi_first/failure.rb
 - lib/openapi_first/file_loader.rb
 - lib/openapi_first/json.rb
-- lib/openapi_first/json_pointer.rb
 - lib/openapi_first/middlewares/request_validation.rb
 - lib/openapi_first/middlewares/response_validation.rb
+- lib/openapi_first/rack/test.rb
 - lib/openapi_first/ref_resolver.rb
 - lib/openapi_first/request.rb
 - lib/openapi_first/request_body_parsers.rb

data/lib/openapi_first/body_parser.rb

@@ -1,45 +0,0 @@
-# frozen_string_literal: true
-
-module OpenapiFirst
-  # @!visibility private
-  module BodyParser
-    def self.[](content_type)
-      case content_type
-      when /json/i
-        JsonBodyParser
-      when %r{multipart/form-data}i
-        MultipartBodyParser
-      else
-        DefaultBodyParser
-      end
-    end
-
-    def self.read_body(request)
-      body = request.body&.read
-      request.body.rewind if request.body.respond_to?(:rewind)
-      body
-    end
-
-    JsonBodyParser = lambda do |request|
-      body = read_body(request)
-      return if body.nil? || body.empty?
-
-      JSON.parse(body)
-    rescue JSON::ParserError
-      Failure.fail!(:invalid_body, message: 'Failed to parse request body as JSON')
-    end
-
-    MultipartBodyParser = lambda do |request|
-      request.POST.transform_values do |value|
-        value.is_a?(Hash) && value[:tempfile] ? value[:tempfile].read : value
-      end
-    end
-
-    # This returns the post data parsed by rack or the raw body
-    DefaultBodyParser = lambda do |request|
-      return request.POST if request.form_data?
-
-      read_body(request)
-    end
-  end
-end

data/lib/openapi_first/json_pointer.rb

@@ -1,22 +0,0 @@
-# frozen_string_literal: true
-
-module OpenapiFirst
-  # Functions to handle JSON Pointers
-  # @!visibility private
-  module JsonPointer
-    ESCAPE_CHARS = { '~' => '~0', '/' => '~1', '+' => '%2B' }.freeze
-    ESCAPE_REGEX = Regexp.union(ESCAPE_CHARS.keys)
-
-    module_function
-
-    def append(root, *tokens)
-      "#{root}/" + tokens.map do |token|
-        escape_json_pointer_token(token)
-      end.join('/')
-    end
-
-    def escape_json_pointer_token(token)
-      token.to_s.gsub(ESCAPE_REGEX, ESCAPE_CHARS)
-    end
-  end
-end