gitlab-grape-swagger 1.5.0

data/spec/swagger_v2/namespace_tags_prefix_spec.rb

@@ -0,0 +1,122 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe 'namespace tags check while using prefix and version' do
+  include_context 'namespace example'
+
+  before :all do
+    module TheApi
+      class NamespaceApi < Grape::API
+        version %i[v1 v2]
+      end
+
+      class CascadingVersionApi < Grape::API
+        version :v2
+
+        namespace :hudson do
+          desc 'Document root'
+          get '/' do
+            { message: 'hi' }
+          end
+        end
+
+        namespace :colorado do
+          desc 'This gets something.',
+               notes: '_test_'
+
+          get '/simple' do
+            { bla: 'something' }
+          end
+        end
+      end
+
+      class NestedPrefixApi < Grape::API
+        version :v1
+        prefix 'nested_prefix/api'
+
+        namespace :deep_namespace do
+          desc 'This gets something within a deeply nested resource'
+          get '/deep' do
+            { bla: 'something' }
+          end
+        end
+      end
+    end
+
+    class TagApi < Grape::API
+      prefix :api
+      mount TheApi::CascadingVersionApi
+      mount TheApi::NamespaceApi
+      mount TheApi::NestedPrefixApi
+      add_swagger_documentation
+    end
+  end
+
+  def app
+    TagApi
+  end
+
+  describe 'retrieves swagger-documentation on /swagger_doc' do
+    subject do
+      get '/api/swagger_doc.json'
+      JSON.parse(last_response.body)
+    end
+
+    specify do
+      expect(subject['tags']).to eql(
+        [
+          { 'name' => 'hudson', 'description' => 'Operations about hudsons' },
+          { 'name' => 'colorado', 'description' => 'Operations about colorados' },
+          { 'name' => 'thames', 'description' => 'Operations about thames' },
+          { 'name' => 'niles', 'description' => 'Operations about niles' },
+          { 'name' => 'deep_namespace', 'description' => 'Operations about deep_namespaces' }
+        ]
+      )
+
+      expect(subject['paths']['/api/v1/hudson']['get']['tags']).to eql(['hudson'])
+      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'])
+      expect(subject['paths']['/api/v1/thames/simple_with_headers']['get']['tags']).to eql(['thames'])
+      expect(subject['paths']['/api/v1/niles/items']['post']['tags']).to eql(['niles'])
+      expect(subject['paths']['/api/v1/niles/custom']['get']['tags']).to eql(['niles'])
+      expect(subject['paths']['/api/v2/hudson']['get']['tags']).to eql(['hudson'])
+      expect(subject['paths']['/api/v2/colorado/simple']['get']['tags']).to eql(['colorado'])
+    end
+  end
+
+  describe 'retrieves the documentation for mounted-api' do
+    subject do
+      get '/api/swagger_doc/colorado.json'
+      JSON.parse(last_response.body)
+    end
+
+    specify do
+      expect(subject['tags']).to eql(
+        [
+          { 'name' => 'colorado', 'description' => 'Operations about colorados' }
+        ]
+      )
+
+      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'])
+    end
+
+    describe 'includes headers' do
+      subject do
+        get '/api/swagger_doc/thames.json'
+        JSON.parse(last_response.body)
+      end
+
+      specify do
+        expect(subject['tags']).to eql(
+          [
+            { 'name' => 'thames', 'description' => 'Operations about thames' }
+          ]
+        )
+
+        expect(subject['paths']['/api/v1/thames/simple_with_headers']['get']['tags']).to eql(['thames'])
+      end
+    end
+  end
+end

data/spec/swagger_v2/namespace_tags_spec.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe 'namespace tags check' do
+  include_context 'namespace example'
+
+  before :all do
+    class TestApi < Grape::API
+      mount TheApi::NamespaceApi
+      add_swagger_documentation
+    end
+  end
+
+  def app
+    TestApi
+  end
+
+  describe 'retrieves swagger-documentation on /swagger_doc' do
+    subject do
+      get '/swagger_doc.json'
+      JSON.parse(last_response.body)
+    end
+
+    specify do
+      expect(subject['tags']).to eql(
+        [
+          { 'name' => 'hudson', 'description' => 'Operations about hudsons' },
+          { 'name' => 'colorado', 'description' => 'Operations about colorados' },
+          { 'name' => 'thames', 'description' => 'Operations about thames' },
+          { 'name' => 'niles', 'description' => 'Operations about niles' }
+        ]
+      )
+
+      expect(subject['paths']['/hudson']['get']['tags']).to eql(['hudson'])
+      expect(subject['paths']['/colorado/simple']['get']['tags']).to eql(['colorado'])
+      expect(subject['paths']['/colorado/simple-test']['get']['tags']).to eql(['colorado'])
+      expect(subject['paths']['/thames/simple_with_headers']['get']['tags']).to eql(['thames'])
+      expect(subject['paths']['/niles/items']['post']['tags']).to eql(['niles'])
+      expect(subject['paths']['/niles/custom']['get']['tags']).to eql(['niles'])
+    end
+  end
+
+  describe 'retrieves the documentation for mounted-api' do
+    subject do
+      get '/swagger_doc/colorado.json'
+      JSON.parse(last_response.body)
+    end
+
+    specify do
+      expect(subject['tags']).to eql(
+        [
+          { 'name' => 'colorado', 'description' => 'Operations about colorados' }
+        ]
+      )
+
+      expect(subject['paths']['/colorado/simple']['get']['tags']).to eql(['colorado'])
+      expect(subject['paths']['/colorado/simple-test']['get']['tags']).to eql(['colorado'])
+    end
+
+    describe 'includes headers' do
+      subject do
+        get '/swagger_doc/thames.json'
+        JSON.parse(last_response.body)
+      end
+
+      specify do
+        expect(subject['tags']).to eql(
+          [
+            { 'name' => 'thames', 'description' => 'Operations about thames' }
+          ]
+        )
+
+        expect(subject['paths']['/thames/simple_with_headers']['get']['tags']).to eql(['thames'])
+      end
+    end
+  end
+end

