openapi3_parser 0.4.0 → 0.5.0

data/lib/openapi3_parser/validators/unexpected_fields.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+require "openapi3_parser/array_sentence"
+require "openapi3_parser/error"
+
+module Openapi3Parser
+  module Validators
+    class UnexpectedFields
+      using ArraySentence
+      private_class_method :new
+
+      def self.call(*args)
+        new.call(*args)
+      end
+
+      def call(validatable,
+               allow_extensions: true,
+               allowed_fields: nil,
+               raise_on_invalid: true)
+        fields = unexpected_fields(validatable.input,
+                                   allowed_fields,
+                                   allow_extensions)
+        return if fields.empty?
+
+        if raise_on_invalid
+          location_summary = validatable.context.location_summary
+          raise Openapi3Parser::Error::UnexpectedFields,
+                "Unexpected fields for #{location_summary}: "\
+                "#{fields.sentence_join}"
+        else
+          validatable.add_error(
+            "Unexpected fields: #{fields.sentence_join}"
+          )
+        end
+      end
+
+      private
+
+      def unexpected_fields(input, allowed_fields, allow_extensions)
+        if allowed_fields
+          extra_keys = input.keys - allowed_fields
+          return extra_keys unless allow_extensions
+          extra_keys.reject { |key| key =~ NodeFactory::EXTENSION_REGEX }
+        elsif !allow_extensions
+          input.keys.select { |key| key =~ NodeFactory::EXTENSION_REGEX }
+        else
+          []
+        end
+      end
+    end
+  end
+end

data/lib/openapi3_parser/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Openapi3Parser
-  VERSION = "0.4.0"
+  VERSION = "0.5.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: openapi3_parser
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Kevin Dew
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-07-18 00:00:00.000000000 Z
+date: 2018-07-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: commonmarker
@@ -129,6 +129,8 @@ files:
 - Rakefile
 - TODO.md
 - lib/openapi3_parser.rb
+- lib/openapi3_parser/array_sentence.rb
+- lib/openapi3_parser/cautious_dig.rb
 - lib/openapi3_parser/context.rb
 - lib/openapi3_parser/context/location.rb
 - lib/openapi3_parser/context/pointer.rb
@@ -169,47 +171,50 @@ files:
 - lib/openapi3_parser/node/server_variable.rb
 - lib/openapi3_parser/node/tag.rb
 - lib/openapi3_parser/node/xml.rb
-- lib/openapi3_parser/node_factories/array.rb
-- lib/openapi3_parser/node_factories/callback.rb
-- lib/openapi3_parser/node_factories/components.rb
-- lib/openapi3_parser/node_factories/contact.rb
-- lib/openapi3_parser/node_factories/discriminator.rb
-- lib/openapi3_parser/node_factories/encoding.rb
-- lib/openapi3_parser/node_factories/example.rb
-- lib/openapi3_parser/node_factories/external_documentation.rb
-- lib/openapi3_parser/node_factories/header.rb
-- lib/openapi3_parser/node_factories/info.rb
-- lib/openapi3_parser/node_factories/license.rb
-- lib/openapi3_parser/node_factories/link.rb
-- lib/openapi3_parser/node_factories/map.rb
-- lib/openapi3_parser/node_factories/media_type.rb
-- lib/openapi3_parser/node_factories/oauth_flow.rb
-- lib/openapi3_parser/node_factories/oauth_flows.rb
-- lib/openapi3_parser/node_factories/openapi.rb
-- lib/openapi3_parser/node_factories/operation.rb
-- lib/openapi3_parser/node_factories/parameter.rb
-- lib/openapi3_parser/node_factories/parameter/parameter_like.rb
-- lib/openapi3_parser/node_factories/path_item.rb
-- lib/openapi3_parser/node_factories/paths.rb
-- lib/openapi3_parser/node_factories/reference.rb
-- lib/openapi3_parser/node_factories/request_body.rb
-- lib/openapi3_parser/node_factories/response.rb
-- lib/openapi3_parser/node_factories/responses.rb
-- lib/openapi3_parser/node_factories/schema.rb
-- lib/openapi3_parser/node_factories/security_requirement.rb
-- lib/openapi3_parser/node_factories/security_scheme.rb
-- lib/openapi3_parser/node_factories/server.rb
-- lib/openapi3_parser/node_factories/server_variable.rb
-- lib/openapi3_parser/node_factories/tag.rb
-- lib/openapi3_parser/node_factories/xml.rb
 - lib/openapi3_parser/node_factory.rb
