skooma 0.3.3 → 0.3.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 76912cb6b09166983cae2e1e03a104d16351116d2076e3c0b27e24491002a89b
-  data.tar.gz: 65f728f3eda604da0eb7750f7f6cad612cd98870626c8fc766c1554336a6efe1
+  metadata.gz: 44e41865174e5bfeb3bf254ed74bb980aaa5d6aea0ca937fbea38b36242ac2ca
+  data.tar.gz: 0b692735b5e0cd2e079b6a7d804b20c53d5069f5e6ed700117fb825f341e71a9
 SHA512:
-  metadata.gz: 2253d20d61746403cd726d47092ba45c7614a283a1af9becfea8fcf387bcd1c9f6f4d52b48efd6ebd7284df52ac5ac944958f6997011f9b8da0b6602d5c21f0d
-  data.tar.gz: 9b220779384f848d308708a1ccd704314ca98d8a3ffc9683fe03962f10a997bc6465835e495638a83a2f955d19191a330e524050deef0345c858255421d2fd1c
+  metadata.gz: 2cbc3a15cf9640bb7bb5614d3b1610db5742218612168f873b74fc9343c1a20855e7a7809bdc3f0da7797071fedf5651057bd7a98fa0b29834e85eed4c453295
+  data.tar.gz: 24717dabd2a57266162aa5827075e7c5c97d8d387faf782549887f1c0fc5383b4109679283f62320f45b01e8a6e6860bab66214e4e30224096ee1267b3b0dc3b

data/CHANGELOG.md

@@ -7,6 +7,22 @@ and this project adheres to [Semantic Versioning].
 
 ## [Unreleased]
 
+## [0.3.4] - 2025-01-14
+
+### Added
+
+- Experimental support for `readOnly` and `writeOnly` keywords. ([@skryukov])
+
+    ```ruby
+    # spec/rails_helper.rb
+    
+    RSpec.configure do |config|
+      # To enable support for readOnly and writeOnly keywords, pass `enforce_access_modes: true` option:
+      config.include Skooma::RSpec[Rails.root.join("docs", "openapi.yml"), enforce_access_modes: true], type: :request
+    end
+    ```
+- Support fallback parsers for vendor-specific media types. ([@pvcarrera], [@skryukov])
+
 ## [0.3.3] - 2024-10-14
 
 ### Fixed
@@ -125,10 +141,12 @@ and this project adheres to [Semantic Versioning].
 - Initial implementation. ([@skryukov])
 
 [@barnaclebarnes]: https://github.com/barnaclebarnes
+[@pvcarrera]: https://github.com/pvcarrera
 [@skryukov]: https://github.com/skryukov
 [@ursm]: https://github.com/ursm
 
-[Unreleased]: https://github.com/skryukov/skooma/compare/v0.3.3...HEAD
+[Unreleased]: https://github.com/skryukov/skooma/compare/v0.3.4...HEAD
+[0.3.4]: https://github.com/skryukov/skooma/compare/v0.3.3...v0.3.4
 [0.3.3]: https://github.com/skryukov/skooma/compare/v0.3.2...v0.3.3
 [0.3.2]: https://github.com/skryukov/skooma/compare/v0.3.1...v0.3.2
 [0.3.1]: https://github.com/skryukov/skooma/compare/v0.3.0...v0.3.1

data/README.md

