grape-swagger 0.20.3 → 0.21.0

data/spec/swagger_v2/api_swagger_v2_request_params_fix_spec.rb

@@ -48,20 +48,23 @@ describe 'additional parameter settings' do
       [
         { 'in' => 'path', 'name' => 'id', 'type' => 'integer', 'format' => 'int32', 'required' => true },
         { 'in' => 'formData', 'name' => 'name', 'type' => 'string', 'required' => false }
-      ])
+      ]
+    )
   end
 
   specify do
     expect(subject['paths']['/bookings/{id}']['get']['parameters']).to eql(
       [
         { 'in' => 'path', 'name' => 'id', 'type' => 'integer', 'format' => 'int32', 'required' => true }
-      ])
+      ]
+    )
   end
 
   specify do
     expect(subject['paths']['/bookings/{id}']['delete']['parameters']).to eql(
       [
         { 'in' => 'path', 'name' => 'id', 'type' => 'integer', 'format' => 'int32', 'required' => true }
-      ])
+      ]
+    )
   end
 end

data/spec/swagger_v2/api_swagger_v2_response_spec.rb

@@ -1,7 +1,7 @@
 require 'spec_helper'
 
 describe 'response' do
-  include_context 'the api entities'
+  include_context "#{MODEL_PARSER} swagger example"
 
   before :all do
     module TheApi
@@ -45,6 +45,7 @@ describe 'response' do
     end
     specify do
       expect(subject['paths']['/nested_type']['get']).to eql(
+        'summary' => 'This returns something',
         'description' => 'This returns something',
         'produces' => ['application/json'],
         'responses' => {
@@ -52,22 +53,9 @@ describe 'response' do
           '400' => { 'description' => 'NotFound', 'schema' => { '$ref' => '#/definitions/ApiError' } }
         },
         'tags' => ['nested_type'],
-        'operationId' => 'getNestedType')
-      expect(subject['definitions']).to eql(
-        'ResponseItem' => {
-          'type' => 'object',
-          'properties' => { 'id' => { 'type' => 'integer', 'format' => 'int32' }, 'name' => { 'type' => 'string' } }
-        },
-        'UseItemResponseAsType' => {
-          'type' => 'object',
-          'properties' => { 'description' => { 'type' => 'string' }, 'responses' => { '$ref' => '#/definitions/ResponseItem' } },
-          'description' => 'This returns something'
-        },
-        'ApiError' => {
-          'type' => 'object',
-          'properties' => { 'code' => { 'type' => 'integer', 'format' => 'int32' }, 'message' => { 'type' => 'string' } },
-          'description' => 'This returns something'
-        })
+        'operationId' => 'getNestedType'
+      )
+      expect(subject['definitions']).to eql(swagger_nested_type)
     end
   end
 
@@ -79,6 +67,7 @@ describe 'response' do
 
     specify do
       expect(subject['paths']['/entity_response']['get']).to eql(
+        'summary' => 'This returns something',
         'description' => 'This returns something',
         'produces' => ['application/json'],
         'responses' => {
@@ -86,22 +75,9 @@ describe 'response' do
           '400' => { 'description' => 'NotFound', 'schema' => { '$ref' => '#/definitions/ApiError' } }
         },
         'tags' => ['entity_response'],
-        'operationId' => 'getEntityResponse')
-      expect(subject['definitions']).to eql(
-        'ResponseItem' => {
-          'type' => 'object',
-          'properties' => { 'id' => { 'type' => 'integer', 'format' => 'int32' }, 'name' => { 'type' => 'string' } }
-        },
-        'UseResponse' => {
-          'type' => 'object',
-          'properties' => { 'description' => { 'type' => 'string' }, '$responses' => { 'type' => 'array', 'items' => { '$ref' => '#/definitions/ResponseItem' } } },
-          'description' => 'This returns something'
-        },
-        'ApiError' => {
-          'type' => 'object',
-          'properties' => { 'code' => { 'type' => 'integer', 'format' => 'int32' }, 'message' => { 'type' => 'string' } },
-          'description' => 'This returns something'
-        })
+        'operationId' => 'getEntityResponse'
+      )
+      expect(subject['definitions']).to eql(swagger_entity_as_response_object)
     end
   end
 
