openapi_contracts 0.7.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 56248ce2cb1b1a67d4cf1d7390a9815bb9f20a3b9b488e0dd116aa994f8bd9a0
-  data.tar.gz: a6a8df4841e768c0905bad6699ef0d9295221dad637e5ef8a01c35bb9442a8f0
+  metadata.gz: 25a37c81bfa9cb9d1d26f26a25b7c81f0675a153c199223639bdd48c76537cb6
+  data.tar.gz: 48529ed541f4ad72568d222d2a57e30ef7f1a7b5e59fbb447961a58d57eafe26
 SHA512:
-  metadata.gz: 578b3ef8c71e5a19667e34e2791be7051693d198bf62dfcdaa8b9fc09403cbe54bc12af266c61103eb743a32a8ea0f88552d6eefeecba7ca14d55a3868f0deb8
-  data.tar.gz: 07c76b46bd842bfb5aa60e9af6cf30a2a45185b682e841183624c222580b3022c7b19239bb2b081a0ae9eedbab365ce78ec55bd4a76e5ba02b9d120fd2a6d853
+  metadata.gz: 1cc4ee62cea4e015834ae6a493bc771f13670b553cfdc1085b7dac79ea5a347583786ec4cd1db31c9054d88a010dd5d779c64f13df4388a3f55a3eae07ef577a
+  data.tar.gz: 9991124beb074d92107b1026e6ffd529cca988d8154eac6c6cc92aa5103df5de11cf917d1809545e26810de07959202f295a5d23a1a15077e639d2212bbc6286

data/README.md

@@ -47,8 +47,9 @@ it 'responds with 200 and matches the doc' do
 
 The `match_openapi_doc($doc)` method allows passing options as a 2nd argument.
 This allows overriding the default request.path lookup in case this does not find
-the correct response definition in your schema. This is especially important with
-dynamic paths.
+the correct response definition in your schema. This can be usefull when there is
+dynamic parameters in the path and the matcher fails to resolve the request path to
+an endpoint in the openapi specification.
 
 Example:
 
@@ -67,7 +68,9 @@ raise result.errors.merge("/n") unless result.valid?
 
 ### How it works
 
-It uses the `request.path`, `request.method`, `status` and `headers` on the test subject (which must be the response) to find the response schema in the OpenAPI document. Then it does the following checks:
+It uses the `request.path`, `request.method`, `status` and `headers` on the test subject
+(which must be the response) to find the response schema in the OpenAPI document.
+Then it does the following checks:
 
 * The response is documented
 * Required headers are present

data/lib/openapi_contracts/doc/file_parser.rb

@@ -10,13 +10,14 @@ module OpenapiContracts
       end
     end
 
-    def self.parse(root, pathname)
-      new(root, pathname).call
+    def self.parse(rootfile, pathname)
+      new(rootfile, pathname).call
     end
 
-    def initialize(root, pathname)
-      @root = root
-      @pathname = pathname.relative? ? root.join(pathname) : pathname
+    def initialize(rootfile, pathname)
+      @root = rootfile.parent
+      @rootfile = rootfile
+      @pathname = pathname.relative? ? @root.join(pathname) : pathname
     end
 
     def call