-- lib/openapi3_parser/node_factory/field_config.rb
+- lib/openapi3_parser/node_factory/array.rb
+- lib/openapi3_parser/node_factory/callback.rb
+- lib/openapi3_parser/node_factory/components.rb
+- lib/openapi3_parser/node_factory/contact.rb
+- lib/openapi3_parser/node_factory/discriminator.rb
+- lib/openapi3_parser/node_factory/encoding.rb
+- lib/openapi3_parser/node_factory/example.rb
+- lib/openapi3_parser/node_factory/external_documentation.rb
+- lib/openapi3_parser/node_factory/field.rb
 - lib/openapi3_parser/node_factory/fields/reference.rb
+- lib/openapi3_parser/node_factory/header.rb
+- lib/openapi3_parser/node_factory/info.rb
+- lib/openapi3_parser/node_factory/license.rb
+- lib/openapi3_parser/node_factory/link.rb
 - lib/openapi3_parser/node_factory/map.rb
+- lib/openapi3_parser/node_factory/media_type.rb
+- lib/openapi3_parser/node_factory/oauth_flow.rb
+- lib/openapi3_parser/node_factory/oauth_flows.rb
 - lib/openapi3_parser/node_factory/object.rb
-- lib/openapi3_parser/node_factory/object/node_builder.rb
-- lib/openapi3_parser/node_factory/object/validator.rb
+- lib/openapi3_parser/node_factory/object_factory/dsl.rb
+- lib/openapi3_parser/node_factory/object_factory/field_config.rb
+- lib/openapi3_parser/node_factory/object_factory/node_builder.rb
+- lib/openapi3_parser/node_factory/object_factory/validator.rb
+- lib/openapi3_parser/node_factory/openapi.rb
+- lib/openapi3_parser/node_factory/operation.rb
 - lib/openapi3_parser/node_factory/optional_reference.rb
+- lib/openapi3_parser/node_factory/parameter.rb
+- lib/openapi3_parser/node_factory/parameter_like.rb
+- lib/openapi3_parser/node_factory/path_item.rb
+- lib/openapi3_parser/node_factory/paths.rb
+- lib/openapi3_parser/node_factory/recursive_pointer.rb
+- lib/openapi3_parser/node_factory/reference.rb
+- lib/openapi3_parser/node_factory/request_body.rb
+- lib/openapi3_parser/node_factory/response.rb
+- lib/openapi3_parser/node_factory/responses.rb
+- lib/openapi3_parser/node_factory/schema.rb
+- lib/openapi3_parser/node_factory/security_requirement.rb
+- lib/openapi3_parser/node_factory/security_scheme.rb
+- lib/openapi3_parser/node_factory/server.rb
+- lib/openapi3_parser/node_factory/server_variable.rb
+- lib/openapi3_parser/node_factory/tag.rb
+- lib/openapi3_parser/node_factory/type_checker.rb
+- lib/openapi3_parser/node_factory/xml.rb
 - lib/openapi3_parser/source.rb
 - lib/openapi3_parser/source/reference.rb
 - lib/openapi3_parser/source/reference_resolver.rb
@@ -221,12 +226,17 @@ files:
 - lib/openapi3_parser/source_input/url.rb
 - lib/openapi3_parser/validation/error.rb
 - lib/openapi3_parser/validation/error_collection.rb