@@ -113,6 +89,7 @@ describe 'response' do
 
     specify do
       expect(subject['paths']['/params_response']['post']).to eql(
+        'summary' => 'This returns something',
         'description' => 'This returns something',
         'produces' => ['application/json'],
         'consumes' => ['application/json'],
@@ -125,13 +102,9 @@ describe 'response' do
           '400' => { 'description' => 'NotFound', 'schema' => { '$ref' => '#/definitions/ApiError' } }
         },
         'tags' => ['params_response'],
-        'operationId' => 'postParamsResponse')
-      expect(subject['definitions']).to eql(
-        'ApiError' => {
-          'type' => 'object',
-          'properties' => { 'code' => { 'type' => 'integer', 'format' => 'int32' }, 'message' => { 'type' => 'string' } },
-          'description' => 'This returns something'
-        })
+        'operationId' => 'postParamsResponse'
+      )
+      expect(subject['definitions']).to eql(swagger_params_as_response_object)
     end
   end
 end

data/spec/swagger_v2/api_swagger_v2_spec.rb

@@ -1,7 +1,7 @@
 require 'spec_helper'
 
 describe 'swagger spec v2.0' do
-  include_context 'swagger example'
+  include_context "#{MODEL_PARSER} swagger example"
 
   def app
     Class.new(Grape::API) do
@@ -201,6 +201,8 @@ describe 'swagger spec v2.0' do
   end
 
   describe 'swagger file' do
-    it { expect(json).to eql swagger_json }
+    it do
+      expect(json).to eql swagger_json
+    end
   end
 end

data/spec/swagger_v2/api_swagger_v2_type-format_spec.rb

@@ -20,30 +20,13 @@ require 'spec_helper'
 # Rack::Multipart::UploadedFile ->  file
 
 describe 'type format settings' do
+  include_context "#{MODEL_PARSER} swagger example"
+
   before :all do
     module TheApi
-      module Entities
-        class TypedDefinition < Grape::Entity
-          expose :prop_integer,   documentation: { type: Integer, desc: 'prop_integer description' }
-          expose :prop_long,      documentation: { type: Numeric, desc: 'prop_long description' }
-          expose :prop_float,     documentation: { type: Float, desc: 'prop_float description' }
-          expose :prop_double,    documentation: { type: BigDecimal, desc: 'prop_double description' }
-          expose :prop_string,    documentation: { type: String, desc: 'prop_string description' }
-          expose :prop_symbol,    documentation: { type: Symbol, desc: 'prop_symbol description' }
-          expose :prop_date,      documentation: { type: Date, desc: 'prop_date description' }
-          expose :prop_date_time, documentation: { type: DateTime, desc: 'prop_date_time description' }
-          expose :prop_time,      documentation: { type: Time, desc: 'prop_time description' }
-          expose :prop_password,  documentation: { type: 'password', desc: 'prop_password description' }
-          expose :prop_email,     documentation: { type: 'email', desc: 'prop_email description' }
-          expose :prop_boolean,   documentation: { type: Virtus::Attribute::Boolean, desc: 'prop_boolean description' }
-          expose :prop_file,      documentation: { type: File, desc: 'prop_file description' }
-          expose :prop_json,      documentation: { type: JSON, desc: 'prop_json description' }
-        end
-      end
-
       class TypeFormatApi < Grape::API
         desc 'full set of request data types',
-             success: TheApi::Entities::TypedDefinition
+             success: Entities::TypedDefinition
 
         params do
           # grape supported data types
