grape-swagger 0.11.0 → 0.20.0

data/spec/api_paths_spec.rb

@@ -1,128 +0,0 @@
-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
-
-describe 'simple api with partially same path as docs mount and hidden doc path' do
-  before :all do
-    class SamePathApi < Grape::API
-      desc 'This gets the documents'
-      get '/documents' do
-        { test: 'something' }
-      end
-
-      desc 'This gets the doc types'
-      get '/doc-types' do
-        { test: 'something' }
-      end
-    end
-
-    class SimpleSamePathApi < Grape::API
-      mount SamePathApi
-      add_swagger_documentation(
-        mount_path: '/doc',
-        hide_documentation_path: true
-      )
-    end
-  end
-
-  def app
-    SimpleSamePathApi
-  end
-
-  it 'retrieves swagger-documentation on /doc that contains documents' do
-    get '/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' => '/documents.{format}', 'description' => 'Operations about documents' },
-        { 'path' => '/doc-types.{format}', 'description' => 'Operations about doc-types' }
-      ]
-    )
-  end
-
-  it 'retrieves the documentation for apis' do
-    get '/doc/documents.json'
-    expect(JSON.parse(last_response.body)).to eq(
-      'apiVersion' => '0.1',
-      'swaggerVersion' => '1.2',
-      'basePath' => 'http://example.org',
-      'resourcePath' => '/documents',
-      'produces' => Grape::ContentTypes::CONTENT_TYPES.values.uniq,
-      'apis' => [{
-        'path' => '/documents.{format}',
-        'operations' => [{
-          'notes' => '',
-          'summary' => 'This gets the documents',
-          'nickname' => 'GET-documents---format-',
-          'method' => 'GET',
-          'parameters' => [],
-          'type' => 'void'
-        }]
-      }]
-    )
-  end
-end

data/spec/api_root_spec.rb

@@ -1,30 +0,0 @@
-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/api_with_nil_types.rb

@@ -1,50 +0,0 @@
-require 'spec_helper'
-
-describe 'API with minimally documented models' do
-  def app
-    entity_klass = Class.new do
-      def self.exposures
-        {}
-      end
-
-      def self.documentation
-        {
-          bar: { type: String },
-          foo: {}
-        }
-      end
-
-      def self.entity_name
-        'Foo'
-      end
-    end
-
-    Class.new(Grape::API) do
-      format :json
-
-      get :foo do
-      end
-
-      add_swagger_documentation \
-        format: :json,
-        models: [Class.new(entity_klass)]
-    end
-  end
-
-  subject do
-    get '/swagger_doc/foo'
-    JSON.parse(last_response.body)['models']
-  end
-
-  it 'returns model' do
-    expect(subject).to eq(
-      'Foo' => {
-        'id' => 'Foo',
-        'properties' => {
-          'bar' => { 'type' => 'string' },
-          'foo' => { '$ref' => nil }
-        }
-      }
-    )
-  end
-end

data/spec/api_with_path_versioning_spec.rb

@@ -1,33 +0,0 @@
-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_prefix_and_namespace_spec.rb

@@ -1,32 +0,0 @@
-require 'spec_helper'
-
-describe 'API with Prefix and Namespace' do
-  def app
-    Class.new(Grape::API) do
-      format :json
-      prefix 'api'
-
-      namespace :status do
-        desc 'Retrieve status.'
-        get do
-        end
-      end
-
-      add_swagger_documentation
-    end
-  end
-
-  subject do
-    get '/api/swagger_doc'
-    expect(last_response.status).to eq 200
-    body = JSON.parse last_response.body
-    body['apis']
-  end
-
-  it 'gets array types' do
-    expect(subject).to eq([
-      { 'path' => '/status.{format}', 'description' => 'Operations about statuses' },
-      { 'path' => '/swagger_doc.{format}', 'description' => 'Operations about swagger_docs' }
-    ])
-  end
-end

data/spec/api_with_standalone_namespace_spec.rb

@@ -1,215 +0,0 @@
-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