openapi3_parser 0.3.0 → 0.4.0

data/lib/openapi3_parser/node_factories/reference.rb

@@ -26,6 +26,10 @@ module Openapi3Parser
       def ref_factory(context)
         Fields::Reference.new(context, factory)
       end
+
+      def build_resolved_input
+        processed_input["$ref"].data
+      end
     end
   end
 end

data/lib/openapi3_parser/node_factories/request_body.rb

@@ -1,9 +1,12 @@
 # frozen_string_literal: true
 
-require "openapi3_parser/nodes/request_body"
+require "openapi3_parser/context"
+require "openapi3_parser/node/request_body"
 require "openapi3_parser/node_factory/object"
 require "openapi3_parser/node_factories/media_type"
 require "openapi3_parser/node_factories/map"
+require "openapi3_parser/validation/error"
+require "openapi3_parser/validators/media_type"
 
 module Openapi3Parser
   module NodeFactories
@@ -18,14 +21,40 @@ module Openapi3Parser
       private
 
       def build_object(data, context)
-        Nodes::RequestBody.new(data, context)
+        Node::RequestBody.new(data, context)
       end
 
       def content_factory(context)
         NodeFactories::Map.new(
-          context, value_factory: NodeFactories::MediaType
+          context,
+          value_factory: NodeFactories::MediaType,
+          validate: ContentValidator
         )
       end
+
+      class ContentValidator
+        def self.call(*args)
+          new.call(*args)
+        end
+
+        def call(input, context)
+          # This validation isn't actually mentioned in the spec, but it
+          # doesn't seem to make sense if this is an empty hash.
+          return "Expected to have at least 1 item" if input.size.zero?
+
+          input.keys.each_with_object([]) do |key, memo|
+            message = Validators::MediaType.call(key)
+            memo << create_error(key, context, message) if message
+          end
+        end
+
+        private
+
+        def create_error(key, parent_context, message)
+          context = Context.next_field(parent_context, key)
+          Validation::Error.new(message, context)
+        end
+      end
     end
   end
 end

data/lib/openapi3_parser/node_factories/response.rb

@@ -1,12 +1,16 @@
 # frozen_string_literal: true
 
-require "openapi3_parser/nodes/response"
+require "openapi3_parser/context"
+require "openapi3_parser/node/response"
 require "openapi3_parser/node_factory/object"
 require "openapi3_parser/node_factory/optional_reference"
 require "openapi3_parser/node_factories/map"
 require "openapi3_parser/node_factories/header"
 require "openapi3_parser/node_factories/media_type"
 require "openapi3_parser/node_factories/link"
+require "openapi3_parser/validation/error"
+require "openapi3_parser/validators/media_type"
+require "openapi3_parser/validators/component_keys"
 
 module Openapi3Parser
   module NodeFactories
@@ -22,7 +26,7 @@ module Openapi3Parser
       private
 
       def build_object(data, context)
-        Nodes::Response.new(data, context)
+        Node::Response.new(data, context)
       end
 
       def headers_factory(context)
@@ -32,13 +36,29 @@ module Openapi3Parser
 
       def content_factory(context)
         NodeFactories::Map.new(
-          context, value_factory: NodeFactories::MediaType
+          context,
+          validate: method(:validate_content),
+          value_factory: NodeFactories::MediaType
         )
       end
 
       def links_factory(context)
         factory = NodeFactory::OptionalReference.new(NodeFactories::Link)
-        NodeFactories::Map.new(context, value_factory: factory)
+        NodeFactories::Map.new(
+          context,
+          validate: ->(input, _) { Validators::ComponentKeys.call(input) },
+          value_factory: factory
+        )
+      end
+
+      def validate_content(input, context)
+        input.keys.each_with_object([]) do |key, memo|
+          message = Validators::MediaType.call(key)
+          next unless message
+          memo << Validation::Error.new(
+            message, Context.next_field(context, key)
+          )
+        end
       end
     end
   end

data/lib/openapi3_parser/node_factories/responses.rb

@@ -4,13 +4,23 @@ require "openapi3_parser/context"
 require "openapi3_parser/node_factories/response"
 require "openapi3_parser/node_factory/map"
 require "openapi3_parser/node_factory/optional_reference"
-require "openapi3_parser/nodes/responses"
+require "openapi3_parser/node/responses"
 
 module Openapi3Parser
   module NodeFactories
     class Responses
       include NodeFactory::Map
 
+      KEY_REGEX = /
+        \A
+        (
+        default
+        |
+        [1-5]([0-9][0-9]|XX)
+        )
+        \Z
+      /x
+
       private
 
       def process_input(input)
