openapi3_parser 0.2.0 → 0.3.0

data/lib/openapi3_parser/source_input/file.rb

@@ -0,0 +1,102 @@
+# frozen_string_literal: true
+
+require "openapi3_parser/source_input"
+require "openapi3_parser/source_input/string_parser"
+require "openapi3_parser/source_input/resolve_next"
+require "openapi3_parser/error"
+
+module Openapi3Parser
+  class SourceInput
+    # An input of a file on the file system
+    #
+    # @attr_reader [String] path              The absolute path to this file
+    # @attr_reader [String] working_directory The abolsute path of the
+    #                                         working directory to use when
+    #                                         opening relative references to
+    #                                         this file
+    class File < SourceInput
+      attr_reader :path, :working_directory
+
+      # @param [String]       path              The path to the file to open
+      #                                         as this source
+      # @param [String, nil]  working_directory The path to the
+      #                                         working directory to use, will
+      #                                         be calculated from path if not
+      #                                         provided
+      def initialize(path, working_directory: nil)
+        @path = ::File.absolute_path(path)
+        working_directory ||= resolve_working_directory
+        @working_directory = ::File.absolute_path(working_directory)
+        initialize_contents
+      end
+
+      # @see SourceInput#resolve_next
+      # @param  [Source::Reference] reference
+      # @return [SourceInput]
+      def resolve_next(reference)
+        ResolveNext.call(reference, self, working_directory: working_directory)
+      end
+
+      # @see SourceInput#other
+      # @param  [SourceInput] other
+      # @return [Boolean]
+      def ==(other)
+        return false unless other.instance_of?(self.class)
+        path == other.path &&
+          working_directory == other.working_directory
+      end
+
+      # return [String]
+      def inspect
+        %{#{self.class.name}(path: #{path}, working_directory: } +
+          %{#{working_directory})}
+      end
+
+      # @return [String]
+      def to_s
+        path
+      end
+
+      # Attempt to return a shorter relative path to the other source input
+      # so we can produce succinct output
+      #
+      # @return [String]
+      def relative_to(source_input)
+        other_path = if source_input.respond_to?(:path)
+                       ::File.dirname(source_input.path)
+                     elsif source_input.respond_to?(:working_directory)
+                       source_input.working_directory
+                     end
+
+        return path unless other_path
+        other_path ? relative_path(other_path, path) : path
+      end
+
+      private
+
+      def resolve_working_directory
+        ::File.dirname(path)
+      end
+
+      def parse_contents
+        begin
+          contents = ::File.read(path)
+        rescue ::StandardError => e
+          @access_error = Error::InaccessibleInput.new(e.message)
+          return
+        end
+
+        filename = ::File.basename(path)
+        StringParser.call(contents, filename)
+      end
+
+      def relative_path(from, to)
+        from_path = Pathname.new(from)
+        to_path = Pathname.new(to)
+        relative = to_path.relative_path_from(from_path).to_s
+
+        relative.size > to.size ? to : relative
+      end
+    end
+  end
+end

data/lib/openapi3_parser/source_input/raw.rb

@@ -0,0 +1,90 @@
+# frozen_string_literal: true
+
+require "openapi3_parser/source_input"
+require "openapi3_parser/source_input/string_parser"
+require "openapi3_parser/source_input/resolve_next"
+
+module Openapi3Parser
+  class SourceInput
+    # An input of data (typically a Hash) to for initialising an OpenAPI
+    # document. Most likely used in development scenarios when you want to
+    # test things without creating/tweaking an OpenAPI source file
+    #
+    # @attr_reader [Object]       raw_input         The data for the document
+    # @attr_reader [String, nil]  base_url          A url to be used for
+    #                                               resolving relative
+    #                                               references
+    # @attr_reader [String, nil]  working_directory A path to be used for
+    #                                               resolving relative
+    #                                               references
+    class Raw < SourceInput
+      attr_reader :raw_input, :base_url, :working_directory
+
+      # @param [Object]       raw_input
+      # @param [String, nil]  base_url
+      # @param [String, nil]  working_directory
+      def initialize(raw_input, base_url: nil, working_directory: nil)
+        @raw_input = raw_input
+        @base_url = base_url
+        working_directory ||= resolve_working_directory
+        @working_directory = ::File.absolute_path(working_directory)
+        initialize_contents
+      end
+
+      # @see SourceInput#resolve_next
+      # @param  [Source::Reference] reference
+      # @return [SourceInput]
+      def resolve_next(reference)
+        ResolveNext.call(reference,
+                         self,
+                         base_url: base_url,
+                         working_directory: working_directory)
+      end
+
+      # @see SourceInput#other
+      # @param  [SourceInput] other
+      # @return [Boolean]
+      def ==(other)
+        return false unless other.instance_of?(self.class)
+        raw_input == other.raw_input &&
+          base_url == other.base_url &&
+          working_directory == other.working_directory
+      end
+
+      # return [String]
+      def inspect
+        %{#{self.class.name}(input: #{raw_input.inspect}, base_url: } +
+          %{#{base_url}, working_directory: #{working_directory})}
+      end
+
+      # @return [String]
+      def to_s
+        raw_input.to_s
+      end
+
+      private
+
+      def resolve_working_directory
+        if raw_input.respond_to?(:path)
+          ::File.dirname(raw_input)
+        else
+          Dir.pwd
+        end
+      end
+
+      def parse_contents
+        return raw_input if raw_input.respond_to?(:keys)
+        StringParser.call(
+          input_to_string(raw_input),
+          raw_input.respond_to?(:path) ? ::File.basename(raw_input.path) : nil
+        )
+      end
+
+      def input_to_string(input)
+        return input.read if input.respond_to?(:read)
+        return input.to_s if input.respond_to?(:to_s)
+        input
+      end
+    end
+  end
+end

data/lib/openapi3_parser/source_input/resolve_next.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+require "openapi3_parser/source_input/file"
+require "openapi3_parser/source_input/url"
+
+module Openapi3Parser
+  class SourceInput
+    class ResolveNext
+      # @param  reference            [Source::Reference]
+      # @param  current_source_input [SourceInput]
+      # @param  base_url             [String, nil]
+      # @param  working_directory    [String, nil]
+      # @return [SourceInput]
+      def self.call(reference,
+                    current_source_input,
+                    base_url: nil,
+                    working_directory: nil)
+        new(reference, current_source_input, base_url, working_directory)
+          .source_input
+      end
+
+      def initialize(reference,
+                     current_source_input,
+                     base_url,
+                     working_directory)
+        @reference = reference
+        @current_source_input = current_source_input
+        @base_url = base_url
+        @working_directory = working_directory
+      end
+
+      private_class_method :new
+
+      def source_input
+        return current_source_input if reference.only_fragment?
+        if reference.absolute?
+          SourceInput::Url.new(reference.resource_uri)
+        else
+          base_url ? url_source_input : file_source_input
+        end
+      end
+
+      private
+
+      attr_reader :reference, :current_source_input, :base_url,
+                  :working_directory
+
+      def url_source_input
+        url = URI.join(base_url, reference.resource_uri)
+        SourceInput::Url.new(url)
+      end
+
+      def file_source_input
+        path = reference.resource_uri.path
+        return SourceInput::File.new(path) if path[0] == "/"
+
+        expanded_path = ::File.expand_path(path, working_directory)
+        SourceInput::File.new(expanded_path)
+      end
+    end
+  end
+end

data/lib/openapi3_parser/source_input/string_parser.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require "yaml"
+require "json"
+
+module Openapi3Parser
+  class SourceInput
+    class StringParser
+      def self.call(input, filename = nil)
+        new(input, filename).call
+      end
+
+      def initialize(input, filename)
+        @input = input
+        @filename = filename
+      end
+
+      def call
+        json? ? parse_json : parse_yaml
+      end
+
+      private_class_method :new
+
+      private
+
+      attr_reader :input, :filename
+
+      def json?
+        return false if filename && ::File.extname(filename) == ".yaml"
+        json_filename = filename && ::File.extname(filename) == ".json"
+        json_filename || input.strip[0] == "{"
+      end
+
+      def parse_json
+        JSON.parse(input)
+      end
+
+      def parse_yaml
+        YAML.safe_load(input, [], [], true)
+      end
+    end
+  end
+end

data/lib/openapi3_parser/source_input/url.rb

@@ -0,0 +1,123 @@
+# frozen_string_literal: true
+
+require "open-uri"
+require "openapi3_parser/source_input"
+require "openapi3_parser/source_input/string_parser"
+require "openapi3_parser/source_input/resolve_next"
+require "openapi3_parser/error"
+
+module Openapi3Parser
+  class SourceInput
+    # An input of a URL to an OpenAPI file
+    #
+    # @attr_reader [String] request_url   The URL that will be requested
+    # @attr_reader [String] resolved_url  The eventual URL of the file that was
+    #                                     accessed, this may differ to the
+    #                                     request_url in the case of redirects
+    class Url < SourceInput
+      attr_reader :request_url, :resolved_url
+
+      # @param [String, URI] request_url
+      def initialize(request_url)
+        @request_url = request_url.to_s
+        initialize_contents
+      end
+
+      # @see SourceInput#resolve_next
+      # @param  [Source::Reference] reference
+      # @return [SourceInput]
+      def resolve_next(reference)
+        ResolveNext.call(reference, self, base_url: resolved_url)
+      end
+
+      # @see SourceInput#other
+      # @param  [SourceInput] other
+      # @return [Boolean]
+      def ==(other)
+        return false unless other.instance_of?(self.class)
+        [request_url, resolved_url].include?(other.request_url) ||
+          [request_url, resolved_url].include?(other.resolved_url)
+      end
+
+      # return [String]
+      def url
+        resolved_url || request_url
+      end
+
+      # return [String]
+      def inspect
+        %{#{self.class.name}(url: #{url})}
+      end
+
+      # @return [String]
+      def to_s
+        request_url
+      end
+
+      # @return [String]
+      def relative_to(source_input)
+        other_url = if source_input.respond_to?(:url)
+                      source_input.url
+                    elsif source_input.respond_to?(:base_url)
+                      source_input.base_url
+                    end
+
+        return url unless other_url
+
+        other_url ? RelativeUrlDifference.call(other_url, url) : url
+      end
+
+      private
+
+      def parse_contents
+        begin
+          file = URI.parse(request_url).open
+        rescue ::StandardError => e
+          @access_error = Error::InaccessibleInput.new(e.message)
+          return
+        end
+        @resolved_url = file.base_uri.to_s
+        StringParser.call(file.read, resolved_url)
+      end
+
+      class RelativeUrlDifference
+        def initialize(from_url, to_url)
+          @from_uri = URI.parse(from_url)
+          @to_uri = URI.parse(to_url)
+        end
+
+        def self.call(from_url, to_url)
+          new(from_url, to_url).call
+        end
+
+        def call
+          return to_uri.to_s if different_hosts?
+          relative_path
+        end
+
+        private_class_method :new
+
+        private
+
+        attr_reader :from_uri, :to_uri
+
+        def different_hosts?
+          URI.join(from_uri, "/") != URI.join(to_uri, "/")
+        end
+
+        def relative_path
+          relative = to_uri.route_from(from_uri)
+          return relative.to_s unless relative.path.empty?
+
+          # if we have same path it's nice to show just the filename
+          file_and_query(to_uri)
+        end
+
+        def file_and_query(uri)
+          Pathname.new(uri.path).basename.to_s +
+            (uri.query ? "?#{uri.query}" : "")
+        end
+      end
+    end
+  end
+end

data/lib/openapi3_parser/validation/error.rb

@@ -1,13 +1,46 @@
 # frozen_string_literal: true
 
+require "forwardable"
+
 module Openapi3Parser
   module Validation
+    # Represents a validation error for an OpenAPI document
+    # @attr_reader [String]     message       The error message
+    # @attr_reader [Context]    context       The context where this was
+    #                                         validated
+    # @attr_reader [Class, nil] factory_class The NodeFactory that was being
+    #                                         created when this error was found
     class Error
-      attr_reader :namespace, :message
+      extend Forwardable
+
+      attr_reader :message, :context, :factory_class
+
+      # @!method source_location
+      #   The source file and pointer for where this error occurred
+      #   @return [Context::Location]
+      def_delegator :context, :source_location
+
+      alias to_s message
 
-      def initialize(namespace, message)
-        @namespace = namespace
+      # @param [String]     message
+      # @param [Context]    context
+      # @param [Class, nil] factory_class
+      def initialize(message, context, factory_class = nil)
         @message = message
+        @context = context
+        @factory_class = factory_class
+      end
+
+      # @return [String, nil]
+      def for_type
+        return unless factory_class
+        factory_class.name.split("::").last
+      end
+
+      # @return [String]
+      def inspect
+        "#{self.class.name}(message: #{message}, context: #{context}, " \
+          "for_type: #{for_type})"
       end
     end
   end