openapi3_parser 0.3.0 → 0.4.0

data/lib/openapi3_parser/{nodes → node}/security_requirement.rb

@@ -3,10 +3,8 @@
 require "openapi3_parser/node/map"
 
 module Openapi3Parser
-  module Nodes
+  module Node
     # @see https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md#securityRequirementObject
-    class SecurityRequirement
-      include Node::Map
-    end
+    class SecurityRequirement < Node::Map; end
   end
 end

data/lib/openapi3_parser/{nodes → node}/security_scheme.rb

@@ -1,14 +1,11 @@
 # frozen_string_literal: true
 
 require "openapi3_parser/node/object"
-require "openapi3_parser/nodes/oauth_flows"
 
 module Openapi3Parser
-  module Nodes
+  module Node
     # @see https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md#securitySchemeObject
-    class SecurityScheme
-      include Node::Object
-
+    class SecurityScheme < Node::Object
       # @return [String, nil]
       def type
         node_data["type"]
@@ -19,6 +16,11 @@ module Openapi3Parser
         node_data["description"]
       end
 
+      # @return [String, nil]
+      def description_html
+        render_markdown(description)
+      end
+
       # @return [String, nil]
       def name
         node_data["name"]

data/lib/openapi3_parser/{nodes → node}/server.rb

@@ -3,11 +3,9 @@
 require "openapi3_parser/node/object"
 
 module Openapi3Parser
-  module Nodes
+  module Node
     # @see https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md#serverObject
-    class Server
-      include Node::Object
-
+    class Server < Node::Object
       # @return [String]
       def url
         node_data["url"]
@@ -18,6 +16,11 @@ module Openapi3Parser
         node_data["description"]
       end
 
+      # @return [String, nil]
+      def description_html
+        render_markdown(description)
+      end
+
       # @return [Map<String, ServerVariable>]
       def variables
         node_data["variables"]

data/lib/openapi3_parser/{nodes → node}/server_variable.rb

@@ -3,12 +3,10 @@
 require "openapi3_parser/node/object"
 
 module Openapi3Parser
-  module Nodes
+  module Node
     # @see https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md#serverVariableObject
-    class ServerVariable
-      include Node::Object
-
-      # @return [Nodes::Array<String>, nil]
+    class ServerVariable < Node::Object
+      # @return [Node::Array<String>, nil]
       def enum
         node_data["enum"]
       end
@@ -22,6 +20,11 @@ module Openapi3Parser
       def description
         node_data["description"]
       end
+
+      # @return [String, nil]
+      def description_html
+        render_markdown(description)
+      end
     end
   end
 end

data/lib/openapi3_parser/{nodes → node}/tag.rb

@@ -3,11 +3,9 @@
 require "openapi3_parser/node/object"
 
 module Openapi3Parser
-  module Nodes
+  module Node
     # @see https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md#tagObject
-    class Tag
-      include Node::Object
-
+    class Tag < Node::Object
       # @return [String]
       def name
         node_data["name"]
@@ -18,6 +16,11 @@ module Openapi3Parser
         node_data["description"]
       end
 
+      # @return [String, nil]
+      def description_html
+        render_markdown(description)
+      end
+
       # @return [ExternalDocumentation, nil]
       def external_docs
         node_data["externalDocs"]

data/lib/openapi3_parser/{nodes → node}/xml.rb

@@ -3,11 +3,9 @@
 require "openapi3_parser/node/object"
 
 module Openapi3Parser
-  module Nodes
+  module Node
     # @see https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md#xmlObject
-    class Xml
-      include Node::Object
-
+    class Xml < Node::Object
       # @return [String, nil]
       def name
         node_data["name"]

data/lib/openapi3_parser/node_factories/array.rb

@@ -3,7 +3,7 @@
 require "openapi3_parser/context"
 require "openapi3_parser/error"
 require "openapi3_parser/node_factory"
-require "openapi3_parser/nodes/array"
+require "openapi3_parser/node/array"
 require "openapi3_parser/validation/error"
 require "openapi3_parser/validation/error_collection"
 
@@ -42,8 +42,8 @@ module Openapi3Parser
         end
       end
 
-      def validate(input, context)
-        given_validate&.call(input, context)
+      def validate(input, _context)
+        given_validate&.call(input, self)
       end
 
       def validate_input
@@ -64,7 +64,13 @@ module Openapi3Parser
       end
 
       def build_array(data, context)
