grape-swagger 0.9.0 → 0.10.0

data/lib/grape-swagger/version.rb

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

data/spec/api_global_models_spec.rb

@@ -1,7 +1,6 @@
 require 'spec_helper'
 
 describe 'Global Models' do
-
   before :all do
     module Entities
       module Some
@@ -74,6 +73,5 @@ describe 'Global Models' do
                                       'created_at' => { 'type' => 'dateTime', 'description' => 'Creation of something.' }
                                     }
                                   })
-
   end
 end

data/spec/api_models_spec.rb

@@ -1,7 +1,6 @@
 require 'spec_helper'
 
 describe 'API Models' do
-
   before :all do
     module Entities
       class Something < Grape::Entity
@@ -72,6 +71,29 @@ describe 'API Models' do
     end
   end
 
+  module Entities
+    class QueryInputElement < Grape::Entity
+      expose :key, documentation: {
+        type: String, desc: 'Name of parameter', required: true }
+      expose :value, documentation: {
+        type: String, desc: 'Value of parameter', required: true }
+    end
+
+    class QueryInput < Grape::Entity
+      expose :elements, using: Entities::QueryInputElement, documentation: {
+        type: 'QueryInputElement',
+        desc: 'Set of configuration',
+        param_type: 'body',
+        is_array: true,
+        required: true
+      }
+    end
+
+    class QueryResult < Grape::Entity
+      expose :elements_size, documentation: { type: Integer, desc: 'Return input elements size' }
+    end
+  end
+
   def app
     Class.new(Grape::API) do
       format :json
@@ -98,7 +120,6 @@ describe 'API Models' do
 
       desc 'This tests the enum values in params and documentation.', entity: Entities::EnumValues, params: Entities::EnumValues.documentation
       get '/enum_description_in_entity' do
-
         enum_value = OpenStruct.new gender: 'Male', number: 1
 
         present enum_value, with: Entities::EnumValues
@@ -120,6 +141,14 @@ describe 'API Models' do
         present first_level, with: Entities::FirstLevel
       end
 
+      desc 'This tests diffrent entity for input and diffrent for output',
+           entity: [Entities::QueryResult, Entities::QueryInput],
+           params: Entities::QueryInput.documentation
+      get '/multiple_entities' do
+        result = OpenStruct.new(elements_size: params[:elements].size)
+        present result, with: Entities::QueryResult
+      end
+
       add_swagger_documentation
     end
   end
@@ -147,6 +176,7 @@ describe 'API Models' do
         { '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' => '/multiple_entities.{format}', 'description' => 'Operations about multiple_entities' },
         { 'path' => '/swagger_doc.{format}', 'description' => 'Operations about swagger_docs' }
       ]
     end
@@ -226,7 +256,6 @@ describe 'API Models' do
                                                          ],
                                                       'type' => 'EnumValues'
                                                   )
-
   end
 
   it 'includes referenced models in those with aliased references.' do
@@ -254,4 +283,11 @@ describe 'API Models' do
 
     expect(result['models']).to include('FirstLevel', 'SecondLevel', 'ThirdLevel', 'FourthLevel')
   end
+
+  it 'includes all entities while using multiple entities' do
+    get '/swagger_doc/multiple_entities'
+    result = JSON.parse(last_response.body)
+
+    expect(result['models']).to include('QueryInput', 'QueryInputElement', 'QueryResult')
+  end
 end

data/spec/api_paths_spec.rb

@@ -1,7 +1,6 @@
 require 'spec_helper'
 
 describe 'simple api with prefix' do
-
   before :all do
     class ApiWithPrefix < Grape::API
       prefix :api
@@ -16,7 +15,6 @@ describe 'simple api with prefix' do
       mount ApiWithPrefix
       add_swagger_documentation
     end
-
   end
 
   def app
@@ -63,5 +61,4 @@ describe 'simple api with prefix' do
       )
     end
   end
-
 end

data/spec/api_root_spec.rb

@@ -1,7 +1,6 @@
 require 'spec_helper'
 
 describe 'simple root api' do
-
   before :all do
     class ApiRoot < Grape::API
       format :json

data/spec/api_with_path_versioning_spec.rb

@@ -0,0 +1,33 @@
+require 'spec_helper'
+
+describe 'Api with "path" versioning' do
+  let(:json_body) { JSON.parse(last_response.body) }
+
+  before :all do
+    class ApiWithPathVersioning < Grape::API
+      format :json
+      version 'v1', using: :path
+
+      namespace :resources do
+        get
+      end
+
+      add_swagger_documentation api_version: 'v1'
+    end
+  end
+
+  def app
+    ApiWithPathVersioning
+  end
+
+  it 'retrieves swagger-documentation on /swagger_doc that contains :resources api path' do
+    get '/v1/swagger_doc'
+
+    expect(json_body['apis']).to eq(
+      [
+        { 'path' => '/resources.{format}', 'description' => 'Operations about resources' },
+        { 'path' => '/swagger_doc.{format}', 'description' => 'Operations about swagger_docs' }
+      ]
+    )
+  end
+end

