openapi_contracts 0.1.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 827fa48e143922260919e9a3231316f1505e34444a7b6a15051ccdb0303c1440
-  data.tar.gz: c02b963ccc67dd5c71c50843a4a517a4c90a9913b182f18c588a1b044a34992b
+  metadata.gz: '099e0e1cdfaf7938e46ba4bdcdbad4d6627d9065a5af46eb757290b27d3faed8'
+  data.tar.gz: a49babd20945272751b9609fa09ddcd7b0da35824aff3de586b059c9d465cba2
 SHA512:
-  metadata.gz: cbd07c48ee48324e0cdae9c7ea8e69defe61cdfc9c17eb4aaea396debef6d5109bbaae153cda430924d533ea415c7fc02b4a2e8c440c3ad121ca64b53aa49988
-  data.tar.gz: a5c26d7a6391f38443688a7a7d43ba785af7ed0840e651e6a60bb0dcbbc83e09e9ec0fa860a9a9f18c2b407c11b866b9e46eaad2de51b933c60a0980e78a5f37
+  metadata.gz: 192fc72178785d45bb029bd9fdd2f1a8af8f33409957375e582701f539d6e8a38715856eabda776904e9acb6d4a36b330f4872a7db1b3f335daeb456299b41f8
+  data.tar.gz: 978184d22801606c97d24926a941b5b6d61bdf08d786417df0246cd7ff5ed8321572d60554060ec0c8575ca73f56aa41784d441e154bb9b0d1064f125f9df7d6

data/README.md

@@ -1,5 +1,9 @@
 # OpenapiContracts
 
