swagger-blocks 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b309bb304d3b80b0a6e213b7f3ec59ae1c9fa51a
+  data.tar.gz: c68fce426638012787fc21ea5f6ee4c514ae4d18
+SHA512:
+  metadata.gz: f4d95e4aedf7c8107d2c09e4c814cdc59c7336e5fb4370e345055fc01de0b7807787d74ca9f6250d4a5f7d6182adb3f7ef0252fe598171c7332d0dfa9490828c
+  data.tar.gz: f419056f5dd26c88d8dafd5f1fcbff859015257897db939ff1d46e13f97e481020362c2db6c948b35a8c80f3a9deb7d6bc21212d262fcdde88c546f5df6e9d10

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--warnings
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 2.1.1
+  - ruby-head
+script: bundle exec rspec

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in swagger-rails.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+Copyright (c) 2014 Mike Fotinakis
+
+The MIT License (MIT)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,31 @@
+# Swagger::Blocks
+
+[![Build Status](https://travis-ci.org/fotinakis/swagger-blocks.svg?branch=master)](https://travis-ci.org/fotinakis/swagger-blocks)
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'swagger-blocks'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install swagger-blocks
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( https://github.com/fotinakis/swagger-blocks/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/lib/swagger/blocks.rb

@@ -0,0 +1,403 @@
+require 'json'
+require 'swagger/blocks/version'
+
+module Swagger
+  module Blocks
+    # Some custom error classes.
+    class Error < Exception; end
+    class DeclarationError < Error; end
+    class NotFoundError < Error; end
+
+    # Inject the swagger_root, swagger_api_root, and swagger_model class methods.
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+
+    module_function def build_root_json(swaggered_classes)
+      data = Swagger::Blocks::InternalHelpers.parse_swaggered_classes(swaggered_classes)
+      data[:root_node].as_json
+    end
+
+    module_function def build_api_json(resource_name, swaggered_classes)
+      data = Swagger::Blocks::InternalHelpers.parse_swaggered_classes(swaggered_classes)
+      api_node = data[:api_node_map][resource_name.to_sym]
+      raise Swagger::Blocks::NotFoundError.new(
+        "Not found: swagger_api_root named #{resource_name}") if !api_node
+
+      # Aggregate all model definitions into a new ModelsNode tree and add it to the JSON.
+      temp_models_node = Swagger::Blocks::ModelsNode.call(name: 'models') { }
+      data[:models_nodes].each do |models_node|
+        temp_models_node.merge!(models_node)
+      end
+      result = api_node.as_json
+      result.merge!(temp_models_node.as_json) if temp_models_node
+      result
+    end
+
+    module InternalHelpers
+      # Return [root_node, api_node_map] from all of the given swaggered_classes.
+      def self.parse_swaggered_classes(swaggered_classes)
+        root_nodes = []
+        api_node_map = {}
+        models_nodes = []
+        swaggered_classes.each do |swaggered_class|
+          next if !swaggered_class.respond_to?(:_swagger_nodes, true)
+          swagger_nodes = swaggered_class.send(:_swagger_nodes)
+          root_node = swagger_nodes[:resource_listing_node]
+          root_nodes << root_node if root_node
+          api_node_map.merge!(swagger_nodes[:api_node_map])
+          models_nodes << swagger_nodes[:models_node] if swagger_nodes[:models_node]
+        end
+        root_node = self.get_resource_listing(root_nodes)
+
+        {
+          root_node: root_node,
+          api_node_map: api_node_map,
+          models_nodes: models_nodes,
+        }
+      end
+
+      # Make sure there is exactly one root_node and return it.
+      def self.get_resource_listing(root_nodes)
+        if root_nodes.length == 0
+          raise Swagger::Blocks::DeclarationError.new(
+            'swagger_root must be declared')
+        elsif root_nodes.length > 1
+          raise Swagger::Blocks::DeclarationError.new(
+            'Only one swagger_root declaration is allowed.')
+        end
+        root_nodes.first
+      end
+    end
+
+    module ClassMethods
+      private
+
+      # Defines a Swagger Resource Listing.
+      # http://goo.gl/PvwUXj#51-resource-listing
+      def swagger_root(&block)
+        @swagger_root_node ||= Swagger::Blocks::ResourceListingNode.call(&block)
+      end
+
+      # Defines a Swagger API Declaration.
+      # http://goo.gl/PvwUXj#52-api-declaration
+      #
+      # @param resource_name [Symbol] An identifier for this API. All swagger_api_root declarations
+      #   with the same resource_name will be merged into a single API root node.
+      def swagger_api_root(resource_name, &block)
+        resource_name = resource_name.to_sym
+
+        # Map of path names to ApiDeclarationNodes.
+        @swagger_api_root_node_map ||= {}
+
+        # Grab a previously declared node if it exists, otherwise create a new ApiDeclarationNode.
+        # This merges all declarations of swagger_api_root with the same resource_name key.
+        api_node = @swagger_api_root_node_map[resource_name]
+        if api_node
+          # Merge this swagger_api_root declaration into the previous one by the same resource_name.
+          api_node.instance_eval(&block)
+        else
+          # First time we've seen this `swagger_api_root :resource_name`.
+          api_node = Swagger::Blocks::ApiDeclarationNode.call(&block)
+        end
+
+        # Add it into the resource_name to node map (may harmlessly overwrite the same object).
+        @swagger_api_root_node_map[resource_name] = api_node
+      end
+
+      # Defines a Swagger Model.
+      # http://goo.gl/PvwUXj#526-models-object
+      def swagger_model(name, &block)
+        @swagger_models_node ||= Swagger::Blocks::ModelsNode.new
+        @swagger_models_node.model(name, &block)
+      end
+
+      def _swagger_nodes
+        @swagger_root_node ||= nil  # Avoid initialization warnings.
+        @swagger_api_root_node_map ||= {}
+        @swagger_models_node ||= nil
+        {
+          resource_listing_node: @swagger_root_node,
+          api_node_map: @swagger_api_root_node_map,
+          models_node: @swagger_models_node,
+        }
+      end
+    end
+
+    # -----
+
+    # Base node for representing every object in the Swagger DSL.
+    class Node
+      attr_accessor :name
+
+      def self.call(name: nil, &block)
+        # Create a new instance and evaluate the block into it.
+        instance = new
+        instance.name = name if name # Set the first parameter given as the name.
+        instance.instance_eval(&block)
+        instance
+      end
+
+      def as_json
+        result = {}
+        self.data.each do |key, value|
+          if value.is_a?(Node)
+            result[key] = value.as_json
+          elsif value.is_a?(Array)
+            result[key] = []
+            value.each { |v| result[key] << (v.respond_to?(:as_json) ? v.as_json : v) }
+          else
+            result[key] = value
+          end
+        end
+        return result if !name
+        # If "name" is given to this node, wrap the data with a root element with the given name.
+        {name => result}
+      end
+
+      def data
+        @data ||= {}
+      end
+
+      def key(key, value)
+        self.data[key] = value
+      end
+    end
+
+    # -----
+    # Nodes for the Resource Listing.
+    # -----
+
+    # http://goo.gl/PvwUXj#51-resource-listing
+    class ResourceListingNode < Node
+      def initialize(*args)
+        # An internal list of the user-defined names that uniquely identify each API tree.
+        @api_paths = []
+        super
+      end
+
+      def has_api_path?(api_path)
+        api_paths = self.data[:apis].map { |x| x.data[:path] }
+        api_paths.include?(api_path)
+      end
+
+      def info(&block)
+        self.data[:info] = InfoNode.call(&block)
+      end
+
+      def authorization(name, &block)
+        self.data[:authorizations] ||= Swagger::Blocks::ResourceListingAuthorizationsNode.new
+        self.data[:authorizations].authorization(name, &block)
+      end
+
+      def api(&block)
+        self.data[:apis] ||= []
+        self.data[:apis] << Swagger::Blocks::ResourceNode.call(&block)
+      end
+    end
+
+    # http://goo.gl/PvwUXj#512-resource-object
+    class ResourceNode < Node; end
+
+    # NOTE: in the spec this is different than API Declaration authorizations.
+    # http://goo.gl/PvwUXj#514-authorizations-object
+    class ResourceListingAuthorizationsNode < Node
+      def authorization(name, &block)
+        self.data[name] = Swagger::Blocks::ResourceListingAuthorizationNode.call(&block)
+      end
+    end
+
+    # NOTE: in the spec this is different than API Declaration authorization.
+    # http://goo.gl/PvwUXj#515-authorization-object
+    class ResourceListingAuthorizationNode < Node
+      GRANT_TYPES = [:implicit, :authorization_code].freeze
+
+      def scope(&block)
+        self.data[:scopes] ||= []
+        self.data[:scopes] << Swagger::Blocks::ScopeNode.call(&block)
+      end
+
+      def grant_type(name, &block)
+        raise ArgumentError.new("#{name} not in #{GRANT_TYPES}") if !GRANT_TYPES.include?(name)
+        self.data[:grantTypes] ||= Swagger::Blocks::GrantTypesNode.new
+        self.data[:grantTypes].implicit(&block) if name == :implicit
+        self.data[:grantTypes].authorization_code(&block) if name == :authorization_code
+      end
+    end
+
+    # http://goo.gl/PvwUXj#513-info-object
+    class InfoNode < Node; end
+
+    # http://goo.gl/PvwUXj#516-scope-object
+    class ScopeNode < Node; end
+
+    # http://goo.gl/PvwUXj#517-grant-types-object
+    class GrantTypesNode < Node
+      def implicit(&block)
+        self.data[:implicit] = Swagger::Blocks::ImplicitNode.call(&block)
+      end
+
+      def authorization_code(&block)
+        self.data[:authorization_code] = Swagger::Blocks::AuthorizationCodeNode.call(&block)
+      end
+    end
+
+    # http://goo.gl/PvwUXj#518-implicit-object
+    class ImplicitNode < Node
+      def login_endpoint(&block)
+        self.data[:loginEndpoint] = Swagger::Blocks::LoginEndpointNode.call(&block)
+      end
+    end
+
+    # http://goo.gl/PvwUXj#5110-login-endpoint-object
+    class LoginEndpointNode < Node; end
+
+    # http://goo.gl/PvwUXj#519-authorization-code-object
+    class AuthorizationCodeNode < Node
+      def token_request_endpoint(&block)
+        self.data[:tokenRequestEndpoint] = Swagger::Blocks::TokenRequestEndpointNode.call(&block)
+      end
+
+      def token_endpoint(&block)
+        self.data[:tokenEndpoint] = Swagger::Blocks::TokenEndpointNode.call(&block)
+      end
+    end
+
+    # http://goo.gl/PvwUXj#5111-token-request-endpoint-object
+    class TokenRequestEndpointNode < Node; end
+
+    # http://goo.gl/PvwUXj#5112-token-endpoint-object
+    class TokenEndpointNode < Node; end
+
+    # -----
+    # Nodes for API Declarations.
+    # -----
+
+    # http://goo.gl/PvwUXj#52-api-declaration
+    class ApiDeclarationNode < Node
+      def api(&block)
+        self.data[:apis] ||= []
+
+        # Important: to conform with the Swagger spec, merge with any previous API declarations
+        # that have the same :path key. This ensures that operations affecting the same resource
+        # are all in the same operations node.
+        #
+        # http://goo.gl/PvwUXj#522-api-object
+        # - The API Object describes one or more operations on a single path. In the apis array,
+        #   there MUST be only one API Object per path.
+        temp_api_node = Swagger::Blocks::ApiNode.call(&block)
+        api_node = self.data[:apis].select do |api|
+          api.data[:path] == temp_api_node.data[:path]
+        end[0]  # Embrace Ruby wtfs.
+
+        if api_node
+          # Merge this block with the previous ApiNode by the same path key.
+          api_node.instance_eval(&block)
+        else
+          # First time we've seen an api block with the given path key.
+          self.data[:apis] << temp_api_node
+        end
+      end
+    end
+
+    # http://goo.gl/PvwUXj#522-api-object
+    class ApiNode < Node
+      def operation(&block)
+        self.data[:operations] ||= []
+        self.data[:operations] << Swagger::Blocks::OperationNode.call(&block)
+      end
+    end
+
+    class OperationNode < Node
+      def parameter(&block)
+        self.data[:parameters] ||= []
+        self.data[:parameters] << Swagger::Blocks::ParameterNode.call(&block)
+      end
+
+      def response_message(&block)
+        self.data[:responseMessages] ||= []
+        self.data[:responseMessages] << Swagger::Blocks::Node.call(&block)
+      end
+
+      def authorization(name, &block)
+        self.data[:authorizations] ||= Swagger::Blocks::ApiAuthorizationsNode.new
+        self.data[:authorizations].authorization(name, &block)
+      end
+
+      def items(&block)
+        self.data[:items] = Swagger::Blocks::ItemsNode.call(&block)
+      end
+    end
+
+    # NOTE: in the spec this is different than Resource Listing's authorizations.
+    # http://goo.gl/PvwUXj#514-authorizations-object
+    class ApiAuthorizationsNode < Node
+      def authorization(name, &block)
+        self.data[name] ||= Swagger::Blocks::ApiAuthorizationNode.call(&block)
+      end
+    end
+
+    # NOTE: in the spec this is different than Resource Listing's authorization.
+    # http://goo.gl/PvwUXj#515-authorization-object
+    class ApiAuthorizationNode < Node
+      def as_json
+        # Special case: the API Authorization object is weirdly the only array of hashes.
+        # Override the default hash behavior and return an array.
+        self.data[:_scopes] ||= []
+        self.data[:_scopes].map { |s| s.as_json }
+      end
+
+      def scope(&block)
+        self.data[:_scopes] ||= []
+        self.data[:_scopes] << Swagger::Blocks::ApiAuthorizationScopeNode.call(&block)
+      end
+    end
+
+    # NOTE: in the spec this is different than Resource Listing's scope object.
+    # http://goo.gl/PvwUXj#5211-scope-object
+    class ApiAuthorizationScopeNode < Node; end
+
+    # http://goo.gl/PvwUXj#434-items-object
+    class ItemsNode < Node; end
+
+    # http://goo.gl/PvwUXj#524-parameter-object
+    class ParameterNode < Node; end
+
+    # -----
+    # Nodes for Models.
+    # -----
+
+    # http://goo.gl/PvwUXj#526-models-object
+    class ModelsNode < Node
+      def merge!(other_models_node)
+        self.data.merge!(other_models_node.data)
+      end
+
+      def model(name, &block)
+        self.data[name] ||= Swagger::Blocks::ModelNode.call(&block)
+      end
+    end
+
+    # http://goo.gl/PvwUXj#527-model-object
+    class ModelNode < Node
+      def property(name, &block)
+        self.data[:properties] ||= Swagger::Blocks::PropertiesNode.new
+        self.data[:properties].property(name, &block)
+      end
+    end
+
+    # http://goo.gl/PvwUXj#527-model-object
+    class PropertiesNode < Node
+      def property(name, &block)
+        self.data[name] = Swagger::Blocks::PropertyNode.call(&block)
+      end
+    end
+
+    # http://goo.gl/PvwUXj#527-model-object
+    class PropertyNode < Node
+      def items(&block)
+        self.data[:items] = Swagger::Blocks::ItemsNode.call(&block)
+      end
+    end
+  end
+end

data/lib/swagger/blocks/version.rb

@@ -0,0 +1,5 @@
+module Swagger
+  module Blocks
+    VERSION = '0.0.1'
+  end
+end

data/spec/lib/swagger_api_declaration.json

@@ -0,0 +1,201 @@
+{
+  "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"
+        }
+      }
+    }
+  }
+}

