openapi3_parser 0.3.0 → 0.4.0

data/lib/openapi3_parser/node_factory/object/validator.rb

@@ -35,6 +35,7 @@ module Openapi3Parser
           [
             missing_required_fields_error,
             unexpected_fields_error,
+            mututally_exclusive_fields_errors,
             invalid_field_errors
           ].flatten.compact
         end
@@ -77,13 +78,20 @@ module Openapi3Parser
           end
         end
 
+        def mututally_exclusive_fields_errors
+          MututallyExclusiveFieldErrors.call(factory, input)
+        end
+
         def field_errors(name, field_config)
+          return if input[name].nil?
           field = input[name]
-          return if field.nil?
-          return field.errors.to_a if field.respond_to?(:errors)
-          type_error = build_type_error(name, field_config)
-          return type_error if type_error
-          build_validation_errors(name, field_config)
+
+          if field.respond_to?(:errors) && !field.errors.empty?
+            field.errors.to_a
+          else
+            build_type_error(name, field_config) ||
+              build_validation_errors(name, field_config)
+          end
         end
 
         def build_type_error(name, field_config)
@@ -101,12 +109,67 @@ module Openapi3Parser
             raw_input[name], factory
           ).map do |error|
             Validation::Error.new(
-              "Invalid field: #{error}",
+              error,
               Context.next_field(context, name),
               factory.class
             )
           end
         end
+
+        class MututallyExclusiveFieldErrors
+          def self.call(*args)
+            new.call(*args)
+          end
+
+          def call(factory, input)
+            factory
+              .mutually_exclusive_fields
+              .each_with_object([]) do |mutually_exclusive, memo|
+                error = determine_error(mutually_exclusive, input, factory)
+                memo << error if error
+              end
+          end
+
+          private
+
+          def determine_error(mutually_exclusive, input, factory)
+            fields = mutually_exclusive.fields
+            number_non_nil = count_non_nil_fields(fields, input)
+
+            if number_non_nil.zero? && mutually_exclusive.required
+              required_error(fields, factory)
+            elsif number_non_nil > 1
+              exclusive_error(fields, factory)
+            end
+          end
+
+          def count_non_nil_fields(fields, input)
+            fields.count do |field|
+              data = input[field]
+              data.respond_to?(:nil_input?) ? !data.nil_input? : !data.nil?
+            end
+          end
+
+          def required_error(fields, factory)
+            Validation::Error.new(
+              "one of #{sentence_fields(fields)} is required",
+              factory.context,
+              factory.class
+            )
+          end
+
+          def exclusive_error(fields, factory)
+            Validation::Error.new(
+              "#{sentence_fields(fields)} are mutually exclusive fields",
+              factory.context,
+              factory.class
+            )
+          end
+
+          def sentence_fields(fields)
+            fields[0..-2].join(", ") + " and " + fields[-1]
+          end
+        end
       end
     end
   end

data/lib/openapi3_parser/source/reference.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require "cgi"
+
 require "openapi3_parser/source"
 require "openapi3_parser/validators/reference"
 

data/lib/openapi3_parser/source/reference_resolver.rb

@@ -16,7 +16,7 @@ module Openapi3Parser
         @reference_factory ||= begin
                                  next_context = Context.reference_field(
                                    context,
-                                   input: source.data_at_pointer(json_pointer),
+                                   input: data,
                                    source: source,
                                    pointer_segments: json_pointer
                                  )
@@ -24,6 +24,10 @@ module Openapi3Parser
                                end
       end
 
+      def data
+        source.data_at_pointer(json_pointer)
+      end
+
       def valid?
         errors.empty?
       end

data/lib/openapi3_parser/validators/absolute_uri.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Openapi3Parser
+  module Validators
+    class AbsoluteUri
+      def self.call(input)
+        uri = URI.parse(input)
+        %("#{input}" is not a absolute URI) unless uri.absolute?
+      rescue URI::InvalidURIError
+        %("#{input}" is not a valid URI)
+      end
+    end
+  end
+end