-        Nodes::Array.new(data, context)
+        Node::Array.new(data, context)
+      end
+
+      def build_resolved_input
+        processed_input.map do |value|
+          value.respond_to?(:resolved_input) ? value.resolved_input : value
+        end
       end
 
       def value_factory?

data/lib/openapi3_parser/node_factories/callback.rb

@@ -2,7 +2,7 @@
 
 require "openapi3_parser/node_factory/map"
 require "openapi3_parser/node_factories/path_item"
-require "openapi3_parser/nodes/callback"
+require "openapi3_parser/node/callback"
 
 module Openapi3Parser
   module NodeFactories
@@ -20,7 +20,7 @@ module Openapi3Parser
       end
 
       def build_map(data, context)
-        Nodes::Callback.new(data, context)
+        Node::Callback.new(data, context)
       end
     end
   end

data/lib/openapi3_parser/node_factories/components.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require "openapi3_parser/nodes/components"
+require "openapi3_parser/node/components"
 require "openapi3_parser/node_factory/object"
 require "openapi3_parser/node_factory/optional_reference"
 require "openapi3_parser/node_factories/map"
@@ -13,6 +13,7 @@ require "openapi3_parser/node_factories/header"
 require "openapi3_parser/node_factories/security_scheme"
 require "openapi3_parser/node_factories/link"
 require "openapi3_parser/node_factories/callback"
+require "openapi3_parser/validators/component_keys"
 
 module Openapi3Parser
   module NodeFactories
@@ -33,7 +34,7 @@ module Openapi3Parser
       private
 
       def build_object(data, context)
-        Nodes::Components.new(data, context)
+        Node::Components.new(data, context)
       end
 
       def schemas_factory(context)
@@ -75,7 +76,8 @@ module Openapi3Parser
       def referenceable_map_factory(context, factory)
         NodeFactories::Map.new(
           context,
-          value_factory: NodeFactory::OptionalReference.new(factory)
+          value_factory: NodeFactory::OptionalReference.new(factory),
+          validate: ->(input, _) { Validators::ComponentKeys.call(input) }
         )
       end
 

data/lib/openapi3_parser/node_factories/contact.rb

@@ -1,7 +1,9 @@
 # frozen_string_literal: true
 
-require "openapi3_parser/nodes/contact"
+require "openapi3_parser/node/contact"
 require "openapi3_parser/node_factory/object"
+require "openapi3_parser/validators/url"
+require "openapi3_parser/validators/email"
 
 module Openapi3Parser
   module NodeFactories
@@ -11,13 +13,17 @@ module Openapi3Parser
       allow_extensions
 
       field "name", input_type: String
-      field "url", input_type: String
-      field "email", input_type: String
+      field "url",
+            input_type: String,
+            validate: ->(input) { Validators::Url.call(input) }
+      field "email",
+            input_type: String,
+            validate: ->(input) { Validators::Email.call(input) }
 
       private
 
       def build_object(data, context)
-        Nodes::Contact.new(data, context)
+        Node::Contact.new(data, context)
       end
     end
   end

data/lib/openapi3_parser/node_factories/discriminator.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require "openapi3_parser/nodes/discriminator"
+require "openapi3_parser/node/discriminator"
 require "openapi3_parser/node_factory/object"
 
 module Openapi3Parser
@@ -16,7 +16,7 @@ module Openapi3Parser
       private
 
       def build_object(data, context)
-        Nodes::Discriminator.new(data, context)
+        Node::Discriminator.new(data, context)
       end
 
       def validate_mapping(input)

data/lib/openapi3_parser/node_factories/encoding.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require "openapi3_parser/nodes/encoding"
+require "openapi3_parser/node/encoding"
 require "openapi3_parser/node_factory/object"
 require "openapi3_parser/node_factory/optional_reference"
 require "openapi3_parser/node_factories/map"
@@ -16,19 +16,23 @@ module Openapi3Parser
       field "contentType", input_type: String
       field "headers", factory: :headers_factory
       field "style", input_type: String
-      field "explode", input_type: :boolean, default: true
+      field "explode", input_type: :boolean, default: :default_explode
       field "allowReserved", input_type: :boolean, default: false
 
       private
 
       def build_object(data, context)
-        Nodes::Encoding.new(data, context)
+        Node::Encoding.new(data, context)
       end
 
       def headers_factory(context)
         factory = NodeFactory::OptionalReference.new(NodeFactories::Header)
         NodeFactories::Map.new(context, value_factory: factory)
       end
