skooma 0.2.2 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d780ea317b116a8bdafac72f240b68366cf6f2892ea671f29ed51dd48a198093
-  data.tar.gz: '078593785c8fc17c73c171616131880dbeaf1b85923e593a3612eb9b2309ff0d'
+  metadata.gz: 9f8caa0911924b17126cad7544d4c54e4fe3f819c6b21c3489cd47180bb69996
+  data.tar.gz: 052a2f72272a02b99cb44f62b6a1b1a319ca1c743742c66125d4da4ae9b402c1
 SHA512:
-  metadata.gz: f16cb70ad584c45615c4c376ebbab69e48caca0daa32c687d55c9c96453b3a608096afeedc45a7286e0e4ace4c2dc500c2d36ed013d0b951d915b60bbba42a63
-  data.tar.gz: c301176ff04134e0e6d18c57e4e0ced55f1dca82d8ff807eefa820cc02f8227101275ccf43b4e3b60c6716b19d7da94f714da37435f417995e97faf44f2b20d3
+  metadata.gz: 4392d35e7aade0d2683f38ef782ed6b2b980aee835ea489f173202ff75627a4cff4bc3ae522bb9e06ed6b69d7b073a08520902a3a6388cd22f3e8321bbedbb08
+  data.tar.gz: 990bfcb689cd4ad8f76060c955abf9ce01fd3513a54499592136045d1f87f3000575356b1d0e7ddea78b16cc76e516d099dfeda18c35c36426a6426e933068ea

data/CHANGELOG.md

@@ -7,6 +7,32 @@ and this project adheres to [Semantic Versioning].
 
 ## [Unreleased]
 
+## [0.3.0] - 2024-04-09
+
+### Changed
+
+- BREAKING CHANGE: Pass `headers` parameter to registered `BodyParsers`. ([@skryukov])
+
+    ```ruby
+    # Before:
+    Skooma::BodyParsers.register("application/xml", ->(body) { Hash.from_xml(body) })
+    # After:
+    Skooma::BodyParsers.register("application/xml", ->(body, headers:) { Hash.from_xml(body) })
+    ```
+### Fixed
+
+- Fix wrong path when combined with Rails exceptions_app. ([@ursm])
+
+## [0.2.3] - 2024-01-18
+
+### Added
+
+- Add support for multiple OpenAPI documents. ([@skryukov])
+
+### Fixed
+
+- Fix `Skooma::Error: Missing name key /request` by setting `content` and `required` keyword dependencies. ([@skryukov])
+
 ## [0.2.2] - 2024-01-04
 
 ### Added
@@ -58,8 +84,11 @@ end
 - Initial implementation. ([@skryukov])
 
 [@skryukov]: https://github.com/skryukov
+[@ursm]: https://github.com/ursm
 
-[Unreleased]: https://github.com/skryukov/skooma/compare/v0.2.2...HEAD
+[Unreleased]: https://github.com/skryukov/skooma/compare/v0.3.0...HEAD
+[0.3.0]: https://github.com/skryukov/skooma/compare/v0.2.3...v0.3.0
+[0.2.3]: https://github.com/skryukov/skooma/compare/v0.2.2...v0.2.3
 [0.2.2]: https://github.com/skryukov/skooma/compare/v0.2.1...v0.2.2
 [0.2.1]: https://github.com/skryukov/skooma/compare/v0.2.0...v0.2.1
 [0.2.0]: https://github.com/skryukov/skooma/compare/v0.1.0...v0.2.0

data/lib/skooma/body_parsers.rb

@@ -3,7 +3,7 @@
 module Skooma
   module BodyParsers
     class << self
-      DEFAULT_PARSER = ->(body) { body }
+      DEFAULT_PARSER = ->(body, **_options) { body }
 
       def [](media_type)
         parsers[media_type.to_s.strip.downcase] || DEFAULT_PARSER
@@ -20,7 +20,7 @@ module Skooma
     self.parsers = {}
 
     module JSONParser
-      def self.call(body)
+      def self.call(body, **_options)
         JSON.parse(body)
       rescue JSON::ParserError
         body

data/lib/skooma/env_mapper.rb

@@ -9,7 +9,7 @@ module Skooma
       def call(env, response = nil, with_response: true, with_request: true)
         result = {
           "method" => env["REQUEST_METHOD"].downcase,
-          "path" => env["PATH_INFO"]
+          "path" => env["action_dispatch.original_path"] || env["PATH_INFO"]
         }
         result["request"] = map_request(env) if with_request
         result["response"] = map_response(response) if response && with_response
@@ -23,10 +23,19 @@ module Skooma
         {
           "query" => env["rack.request.query_string"] || env["QUERY_STRING"],
           "headers" => env.select { |k, _| k.start_with?("HTTP_") || PLAIN_HEADERS.include?(k) }.transform_keys { |k| k.sub(REGEXP_HTTP, "").split("_").map(&:capitalize).join("-") },
-          "body" => env["RAW_POST_DATA"]
+          "body" => env["RAW_POST_DATA"] || read_rack_input(env["rack.input"])
         }
       end
 
