openapi_validator 0.1.0

data/lib/openapi_validator.rb

@@ -0,0 +1,12 @@
+require "openapi_validator/extended_schema"
+require "openapi_validator/validator"
+require "openapi_validator/version"
+
+module OpenapiValidator
+  class Error < StandardError; end
+
+  # @see Validator#initialize
+  def self.call(*attrs)
+    Validator.new(*attrs)
+  end
+end

data/lib/openapi_validator/documentation_validator.rb

@@ -0,0 +1,57 @@
+require "json-schema"
+require "openapi_validator/file_loader"
+
+module OpenapiValidator
+  class DocumentationValidator
+
+    attr_reader :errors
+
+    # @param [Hash] api_doc parsed openapi documentation
+    # @param [Array<String>] additional_schemas paths to custom schemas
+    # @return [DocumentationValidator] validation result
+    def self.call(api_doc, additional_schemas: [])
+      new(api_doc, additional_schemas: additional_schemas).call
+    end
+
+    # @return [DocumentationValidator]
+    def call
+      validate
+    end
+
+    # @return [true, false]
+    def valid?
+      errors.empty?
+    end
+
+    private
+
+    attr_reader :api_doc, :schemas
+
+    # @return [DocumentationValidator]
+    def validate
+      parsed_schemas.each do |schema|
+        errors.concat JSON::Validator.fully_validate(schema, api_doc)
+      end
+
+      self
+    end
+
+    # @return [Array<Hash>] parsed custom schemas
+    def parsed_schemas
+      schemas.map { |schema| FileLoader.call(schema) }
+    end
+
+    # @param [Hash] api_doc parsed openapi documentation
+    # @param [Array<String>] additional_schemas paths to custom schemas
+    def initialize(api_doc, additional_schemas:)
+      @api_doc = api_doc
+      @schemas = additional_schemas.unshift openapi_schema
+      @errors = []
+    end
+
+    # @return [String] path to openapi v3 schema
+    def openapi_schema
+      File.expand_path("../../../data/openapi-3.0.json", __FILE__)
+    end
+  end
+end

data/lib/openapi_validator/extended_schema.rb

@@ -0,0 +1,16 @@
+require "openapi_validator/extended_type_attribute"
+require "json-schema"
+
+module OpenapiValidator
+  class ExtendedSchema < JSON::Schema::Draft4
+    def initialize
+      super
+      @attributes['type'] = ExtendedTypeAttribute
+      @uri = URI.parse('http://tempuri.org/apivore/extended_schema')
+      @names = ['http://tempuri.org/apivore/extended_schema']
+    end
+
+    JSON::Validator.register_validator(self.new)
+    JSON::Validator.register_default_validator(self.new)
+  end
+end

data/lib/openapi_validator/extended_type_attribute.rb

@@ -0,0 +1,10 @@
+require "json-schema/attributes/type_v4"
+
+module OpenapiValidator
+  class ExtendedTypeAttribute < JSON::Schema::TypeV4Attribute
+    def self.validate(current_schema, data, fragments, processor, validator, options = {})
+      return if data.nil? && current_schema.schema["nullable"] == true
+      super
+    end
+  end
+end

data/lib/openapi_validator/file_loader.rb

@@ -0,0 +1,34 @@
+require "json"
+require "yaml"
+
+module OpenapiValidator
+  class FileLoader
+
+    # @param [String] path path to file
+    # @return [Hash] parsed file
+    def self.call(path)
+      new(path).call
+    end
+
+    # @return [Hash] parsed file
+    def call
+      case File.extname(path)
+      when ".yml", ".yaml"
+        YAML.load_file(path)
+      when ".json"
+        JSON.parse(File.read(path))
+      else
+        raise "Can't parse #{path}. It should be json or yaml file.", Error
+      end
+    end
+
+    private
+
+    attr_reader :path
+
+    # @param [String] path path to file
+    def initialize(path)
+      @path = path
+    end
+  end
+end

data/lib/openapi_validator/request_validator.rb

