swagger-blocks 2.0.2 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 404b9602f5da9794e8be26ad7bfb2e843f670e39
-  data.tar.gz: dbee5a43cd192a43fe752704067b525592cd5708
+SHA256:
+  metadata.gz: 32f19fd2faba19b9d8fd4111231781cc850037de8aa3042b7d0b7c35093370d4
+  data.tar.gz: 5799cb21a1651e9845d833aae1ee3eb318a475f31d204147e332b0a7c7305251
 SHA512:
-  metadata.gz: 3bf6cd4d6fd437f153c0ea1ac24d961392f205e10f03a5a517791f4305fb4010b36a8b8046d3f06ab010c1e653b09e663f0ef92b15a3335148684aef94876d9f
-  data.tar.gz: a4851231553d499aea5ff4870b37f0f4ae807d962b00cfb9cb62da910e69b21ce15ae58f6a38592be3d7c91d64d879842060b16add4e6cb17a08a69cb92ee269
+  metadata.gz: ed7faabe133513535df3165f36d090ef3a8fbc7171d04d0d820c0f673fe118117b5ddbd23790175099224a8c1a56c495ddb15ec7306d2cf038de331ef5b48cff
+  data.tar.gz: 2a8ea7db734e7093086f5e8a75d15af7f8208a37c89d172a4f0af7fd12aff91c1c23ca9eaa4a21089d4150092114ae8c21dde7ea004b0629b3497383a73141c3

data/.github/ISSUE_TEMPLATE.md

@@ -0,0 +1,4 @@
+#
+# PLEASE READ THIS BEFORE FILING AN ISSUE:
+# https://github.com/fotinakis/swagger-blocks/#filing-issues
+#

data/lib/swagger/blocks.rb

@@ -9,26 +9,40 @@ module Swagger
 
     module Nodes
       autoload :AllOfNode, 'swagger/blocks/nodes/all_of_node'
+      autoload :CallbackNode, 'swagger/blocks/nodes/callback_node'
+      autoload :CallbackDestinationNode, 'swagger/blocks/nodes/callback_destination_node'
+      autoload :CallbackMethodNode, 'swagger/blocks/nodes/callback_method_node'
+      autoload :ComponentNode, 'swagger/blocks/nodes/component_node'
       autoload :ContactNode, 'swagger/blocks/nodes/contact_node'
+      autoload :ContentNode, 'swagger/blocks/nodes/content_node'
       autoload :ExampleNode, 'swagger/blocks/nodes/example_node'
       autoload :ExternalDocsNode, 'swagger/blocks/nodes/external_docs_node'
+      autoload :FlowNode, 'swagger/blocks/nodes/flow_node'
       autoload :HeaderNode, 'swagger/blocks/nodes/header_node'
       autoload :InfoNode, 'swagger/blocks/nodes/info_node'
       autoload :ItemsNode, 'swagger/blocks/nodes/items_node'
       autoload :LicenseNode, 'swagger/blocks/nodes/license_node'
+      autoload :LinkNode, 'swagger/blocks/nodes/link_node'
+      autoload :LinkParameterNode, 'swagger/blocks/nodes/link_parameter_node'
+      autoload :OneOfNode, 'swagger/blocks/nodes/one_of_node'
       autoload :OperationNode, 'swagger/blocks/nodes/operation_node'
       autoload :ParameterNode, 'swagger/blocks/nodes/parameter_node'
       autoload :PathNode, 'swagger/blocks/nodes/path_node'
       autoload :PropertiesNode, 'swagger/blocks/nodes/properties_node'
       autoload :PropertyNode, 'swagger/blocks/nodes/property_node'
+      autoload :RequestBodyNode, 'swagger/blocks/nodes/request_body_node'
       autoload :ResponseNode, 'swagger/blocks/nodes/response_node'
       autoload :RootNode, 'swagger/blocks/nodes/root_node'
       autoload :SchemaNode, 'swagger/blocks/nodes/schema_node'
       autoload :ScopesNode, 'swagger/blocks/nodes/scopes_node'
       autoload :SecurityRequirementNode, 'swagger/blocks/nodes/security_requirement_node'
       autoload :SecuritySchemeNode, 'swagger/blocks/nodes/security_scheme_node'
