openapi_validator 0.4.1 → 0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5d4bd8846a30fce3dc1dd1503a6b21989251d86a21869ffa7e080067d23dd275
-  data.tar.gz: 8a0f95184f4de1a96d2c36fe80f8abfb867f3f85993a50b11b3743ad54792f02
+  metadata.gz: 421695ee7a834a974d8564fbd30da8f3bc21ade39aeca6bb67dd81bf5394d5c9
+  data.tar.gz: ee0caa0e6210f8c7f3a11eac1d744c906a886b8868c402da52082804dcd3a848
 SHA512:
-  metadata.gz: 874600b81ceb661d8df2d6d55cc881a7202ddea8e3d9ed87d6b9eb54be7dbf48638cf3789e03dcd5faed275655cb0aaa58f8b48c49546adac31e04ed55162a03
-  data.tar.gz: d690efa10ec2dae997b6c5f0ce3d785b375a06909cb913d4b75b23d7f49f3f0e8c0c122c2e2fc672fe4d86510247fabb9560d8e995a661a8cbf4dfa49b286609
+  metadata.gz: ea58fb690c20e18076d9bacea5d563cdbf6ab7951c1e7a7ddc9967efe0f5251a3409e3aaf38d4077b870eef01fa7b2693a6b34fc776aba0cf3904f1f8d942adc
+  data.tar.gz: 2b14e4bac49769407d1e0b9d0bb8a82428c17e182b52755e74b6479da0a54a641f1434ad52d54f68fb88e8ae433bc22dfc979634ce7f9b6aaab9c169fce539a6

data/README.md

