openapi_validator 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0a2e54a665eba19186fb3b7ca15dfe8707cf38ba121ac7f0ebcc956715f9dd87
-  data.tar.gz: ddea6b70d0f33c09a81c39025621b9075c836e15d1dda0b066485f4602f70af3
+  metadata.gz: 7c840922f71d5eb8be437c9a544b50288b807ba6a7b2b1c1a5aecad9c5ff3a37
+  data.tar.gz: 14f0d4fc6828f74125cebc2267362ed8ef6b641980af2bbc2e71241169c056f1
 SHA512:
-  metadata.gz: 36f5c80aa8a9252c34581de7963df8e318a84c3b5de85910bf5843f7d446b806c428e485b77dedfe2fef82395c84aecb454905e9fa964337bc81b8ce60c890b3
-  data.tar.gz: 212fba9b212eb55990d91ac0ae739d8cc0745427414eb41a144601124709df80f844b74d3fccdd6e2dd230bc426688542185d4c536ed2c0b175acf085aaacb23
+  metadata.gz: 47ae33c7b4d13fa6c5250b6b68a961142be882af3ee349f07b93df7421c6b18592c6fa830ea2cb4302c3409569dd0b054efbeff2026caca9111e8963ab103df4
+  data.tar.gz: 91b5141d6b3046e0108c514a1f6e42382d8c0189a00faeaebe68dd1dda5ff5099ebf0370097cab86ce2e5e4f6aa4b3eb40bab1bed516beb3078635182e300038

data/lib/openapi_validator.rb

@@ -6,7 +6,15 @@ module OpenapiValidator
   class Error < StandardError; end
 
   # @see Validator#initialize
-  def self.call(*attrs)
-    Validator.new(*attrs)
+  def self.call(doc, **params)
+    if doc.is_a? String
+      parsed_doc = FileLoader.call(doc)
+    elsif doc.is_a? Hash
+      parsed_doc = doc
+    else
+      raise ArgumentError, "Please provide parsed OpenAPI doc as Hash or path to file as String. Passed: #{doc.class}"
+    end
+
+    Validator.new(parsed_doc, **params)
   end
 end

data/lib/openapi_validator/path_validator.rb

@@ -0,0 +1,96 @@
+require 'forwardable'
+
+module OpenapiValidator
+  class PathValidator
+    class Error < StandardError; end
+
+    extend Forwardable
+
+    def path
+      [path_key, method, @schema_code]
+    end
+
+    def fragment
+      build_fragment.tap do |array|
+        array.define_singleton_method(:split) do |_|
+          self
+        end
+      end
+    end
+
+    def self.call(**params)
+      new(**params).call
+    end
+
+    def call
+      validate_path_exists
+      self
+    end
+
+    private
+
+    attr_reader :api_doc
+
+    def_delegators :@request, :media_type, :method, :path_key, :code
+
+    def initialize(request:, api_doc:)
+      @request = request
+      @api_doc = api_doc
+    end
+
+    def validate_path_exists
+      code_schema.dig(media_type) ||
+        raise(Error, "OpenAPI documentation does not have a documented response"\
+                     " for #{media_type} media-type at path #{method.upcase} #{path_key}")
+    end
+
+    def code_schema
+      schema = schema_code
+      ref_schema(schema) || content_schema(schema)
+    end
+
+    def content_schema(responses)
+      responses.dig("content")
+    end
+
+    def ref_schema(responses)
+      schema = responses.dig("$ref")
+      return unless schema
+
+      @fragment_path = "#{schema}/#{media_type}/schema"
+      api_doc.dig(*schema[2..-1].split("/"), "content")
+    end
+
+    def schema_code
+      responses = responses_schema
+      if responses.dig(code)
+        @schema_code = code
+      elsif responses.dig("default")
+        @schema_code = "default"
+      else
+        raise(Error, "OpenAPI documentation does not have a documented response for code #{code}"\
+                    " at path #{method.upcase} #{path_key}")
+      end
+
+      responses.dig(@schema_code)
+    end
+
+    def responses_schema
+      path_schema.dig(method, "responses") ||
+        raise(Error, "OpenAPI documentation does not have a documented path for #{method.upcase} #{path_key}")
+    end
+
+    def path_schema
+      api_doc.dig("paths", path_key) ||
+        raise(Error, "OpenAPI documentation does not have a documented path for #{path_key}")
+    end
+
+    def build_fragment
+      if @fragment_path
+        @fragment_path.split("/")
+      else
+        ["#", "paths", path_key, method, "responses", @schema_code, "content", media_type, "schema"]
+      end
+    end
+  end
+end

data/lib/openapi_validator/request.rb