+      autoload :ServerNode, 'swagger/blocks/nodes/server_node'
       autoload :TagNode, 'swagger/blocks/nodes/tag_node'
+      autoload :ValueNode, 'swagger/blocks/nodes/value_node'
+      autoload :VariableNode, 'swagger/blocks/nodes/variable_node'
       autoload :XmlNode, 'swagger/blocks/nodes/xml_node'
+      autoload :VendorExtensionNode, 'swagger/blocks/nodes/vendor_extension_node'
     end
   end
 end

data/lib/swagger/blocks/class_methods.rb

@@ -9,6 +9,14 @@ module Swagger
         @swagger_root_node ||= Swagger::Blocks::Nodes::RootNode.call(inline_keys: inline_keys, &block)
       end
 
+      def version
+        if defined?(@swagger_root_node) && @swagger_root_node.data[:info] && @swagger_root_node.data[:info].version == '3.0.0'
+          '3.0.0'
+        else
+          '2.0'
+        end
+      end
+
       # v2.0: Defines a Swagger Path Item object
       # https://github.com/swagger-api/swagger-spec/blob/master/versions/2.0.md#path-item-object
       def swagger_path(path, &block)
@@ -25,7 +33,7 @@ module Swagger
           path_node.instance_eval(&block)
         else
           # First time we've seen this path
-          @swagger_path_node_map[path] = Swagger::Blocks::Nodes::PathNode.call(version: '2.0', &block)
+          @swagger_path_node_map[path] = Swagger::Blocks::Nodes::PathNode.call(version: version, &block)
         end
       end
 
@@ -41,10 +49,14 @@ module Swagger
           schema_node.instance_eval(&block)
         else
           # First time we've seen this schema_node
-          @swagger_schema_node_map[name] = Swagger::Blocks::Nodes::SchemaNode.call(version: '2.0', inline_keys: inline_keys, &block)
+          @swagger_schema_node_map[name] = Swagger::Blocks::Nodes::SchemaNode.call(version: version, inline_keys: inline_keys, &block)
         end
       end
 
+      def swagger_component(inline_keys = nil, &block)
+        @swagger_components_node ||= Swagger::Blocks::Nodes::ComponentNode.call(version: '3.0.0', inline_keys: inline_keys, &block)
+      end
+
       def _swagger_nodes
         # Avoid initialization warnings.
         @swagger_root_node ||= nil
@@ -52,12 +64,14 @@ module Swagger
         @swagger_schema_node_map ||= nil
         @swagger_api_root_node_map ||= {}
         @swagger_models_node ||= nil
+        @swagger_components_node ||= nil
 
         data = {root_node: @swagger_root_node}
         data[:path_node_map] = @swagger_path_node_map
         data[:schema_node_map] = @swagger_schema_node_map
         data[:api_node_map] = @swagger_api_root_node_map
         data[:models_node] = @swagger_models_node
+        data[:component_node] = @swagger_components_node
         data
       end
     end

data/lib/swagger/blocks/internal_helpers.rb

@@ -10,6 +10,8 @@ module Swagger
 
         path_node_map = {}
         schema_node_map = {}
+        component_node = nil
+
         swaggered_classes.each do |swaggered_class|
           next unless swaggered_class.respond_to?(:_swagger_nodes, true)
           swagger_nodes = swaggered_class.send(:_swagger_nodes)
@@ -23,11 +25,29 @@ module Swagger
           if swagger_nodes[:schema_node_map]
             schema_node_map.merge!(swagger_nodes[:schema_node_map])
           end
+          if swagger_nodes[:component_node]
+            if component_node
+              merge_components(component_node, swagger_nodes, :examples)
+              merge_components(component_node, swagger_nodes, :links)
+              merge_components(component_node, swagger_nodes, :parameters)
+              merge_components(component_node, swagger_nodes, :requestBodies)
+              merge_components(component_node, swagger_nodes, :responses)
+              merge_components(component_node, swagger_nodes, :schemas)
+              merge_components(component_node, swagger_nodes, :securitySchemes)
+            else
+              component_node = swagger_nodes[:component_node]
+            end
+          end
         end