data/lib/openapi3_parser/validators/component_keys.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Openapi3Parser
+  module Validators
+    # This validates that the keys of an object match the format of those
+    # defined for a Components node.
+    # As defined: https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.1.md#components-object
+    class ComponentKeys
+      REGEX = /\A[a-zA-Z0-9\.\-_]+\Z/
+
+      def self.call(input)
+        invalid = input.keys.reject { |key| REGEX.match(key) }
+        "Contains invalid keys: #{invalid.join(', ')}" unless invalid.empty?
+      end
+    end
+  end
+end

data/lib/openapi3_parser/validators/duplicate_parameters.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Openapi3Parser
+  module Validators
+    class DuplicateParameters
+      def self.call(resolved_input)
+        new.call(resolved_input)
+      end
+
+      def call(resolved_input)
+        dupes = duplicate_names_by_in(resolved_input)
+        message(dupes) unless dupes.empty?
+      end
+
+      private
+
+      def duplicate_names_by_in(resolved_input)
+        resolved_input.reject { |item| item["name"].nil? || item["in"].nil? }
+                      .group_by { |item| [item["name"], item["in"]] }
+                      .delete_if { |_, group| group.size < 2 }
+                      .keys
+      end
+
+      def message(dupes)
+        grouped = dupes.map { |d| "#{d.first} in #{d.last}" }.join(", ")
+        "Duplicate parameters: #{grouped}"
+      end
+    end
+  end
+end

