grape-swagger 0.8.0 → 0.9.0

data/lib/grape-swagger/version.rb

@@ -1,3 +1,3 @@
 module GrapeSwagger
-  VERSION = '0.8.0'
+  VERSION = '0.9.0'
 end

data/spec/api_global_models_spec.rb

@@ -7,10 +7,12 @@ describe 'Global Models' do
       module Some
         class Thing < Grape::Entity
           expose :text, documentation: { type: 'string', desc: 'Content of something.' }
+          expose :name, documentation: { type: String, desc: 'Name of something.' }
         end
 
         class CombinedThing < Grape::Entity
           expose :text, documentation: { type: 'string', desc: 'Content of something.' }
+          expose :created_at, documentation: { type: DateTime, desc: 'Creation of something.' }
         end
       end
     end
@@ -18,15 +20,13 @@ describe 'Global Models' do
 
   subject do
     Class.new(Grape::API) do
-      desc 'This gets thing.', params: Entities::Some::Thing.documentation
+      desc 'This gets thing.'
       get '/thing' do
         thing = OpenStruct.new text: 'thing'
         present thing, with: Entities::Some::Thing
       end
 
-      desc 'This gets combined thing.',
-           params: Entities::Some::CombinedThing.documentation,
-           entity: Entities::Some::CombinedThing
+      desc 'This gets combined thing.', entity: Entities::Some::CombinedThing
       get '/combined_thing' do
         thing = OpenStruct.new text: 'thing'
         present thing, with: Entities::Some::CombinedThing
@@ -47,7 +47,8 @@ describe 'Global Models' do
         'Some::Thing' => {
           'id' => 'Some::Thing',
           'properties' => {
-            'text' => { 'type' => 'string', 'description' => 'Content of something.' }
+            'text' => { 'type' => 'string', 'description' => 'Content of something.' },
+            'name' => { 'type' => 'string', 'description' => 'Name of something.' }
           }
         })
   end
@@ -60,7 +61,8 @@ describe 'Global Models' do
                                   'Some::Thing' => {
                                     'id' => 'Some::Thing',
                                     'properties' => {
-                                      'text' => { 'type' => 'string', 'description' => 'Content of something.' }
+                                      'text' => { 'type' => 'string', 'description' => 'Content of something.' },
+                                      'name' => { 'type' => 'string', 'description' => 'Name of something.' }
                                     }
                                   })
 
@@ -68,7 +70,8 @@ describe 'Global Models' do
                                   'Some::CombinedThing' => {
                                     'id' => 'Some::CombinedThing',
                                     'properties' => {
-                                      'text' => { 'type' => 'string', 'description' => 'Content of something.' }
+                                      'text' => { 'type' => 'string', 'description' => 'Content of something.' },
+                                      'created_at' => { 'type' => 'dateTime', 'description' => 'Creation of something.' }
                                     }
                                   })
 

data/spec/api_models_spec.rb

@@ -6,6 +6,7 @@ describe 'API Models' do
     module Entities
       class Something < Grape::Entity
         expose :text, documentation: { type: 'string', desc: 'Content of something.' }
+        expose :links, documentation: { type: 'link', is_array: true }
       end
     end
 
@@ -51,6 +52,24 @@ describe 'API Models' do
         expose :something, as: :post, using: Entities::Something, documentation: { type: 'Something', desc: 'Reference to something.' }
       end
     end
+
+    module Entities
+      class FourthLevel < Grape::Entity
+        expose :text, documentation: { type: 'string' }
+      end
+
+      class ThirdLevel < Grape::Entity
+        expose :parts, using: Entities::FourthLevel, documentation: { type: 'FourthLevel' }
+      end
+
+      class SecondLevel < Grape::Entity
+        expose :parts, using: Entities::ThirdLevel, documentation: { type: 'ThirdLevel' }
+      end
+
+      class FirstLevel < Grape::Entity
+        expose :parts, using: Entities::SecondLevel, documentation: { type: 'SecondLevel' }
+      end
+    end
   end
 
   def app
@@ -91,6 +110,16 @@ describe 'API Models' do
         present something, with: Entities::AliasedThing
       end
 
