openapi_first 1.1.1 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4bb6d0ee4dbe98020ef124e79a99ced0d0111b1e2891cc8cb3ed8bb697973d2b
-  data.tar.gz: 77ce896a68f885614f64fd680af0dde1860c07ae772ce7d5f7d1b75b5abb4528
+  metadata.gz: 5ee379d839bec13bd899f690b3275d761b7425461f2241da4ccb62de384f0c94
+  data.tar.gz: 6ea27d437c7cb443d5b5c84b8e6d0ef34782e4f5d8bb5ce7666acc78797ca523
 SHA512:
-  metadata.gz: 841e32068646969d92ab26fff9c332e849056463c99805c8e0dbbb437918113a09750fb5ceffd3940716911ea50bc20685acbcd862aa6acc270e43fe43675c87
-  data.tar.gz: d9a225b3e3119512fc3ed585f00f6f915e21f3199206f520d20733999441567e651fcb129588092c4e7ea9dcc4ce1e77c24365b04b8a8d9d232b8a1a5cd8e1da
+  metadata.gz: ab20a8bcd7d61961f4a1d654a36291f295ee0d69c50829cd8f1965998ca9a480a0636e2b0ca62d220a53c62b60d8bedb934fc8a57bed39a8e45683796a5cee8a
+  data.tar.gz: 43206c1bf540193863bd1f02c14f79d172fff662974c8efbfd90dfd6334f11f23c0dee62c9c70c4bd45bbf202e68a76c9750a00aa4a45f5dd8682b6837a1177b

data/CHANGELOG.md

@@ -1,15 +1,20 @@
 # Changelog
 
-## 1.1.1
+## 1.2.0
 
