openapi3_parser 0.2.0 → 0.3.0

data/lib/openapi3_parser/validation/error_collection.rb

@@ -2,35 +2,77 @@
 
 module Openapi3Parser
   module Validation
+    # An immutable collection of Validation::Error objects
+    # @attr_reader [Array<Validation::Error>] errors
     class ErrorCollection
-      def initialize(*errors)
-        reset
-        append(*errors)
-      end
+      include Enumerable
 
-      def append(*errors)
-        errors.each { |e| @errors << e }
+      # Combines ErrorCollection objects or arrays of Validation::Error objects
+      # @param  [ErrorCollection, Array<Validation::Error>] errors
+      # @param  [ErrorCollection, Array<Validation::Error>] other_errors
+      # @return [ErrorCollection]
+      def self.combine(errors, other_errors)
+        new(errors.to_a + other_errors.to_a)
       end
 
-      def reset
-        @errors = []
-      end
+      attr_reader :errors
+      alias to_a errors
 
-      def merge(error_collection)
-        append(*error_collection.to_a)
+      # @param  [Array<Validation::Error>] errors
+      def initialize(errors = [])
+        @errors = errors.freeze
       end
 
       def empty?
         errors.empty?
       end
 
-      def to_a
-        errors.dup
+      def each(&block)
+        errors.each(&block)
       end
 
-      private
+      # Group errors by those in the same location for the same node
+      #
+      # @return [Array<LocationTypeGroup]
+      def group_errors
+        grouped = group_by do |e|
+          [e.source_location.to_s, e.for_type]
+        end
 
-      attr_reader :errors
+        grouped.map do |_, errors|
+          LocationTypeGroup.new(errors[0].source_location,
+                                errors[0].for_type,
+                                errors)
+        end
+      end
+
+      # Return a hash structure where the location is key and the errors are
+      # values
+      #
+      # @return [Hash]
+      def to_h
+        grouped = group_errors.group_by { |g| g.source_location.to_s }
+
+        grouped.each_with_object({}) do |(_, items), memo|
+          items.each do |item|
+            key = item.location_summary(with_type: items.count > 1)
+            memo[key] = (memo[key] || []) + item.errors.map(&:to_s)
+          end
+        end
+      end
+
+      # @return [String]
+      def inspect
+        "#{self.class.name}(errors: #{to_h})"
+      end
+
+      LocationTypeGroup = Struct.new(:source_location, :for_type, :errors) do
+        def location_summary(with_type: false)
+          string = source_location.to_s
+          string << " (as #{for_type})" if with_type && !for_type&.empty?
+          string
+        end
+      end
     end
   end
 end

data/lib/openapi3_parser/validators/reference.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Openapi3Parser
+  module Validators
+    class Reference
+      def initialize(given_reference)
+        @given_reference = given_reference
+      end
+
+      def valid?
+        errors.empty?
+      end
+
+      def errors
+        @errors ||= Array(build_errors)
+      end
+
+      private
+
+      attr_reader :given_reference
+
+      def build_errors
+        return "expected a string" unless given_reference.is_a?(String)
+        begin
+          uri = URI.parse(given_reference)
+        rescue URI::Error
+          return "could not parse as a URI"
+        end
+        check_fragment(uri) || []
+      end
+
+      def check_fragment(uri)
+        return if uri.fragment.nil? || uri.fragment.empty?
+        first_char = uri.fragment[0]
+
+        "invalid JSON pointer, expected a root slash" if first_char != "/"
+      end
+    end
+  end
+end

data/lib/openapi3_parser/version.rb

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

data/openapi3_parser.gemspec

@@ -7,22 +7,27 @@ require "openapi3_parser/version"
 Gem::Specification.new do |spec|
   spec.name          = "openapi3_parser"
   spec.version       = Openapi3Parser::VERSION
-  spec.authors       = ["Kevin Dew"]
-  spec.email         = ["kevindew@me.com"]
+  spec.author        = "Kevin Dew"
+  spec.email         = "kevindew@me.com"
 
   spec.summary       = "An OpenAPI V3 parser for Ruby"