data/spec/lib/swagger_blocks_spec.rb

@@ -0,0 +1,371 @@
+require 'json'
+require 'swagger/blocks'
+
+# Test data originally based on the Swagger UI example data:
+# https://github.com/wordnik/swagger-codegen/blob/master/src/test/resources/petstore-1.2/api-docs
+RESOURCE_LISTING_JSON = open(File.expand_path('../swagger_resource_listing.json', __FILE__)).read
+# https://github.com/wordnik/swagger-codegen/blob/master/src/test/resources/petstore-1.2/pet
+API_DECLARATION_JSON = open(File.expand_path('../swagger_api_declaration.json', __FILE__)).read
+
+class PetController
+  include Swagger::Blocks
+
+  swagger_root do
+    key :swaggerVersion, '1.2'
+    key :apiVersion, '1.0.0'
+    info do
+      key :title, 'Swagger Sample App'
+      key :description, "This is a sample server Petstore server.  You can find out more about Swagger \n    at <a href=\"http://swagger.wordnik.com\">http://swagger.wordnik.com</a> or on irc.freenode.net, #swagger.  For this sample,\n    you can use the api key \"special-key\" to test the authorization filters"
+      key :termsOfServiceUrl, 'http://helloreverb.com/terms/'
+      key :contact, 'apiteam@wordnik.com'
+      key :license, 'Apache 2.0'
+      key :licenseUrl, 'http://www.apache.org/licenses/LICENSE-2.0.html'
+    end
+    api do
+      key :path, '/pet'
+      key :description, 'Operations about pets'
+    end
+    api do
+      key :path, '/user'
+      key :description, 'Operations about user'
+    end
+    api do
+      key :path, '/store'
+      key :description, 'Operations about store'
+    end
+    authorization :oauth2 do
+      key :type, 'oauth2'
+      scope do
+        key :scope, 'email'
+        key :description, 'Access to your email address'
+      end
+      scope do
+        key :scope, 'pets'
+        key :description, 'Access to your pets'
+      end
+      grant_type :implicit do
+        login_endpoint do
+          key :url, 'http://petstore.swagger.wordnik.com/oauth/dialog'
+        end
+        key :tokenName, 'access_token'
+      end
+      grant_type :authorization_code do
+        token_request_endpoint do
+          key :url, 'http://petstore.swagger.wordnik.com/oauth/requestToken'
+          key :clientIdName, 'client_id'
+          key :clientSecretName, 'client_secret'
+        end
+        token_endpoint do
+          key :url, 'http://petstore.swagger.wordnik.com/oauth/token'
+          key :tokenName, 'access_code'
+        end
+      end
+    end
+  end
+
+  # All swagger_api_root declarations with the same key will be merged.
+  swagger_api_root :pets do
+    key :swaggerVersion, '1.2'
+    key :apiVersion, '1.0.0'
+    key :basePath, 'http://petstore.swagger.wordnik.com/api'
+    key :resourcePath, '/pet'
+    key :produces, [
+      'application/json',
+      'application/xml',
+      'text/plain',
+      'text/html',
+    ]
+    api do
+      key :path, '/pet/{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
+          key :format, :int64
+          key :minimum, '1.0'
+          key :maximum, '100000.0'
+        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
+
+  swagger_api_root :pets do
+    api do
+      key :path, '/pet/{petId}'
+      operation do
+        key :method, 'PATCH'
+        key :summary, 'partial updates to a pet'
+        key :notes, ''
+        key :type, :array
+        key :nickname, :partialUpdate
+        items do
+          key :'$ref', :Pet
+        end
+        key :produces, [
+          'application/json',
+          'application/xml',
+        ]
+        key :consumes, [
+          'application/json',
+          'application/xml',
+        ]
+        authorization :oauth2 do
+          scope do
+            key :scope, 'test:anything'
+            key :description, 'anything'
+          end
+        end
+        parameter do
+          key :paramType, :path
+          key :name, :petId
+          key :description, 'ID of pet that needs to be fetched'
+          key :required, true
+          key :type, :string
+        end
+        parameter do
+          key :paramType, :body
+          key :name, :body
+          key :description, 'Pet object that needs to be added to the store'
+          key :required, true
+          key :type, :Pet
+        end
+        response_message do
+          key :code, 400
+          key :message, 'Invalid tag value'
+        end
+      end
+    end
+  end
+
+  swagger_api_root :pets do
+    api do
+      key :path, '/pet/findByStatus'
+      operation do
+        key :method, 'GET'
+        key :summary, 'Finds Pets by status'
+        key :notes, 'Multiple status values can be provided with comma seperated strings'
+        key :type, :array
+        key :nickname, :findPetsByStatus
+        items do
+          key :'$ref', :Pet
+        end
+        parameter do
+          key :paramType, :query
+          key :name, :status
+          key :description, 'Status values that need to be considered for filter'
+          key :defaultValue, 'available'
+          key :required, true
+          key :type, :string
+          key :enum, [
+            'available',
+            'pending',
+            'sold',
+          ]
+        end
+        response_message do
+          key :code, 400
+          key :message, 'Invalid status value'
+        end
+      end
+    end
+  end
+end
+
+
+class StoreController
+  include Swagger::Blocks
+
+  swagger_api_root :stores do
+    key :path, '/store'
+  end
+end
+
+
+class UserController
+  include Swagger::Blocks
+
+  swagger_api_root :users do
+    key :path, '/user'
+  end
+end
+
+
+class TagModel
+  include Swagger::Blocks
+
+  swagger_model :Tag do
+    key :id, :Tag
+    property :id do
+      key :type, :integer
+      key :format, :int64
+    end
+    property :name do
+      key :type, :string
+    end
+  end
+end
+
+
+class OtherModelsContainer
+  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 :category do
+      key :'$ref', :Category
+    end
+    property :name do
+      key :type, :string
+    end
+    property :photoUrls do
+      key :type, :array
+      items do
+        key :type, :string
+      end
+    end
+    property :tags do
+      key :type, :array
+      items do
+        key :'$ref', :Tag
+      end
+    end
+    property :status do
+      key :type, :string
+      key :description, 'pet status in the store'
+      key :enum, [:available, :pending, :sold]
+    end
+  end
+
+  swagger_model :Category do
+    key :id, :Category
+    property :id do
+      key :type, :integer
+      key :format, :int64
+    end
+    property :name do
+      key :type, :string
+    end
+  end
+end
+
+
+class BlankController; end
+
+
+describe Swagger::Blocks do
+  describe 'build_root_json' do
+    it 'outputs the correct data' do
+      swaggered_classes = [
+        PetController,
+        UserController,
+        StoreController,
+        TagModel,
+        OtherModelsContainer,
+      ]
+      actual = Swagger::Blocks.build_root_json(swaggered_classes)
+
+      # Multiple expectations for better test diff output.
+      actual = JSON.parse(actual.to_json)  # For access consistency.
+      data = JSON.parse(RESOURCE_LISTING_JSON)
+      expect(actual['info']).to eq(data['info'])
+      expect(actual['authorizations']).to eq(data['authorizations'])
+      actual['apis'].each_with_index do |api_data, i|
+        expect(api_data).to eq(data['apis'][i])
+      end
+      expect(actual).to eq(data)
+    end
+    it 'is idempotent' do
+      swaggered_classes = [PetController, UserController, StoreController]
+      actual = JSON.parse(Swagger::Blocks.build_root_json(swaggered_classes).to_json)
+      actual = JSON.parse(Swagger::Blocks.build_root_json(swaggered_classes).to_json)
+      data = JSON.parse(RESOURCE_LISTING_JSON)
+      expect(actual).to eq(data)
+    end
+    it 'errors if no swagger_root is declared' do
+      expect {
+        Swagger::Blocks.build_root_json([])
+      }.to raise_error(Swagger::Blocks::DeclarationError)
+    end
+    it 'errors if mulitple swagger_roots are declared' do
+      expect {
+        Swagger::Blocks.build_root_json([PetController, PetController])
+      }.to raise_error(Swagger::Blocks::DeclarationError)
+    end
+    it 'does not error if given non-swaggered classes' do
+      Swagger::Blocks.build_root_json([PetController, BlankController])
+    end
+  end
+  describe 'build_api_json' do
+    it 'outputs the correct data' do
+      swaggered_classes = [
+        PetController,
+        UserController,
+        StoreController,
+        TagModel,
+        OtherModelsContainer,
+      ]
+      actual = Swagger::Blocks.build_api_json(:pets, swaggered_classes)
+
+      # Multiple expectations for better test diff output.
+      actual = JSON.parse(actual.to_json)  # For access consistency.
+      data = JSON.parse(API_DECLARATION_JSON)
+      expect(actual['apis'][0]).to be
+      expect(actual['apis'][0]['operations']).to be
+      expect(actual['apis'][0]['operations'][0]).to be
+      expect(actual['apis'][0]['operations'][1]).to be
+      expect(actual['apis'][0]['operations'][0]).to eq(data['apis'][0]['operations'][0])
+      expect(actual['apis'][0]['operations'][1]).to eq(data['apis'][0]['operations'][1])
+      expect(actual['apis'][0]['operations']).to eq(data['apis'][0]['operations'])
+      expect(actual['apis']).to eq(data['apis'])
+      expect(actual['models']).to eq(data['models'])
+      expect(actual).to eq(data)
+    end
+    it 'is idempotent' do
+      swaggered_classes = [
+        PetController,
+        UserController,
+        StoreController,
+        TagModel,
+        OtherModelsContainer,
+      ]
+      actual = JSON.parse(Swagger::Blocks.build_api_json(:pets, swaggered_classes).to_json)
+      actual = JSON.parse(Swagger::Blocks.build_api_json(:pets, swaggered_classes).to_json)
+      data = JSON.parse(API_DECLARATION_JSON)
+      expect(actual).to eq(data)
+    end
+    it 'errors if no swagger_root is declared' do
+      expect {
+        Swagger::Blocks.build_root_json([])
+      }.to raise_error(Swagger::Blocks::DeclarationError)
+    end
+    it 'errors if mulitple swagger_roots are declared' do
+      expect {
+        Swagger::Blocks.build_root_json([PetController, PetController])
+      }.to raise_error(Swagger::Blocks::DeclarationError)
+    end
+  end
+end