+- lib/openapi3_parser/validation/input_validator.rb
+- lib/openapi3_parser/validation/validatable.rb
 - lib/openapi3_parser/validators/absolute_uri.rb
 - lib/openapi3_parser/validators/component_keys.rb
 - lib/openapi3_parser/validators/duplicate_parameters.rb
 - lib/openapi3_parser/validators/email.rb
 - lib/openapi3_parser/validators/media_type.rb
+- lib/openapi3_parser/validators/mutually_exclusive_fields.rb
 - lib/openapi3_parser/validators/reference.rb
+- lib/openapi3_parser/validators/required_fields.rb
+- lib/openapi3_parser/validators/unexpected_fields.rb
 - lib/openapi3_parser/validators/url.rb
 - lib/openapi3_parser/version.rb
 - openapi3_parser.gemspec

data/lib/openapi3_parser/node_factories/array.rb

@@ -1,114 +0,0 @@
-# frozen_string_literal: true
-
-require "openapi3_parser/context"
-require "openapi3_parser/error"
-require "openapi3_parser/node_factory"
-require "openapi3_parser/node/array"
-require "openapi3_parser/validation/error"
-require "openapi3_parser/validation/error_collection"
-
-module Openapi3Parser
-  module NodeFactories
-    class Array
-      include NodeFactory
-      input_type ::Array
-
-      def initialize(
-        context,
-        default: [],
-        value_input_type: nil,
-        value_factory: nil,
-        validate: nil
-      )
-        @default = default
-        @given_value_input_type = value_input_type
-        @given_value_factory = value_factory
-        @given_validate = validate
-        super(context)
-      end
-
-      private
-
-      attr_reader :default, :given_value_input_type,
-                  :given_value_factory, :given_validate
-
-      def process_input(input)
-        input.each_with_index.map do |value, i|
-          if value_factory?
-            initialize_value_factory(Context.next_field(context, i))
-          else
-            value
-          end
-        end
-      end
-
-      def validate(input, _context)
-        given_validate&.call(input, self)
-      end
-
-      def validate_input
-        value_errors = processed_input.flat_map do |value|
-          value.respond_to?(:errors) ? value.errors.to_a : []
-        end
-        errors = value_errors + validate_value_input_type(processed_input,
-                                                          context)
-        Validation::ErrorCollection.combine(super, errors)
-      end
-
-      def build_node(input)
-        check_value_input_type(input)
-        data = input.map do |value|
-          value.respond_to?(:node) ? value.node : value
-        end
-        build_array(data, context)
-      end
-
-      def build_array(data, context)
-        Node::Array.new(data, context)
-      end
-
-      def build_resolved_input
-        processed_input.map do |value|
-          value.respond_to?(:resolved_input) ? value.resolved_input : value
-        end
-      end
-
-      def value_factory?
-        !given_value_factory.nil?
-      end
-
-      def initialize_value_factory(context)
-        factory = given_value_factory
-        return factory.new(context) if factory.is_a?(Class)
-        factory.call(context)
-      end
-
-      def validate_value_input_type(input, context)
-        input.each_with_index.each_with_object([]) do |(value, i), memo|
-          error = error_for_value_input_type(value)
-          next unless error
-          memo << Validation::Error.new(
-            error, Context.next_field(context, i), self.class
-          )
-        end
-      end
-
-      def check_value_input_type(input)
-        input.each_with_index do |value, i|
-          error = error_for_value_input_type(value)
-          next unless error
-          next_context = Context.next_field(context, i)
-          raise Openapi3Parser::Error::InvalidType,
-                "Invalid type for #{next_context.location_summary}. "\
-                "#{error}"
-        end
-      end
-
-      def error_for_value_input_type(value)
-        type = given_value_input_type
-        return unless type
-        "Expected #{type}" unless value.is_a?(type)
-      end
-    end
-  end
-end

data/lib/openapi3_parser/node_factories/callback.rb

