openapi_parser 0.2.6 → 0.2.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 03ecb03e959dd472600018d4b8e0978cb8e4b0a1eae5c71b27b7e48aa71a7820
-  data.tar.gz: cae628061130aa70c56fb845efc14fc1c57b9a14ea70a13976bc508ef573a94a
+  metadata.gz: 2dd37ca24b93c63b4ccb98a693c9200f1850fca3349b5e70931aa40771bb31dc
+  data.tar.gz: c7d4e29d589c610554a8873a601d8eba674560267ccdb28a951ec120debbb0a0
 SHA512:
-  metadata.gz: 0a16babec6dfe5adb06207bab3fb746f5ac42f228aef95b4339d43998ce092073ff5c1e8b00b950fbe626e667147a715ed33e1b7bb832f3fe40e136b8bfb2117
-  data.tar.gz: f52fadf6c9cf1f12614c3be3e886504cb3e4377f40151dceb6714e9384697727931643beaab8b19f96c62a06448ccf871d0069159460c45cf6b20e662f12902e
+  metadata.gz: a8c5ce03e3a6399403b3018f3fb5b6d3b0ff304989ac83a1c4aedb1a83709285f2a80abf90b25ac99ea5623474f7070239e62a918535f8798de2c73d1527c0fe
+  data.tar.gz: 85dda1a6fff6458ca87f462ede780a933448e05188e4d514c415abee3e36a365ba956e57684748c65103a83321a1760f5433ef9f909fcb5fc2178def664eccc9

data/CHANGELOG.md

@@ -1,5 +1,8 @@
 ## Unreleased
 