data/spec/api_with_standalone_namespace_spec.rb

@@ -0,0 +1,215 @@
+require 'spec_helper'
+
+describe 'Standalone namespace API' do
+  let(:json_body) { JSON.parse(last_response.body) }
+
+  describe 'with "path" versioning' do
+    before do
+      class StandaloneApiWithPathVersioning < Grape::API
+        format :json
+        version 'v1', using: :path
+
+        namespace :store do
+          get
+          # will be assigned to standalone the namespace below
+          namespace :orders do
+            get :order_id
+          end
+        end
+
+        namespace 'store/orders', swagger: { nested: false } do
+          post :order_idx
+          namespace 'actions' do
+            get 'dummy'
+          end
+          namespace 'actions2', swagger: { nested: false } do
+            get 'dummy2'
+            namespace 'actions22' do
+              get 'dummy22'
+            end
+          end
+        end
+
+        namespace 'store/:store_id/orders', swagger: { nested: false, name: 'specific-store-orders' } do
+          delete :order_id
+        end
+
+        add_swagger_documentation api_version: 'v1'
+      end
+    end
+
+    def app
+      StandaloneApiWithPathVersioning
+    end
+
+    describe 'retrieves swagger-documentation on /swagger_doc' do
+      before { get '/v1/swagger_doc' }
+
+      it 'that contains all api paths' do
+        expect(json_body['apis']).to eq(
+                                         [
+                                           { 'path' => '/store.{format}', 'description' => 'Operations about stores' },
+                                           { 'path' => '/store_orders.{format}', 'description' => 'Operations about store/orders' },
+                                           { 'path' => '/store_orders_actions2.{format}', 'description' => 'Operations about store/orders/actions2s' },
+                                           { 'path' => '/specific-store-orders.{format}', 'description' => 'Operations about store/:store_id/orders' },
+                                           { 'path' => '/swagger_doc.{format}', 'description' => 'Operations about swagger_docs' }
+                                         ]
+                                     )
+      end
+    end
+
+    describe 'retrieved namespace swagger-documentation on /swagger_doc/store' do
+      before { get '/v1/swagger_doc/store' }
+      it 'does not include standalone namespaces' do
+        apis = json_body['apis']
+        # shall include 1 route, GET on store
+        expect(apis.length).to eql(1)
+        expect(apis[0]['operations'][0]['method']).to eql('GET')
+      end
+    end
+
+    describe 'retrieved namespace swagger-documentation on /swagger_doc/store_orders' do
+      before { get '/v1/swagger_doc/store_orders' }
+      it 'does not assign namespaces within standalone namespaces to the general resource' do
+        apis = json_body['apis']
+        # shall include 3 routes, get on store, get with order_id and get dummy on actions
+        expect(apis.length).to eql(3)
+      end
+    end
+
+    describe 'retrieved namespace swagger-documentation on /swagger_doc/store_orders_actions2' do
+      before { get '/v1/swagger_doc/store_orders_actions2' }
+      it 'does appear as standalone namespace within another standalone namespace' do
+        apis = json_body['apis']
+        # shall include 2 routes, get on dummy2 and get on dummy22
+        expect(apis.length).to eql(2)
+        expect(apis[0]['operations'][0]['method']).to eql('GET')
+        expect(apis[1]['operations'][0]['method']).to eql('GET')
+      end
+    end
+
+    describe 'retrieved namespace swagger-documentation on /swagger_doc/specific-store-orders' do
+      before { get '/v1/swagger_doc/specific-store-orders' }
+      it 'does show the one route' do
+        apis = json_body['apis']
+        # shall include 1 routes, delete action
+        expect(apis.length).to eql(1)
+        expect(apis[0]['operations'][0]['method']).to eql('DELETE')
+      end
+    end
+
+    describe 'retrieved namespace swagger-documentation on /swagger_doc/store_orders' do
+      before { get '/v1/swagger_doc/store_orders_actions2' }
+      it 'does work with standalone in standalone namespaces' do
+        apis = json_body['apis']
+        # shall include 2 routes, dummy2 and dummy22
+        expect(apis.length).to eql(2)
+      end
+    end
+  end
+
+  describe 'with header versioning' do
+    before do
+      class StandaloneApiWithHeaderVersioning < Grape::API
+        format :json
+        version 'v1', using: :header, vendor: 'grape-swagger'
+
+        namespace :store do
+          get
+          # will be assigned to standalone the namespace below
+          namespace :orders do
+            get :order_id
+          end
+        end
+
+        namespace 'store/orders', swagger: { nested: false } do
+          post :order_idx
+          namespace 'actions' do
+            get 'dummy'
+          end
+          namespace 'actions2', swagger: { nested: false } do
+            get 'dummy2'
+            namespace 'actions22' do
+              get 'dummy22'
+            end
+          end
+        end
+
+        namespace 'store/:store_id/orders', swagger: { nested: false, name: 'specific-store-orders' } do
+          delete :order_id
+        end
+
+        add_swagger_documentation api_version: 'v1'
+      end
+    end
+
+    def app
+      StandaloneApiWithHeaderVersioning
+    end
+
+    describe 'retrieves swagger-documentation on /swagger_doc' do
+      before { get 'swagger_doc' }
+
+      it 'that contains all api paths' do
+        expect(json_body['apis']).to eq(
+                                         [
+                                           { 'path' => '/store.{format}', 'description' => 'Operations about stores' },
+                                           { 'path' => '/store_orders.{format}', 'description' => 'Operations about store/orders' },
+                                           { 'path' => '/store_orders_actions2.{format}', 'description' => 'Operations about store/orders/actions2s' },
+                                           { 'path' => '/specific-store-orders.{format}', 'description' => 'Operations about store/:store_id/orders' },
+                                           { 'path' => '/swagger_doc.{format}', 'description' => 'Operations about swagger_docs' }
+                                         ]
+                                     )
+      end
+    end
+
+    describe 'retrieved namespace swagger-documentation on /swagger_doc/store' do
+      before { get '/swagger_doc/store' }
+      it 'does not include standalone namespaces' do
+        apis = json_body['apis']
+        # shall include 1 route, GET on store
+        expect(apis.length).to eql(1)
+        expect(apis[0]['operations'][0]['method']).to eql('GET')
+      end
+    end
+
+    describe 'retrieved namespace swagger-documentation on /swagger_doc/store_orders' do
+      before { get '/swagger_doc/store_orders' }
+      it 'does not assign namespaces within standalone namespaces to the general resource' do
+        apis = json_body['apis']
+        # shall include 3 routes, get on store, get with order_id and get dummy on actions
+        expect(apis.length).to eql(3)
+      end
+    end
+
+    describe 'retrieved namespace swagger-documentation on /swagger_doc/store_orders_actions2' do
+      before { get '/swagger_doc/store_orders_actions2' }
+      it 'does appear as standalone namespace within another standalone namespace' do
+        apis = json_body['apis']
+        # shall include 2 routes, get on dummy2 and get on dummy22
+        expect(apis.length).to eql(2)
+        expect(apis[0]['operations'][0]['method']).to eql('GET')
+        expect(apis[1]['operations'][0]['method']).to eql('GET')
+      end
+    end
+
+    describe 'retrieved namespace swagger-documentation on /swagger_doc/specific-store-orders' do
+      before { get '/swagger_doc/specific-store-orders' }
+      it 'does show the one route' do
+        apis = json_body['apis']
+        # shall include 1 routes, delete action
+        expect(apis.length).to eql(1)
+        expect(apis[0]['operations'][0]['method']).to eql('DELETE')
+      end
+    end
+
+    describe 'retrieved namespace swagger-documentation on /swagger_doc/store_orders' do
+      before { get '/swagger_doc/store_orders_actions2' }
+      it 'does work with standalone in standalone namespaces' do
+        apis = json_body['apis']
+        # shall include 2 routes, dummy2 and dummy22
+        expect(apis.length).to eql(2)
+      end
+    end
+  end
+end

