openapi_contracts 0.13.0 → 0.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2e3c770fbbdd4c6d8a18f69f9deaf65959ce70088232ad8291a5aa10bf4b6f0e
-  data.tar.gz: 2248125b3e18a71d403f72b25eae01c2173628f0c58deaf7e004d501cb7f9b16
+  metadata.gz: 6a860586af31ca0bcf61a9301dba60df4466d367a495efbb306498eb71496f09
+  data.tar.gz: d74042e38633c207a4410ba6e961e68ed206f4b9d3a0d1fe0ea8d8aa1f4f4982
 SHA512:
-  metadata.gz: 64d09afded34921b66bd12573998906882681cf68e62c277abb1f569afa3da93e856240877e9edffa1768c14d7a9766de0a9be57bf9f40a0b443c366187f8813
-  data.tar.gz: 3b93196eaaf631d853d693a6082b19399b2db334190cd0bc7d8d27d80ddf67260556249f284c515fb6c0bf207d9d6599a916a2bfbccdbb4c40d6637ae08004fd
+  metadata.gz: 0bdddf66b9418f3374179566ebccfa5d7abad647708557ce5ec176afe620cbfcf79102743ffff6d293503278eeaccd8465e0a8627ff03b646b44c2c0aeb7e8f4
+  data.tar.gz: 9c0e8a0ba61f44bb8bde129524531a7a60918c9ff5fc23072c3d547a23a70ae45ef1e1a0983dc48b0ff2f57c8caf4e5998b5c80088d08aa645c99ccc0ed9acf6

data/README.md