data/lib/openapi3_parser/validators/email.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Openapi3Parser
+  module Validators
+    class Email
+      # Regex is sourced from HTML specification:
+      # https://html.spec.whatwg.org/#e-mail-state-(type=email)
+      REGEX = %r{
+        \A
+        [a-zA-Z0-9.!#$%&'*+\/=?^_`{|}~-]+
+        @
+        [a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?
+        (?:\.[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)*
+        \Z
+      }x
+
+      def self.call(input)
+        message = %("#{input}" is not a valid email address)
+        message unless REGEX.match(input)
+      end
+    end
+  end
+end

data/lib/openapi3_parser/validators/media_type.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Openapi3Parser
+  module Validators
+    class MediaType
+      REGEX = %r{
+        \A
+        (\w+|\*) # word or asterisk
+        / # separating slash
+        ([-+.\w]+|\*) # word (with +, - & .) or asterisk
+        \Z
+      }x
+
+      def self.call(input)
+        message = %("#{input}" is not a valid media type)
+        message unless REGEX.match(input)
+      end
+    end
+  end
+end

data/lib/openapi3_parser/validators/url.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Openapi3Parser
+  module Validators
+    class Url
+      def self.call(input)
+        message = %("#{input}" is not a valid URL)
+        uri = URI.parse(input)
+
+        message if !uri.relative? &&
+                   !uri.is_a?(URI::HTTP) &&
+                   !uri.is_a?(URI::HTTPS)
+      rescue URI::InvalidURIError
+        message
+      end
+    end
+  end
+end

data/lib/openapi3_parser/version.rb

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

data/openapi3_parser.gemspec

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-lib = File.expand_path("../lib", __FILE__)
+lib = File.expand_path("lib", __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require "openapi3_parser/version"
 
@@ -25,9 +25,12 @@ Gem::Specification.new do |spec|
 
   spec.required_ruby_version = ">= 2.3.0"
 
+  spec.add_dependency "commonmarker", "~> 0.17"
+
   spec.add_development_dependency "bundler", "~> 1.15"
+  spec.add_development_dependency "byebug", "~> 10.0"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.6"
-  spec.add_development_dependency "rubocop", "~> 0.51"
+  spec.add_development_dependency "rubocop", "~> 0.53.0"
   spec.add_development_dependency "webmock", "~> 3.1"
 end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: openapi3_parser
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Kevin Dew
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-01-31 00:00:00.000000000 Z
+date: 2018-07-18 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: commonmarker
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.17'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.17'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -24,6 +38,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  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: rake
   requirement: !ruby/object:Gem::Requirement
@@ -58,14 +86,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.51'
+        version: 0.53.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.51'
+        version: 0.53.0
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
@@ -107,8 +135,40 @@ files:
 - lib/openapi3_parser/document.rb
 - lib/openapi3_parser/document/reference_register.rb
 - lib/openapi3_parser/error.rb
+- lib/openapi3_parser/markdown.rb
+- lib/openapi3_parser/node/array.rb
+- lib/openapi3_parser/node/callback.rb
+- lib/openapi3_parser/node/components.rb
+- lib/openapi3_parser/node/contact.rb
+- lib/openapi3_parser/node/discriminator.rb
+- lib/openapi3_parser/node/encoding.rb
+- lib/openapi3_parser/node/example.rb
+- lib/openapi3_parser/node/external_documentation.rb
+- lib/openapi3_parser/node/header.rb
+- lib/openapi3_parser/node/info.rb
+- lib/openapi3_parser/node/license.rb
+- lib/openapi3_parser/node/link.rb
 - lib/openapi3_parser/node/map.rb
+- lib/openapi3_parser/node/media_type.rb
+- lib/openapi3_parser/node/oauth_flow.rb
+- lib/openapi3_parser/node/oauth_flows.rb
 - lib/openapi3_parser/node/object.rb
+- lib/openapi3_parser/node/openapi.rb
+- lib/openapi3_parser/node/operation.rb
+- lib/openapi3_parser/node/parameter.rb
+- lib/openapi3_parser/node/parameter_like.rb
+- lib/openapi3_parser/node/path_item.rb
+- lib/openapi3_parser/node/paths.rb
+- lib/openapi3_parser/node/request_body.rb
+- lib/openapi3_parser/node/response.rb
+- lib/openapi3_parser/node/responses.rb
+- lib/openapi3_parser/node/schema.rb
+- lib/openapi3_parser/node/security_requirement.rb
+- lib/openapi3_parser/node/security_scheme.rb
+- lib/openapi3_parser/node/server.rb
+- 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
@@ -150,38 +210,6 @@ files:
 - lib/openapi3_parser/node_factory/object/node_builder.rb
 - lib/openapi3_parser/node_factory/object/validator.rb
 - lib/openapi3_parser/node_factory/optional_reference.rb
-- lib/openapi3_parser/nodes/array.rb
-- lib/openapi3_parser/nodes/callback.rb
-- lib/openapi3_parser/nodes/components.rb
-- lib/openapi3_parser/nodes/contact.rb
-- lib/openapi3_parser/nodes/discriminator.rb
-- lib/openapi3_parser/nodes/encoding.rb
-- lib/openapi3_parser/nodes/example.rb
-- lib/openapi3_parser/nodes/external_documentation.rb
-- lib/openapi3_parser/nodes/header.rb
-- lib/openapi3_parser/nodes/info.rb
-- lib/openapi3_parser/nodes/license.rb
-- lib/openapi3_parser/nodes/link.rb
-- lib/openapi3_parser/nodes/map.rb
-- lib/openapi3_parser/nodes/media_type.rb
-- lib/openapi3_parser/nodes/oauth_flow.rb
-- lib/openapi3_parser/nodes/oauth_flows.rb
-- lib/openapi3_parser/nodes/openapi.rb
-- lib/openapi3_parser/nodes/operation.rb
-- lib/openapi3_parser/nodes/parameter.rb
-- lib/openapi3_parser/nodes/parameter/parameter_like.rb
-- lib/openapi3_parser/nodes/path_item.rb
-- lib/openapi3_parser/nodes/paths.rb
-- lib/openapi3_parser/nodes/request_body.rb
-- lib/openapi3_parser/nodes/response.rb
-- lib/openapi3_parser/nodes/responses.rb
-- lib/openapi3_parser/nodes/schema.rb
-- lib/openapi3_parser/nodes/security_requirement.rb
-- lib/openapi3_parser/nodes/security_scheme.rb
-- lib/openapi3_parser/nodes/server.rb
-- lib/openapi3_parser/nodes/server_variable.rb
-- lib/openapi3_parser/nodes/tag.rb
-- lib/openapi3_parser/nodes/xml.rb
 - lib/openapi3_parser/source.rb
 - lib/openapi3_parser/source/reference.rb
 - lib/openapi3_parser/source/reference_resolver.rb
@@ -193,7 +221,13 @@ files:
 - lib/openapi3_parser/source_input/url.rb
 - lib/openapi3_parser/validation/error.rb
 - lib/openapi3_parser/validation/error_collection.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/reference.rb
+- lib/openapi3_parser/validators/url.rb
 - lib/openapi3_parser/version.rb
 - openapi3_parser.gemspec
 homepage: https://github.com/kevindew/openapi_parser