openapi_first 2.1.1 → 2.2.0

data/lib/openapi_first.rb

@@ -1,18 +1,18 @@
 # frozen_string_literal: true
 
-require 'yaml'
-require 'multi_json'
-require_relative 'openapi_first/json_refs'
+require_relative 'openapi_first/json'
+require_relative 'openapi_first/file_loader'
 require_relative 'openapi_first/errors'
 require_relative 'openapi_first/configuration'
 require_relative 'openapi_first/definition'
 require_relative 'openapi_first/version'
-require_relative 'openapi_first/schema'
 require_relative 'openapi_first/middlewares/response_validation'
 require_relative 'openapi_first/middlewares/request_validation'
 
 # OpenapiFirst is a toolchain to build HTTP APIS based on OpenAPI API descriptions.
 module OpenapiFirst
+  autoload :Test, 'openapi_first/test'
+
   # Key in rack to find instance of Request
   REQUEST = 'openapi.request'
   FAILURE = :openapi_first_validation_failure
@@ -53,23 +53,16 @@ module OpenapiFirst
   def self.load(filepath, only: nil, &)
     raise FileNotFoundError, "File not found: #{filepath}" unless File.exist?(filepath)
 
-    resolved = Bundle.resolve(filepath)
-    parse(resolved, only:, filepath:, &)
+    contents = FileLoader.load(filepath)
+    parse(contents, only:, filepath:, &)
   end
 
   # Parse a dereferenced Hash
   # @return [Definition]
-  def self.parse(resolved, only: nil, filepath: nil, &)
-    resolved['paths'].filter!(&->(key, _) { only.call(key) }) if only
-    Definition.new(resolved, filepath, &)
-  end
-
-  # @!visibility private
-  module Bundle
-    def self.resolve(spec_path)
-      @file_cache ||= {}
-      @file_cache[File.expand_path(spec_path).to_sym] ||= JsonRefs.load(spec_path)
-    end
+  def self.parse(contents, only: nil, filepath: nil, &)
+    # TODO: This needs to work with unresolved contents as well
+    contents['paths'].filter!(&->(key, _) { only.call(key) }) if only
+    Definition.new(contents, filepath, &)
   end
 end
 

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: openapi_first
 version: !ruby/object:Gem::Version
-  version: 2.1.1
+  version: 2.2.0
 platform: ruby
 authors:
 - Andreas Haller
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-09-19 00:00:00.000000000 Z
+date: 2025-01-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hana
@@ -44,20 +43,6 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '3.0'
-- !ruby/object:Gem::Dependency
-  name: multi_json
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.15'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.15'
 - !ruby/object:Gem::Dependency
   name: openapi_parameters
   requirement: !ruby/object:Gem::Requirement
@@ -98,7 +83,6 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '4.0'
-description:
 email:
 - andreas.haller@posteo.de
 executables: []
@@ -118,20 +102,24 @@ files:
 - lib/openapi_first/error_responses/jsonapi.rb
 - lib/openapi_first/errors.rb
 - lib/openapi_first/failure.rb
-- lib/openapi_first/json_refs.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/ref_resolver.rb
 - lib/openapi_first/request.rb
+- lib/openapi_first/request_body_parsers.rb
 - lib/openapi_first/request_parser.rb
 - lib/openapi_first/request_validator.rb
 - lib/openapi_first/response.rb
+- lib/openapi_first/response_body_parsers.rb
 - lib/openapi_first/response_parser.rb
 - lib/openapi_first/response_validator.rb
 - lib/openapi_first/router.rb
 - lib/openapi_first/router/find_content.rb
 - lib/openapi_first/router/find_response.rb
 - lib/openapi_first/router/path_template.rb
-- lib/openapi_first/schema.rb
 - lib/openapi_first/schema/validation_error.rb
 - lib/openapi_first/schema/validation_result.rb
 - lib/openapi_first/test.rb
@@ -152,7 +140,6 @@ metadata:
   source_code_uri: https://github.com/ahx/openapi_first
   changelog_uri: https://github.com/ahx/openapi_first/blob/main/CHANGELOG.md
   rubygems_mfa_required: 'true'
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -167,8 +154,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.19
-signing_key:
+rubygems_version: 3.6.2
 specification_version: 4
 summary: Implement HTTP APIs based on OpenApi 3.x
 test_files: []

data/lib/openapi_first/json_refs.rb