+[![Push & PR](https://github.com/mkon/openapi_contracts/actions/workflows/main.yml/badge.svg)](https://github.com/mkon/openapi_contracts/actions/workflows/main.yml)
+[![Gem Version](https://badge.fury.io/rb/openapi_contracts.svg)](https://badge.fury.io/rb/openapi_contracts)
+[![Depfu](https://badges.depfu.com/badges/8ac57411497df02584bbf59685634e45/overview.svg)](https://depfu.com/github/mkon/openapi_contracts?project_id=35354)
+
 Use openapi documentation as an api contract.
 
 Currently supports OpenAPI documentation in the structure as used by [Redocly](https://github.com/Redocly/create-openapi-repo), but should also work for single file schemas.
@@ -12,7 +16,7 @@ First parse your api documentation:
 
 ```ruby
 # This must point to the folder where the "openapi.yaml" file is
-$doc = OpenapiContracts::Doc.parse(Rails.root.join('spec', 'fixtures', 'openapi', 'api-docs', 'openapi'))
+$doc = OpenapiContracts::Doc.parse(Rails.root.join('spec/fixtures/openapi/api-docs/openapi'))
 ```
 
 Ideally you do this once in a RSpec `before(:suite)` hook.
@@ -45,8 +49,8 @@ It uses the `request.path`, `request.method`, `status` and `headers` on the test
 
 * The response is documented
 * Required headers are present
-* Documented headers match the schema (via json-schema)
-* The response body matches the schema (via json-schema)
+* Documented headers match the schema (via json_schemer)
+* The response body matches the schema (via json_schemer)
 
 ## Future plans
 

data/lib/openapi_contracts/doc/parser.rb

@@ -10,23 +10,78 @@ module OpenapiContracts
 
     def parse(path = 'openapi.yaml')
       abs_path = @dir.join(path)
-      yaml = File.read(abs_path)
-      data = YAML.safe_load(yaml)
-      join_components(abs_path.dirname, data)
+      data = parse_file(abs_path, translate: false)
+      data.deep_merge! merge_components
+      data = join_partials(abs_path.dirname, data)
+      nullable_to_type!(data)
     end
 
     private
 
-    def join_components(current_path, data)
+    def parse_file(path, translate: true)
+      schema = YAML.safe_load(File.read(path))
+      translate ? translate_paths(schema, Pathname(path).parent) : schema
+    end
+
+    def join_partials(cwd, data)
       data.each_with_object({}) do |(key, val), m|
         if val.is_a?(Hash)
-          m[key] = join_components(current_path, val)
-        elsif key == '$ref'
-          m.merge! parse(current_path.join(val))
+          m[key] = join_partials(cwd, val)
+        elsif key == '$ref' && val !~ /^#/
+          m.merge! parse_file(cwd.join(val))
         else
           m[key] = val
         end
       end
     end
+
+    def nullable_to_type!(object)
+      case object
+      when Hash
+        if object['type'] && object['nullable']
+          object['type'] = [object['type'], 'null']
+          object.delete 'nullable'
+        else
+          object.each_value { |o| nullable_to_type! o }
+        end
+      when Array
+        object.each { |o| nullable_to_type! o }
+      end
+    end
+
+    def merge_components
+      data = {}
+      Dir[File.expand_path('components/**/*.yaml', @dir)].each do |file|
+        pointer = json_pointer(Pathname(file)).split('/')
+        i = 0
+        pointer.reduce(data) do |h, p|
+          i += 1
+          if i == pointer.size
+            h[p] = parse_file(file)
+          else
+            h[p] ||= {}
+          end
+          h[p]
+        end
+      end
+      data
+    end
+
+    def translate_paths(data, cwd)
+      data.each_with_object({}) do |(key, val), m|
+        if val.is_a?(Hash)
+          m[key] = translate_paths(val, cwd)
+        elsif key == '$ref' && val !~ %r{^#/}
+          m[key] = json_pointer(cwd.join(val), '#/')
+        else
+          m[key] = val
+        end
+      end
+    end
+
+    def json_pointer(pathname, prefix = '')
+      relative = pathname.relative_path_from(@dir)
+      "#{prefix}#{relative.to_s.delete_suffix(pathname.extname)}"
+    end
   end
 end

data/lib/openapi_contracts/doc/response.rb

@@ -1,27 +1,29 @@
 module OpenapiContracts
   class Doc::Response
-    def initialize(data)
-      @data = data
+    def initialize(schema)
+      @schema = schema
     end
 
     def headers
       return @headers if instance_variable_defined? :@headers
 
-      @headers = @data.fetch('headers', {}).map do |(k, v)|
-        Doc::Header.new(k, v)
+      @headers = @schema.fetch('headers', {}).map do |(key, val)|
+        Doc::Header.new(key, val)
       end
     end
 
     def schema_for(content_type)
-      @data.dig('content', content_type, 'schema')
+      return unless supports_content_type?(content_type)
+
+      @schema.navigate('content', content_type, 'schema')
     end
 
     def no_content?
-      !@data.key? 'content'
+      !@schema.key? 'content'
     end
 
     def supports_content_type?(content_type)
-      @data.dig('content', content_type).present?
+      @schema.dig('content', content_type).present?
     end
   end
 end

data/lib/openapi_contracts/doc/schema.rb

@@ -0,0 +1,30 @@
+module OpenapiContracts
+  class Doc::Schema
+    attr_reader :path, :schema
+
+    def initialize(schema, path = nil)
+      @schema = schema
+      @path = path.freeze
+    end
+
+    def fragment
+      path.map { |p| p.gsub('/', '~1') }.join('/').then { |s| "#/#{s}" }
+    end
+
+    delegate :dig, :fetch, :key?, :[], to: :to_h
+
+    def at_path(path)
+      self.class.new(schema, path)
+    end
+
+    def to_h
+      return @schema if path.nil? || path.empty?
+
+      @schema.dig(*path)
+    end
+
+    def navigate(*sub_path)
+      self.class.new(schema, (path + Array.wrap(sub_path)))
+    end
+  end
+end

data/lib/openapi_contracts/doc.rb

@@ -3,19 +3,23 @@ module OpenapiContracts
     autoload :Header,   'openapi_contracts/doc/header'
     autoload :Parser,   'openapi_contracts/doc/parser'
     autoload :Response, 'openapi_contracts/doc/response'
+    autoload :Schema,   'openapi_contracts/doc/schema'
 
     def self.parse(dir)
       new Parser.call(dir)
     end
 
-    def initialize(spec, pointer = [])
-      @spec = spec
+    def initialize(schema)
+      @schema = Schema.new(schema)
     end
 
-    delegate :dig, :fetch, :[], to: :@spec
+    delegate :dig, :fetch, :[], :at_path, to: :@schema
 
     def response_for(path, method, status)
-      dig('paths', path, method, 'responses', status)&.then { |d| Response.new(d) }
+      path = ['paths', path, method, 'responses', status]
+      return unless dig(*path).present?
+
+      Response.new(@schema.at_path(path))
     end
   end
 end

data/lib/openapi_contracts/matchers/match_openapi_doc.rb

@@ -42,7 +42,11 @@ module OpenapiContracts
       end
 
       def response_spec
-        @response_spec ||= @doc.response_for(@response.request.path, @response.request.request_method.downcase, @response.status.to_s)
+        @response_spec ||= @doc.response_for(
+          @response.request.path,
+          @response.request.request_method.downcase,
+          @response.status.to_s
+        )
       end
 
       def response_content_type
@@ -54,8 +58,8 @@ module OpenapiContracts
           value = @response.headers[header.name]
           if value.blank?
             @errors << "Missing header #{header.name}" if header.required?
-          elsif (errors = JSON::Validator.fully_validate(header.schema, value)).any?
-            @errors << "Header #{header.name} does not match: #{errors.to_sentence}"
+          elsif !JSONSchemer.schema(header.schema).valid?(value)
+            @errors << "Header #{header.name} does not match"
           end
         end
         @errors.empty?
@@ -77,16 +81,29 @@ module OpenapiContracts
 
       def body_matches?
         if response_spec.no_content?
-          @errors << "Expected empty response body" if @response.body.present?
+          @errors << 'Expected empty response body' if @response.body.present?
         elsif !response_spec.supports_content_type?(response_content_type)
           @errors << "Undocumented response with content-type #{response_content_type.inspect}"
         else
           @schema = response_spec.schema_for(response_content_type)
-          @errors += JSON::Validator.fully_validate(@schema, JSON(@response.body))
+          schemer = JSONSchemer.schema(@schema.schema.merge('$ref' => @schema.fragment))
+          schemer.validate(JSON(@response.body)).each do |err|
+            @errors << error_to_message(err)
+          end
         end
         @errors.empty?
       end
 
+      def error_to_message(error)
+        if error.key?('details')
+          error['details'].to_a.map do |(key, val)|
+            "#{key.humanize}: #{val} at #{error['data_pointer']}"
+          end.to_sentence
+        else
+          "#{error['data'].inspect} at #{error['data_pointer']} does not match the schema"
+        end
+      end
+
       def response_documented?
         return true if response_spec
 

data/lib/openapi_contracts/matchers.rb

@@ -7,7 +7,3 @@ module OpenapiContracts
     end
   end
 end
-
-RSpec.configure do |config|
-  config.include OpenapiContracts::Matchers
-end

data/lib/openapi_contracts.rb

@@ -1,17 +1,18 @@
 require 'active_support'
-if ActiveSupport.version >= Gem::Version.new('7')
-  require 'active_support/isolated_execution_state' # required by array somehow
-end
 require 'active_support/core_ext/array'
 require 'active_support/core_ext/module'
+require 'active_support/core_ext/string'
 
-require 'json-schema'
+require 'json_schemer'
+require 'yaml'
 
 module OpenapiContracts
   autoload :Doc,      'openapi_contracts/doc'
   autoload :Matchers, 'openapi_contracts/matchers'
 end
 
-RSpec.configure do |config|
-  config.include OpenapiContracts::Matchers
+if defined?(RSpec)
+  RSpec.configure do |config|
+    config.include OpenapiContracts::Matchers
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: openapi_contracts
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.4.0
 platform: ruby
 authors:
 - mkon
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-05-03 00:00:00.000000000 Z
+date: 2022-06-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -31,19 +31,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '8'
 - !ruby/object:Gem::Dependency
-  name: json-schema
+  name: json_schemer
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.8.1
+        version: 0.2.20
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.8.1
+        version: 0.2.20
 - !ruby/object:Gem::Dependency
   name: rack
   requirement: !ruby/object:Gem::Requirement
@@ -72,6 +72,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 3.11.0
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.29.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.29.1
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.11.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.11.1
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -99,12 +127,14 @@ files:
 - lib/openapi_contracts/doc/header.rb
 - lib/openapi_contracts/doc/parser.rb
 - lib/openapi_contracts/doc/response.rb
+- lib/openapi_contracts/doc/schema.rb
 - lib/openapi_contracts/matchers.rb
 - lib/openapi_contracts/matchers/match_openapi_doc.rb
 homepage: https://github.com/mkon/openapi_contracts
 licenses:
 - MIT
-metadata: {}
+metadata:
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -113,10 +143,10 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.6'
+      version: '2.7'
   - - "<"
     - !ruby/object:Gem::Version
-      version: '4'
+      version: '3.3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="