+
         data = {root_node: self.limit_root_node(root_nodes)}
+
         if data[:root_node].is_swagger_2_0?
           data[:path_nodes] = path_node_map
           data[:schema_nodes] = schema_node_map
+        elsif data[:root_node].is_openapi_3_0?
+          data[:path_nodes] = path_node_map
+          data[:component_node] = component_node
         else
           data[:api_node_map] = api_node_map
           data[:models_nodes] = models_nodes
@@ -35,6 +55,11 @@ module Swagger
         data
       end
 
+      def self.merge_components(component_node, swagger_nodes, key)
+        component_node.data[key] ||= {}
+        component_node.data[key].merge!(swagger_nodes[:component_node].data[key]) if swagger_nodes[:component_node].data[key]
+      end
+
       # Make sure there is exactly one root_node and return it.
       # TODO should this merge the contents of the root nodes instead?
       def self.limit_root_node(root_nodes)

data/lib/swagger/blocks/node.rb

@@ -4,6 +4,8 @@ module Swagger
     class Node
       attr_accessor :name
       attr_writer :version
+      VERSION_2 = '2.0'
+      VERSION_3 = '3.0.0'
 
       def self.call(options = {}, &block)
         # Create a new instance and evaluate the block into it.
@@ -15,20 +17,35 @@ module Swagger
         instance
       end
 
-      def as_json
-        result = {}
+      def as_json(options = {})
+        version = options.fetch(:version, VERSION_2)
 
+        result = {}
         self.data.each do |key, value|
           if value.is_a?(Node)
-            result[key] = value.as_json
+            result[key] = value.as_json(version: version)
           elsif value.is_a?(Array)
             result[key] = []
-            value.each { |v| result[key] << (v.respond_to?(:as_json) ? v.as_json : v) }
-          elsif is_swagger_2_0? && value.is_a?(Hash)
+            value.each do |v|
+              result[key] << value_as_json(v, version)
+            end
+          elsif value.is_a?(Hash)
             result[key] = {}