@@ -1,151 +0,0 @@
-# frozen_string_literal: true
-
-# This is a fork of the json_refs gem, which does not use
-# open-uri, does not call chdir and adds caching of files during dereferencing.
-# The original code is available at https://github.com/tzmfreedom/json_refs
-# See also https://github.com/tzmfreedom/json_refs/pull/11
-# The code was originally written by Makoto Tajitsu with the MIT License.
-#
-# The MIT License (MIT)
-
-# Copyright (c) 2017 Makoto Tajitsu
-
-# 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.
-
-require 'hana'
-require 'json'
-require 'yaml'
-
-module OpenapiFirst
-  module JsonRefs # :nodoc:
-    class << self
-      def dereference(doc)
-        file_cache = {}
-        Dereferencer.new(Dir.pwd, doc, file_cache).call
-      end
-
-      def load(filename)
-        doc_dir = File.dirname(filename)
-        doc = Loader.handle(filename)
-        file_cache = {}
-        Dereferencer.new(filename, doc_dir, doc, file_cache).call
-      end
-    end
-
-    module LocalRef
-      module_function
-
-      def call(path:, doc:)
-        Hana::Pointer.new(path[1..]).eval(doc)
-      end
-    end
-
-    module Loader
-      module_function
-
-      def handle(filename)
-        body = File.read(filename)
-        return JSON.parse(body) if File.extname(filename) == '.json'
-
-        YAML.unsafe_load(body)
-      end
-    end
-
-    class Dereferencer
-      def initialize(filename, doc_dir, doc, file_cache)
-        @filename = filename
-        @doc = doc
-        @doc_dir = doc_dir
-        @file_cache = file_cache
-      end
-
-      def call(doc = @doc, keys = [])
-        if doc.is_a?(Array)
-          doc.each_with_index do |value, idx|
-            call(value, keys + [idx])
-          end
-        elsif doc.is_a?(Hash)
-          if doc.key?('$ref')
-            dereference(keys, doc['$ref'])
-          else
-            doc.each do |key, value|
-              call(value, keys + [key])
-            end
-          end
-        end
-        doc
-      end
-
-      private
-
-      attr_reader :doc_dir
-
-      def dereference(paths, referenced_path)
-        key = paths.pop
-        target = paths.inject(@doc) do |obj, k|
-          obj[k]
-        end
-        value = follow_referenced_value(referenced_path)
-        target[key] = value
-      end
-
-      def follow_referenced_value(referenced_path)
-        value = referenced_value(referenced_path)
-        return referenced_value(value['$ref']) if value.is_a?(Hash) && value.key?('$ref')
-
-        value
-      end
-
-      def referenced_value(referenced_path)
-        filepath, pointer = referenced_path.split('#')
-        pointer&.prepend('#')
-        return dereference_local(pointer) if filepath.empty?
-
-        dereferenced_file = dereference_file(filepath)
-        return dereferenced_file if pointer.nil?
-
-        LocalRef.call(
-          path: pointer,
-          doc: dereferenced_file
-        )
-      end
-
-      def dereference_local(referenced_path)
-        LocalRef.call(path: referenced_path, doc: @doc)
-      end
-
-      def dereference_file(referenced_path)
-        referenced_path = File.expand_path(referenced_path, doc_dir) unless File.absolute_path?(referenced_path)
-        @file_cache[referenced_path] ||= load_referenced_file(referenced_path)
-      end
-
-      def load_referenced_file(absolute_path)
-        directory = File.dirname(absolute_path)
-
-        unless File.exist?(absolute_path)
-          raise FileNotFoundError,
-                "Problem while loading file referenced in #{@filename}: File not found #{absolute_path}"
-        end
-
-        referenced_doc = Loader.handle(absolute_path)
-        Dereferencer.new(@filename, directory, referenced_doc, @file_cache).call
-      end
-    end
-  end
-end

data/lib/openapi_first/schema.rb

@@ -1,44 +0,0 @@
-# frozen_string_literal: true
-
-require 'json_schemer'
-require_relative 'schema/validation_result'
-
-module OpenapiFirst
-  # Validate data via JSON Schema. A wrapper around JSONSchemer.
-  class Schema
-    attr_reader :schema
-
-    SCHEMAS = {
-      '3.1' => 'https://spec.openapis.org/oas/3.1/dialect/base',
-      '3.0' => 'json-schemer://openapi30/schema'
-    }.freeze
-
-    def initialize(schema, openapi_version: '3.1', write: true, after_property_validation: nil)
-      @schemer = JSONSchemer.schema(
-        schema,
-        access_mode: write ? 'write' : 'read',
-        meta_schema: SCHEMAS.fetch(openapi_version),
-        insert_property_defaults: true,
-        output_format: 'classic',
-        before_property_validation: method(:before_property_validation),
-        after_property_validation:
-      )
-    end
-
-    def validate(data)
-      ValidationResult.new(@schemer.validate(data))
-    end
-
-    private
-
-    def before_property_validation(data, property, property_schema, parent)
-      binary_format(data, property, property_schema, parent)
-    end
-
-    def binary_format(data, property, property_schema, _parent)
-      return unless property_schema.is_a?(Hash) && property_schema['format'] == 'binary'
-
-      data[property] = data.dig(property, :tempfile)&.read if data[property]
-    end
-  end
-end