skooma 0.2.0 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 784c4f022f60aced719808f543bcdc9a153df4a58dd44179888f73f9c7c8fa3f
-  data.tar.gz: c60b8a11cd1ccbefcc83207a0ad2734281d8e194b58fd2637dd25bd48e7577a3
+  metadata.gz: d780ea317b116a8bdafac72f240b68366cf6f2892ea671f29ed51dd48a198093
+  data.tar.gz: '078593785c8fc17c73c171616131880dbeaf1b85923e593a3612eb9b2309ff0d'
 SHA512:
-  metadata.gz: c17febaba56cd351329f42acd06a74fdbd02782ccaef3d855098cc41159ee31ef8862cba849a4591f15a6580ffe69705fc783a5ab026f52fa5eefbf55963cd8f
-  data.tar.gz: 35f93cdc5ace695d8e3bf7f315a573e9498e1799fb4bbd9f012d097b7b04ea0a3626b57239e67fbf49a5193d07947aa7c671543630353b10401a16bc66fb0625
+  metadata.gz: f16cb70ad584c45615c4c376ebbab69e48caca0daa32c687d55c9c96453b3a608096afeedc45a7286e0e4ace4c2dc500c2d36ed013d0b951d915b60bbba42a63
+  data.tar.gz: c301176ff04134e0e6d18c57e4e0ced55f1dca82d8ff807eefa820cc02f8227101275ccf43b4e3b60c6716b19d7da94f714da37435f417995e97faf44f2b20d3

data/CHANGELOG.md

@@ -7,6 +7,39 @@ and this project adheres to [Semantic Versioning].
 
 ## [Unreleased]
 
+## [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
+
+- Raise error when parameter attributes misses required keys. ([@skryukov])
+- Fix output format. ([@skryukov])
+
 ## [0.2.0] - 2023-10-23
 
 ### Added
@@ -26,7 +59,9 @@ and this project adheres to [Semantic Versioning].
 
 [@skryukov]: https://github.com/skryukov
 
-[Unreleased]: https://github.com/skryukov/skooma/compare/v0.2.0...HEAD
+[Unreleased]: https://github.com/skryukov/skooma/compare/v0.2.2...HEAD
+[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/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,24 +23,24 @@ 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
@@ -50,6 +50,7 @@ module Skooma
           JSONSkooma::Sources::Local.new(pathname.dirname.to_s)
         )
         schema = registry.schema(URI.parse("#{base_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/value_parser.rb

@@ -9,9 +9,11 @@ module Skooma
         module ValueParser
           class << self
             def call(instance, result)
-              type = result.sibling(instance, "in").annotation
-              key = result.sibling(instance, "name").annotation
-              raise Error, "Missing key: #{key}" unless key
+              type = result.sibling(instance, "in")&.annotation
+              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
 
               case type
               when "query"
@@ -30,7 +32,7 @@ module Skooma
               when "cookie"
                 # instance["headers"]["Cookie"]
               else
-                raise Error, "Unknown location: #{result.sibling(instance, "in").annotation}"
+                raise Error, "Unknown location: #{type}"
               end
             end
 

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/output_format.rb

@@ -18,8 +18,9 @@ module Skooma
           "keywordLocation" => node.path.to_s
         }
 
-        child_data = node.children.filter_map do |_, child|
-          node_data(child) unless child.valid?
+        child_data = []
+        node.each_children do |child|
+          child_data << node_data(child) unless child.valid?
         end
 
         if first || child_data.length > 1

data/lib/skooma/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: skooma
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.2
 platform: ruby
 authors:
 - Svyatoslav Kryukov
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-10-22 00:00:00.000000000 Z
+date: 2024-01-04 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: []