+## 0.2.7 (2019-05-20)
+* Fix for release miss
+
 ## 0.2.6 (2019-05-20)
 * Add support for discriminator (#32)
 

data/lib/openapi_parser/errors.rb

@@ -43,6 +43,29 @@ module OpenAPIParser
     end
   end
 
+  class NotExistDiscriminatorMappingTarget < OpenAPIError
+    def initialize(key, reference)
+      super(reference)
+      @key = key
+    end
+
+    def message
+      "discriminator mapping key #{@key} does not exist in #{@reference}"
+    end
+  end
+
+  class NotExistDiscriminatorPropertyName < OpenAPIError
+    def initialize(key, value, reference)
+      super(reference)
+      @key   = key
+      @value = value
+    end
+
+    def message
+      "discriminator propertyName #{@key} does not exist in value #{@value} in #{@reference}"
+    end
+  end
+
   class NotOneOf < OpenAPIError
     def initialize(value, reference)
       super(reference)

data/lib/openapi_parser/schema_validator.rb

@@ -88,7 +88,7 @@ class OpenAPIParser::SchemaValidator
   private
 
     # @return [OpenAPIParser::SchemaValidator::Base, nil]
-    def validator(value, schema) # rubocop:disable Metrics/CyclomaticComplexity
+    def validator(value, schema)
       return any_of_validator if schema.any_of
       return all_of_validator if schema.all_of
       return one_of_validator if schema.one_of

data/lib/openapi_parser/schema_validators/any_of_validator.rb

@@ -3,6 +3,10 @@ class OpenAPIParser::SchemaValidator
     # @param [Object] value
     # @param [OpenAPIParser::Schemas::Schema] schema
     def coerce_and_validate(value, schema)
+      if schema.discriminator
+        return validate_discriminator_schema(schema.discriminator, value)
+      end
+
       # in all schema return error (=true) not any of data
       schema.any_of.each do |s|
         coerced, err = validatable.validate_schema(value, s)

data/lib/openapi_parser/schema_validators/base.rb

@@ -17,5 +17,23 @@ class OpenAPIParser::SchemaValidator
     def coerce_and_validate(_value, _schema)
       raise 'need implement'
     end
+
+    def validate_discriminator_schema(discriminator, value)
+      unless value.key?(discriminator.property_name)
+        return [nil, OpenAPIParser::NotExistDiscriminatorPropertyName.new(discriminator.property_name, value, discriminator.object_reference)]
+      end
+      mapping_key = value[discriminator.property_name]
+
+      # TODO: it's allowed to have discriminator without mapping, then we need to lookup discriminator.property_name
+      # but the format is not the full path, just model name in the components
+      mapping_target = discriminator.mapping[mapping_key]
+      unless mapping_target
+        return [nil, OpenAPIParser::NotExistDiscriminatorMappingTarget.new(mapping_key, discriminator.object_reference)]
+      end
+
+      # Find object does O(n) search at worst, then caches the result, so this is ok for repeated search
+      resolved_schema = discriminator.root.find_object(mapping_target)
+      validatable.validate_schema(value, resolved_schema)
+    end
   end
 end

data/lib/openapi_parser/schema_validators/one_of_validator.rb

@@ -3,6 +3,10 @@ class OpenAPIParser::SchemaValidator
     # @param [Object] value
     # @param [OpenAPIParser::Schemas::Schema] schema
     def coerce_and_validate(value, schema)
+      if schema.discriminator
+        return validate_discriminator_schema(schema.discriminator, value)
+      end
+
       # if multiple schemas are satisfied, it's not valid
       result = schema.one_of.one? do |s|
         _coerced, err = validatable.validate_schema(value, s)

data/lib/openapi_parser/schemas.rb

@@ -1,6 +1,7 @@
 require_relative 'schemas/classes'
 
 require_relative 'schemas/base'
+require_relative 'schemas/discriminator'
 require_relative 'schemas/openapi'
 require_relative 'schemas/paths'
 require_relative 'schemas/path_item'

data/lib/openapi_parser/schemas/classes.rb

@@ -2,6 +2,7 @@
 
 module OpenAPIParser::Schemas
   class Base; end
+  class Discriminator < Base; end
   class OpenAPI < Base; end
   class Operation < Base; end
   class Parameter < Base; end

data/lib/openapi_parser/schemas/discriminator.rb

@@ -0,0 +1,11 @@
+module OpenAPIParser::Schemas
+  class Discriminator < Base
+    # @!attribute [r] property_name
+    #   @return [String, nil]
+    openapi_attr_value :property_name, schema_key: :propertyName
+
+    # @!attribute [r] mapping
+    #   @return [Hash{String => String]
+    openapi_attr_value :mapping
+  end
+end

data/lib/openapi_parser/schemas/openapi.rb

@@ -5,8 +5,6 @@
 
 module OpenAPIParser::Schemas
   class OpenAPI < Base
-    include OpenAPIParser::DefinitionValidatable
-
     def initialize(raw_schema, config)
       super('#', nil, self, raw_schema)
       @find_object_cache = {}
@@ -30,17 +28,5 @@ module OpenAPIParser::Schemas
     def request_operation(http_method, request_path)
       OpenAPIParser::RequestOperation.create(http_method, request_path, @path_item_finder, @config)
     end
-
-    # return the definition is valid or not
-    # @return Boolean
-    def valid_definition?
-      openapi_definition_errors.empty?
-    end
-
-    # return definition errors
-    # @return Array
-    def openapi_definition_errors
-      @openapi_definition_errors ||= validate_definitions([])
-    end
   end
 end

data/lib/openapi_parser/schemas/schema.rb

@@ -1,5 +1,5 @@
 # TODO: support 'not' because I need check reference...
-# TODO: support 'discriminator', 'xml', 'externalDocs'
+# TODO: support 'xml', 'externalDocs'
 # TODO: support extended property
 
 module OpenAPIParser::Schemas
@@ -101,6 +101,10 @@ module OpenAPIParser::Schemas
     #   @return [Hash{String => Schema}, nil]
     openapi_attr_hash_object :properties, Schema, reference: true
 
+    # @!attribute [r] discriminator
+    #   @return [Discriminator, nil]
+    openapi_attr_object :discriminator, Discriminator
+
     # @!attribute [r] additional_properties
     #   @return [Boolean, Schema, Reference, nil]
     openapi_attr_object :additional_properties, Schema, reference: true, allow_data_type: true, schema_key: :additionalProperties

data/lib/openapi_parser/version.rb

@@ -1,3 +1,3 @@
 module OpenAPIParser
-  VERSION = '0.2.6'.freeze
+  VERSION = '0.2.7'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: openapi_parser
 version: !ruby/object:Gem::Version
-  version: 0.2.6
+  version: 0.2.7
 platform: ruby
 authors:
 - ota42y
@@ -144,7 +144,6 @@ files:
 - bin/setup
 - lib/openapi_parser.rb
 - lib/openapi_parser/concern.rb
-- lib/openapi_parser/concerns/definition_validatable.rb
 - lib/openapi_parser/concerns/expandable.rb
 - lib/openapi_parser/concerns/findable.rb
 - lib/openapi_parser/concerns/media_type_selectable.rb
@@ -188,6 +187,7 @@ files:
 - lib/openapi_parser/schemas/base.rb
 - lib/openapi_parser/schemas/classes.rb
 - lib/openapi_parser/schemas/components.rb
+- lib/openapi_parser/schemas/discriminator.rb
 - lib/openapi_parser/schemas/header.rb
 - lib/openapi_parser/schemas/media_type.rb
 - lib/openapi_parser/schemas/openapi.rb

data/lib/openapi_parser/concerns/definition_validatable.rb

@@ -1,7 +0,0 @@
-module OpenAPIParser::DefinitionValidatable
-  # validate this definition is valid and return all definition errors
-  # @return Array
-  def validate_definitions(_parents)
-    []
-  end
-end