-            value.each_pair {|k, v| result[key][k] = (v.respond_to?(:as_json) ? v.as_json : v) }
-          elsif is_swagger_2_0? && key.to_s.eql?('$ref') && (value.to_s !~ %r{^#/|https?://})
+            value.each_pair {|k, v| result[key][k] = value_as_json(v, version) }
+          elsif version == VERSION_2 && ref?(key) && !static_ref?(value)
             result[key] = "#/definitions/#{value}"
+          elsif version == VERSION_3 && ref?(key) && self.is_a?(Swagger::Blocks::Nodes::LinkNode) && !static_ref?(value)
+            result[key] = "#/components/links/#{value}"
+          elsif version == VERSION_3 && ref?(key) && self.is_a?(Swagger::Blocks::Nodes::ExampleNode) && !static_ref?(value)
+            result[key] = "#/components/examples/#{value}"
+          elsif version == VERSION_3 && ref?(key) && self.is_a?(Swagger::Blocks::Nodes::ParameterNode) && !static_ref?(value)
+            result[key] = "#/components/parameters/#{value}"
+          elsif version == VERSION_3 && ref?(key) && self.is_a?(Swagger::Blocks::Nodes::RequestBodyNode) && !static_ref?(value)
+            result[key] = "#/components/requestBodies/#{value}"
+          elsif version == VERSION_3 && ref?(key) && self.is_a?(Swagger::Blocks::Nodes::ResponseNode) && !static_ref?(value)
+            result[key] = "#/components/responses/#{value}"
+          elsif version == VERSION_3 && ref?(key) && !static_ref?(value)
+            result[key] = "#/components/schemas/#{value}"
           else
             result[key] = value
           end
@@ -38,6 +55,22 @@ module Swagger
         {name => result}
       end
 
+      def ref?(key)
+        key.to_s.eql?('$ref')
+      end
+
+      def static_ref?(value)
+        value.to_s =~ %r{^#/|https?://}
+      end
+
+      def value_as_json(value, version)
+        if value.respond_to?(:as_json)
+           value.as_json(version: version)
+        else
+           value
+        end
+      end
+
       def data
         @data ||= {}
       end
@@ -52,12 +85,17 @@ module Swagger
 
       def version
         return @version if instance_variable_defined?('@version') && @version
-        return '2.0' if data.has_key?(:swagger) && data[:swagger] == '2.0'
-        raise DeclarationError, "You must specify swagger '2.0'"
+        return VERSION_2 if data.has_key?(:swagger) && data[:swagger] == VERSION_2
+        return VERSION_3 if data.has_key?(:openapi) && data[:openapi] == VERSION_3
+        raise DeclarationError, "You must specify swagger '#{VERSION_2}' or openapi '#{VERSION_3}'"
       end
 
       def is_swagger_2_0?
-        version == '2.0'
+        version == VERSION_2
+      end
+
+      def is_openapi_3_0?
+        version == VERSION_3
       end
     end
   end

data/lib/swagger/blocks/nodes/all_of_node.rb

@@ -2,19 +2,20 @@ module Swagger
   module Blocks
     module Nodes
       class AllOfNode < Node
-        def as_json
+        def as_json(options = {})
+          version = options.fetch(:version, '2.0')
           result = []
 
           self.data.each do |value|
             if value.is_a?(Node)
-              result << value.as_json
+              result << value.as_json(version: version)
             elsif value.is_a?(Array)
               r = []
-              value.each { |v| r << (v.respond_to?(:as_json) ? v.as_json : v) }
+              value.each { |v| r << value_as_json(v, version) }
               result << r
-            elsif is_swagger_2_0? && value.is_a?(Hash)
+            elsif (is_swagger_2_0? || is_openapi_3_0?) && value.is_a?(Hash)
               r = {}
-              value.each_pair {|k, v| r[k] = (v.respond_to?(:as_json) ? v.as_json : v) }
+              value.each_pair {|k, v| r[k] = value_as_json(v, version) }
               result << r
             else
               result = value

data/lib/swagger/blocks/nodes/callback_destination_node.rb

@@ -0,0 +1,11 @@
+module Swagger
+  module Blocks
+    module Nodes
+      class CallbackDestinationNode < Node
+        def method(method_name, inline_keys = nil, &block)
+          self.data[method_name] = Swagger::Blocks::Nodes::CallbackMethodNode.call(version: version, inline_keys: inline_keys, &block)
+        end
+      end
+    end
+  end
+end

data/lib/swagger/blocks/nodes/callback_method_node.rb

@@ -0,0 +1,16 @@
+module Swagger
+  module Blocks
+    module Nodes
+      class CallbackMethodNode < Node
+        def request_body(inline_keys = nil, &block)
+          self.data[:requestBody] = Swagger::Blocks::Nodes::RequestBodyNode.call(version: version, inline_keys: inline_keys, &block)
+        end
+
+        def response(resp, inline_keys = nil, &block)
+          self.data[:responses] ||= {}
+          self.data[:responses][resp] = Swagger::Blocks::Nodes::ResponseNode.call(version: version, inline_keys: inline_keys, &block)
+        end
+      end
+    end
+  end
+end

data/lib/swagger/blocks/nodes/callback_node.rb

@@ -0,0 +1,11 @@
+module Swagger
+  module Blocks
+    module Nodes
+      class CallbackNode < Node
+        def destination(address, inline_keys = nil, &block)
+          self.data[address] = Swagger::Blocks::Nodes::CallbackDestinationNode.call(version: version, inline_keys: inline_keys, &block)
+        end
+      end
+    end
+  end
+end

data/lib/swagger/blocks/nodes/component_node.rb

@@ -0,0 +1,50 @@
+module Swagger
+  module Blocks
+    module Nodes
+      class ComponentNode < Node
+        def schema(name, inline_keys = nil, &block)
+          self.data[:schemas] ||= {}
+          schema_node = self.data[:schemas][name]
+
+          if schema_node
+            # Merge this schema_node declaration into the previous one
+            schema_node.instance_eval(&block)
+          else
+            # First time we've seen this schema_node
+            self.data[:schemas][name] = Swagger::Blocks::Nodes::SchemaNode.call(version: '3.0.0', inline_keys: inline_keys, &block)
+          end
+        end
+
+        def link(name, inline_keys = nil, &block)
+          self.data[:links] ||= {}
+          self.data[:links][name] = Swagger::Blocks::Nodes::LinkNode.call(version: version, inline_keys: inline_keys, &block)
+        end
+
+        def example(name, inline_keys = nil, &block)
+          self.data[:examples] ||= {}
+          self.data[:examples][name] = Swagger::Blocks::Nodes::ExampleNode.call(version: version, inline_keys: inline_keys, &block)
+        end
+
+        def security_scheme(name, inline_keys = nil, &block)
+          self.data[:securitySchemes] ||= {}
+          self.data[:securitySchemes][name] = Swagger::Blocks::Nodes::SecuritySchemeNode.call(version: version, inline_keys: inline_keys, &block)
+        end
+
+        def parameter(name, inline_keys = nil, &block)
+          self.data[:parameters] ||= {}
+          self.data[:parameters][name] = Swagger::Blocks::Nodes::ParameterNode.call(version: version, inline_keys: inline_keys, &block)
+        end
+
+        def request_body(name, inline_keys = nil, &block)
+          self.data[:requestBodies] ||= {}
+          self.data[:requestBodies][name] = Swagger::Blocks::Nodes::RequestBodyNode.call(version: version, inline_keys: inline_keys, &block)
+        end
+
+        def response(name, inline_keys = nil, &block)
+          self.data[:responses] ||= {}
+          self.data[:responses][name] = Swagger::Blocks::Nodes::ResponseNode.call(version: version, inline_keys: inline_keys, &block)
+        end
+      end
+    end
+  end
+end

data/lib/swagger/blocks/nodes/content_node.rb

@@ -0,0 +1,20 @@
+module Swagger
+  module Blocks
+    module Nodes
+      class ContentNode < Node
+        def schema(inline_keys = nil, &block)
+          self.data[:schema] = Swagger::Blocks::Nodes::SchemaNode.call(version: version, inline_keys: inline_keys, &block)
+        end
+
+        def example(name = nil, inline_keys = nil, &block)
+          if name.nil?
+            self.data[:example] = Swagger::Blocks::Nodes::ExampleNode.call(version: version, inline_keys: inline_keys, &block)
+          else
+            self.data[:examples] ||= {}
+            self.data[:examples][name] = Swagger::Blocks::Nodes::ExampleNode.call(version: version, inline_keys: inline_keys, &block)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/swagger/blocks/nodes/example_node.rb

@@ -1,8 +1,10 @@
 module Swagger
   module Blocks
     module Nodes
-      # v2.0:
       class ExampleNode < Node
+        def value(inline_keys = nil, &block)
+          self.data[:value] = Swagger::Blocks::Nodes::ValueNode.call(version: version, inline_keys: inline_keys, &block)
+        end
       end
     end
   end

data/lib/swagger/blocks/nodes/flow_node.rb

@@ -0,0 +1,11 @@
+module Swagger
+  module Blocks
+    module Nodes
+      class FlowNode < Node
+        def scopes(inline_keys = nil, &block)
+          self.data[:scopes] = Swagger::Blocks::Nodes::ScopesNode.call(version: version, inline_keys: inline_keys, &block)
+        end
+      end
+    end
+  end
+end

data/lib/swagger/blocks/nodes/header_node.rb

@@ -6,6 +6,10 @@ module Swagger
         def items(inline_keys = nil, &block)
           self.data[:items] = Swagger::Blocks::Nodes::ItemsNode.call(version: version, inline_keys: inline_keys, &block)
         end
+
+        def schema(inline_keys = nil, &block)
+          self.data[:schema] = Swagger::Blocks::Nodes::SchemaNode.call(version: version, inline_keys: inline_keys, &block)
+        end
       end
     end
   end

data/lib/swagger/blocks/nodes/items_node.rb

@@ -8,7 +8,7 @@ module Swagger
           self.data[:properties].version = version
           self.data[:properties].property(name, inline_keys, &block)
         end
-        
+
         def items(inline_keys = nil, &block)
           self.data[:items] = Swagger::Blocks::Nodes::ItemsNode.call(version: version, inline_keys: inline_keys, &block)
         end