-  spec.description   = "An OpenAPI V3 parser for Ruby"
+  spec.description   = <<-DESCRIPTION
+    A tool to parse and validate OpenAPI V3 files.
+    Aims to provide complete compatibility with the OpenAPI specification and
+    to provide a natural, idiomatic way to interact with a openapi.yaml file.
+  DESCRIPTION
   spec.homepage      = "https://github.com/kevindew/openapi_parser"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^spec/})
   end
-  spec.require_paths = ["lib"]
+
+  spec.required_ruby_version = ">= 2.3.0"
 
   spec.add_development_dependency "bundler", "~> 1.15"
-  spec.add_development_dependency "byebug", "~> 9.1"
   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 "webmock", "~> 3.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: openapi3_parser
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Kevin Dew
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-12-09 00:00:00.000000000 Z
+date: 2018-01-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -25,64 +25,66 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.15'
 - !ruby/object:Gem::Dependency
-  name: byebug
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '9.1'
+        version: '10.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '9.1'
+        version: '10.0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '3.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '3.6'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.6'
+        version: '0.51'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.6'
+        version: '0.51'
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.51'
+        version: '3.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.51'
-description: An OpenAPI V3 parser for Ruby
-email:
-- kevindew@me.com
+        version: '3.1'
+description: |2
+      A tool to parse and validate OpenAPI V3 files.
+      Aims to provide complete compatibility with the OpenAPI specification and
+      to provide a natural, idiomatic way to interact with a openapi.yaml file.
+email: kevindew@me.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -100,10 +102,11 @@ files:
 - TODO.md
 - lib/openapi3_parser.rb
 - lib/openapi3_parser/context.rb
+- lib/openapi3_parser/context/location.rb
+- lib/openapi3_parser/context/pointer.rb
 - lib/openapi3_parser/document.rb
+- lib/openapi3_parser/document/reference_register.rb
 - lib/openapi3_parser/error.rb
-- lib/openapi3_parser/fields/map.rb
-- lib/openapi3_parser/node.rb
 - lib/openapi3_parser/node/map.rb
 - lib/openapi3_parser/node/object.rb
 - lib/openapi3_parser/node_factories/array.rb
@@ -141,6 +144,7 @@ files:
 - 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/fields/reference.rb
 - lib/openapi3_parser/node_factory/map.rb
 - lib/openapi3_parser/node_factory/object.rb
 - lib/openapi3_parser/node_factory/object/node_builder.rb
@@ -178,8 +182,18 @@ files:
 - 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
+- lib/openapi3_parser/source_input.rb
+- lib/openapi3_parser/source_input/file.rb
+- lib/openapi3_parser/source_input/raw.rb
+- lib/openapi3_parser/source_input/resolve_next.rb
+- lib/openapi3_parser/source_input/string_parser.rb
+- lib/openapi3_parser/source_input/url.rb
 - lib/openapi3_parser/validation/error.rb
 - lib/openapi3_parser/validation/error_collection.rb
+- lib/openapi3_parser/validators/reference.rb
 - lib/openapi3_parser/version.rb
 - openapi3_parser.gemspec
 homepage: https://github.com/kevindew/openapi_parser
@@ -194,7 +208,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="

data/lib/openapi3_parser/fields/map.rb

