swagger-blocks 1.4.0 → 2.0.0

data/spec/lib/swagger_blocks_spec.rb

@@ -1,349 +0,0 @@
-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 swaggerVersion: '1.2'do
-    key :apiVersion, '1.0.0'
-    info title: 'Swagger Sample App' do
-      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/'
-      keys contact: 'apiteam@wordnik.com',
-           license: 'Apache 2.0',
-           licenseUrl: 'http://www.apache.org/licenses/LICENSE-2.0.html'
-    end
-    api path: '/pet', description: 'Operations about pets'
-    api do
-      key :path, '/user'
-      key :description, 'Operations about user'
-    end
-    api do
-      key :path, '/store'
-      key :description, 'Operations about store'
-    end
-    authorization :oauth2, type: 'oauth2' do
-      scope scope: 'email', description: 'Access to your email address'
-      scope do
-        key :scope, 'pets'
-        key :description, 'Access to your pets'
-      end
-      grant_type :implicit, tokenName: 'access_token' do
-        login_endpoint do
-          key :url, 'http://petstore.swagger.wordnik.com/oauth/dialog'
-        end
-      end
-      grant_type :authorization_code do
-        token_request_endpoint clientSecretName: 'client_secret' do
-          key :url, 'http://petstore.swagger.wordnik.com/oauth/requestToken'
-          key :clientIdName, 'client_id'
-        end
-        token_endpoint tokenName: 'access_code' do
-          key :url, 'http://petstore.swagger.wordnik.com/oauth/token'
-        end
-      end
-    end
-  end
-
-  # All swagger_api_root declarations with the same key will be merged.
-  swagger_api_root :pets, swaggerVersion: '1.2' do
-    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 paramType: :path do
-          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 code: 400 do
-          key :message, 'Invalid tag value'
-        end
-      end
-    end
-  end
-
-  swagger_api_root :pets do
-    api do
-      key :path, '/pet/findByStatus'
-      operation method: 'GET' do
-        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 :'$ref' => :Pet
-        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 code: 400, message: 'Invalid status value'
-      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, id: :Pet do
-    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 v1' 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 multiple 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

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