openapi_first 2.0.3 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 600de21e1747c012275bf68c2d577296a8d82bb158cb4d73949b5b97167e655d
-  data.tar.gz: 86bcde27440b46fba91662fc7e6b86ac05d899da927fefc3e9d45a41a6d7fac9
+  metadata.gz: 1c1cc903f3a064f2f386503959e1b437729ab8a668ffbf0dd5aac19c38b4faf4
+  data.tar.gz: 0ee337872917f9009c9e9b9d57da4382e7b34248cf7df51a2926b3c589bc2f46
 SHA512:
-  metadata.gz: ee729f6f6fedf5d6e9b82b82bdf86493a0a7ea6274e20b60e2cdd84eda2ce086cf366249f61a28016374355d11ab32654a970a418cf5af24a0b187d31b967618
-  data.tar.gz: 125cc38e91e489f30c922f38056c69f9a6d501f3748ee098f2977d8fc6dc7f5f43f77264991f98564cb60ff2af19912ae85537c57d25c92604f8f6ee8766a749
+  metadata.gz: 30636bed981564cfe21696a46eb92d51ccb7680531b754dbfa37a6f52e37420f4e9611437e93ee54aada8eb6062db92ffd7fbce32eb1c76e8d856c5777b64444
+  data.tar.gz: 769c0821eca57bf60d8554ffd231b042511f57627f55c6083f2a9d054b35d08f0451d20f2411eaae035d7b3a591a046c57d732bf086143ac3d16162bf25b7c69

data/CHANGELOG.md

@@ -2,8 +2,18 @@
 
 ## Unreleased
 
+## 2.1.0
+
+- Added `OpenapiFirst::Definition#[]` to access the raw Hash representation of the OAS document. Example: `api['components'].fetch('schemas', 'Stations')`
+
+## 2.0.4
+
+- Fix issue with parsing reponse body when using Rails https://github.com/ahx/openapi_first/issues/281
+
 ## 2.0.3
 
+- Fix `OpenapiFirst::Test.register` https://github.com/ahx/openapi_first/issues/276
+
 - Request validation middleware now accepts `error_response: false` do disable rendering a response. This is useful if you just want to collect metrics (via hooks) during a migration phase.
 
 ## 2.0.2

data/lib/openapi_first/definition.rb

@@ -5,12 +5,22 @@ require_relative 'router'
 require_relative 'request'
 require_relative 'response'
 require_relative 'builder'
+require 'forwardable'
 
 module OpenapiFirst
   # Represents an OpenAPI API Description document
   # This is returned by OpenapiFirst.load.
   class Definition
-    attr_reader :filepath, :config, :paths, :router
+    extend Forwardable
+
+    # @return [String,nil]
+    attr_reader :filepath
+    # @return [Configuration]
+    attr_reader :config
+    # @return [Enumerable[String]]
+    attr_reader :paths
+    # @return [Router]
+    attr_reader :router
 
     # @param resolved [Hash] The resolved OpenAPI document.
     # @param filepath [String] The file path of the OpenAPI document.
@@ -20,15 +30,23 @@ module OpenapiFirst
       yield @config if block_given?
       @config.freeze
       @router = Builder.build_router(resolved, @config)
+      @resolved = resolved
       @paths = resolved['paths'].keys # TODO: Move into builder as well
     end
 
+    # Gives access to the raw resolved Hash. Like `mydefinition['components'].dig('schemas', 'Stations')`
+    # @!method [](key)
+    # @return [Hash]
+    def_delegators :@resolved, :[]
+
+    # Returns an Enumerable of available Routes for this API description.
+    # @return [Enumerable[Router::Route]]
     def routes
       @router.routes
     end
 
     # Validates the request against the API description.
-    # @param [Rack::Request] rack_request The Rack request object.
+    # @param [Rack::Request] request The Rack request object.
     # @param [Boolean] raise_error Whether to raise an error if validation fails.
     # @return [ValidatedRequest] The validated request object.
     def validate_request(request, raise_error: false)

data/lib/openapi_first/errors.rb

@@ -1,38 +1,40 @@
 # frozen_string_literal: true
 
 module OpenapiFirst
-  # @!visibility private
+  # Base class for all errors
   class Error < StandardError; end
-  # @!visibility private
+
+  # Raised if YAML/JSON file was not found
   class FileNotFoundError < Error; end
-  # @!visibility private
+
+  # Raised if response body could not be parsed
   class ParseError < Error; end
 
-  # @!visibility private
+  # Raised during request validation if request was invalid
   class RequestInvalidError < Error
     def initialize(message, validated_request)
       super(message)
       @request = validated_request
     end
 
-    # @attr_reader [OpenapiFirst::ValidatedRequest] request The validated request
+    # @return [ValidatedRequest] The validated request
     attr_reader :request
   end
 
-  # @!visibility private
+  # Raised during request validation if request was not defined in the API description
   class NotFoundError < RequestInvalidError; end
 
-  # @!visibility private
+  # Raised during response validation if request was invalid
   class ResponseInvalidError < Error
     def initialize(message, validated_response)
       super(message)
       @response = validated_response
     end
 