@@ -7,6 +7,7 @@
 [![Build Status](https://travis-ci.org/medsolutions/openapi_validator.svg?branch=master)][travis]
 [![Code Climate](https://codeclimate.com/github/medsolutions/openapi_validator/badges/gpa.svg)][codeclimate]
 [![Test Coverage](https://codeclimate.com/github/medsolutions/openapi_validator/badges/coverage.svg)][codeclimate]
+[![Ruby Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://github.com/testdouble/standard)
 
 Validator used for [openapi_rspec](https://github.com/medsolutions/openapi_rspec)
 
@@ -43,3 +44,5 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/medsol
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+This project includes the [OpenAPI 3.0 Schema](https://github.com/googleapis/gnostic/blob/master/OpenAPIv3/openapi-3.0.json) as `data/openapi-3.0.json`. Copyright 2017, Google Inc. Released under the Apache 2.0 license.

data/lib/openapi_validator/documentation_validator.rb

@@ -4,7 +4,6 @@ require "openapi_validator/schema/json_validator"
 
 module OpenapiValidator
   class DocumentationValidator
-
     attr_reader :errors
 
     # @param [Hash] api_doc parsed openapi documentation

data/lib/openapi_validator/extended_schema.rb

@@ -7,13 +7,13 @@ module OpenapiValidator
   class ExtendedSchema < JSON::Schema::Draft4
     def initialize
       super
-      @attributes['type'] = TypeAttribute
-      @attributes['required'] = RequiredAttribute
-      @uri = URI.parse('http://example.com/extended_schema')
-      @names = ['http://example.com/extended_schema']
+      @attributes["type"] = TypeAttribute
+      @attributes["required"] = RequiredAttribute
+      @uri = URI.parse("http://example.com/extended_schema")
+      @names = ["http://example.com/extended_schema"]
     end
 
-    JsonValidator.register_validator(self.new)
-    JsonValidator.register_default_validator(self.new)
+    JsonValidator.register_validator(new)
+    JsonValidator.register_default_validator(new)
   end
 end

data/lib/openapi_validator/file_loader.rb

@@ -3,7 +3,6 @@ require "yaml"
 
 module OpenapiValidator
   class FileLoader
-
     # @param [String] path path to file
     # @return [Hash] parsed file
     def self.call(path)

data/lib/openapi_validator/path_validator.rb

@@ -1,4 +1,4 @@
-require 'forwardable'
+require "forwardable"
 
 module OpenapiValidator
   class PathValidator
@@ -14,8 +14,8 @@ module OpenapiValidator
       [path_key, method, @schema_code]
     end
 
-    def fragment
-      build_fragment.tap do |array|
+    def fragment(media_type: nil)
+      build_fragment(media_type: media_type).tap do |array|
         array.define_singleton_method(:split) do |_|
           self
         end
@@ -93,7 +93,7 @@ module OpenapiValidator
         raise(Error, "OpenAPI documentation does not have a documented path for #{path_key}")
     end
 
-    def build_fragment
+    def build_fragment(media_type: nil)
       fragment =
         if @fragment_path
           @fragment_path.split("/")
@@ -101,7 +101,7 @@ module OpenapiValidator
           ["#", "paths", path_key, method, "responses", @schema_code]
         end
 
-      fragment += ["content", media_type, "schema"] unless @empty_schema
+      fragment += ["content", media_type || self.media_type, "schema"] unless @empty_schema
 
       fragment
     end

data/lib/openapi_validator/request.rb

@@ -1,6 +1,5 @@
 module OpenapiValidator
   class Request
-
     attr_reader :path, :method, :code, :media_type
 
     def self.call(**params)

data/lib/openapi_validator/request_validator.rb

@@ -1,10 +1,9 @@
-require 'openapi_validator/path_validator'
-require 'openapi_validator/response_validator'
-require 'openapi_validator/schema/json_validator'
+require "openapi_validator/path_validator"
+require "openapi_validator/response_validator"
+require "openapi_validator/schema/json_validator"
 
 module OpenapiValidator
   class RequestValidator
-
     attr_reader :errors, :api_doc, :path_validator
 
     def valid?
@@ -20,7 +19,7 @@ module OpenapiValidator
       self
     end
 
-    def validate_response(body:, code:)
+    def validate_response(body:, code:, media_type: request.media_type)
       if request.code != code.to_s
         @errors << "Path #{request.path} did not respond with expected status code. Expected #{request.code} got #{code}"
       end
@@ -29,7 +28,8 @@ module OpenapiValidator
         @errors << "Path #{request.path} should return empty response." unless body.empty?
       else
         @errors += OpenapiValidator::ResponseValidator.call(
-          request: request, schema: validator.api_doc, data: body, fragment: path_validator.fragment, response: true
+          request: request, schema: validator.api_doc, data: body, media_type: media_type,
+          fragment: path_validator.fragment(media_type: media_type), response: true
         ).errors
       end
 

data/lib/openapi_validator/response_validator.rb

@@ -3,7 +3,6 @@ require "openapi_validator/response_validators/image_validator"
 
 module OpenapiValidator
   class ResponseValidator
-
     attr_reader :errors
 
     def valid?
@@ -21,27 +20,28 @@ module OpenapiValidator
 
     private
 
-    attr_reader :request, :schema, :data, :fragment, :response
+    attr_reader :request, :schema, :data, :fragment, :response, :media_type
 
-    def initialize(request:, schema:, data:, fragment:, response:)
+    def initialize(request:, schema:, data:, fragment:, response:, media_type:)
       @request = request
       @schema = schema
       @data = data
+      @media_type = media_type
       @fragment = fragment
       @response = response
       @errors = []
     end
 
     def validate_response
-      @errors += validator.new(schema: schema, data: data, fragment: fragment, media_type: request.media_type, response: response).validate
+      @errors += validator.new(schema: schema, data: data, fragment: fragment, media_type: media_type, response: response).validate
     end
 
     def validator
-      case request.media_type
-      when 'application/json'
-        OpenapiValidator::ResponseValidator::JsonValidator
+      case media_type
       when %r{^image/[^/]*$}
         OpenapiValidator::ResponseValidator::ImageValidator
+      else
+        OpenapiValidator::ResponseValidator::JsonValidator
       end
     end
   end

data/lib/openapi_validator/response_validators/image_validator.rb

@@ -23,17 +23,17 @@ module OpenapiValidator
       attr_reader :schema, :data, :fragment, :media_type, :response, :property_name
 
       def validate_media_type
-        type, sub_type = media_type.split('/')
+        type, sub_type = media_type.split("/")
         content = MimeMagic.by_magic(data)
 
-        if content&.mediatype != type && (content&.subtype == sub_type || sub_type == '*')
+        if content&.mediatype != type && (content&.subtype == sub_type || sub_type == "*")
           @errors << "Content-type of property '#{property_name}' did not match the following content-type: #{media_type}"
         end
       end
 
       def validate_schema
-        unless JSON::Schema::Attribute.data_valid_for_type?(data, 'string')
-           @errors << "The property '#{property_name}' did not match the following type: #{type}"
+        unless JSON::Schema::Attribute.data_valid_for_type?(data, "string")
+          @errors << "The property '#{property_name}' did not match the following type: #{type}"
         end
       end
     end

data/lib/openapi_validator/schema/json_validator.rb

@@ -1,4 +1,3 @@
-
 module OpenapiValidator
   class JsonValidator < JSON::Validator
     attr_reader :options

data/lib/openapi_validator/schema/required_attribute.rb

@@ -6,17 +6,17 @@ module OpenapiValidator
       return unless data.is_a?(Hash)
 
       schema = current_schema.schema
-      defined_properties = schema['properties']
+      defined_properties = schema["properties"]
 
-      schema['required'].each do |property, _property_schema|
-        next if data.has_key?(property.to_s)
+      schema["required"].each do |property, _property_schema|
+        next if data.key?(property.to_s)
         prop_defaults = options[:insert_defaults] &&
           defined_properties &&
           defined_properties[property] &&
           !defined_properties[property]["default"].nil? &&
           !defined_properties[property]["readonly"]
 
-        skip_error = processor.options[:response] && defined_properties[property]["writeOnly"]
+        skip_error = processor.options[:response] && defined_properties.dig(property, "writeOnly")
 
         if !prop_defaults && !skip_error
           message = "The property '#{build_fragment(fragments)}' did not contain a required property of '#{property}'"

data/lib/openapi_validator/validator.rb

@@ -6,7 +6,6 @@ require "openapi_validator/request_validator"
 
 module OpenapiValidator
   class Validator
-
     attr_reader :api_base_path, :unvalidated_requests, :api_doc
 
     # @return [DocumentationValidator] validation result
@@ -41,11 +40,12 @@ module OpenapiValidator
     def build_unvalidated_requests
       http_methods = %w[get put post delete options head patch trace]
       requests = []
-      api_doc["paths"] && api_doc["paths"].each do |path, methods|
+
+      api_doc["paths"]&.each do |path, methods|
         methods.each do |method, values|
           next unless http_methods.include?(method)
 
-          values["responses"] && values["responses"].each_key do |code|
+          values["responses"]&.each_key do |code|
             requests << [path, method, code]
           end
         end

data/lib/openapi_validator/version.rb

@@ -1,3 +1,3 @@
 module OpenapiValidator
-  VERSION = "0.4.1"
+  VERSION = "0.5"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: openapi_validator
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: '0.5'
 platform: ruby
 authors:
 - Svyatoslav Kryukov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-08-05 00:00:00.000000000 Z
+date: 2019-11-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json-schema