+      desc 'This gets all nested entities.', entity: Entities::FirstLevel
+      get '/nesting' do
+        fourth_level = OpenStruct.new text: 'something'
+        third_level  = OpenStruct.new parts: [fourth_level]
+        second_level = OpenStruct.new parts: [third_level]
+        first_level  = OpenStruct.new parts: [second_level]
+
+        present first_level, with: Entities::FirstLevel
+      end
+
       add_swagger_documentation
     end
   end
@@ -117,37 +146,28 @@ describe 'API Models' do
         { 'path' => '/somethingelse.{format}', 'description' => 'Operations about somethingelses' },
         { 'path' => '/enum_description_in_entity.{format}', 'description' => 'Operations about enum_description_in_entities' },
         { 'path' => '/aliasedthing.{format}', 'description' => 'Operations about aliasedthings' },
+        { 'path' => '/nesting.{format}', 'description' => 'Operations about nestings' },
         { 'path' => '/swagger_doc.{format}', 'description' => 'Operations about swagger_docs' }
       ]
     end
   end
 
   it 'returns type' do
-    get '/swagger_doc/something.json'
+    get '/swagger_doc/something'
     result = JSON.parse(last_response.body)
     expect(result['apis'].first['operations'].first['type']).to eq 'Something'
   end
 
   it 'includes nested type' do
-    get '/swagger_doc/thing.json'
+    get '/swagger_doc/thing'
     result = JSON.parse(last_response.body)
     expect(result['apis'].first['operations'].first['type']).to eq 'Some::Thing'
   end
 
   it 'includes entities which are only used as composition' do
-    get '/swagger_doc/somethingelse.json'
+    get '/swagger_doc/somethingelse'
     result = JSON.parse(last_response.body)