@@ -1,83 +0,0 @@
-# frozen_string_literal: true
-
-require "openapi3_parser/error"
-
-module Openapi3Parser
-  module Fields
-    class Map
-      private_class_method :new
-
-      def initialize(input, context, value_type, key_format)
-        @input = input
-        @context = context
-        @value_type = value_type
-        @key_format = key_format
-      end
-
-      def self.call(
-        input,
-        context,
-        value_type: Hash,
-        key_format: nil,
-        &block
-      )
-        new(input, context, value_type, key_format).call(&block)
-      end
-
-      def self.reference_input(
-        input,
-        context,
-        value_type: Hash,
-        key_format: nil,
-        &block
-      )
-        call(
-          input, context, value_type: value_type, key_format: key_format
-        ) do |field_input, field_context|
-          field_context.possible_reference(field_input, &block)
-        end
-      end
-
-      def call(&block)
-        validate_keys
-        validate_values
-
-        input.each_with_object({}) do |(key, value), memo|
-          memo[key] = if block
-                        yield(value, context.next_namespace(key), key)
-                      else
-                        value
-                      end
-        end
-      end
-
-      private
-
-      attr_reader :input, :context, :value_type, :key_format
-
-      def validate_keys
-        return unless key_format
-        invalid_keys = input.keys.reject { |key| key =~ key_format }
-        return if invalid_keys.empty?
-
-        raise Openapi3Parser::Error, "Invalid field names for "\
-          "#{context.stringify_namespace}: #{invalid_keys.join(', ')}"
-      end
-
-      def validate_values
-        return unless value_type
-        invalid = input.reject do |key, value|
-          if value_type.is_a?(Proc)
-            value.call(value, key)
-          else
-            value.is_a?(value_type)
-          end
-        end
-        return if invalid.empty?
-
-        raise Openapi3Parser::Error, "Unexpected type for "\
-          "#{context.stringify_namespace}: #{invalid.keys.join(', ')}"
-      end
-    end
-  end
-end

data/lib/openapi3_parser/node.rb

@@ -1,115 +0,0 @@
-# frozen_string_literal: true
-
-require "openapi3_parser/node/field_config"
-
-module Openapi3Parser
-  module Node
-    module ClassMethods
-      def field(name, **options)
-        @field_configs ||= {}
-        @field_configs[name] = FieldConfig.new(options)
-      end
-
-      def field_configs
-        @field_configs || {}
-      end
-
-      def allow_extensions
-        @allow_extensions = true
-      end
-
-      def disallow_extensions
-        @allow_extensions = false
-      end
-
-      def allowed_extensions?
-        @allow_extensions == true
-      end
-    end
-
-    def self.included(base)
-      base.extend(ClassMethods)
-    end
-
-    EXTENSION_REGEX = /^x-(.*)/
-
-    attr_reader :input, :context, :fields
-
-    def initialize(input, context)
-      @input = input
-      @context = context
-      @fields = build_fields(input)
-    end
-
-    def [](value)
-      fields[value]
-    end
-
-    def extension(value)
-      fields["x-#{value}"]
-    end
-
-    private
-
-    def build_fields(input)
-      check_for_unexpected_fields(input)
-      create_fields(input)
-    end
-
-    def check_for_unexpected_fields(input)
-      allowed_fields = field_configs.keys
-      remaining_fields = input.keys - allowed_fields
-      return if remaining_fields.empty?
-
-      if allowed_extensions?
-        remaining_fields.reject! { |key| key =~ EXTENSION_REGEX }
-      end
-
-      return if remaining_fields.empty?
-      raise Error,
-            "Unexpected attributes for #{context.stringify_namespace}: "\
-            "#{remaining_fields.join(', ')}"
-    end
-
-    def create_fields(input)
-      check_required(input)
-      check_types(input)
-      fields = field_configs.each_with_object({}) do |(field, config), memo|
-        next_context = context.next_namespace(field)
-        memo[field] = config.build(input[field], self, next_context)
-      end
-      extensions = input.select { |(k, _)| k =~ EXTENSION_REGEX }
-      fields.merge(extensions)
-    end
-
-    def check_required(input)
-      missing = field_configs.reject do |field, config|
-        config.valid_presence?(input[field])
-      end
-
-      return if missing.empty?
-      raise Error,
-            "Missing required fields for #{context.stringify_namespace}: "\
-              "#{missing.keys}"
-    end
-
-    def check_types(input)
-      invalid = field_configs.reject do |field, config|
-        config.valid_input_type?(input[field], self)
-      end
-
-      return if invalid.empty?
-      raise Error,
-            "Invalid fields for #{context.stringify_namespace}: "\
-              "#{invalid.keys}"
-    end
-
-    def allowed_extensions?
-      self.class.allowed_extensions?
-    end
-
-    def field_configs
-      self.class.field_configs || {}
-    end
-  end
-end