-- Fix reading response body for example when running Rails (`ActionDispatch::Response::RackBody`)
+- Added `OpenapiFirst.parse(hash)` to load ("parse") a resolved/de-referenced Hash
+- Added support for unescaped special characters in the path params (https://github.com/ahx/openapi_first/pull/217)
+- Added `operation` to `RuntimeRequest` by [@MrBananaLord](https://github.com/ahx/openapi_first/pull/216)
 
-## 1.1.0
+## 1.1.1
 
+- Fix reading response body for example when running Rails (`ActionDispatch::Response::RackBody`)
 - Add `known?`, `status`, `body`, `headers`, `content_type` methods to inspect the parsed response (`RuntimeResponse`)
 - Add `OpenapiFirst::ParseError` which is raised by low-level interfaces like `request.body` if the body could not be parsed.
 - Add "code" field to errors in JSON:API error response
 
+## 1.1.0 (yanked)
+
 ## 1.0.0
 
 - Breaking: The default error uses application/problem+json content-type

data/Gemfile.lock

@@ -1,20 +1,20 @@
 PATH
   remote: .
   specs:
-    openapi_first (1.1.1)
+    openapi_first (1.2.1)
       json_refs (~> 0.1, >= 0.1.7)
       json_schemer (~> 2.1.0)
       multi_json (~> 1.15)
-      mustermann-contrib (~> 3.0.0)
+      mustermann (~> 3.0.0)
       openapi_parameters (>= 0.3.2, < 2.0)
       rack (>= 2.2, < 4.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    actionpack (7.1.2)
-      actionview (= 7.1.2)
-      activesupport (= 7.1.2)
+    actionpack (7.1.3)
+      actionview (= 7.1.3)
+      activesupport (= 7.1.3)
       nokogiri (>= 1.8.5)
       racc
       rack (>= 2.2.4)
@@ -22,13 +22,13 @@ GEM
       rack-test (>= 0.6.3)
       rails-dom-testing (~> 2.2)
       rails-html-sanitizer (~> 1.6)
-    actionview (7.1.2)
-      activesupport (= 7.1.2)
+    actionview (7.1.3)
+      activesupport (= 7.1.3)
       builder (~> 3.1)
       erubi (~> 1.11)
       rails-dom-testing (~> 2.2)
       rails-html-sanitizer (~> 1.6)
-    activesupport (7.1.2)
+    activesupport (7.1.3)
       base64
       bigdecimal
       concurrent-ruby (~> 1.0, >= 1.0.2)
@@ -40,9 +40,9 @@ GEM
       tzinfo (~> 2.0)
     ast (2.4.2)
     base64 (0.2.0)
-    bigdecimal (3.1.5)
+    bigdecimal (3.1.6)
     builder (3.2.4)
-    concurrent-ruby (1.2.2)
+    concurrent-ruby (1.2.3)
     connection_pool (2.4.1)
     crass (1.0.6)
     diff-lcs (1.5.0)
@@ -51,7 +51,6 @@ GEM
       ruby2_keywords
     erubi (1.12.0)
     hana (1.3.7)
-    hansi (0.2.1)
     i18n (1.14.1)
       concurrent-ruby (~> 1.0)
     json (2.7.1)
@@ -65,13 +64,10 @@ GEM
     loofah (2.22.0)
       crass (~> 1.0.2)
       nokogiri (>= 1.12.0)
-    minitest (5.21.1)
+    minitest (5.21.2)
     multi_json (1.15.0)
     mustermann (3.0.0)
       ruby2_keywords (~> 0.0.1)
-    mustermann-contrib (3.0.0)
-      hansi (~> 0.2.0)
-      mustermann (= 3.0.0)
     mutex_m (0.2.0)
     nokogiri (1.16.0-arm64-darwin)
       racc (~> 1.4)
@@ -81,7 +77,7 @@ GEM
       rack (>= 2.2)
       zeitwerk (~> 2.6)
     parallel (1.24.0)
-    parser (3.3.0.3)
+    parser (3.3.0.5)
       ast (~> 2.4.1)
       racc
     racc (1.7.3)
@@ -117,11 +113,11 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.12.0)
     rspec-support (3.12.1)
-    rubocop (1.59.0)
+    rubocop (1.60.1)
       json (~> 2.3)
       language_server-protocol (>= 3.17.0)
       parallel (~> 1.10)
-      parser (>= 3.2.2.4)
+      parser (>= 3.3.0.2)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
       rexml (>= 3.2.5, < 4.0)

data/Gemfile.rack2.lock

@@ -1,11 +1,11 @@
 PATH
   remote: .
   specs:
-    openapi_first (1.0.0.beta6)
+    openapi_first (1.1.1)
       json_refs (~> 0.1, >= 0.1.7)
       json_schemer (~> 2.1.0)
       multi_json (~> 1.15)
-      mustermann-contrib (~> 3.0.0)
+      mustermann (~> 3.0.0)
       openapi_parameters (>= 0.3.2, < 2.0)
       rack (>= 2.2, < 4.0)
 
@@ -15,7 +15,6 @@ GEM
     ast (2.4.2)
     diff-lcs (1.5.0)
     hana (1.3.7)
-    hansi (0.2.1)
     json (2.7.1)
     json_refs (0.1.8)
       hana
@@ -27,9 +26,6 @@ GEM
     multi_json (1.15.0)
     mustermann (3.0.0)
       ruby2_keywords (~> 0.0.1)
-    mustermann-contrib (3.0.0)
-      hansi (~> 0.2.0)
-      mustermann (= 3.0.0)
     openapi_parameters (0.3.2)
       rack (>= 2.2)
       zeitwerk (~> 2.6)

data/lib/openapi_first/body_parser.rb

@@ -6,7 +6,8 @@ module OpenapiFirst
   class BodyParser
     def self.const_missing(const_name)
       super unless const_name == :ParsingError
-      warn 'DEPRECATION WARNING: OpenapiFirst::BodyParser::ParsingError is deprecated. Use OpenapiFirst::ParseError instead.' # rubocop:disable Layout/LineLength
+      warn 'DEPRECATION WARNING: OpenapiFirst::BodyParser::ParsingError is deprecated. ' \
+           'Use OpenapiFirst::ParseError instead.'
       OpenapiFirst::ParseError
     end
 

data/lib/openapi_first/definition/operation.rb

@@ -11,8 +11,7 @@ module OpenapiFirst
     class Operation
       extend Forwardable
       def_delegators :operation_object,
-                     :[],
-                     :dig
+                     :[]
 
       WRITE_METHODS = Set.new(%w[post put patch delete]).freeze
       private_constant :WRITE_METHODS

data/lib/openapi_first/definition.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'mustermann/template'
+require 'mustermann'
 require_relative 'definition/path_item'
 require_relative 'runtime_request'
 
@@ -9,7 +9,7 @@ module OpenapiFirst
   class Definition
     attr_reader :filepath, :paths, :openapi_version
 
-    def initialize(resolved, filepath)
+    def initialize(resolved, filepath = nil)
       @filepath = filepath
       @paths = resolved['paths']
       @openapi_version = detect_version(resolved)
@@ -60,7 +60,7 @@ module OpenapiFirst
 
     def search_for_path_item(request_path)
       paths.find do |path, path_item_object|
-        template = Mustermann::Template.new(path)
+        template = Mustermann.new(path)
         path_params = template.params(request_path)
         next unless path_params
         next unless path_params.size == template.names.size

data/lib/openapi_first/failure.rb

@@ -47,9 +47,22 @@ module OpenapiFirst
 
     # Raise an exception that fits the failure.
     def raise!
-      exception, message_prefix = TYPES.fetch(error_type)
+      exception, = TYPES.fetch(error_type)
+      raise exception, exception_message
+    end
+
+    def exception_message
+      _, message_prefix = TYPES.fetch(error_type)
+
+      "#{message_prefix} #{@message || generate_message}"
+    end
+
+    private
 
-      raise exception, "#{message_prefix} #{@message || errors&.map(&:error)&.join('. ')}"
+    def generate_message
+      messages = errors&.take(4)&.map(&:error)
+      messages << "... (#{errors.size} errors total)" if errors && errors.size > 4
+      messages&.join('. ')
     end
   end
 end

data/lib/openapi_first/runtime_request.rb

@@ -22,7 +22,7 @@ module OpenapiFirst
     def_delegators :@operation, :operation_id, :request_method
     def_delegator :@path_item, :path, :path_definition
 
-    attr_reader :path_item
+    attr_reader :path_item, :operation
 
     def known?
       known_path? && known_request_method?
@@ -90,6 +90,6 @@ module OpenapiFirst
 
     private
 
-    attr_reader :request, :operation
+    attr_reader :request
   end
 end

data/lib/openapi_first/schema/validation_result.rb

@@ -20,13 +20,6 @@ module OpenapiFirst
           ValidationError.new(err)
         end
       end
-
-      # Returns a message that is used in exception messages.
-      def message
-        return unless error?
-
-        errors.map(&:error).join('. ')
-      end
     end
   end
 end

data/lib/openapi_first/version.rb

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

data/lib/openapi_first.rb

@@ -28,10 +28,20 @@ module OpenapiFirst
   # Key in rack to find instance of RuntimeRequest
   REQUEST = 'openapi.request'
 
-  def self.load(spec_path, only: nil)
-    resolved = Bundle.resolve(spec_path)
+  # Load and dereference an OpenAPI spec file
+  def self.load(filepath, only: nil)
+    resolved = bundle(filepath)
+    parse(resolved, only:, filepath:)
+  end
+
+  # Parse a dereferenced Hash
+  def self.parse(resolved, only: nil, filepath: nil)
     resolved['paths'].filter!(&->(key, _) { only.call(key) }) if only
-    Definition.new(resolved, spec_path)
+    Definition.new(resolved, filepath)
+  end
+
+  def self.bundle(filepath)
+    Bundle.resolve(filepath)
   end
 
   module Bundle

data/openapi_first.gemspec

@@ -41,7 +41,7 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency 'json_refs', '~> 0.1', '>= 0.1.7'
   spec.add_runtime_dependency 'json_schemer', '~> 2.1.0'
   spec.add_runtime_dependency 'multi_json', '~> 1.15'
-  spec.add_runtime_dependency 'mustermann-contrib', '~> 3.0.0'
+  spec.add_runtime_dependency 'mustermann', '~> 3.0.0'
   spec.add_runtime_dependency 'openapi_parameters', '>= 0.3.2', '< 2.0'
   spec.add_runtime_dependency 'rack', '>= 2.2', '< 4.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: openapi_first
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.2.1
 platform: ruby
 authors:
 - Andreas Haller
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-01-12 00:00:00.000000000 Z
+date: 2024-01-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json_refs
@@ -59,7 +59,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.15'
 - !ruby/object:Gem::Dependency
-  name: mustermann-contrib
+  name: mustermann
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"