openapi3_parser 0.6.1 → 0.9.0

data/lib/openapi3_parser/node_factory/schema.rb

@@ -39,7 +39,7 @@ module Openapi3Parser
       field "default"
 
       field "nullable", input_type: :boolean, default: false
-      field "discriminator", factory: :disciminator_factory
+      field "discriminator", factory: :discriminator_factory
       field "readOnly", input_type: :boolean, default: false
       field "writeOnly", input_type: :boolean, default: false
       field "xml", factory: :xml_factory
@@ -61,6 +61,7 @@ module Openapi3Parser
       def read_only_or_write_only(validatable)
         input = validatable.input
         return if [input["readOnly"], input["writeOnly"]].uniq != [true]
+
         validatable.add_error("readOnly and writeOnly cannot both be true")
       end
 
@@ -80,7 +81,7 @@ module Openapi3Parser
         NodeFactory::Array.new(context, default: nil)
       end
 
-      def disciminator_factory(context)
+      def discriminator_factory(context)
         NodeFactory::Discriminator.new(context)
       end
 
@@ -114,11 +115,13 @@ module Openapi3Parser
       def additional_properties_input_type(validatable)
         input = validatable.input
         return if [true, false].include?(input) || input.is_a?(Hash)
+
         validatable.add_error("Expected a Boolean or an Object")
       end
 
       def additional_properties_factory(context)
         return context.input if [true, false].include?(context.input)
+
         referenceable_schema(context)
       end
     end

data/lib/openapi3_parser/node_factory/server_variable.rb

@@ -19,6 +19,7 @@ module Openapi3Parser
           value_input_type: String,
           validate: lambda do |validatable|
             return if validatable.input.any?
+
             validatable.add_error("Expected atleast one value")
           end
         )

data/lib/openapi3_parser/node_factory/type_checker.rb

@@ -27,9 +27,11 @@ module Openapi3Parser
 
       def validate_type(validatable, context)
         return true unless type
+
         context ||= validatable.context
         valid_type?(context.input).tap do |valid|
           next if valid
+
           validatable.add_error("Invalid type. #{field_error_message}",
                                 context)
         end
@@ -37,9 +39,11 @@ module Openapi3Parser
 
       def validate_keys(validatable, context)
         return true unless type
+
         context ||= validatable.context
         valid_keys?(context.input).tap do |valid|
           next if valid
+
           validatable.add_error("Invalid keys. #{keys_error_message}",
                                 context)
         end
@@ -47,6 +51,7 @@ module Openapi3Parser
 
       def raise_on_invalid_type(context)
         return true if !type || valid_type?(context.input)
+
         raise Error::InvalidType,
               "Invalid type for #{context.location_summary}: "\
               "#{field_error_message}"
@@ -54,6 +59,7 @@ module Openapi3Parser
 
       def raise_on_invalid_keys(context)
         return true if !type || valid_keys?(context.input)
+
         raise Error::InvalidType,
               "Invalid keys for #{context.location_summary}: "\
               "#{keys_error_message}"

data/lib/openapi3_parser/source.rb

@@ -93,6 +93,7 @@ module Openapi3Parser
     # @return [Object]
     def data_at_pointer(json_pointer)
       return data if json_pointer.empty?
+
       data.dig(*json_pointer) if data.respond_to?(:dig)
     end
 
@@ -104,6 +105,7 @@ module Openapi3Parser
     # @return [String]
     def relative_to_root
       return "" if root?
+
       source_input.relative_to(document.root_source.source_input)
     end
 

data/lib/openapi3_parser/source/location.rb

@@ -1,15 +1,20 @@
 # frozen_string_literal: true
 
+require "forwardable"
+
 module Openapi3Parser
   class Source
     # Class used to represent a location within an OpenAPI document.
     # It contains a source, which is the source file/data used for the contents
     # and the pointer which indicates where in the object like file the data is
     class Location
+      extend Forwardable
+
       def self.next_field(location, field)
         new(location.source, location.pointer.segments + [field])
       end
 
+      def_delegators :pointer, :root?
       attr_reader :source, :pointer
 
       # @param [Openapi3Parser::Source] source
@@ -21,6 +26,7 @@ module Openapi3Parser
 
       def ==(other)
         return false unless other.instance_of?(self.class)
+
         source == other.source && pointer == other.pointer
       end
 

data/lib/openapi3_parser/source/pointer.rb

