skooma 0.2.1 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: eef2c83a80d1526de1a465acbb29b70fc053b6b5e54ed1e6b6ed131f56a8fe0a
-  data.tar.gz: 0c4cdec06703bdeb6fd3cf6922401552afaa13aa20b9189e472e703288ba60aa
+  metadata.gz: 6263d8960b9a3b49287103608c6770c967b6fadfcf58d826df2a492c4dedbd35
+  data.tar.gz: 5dd2c141d4baa7f0b95c1b3f3fbfd1afdafaae0097a1139956ba1c7e45f876a1
 SHA512:
-  metadata.gz: b5089b0a710836b072b723014cfaaf88b4504853f09a42ddf6a6f9e36ed50271b082dfcc184e047f2bf4481e6a343b4bebbd3bced7dfcec2c5a4f85697fbf113
-  data.tar.gz: aacb7329ef950a1fc9ff87513a85803e5530cacaec97f0dad1330bf20fb45e9bc339fe9004af11e1b90cfa6cbb725a2cd339a69c6a23721b667e8d10959b37fb
+  metadata.gz: e5ddc4010685045a5b2a9908597096af07fb5ac21cce3e1c456568111fed4fc2fb708603be0a47dbd6e61bec0d64e0d85e27841ab36583f0fb61b73759d3f05b
+  data.tar.gz: 1210a2ed7f56206369242baa147795acd3a6bc77aa6b719cb3ccc26ab33367a775921d0d94fd8741b651274afdc9183c20af194e4a289190d5968de239a9ae56

data/CHANGELOG.md

@@ -7,6 +7,42 @@ and this project adheres to [Semantic Versioning].
 
 ## [Unreleased]
 
+## [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
+
+- Add support for APIs mounted under a path prefix. ([@skryukov])
+
+```ruby
+# spec/rails_helper.rb
+
+RSpec.configure do |config|
+  # ...
+  path_to_openapi = Rails.root.join("docs", "openapi.yml")
+  # pass path_prefix option if your API is mounted under a prefix:
+  config.include Skooma::RSpec[path_to_openapi, path_prefix: "/internal/api"], type: :request
+end
+```
+
+### Changed
+
+- Bump `json_skooma` version to `~> 0.2.0`. ([@skryukov])
+
+### Fixed
+
+- Better checks to automatic request/response detection to prevent methods overrides via RSpec helpers (i.e. `subject(:response)`). ([@skryukov])
+- Fail response validation when expected response code or `responses` keyword aren't listed. ([@skryukov])
+
 ## [0.2.1] - 2023-10-23
 
 ### Fixed
@@ -33,7 +69,9 @@ and this project adheres to [Semantic Versioning].
 
 [@skryukov]: https://github.com/skryukov
 