+      def read_rack_input(input)
+        return nil unless input.respond_to?(:rewind)
+
+        input.rewind
+        raw_input = input.read
+        input.rewind
+        raw_input
+      end
+
       def map_response(response)
         status, headers, body = response.to_a
         full_body = +""

data/lib/skooma/instance.rb

@@ -63,16 +63,16 @@ module Skooma
         data = {}
         data["status"] = JSONSkooma::JSONNode.new(value.fetch("status"), key: "status", parent: self)
         data["headers"] = Headers.new(value.fetch("headers", {}), key: "headers", parent: self)
-        body_value = parse_body(value["body"], data["headers"]&.[]("Content-Type"))
+        body_value = parse_body(value["body"], data["headers"])
         data["body"] = Attribute.new(body_value, key: "body", parent: self)
         ["object", data]
       end
 
-      def parse_body(body, content_type)
+      def parse_body(body, headers)
         return nil unless body
 
-        parser = BodyParsers[content_type&.split(";")&.first]
-        parser ? parser.call(body) : body
+        parser = BodyParsers[headers["Content-Type"]&.value&.split(";")&.first]
+        parser ? parser.call(body, headers: headers) : body
       end
     end
 
@@ -83,16 +83,16 @@ module Skooma
         data = {}
         data["query"] = Attribute.new(value.fetch("query", ""), key: "query", parent: self)
         data["headers"] = Headers.new(value.fetch("headers", {}), key: "headers", parent: self)
-        body_value = parse_body(value["body"], data["headers"]&.[]("Content-Type"))
+        body_value = parse_body(value["body"], data["headers"])
         data["body"] = Attribute.new(body_value, key: "body", parent: self)
         ["object", data]
       end
 
-      def parse_body(body, content_type)
+      def parse_body(body, headers)
         return nil unless body
 
-        parser = BodyParsers[content_type&.split(";")&.first]
-        parser ? parser.call(body) : body
+        parser = BodyParsers[headers["Content-Type"]&.value&.split(";")&.first]
+        parser ? parser.call(body, headers: headers) : body
       end
     end
 

data/lib/skooma/matchers/be_valid_document.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require "pp"
+
 module Skooma
   module Matchers
     class BeValidDocument

data/lib/skooma/matchers/conform_request_schema.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require "pp"
+
 module Skooma
   module Matchers
     class ConformRequestSchema

data/lib/skooma/matchers/wrapper.rb

@@ -45,11 +45,13 @@ module Skooma
 
         registry = create_test_registry
         pathname = Pathname.new(openapi_path)
+        source_uri = "#{base_uri}#{path_prefix.delete_suffix("/")}"
+        source_uri += "/" unless source_uri.end_with?("/")
         registry.add_source(
-          base_uri,
+          source_uri,
           JSONSkooma::Sources::Local.new(pathname.dirname.to_s)
         )
-        schema = registry.schema(URI.parse("#{base_uri}#{pathname.basename}"), schema_class: Skooma::Objects::OpenAPI)
+        schema = registry.schema(URI.parse("#{source_uri}#{pathname.basename}"), schema_class: Skooma::Objects::OpenAPI)
         schema.path_prefix = path_prefix
 
         include DefaultHelperMethods

data/lib/skooma/objects/parameter/keywords/content.rb

@@ -8,6 +8,7 @@ module Skooma
           self.key = "content"
           self.value_schema = :object_of_schemas
           self.schema_value_class = Objects::MediaType
+          self.depends_on = %w[in name style explode allowReserved allowEmptyValue]
 
           def evaluate(instance, result)
             return if instance.value.nil?

data/lib/skooma/objects/parameter/keywords/required.rb

@@ -6,6 +6,7 @@ module Skooma
       module Keywords
         class Required < JSONSkooma::Keywords::Base
           self.key = "required"
+          self.depends_on = %w[in name style explode allowReserved allowEmptyValue]
 
           def evaluate(instance, result)
             if json.value && ValueParser.call(instance, result)&.value.nil?

data/lib/skooma/objects/parameter/keywords/value_parser.rb

@@ -13,7 +13,7 @@ module Skooma
               raise Error, "Missing `in` key #{result.path}" unless type
 
               key = result.sibling(instance, "name")&.annotation
-              raise Error, "Missing `name` key #{instance.path}: #{key}" unless key
+              raise Error, "Missing `name` key #{result.path}" unless key
 
               case type
               when "query"

data/lib/skooma/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Skooma
-  VERSION = "0.2.2"
+  VERSION = "0.3.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: skooma
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.0
 platform: ruby
 authors:
 - Svyatoslav Kryukov
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-01-04 00:00:00.000000000 Z
+date: 2024-04-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: zeitwerk