@@ -1,27 +0,0 @@
-# frozen_string_literal: true
-
-require "openapi3_parser/node_factory/map"
-require "openapi3_parser/node_factories/path_item"
-require "openapi3_parser/node/callback"
-
-module Openapi3Parser
-  module NodeFactories
-    class Callback
-      include NodeFactory::Map
-
-      private
-
-      def process_input(input)
-        input.each_with_object({}) do |(key, value), memo|
-          memo[key] = value if extension?(key)
-          next_context = Context.next_field(context, key)
-          memo[key] = NodeFactories::PathItem.new(next_context)
-        end
-      end
-
-      def build_map(data, context)
-        Node::Callback.new(data, context)
-      end
-    end
-  end
-end

data/lib/openapi3_parser/node_factories/map.rb

@@ -1,120 +0,0 @@
-# frozen_string_literal: true
-
-require "openapi3_parser/context"
-require "openapi3_parser/error"
-require "openapi3_parser/node_factory/map"
-require "openapi3_parser/node/map"
-require "openapi3_parser/validation/error"
-require "openapi3_parser/validation/error_collection"
-
-module Openapi3Parser
-  module NodeFactories
-    class Map
-      include NodeFactory::Map
-
-      # rubocop:disable Metrics/ParameterLists
-      def initialize(
-        context,
-        key_input_type: String,
-        value_input_type: nil,
-        value_factory: nil,
-        validate: nil,
-        default: {}
-      )
-        @given_key_input_type = key_input_type
-        @given_value_input_type = value_input_type
-        @given_value_factory = value_factory
-        @given_validate = validate
-        @given_default = default
-        super(context)
-      end
-      # rubocop:enable Metrics/ParameterLists
-
-      private
-
-      attr_reader :given_key_input_type, :given_value_input_type,
-                  :given_value_factory, :given_validate, :given_default
-
-      def process_input(input)
-        input.each_with_object({}) do |(key, value), memo|
-          memo[key] = if value_factory?
-                        next_context = Context.next_field(context, key)
-                        initialize_value_factory(next_context)
-                      else
-                        value
-                      end
-        end
-      end
-
-      def validate_type
-        error = super
-        return error if error
-        return unless given_key_input_type
-        invalid_keys = context.input.keys.reject do |key|
-          key.is_a?(given_key_input_type)
-        end
-        error = "Expected keys to be of type #{given_key_input_type}"
-        return error if invalid_keys.any?
-      end
-
-      def validate(input, context)
-        given_validate&.call(input, context)
-      end
-
-      def validate_input
-        errors = validate_value_input_type(processed_input, context)
-        Validation::ErrorCollection.combine(super, errors)
-      end
-
-      def build_node(input)
-        check_value_input_type(input)
-        super(input)
-      end
-
-      def build_map(data, context)
-        Node::Map.new(data, context)
-      end
-
-      def value_factory?
-        !given_value_factory.nil?
-      end
-
-      def initialize_value_factory(context)
-        factory = given_value_factory
-        return factory.new(context) if factory.is_a?(Class)
-        factory.call(context)
-      end
-
-      def validate_value_input_type(input, context)
-        input.each_with_object([]) do |(key, value), memo|
-          error = error_for_value_input_type(value)
-          next unless error
-          memo << Validation::Error.new(
-            error, Context.next_field(context, key), self.class
-          )
-        end
-      end
-
-      def check_value_input_type(input)
-        input.each do |key, value|
-          error = error_for_value_input_type(value)
-          next unless error
-          next_context = Context.next_field(context, key)
-          raise Openapi3Parser::Error::InvalidType,
-                "Invalid type for #{next_context.location_summary}. "\
-                "#{error}"
-        end
-      end
-
-      def error_for_value_input_type(value)
-        type = given_value_input_type
-        return unless type
-        "Expected #{type}" unless value.is_a?(type)
-      end
-
-      def default
-        given_default
-      end
-    end
-  end
-end