data/spec/array_params_spec.rb

@@ -0,0 +1,34 @@
+require 'spec_helper'
+
+describe 'Array Params' do
+  def app
+    Class.new(Grape::API) do
+      format :json
+
+      params do
+        requires :a_array, type: Array do
+          requires :param_1, type: Integer
+          requires :param_2, type: String
+        end
+      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 'gets array types' do
+    expect(subject).to eq [
+      { 'paramType' => 'form', 'name' => 'a_array[][param_1]', 'description' => nil, 'type' => 'integer', 'required' => true, 'allowMultiple' => false, 'format' => 'int32' },
+      { 'paramType' => 'form', 'name' => 'a_array[][param_2]', 'description' => nil, 'type' => 'string', 'required' => true, 'allowMultiple' => false }
+    ]
+  end
+end

data/spec/float_api_spec.rb

@@ -0,0 +1,30 @@
+require 'spec_helper'
+
+describe 'Float Params' do
+  def app
+    Class.new(Grape::API) do
+      format :json
+
+      params do
+        requires :a_float, type: Float
+      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 float types' do
+    expect(subject).to eq [
+      { 'paramType' => 'form', 'name' => 'a_float', 'description' => nil, 'type' => 'float', 'required' => true, 'allowMultiple' => false }
+    ]
+  end
+end