@@ -12,10 +12,11 @@ module Openapi3Parser
         absolute = fragment[0] == "/"
         segments = fragment.split("/").map do |part|
           next if part == ""
+
           unescaped = CGI.unescape(part.gsub("%20", "+"))
           unescaped.match?(/\A\d+\z/) ? unescaped.to_i : unescaped
         end
-        new(segments.compact, absolute)
+        new(segments.compact, absolute: absolute)
       end
 
       def self.merge_pointers(base_pointer, new_pointer)
@@ -26,7 +27,7 @@ module Openapi3Parser
 
       # @param [::Array] segments
       # @param [Boolean] absolute
-      def initialize(segments, absolute = true)
+      def initialize(segments, absolute: true)
         @segments = segments.freeze
         @absolute = absolute
       end
@@ -38,7 +39,7 @@ module Openapi3Parser
       def fragment
         fragment = segments.map { |s| CGI.escape(s.to_s).gsub("+", "%20") }
                            .join("/")
-        "#" + (absolute ? fragment.prepend("/") : fragment)
+        "##{absolute ? fragment.prepend('/') : fragment}"
       end
 
       def to_s
@@ -49,6 +50,10 @@ module Openapi3Parser
         %{#{self.class.name}(segments: #{segments}, fragment: "#{fragment}")}
       end
 
+      def root?
+        segments.empty?
+      end
+
       class MergePointers
         private_class_method :new
 
@@ -75,7 +80,7 @@ module Openapi3Parser
         def create_pointer(pointer_like)
           case pointer_like
           when Pointer then pointer_like
-          when ::Array then Pointer.new(pointer_like, false)
+          when ::Array then Pointer.new(pointer_like, absolute: false)
           when ::String then Pointer.from_fragment(pointer_like)
           when nil then nil
           else raise Openapi3Parser::Error, "Unexpected type for pointer"

data/lib/openapi3_parser/source_input.rb

@@ -20,6 +20,14 @@ module Openapi3Parser
   class SourceInput
     attr_reader :access_error, :parse_error
 
+    def initialize
+      return if access_error
+
+      @contents = parse_contents
+    rescue ::StandardError => e
+      @parse_error = Error::UnparsableInput.new(e.message)
+    end
+
     # Indicates that the data within this input is suitable (i.e. can parse
     # underlying JSON or YAML) for trying to use as part of a Document
     def available?
@@ -45,6 +53,7 @@ module Openapi3Parser
     def contents
       raise access_error if access_error
       raise parse_error if parse_error
+
       @contents
     end
 
@@ -56,14 +65,5 @@ module Openapi3Parser
     def relative_to(_source_input)
       ""
     end
-
-    private
-
-    def initialize_contents
-      return if access_error
-      @contents = parse_contents
-    rescue ::StandardError => e
-      @parse_error = Error::UnparsableInput.new(e.message)
-    end
   end
 end

data/lib/openapi3_parser/source_input/file.rb

@@ -24,7 +24,7 @@ module Openapi3Parser
         @path = ::File.absolute_path(path)
         working_directory ||= resolve_working_directory
         @working_directory = ::File.absolute_path(working_directory)
-        initialize_contents
+        super()
       end
 
       # @see SourceInput#resolve_next
@@ -39,6 +39,7 @@ module Openapi3Parser
       # @return [Boolean]
       def ==(other)
         return false unless other.instance_of?(self.class)
+
         path == other.path &&
           working_directory == other.working_directory
       end
@@ -66,6 +67,7 @@ module Openapi3Parser
                      end
 
         return path unless other_path
+
         other_path ? relative_path(other_path, path) : path
       end
 

data/lib/openapi3_parser/source_input/raw.rb

@@ -26,7 +26,7 @@ module Openapi3Parser
         @base_url = base_url
         working_directory ||= resolve_working_directory
         @working_directory = ::File.absolute_path(working_directory)
-        initialize_contents
+        super()
       end
 
       # @see SourceInput#resolve_next
@@ -44,6 +44,7 @@ module Openapi3Parser
       # @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
@@ -72,6 +73,7 @@ module Openapi3Parser
 
       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
@@ -81,6 +83,7 @@ module Openapi3Parser
       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

data/lib/openapi3_parser/source_input/resolve_next.rb

@@ -30,6 +30,7 @@ module Openapi3Parser
 
       def source_input
         return current_source_input if reference.only_fragment?
+
         if reference.absolute?
           SourceInput::Url.new(reference.resource_uri)
         else

data/lib/openapi3_parser/source_input/string_parser.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require "yaml"
+require "psych"
 require "json"
 
 module Openapi3Parser
@@ -27,6 +27,7 @@ module Openapi3Parser
 
       def json?
         return false if filename && ::File.extname(filename) == ".yaml"
+
         json_filename = filename && ::File.extname(filename) == ".json"
         json_filename || input.strip[0] == "{"
       end
@@ -36,7 +37,7 @@ module Openapi3Parser
       end
 
       def parse_yaml
-        YAML.safe_load(input, [Date, Time], [], true)
+        Psych.safe_load(input, permitted_classes: [Date, Time], aliases: true)
       end
     end
   end

data/lib/openapi3_parser/source_input/url.rb

@@ -17,7 +17,7 @@ module Openapi3Parser
       # @param [String, URI] request_url
       def initialize(request_url)
         @request_url = request_url.to_s
-        initialize_contents
+        super()
       end
 
       # @see SourceInput#resolve_next
@@ -32,6 +32,7 @@ module Openapi3Parser
       # @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
@@ -89,6 +90,7 @@ module Openapi3Parser
 
         def call
           return to_uri.to_s if different_hosts?
+
           relative_path
         end
 

data/lib/openapi3_parser/validation/error.rb

@@ -35,6 +35,7 @@ module Openapi3Parser
       def for_type
         return unless factory_class
         return "(anonymous)" unless factory_class.name
+
         factory_class.name.split("::").last
       end
 
@@ -47,6 +48,7 @@ module Openapi3Parser
       # @return [Boolean]
       def ==(other)
         return false unless other.instance_of?(self.class)
+
         message == other.message &&
           context == other.context &&
           factory_class == other.factory_class

data/lib/openapi3_parser/validation/error_collection.rb

@@ -56,7 +56,7 @@ module Openapi3Parser
         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)