@@ -27,7 +37,23 @@ module Openapi3Parser
       end
 
       def build_map(data, context)
-        Nodes::Responses.new(data, context)
+        Node::Responses.new(data, context)
+      end
+
+      def validate(input, _context)
+        validate_keys(input.keys)
+      end
+
+      def validate_keys(keys)
+        invalid = keys.reject do |key|
+          extension?(key) || KEY_REGEX.match(key)
+        end
+
+        return if invalid.empty?
+
+        codes = invalid.map { |k| "'#{k}'" }.join(", ")
+        "Invalid responses keys: #{codes} - default, status codes and status "\
+        "code ranges allowed"
       end
     end
   end

data/lib/openapi3_parser/node_factories/schema.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require "openapi3_parser/nodes/schema"
+require "openapi3_parser/node/schema"
 require "openapi3_parser/node_factory/object"
 require "openapi3_parser/node_factory/optional_reference"
 require "openapi3_parser/node_factories/map"
@@ -23,7 +23,7 @@ module Openapi3Parser
       field "exclusiveMinimum", input_type: :boolean, default: false
       field "maxLength", input_type: Integer
       field "minLength", input_type: Integer, default: 0
-      field :pattern, input_type: String
+      field "pattern", input_type: String
       field "maxItems", input_type: Integer
       field "minItems", input_type: Integer, default: 0
       field "uniqueItems", input_type: :boolean, default: false
@@ -59,7 +59,21 @@ module Openapi3Parser
       private
 
       def build_object(data, context)
-        Nodes::Schema.new(data, context)
+        Node::Schema.new(data, context)
+      end
+
+      def validate(input, _context)
+        errors = []
+
+        if input["type"] == "array" && resolved_input["items"].nil?
+          errors << "items must be defined for a type of array"
+        end
+
+        if input["readOnly"] == true && input["writeOnly"] == true
+          errors << "readOnly and writeOnly cannot both be true"
+        end
+
+        errors
       end
 
       def required_factory(context)

data/lib/openapi3_parser/node_factories/security_requirement.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require "openapi3_parser/nodes/security_requirement"
+require "openapi3_parser/node/security_requirement"
 require "openapi3_parser/node_factory/map"
 require "openapi3_parser/node_factories/array"
 
@@ -19,7 +19,7 @@ module Openapi3Parser
       end
 
       def build_map(data, context)
-        Nodes::SecurityRequirement.new(data, context)
+        Node::SecurityRequirement.new(data, context)
       end
     end
   end

data/lib/openapi3_parser/node_factories/security_scheme.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require "openapi3_parser/nodes/security_scheme"
+require "openapi3_parser/node/security_scheme"
 require "openapi3_parser/node_factories/oauth_flows"
 require "openapi3_parser/node_factory/object"
 require "openapi3_parser/node_factory/optional_reference"
@@ -24,7 +24,7 @@ module Openapi3Parser
       private
 
       def build_object(data, context)
-        Nodes::SecurityScheme.new(data, context)
+        Node::SecurityScheme.new(data, context)
       end
 
       def flows_factory(context)

data/lib/openapi3_parser/node_factories/server.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require "openapi3_parser/nodes/server"
+require "openapi3_parser/node/server"
 require "openapi3_parser/node_factory/object"
 require "openapi3_parser/node_factories/server_variable"
 require "openapi3_parser/node_factories/map"
@@ -18,7 +18,7 @@ module Openapi3Parser
       private
 
       def build_object(data, context)
-        Nodes::Server.new(data, context)
+        Node::Server.new(data, context)
       end
 
       def variables_factory(context)

data/lib/openapi3_parser/node_factories/server_variable.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require "openapi3_parser/nodes/server_variable"
+require "openapi3_parser/node/server_variable"
 require "openapi3_parser/node_factory/object"
 require "openapi3_parser/node_factories/array"
 
@@ -29,7 +29,7 @@ module Openapi3Parser
       end
 
       def build_object(data, context)
-        Nodes::ServerVariable.new(data, context)
+        Node::ServerVariable.new(data, context)
       end
     end
   end

data/lib/openapi3_parser/node_factories/tag.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require "openapi3_parser/nodes/tag"
+require "openapi3_parser/node/tag"
 require "openapi3_parser/node_factory/object"
 require "openapi3_parser/node_factories/external_documentation"
 
@@ -17,7 +17,7 @@ module Openapi3Parser
       private
 
       def build_object(data, context)