@@ -62,6 +62,12 @@ it { is_expected.to match_openapi_doc($doc, path: '/messages/{id}').with_http_st
 it { is_expected.to match_openapi_doc($doc, request_body: true).with_http_status(:created) }
 ```
 
+* `parameters` can be set to `true` to validate request parameters against the parameter definitions
+
+```ruby
+it { is_expected.to match_openapi_doc($doc, parameters: true) }
+```
+
 Both options can as well be used simultaneously.
 
 ### Without RSpec

data/lib/openapi_contracts/doc/parameter.rb

@@ -14,33 +14,34 @@ module OpenapiContracts
       @in == 'path'
     end
 
+    def in_query?
+      @in == 'query'
+    end
+
     def matches?(value)
-      case @spec.dig('schema', 'type')
-      when 'integer'
-        integer_parameter_matches?(value)
-      when 'number'
-        number_parameter_matches?(value)
-      else
-        schemer.valid?(value)
-      end
+      errors = schemer.validate(convert_value(value))
+      # debug errors.to_a here
+      errors.none?
     end
 
-    private
+    def required?
+      @required == true
+    end
 
-    def schemer
-      @schemer ||= Validators::SchemaValidation.validation_schemer(@spec.navigate('schema'))
+    def schema_for_validation
+      @spec.navigate('schema')
     end
 
-    def integer_parameter_matches?(value)
-      return false unless /^-?\d+$/.match?(value)
+    private
 
-      schemer.valid?(value.to_i)
+    def convert_value(original)
+      OpenapiParameters::Converter.convert(original, schema_for_validation)
+    rescue StandardError
+      original
     end
 
-    def number_parameter_matches?(value)
-      return false unless /^-?(\d+\.)?\d+$/.match?(value)
-
-      schemer.valid?(value.to_f)
+    def schemer
+      @schemer ||= Validators::SchemaValidation.validation_schemer(schema_for_validation)
     end
   end
 end

data/lib/openapi_contracts/doc.rb

@@ -35,20 +35,20 @@ module OpenapiContracts
     end
 
     # Returns an Enumerator over all Operations
-    def operations(&block) # rubocop:disable Naming/BlockForwarding
+    def operations(&block)
       return enum_for(:operations) unless block_given?
 
       paths.each do |path|
-        path.operations.each(&block) # rubocop:disable Naming/BlockForwarding
+        path.operations.each(&block)
       end
     end
 
     # Returns an Enumerator over all Responses
-    def responses(&block) # rubocop:disable Naming/BlockForwarding
+    def responses(&block)
       return enum_for(:responses) unless block_given?
 
       operations.each do |operation|
-        operation.responses.each(&block) # rubocop:disable Naming/BlockForwarding
+        operation.responses.each(&block)
       end
     end
 

data/lib/openapi_contracts/match.rb

@@ -1,6 +1,9 @@
 module OpenapiContracts
   class Match
-    DEFAULT_OPTIONS = {request_body: false}.freeze
+    DEFAULT_OPTIONS = {
+      parameters:   false,
+      request_body: false
+    }.freeze
     MIN_REQUEST_ANCESTORS = %w(Rack::Request::Env Rack::Request::Helpers).freeze
     MIN_RESPONSE_ANCESTORS = %w(Rack::Response::Helpers).freeze
 
@@ -42,6 +45,7 @@ module OpenapiContracts
       )
       validators = Validators::ALL.dup
       validators.delete(Validators::HttpStatus) unless @options[:status]
+      validators.delete(Validators::Parameters) unless @options[:parameters]
       validators.delete(Validators::RequestBody) unless @options[:request_body]
       validators.reverse
                 .reduce(->(err) { err }) { |s, m| m.new(s, env) }

data/lib/openapi_contracts/parser.rb

@@ -30,7 +30,7 @@ module OpenapiContracts
     # file list consists of
     # - root file
     # - all files in components/
-    # - all path files referenced by the root file
+    # - all path & webhook files referenced by the root file
     def build_file_list
       list = {@rootfile.relative_path_from(@cwd) => Doc::Pointer[]}
       Dir[File.expand_path('components/**/*.yaml', @cwd)].each do |file|
@@ -38,16 +38,21 @@ module OpenapiContracts
         pointer = Doc::Pointer.from_path pathname.sub_ext('')
         list.merge! pathname => pointer
       end
-      YAML.safe_load_file(@rootfile).fetch('paths') { {} }.each_pair do |k, v|
-        next unless v['$ref'] && !v['$ref'].start_with?('#')
+      rootdata = YAML.safe_load_file(@rootfile)
+      %w(paths webhooks).each do |name|
+        rootdata.fetch(name) { {} }.each_pair do |k, v|
+          next unless v['$ref'] && !v['$ref'].start_with?('#')
 
-        list.merge! Pathname(v['$ref']).cleanpath => Doc::Pointer['paths', k]
+          list.merge! Pathname(v['$ref']).cleanpath => Doc::Pointer[name, k]
+        end
       end
       list
     end
 
     def file_to_data(pathname, pointer)
       YAML.safe_load_file(@cwd.join(pathname)).tap do |data|
+        break {} unless data.present?
+
         transform_objects!(data, pathname.parent, pointer)
       end
     end

data/lib/openapi_contracts/validators/parameters.rb

@@ -0,0 +1,21 @@
+module OpenapiContracts::Validators
+  # Validates the input parameters, eg path/url parameters
+  class Parameters < Base
+    include SchemaValidation
+
+    private
+
+    def validate
+      operation.parameters.select(&:in_query?).each do |parameter|
+        if request.GET.key?(parameter.name)
+          value = request.GET[parameter.name]
+          unless parameter.matches?(value)
+            @errors << "#{value.inspect} is not a valid value for the query parameter #{parameter.name.inspect}"
+          end
+        elsif parameter.required?
+          @errors << "Missing query parameter #{parameter.name.inspect}"
+        end
+      end
+    end
+  end
+end

data/lib/openapi_contracts/validators.rb

@@ -4,6 +4,7 @@ module OpenapiContracts
     autoload :Documented,       'openapi_contracts/validators/documented'
     autoload :Headers,          'openapi_contracts/validators/headers'
     autoload :HttpStatus,       'openapi_contracts/validators/http_status'
+    autoload :Parameters,       'openapi_contracts/validators/parameters'
     autoload :RequestBody,      'openapi_contracts/validators/request_body'
     autoload :ResponseBody,     'openapi_contracts/validators/response_body'
     autoload :SchemaValidation, 'openapi_contracts/validators/schema_validation'
@@ -12,6 +13,7 @@ module OpenapiContracts
     ALL = [
       Documented,
       HttpStatus,
+      Parameters,
       RequestBody,
       ResponseBody,
       Headers

data/lib/openapi_contracts.rb

@@ -7,6 +7,7 @@ require 'active_support/core_ext/string'
 require 'rubygems/version'
 
 require 'json_schemer'
+require 'openapi_parameters'
 require 'rack'
 require 'yaml'
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: openapi_contracts
 version: !ruby/object:Gem::Version
-  version: 0.13.0
+  version: 0.14.0
 platform: ruby
 authors:
 - mkon
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-01-09 00:00:00.000000000 Z
+date: 2024-06-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -50,6 +50,26 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '2.2'
+- !ruby/object:Gem::Dependency
+  name: openapi_parameters
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.3.3
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.3.3
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '0.4'
 - !ruby/object:Gem::Dependency
   name: rack
   requirement: !ruby/object:Gem::Requirement
@@ -84,42 +104,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.12.0
+        version: 3.13.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.12.0
+        version: 3.13.0
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.59.0
+        version: 1.64.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.59.0
+        version: 1.64.1
 - !ruby/object:Gem::Dependency
   name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 2.25.0
+        version: 2.31.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 2.25.0
+        version: 2.31.0
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -170,6 +190,7 @@ files:
 - lib/openapi_contracts/validators/documented.rb
 - lib/openapi_contracts/validators/headers.rb
 - lib/openapi_contracts/validators/http_status.rb
+- lib/openapi_contracts/validators/parameters.rb
 - lib/openapi_contracts/validators/request_body.rb
 - lib/openapi_contracts/validators/response_body.rb
 - lib/openapi_contracts/validators/schema_validation.rb
@@ -196,7 +217,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.22
+rubygems_version: 3.5.11
 signing_key:
 specification_version: 4
 summary: Openapi schemas as API contracts