@@ -94,24 +77,11 @@ describe 'type format settings' do
         { 'in' => 'formData', 'name' => 'param_boolean', 'required' => false, 'type' => 'boolean' },
         { 'in' => 'formData', 'name' => 'param_file', 'required' => false, 'type' => 'file' },
         { 'in' => 'formData', 'name' => 'param_json', 'required' => false, 'type' => 'json' }
-      ])
+      ]
+    )
   end
 
   specify do
-    expect(subject['definitions']['TypedDefinition']['properties']).to eql(
-      'prop_integer' => { 'type' => 'integer', 'format' => 'int32', 'description' => 'prop_integer description' },
-      'prop_long' => { 'type' => 'integer', 'format' => 'int64', 'description' => 'prop_long description' },
-      'prop_float' => { 'type' => 'number', 'format' => 'float', 'description' => 'prop_float description' },
-      'prop_double' => { 'type' => 'number', 'format' => 'double', 'description' => 'prop_double description' },
-      'prop_string' => { 'type' => 'string', 'description' => 'prop_string description' },
-      'prop_symbol' => { 'type' => 'string', 'description' => 'prop_symbol description' },
-      'prop_date' => { 'type' => 'string', 'format' => 'date', 'description' => 'prop_date description' },
-      'prop_date_time' => { 'type' => 'string', 'format' => 'date-time', 'description' => 'prop_date_time description' },
-      'prop_time' => { 'type' => 'string', 'format' => 'date-time', 'description' => 'prop_time description' },
-      'prop_password' => { 'type' => 'string', 'format' => 'password', 'description' => 'prop_password description' },
-      'prop_email' => { 'type' => 'string', 'format' => 'email', 'description' => 'prop_email description' },
-      'prop_boolean' => { 'type' => 'boolean', 'description' => 'prop_boolean description' },
-      'prop_file' => { 'type' => 'file', 'description' => 'prop_file description' },
-      'prop_json' => { 'type' => 'json', 'description' => 'prop_json description' })
+    expect(subject['definitions']['TypedDefinition']['properties']).to eql(swagger_typed_defintion)
   end
 end

data/spec/swagger_v2/default_api_spec.rb

@@ -29,11 +29,15 @@ describe 'Default API' do
         'paths' => {
           '/something' => {
             'get' => {
+              'summary' => 'This gets something.',
               'description' => 'This gets something.',
               'produces' => ['application/json'],
               'tags' => ['something'],
               'operationId' => 'getSomething',
-              'responses' => { '200' => { 'description' => 'This gets something.' } } } } }
+              'responses' => { '200' => { 'description' => 'This gets something.' } }
+            }
+          }
+        }
       )
     end
 
@@ -72,11 +76,15 @@ describe 'Default API' do
                             'paths' => {
                               '/something' => {
                                 'get' => {
+                                  'summary' => 'This gets something.',
                                   'description' => 'This gets something.',
                                   'produces' => ['application/json'],
                                   'tags' => ['something'],
                                   'operationId' => 'getSomething',
-                                  'responses' => { '200' => { 'description' => 'This gets something.' } } } } })
+                                  'responses' => { '200' => { 'description' => 'This gets something.' } }
+                                }
+                              }
+                            })
     end
   end
 

data/spec/swagger_v2/endpoint_versioned_path_spec.rb

@@ -0,0 +1,30 @@
+require 'spec_helper'
+
+describe 'Grape::Endpoint#path_and_definitions' do
+  before do
+    module API
+      module V1
+        class Item < Grape::API
+          version 'v1', using: :path
+
+          resource :item do
+            get '/'
+          end
+        end
+      end
+
+      class Root < Grape::API
+        mount API::V1::Item
+        add_swagger_documentation add_version: true
+      end
+    end
+
+    @options = { add_version: true }
+    @target_routes = API::Root.combined_namespace_routes
+  end
+
+  it 'is returning a versioned path' do
+    expect(API::V1::Item.endpoints[0]
+      .path_and_definition_objects(@target_routes, @options)[0].keys[0]).to eql '/v1/item'
+  end
+end