+
+      def default_explode
+        context.input["style"] == "form"
+      end
     end
   end
 end

data/lib/openapi3_parser/node_factories/example.rb

@@ -1,7 +1,8 @@
 # frozen_string_literal: true
 
-require "openapi3_parser/nodes/example"
+require "openapi3_parser/node/example"
 require "openapi3_parser/node_factory/object"
+require "openapi3_parser/validators/url"
 
 module Openapi3Parser
   module NodeFactories
@@ -13,12 +14,16 @@ module Openapi3Parser
       field "summary", input_type: String
       field "description", input_type: String
       field "value"
-      field "externalValue", input_type: String
+      field "externalValue",
+            input_type: String,
+            validate: ->(input) { Validators::Url.call(input) }
+
+      mutually_exclusive "value", "externalValue"
 
       private
 
       def build_object(data, context)
-        Nodes::Example.new(data, context)
+        Node::Example.new(data, context)
       end
     end
   end

data/lib/openapi3_parser/node_factories/external_documentation.rb

@@ -1,7 +1,8 @@
 # frozen_string_literal: true
 
-require "openapi3_parser/nodes/external_documentation"
+require "openapi3_parser/node/external_documentation"
 require "openapi3_parser/node_factory/object"
+require "openapi3_parser/validators/url"
 
 module Openapi3Parser
   module NodeFactories
@@ -11,12 +12,15 @@ module Openapi3Parser
       allow_extensions
 
       field "description", input_type: String
-      field "url", required: true, input_type: String
+      field "url",
+            required: true,
+            input_type: String,
+            validate: ->(input) { Validators::Url.call(input) }
 
       private
 
       def build_object(data, context)
-        Nodes::ExternalDocumentation.new(data, context)
+        Node::ExternalDocumentation.new(data, context)
       end
     end
   end

data/lib/openapi3_parser/node_factories/header.rb

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

data/lib/openapi3_parser/node_factories/info.rb

@@ -1,9 +1,10 @@
 # frozen_string_literal: true
 
-require "openapi3_parser/nodes/info"
+require "openapi3_parser/node/info"
 require "openapi3_parser/node_factories/license"
 require "openapi3_parser/node_factories/contact"
 require "openapi3_parser/node_factory/object"
+require "openapi3_parser/validators/url"
 
 module Openapi3Parser
   module NodeFactories
@@ -13,7 +14,9 @@ module Openapi3Parser
       allow_extensions
       field "title", input_type: String, required: true
       field "description", input_type: String
-      field "termsOfService", input_type: String
+      field "termsOfService",
+            input_type: String,
+            validate: ->(input) { Validators::Url.call(input) }
       field "contact", factory: Contact
       field "license", factory: License
       field "version", input_type: String, required: true
@@ -21,7 +24,7 @@ module Openapi3Parser
       private
 
       def build_object(data, context)
-        Nodes::Info.new(data, context)
+        Node::Info.new(data, context)
       end
     end
   end

data/lib/openapi3_parser/node_factories/license.rb

@@ -1,7 +1,8 @@
 # frozen_string_literal: true
 
-require "openapi3_parser/nodes/license"
+require "openapi3_parser/node/license"
 require "openapi3_parser/node_factory/object"
+require "openapi3_parser/validators/url"
 
 module Openapi3Parser
   module NodeFactories
@@ -10,12 +11,14 @@ module Openapi3Parser
 
       allow_extensions
       field "name", input_type: String, required: true
-      field "url", input_type: String
+      field "url",
+            input_type: String,
+            validate: ->(input) { Validators::Url.call(input) }
 
       private
 
       def build_object(data, context)
-        Nodes::License.new(data, context)
+        Node::License.new(data, context)
       end
     end
   end

data/lib/openapi3_parser/node_factories/link.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require "openapi3_parser/nodes/license"
+require "openapi3_parser/node/license"
 require "openapi3_parser/node_factory/object"
 require "openapi3_parser/node_factories/map"
 require "openapi3_parser/node_factories/server"
@@ -22,10 +22,12 @@ module Openapi3Parser
       field "description", input_type: String
       field "server", factory: :server_factory
 
+      mutually_exclusive "operationRef", "operationId", required: true
+
       private
 
       def build_object(data, context)
-        Nodes::Link.new(data, context)
+        Node::Link.new(data, context)
       end
 
       def parameters_factory(context)