@@ -57,11 +58,11 @@ module OpenapiContracts
     def transform_pointer(key, target)
       if %r{^#/(?<pointer>.*)} =~ target
         # A JSON Pointer
-        {key => "#/#{@pathname.relative_path_from(@root).sub_ext('').join(pointer)}"}
+        {key => generate_absolute_pointer(pointer)}
       elsif %r{^(?<relpath>[^#]+)(?:#/(?<pointer>.*))?} =~ target
         if relpath.start_with?('paths') # path description file pointer
           # Inline the file contents
-          self.class.parse(@root, Pathname(relpath)).data
+          self.class.parse(@rootfile, Pathname(relpath)).data
         else # A file pointer with potential JSON sub-pointer
           tgt = @pathname.parent.relative_path_from(@root).join(relpath).sub_ext('')
           tgt = tgt.join(pointer) if pointer
@@ -71,5 +72,14 @@ module OpenapiContracts
         {key => target}
       end
     end
+
+    # A JSON pointer to the currently parsed file as seen from the root openapi file
+    def generate_absolute_pointer(json_pointer)
+      if @rootfile == @pathname
+        "#/#{json_pointer}"
+      else
+        "#/#{@pathname.relative_path_from(@root).sub_ext('').join(json_pointer)}"
+      end
+    end
   end
 end

data/lib/openapi_contracts/doc/parameter.rb

@@ -0,0 +1,86 @@
+module OpenapiContracts
+  class Doc::Parameter
+    attr_reader :schema
+
+    def initialize(options)
+      @name = options[:name]
+      @in = options[:in]
+      @required = options[:required]
+      @schema = options[:schema]
+    end
+
+    def matches?(value)
+      case schema['type']
+      when 'integer'
+        integer_parameter_matches?(value)
+      when 'number'
+        number_parameter_matches?(value)
+      when 'string'
+        string_parameter_matches?(value)
+      else
+        # Not yet implemented
+        false
+      end
+    end
+
+    private
+
+    def integer_parameter_matches?(value)
+      return false unless /^-?\d+$/.match?(value)
+
+      parsed = value.to_i
+      return false unless minimum_number_matches?(parsed)
+      return false unless maximum_number_matches?(parsed)
+
+      true
+    end
+
+    def number_parameter_matches?(value)
+      return false unless /^-?(\d+\.)?\d+$/.match?(value)
+
+      parsed = value.to_f
+      return false unless minimum_number_matches?(parsed)
+      return false unless maximum_number_matches?(parsed)
+
+      true
+    end
+
+    def minimum_number_matches?(value)
+      if (min = schema['minimum'])
+        if schema['exclusiveMinimum']
+          return false if value <= min
+        elsif value < min
+          return false
+        end
+      end
+      true
+    end
+
+    def maximum_number_matches?(value)
+      if (max = schema['maximum'])
+        if schema['exclusiveMaximum']
+          return false if value >= max
+        elsif value > max
+          return false
+        end
+      end
+      true
+    end
+
+    def string_parameter_matches?(value)
+      if (pat = schema['pattern'])
+        Regexp.new(pat).match?(value)
+      else
+        if (min = schema['minLength']) && (value.length < min)
+          return false
+        end
+
+        if (max = schema['maxLength']) && (value.length > max)
+          return false
+        end
+
+        true
+      end
+    end
+  end
+end

data/lib/openapi_contracts/doc/parser.rb

@@ -1,27 +1,27 @@
 module OpenapiContracts
   class Doc::Parser
     def self.call(dir, filename)
-      new(dir).parse(filename)
+      new(dir.join(filename)).parse
     end
 
-    def initialize(dir)
-      @dir = dir
+    def initialize(rootfile)
+      @rootfile = rootfile
     end
 
-    def parse(path)
-      abs_path = @dir.join(path)
-      file = Doc::FileParser.parse(@dir, abs_path)
+    def parse
+      file = Doc::FileParser.parse(@rootfile, @rootfile)
       data = file.data
       data.deep_merge! merge_components
       nullable_to_type!(data)
+      # debugger
     end
 
     private
 
     def merge_components
       data = {}
-      Dir[File.expand_path('components/**/*.yaml', @dir)].each do |file|
-        result = Doc::FileParser.parse(@dir, Pathname(file))
+      Dir[File.expand_path('components/**/*.yaml', @rootfile.parent)].each do |file|
+        result = Doc::FileParser.parse(@rootfile, Pathname(file))
         data.deep_merge!(result.to_mergable_hash)
       end
       data

data/lib/openapi_contracts/doc/path.rb

@@ -1,18 +1,61 @@
 module OpenapiContracts
   class Doc::Path
-    def initialize(schema)
+    def initialize(path, schema)
+      @path = path
       @schema = schema
-      @methods = @schema.to_h do |method, _|
+
+      @methods = (known_http_methods & @schema.keys).to_h do |method|
         [method, Doc::Method.new(@schema.navigate(method))]
       end
     end
 
+    def dynamic?
+      @path.include?('{')
+    end
+
+    def matches?(path)
+      @path == path || regexp_path.match(path) do |m|
+        m.named_captures.each do |k, v|
+          return false unless parameter_matches?(k, v)
+        end
+        true
+      end
+    end
+
     def methods
       @methods.each_value
     end
 
+    def static?
+      !dynamic?
+    end
+
     def with_method(method)
       @methods[method]
     end
+
+    private
+
+    def parameter_matches?(name, value)
+      parameter = @schema['parameters']
+        &.find { |p| p['name'] == name && p['in'] == 'path' }
+        &.then { |s| Doc::Parameter.new(s.with_indifferent_access) }
+
+      return false unless parameter
+
+      parameter.matches?(value)
+    end
+
+    def regexp_path
+      re = /\{(\S+)\}/
+      @path.gsub(re) { |placeholder|
+        placeholder.match(re) { |m| "(?<#{m[1]}>[^/]*)" }
+      }.then { |str| Regexp.new(str) }
+    end
+
+    def known_http_methods
+      # https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods
+      %w(get head post put delete connect options trace patch).freeze
+    end
   end
 end

data/lib/openapi_contracts/doc/schema.rb

@@ -26,7 +26,7 @@ module OpenapiContracts
       pointer.map { |p| p.gsub('/', '~1') }.join('/').then { |s| "#/#{s}" }
     end
 
-    delegate :dig, :fetch, :key?, :[], :to_h, to: :as_h
+    delegate :dig, :fetch, :keys, :key?, :[], :to_h, to: :as_h
 
     def at_pointer(pointer)
       self.class.new(raw, pointer)

data/lib/openapi_contracts/doc.rb

@@ -4,6 +4,7 @@ module OpenapiContracts
     autoload :FileParser, 'openapi_contracts/doc/file_parser'
     autoload :Method,     'openapi_contracts/doc/method'
     autoload :Parser,     'openapi_contracts/doc/parser'
+    autoload :Parameter,  'openapi_contracts/doc/parameter'
     autoload :Path,       'openapi_contracts/doc/path'
     autoload :Response,   'openapi_contracts/doc/response'
     autoload :Schema,     'openapi_contracts/doc/schema'
@@ -17,8 +18,9 @@ module OpenapiContracts
     def initialize(schema)
       @schema = Schema.new(schema)
       @paths = @schema['paths'].to_h do |path, _|
-        [path, Path.new(@schema.at_pointer(['paths', path]))]
+        [path, Path.new(path, @schema.at_pointer(['paths', path]))]
       end
+      @dynamic_paths = paths.select(&:dynamic?)
     end
 
     # Returns an Enumerator over all paths
@@ -42,7 +44,11 @@ module OpenapiContracts
     end
 
     def with_path(path)
-      @paths[path]
+      if @paths.key?(path)
+        @paths[path]
+      else
+        @dynamic_paths.find { |p| p.matches?(path) }
+      end
     end
   end
 end

data/lib/openapi_contracts/validators/body.rb

@@ -23,9 +23,9 @@ module OpenapiContracts::Validators
 
     def error_to_message(error)
       if error.key?('details')
-        error['details'].to_a.map do |(key, val)|
+        error['details'].to_a.map { |(key, val)|
           "#{key.humanize}: #{val} at #{error['data_pointer']}"
-        end.to_sentence
+        }.to_sentence
       else
         "#{error['data'].inspect} at #{error['data_pointer']} does not match the schema"
       end

data/lib/openapi_contracts.rb

@@ -1,5 +1,6 @@
 require 'active_support'
 require 'active_support/core_ext/array'
+require 'active_support/core_ext/hash'
 require 'active_support/core_ext/class'
 require 'active_support/core_ext/module'
 require 'active_support/core_ext/string'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: openapi_contracts
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.8.0
 platform: ruby
 authors:
 - mkon
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-05-31 00:00:00.000000000 Z
+date: 2023-07-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -92,14 +92,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.51.0
+        version: 1.52.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.51.0
+        version: 1.52.0
 - !ruby/object:Gem::Dependency
   name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
@@ -141,6 +141,7 @@ files:
 - lib/openapi_contracts/doc/file_parser.rb
 - lib/openapi_contracts/doc/header.rb
 - lib/openapi_contracts/doc/method.rb
+- lib/openapi_contracts/doc/parameter.rb
 - lib/openapi_contracts/doc/parser.rb
 - lib/openapi_contracts/doc/path.rb
 - lib/openapi_contracts/doc/response.rb