data/spec/swagger_v2/errors_spec.rb

@@ -0,0 +1,75 @@
+require 'spec_helper'
+
+describe 'Errors' do
+  describe 'Empty model error' do
+    let!(:app) do
+      Class.new(Grape::API) do
+        format :json
+
+        desc 'Empty model get.' do
+          http_codes [
+            { code: 200, message: 'get Empty model', model: EmptyClass }
+          ]
+        end
+        get '/empty_model' do
+          something = OpenStruct.new text: 'something'
+          present something, with: EmptyClass
+        end
+
+        version 'v3', using: :path
+        add_swagger_documentation api_version: 'v1',
+                                  base_path: '/api',
+                                  info: {
+                                    title: 'The API title to be displayed on the API homepage.',
+                                    description: 'A description of the API.',
+                                    contact_name: 'Contact name',
+                                    contact_email: 'Contact@email.com',
+                                    contact_url: 'Contact URL',
+                                    license: 'The name of the license.',
+                                    license_url: 'www.The-URL-of-the-license.org',
+                                    terms_of_service_url: 'www.The-URL-of-the-terms-and-service.com'
+                                  }
+      end
+    end
+
+    it 'should raise SwaggerSpec exception' do
+      expect { get '/v3/swagger_doc' }.to raise_error(GrapeSwagger::Errors::SwaggerSpec, "Empty model EmptyClass, swagger 2.0 doesn't support empty definitions.")
+    end
+  end
+
+  describe 'Parser not found error' do
+    let!(:app) do
+      Class.new(Grape::API) do
+        format :json
+
+        desc 'Wrong model get.' do
+          http_codes [
+            { code: 200, message: 'get Wrong model', model: Hash }
+          ]
+        end
+        get '/wrong_model' do
+          something = OpenStruct.new text: 'something'
+          present something, with: Hash
+        end
+
+        version 'v3', using: :path
+        add_swagger_documentation api_version: 'v1',
+                                  base_path: '/api',
+                                  info: {
+                                    title: 'The API title to be displayed on the API homepage.',
+                                    description: 'A description of the API.',
+                                    contact_name: 'Contact name',
+                                    contact_email: 'Contact@email.com',
+                                    contact_url: 'Contact URL',
+                                    license: 'The name of the license.',
+                                    license_url: 'www.The-URL-of-the-license.org',
+                                    terms_of_service_url: 'www.The-URL-of-the-terms-and-service.com'
+                                  }
+      end
+    end
+
+    it 'should raise UnregisteredParser exception' do
+      expect { get '/v3/swagger_doc' }.to raise_error(GrapeSwagger::Errors::UnregisteredParser, 'No parser registered for Hash.')
+    end
+  end
+end

data/spec/swagger_v2/hide_api_spec.rb

@@ -44,18 +44,26 @@ describe 'a hide mounted api' do
       'paths' => {
         '/simple' => {
           'get' => {
+            'summary' => 'Show this endpoint',
             'description' => 'Show this endpoint',
             'produces' => ['application/json'],
             'tags' => ['simple'],
             'operationId' => 'getSimple',
-            'responses' => { '200' => { 'description' => 'Show this endpoint' } } } },
+            'responses' => { '200' => { 'description' => 'Show this endpoint' } }
+          }
+        },
         '/lazy' => {
           'get' => {
+            'summary' => 'Lazily show endpoint',
             'description' => 'Lazily show endpoint',
             'produces' => ['application/json'],
             'tags' => ['lazy'],
             'operationId' => 'getLazy',
-            'responses' => { '200' => { 'description' => 'Lazily show endpoint' } } } } })
+            'responses' => { '200' => { 'description' => 'Lazily show endpoint' } }
+          }
+        }
+      }
+    )
   end
 end
 
