openapi3_parser 0.3.0 → 0.4.0

data/lib/openapi3_parser/{nodes → node}/link.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#linkObject
-    class Link
-      include Node::Object
-
+    class Link < Node::Object
       # @return [String, nil]
       def operation_ref
         node_data["operationRef"]
@@ -33,6 +31,11 @@ module Openapi3Parser
         node_data["description"]
       end
 
+      # @return [String, nil]
+      def description_html
+        render_markdown(description)
+      end
+
       # @return [Server, nil]
       def server
         node_data["server"]

data/lib/openapi3_parser/node/map.rb

@@ -2,7 +2,7 @@
 
 module Openapi3Parser
   module Node
-    module Map
+    class Map
       include Enumerable
 
       attr_reader :node_data, :node_context

data/lib/openapi3_parser/{nodes → node}/media_type.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#mediaTypeObject
-    class MediaType
-      include Node::Object
-
+    class MediaType < Node::Object
       # @return [Schema, nil]
       def schema
         node_data["schema"]

data/lib/openapi3_parser/{nodes → node}/oauth_flow.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#oauthFlowObject
-    class OauthFlow
-      include Node::Object
-
+    class OauthFlow < Node::Object
       # @return [String, nil]
       def authorization_url
         node_data["authorizationUrl"]

data/lib/openapi3_parser/{nodes → node}/oauth_flows.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#oauthFlowsObject
-    class OauthFlows
-      include Node::Object
-
+    class OauthFlows < Node::Object
       # @return [OauthFlow, nil]
       def implicit
         node_data["implicit"]

data/lib/openapi3_parser/node/object.rb

@@ -1,8 +1,10 @@
 # frozen_string_literal: true
 
+require "openapi3_parser/markdown"
+
 module Openapi3Parser
   module Node
-    module Object
+    class Object
       include Enumerable
 
       attr_reader :node_data, :node_context
@@ -48,6 +50,14 @@ module Openapi3Parser
       def each(&block)
         node_data.each(&block)
       end
+
+      # Used to render fields that can be in markdown syntax into HTML
+      # @param  [String, nil] value
+      # @return [String, nil]
+      def render_markdown(value)
+        return if value.nil?
+        Markdown.to_html(value)
+      end
     end
   end
 end

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

@@ -1,15 +1,13 @@
 # frozen_string_literal: true
 
 require "openapi3_parser/node/object"
-require "openapi3_parser/nodes/components"
+require "openapi3_parser/node/components"
 
 module Openapi3Parser
-  module Nodes
+  module Node
     # OpenAPI Root Object
     # @see https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md#oasObject
-    class Openapi
-      include Node::Object
-
+    class Openapi < Node::Object
       # @return [String]
       def openapi
         node_data["openapi"]
@@ -20,7 +18,7 @@ module Openapi3Parser
         node_data["info"]
       end
 
-      # @return [Nodes::Array<Server>]
+      # @return [Node::Array<Server>]
       def servers
         node_data["servers"]
       end
@@ -35,12 +33,12 @@ module Openapi3Parser
         node_data["components"]
       end
 
-      # @return [Nodes::Array<SecurityRequirement>]
+      # @return [Node::Array<SecurityRequirement>]
       def security
         node_data["security"]
       end
 
-      # @return [Nodes::Array<Tag>]
+      # @return [Node::Array<Tag>]
       def tags
         node_data["tags"]
       end

data/lib/openapi3_parser/{nodes → node}/operation.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#operationObject
-    class Operation
-      include Node::Object
-
-      # @return [Nodes::Array<String>]
+    class Operation < Node::Object
+      # @return [Node::Array<String>]
       def tags
         node_data["tags"]
       end
@@ -23,6 +21,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"]
@@ -33,7 +36,7 @@ module Openapi3Parser
         node_data["operationId"]
       end
 
-      # @return [Nodes::Array<Parameter>]
+      # @return [Node::Array<Parameter>]
       def parameters
         node_data["parameters"]
       end
@@ -58,12 +61,12 @@ module Openapi3Parser
         node_data["deprecated"]
       end
 
-      # @return [Nodes::Array<SecurityRequirement>]
+      # @return [Node::Array<SecurityRequirement>]
       def security
         node_data["security"]
       end
 
-      # @return [Nodes::Array<Server>]
+      # @return [Node::Array<Server>]
       def servers
         node_data["servers"]
       end

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

@@ -1,13 +1,12 @@
 # frozen_string_literal: true
 
 require "openapi3_parser/node/object"
-require "openapi3_parser/nodes/parameter/parameter_like"
+require "openapi3_parser/node/parameter_like"
 
 module Openapi3Parser
-  module Nodes
+  module Node
     # @see https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md#parameterObject
-    class Parameter
-      include Node::Object
+    class Parameter < Node::Object
       include ParameterLike
 
       # @return [String]

