swagger-blocks 1.4.0 → 2.0.0

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

@@ -0,0 +1,53 @@
+module Swagger
+  module Blocks
+    module Nodes
+      class RootNode < Node
+
+        def info(inline_keys = nil, &block)
+          self.data[:info] = Swagger::Blocks::Nodes::InfoNode.call(version: version, inline_keys: inline_keys, &block)
+        end
+
+        def parameter(param, inline_keys = nil, &block)
+          raise NotSupportedError unless is_swagger_2_0?
+
+          # TODO validate 'param' is as per spec
+          self.data[:parameters] ||= {}
+          self.data[:parameters][param] = Swagger::Blocks::Nodes::ParameterNode.call(version: version, inline_keys: inline_keys, &block)
+        end
+
+        def response(resp, inline_keys = nil, &block)
+          raise NotSupportedError unless is_swagger_2_0?
+
+          # TODO validate 'resp' is as per spec
+          self.data[:responses] ||= {}
+          self.data[:responses][resp] = Swagger::Blocks::Nodes::ResponseNode.call(version: version, inline_keys: inline_keys, &block)
+        end
+
+        def security_definition(name, inline_keys = nil, &block)
+          raise NotSupportedError unless is_swagger_2_0?
+
+          self.data[:securityDefinitions] ||= {}
+          self.data[:securityDefinitions][name] = Swagger::Blocks::Nodes::SecuritySchemeNode.call(version: version, inline_keys: inline_keys, &block)
+        end
+
+        def security(inline_keys = nil, &block)
+          raise NotSupportedError unless is_swagger_2_0?
+
+          self.data[:security] ||= []
+          self.data[:security] << Swagger::Blocks::Nodes::SecurityRequirementNode.call(version: version, inline_keys: inline_keys, &block)
+        end
+
+        def tag(inline_keys = nil, &block)
+          raise NotSupportedError unless is_swagger_2_0?
+
+          self.data[:tags] ||= []
+          self.data[:tags] << Swagger::Blocks::Nodes::TagNode.call(version: version, inline_keys: inline_keys, &block)
+        end
+
+        # Use 'tag' instead.
+        # @deprecated
+        alias_method :tags, :tag
+      end
+    end
+  end
+end

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

@@ -0,0 +1,30 @@
+module Swagger
+  module Blocks
+    module Nodes
+      # v2.0: https://github.com/swagger-api/swagger-spec/blob/master/versions/2.0.md#schema-object
+      class SchemaNode < Node
+        def items(inline_keys = nil, &block)
+          self.data[:items] = Swagger::Blocks::Nodes::ItemsNode.call(version: version, inline_keys: inline_keys, &block)
+        end
+
+        def allOf(&block)
+          self.data[:allOf] = Swagger::Blocks::Nodes::AllOfNode.call(version: version, &block)
+        end
+
+        def property(name, inline_keys = nil, &block)
+          self.data[:properties] ||= Swagger::Blocks::Nodes::PropertiesNode.new
+          self.data[:properties].version = version
+          self.data[:properties].property(name, inline_keys, &block)
+        end
+
+        def xml(inline_keys = nil, &block)
+          self.data[:xml] = Swagger::Blocks::Nodes::XmlNode.call(version: version, inline_keys: inline_keys, &block)
+        end
+
+        def externalDocs(inline_keys = nil, &block)
+          self.data[:externalDocs] = Swagger::Blocks::Nodes::ExternalDocsNode.call(version: version, inline_keys: inline_keys, &block)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,9 @@
+module Swagger
+  module Blocks
+    module Nodes
+      # v2.0: https://github.com/swagger-api/swagger-spec/blob/master/versions/2.0.md#scopes-object
+      class ScopesNode < Node
+      end
+    end
+  end
+end

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

@@ -0,0 +1,9 @@
+module Swagger
+  module Blocks
+    module Nodes
+      # v2.0: https://github.com/swagger-api/swagger-spec/blob/master/versions/2.0.md#securityRequirementObject
+      class SecurityRequirementNode < Node
+      end
+    end
+  end
+end

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

@@ -0,0 +1,14 @@
+module Swagger
+  module Blocks
+    module Nodes
+      # v2.0: https://github.com/swagger-api/swagger-spec/blob/master/versions/2.0.md#security-scheme-object
+      class SecuritySchemeNode < Node
+        # TODO support ^x- Vendor Extensions
+
+        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/tag_node.rb