-    expect(result['apis']).to eq([{
-                                   'path' => '/somethingelse.{format}',
-                                   'operations' => [{
-                                     'notes' => '',
-                                     'type' => 'SomeThingElse',
-                                     'summary' => 'This gets somthing else.',
-                                     'nickname' => 'GET-somethingelse---format-',
-                                     'method' => 'GET',
-                                     'parameters' => []
-                                   }]
-                                 }])
+    expect(result['apis'][0]['path']).to start_with '/somethingelse'
 
     expect(result['models']['SomeThingElse']).to include('id' => 'SomeThingElse',
                                                          'properties' => {
@@ -188,7 +208,7 @@ describe 'API Models' do
   end
 
   it 'includes enum values in params and documentation.' do
-    get '/swagger_doc/enum_description_in_entity.json'
+    get '/swagger_doc/enum_description_in_entity'
     result = JSON.parse(last_response.body)
     expect(result['models']['EnumValues']).to eq(
                                                   'id' => 'EnumValues',
@@ -210,7 +230,7 @@ describe 'API Models' do
   end
 
   it 'includes referenced models in those with aliased references.' do
-    get '/swagger_doc/aliasedthing.json'
+    get '/swagger_doc/aliasedthing'
     result = JSON.parse(last_response.body)
     expect(result['models']['AliasedThing']).to eq(
                                                     'id' => 'AliasedThing',
@@ -222,8 +242,16 @@ describe 'API Models' do
     expect(result['models']['Something']).to eq(
                                                  'id' => 'Something',
                                                  'properties' => {
-                                                   'text' => { 'type' => 'string', 'description' => 'Content of something.' }
+                                                   'text' => { 'type' => 'string', 'description' => 'Content of something.' },
+                                                   'links' => { 'type' => 'array', 'items' => { '$ref' => 'link' } }
                                                  }
                                              )
   end
+
+  it 'includes all entities with four levels of nesting' do
+    get '/swagger_doc/nesting'
+    result = JSON.parse(last_response.body)
+
+    expect(result['models']).to include('FirstLevel', 'SecondLevel', 'ThirdLevel', 'FourthLevel')
+  end
 end

data/spec/api_paths_spec.rb

@@ -0,0 +1,67 @@
+require 'spec_helper'
+
+describe 'simple api with prefix' do
+
+  before :all do
+    class ApiWithPrefix < Grape::API
+      prefix :api
+
+      desc 'This gets apitest'
+      get '/apitest' do
+        { test: 'something' }
+      end
+    end
+
+    class SimpleApiWithPrefix < Grape::API
+      mount ApiWithPrefix
+      add_swagger_documentation
+    end
+
+  end
+
+  def app
+    SimpleApiWithPrefix
+  end
+
+  it 'should not raise TypeError exception' do
+  end
+
+  it 'retrieves swagger-documentation on /swagger_doc that contains apitest' do
+    get '/swagger_doc.json'
+    expect(JSON.parse(last_response.body)).to eq(
+      'apiVersion' => '0.1',
+      'swaggerVersion' => '1.2',
+      'info' => {},
+      'produces' => Grape::ContentTypes::CONTENT_TYPES.values.uniq,
+      'apis' => [
+        { 'path' => '/apitest.{format}', 'description' => 'Operations about apitests' },
+        { 'path' => '/swagger_doc.{format}', 'description' => 'Operations about swagger_docs' }
+      ]
+    )
+  end
+
+  context 'retrieves the documentation for apitest that' do
+    it 'contains returns something in URL' do
+      get '/swagger_doc/apitest.json'
+      expect(JSON.parse(last_response.body)).to eq(
+        'apiVersion' => '0.1',
+        'swaggerVersion' => '1.2',
+        'basePath' => 'http://example.org',
+        'resourcePath' => '/apitest',
+        'produces' => Grape::ContentTypes::CONTENT_TYPES.values.uniq,
+        'apis' => [{
+          'path' => '/api/apitest.{format}',
+          'operations' => [{
+            'notes' => '',
+            'summary' => 'This gets apitest',
+            'nickname' => 'GET-api-apitest---format-',
+            'method' => 'GET',
+            'parameters' => [],
+            'type' => 'void'
+          }]
+        }]
+      )
+    end
+  end
+
+end

data/spec/api_root_spec.rb

@@ -0,0 +1,31 @@
+require 'spec_helper'
+
+describe 'simple root api' do
+
+  before :all do
+    class ApiRoot < Grape::API
+      format :json
+      prefix 'api'
+      version 'v2', using: :header, vendor: 'artsy', strict: false
+      get do
+        {}
+      end
+      add_swagger_documentation
+    end
+  end
+
+  def app
+    ApiRoot
+  end
+
+  it 'retrieves swagger-documentation on /swagger_doc' do
+    get '/api/swagger_doc'
+    expect(JSON.parse(last_response.body)).to eq(
+      'apiVersion' => '0.1',
+      'swaggerVersion' => '1.2',
+      'info' => {},
+      'produces' => ['application/json'],
+      'apis' => [{ 'path' => '/swagger_doc.{format}', 'description' => 'Operations about swagger_docs' }]
+    )
+  end
+end

data/spec/boolean_params_spec.rb

@@ -0,0 +1,30 @@
+require 'spec_helper'
+
+describe 'Boolean Params' do
+  def app
+    Class.new(Grape::API) do
+      format :json
+
+      params do
+        requires :a_boolean, type: Virtus::Attribute::Boolean
+      end
+      post :splines do
+      end
+
+      add_swagger_documentation
+    end
+  end
+
+  subject do
+    get '/swagger_doc/splines'
+    expect(last_response.status).to eq 200
+    body = JSON.parse last_response.body
+    body['apis'].first['operations'].first['parameters']
+  end
+
+  it 'converts boolean types' do
+    expect(subject).to eq [
+      { 'paramType' => 'form', 'name' => 'a_boolean', 'description' => nil, 'type' => 'boolean', 'required' => true, 'allowMultiple' => false }
+    ]
+  end
+end

data/spec/form_params_spec.rb

@@ -35,52 +35,16 @@ describe 'Form Params' do
   end
 
   subject do
-    get '/swagger_doc/items.json'
+    get '/swagger_doc/items'
     JSON.parse(last_response.body)
   end
 
   it 'retrieves the documentation form params' do
-    expect(subject['apis']).to eq([
-      {
-        'path' => '/items.{format}',
-        'operations' => [
-          {
-            'notes' => '',
-            'summary' => '',
-            'nickname' => 'POST-items---format-',
-            'method' => 'POST',
-            'parameters' => [{ 'paramType' => 'form', 'name' => 'name', 'description' => 'name of item', 'type' => 'string', 'required' => true, 'allowMultiple' => false }],
-            'type' => 'void'
-          }
-        ]
-      }, {
-        'path' => '/items/{id}.{format}',
-        'operations' => [
-          {
-            'notes' => '',
-            'summary' => '',
-            'nickname' => 'PUT-items--id---format-',
-            'method' => 'PUT',
-            'parameters' => [
-              { 'paramType' => 'path', 'name' => 'id', 'description' => 'id of item', 'type' => 'integer', 'required' => true, 'allowMultiple' => false, 'format' => 'int32' },
-              { 'paramType' => 'form', 'name' => 'name', 'description' => 'name of item', 'type' => 'string', 'required' => true, 'allowMultiple' => false },
-              { 'paramType' => 'form', 'name' => 'conditions', 'description' => 'conditions of item', 'type' => 'integer', 'required' => true, 'allowMultiple' => false, 'format' => 'int32', 'enum' => [1, 2, 3] }
-            ],
-            'type' => 'void'
-          },
-          {
-            'notes' => '',
-            'summary' => '',
-            'nickname' => 'PATCH-items--id---format-',
-            'method' => 'PATCH',
-            'parameters' => [
-              { 'paramType' => 'path', 'name' => 'id', 'description' => 'id of item', 'type' => 'integer', 'required' => true, 'allowMultiple' => false, 'format' => 'int32' },
-              { 'paramType' => 'form', 'name' => 'name', 'description' => 'name of item', 'type' => 'string', 'required' => true, 'allowMultiple' => false },
-              { 'paramType' => 'form', 'name' => 'conditions', 'description' => 'conditions of item', 'type' => 'string', 'required' => false, 'allowMultiple' => false, 'enum' => %w(1 2) }
-            ],
-            'type' => 'void'
-          }
-        ]
-      }])
+    expect(subject['apis'].count).to eq 2
+    expect(subject['apis'][0]['path']).to start_with '/items'
+    expect(subject['apis'][0]['operations'][0]['method']).to eq 'POST'
+    expect(subject['apis'][1]['path']).to start_with '/items/{id}'
+    expect(subject['apis'][1]['operations'][0]['method']).to eq 'PUT'
+    expect(subject['apis'][1]['operations'][1]['method']).to eq 'PATCH'
   end
 end

data/spec/grape-swagger_helper_spec.rb

@@ -4,19 +4,11 @@ describe 'helpers' do
 
   before :all do
     class HelperTestAPI < Grape::API
-      add_swagger_documentation
     end
   end
 
   subject do
-    api = Object.new
-
-    # after injecting grape-swagger into the Test API we get the helper methods
-    # back from the first endpoint's class (the API mounted by grape-swagger
-    # to serve the swagger_doc
-
-    api.extend HelperTestAPI.endpoints.first.options[:app].helpers
-    api
+    HelperTestAPI.add_swagger_documentation
   end
 
   context 'parsing parameters' do
@@ -53,12 +45,6 @@ describe 'helpers' do
           desc: 'rack file',
           datafile: 'content',
           required: true
-        },
-        rails: {
-          type: 'Hash',
-          desc: 'rails file',
-          datafile: 'content',
-          required: true
         }
       }
       path = '/coolness'
@@ -71,14 +57,6 @@ describe 'helpers' do
           type: 'File',
           required: true,
           allowMultiple: false
-        },
-        {
-          paramType: 'body',
-          name: :rails,
-          description: 'rails file',
-          type: 'File',
-          required: true,
-          allowMultiple: false
         }
       ]
 

data/spec/group_params_spec.rb

@@ -0,0 +1,31 @@
+require 'spec_helper'
+
+describe 'Group Params' do
+  def app
+    Class.new(Grape::API) do
+      format :json
+
+      params do
+        requires :required_group, type: Hash do
+          requires :required_param_1
+          requires :required_param_2
+        end
+      end
+      post '/groups' do
+        {}
+      end
+
+      add_swagger_documentation
+    end
+  end
+
+  it 'retrieves the documentation for group parameters' do
+    get '/swagger_doc/groups'
+
+    body = JSON.parse last_response.body
+    parameters = body['apis'].first['operations'].first['parameters']
+    expect(parameters).to eq [
+      { 'paramType' => 'form', 'name' => 'required_group[required_param_1]', 'description' => nil, 'type' => 'string', 'required' => true, 'allowMultiple' => false },
+      { 'paramType' => 'form', 'name' => 'required_group[required_param_2]', 'description' => nil, 'type' => 'string', 'required' => true, 'allowMultiple' => false }]
+  end
+end