data/spec/swagger_v2/namespaced_api_spec.rb

@@ -0,0 +1,121 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe 'namespace' do
+  context 'at root level' do
+    def app
+      Class.new(Grape::API) do
+        namespace :aspace do
+          get '/', desc: 'Description for aspace'
+        end
+        add_swagger_documentation format: :json
+      end
+    end
+
+    subject do
+      get '/swagger_doc'
+      JSON.parse(last_response.body)['paths']['/aspace']['get']
+    end
+
+    it 'shows the namespace summary in the json spec' do
+      expect(subject['summary']).to eql('Description for aspace')
+    end
+  end
+
+  context 'with camel case namespace' do
+    def app
+      Class.new(Grape::API) do
+        namespace :camelCases do
+          get '/', desc: 'Look! An endpoint.'
+        end
+        add_swagger_documentation format: :json
+      end
+    end
+
+    subject do
+      get '/swagger_doc'
+      JSON.parse(last_response.body)['paths']['/camelCases']['get']
+    end
+
+    it 'shows the namespace summary in the json spec' do
+      expect(subject['summary']).to eql('Look! An endpoint.')
+    end
+  end
+
+  context 'mounted' do
+    def app
+      namespaced_api = Class.new(Grape::API) do
+        namespace :bspace do
+          get '/', desc: 'Description for aspace'
+        end
+      end
+
+      Class.new(Grape::API) do
+        mount namespaced_api
+        add_swagger_documentation format: :json
+      end
+    end
+
+    subject do
+      get '/swagger_doc'
+      JSON.parse(last_response.body)['paths']['/bspace']['get']
+    end
+
+    it 'shows the namespace summary in the json spec' do
+      expect(subject['summary']).to eql('Description for aspace')
+    end
+  end
+
+  context 'mounted under a route' do
+    def app
+      namespaced_api = Class.new(Grape::API) do
+        namespace :bspace do
+          get '/', desc: 'Description for aspace'
+        end
+      end
+
+      Class.new(Grape::API) do
+        mount namespaced_api => '/mounted'
+        add_swagger_documentation format: :json
+      end
+    end
+
+    subject do
+      get '/swagger_doc'
+      JSON.parse(last_response.body)['paths']['/mounted/bspace']['get']
+    end
+
+    it 'shows the namespace summary in the json spec' do
+      expect(subject['summary']).to eql('Description for aspace')
+    end
+  end
+
+  context 'arbitrary mounting' do
+    def app
+      inner_namespaced_api = Class.new(Grape::API) do
+        namespace :bspace do
+          get '/', desc: 'Description for aspace'
+        end
+      end
+
+      outer_namespaced_api = Class.new(Grape::API) do
+        mount inner_namespaced_api => '/mounted'
+      end
+
+      Class.new(Grape::API) do
+        mount outer_namespaced_api => '/'
+        add_swagger_documentation format: :json
+      end
+    end
+
+    subject do
+      get '/swagger_doc'
+      JSON.parse(last_response.body)['paths']['/mounted/bspace']['get']
+    end
+
+    it 'shows the namespace summary in the json spec' do
+      expect(subject['summary']).to eql('Description for aspace')
+    end
+  end
+end

data/spec/swagger_v2/nicknamed_api_spec.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe 'a nicknamed mounted api' do
+  def app
+    Class.new(Grape::API) do
+      desc 'Show this endpoint', nickname: 'simple'
+      get '/simple' do
+        { foo: 'bar' }
+      end
+
+      add_swagger_documentation format: :json
+    end
+  end
+
+  subject do
+    get '/swagger_doc.json'
+    JSON.parse(last_response.body)
+  end
+
+  it 'uses the nickname as the operationId' do
+    expect(subject['paths']['/simple']['get']['operationId']).to eql('simple')
+  end
+end