@@ -0,0 +1,23 @@
+module OpenapiValidator
+  class Request
+
+    attr_reader :path, :method, :code, :media_type
+
+    def self.call(**params)
+      new(**params)
+    end
+
+    def path_key
+      path[/(\/[-_\/\{\}\w]*)/]
+    end
+
+    private
+
+    def initialize(path:, method:, code:, media_type: "application/json")
+      @path = path
+      @method = method.to_s
+      @code = code.to_s
+      @media_type = media_type.to_s
+    end
+  end
+end

data/lib/openapi_validator/request_validator.rb

@@ -1,81 +1,46 @@
+require 'openapi_validator/path_validator'
+
 module OpenapiValidator
   class RequestValidator
 
-    attr_reader :errors
+    attr_reader :errors, :api_doc, :path_validator
 
     def valid?
       errors.empty?
     end
 
-    def self.call(api_doc, **params)
-      new(api_doc, **params).call
+    def self.call(**params)
+      new(**params).call
     end
 
     def call
-      validate_path_exists
+      validate_path
       self
     end
 
     def validate_response(body:, code:)
-      response_body = body
-      response_code = code.to_s
-      if @code != response_code
-        @errors << "Path #{path} did not respond with expected status code. Expected #{@code} got #{response_code}"
+      if request.code != code.to_s
+        @errors << "Path #{request.path} did not respond with expected status code. Expected #{request.code} got #{code}"
       end
-      @errors += JSON::Validator.fully_validate(api_doc, response_body, fragment: fragment)
+      @errors += JSON::Validator.fully_validate(validator.api_doc, body, fragment: path_validator.fragment)
+      validator.remove_validated_path(path_validator.path) if @errors.empty?
       self
     end
 
     private
 
-    attr_reader :api_doc, :path, :method, :code, :media_type
+    attr_reader :request, :validator
 
-    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
+    def initialize(request:, validator:)
+      @validator = validator
+      @request = request
       @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
+    def validate_path
+      @path_validator = PathValidator.call(request: request, api_doc: validator.api_doc)
+    rescue PathValidator::Error => e
+      @errors << e.message
     end
   end
 end

data/lib/openapi_validator/validator.rb

@@ -1,32 +1,53 @@
 require "json-schema"
 require "openapi_validator/file_loader"
 require "openapi_validator/documentation_validator"
+require "openapi_validator/request"
 require "openapi_validator/request_validator"
 
 module OpenapiValidator
   class Validator
 
-    attr_reader :api_base_path
+    attr_reader :api_base_path, :unvalidated_requests, :api_doc
 
     # @return [DocumentationValidator] validation result
     def validate_documentation
       DocumentationValidator.call(api_doc, additional_schemas: additional_schemas)
     end
 
+    # @return [Object] RequestValidator
     def validate_request(**params)
-      RequestValidator.call(api_doc, **params)
+      RequestValidator.call(request: Request.call(**params), validator: self)
+    end
+
+    # @param [Array] request
+    def remove_validated_path(request)
+      @unvalidated_requests.delete(request)
     end
 
     private
 
-    attr_reader :api_doc, :additional_schemas
+    attr_reader :additional_schemas
 
-    # @param [String] path path to openapi documentation
+    # @param [Hash] doc parsed openapi documentation
     # @param [Array<String>] additional_schemas paths to custom schemas
-    def initialize(path, additional_schemas: [], api_base_path: "")
-      @api_doc = FileLoader.call(path)
+    def initialize(doc, additional_schemas: [], api_base_path: "")
+      @api_doc = doc
       @api_base_path = api_base_path
       @additional_schemas = additional_schemas
+      @unvalidated_requests = build_unvalidated_requests
+    end
+
+    # @return [Array]
+    def build_unvalidated_requests
+      requests = []
+      api_doc["paths"] && api_doc["paths"].each do |path, methods|
+        methods.each do |method, values|
+          values["responses"] && values["responses"].each_key do |code|
+            requests << [path, method, code]
+          end
+        end
+      end
+      requests
     end
   end
 end

data/lib/openapi_validator/version.rb

@@ -1,3 +1,3 @@
 module OpenapiValidator
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: openapi_validator
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Svyatoslav Kryukov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-04-10 00:00:00.000000000 Z
+date: 2019-04-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json-schema
@@ -81,6 +81,8 @@ files:
 - lib/openapi_validator/extended_schema.rb
 - lib/openapi_validator/extended_type_attribute.rb
 - lib/openapi_validator/file_loader.rb
+- lib/openapi_validator/path_validator.rb
+- lib/openapi_validator/request.rb
 - lib/openapi_validator/request_validator.rb
 - lib/openapi_validator/validator.rb
 - lib/openapi_validator/version.rb