@@ -99,10 +107,15 @@ describe 'a hide mounted api with same namespace' do
       'paths' => {
         '/simple/show' => {
           'get' => {
+            'summary' => 'Show this endpoint',
             'description' => 'Show this endpoint',
             'produces' => ['application/json'],
             'operationId' => 'getSimpleShow',
-            'tags' => ['simple'], 'responses' => { '200' => { 'description' => 'Show this endpoint' } } } } })
+            'tags' => ['simple'], 'responses' => { '200' => { 'description' => 'Show this endpoint' } }
+          }
+        }
+      }
+    )
   end
 
   it "retrieves the documentation for mounted-api that doesn't include hidden endpoints" do
@@ -116,10 +129,15 @@ describe 'a hide mounted api with same namespace' do
       'paths' => {
         '/simple/show' => {
           'get' => {
+            'summary' => 'Show this endpoint',
             'description' => 'Show this endpoint',
             'produces' => ['application/json'],
             'tags' => ['simple'],
             'operationId' => 'getSimpleShow',
-            'responses' => { '200' => { 'description' => 'Show this endpoint' } } } } })
+            'responses' => { '200' => { 'description' => 'Show this endpoint' } }
+          }
+        }
+      }
+    )
   end
 end

data/spec/swagger_v2/mounted_target_class_spec.rb

@@ -37,6 +37,7 @@ describe 'docs mounted separately from api' do
       'paths' => {
         '/simple' => {
           'get' => {
+            'summary' => 'This gets something.',
             'description' => 'This gets something.',
             'produces' => ['application/json'],
             'responses' => { '200' => { 'description' => 'This gets something.' } },
@@ -44,7 +45,8 @@ describe 'docs mounted separately from api' do
             'operationId' => 'getSimple'
           }
         }
-      })
+      }
+    )
   end
 
   it 'retrieves docs for endpoint in actual api class' do
@@ -58,6 +60,7 @@ describe 'docs mounted separately from api' do
       'paths' => {
         '/simple' => {
           'get' => {
+            'summary' => 'This gets something.',
             'description' => 'This gets something.',
             'produces' => ['application/json'],
             'responses' => {
@@ -67,6 +70,7 @@ describe 'docs mounted separately from api' do
             'operationId' => 'getSimple'
           }
         }
-      })
+      }
+    )
   end
 end

data/spec/swagger_v2/namespace_tags_prefix_spec.rb

@@ -34,7 +34,8 @@ describe 'namespace tags check while using prefix and version' do
           { 'name' => 'colorado', 'description' => 'Operations about colorados' },
           { 'name' => 'thames', 'description' => 'Operations about thames' },
           { 'name' => 'niles', 'description' => 'Operations about niles' }
-        ])
+        ]
+      )
 
       expect(subject['paths']['/api/v1/hudson']['get']['tags']).to eql(['hudson'])
       expect(subject['paths']['/api/v1/colorado/simple']['get']['tags']).to eql(['colorado'])
@@ -58,7 +59,8 @@ describe 'namespace tags check while using prefix and version' do
           { 'name' => 'colorado', 'description' => 'Operations about colorados' },
           { 'name' => 'thames', 'description' => 'Operations about thames' },
           { 'name' => 'niles', 'description' => 'Operations about niles' }
-        ])
+        ]
+      )
 
       expect(subject['paths']['/api/v1/colorado/simple']['get']['tags']).to eql(['colorado'])
       expect(subject['paths']['/api/v1/colorado/simple-test']['get']['tags']).to eql(['colorado'])
@@ -77,7 +79,8 @@ describe 'namespace tags check while using prefix and version' do
             { 'name' => 'colorado', 'description' => 'Operations about colorados' },
             { 'name' => 'thames', 'description' => 'Operations about thames' },
             { 'name' => 'niles', 'description' => 'Operations about niles' }
-          ])
+          ]
+        )
 
         expect(subject['paths']['/api/v1/thames/simple_with_headers']['get']['tags']).to eql(['thames'])
       end