data/spec/swagger_v2/operation_id_api_spec.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe 'an operation id api' do
+  def app
+    Class.new(Grape::API) do
+      version '0.1'
+
+      desc 'Show this endpoint'
+      get '/simple_opp' do
+        { foo: 'bar' }
+      end
+
+      add_swagger_documentation format: :json
+    end
+  end
+
+  subject do
+    get '/0.1/swagger_doc.json'
+    JSON.parse(last_response.body)
+  end
+
+  it 'uses build name as operationId' do
+    expect(subject['paths']['/0.1/simple_opp']['get']['operationId']).to eql('get01SimpleOpp')
+  end
+end

data/spec/swagger_v2/param_multi_type_spec.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe 'Params Multi Types' do
+  def app
+    Class.new(Grape::API) do
+      format :json
+
+      desc 'action' do
+        consumes ['application/x-www-form-urlencoded']
+      end
+      params do
+        if Grape::VERSION < '0.14'
+          requires :input, type: [String, Integer]
+        else
+          requires :input, types: [String, Integer]
+        end
+        requires :another_input, type: [String, Integer]
+      end
+      post :action do
+        { message: 'hi' }
+      end
+
+      add_swagger_documentation
+    end
+  end
+
+  subject do
+    get '/swagger_doc/action'
+    expect(last_response.status).to eq 200
+    body = JSON.parse last_response.body
+    body['paths']['/action']['post']['parameters']
+  end
+
+  it 'reads param type correctly' do
+    expect(subject).to eq [
+      {
+        'in' => 'formData',
+        'name' => 'input',
+        'type' => 'string',
+        'required' => true
+      },
+      {
+        'in' => 'formData',
+        'name' => 'another_input',
+        'type' => 'string',
+        'required' => true
+      }
+    ]
+  end
+
+  describe 'header params' do
+    def app
+      Class.new(Grape::API) do
+        format :json
+
+        desc 'Some API', 
+          consumes: ['application/x-www-form-urlencoded'],
+          headers: { 'My-Header' => { required: true, description: 'Set this!' } }
+        params do
+          if Grape::VERSION < '0.14'
+            requires :input, type: [String, Integer]
+          else
+            requires :input, types: [String, Integer]
+          end
+          requires :another_input, type: [String, Integer]
+        end
+        post :action do
+          { message: 'hi' }
+        end
+
+        add_swagger_documentation
+      end
+    end
+
+    it 'has consistent types' do
+      types = subject.map { |param| param['type'] }
+      expect(types).to eq(%w[string string string])
+    end
+  end
+end

data/spec/swagger_v2/param_type_spec.rb

@@ -0,0 +1,95 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe 'Params Types' do
+  def app
+    Class.new(Grape::API) do
+      format :json
+
+      desc 'action' do
+        consumes ['application/x-www-form-urlencoded']
+      end
+      params do
+        requires :input, type: String
+      end
+      post :action do
+        { message: 'hi' }
+      end
+
+      desc 'action_with_doc' do
+        consumes ['application/x-www-form-urlencoded']
+      end
+      params do
+        requires :input, type: String, default: '14', documentation: { type: 'email', default: '42' }
+      end
+      post :action_with_doc do
+        { message: 'hi' }
+      end
+
+      add_swagger_documentation
+    end
+  end
+  context 'with no documentation hash' do
+    subject do
+      get '/swagger_doc/action'
+      expect(last_response.status).to eq 200
+      body = JSON.parse last_response.body
+      body['paths']['/action']['post']['parameters']
+    end
+
+    it 'reads param type correctly' do
+      expect(subject).to eq [{
+        'in' => 'formData',
+        'name' => 'input',
+        'type' => 'string',
+        'required' => true
+      }]
+    end
+
+    describe 'header params' do
+      def app
+        Class.new(Grape::API) do
+          format :json
+
+          desc 'Some API',
+            consumes: ['application/x-www-form-urlencoded'],
+            headers: { 'My-Header' => { required: true, description: 'Set this!' } }
+          params do
+            requires :input, type: String
+          end
+          post :action do
+            { message: 'hi' }
+          end
+
+          add_swagger_documentation
+        end
+      end
+
+      it 'has consistent types' do
+        types = subject.map { |param| param['type'] }
+        expect(types).to eq(%w[string string])
+      end
+    end
+  end
+
+  context 'with documentation hash' do
+    subject do
+      get '/swagger_doc/action_with_doc'
+      expect(last_response.status).to eq 200
+      body = JSON.parse last_response.body
+      body['paths']['/action_with_doc']['post']['parameters']
+    end
+
+    it 'reads param type correctly' do
+      expect(subject).to eq [{
+        'in' => 'formData',
+        'name' => 'input',
+        'type' => 'string',
+        'format' => 'email',
+        'default' => '42',
+        'required' => true
+      }]
+    end
+  end
+end