@@ -128,6 +128,10 @@ ActionDispatch::IntegrationTest.include Skooma::Minitest[path_to_openapi, path_p
 # To enable coverage, pass `coverage: :report` option,
 # and to raise an error when an operation is not covered, pass `coverage: :strict` option:
 ActionDispatch::IntegrationTest.include Skooma::Minitest[path_to_openapi, coverage: :report], type: :request
+
+# EXPERIMENTAL
+# To enable support for readOnly and writeOnly keywords, pass `enforce_access_modes: true` option:
+ActionDispatch::IntegrationTest.include Skooma::Minitest[path_to_openapi, enforce_access_modes: true], type: :request
 ```
 
 #### Validate OpenAPI document

data/lib/skooma/body_parsers.rb

@@ -6,16 +6,38 @@ module Skooma
       DEFAULT_PARSER = ->(body, **_options) { body }
 
       def [](media_type)
-        parsers[media_type.to_s.strip.downcase] || DEFAULT_PARSER
+        key = normalize_media_type(media_type)
+        parsers[key] ||
+          find_suffix_parser(key) ||
+          find_fallback_parser(key) ||
+          DEFAULT_PARSER
       end
 
       attr_accessor :parsers
 
       def register(*media_types, parser)
         media_types.each do |media_type|
-          parsers[media_type.to_s.strip.downcase] = parser
+          parsers[normalize_media_type(media_type)] = parser
         end
       end
+
+      private
+
+      def normalize_media_type(media_type)
+        media_type.to_s.strip.downcase
+      end
+
+      def find_suffix_parser(media_type)
+        return unless media_type.include?("+")
+
+        suffix = media_type.split("+").last
+        parsers["application/#{suffix}"]
+      end
+
+      def find_fallback_parser(media_type)
+        type = media_type.split("/").first
+        parsers["#{type}/*"] || parsers["*/*"]
+      end
     end
     self.parsers = {}
 

data/lib/skooma/dialects/oas_3_1.rb

@@ -16,6 +16,9 @@ module Skooma
             Skooma::Keywords::OAS31::Dialect::OneOf,
             Skooma::Keywords::OAS31::Dialect::Discriminator,
             Skooma::Keywords::OAS31::Dialect::Xml,
+            Skooma::Keywords::OAS31::Dialect::Properties,
+            Skooma::Keywords::OAS31::Dialect::AdditionalProperties,
+            Skooma::Keywords::OAS31::Dialect::Required,
             Skooma::Keywords::OAS31::Dialect::ExternalDocs,
             Skooma::Keywords::OAS31::Dialect::Example
           )

data/lib/skooma/keywords/oas_3_1/dialect/additional_properties.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+module Skooma
+  module Keywords
+    module OAS31
+      module Dialect
+        class AdditionalProperties < JSONSkooma::Keywords::Applicator::AdditionalProperties
+          self.key = "additionalProperties"
+          self.instance_types = "object"
+          self.value_schema = :schema
+          self.depends_on = %w[properties patternProperties]
+
+          def evaluate(instance, result)
+            known_property_names = result.sibling(instance, "properties")&.schema_node&.keys || []
+            known_property_patterns = (result.sibling(instance, "patternProperties")&.schema_node&.keys || [])
+              .map { |pattern| Regexp.new(pattern) }
+
+            forbidden = []
+
+            if json.root.enforce_access_modes?
+              only_key = result.path.include?("responses") ? "writeOnly" : "readOnly"
+              properties_result = result.sibling(instance, "properties")
+              instance.each_key do |name|
+                res = properties_result&.children&.[](instance[name]&.path)&.[]name
+                forbidden << name.tap { puts "adding #{name}" } if annotation_exists?(res, key: only_key)
+              end
+            end
+
+            annotation = []
+            error = []
+
+            instance.each do |name, item|
+              if forbidden.include?(name) || !known_property_names.include?(name) && known_property_patterns.none? { |pattern| pattern.match?(name) }
+                if json.evaluate(item, result).passed?
+                  annotation << name
+                else
+                  error << name
+                  # reset to success for the next iteration
+                  result.success
+                end
+              end
+            end
+            return result.annotate(annotation) if error.empty?
+
+            result.failure(error)
+          end
+
+          private
+
+          def annotation_exists?(result, key:)
+            return result if result.key == key && result.annotation
+
+            result.each_children do |child|
+              return child if annotation_exists?(child, key: key)
+            end
+
+            nil
+          end
+        end
+      end
+    end
+  end
+end

data/lib/skooma/keywords/oas_3_1/dialect/properties.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module Skooma
+  module Keywords
+    module OAS31
+      module Dialect
+        class Properties < JSONSkooma::Keywords::Applicator::Properties
+          self.key = "properties"
+          self.instance_types = "object"
+          self.value_schema = :object_of_schemas
+
+          def evaluate(instance, result)
+            annotation = []
+            err_names = []
+            instance.each do |name, item|
+              next unless json.value.key?(name)
+
+              result.call(item, name) do |subresult|
+                json[name].evaluate(item, subresult)
+                if ignored_with_only_key?(subresult)
+                  subresult.discard
+                elsif subresult.passed?
+                  annotation << name
+                else
+                  err_names << name
+                end
+              end
+            end
+
+            return result.annotate(annotation) if err_names.empty?
+
+            result.failure("Properties #{err_names.join(", ")} are invalid")
+          end
+
+          private
+
+          def ignored_with_only_key?(subresult)
+            return false unless json.root.enforce_access_modes?
+
+            if subresult.parent.path.include?("responses")
+              subresult.children["readOnly"]&.value == true
+            else
+              subresult.children["writeOnly"]&.value == true
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/skooma/keywords/oas_3_1/dialect/required.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module Skooma
+  module Keywords
+    module OAS31
+      module Dialect
+        class Required < JSONSkooma::Keywords::Validation::Required
+          self.key = "required"
+          self.instance_types = "object"
+          self.depends_on = %w[properties]
+
+          def evaluate(instance, result)
+            missing = required_keys.reject { |key| instance.key?(key) }
+            return if missing.none?
+
+            if json.root.enforce_access_modes?
+              properties_schema = result.sibling(instance, "properties")&.schema_node || {}
+              only_key = result.path.include?("responses") ? "writeOnly" : "readOnly"
+              ignore = []
+              missing.each do |name|
+                next unless properties_schema.key?(name)
+
+                result.call(nil, name) do |subresult|
+                  properties_schema[name].evaluate(nil, subresult)
+                  ignore << name if annotation_exists?(subresult, key: only_key)
+                  subresult.discard
+                end
+              end
+
+              return if (missing - ignore).none?
+            end
+
+            result.failure(missing_keys_message(missing))
+          end
+
+          private
+
+          def annotation_exists?(result, key:)
+            return result if result.key == key && result.annotation
+
+            result.each_children do |child|
+              return child if annotation_exists?(child, key: key)
+            end
+
+            nil
+          end
+        end
+      end
+    end
+  end
+end

data/lib/skooma/matchers/wrapper.rb

@@ -44,7 +44,7 @@ module Skooma
         end
       end
 
-      def initialize(helper_methods_module, openapi_path, base_uri: "https://skoomarb.dev/", path_prefix: "", **params)
+      def initialize(helper_methods_module, openapi_path, base_uri: "https://skoomarb.dev/", path_prefix: "", enforce_access_modes: false, **params)
         super()
 
         registry = create_test_registry
@@ -57,6 +57,7 @@ module Skooma
         )
         @schema = registry.schema(URI.parse("#{source_uri}#{pathname.basename}"), schema_class: Skooma::Objects::OpenAPI)
         @schema.path_prefix = path_prefix
+        @schema.enforce_access_modes = enforce_access_modes
 
         @coverage = Coverage.new(@schema, mode: params[:coverage], format: params[:coverage_format])
 

data/lib/skooma/objects/openapi.rb

@@ -39,6 +39,16 @@ module Skooma
         @path_prefix = @path_prefix.delete_suffix("/") if @path_prefix.end_with?("/")
       end
 
+      def enforce_access_modes=(value)
+        raise ArgumentError, "Enforce access modes must be a boolean" unless [true, false].include?(value)
+
+        @enforce_access_modes = value
+      end
+
+      def enforce_access_modes?
+        @enforce_access_modes
+      end
+
       def path_prefix
         @path_prefix || ""
       end

data/lib/skooma/version.rb

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

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: skooma
 version: !ruby/object:Gem::Version
-  version: 0.3.3
+  version: 0.3.4
 platform: ruby
 authors:
 - Svyatoslav Kryukov
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-10-14 00:00:00.000000000 Z
+date: 2025-01-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: zeitwerk
@@ -30,14 +29,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.0
+        version: 0.2.5
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.0
+        version: 0.2.5
 description: Apply a documentation-first approach to API development.
 email:
 - me@skryukov.dev
@@ -60,11 +59,14 @@ files:
 - lib/skooma/inflector.rb
 - lib/skooma/instance.rb
 - lib/skooma/keywords/oas_3_1.rb
+- lib/skooma/keywords/oas_3_1/dialect/additional_properties.rb
 - lib/skooma/keywords/oas_3_1/dialect/any_of.rb
 - lib/skooma/keywords/oas_3_1/dialect/discriminator.rb
 - lib/skooma/keywords/oas_3_1/dialect/example.rb
 - lib/skooma/keywords/oas_3_1/dialect/external_docs.rb
 - lib/skooma/keywords/oas_3_1/dialect/one_of.rb
+- lib/skooma/keywords/oas_3_1/dialect/properties.rb
+- lib/skooma/keywords/oas_3_1/dialect/required.rb
 - lib/skooma/keywords/oas_3_1/dialect/xml.rb
 - lib/skooma/keywords/oas_3_1/schema.rb
 - lib/skooma/matchers/be_valid_document.rb
@@ -149,7 +151,6 @@ metadata:
   homepage_uri: https://github.com/skryukov/skooma
   source_code_uri: https://github.com/skryukov/skooma
   rubygems_mfa_required: 'true'
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -164,8 +165,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.17
-signing_key:
+rubygems_version: 3.6.2
 specification_version: 4
 summary: Validate API implementations against OpenAPI documents.
 test_files: []