data/lib/openapi3_parser/node/parameter_like.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+module Openapi3Parser
+  module Node
+    # This contains methods that are shared between nodes that act like a
+    # Parameter, at the time of writing this was {Header}[../Header.html]
+    # and {Parameter}[../Paramater.html]
+    module ParameterLike
+      # @return [String]
+      def description
+        node_data["description"]
+      end
+
+      # @return [String, nil]
+      def description_html
+        render_markdown(description)
+      end
+
+      # @return [Boolean]
+      def required?
+        node_data["required"]
+      end
+
+      # @return [Boolean]
+      def deprecated?
+        node_data["deprecated"]
+      end
+
+      # @return [Boolean]
+      def allow_empty_value?
+        node_data["allowEmptyValue"]
+      end
+
+      # @return [String, nil]
+      def style
+        node_data["style"]
+      end
+
+      # @return [Boolean]
+      def explode?
+        node_data["explode"]
+      end
+
+      # @return [Boolean]
+      def allow_reserved?
+        node_data["allowReserved"]
+      end
+
+      # @return [Schema, nil]
+      def schema
+        node_data["schema"]
+      end
+
+      # @return [Any]
+      def example
+        node_data["example"]
+      end
+
+      # @return [Map<String, Example>, nil]
+      def examples
+        node_data["examples"]
+      end
+
+      # @return [Map<String, MediaType>, nil]
+      def content
+        node_data["content"]
+      end
+    end
+  end
+end

data/lib/openapi3_parser/{nodes → node}/path_item.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#pathItemObject
-    class PathItem
-      include Node::Object
-
+    class PathItem < Node::Object
       # @return [String, nil]
       def summary
         node_data["summary"]
@@ -18,6 +16,11 @@ module Openapi3Parser
         node_data["description"]
       end
 
+      # @return [String, nil]
+      def description_html
+        render_markdown(description)
+      end
+
       # @return [Operation, nil]
       def get
         node_data["get"]
@@ -58,12 +61,12 @@ module Openapi3Parser
         node_data["trace"]
       end
 
-      # @return [Nodes::Array<Server>]
+      # @return [Node::Array<Server>]
       def servers
         node_data["servers"]
       end
 
-      # @return [Nodes::Array<Parameter>]
+      # @return [Node::Array<Parameter>]
       def parameters
         node_data["parameters"]
       end

data/lib/openapi3_parser/{nodes → node}/paths.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#pathsObject
-    class Paths
-      include Node::Map
-    end
+    class Paths < Node::Map; end
   end
 end

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

@@ -3,16 +3,19 @@
 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#requestBodyObject
-    class RequestBody
-      include Node::Object
-
+    class RequestBody < Node::Object
       # @return [String, nil]
       def description
         node_data["description"]
       end
 
+      # @return [String, nil]
+      def description_html
+        render_markdown(description)
+      end
+
       # @return [Map<String, MediaType>]
       def content
         node_data["content"]

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

@@ -3,16 +3,19 @@
 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#responseObject
-    class Response
-      include Node::Object
-
+    class Response < Node::Object
       # @return [String]
       def description
         node_data["description"]
       end
 
+      # @return [String]
+      def description_html
+        render_markdown(description)
+      end
+
       # @return [Map<String, Header>]
       def headers
         node_data["headers"]

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

@@ -3,11 +3,9 @@
 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#responsesObject
-    class Responses
-      include Node::Map
-
+    class Responses < Node::Map
       # @return [Response]
       def default
         node_data["default"]

data/lib/openapi3_parser/{nodes → node}/schema.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#schemaObject
     # rubocop:disable ClassLength
-    class Schema
-      include Node::Object
-
+    class Schema < Node::Object
       # @return [String, nil]
       def title
         node_data["title"]
@@ -79,12 +77,12 @@ module Openapi3Parser
         node_data["minProperties"]
       end
 
-      # @return [Nodes::Array<String>, nil]
+      # @return [Node::Array<String>, nil]
       def required
         node_data["required"]
       end
 
-      # @return [Nodes::Array<Object>, nil]
+      # @return [Node::Array<Object>, nil]
       def enum
         node_data["enum"]
       end
@@ -94,17 +92,17 @@ module Openapi3Parser
         node_data["type"]
       end
 
-      # @return [Nodes::Array<Schema>, nil]
+      # @return [Node::Array<Schema>, nil]
       def all_of
         node_data["allOf"]
       end
 
-      # @return [Nodes::Array<Schema>, nil]
+      # @return [Node::Array<Schema>, nil]
       def one_of
         node_data["oneOf"]
       end
 
-      # @return [Nodes::Array<Schema>, nil]
+      # @return [Node::Array<Schema>, nil]
       def any_of
         node_data["anyOf"]
       end
@@ -141,6 +139,11 @@ module Openapi3Parser
         node_data["description"]
       end
 
+      # @return [String, nil]
+      def description_html
+        render_markdown(description)
+      end
+
       # @return [String, nil]
       def format
         node_data["format"]