-    # @attr_reader [OpenapiFirst::ValidatedResponse] request The validated response
+    # @return [ValidatedResponse] The validated response
     attr_reader :response
   end
 
-  # @!visibility private
+  # Raised during request validation if response was not defined in the API description
   class ResponseNotFoundError < ResponseInvalidError; end
 end

data/lib/openapi_first/middlewares/response_validation.rb

@@ -25,20 +25,9 @@ module OpenapiFirst
 
       def call(env)
         status, headers, body = @app.call(env)
-        body = read_body(body)
         @definition.validate_response(Rack::Request.new(env), Rack::Response[status, headers, body], raise_error: @raise)
         [status, headers, body]
       end
-
-      private
-
-      def read_body(body)
-        return body.to_ary if body.respond_to?(:to_ary)
-
-        result = []
-        body.each { |part| result << part }
-        result
-      end
     end
   end
 end

data/lib/openapi_first/validated_request.rb

@@ -15,46 +15,53 @@ module OpenapiFirst
       @request_definition = request_definition
     end
 
-    # @!method error
-    #   @return [Failure, nil] The error that occurred during validation.
-    # @!method request_definition
-    #   @return [Request, nil]
-    attr_reader :parsed_values, :error, :request_definition
+    # A Failure object if the request is invalid
+    # @return [Failure, nil]
+    attr_reader :error
+
+    # The request definition if this request is defined in the API description
+    # @return [Request, nil]
+    attr_reader :request_definition
 
-    # Openapi 3 specific
-    # @!method operation
-    #   @return [Hash] The OpenAPI 3 operation object
     # @!method operation_id
-    #   @return [String, nil] The OpenAPI 3 operationId
-    def_delegators :request_definition, :operation_id, :operation
+    # @return [String, nil] The OpenAPI 3 operationId
+    def_delegator :request_definition, :operation_id
+
+    # @!method operation
+    # @return [Hash] The raw OpenAPI 3 operation object
+    def_delegator :request_definition, :operation
 
     # Parsed path parameters
-    #   @return [Hash] A string keyed hash of path parameters
+    # @return [Hash<String, anything>]
     def parsed_path_parameters
-      parsed_values[:path]
+      @parsed_values[:path]
     end
 
     # Parsed query parameters. This only returns the query parameters that are defined in the OpenAPI spec.
+    # @return [Hash<String, anything>]
     def parsed_query
-      parsed_values[:query]
+      @parsed_values[:query]
     end
 
     # Parsed headers. This only returns the query parameters that are defined in the OpenAPI spec.
+    # @return [Hash<String, anything>]
     def parsed_headers
-      parsed_values[:headers]
+      @parsed_values[:headers]
     end
 
     # Parsed cookies. This only returns the query parameters that are defined in the OpenAPI spec.
+    # @return [Hash<String, anything>]
     def parsed_cookies
-      parsed_values[:cookies]
+      @parsed_values[:cookies]
     end
 
     # Parsed body. This parses the body according to the content type.
     # Note that this returns the hole body, not only the fields that are defined in the OpenAPI spec.
     # You can use JSON Schemas `additionalProperties` or `unevaluatedProperties` to
     # returns a validation error if the body contains unknown fields.
+    # @return [Hash<String, anything>]
     def parsed_body
-      parsed_values[:body]
+      @parsed_values[:body]
     end
 
     # Checks if the request is valid.
@@ -74,6 +81,7 @@ module OpenapiFirst
 
     # Merged path, query, body parameters.
     # Here path has the highest precedence, then query, then body.
+    # @return [Hash<String, anything>]
     def parsed_params
       @parsed_params ||= parsed_body.merge(parsed_query, parsed_path_parameters)
     end

data/lib/openapi_first/validated_response.rb

@@ -15,10 +15,23 @@ module OpenapiFirst
       @response_definition = response_definition
     end
 
-    attr_reader :parsed_values, :error, :response_definition
+    # A Failure object if the response is invalid
+    # @return [Failure, nil]
+    attr_reader :error
 
-    def_delegator :parsed_values, :headers, :parsed_headers
-    def_delegator :parsed_values, :body, :parsed_body
+    # The response definition if this response is defined in the API description
+    # @return [Response, nil]
+    attr_reader :response_definition
+
+    # The parsed headers
+    # @!method parsed_headers
+    # @return [Hash<String,anything>]
+    def_delegator :@parsed_values, :headers, :parsed_headers
+
+    # The parsed body
+    # @!method parsed_body
+    # @return [Hash<String,anything>]
+    def_delegator :@parsed_values, :body, :parsed_body
 
     # Checks if the response is valid.
     # @return [Boolean] true if the response is valid, false otherwise.
@@ -26,6 +39,8 @@ module OpenapiFirst
       error.nil?
     end
 
+    # Checks if the response is invalid.
+    # @return [Boolean]
     def invalid?
       !valid?
     end

data/lib/openapi_first/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: openapi_first
 version: !ruby/object:Gem::Version
-  version: 2.0.3
+  version: 2.1.0
 platform: ruby
 authors:
 - Andreas Haller
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-07-13 00:00:00.000000000 Z
+date: 2024-07-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hana