data/spec/lib/swagger_resource_listing.json

@@ -0,0 +1,60 @@
+{
+  "apiVersion": "1.0.0",
+  "swaggerVersion": "1.2",
+  "apis": [
+    {
+      "path": "/pet",
+      "description": "Operations about pets"
+    },
+    {
+      "path": "/user",
+      "description": "Operations about user"
+    },
+    {
+      "path": "/store",
+      "description": "Operations about store"
+    }
+  ],
+  "authorizations": {
+    "oauth2": {
+      "type": "oauth2",
+      "scopes": [
+        {
+          "scope": "email",
+          "description": "Access to your email address"
+        },
+        {
+          "scope": "pets",
+          "description": "Access to your pets"
+        }
+      ],
+      "grantTypes": {
+        "implicit": {
+          "loginEndpoint": {
+            "url": "http://petstore.swagger.wordnik.com/oauth/dialog"
+          },
+          "tokenName": "access_token"
+        },
+        "authorization_code": {
+          "tokenRequestEndpoint": {
+            "url": "http://petstore.swagger.wordnik.com/oauth/requestToken",
+            "clientIdName": "client_id",
+            "clientSecretName": "client_secret"
+          },
+          "tokenEndpoint": {
+            "url": "http://petstore.swagger.wordnik.com/oauth/token",
+            "tokenName": "access_code"
+          }
+        }
+      }
+    }
+  },
+  "info": {
+    "title": "Swagger Sample App",
+    "description": "This is a sample server Petstore server.  You can find out more about Swagger \n    at <a href=\"http://swagger.wordnik.com\">http://swagger.wordnik.com</a> or on irc.freenode.net, #swagger.  For this sample,\n    you can use the api key \"special-key\" to test the authorization filters",
+    "termsOfServiceUrl": "http://helloreverb.com/terms/",
+    "contact": "apiteam@wordnik.com",
+    "license": "Apache 2.0",
+    "licenseUrl": "http://www.apache.org/licenses/LICENSE-2.0.html"
+  }
+}