@@ -0,0 +1,15 @@
+module Swagger
+  module Blocks
+    module Nodes
+      # v2.0: https://github.com/swagger-api/swagger-spec/blob/master/versions/2.0.md#tag-object
+      class TagNode < Node
+
+        # TODO support ^x- Vendor Extensions
+
+        def externalDocs(inline_keys = nil, &block)
+          self.data[:externalDocs] = Swagger::Blocks::Nodes::ExternalDocsNode.call(version: version, inline_keys: inline_keys, &block)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,9 @@
+module Swagger
+  module Blocks
+    module Nodes
+      # v2.0:
+      class XmlNode < Node
+      end
+    end
+  end
+end

data/lib/swagger/blocks/root.rb

@@ -0,0 +1,25 @@
+require 'json'
+require 'swagger/blocks/version'
+
+module Swagger
+  module Blocks
+
+    # Inject the swagger_root, swagger_api_root, and swagger_model class methods.
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+
+    def self.build_root_json(swaggered_classes)
+      data = Swagger::Blocks::InternalHelpers.parse_swaggered_classes(swaggered_classes)
+
+      if data[:root_node].is_swagger_2_0?
+        data[:root_node].key(:paths, data[:path_nodes]) # Required, so no empty check.
+        if data[:schema_nodes] && !data[:schema_nodes].empty?
+          data[:root_node].key(:definitions, data[:schema_nodes])
+        end
+      end
+
+      data[:root_node].as_json
+    end
+  end
+end

data/lib/swagger/blocks/version.rb

@@ -1,5 +1,5 @@
 module Swagger
   module Blocks
-    VERSION = '1.4.0'
+    VERSION = '2.0.0'
   end
 end

data/spec/lib/swagger_v2_blocks_spec.rb

@@ -321,10 +321,5 @@ describe 'Swagger::Blocks v2' do
         Swagger::Blocks.build_root_json([PetControllerV2, PetControllerV2])
       }.to raise_error(Swagger::Blocks::DeclarationError)
     end
-    it 'errors if calling build_api_json' do
-      expect {
-        Swagger::Blocks.build_api_json('fake', [PetControllerV2])
-      }.to raise_error(Swagger::Blocks::NotSupportedError)
-    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: swagger-blocks
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Mike Fotinakis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-11-22 00:00:00.000000000 Z
+date: 2016-11-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -79,13 +79,35 @@ files:
 - Gemfile
 - LICENSE
 - README.md
-- README_v1_2.md
 - Rakefile
 - lib/swagger/blocks.rb
+- lib/swagger/blocks/class_methods.rb
+- lib/swagger/blocks/errors.rb
+- lib/swagger/blocks/internal_helpers.rb
+- lib/swagger/blocks/node.rb
+- lib/swagger/blocks/nodes/all_of_node.rb
+- lib/swagger/blocks/nodes/contact_node.rb
+- lib/swagger/blocks/nodes/example_node.rb
+- lib/swagger/blocks/nodes/external_docs_node.rb
+- lib/swagger/blocks/nodes/header_node.rb
+- lib/swagger/blocks/nodes/info_node.rb
+- lib/swagger/blocks/nodes/items_node.rb
+- lib/swagger/blocks/nodes/license_node.rb
+- lib/swagger/blocks/nodes/operation_node.rb
+- lib/swagger/blocks/nodes/parameter_node.rb
+- lib/swagger/blocks/nodes/path_node.rb
+- lib/swagger/blocks/nodes/properties_node.rb
+- lib/swagger/blocks/nodes/property_node.rb
+- lib/swagger/blocks/nodes/response_node.rb
+- lib/swagger/blocks/nodes/root_node.rb
+- lib/swagger/blocks/nodes/schema_node.rb
+- lib/swagger/blocks/nodes/scopes_node.rb
+- lib/swagger/blocks/nodes/security_requirement_node.rb
+- lib/swagger/blocks/nodes/security_scheme_node.rb
+- lib/swagger/blocks/nodes/tag_node.rb
+- lib/swagger/blocks/nodes/xml_node.rb
+- lib/swagger/blocks/root.rb
 - lib/swagger/blocks/version.rb
-- spec/lib/swagger_api_declaration.json
-- spec/lib/swagger_blocks_spec.rb
-- spec/lib/swagger_resource_listing.json
 - spec/lib/swagger_v2_api_declaration.json
 - spec/lib/swagger_v2_blocks_spec.rb
 - spec/spec_helper.rb
@@ -115,9 +137,6 @@ signing_key:
 specification_version: 4
 summary: Define and serve live-updating Swagger JSON for Ruby apps.
 test_files:
-- spec/lib/swagger_api_declaration.json
-- spec/lib/swagger_blocks_spec.rb
-- spec/lib/swagger_resource_listing.json
 - spec/lib/swagger_v2_api_declaration.json
 - spec/lib/swagger_v2_blocks_spec.rb
 - spec/spec_helper.rb

data/README_v1_2.md

@@ -1,143 +0,0 @@
-# Swagger 1.2 example (Rails)
-
-**NOTE: this is old, you probably want to [use the latest syntax](https://github.com/fotinakis/swagger-blocks).**
-
-This is a simplified example based on the objects in the Petstore [Swagger Sample App](http://petstore.swagger.wordnik.com/#!/pet). For a more complex and complete example, see the [swagger_blocks_spec.rb](https://github.com/fotinakis/swagger-blocks/blob/master/spec/lib/swagger_blocks_spec.rb) file.
-
-Also note that Rails is not required, you can use Swagger::Blocks with any Ruby web framework.
-
-### PetsController
-
-Parameters and features below are defined by the [Swagger 1.2 spec](https://github.com/wordnik/swagger-spec/blob/master/versions/1.2.md).
-
-```Ruby
-class PetsController < ActionController::Base
-  include Swagger::Blocks
-
-  swagger_api_root :pets do
-    key :swaggerVersion, '1.2'
-    key :apiVersion, '1.0.0'
-    key :basePath, 'http://petstore.swagger.wordnik.com/api'
-    key :resourcePath, '/pets'
-    api do
-      key :path, '/pets/{petId}'
-      operation do
-        key :method, 'GET'
-        key :summary, 'Find pet by ID'
-        key :notes, 'Returns a pet based on ID'
-        key :type, :Pet
-        key :nickname, :getPetById
-        parameter do
-          key :paramType, :path
-          key :name, :petId
-          key :description, 'ID of pet that needs to be fetched'
-          key :required, true
-          key :type, :integer
-        end
-        response_message do
-          key :code, 400
-          key :message, 'Invalid ID supplied'
-        end
-        response_message do
-          key :code, 404
-          key :message, 'Pet not found'
-        end
-      end
-    end
-  end
-
-  # ...
-end
-```
-
-### Pet model
-
-```Ruby
-class Pet < ActiveRecord::Base
-  include Swagger::Blocks
-
-  swagger_model :Pet do
-    key :id, :Pet
-    key :required, [:id, :name]
-    property :id do
-      key :type, :integer
-      key :format, :int64
-      key :description, 'unique identifier for the pet'
-      key :minimum, '0.0'
-      key :maximum, '100.0'
-    end
-    property :name do
-      key :type, :string
-    end
-    property :photoUrls do
-      key :type, :array
-      items do
-        key :type, :string
-      end
-    end
-    property :status do
-      key :type, :string
-      key :description, 'pet status in the store'
-      key :enum, [:available, :pending, :sold]
-    end
-  end
-
-  # ...
-end
-```
-
-### Docs controller
-
-To integrate these definitions with Swagger UI, we need a docs controller that can serve the JSON definitions.
-
-```Ruby
-resources :apidocs, only: [:index, :show]
-```
-
-```Ruby
-class ApidocsController < ActionController::Base
-  include Swagger::Blocks
-
-  swagger_root do
-    key :swaggerVersion, '1.2'
-    key :apiVersion, '1.0.0'
-    info do
-      key :title, 'Swagger Sample App'
-    end
-    api do
-      key :path, '/pets'
-      key :description, 'Operations about pets'
-    end
-  end
-
-  # A list of all classes that have swagger_* declarations.
-  SWAGGERED_CLASSES = [
-    PetsController,
-    Pets,
-    self,
-  ].freeze
-
-  def index
-    render json: Swagger::Blocks.build_root_json(SWAGGERED_CLASSES)
-  end
-
-  def show
-    render json: Swagger::Blocks.build_api_json(params[:id], SWAGGERED_CLASSES)
-  end
-end
-
-```
-
-The special part of this controller are these lines:
-
-```Ruby
-render json: Swagger::Blocks.build_root_json(SWAGGERED_CLASSES)
-```
-
-```Ruby
-render json: Swagger::Blocks.build_api_json(params[:id], SWAGGERED_CLASSES)
-```
-
-Those are the only lines necessary to build the root Swagger [Resource Listing](https://github.com/wordnik/swagger-spec/blob/master/versions/1.2.md#51-resource-listing) JSON and the JSON for each Swagger [API Declaration](https://github.com/wordnik/swagger-spec/blob/master/versions/1.2.md#52-api-declaration). You simply pass in a list of all the "swaggered" classes in your app.
-
-Now, simply point Swagger UI at `/apidocs` and everything should Just Work™. If you change any of the Swagger block definitions, you can simply refresh Swagger UI to see the changes.

data/spec/lib/swagger_api_declaration.json

@@ -1,201 +0,0 @@
-{
-  "apiVersion": "1.0.0",
-  "swaggerVersion": "1.2",
-  "basePath": "http://petstore.swagger.wordnik.com/api",
-  "resourcePath": "/pet",
-  "produces": [
-    "application/json",
-    "application/xml",
-    "text/plain",
-    "text/html"
-  ],
-  "apis": [
-    {
-      "path": "/pet/{petId}",
-      "operations": [
-        {
-          "method": "GET",
-          "summary": "Find pet by ID",
-          "notes": "Returns a pet based on ID",
-          "type": "Pet",
-          "nickname": "getPetById",
-          "parameters": [
-            {
-              "name": "petId",
-              "description": "ID of pet that needs to be fetched",
-              "required": true,
-              "type": "integer",
-              "format": "int64",
-              "paramType": "path",
-              "minimum": "1.0",
-              "maximum": "100000.0"
-            }
-          ],
-          "responseMessages": [
-            {
-              "code": 400,
-              "message": "Invalid ID supplied"
-            },
-            {
-              "code": 404,
-              "message": "Pet not found"
-            }
-          ]
-        },
-        {
-          "method": "PATCH",
-          "summary": "partial updates to a pet",
-          "notes": "",
-          "type": "array",
-          "items": {
-            "$ref": "Pet"
-          },
-          "nickname": "partialUpdate",
-          "produces": [
-            "application/json",
-            "application/xml"
-          ],
-          "consumes": [
-            "application/json",
-            "application/xml"
-          ],
-          "authorizations": {
-            "oauth2": [
-              {
-                "scope": "test:anything",
-                "description": "anything"
-              }
-            ]
-          },
-          "parameters": [
-            {
-              "name": "petId",
-              "description": "ID of pet that needs to be fetched",
-              "required": true,
-              "type": "string",
-              "paramType": "path"
-            },
-            {
-              "name": "body",
-              "description": "Pet object that needs to be added to the store",
-              "required": true,
-              "type": "Pet",
-              "paramType": "body"
-            }
-          ],
-          "responseMessages": [
-            {
-              "code": 400,
-              "message": "Invalid tag value"
-            }
-          ]
-        }
-      ]
-    },
-    {
-      "path": "/pet/findByStatus",
-      "operations": [
-        {
-          "method": "GET",
-          "summary": "Finds Pets by status",
-          "notes": "Multiple status values can be provided with comma seperated strings",
-          "type": "array",
-          "items": {
-            "$ref": "Pet"
-          },
-          "nickname": "findPetsByStatus",
-          "parameters": [
-            {
-              "name": "status",
-              "description": "Status values that need to be considered for filter",
-              "defaultValue": "available",
-              "required": true,
-              "type": "string",
-              "paramType": "query",
-              "enum": [
-                "available",
-                "pending",
-                "sold"
-              ]
-            }
-          ],
-          "responseMessages": [
-            {
-              "code": 400,
-              "message": "Invalid status value"
-            }
-          ]
-        }
-      ]
-    }
-  ],
-  "models": {
-    "Tag": {
-      "id": "Tag",
-      "properties": {
-        "id": {
-          "type": "integer",
-          "format": "int64"
-        },
-        "name": {
-          "type": "string"
-        }
-      }
-    },
-    "Pet": {
-      "id": "Pet",
-      "required": [
-        "id",
-        "name"
-      ],
-      "properties": {
-        "id": {
-          "type": "integer",
-          "format": "int64",
-          "description": "unique identifier for the pet",
-          "minimum": "0.0",
-          "maximum": "100.0"
-        },
-        "category": {
-          "$ref": "Category"
-        },
-        "name": {
-          "type": "string"
-        },
-        "photoUrls": {
-          "type": "array",
-          "items": {
-            "type": "string"
-          }
-        },
-        "tags": {
-          "type": "array",
-          "items": {
-            "$ref": "Tag"
-          }
-        },
-        "status": {
-          "type": "string",
-          "description": "pet status in the store",
-          "enum": [
-            "available",
-            "pending",
-            "sold"
-          ]
-        }
-      }
-    },
-    "Category": {
-      "id": "Category",
-      "properties": {
-        "id": {
-          "type": "integer",
-          "format": "int64"
-        },
-        "name": {
-          "type": "string"
-        }
-      }
-    }
-  }
-}