-        Nodes::Tag.new(data, context)
+        Node::Tag.new(data, context)
       end
     end
   end

data/lib/openapi3_parser/node_factories/xml.rb

@@ -1,7 +1,8 @@
 # frozen_string_literal: true
 
-require "openapi3_parser/nodes/xml"
+require "openapi3_parser/node/xml"
 require "openapi3_parser/node_factory/object"
+require "openapi3_parser/validators/absolute_uri"
 
 module Openapi3Parser
   module NodeFactories
@@ -10,7 +11,9 @@ module Openapi3Parser
 
       allow_extensions
       field "name", input_type: String
-      field "namespace", input_type: String
+      field "namespace",
+            input_type: String,
+            validate: ->(input) { Validators::AbsoluteUri.call(input) }
       field "prefix", input_type: String
       field "attribute", input_type: :boolean, default: false
       field "wrapped", input_type: :boolean, default: false
@@ -18,7 +21,7 @@ module Openapi3Parser
       private
 
       def build_object(data, context)
-        Nodes::Xml.new(data, context)
+        Node::Xml.new(data, context)
       end
     end
   end

data/lib/openapi3_parser/node_factory.rb

@@ -44,7 +44,7 @@ module Openapi3Parser
 
     EXTENSION_REGEX = /^x-(.*)/
 
-    attr_reader :context
+    attr_reader :context, :processed_input
 
     def initialize(context)
       @context = context
@@ -68,9 +68,11 @@ module Openapi3Parser
       context.input.nil?
     end
 
-    private
+    def resolved_input
+      @resolved_input ||= processed_input ? build_resolved_input : nil
+    end
 
-    attr_reader :processed_input
+    private
 
     def validate(_input, _context); end
 
@@ -78,9 +80,13 @@ module Openapi3Parser
       transform_errors(validate(context.input, context))
     end
 
+    def build_resolved_input
+      context.input
+    end
+
     def transform_errors(errors)
       error_objects = Array(errors).map do |error|
-        if !error.is_a?(Validation::Error)
+        if error.is_a?(Validation::Error)
           error
         else
           Validation::Error.new(error, context, self.class)

data/lib/openapi3_parser/node_factory/fields/reference.rb

@@ -17,6 +17,10 @@ module Openapi3Parser
           @reference_resolver = create_reference_resolver
         end
 
+        def data
+          reference_resolver&.data
+        end
+
         private
 
         attr_reader :given_reference, :factory, :reference_resolver

data/lib/openapi3_parser/node_factory/map.rb

@@ -35,6 +35,16 @@ module Openapi3Parser
         data
       end
 
+      def build_resolved_input
+        processed_input.each_with_object({}) do |(key, value), memo|
+          memo[key] = if value.respond_to?(:resolved_input)
+                        value.resolved_input
+                      else
+                        value
+                      end
+        end
+      end
+
       def default
         {}
       end

data/lib/openapi3_parser/node_factory/object.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require "ostruct"
+
 require "openapi3_parser/context"
 require "openapi3_parser/node_factory"
 require "openapi3_parser/node_factory/field_config"
@@ -33,6 +35,17 @@ module Openapi3Parser
         def allowed_extensions?
           @allow_extensions == true
         end
+
+        def mutually_exclusive(*fields, required: false)
+          @mutually_exclusive ||= []
+          @mutually_exclusive << OpenStruct.new(
+            fields: fields, required: required
+          )
+        end
+
+        def mutually_exclusive_fields
+          @mutually_exclusive || []
+        end
       end
 
       def self.included(base)
@@ -47,6 +60,10 @@ module Openapi3Parser
         self.class.allowed_extensions?
       end
 
+      def mutually_exclusive_fields
+        self.class.mutually_exclusive_fields
+      end
+
       def field_configs
         self.class.field_configs || {}
       end
@@ -55,6 +72,7 @@ module Openapi3Parser
 
       def process_input(input)
         field_configs.each_with_object(input.dup) do |(field, config), memo|
+          memo[field] = nil unless memo[field]
           next unless config.factory?
           next_context = Context.next_field(context, field)
           memo[field] = config.initialize_factory(next_context, self)
@@ -74,6 +92,17 @@ module Openapi3Parser
       def build_object(data, _context)
         data
       end
+
+      def build_resolved_input
+        processed_input.each_with_object({}) do |(key, value), memo|
+          next if value.respond_to?(:nil_input?) && value.nil_input?
+          memo[key] = if value.respond_to?(:resolved_input)
+                        value.resolved_input
+                      else
+                        value
+                      end
+        end
+      end
     end
   end
 end