@@ -0,0 +1,77 @@
+module OpenapiValidator
+  class RequestValidator
+
+    attr_reader :errors
+
+    def valid?
+      errors.empty?
+    end
+
+    def self.call(api_doc, **params)
+      new(api_doc, **params).call
+    end
+
+    def call
+      validate_path_exists
+      self
+    end
+
+    def validate_response(response_body)
+      @response_body = response_body
+      @errors += JSON::Validator.fully_validate(api_doc, response_body, fragment: fragment)
+      self
+    end
+
+    private
+
+    attr_reader :api_doc, :path, :method, :code, :media_type
+
+    def initialize(api_doc, path:, method:, code:, media_type: "application/json")
+      @api_doc = api_doc
+      @path = path
+      @method = method.to_s
+      @code = code.to_s
+      @media_type = media_type.to_s
+      @errors = []
+    end
+
+    def path_key
+      path[/(\/[-_\/\{\}\w]*)/]
+    end
+
+    def fragment
+      ["#", "paths", path_key, method, "responses", code, "content", media_type, "schema"].tap do |array|
+        array.define_singleton_method(:split) do |_|
+          self
+        end
+       end
+    end
+
+    def validate_path_exists
+      path_schema = api_doc.dig("paths", path_key)
+      unless path_schema
+        errors << "OpenAPI documentation does not have a documented path for #{path_key}"
+        return
+      end
+
+      responses_schema = path_schema.dig(method, "responses")
+      unless responses_schema
+        errors << "OpenAPI documentation does not have a documented path for #{method.upcase} #{path_key}"
+        return
+      end
+
+      content_schema = responses_schema.dig(code, "content") || responses_schema.dig("default", "content")
+      unless content_schema
+        errors << "OpenAPI documentation does not have a documented response for code #{code}"\
+                  " at path #{method.upcase} #{path_key}"
+        return
+      end
+
+      response_schema = content_schema.dig(media_type)
+      unless response_schema
+        errors << "OpenAPI documentation does not have a documented response for #{media_type}"\
+                  " media-type at path #{method.upcase} #{path_key}"
+      end
+    end
+  end
+end

data/lib/openapi_validator/validator.rb

@@ -0,0 +1,32 @@
+require "json-schema"
+require "openapi_validator/file_loader"
+require "openapi_validator/documentation_validator"
+require "openapi_validator/request_validator"
+
+module OpenapiValidator
+  class Validator
+
+    attr_reader :api_base_path
+
+    # @return [DocumentationValidator] validation result
+    def validate_documentation
+      DocumentationValidator.call(api_doc, additional_schemas: additional_schemas)
+    end
+
+    def validate_request(**params)
+      RequestValidator.call(api_doc, **params)
+    end
+
+    private
+
+    attr_reader :api_doc, :additional_schemas
+
+    # @param [String] path path to openapi documentation
+    # @param [Array<String>] additional_schemas paths to custom schemas
+    def initialize(path, additional_schemas: [], api_base_path: "")
+      @api_doc = FileLoader.call(path)
+      @api_base_path = api_base_path
+      @additional_schemas = additional_schemas
+    end
+  end
+end

data/lib/openapi_validator/version.rb

@@ -0,0 +1,3 @@
+module OpenapiValidator
+  VERSION = "0.1.0"
+end

data/openapi_validator.gemspec

@@ -0,0 +1,29 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "openapi_validator/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "openapi_validator"
+  spec.version       = OpenapiValidator::VERSION
+  spec.authors       = ["Svyatoslav Kryukov"]
+  spec.email         = ["s.g.kryukov@yandex.ru"]
+
+  spec.summary       = "Validator used for openapi_rspec"
+  spec.homepage      = "https://github.com/llcmedsolutions/openapi_validator"
+  spec.license       = "MIT"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "json-schema", "~> 2.8"
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,119 @@
+--- !ruby/object:Gem::Specification
+name: openapi_validator
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Svyatoslav Kryukov
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-04-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: json-schema
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.8'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: 
+email:
+- s.g.kryukov@yandex.ru
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- data/openapi-3.0.json
+- lib/openapi_validator.rb
+- lib/openapi_validator/documentation_validator.rb
+- lib/openapi_validator/extended_schema.rb
+- lib/openapi_validator/extended_type_attribute.rb
+- lib/openapi_validator/file_loader.rb
+- lib/openapi_validator/request_validator.rb
+- lib/openapi_validator/validator.rb
+- lib/openapi_validator/version.rb
+- openapi_validator.gemspec
+homepage: https://github.com/llcmedsolutions/openapi_validator
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.1
+signing_key: 
+specification_version: 4
+summary: Validator used for openapi_rspec
+test_files: []