-[Unreleased]: https://github.com/skryukov/skooma/compare/v0.2.1...HEAD
+[Unreleased]: https://github.com/skryukov/skooma/compare/v0.2.3...HEAD
+[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
 [0.1.0]: https://github.com/skryukov/skooma/commits/v0.1.0

data/README.md

@@ -14,6 +14,10 @@ Skooma is a Ruby library for validating API implementations against OpenAPI docu
 - Supports request/response validations against OpenAPI document
 - Includes RSpec and Minitest helpers
 
+### Learn more
+
+- [Let there be docs! A documentation-first approach to Rails API development](https://evilmartians.com/events/let-there-be-docs-a-documentation-first-approach-to-rails-api-development) – Talk and slides from Friendly.rb 2023
+
 <a href="https://evilmartians.com/?utm_source=skooma&utm_campaign=project_page">
 <img src="https://evilmartians.com/badges/sponsored-by-evil-martians.svg" alt="Sponsored by Evil Martians" width="236" height="54">
 </a>
@@ -44,6 +48,9 @@ RSpec.configure do |config|
   # ...
   path_to_openapi = Rails.root.join("docs", "openapi.yml")
   config.include Skooma::RSpec[path_to_openapi], type: :request
+
+  # OR pass path_prefix option if your API is mounted under a prefix:
+  config.include Skooma::RSpec[path_to_openapi, path_prefix: "/internal/api"], type: :request
 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/conform_response_schema.rb

@@ -19,7 +19,7 @@ module Skooma
       end
 
       def failure_message
-        return "Expected #{@expected} status code" unless status_matches?
+        return "Expected #{@expected} status code, but got #{@mapped_response["response"]["status"]}" unless status_matches?
 
         super
       end

data/lib/skooma/matchers/wrapper.rb

@@ -23,33 +23,36 @@ module Skooma
 
         def request_object
           # `rails` integration
-          return request if defined?(::ActionDispatch)
+          return @request if defined?(::ActionDispatch) && @request.is_a?(::ActionDispatch::Request)
           # `rack-test` integration
-          return last_request if defined?(::Rack::Test)
+          return last_request if defined?(::Rack::Test) && defined?(:last_request)
 
           raise "Request object not found"
         end
 
         def response_object
           # `rails` integration
-          return response if defined?(::ActionDispatch)
+          return @response if defined?(::ActionDispatch) && @response.is_a?(::ActionDispatch::Response)
           # `rack-test` integration
-          return last_response if defined?(::Rack::Test)
+          return last_response if defined?(::Rack::Test) && defined?(:last_response)
 
           raise "Response object not found"
         end
       end
 
-      def initialize(helper_methods_module, openapi_path, base_uri: "https://skoomarb.dev/")
+      def initialize(helper_methods_module, openapi_path, base_uri: "https://skoomarb.dev/", path_prefix: "")
         super()
 
         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
         include helper_methods_module

data/lib/skooma/objects/openapi/keywords/paths.rb

@@ -32,7 +32,7 @@ module Skooma
               subresult.annotate({"path_attributes" => attributes})
               path_schema.evaluate(instance, subresult)
 
-              if subresult.passed?
+              if subresult.passed? && subresult.children.any?
                 result.success
               else
                 result.failure("Path #{instance["path"]} is invalid")
@@ -43,6 +43,7 @@ module Skooma
           private
 
           def find_route(instance_path)
+            instance_path = instance_path.delete_prefix(json.root.path_prefix)
             return [instance_path, {}, json[instance_path]] if json.key?(instance_path)
 
             @regexp_map.reduce(nil) do |result, (path, path_regex, subschema)|

data/lib/skooma/objects/openapi.rb

@@ -31,6 +31,18 @@ module Skooma
         super(Instance.new(instance), result)
       end
 
+      def path_prefix=(value)
+        raise ArgumentError, "Path prefix must be a string" unless value.is_a?(String)
+
+        @path_prefix = value
+        @path_prefix = "/#{@path_prefix}" unless @path_prefix.start_with?("/")
+        @path_prefix = @path_prefix.delete_suffix("/") if @path_prefix.end_with?("/")
+      end
+
+      def path_prefix
+        @path_prefix || ""
+      end
+
       def json_schema_dialect_uri
         @json_schema_dialect_uri || parent_schema&.json_schema_dialect_uri
       end

data/lib/skooma/objects/operation/keywords/parameters.rb

@@ -12,7 +12,7 @@ module Skooma
           def initialize(parent_schema, value)
             super
             keys = json.filter_map { |v| v["in"] && [v["in"].value, v["name"].value] }
-            parent_params = (parent_schema.parent["parameters"] || [])
+            parent_params = parent_schema.parent["parameters"] || []
             parent_params.reject! do |v|
               v["in"] && keys.include?([v["in"].value, v["name"].value])
             end

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/objects/path_item/keywords/base_operation.rb

@@ -8,6 +8,10 @@ module Skooma
           def evaluate(instance, result)
             return result.discard unless instance["method"] == key
 
+            if json["responses"].nil? && instance["response"]
+              return result.failure("Responses are not listed for #{key.upcase} #{instance["path"]}")
+            end
+
             json.evaluate(instance, result)
             return result.success if result.passed?
 

data/lib/skooma/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: skooma
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.3
 platform: ruby
 authors:
 - Svyatoslav Kryukov
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-10-23 00:00:00.000000000 Z
+date: 2024-01-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: zeitwerk
@@ -30,15 +30,15 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.2'
+        version: 0.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.2'
-description: I bring some sugar for your APIs.
+        version: 0.2.0
+description: Apply a documentation-first approach to API development.
 email:
 - me@skryukov.dev
 executables: []
@@ -166,5 +166,5 @@ requirements: []
 rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
-summary: I bring some sugar for your APIs.
+summary: Validate API implementations against OpenAPI documents.
 test_files: []