+            memo[key] = memo.fetch(key, []) + item.errors.map(&:to_s)
           end
         end
       end

data/lib/openapi3_parser/validation/input_validator.rb

@@ -10,7 +10,7 @@ module Openapi3Parser
       end
 
       def call(validatable)
-        error = @callable.call(validatable.input)
+        error = callable.call(validatable.input)
         validatable.add_error(error) if error
       end
     end

data/lib/openapi3_parser/validators/component_keys.rb

@@ -6,7 +6,7 @@ module Openapi3Parser
     # 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/
+      REGEX = /\A[a-zA-Z0-9.\-_]+\Z/.freeze
 
       def self.call(input)
         invalid = input.keys.reject { |key| REGEX.match(key) }

data/lib/openapi3_parser/validators/duplicate_parameters.rb

@@ -17,6 +17,7 @@ module Openapi3Parser
       def duplicate_names_by_in(resolved_input)
         potential_items = resolved_input.reject do |item|
           next true unless item.respond_to?(:keys)
+
           item["name"].nil? || item["in"].nil?
         end
 

data/lib/openapi3_parser/validators/email.rb

@@ -7,12 +7,12 @@ module Openapi3Parser
       # 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](?:[a-zA-Z0-9-]{0,61}[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
+      }x.freeze
 
       def self.call(input)
         message = %("#{input}" is not a valid email address)

data/lib/openapi3_parser/validators/media_type.rb

@@ -9,7 +9,7 @@ module Openapi3Parser
         / # separating slash
         ([-+.\w]+|\*) # word (with +, - & .) or asterisk
         \Z
-      }x
+      }x.freeze
 
       def self.call(input)
         message = %("#{input}" is not a valid media type)

data/lib/openapi3_parser/validators/mutually_exclusive_fields.rb

@@ -8,8 +8,8 @@ module Openapi3Parser
       using ArraySentence
       private_class_method :new
 
-      def self.call(*args)
-        new.call(*args)
+      def self.call(*args, **kwargs)
+        new.call(*args, **kwargs)
       end
 
       def call(validatable,
@@ -78,12 +78,12 @@ module Openapi3Parser
 
         def errors
           @errors ||= begin
-                        default = { required: [], exclusive: [] }
-                        mutually_exclusive_fields
-                          .each_with_object(default) do |exclusive, errors|
-                            add_error(errors, exclusive)
-                          end
-                      end
+            default = { required: [], exclusive: [] }
+            mutually_exclusive_fields
+              .each_with_object(default) do |exclusive, errors|
+                add_error(errors, exclusive)
+              end
+          end
         end
 
         private