swagger-blocks 1.0.1 → 1.1

data/lib/swagger/blocks/version.rb

@@ -1,5 +1,5 @@
 module Swagger
   module Blocks
-    VERSION = '1.0.1'
+    VERSION = '1.1'
   end
 end

data/spec/lib/swagger_blocks_spec.rb

@@ -276,7 +276,7 @@ end
 class BlankController; end
 
 
-describe Swagger::Blocks do
+describe 'Swagger::Blocks v1' do
   describe 'build_root_json' do
     it 'outputs the correct data' do
       swaggered_classes = [
@@ -362,7 +362,7 @@ describe Swagger::Blocks do
         Swagger::Blocks.build_root_json([])
       }.to raise_error(Swagger::Blocks::DeclarationError)
     end
-    it 'errors if mulitple swagger_roots are declared' do
+    it 'errors if multiple swagger_roots are declared' do
       expect {
         Swagger::Blocks.build_root_json([PetController, PetController])
       }.to raise_error(Swagger::Blocks::DeclarationError)

data/spec/lib/swagger_v2_api_declaration.json

@@ -0,0 +1,224 @@
+{
+  "swagger": "2.0",
+  "info": {
+    "version": "1.0.0",
+    "title": "Swagger Petstore",
+    "description": "A sample API that uses a petstore as an example to demonstrate features in the swagger-2.0 specification",
+    "termsOfService": "http://helloreverb.com/terms/",
+    "contact": {
+      "name": "Wordnik API Team"
+    },
+    "license": {
+      "name": "MIT"
+    }
+  },
+  "host": "petstore.swagger.wordnik.com",
+  "basePath": "/api",
+  "schemes": [
+    "http"
+  ],
+  "consumes": [
+    "application/json"
+  ],
+  "produces": [
+    "application/json"
+  ],
+  "paths": {
+    "/pets": {
+      "get": {
+        "description": "Returns all pets from the system that the user has access to",
+        "operationId": "findPets",
+        "produces": [
+          "application/json",
+          "application/xml",
+          "text/xml",
+          "text/html"
+        ],
+        "parameters": [
+          {
+            "name": "tags",
+            "in": "query",
+            "description": "tags to filter by",
+            "required": false,
+            "type": "array",
+            "items": {
+              "type": "string"
+            },
+            "collectionFormat": "csv"
+          },
+          {
+            "name": "limit",
+            "in": "query",
+            "description": "maximum number of results to return",
+            "required": false,
+            "type": "integer",
+            "format": "int32"
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "pet response",
+            "schema": {
+              "type": "array",
+              "items": {
+                "$ref": "#/definitions/Pet"
+              }
+            }
+          },
+          "default": {
+            "description": "unexpected error",
+            "schema": {
+              "$ref": "#/definitions/ErrorModel"
+            }
+          }
+        }
+      },
+      "post": {
+        "description": "Creates a new pet in the store.  Duplicates are allowed",
+        "operationId": "addPet",
+        "produces": [
+          "application/json"
+        ],
+        "parameters": [
+          {
+            "name": "pet",
+            "in": "body",
+            "description": "Pet to add to the store",
+            "required": true,
+            "schema": {
+              "$ref": "#/definitions/PetInput"
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "pet response",
+            "schema": {
+              "$ref": "#/definitions/Pet"
+            }
+          },
+          "default": {
+            "description": "unexpected error",
+            "schema": {
+              "$ref": "#/definitions/ErrorModel"
+            }
+          }
+        }
+      }
+    },
+    "/pets/{id}": {
+      "get": {
+        "description": "Returns a user based on a single ID, if the user does not have access to the pet",
+        "operationId": "findPetById",
+        "produces": [
+          "application/json",
+          "application/xml",
+          "text/xml",
+          "text/html"
+        ],
+        "parameters": [
+          {
+            "name": "id",
+            "in": "path",
+            "description": "ID of pet to fetch",
+            "required": true,
+            "type": "integer",
+            "format": "int64"
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "pet response",
+            "schema": {
+              "$ref": "#/definitions/Pet"
+            }
+          },
+          "default": {
+            "description": "unexpected error",
+            "schema": {
+              "$ref": "#/definitions/ErrorModel"
+            }
+          }
+        }
+      },
+      "delete": {
+        "description": "deletes a single pet based on the ID supplied",
+        "operationId": "deletePet",
+        "parameters": [
+          {
+            "name": "id",
+            "in": "path",
+            "description": "ID of pet to delete",
+            "required": true,
+            "type": "integer",
+            "format": "int64"
+          }
+        ],
+        "responses": {
+          "204": {
+            "description": "pet deleted"
+          },
+          "default": {
+            "description": "unexpected error",
+            "schema": {
+              "$ref": "#/definitions/ErrorModel"
+            }
+          }
+        }
+      }
+    }
+  },
+  "definitions": {
+    "Pet": {
+      "required": [
+        "id",
+        "name"
+      ],
+      "properties": {
+        "id": {
+          "type": "integer",
+          "format": "int64"
+        },
+        "name": {
+          "type": "string"
+        },
+        "tag": {
+          "type": "string"
+        }
+      }
+    },
+    "PetInput": {
+      "allOf": [
+        {
+          "$ref": "#/definitions/Pet"
+        },
+        {
+          "required": [
+            "name"
+          ],
+          "properties": {
+            "id": {
+              "type": "integer",
+              "format": "int64"
+            }
+          }
+        }
+      ]
+    },
+    "ErrorModel": {
+      "required": [
+        "code",
+        "message"
+      ],
+      "properties": {
+        "code": {
+          "type": "integer",
+          "format": "int32"
+        },
+        "message": {
+          "type": "string"
+        }
+      }
+    }
+  }
+}

data/spec/lib/swagger_v2_blocks_spec.rb

@@ -0,0 +1,256 @@
+require 'json'
+require 'swagger/blocks'
+
+# TODO Test data originally based on the Swagger UI example data
+
+RESOURCE_LISTING_JSON_V2 = open(File.expand_path('../swagger_v2_api_declaration.json', __FILE__)).read
+
+class PetControllerV2
+  include Swagger::Blocks
+
+  swagger_root do
+    key :swagger, '2.0'
+    info do
+      key :version, '1.0.0'
+      key :title, 'Swagger Petstore'
+      key :description, 'A sample API that uses a petstore as an example to ' \
+                        'demonstrate features in the swagger-2.0 specification'
+      key :termsOfService, 'http://helloreverb.com/terms/'
+      contact do
+        key :name, 'Wordnik API Team'
+      end
+      license do
+        key :name, 'MIT'
+      end
+    end
+    key :host, 'petstore.swagger.wordnik.com'
+    key :basePath, '/api'
+    key :schemes, ['http']
+    key :consumes, ['application/json']
+    key :produces, ['application/json']
+  end
+
+  swagger_path '/pets' do
+    operation :get do
+      key :description, 'Returns all pets from the system that the user has access to'
+      key :operationId, 'findPets'
+      key :produces, [
+        'application/json',
+        'application/xml',
+        'text/xml',
+        'text/html',
+      ]
+      parameter do
+        key :name, :tags
+        key :in, :query
+        key :description, 'tags to filter by'
+        key :required, false
+        key :type, :array
+        items do
+          key :type, :string
+        end
+        key :collectionFormat, :csv
+      end
+      parameter do
+        key :name, :limit
+        key :in, :query
+        key :description, 'maximum number of results to return'
+        key :required, false
+        key :type, :integer
+        key :format, :int32
+      end
+      response 200 do
+        key :description, 'pet response'
+        schema do
+          key :type, :array
+          items do
+            key :'$ref', :Pet
+          end
+        end
+      end
+      response :default do
+        key :description, 'unexpected error'
+        schema do
+          key :'$ref', :ErrorModel
+        end
+      end
+    end
+    operation :post do
+      key :description, 'Creates a new pet in the store.  Duplicates are allowed'
+      key :operationId, 'addPet'
+      key :produces, [
+        'application/json'
+      ]
+      parameter do
+        key :name, :pet
+        key :in, :body
+        key :description, 'Pet to add to the store'
+        key :required, true
+        schema do
+          key :'$ref', :PetInput
+        end
+      end
+      response 200 do
+        key :description, 'pet response'
+        schema do
+          key :'$ref', :Pet
+        end
+      end
+      response :default do
+        key :description, 'unexpected error'
+        schema do
+          key :'$ref', :ErrorModel
+        end
+      end
+    end
+  end
+
+  swagger_path '/pets/{id}' do
+    operation :get do
+      key :description, 'Returns a user based on a single ID, if the user does not have access to the pet'
+      key :operationId, 'findPetById'
+      key :produces, [
+        'application/json',
+        'application/xml',
+        'text/xml',
+        'text/html',
+      ]
+      parameter do
+        key :name, :id
+        key :in, :path
+        key :description, 'ID of pet to fetch'
+        key :required, true
+        key :type, :integer
+        key :format, :int64
+      end
+      response 200 do
+        key :description, 'pet response'
+        schema do
+          key :'$ref', :Pet
+        end
+      end
+      response :default do
+        key :description, 'unexpected error'
+        schema do
+          key :'$ref', :ErrorModel
+        end
+      end
+    end
+    operation :delete do
+      key :description, 'deletes a single pet based on the ID supplied'
+      key :operationId, 'deletePet'
+      parameter do
+        key :name, :id
+        key :in, :path
+        key :description, 'ID of pet to delete'
+        key :required, true
+        key :type, :integer
+        key :format, :int64
+      end
+      response 204 do
+        key :description, 'pet deleted'
+      end
+      response :default do
+        key :description, 'unexpected error'
+        schema do
+          key :'$ref', :ErrorModel
+        end
+      end
+    end
+  end
+
+end
+
+class PetV2
+  include Swagger::Blocks
+
+  swagger_schema :Pet do
+    key :required, [:id, :name]
+    property :id do
+      key :type, :integer
+      key :format, :int64
+    end
+    property :name do
+      key :type, :string
+    end
+    property :tag do
+      key :type, :string
+    end
+  end
+
+  swagger_schema :PetInput do
+    allOf do
+      schema do
+        key :'$ref', :Pet
+      end
+      schema do
+        key :required, [:name]
+        property :id do
+          key :type, :integer
+          key :format, :int64
+        end
+      end
+    end
+  end
+end
+
+class ErrorModelV2
+  include Swagger::Blocks
+
+  swagger_schema :ErrorModel do
+    key :required, [:code, :message]
+    property :code do
+      key :type, :integer
+      key :format, :int32
+    end
+    property :message do
+      key :type, :string
+    end
+  end
+end
+
+describe 'Swagger::Blocks v2' do
+  describe 'build_json' do
+    it 'outputs the correct data' do
+      swaggered_classes = [
+        PetControllerV2,
+        PetV2,
+        ErrorModelV2
+      ]
+      actual = Swagger::Blocks.build_root_json(swaggered_classes)
+      actual = JSON.parse(actual.to_json)  # For access consistency.
+      data = JSON.parse(RESOURCE_LISTING_JSON_V2)
+
+      # Multiple expectations for better test diff output.
+      expect(actual['info']).to eq(data['info'])
+      expect(actual['paths']).to be
+      expect(actual['paths']['/pets']).to be
+      expect(actual['paths']['/pets']).to eq(data['paths']['/pets'])
+      expect(actual['paths']).to eq(data['paths'])
+      expect(actual['definitions']).to eq(data['definitions'])
+      expect(actual).to eq(data)
+    end
+    it 'is idempotent' do
+      swaggered_classes = [PetControllerV2, PetV2, ErrorModelV2]
+      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_V2)
+      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([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