data/spec/spec_helper.rb

@@ -0,0 +1,42 @@
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # Allow more verbose output when running an individual spec file.
+  if config.files_to_run.one?
+    config.default_formatter = 'doc'
+  end
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # Enable only the newer, non-monkey-patching expect syntax.
+    # For more details, see:
+    #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
+    expectations.syntax = :expect
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Enable only the newer, non-monkey-patching expect syntax.
+    # For more details, see:
+    #   - http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+    mocks.syntax = :expect
+
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended.
+    mocks.verify_partial_doubles = true
+  end
+end

data/swagger-blocks.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'swagger/blocks/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'swagger-blocks'
+  spec.version       = Swagger::Blocks::VERSION
+  spec.authors       = ['Mike Fotinakis']
+  spec.email         = ['mike@fotinakis.com']
+  spec.summary       = %q{Define and generate Swagger JSON files in Ruby.}
+  spec.description   = %q{}
+  spec.homepage      = 'https://github.com/fotinakis/swagger-blocks'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'pry'
+end

metadata

@@ -0,0 +1,119 @@
+--- !ruby/object:Gem::Specification
+name: swagger-blocks
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Mike Fotinakis
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-09-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ''
+email:
+- mike@fotinakis.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/swagger/blocks.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/spec_helper.rb
+- swagger-blocks.gemspec
+homepage: https://github.com/fotinakis/swagger-blocks
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.1
+signing_key: 
+specification_version: 4
+summary: Define and generate Swagger JSON files in Ruby.
+test_files:
+- spec/lib/swagger_api_declaration.json
+- spec/lib/swagger_blocks_spec.rb
+- spec/lib/swagger_resource_listing.json
+- spec/spec_helper.rb
+has_rdoc: