grape-swagger 0.11.0 → 0.20.0

data/spec/mutually_exclusive_spec.rb

@@ -1,36 +0,0 @@
-require 'spec_helper'
-
-describe 'Mutually exclusive group params' do
-  def app
-    Class.new(Grape::API) do
-      format :json
-
-      params do
-        requires :required_group, type: Hash do
-          group :param_group_1, type: Hash do
-            requires :param_1, type: String
-          end
-          optional :param_group_2, type: Array do
-            requires :param_2, type: String
-          end
-          mutually_exclusive :param_group_1, :param_group_2
-        end
-      end
-      post '/groups' do
-        {}
-      end
-
-      add_swagger_documentation
-    end
-  end
-
-  it 'marks the nested required params in a group as optional if the group is in a mutually_exclusive set' 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[param_group_1][param_1]', 'description' => '', 'type' => 'string', 'required' => false, 'allowMultiple' => false },
-      { 'paramType' => 'form', 'name' => 'required_group[param_group_2][][param_2]', 'description' => '', 'type' => 'string', 'required' => true, 'allowMultiple' => false }]
-  end
-end

data/spec/non_default_api_spec.rb

@@ -1,733 +0,0 @@
-require 'spec_helper'
-
-describe 'options: ' do
-  context 'overriding the basepath' do
-    before :all do
-      class BasePathMountedApi < Grape::API
-        desc 'This gets something.'
-        get '/something' do
-          { bla: 'something' }
-        end
-      end
-
-      class SimpleApiWithBasePath < Grape::API
-        NON_DEFAULT_BASE_PATH = 'http://www.breakcoregivesmewood.com'.freeze
-
-        mount BasePathMountedApi
-        add_swagger_documentation base_path: NON_DEFAULT_BASE_PATH
-      end
-    end
-
-    def app
-      SimpleApiWithBasePath
-    end
-
-    subject do
-      get '/swagger_doc/something.json'
-      JSON.parse(last_response.body)
-    end
-
-    # it "retrieves the given base-path on /swagger_doc" do
-    #   get '/swagger_doc.json'
-    #   JSON.parse(last_response.body)["basePath"].should == SimpleApiWithBasePath::NON_DEFAULT_BASE_PATH
-    # end
-
-    it 'retrieves the same given base-path for mounted-api' do
-      expect(subject['basePath']).to eq SimpleApiWithBasePath::NON_DEFAULT_BASE_PATH
-    end
-  end
-
-  context 'overriding the basepath with a proc' do
-    before :all do
-      class ProcBasePathMountedApi < Grape::API
-        desc 'This gets something.'
-        get '/something' do
-          { bla: 'something' }
-        end
-      end
-
-      class SimpleApiWithProcBasePath < Grape::API
-        mount ProcBasePathMountedApi
-        add_swagger_documentation base_path: proc { |request| [request.base_url, request.params[:base_path], 'some_value'].compact.join('/') }
-      end
-    end
-
-    def app
-      SimpleApiWithProcBasePath
-    end
-
-    context 'default' do
-      subject do
-        get '/swagger_doc/something.json'
-        JSON.parse(last_response.body)
-      end
-
-      it 'retrieves the same given base-path for mounted-api' do
-        expect(subject['basePath']).to eq 'http://example.org/some_value'
-      end
-    end
-
-    context 'param' do
-      subject do
-        get '/swagger_doc/something.json?base_path=foobar'
-        JSON.parse(last_response.body)
-      end
-
-      it 're-evaluates base-path' do
-        expect(subject['basePath']).to eq 'http://example.org/foobar/some_value'
-      end
-    end
-  end
-
-  context 'relative base_path' do
-    before :all do
-      class RelativeBasePathMountedApi < Grape::API
-        desc 'This gets something.'
-        get '/something' do
-          { bla: 'something' }
-        end
-      end
-
-      class SimpleApiWithRelativeBasePath < Grape::API
-        mount RelativeBasePathMountedApi
-        add_swagger_documentation base_path: '/some_value'
-      end
-    end
-
-    def app
-      SimpleApiWithRelativeBasePath
-    end
-
-    subject do
-      get '/swagger_doc/something.json'
-      JSON.parse(last_response.body)
-    end
-
-    it 'retrieves the same given base-path for mounted-api' do
-      get '/swagger_doc/something.json'
-      expect(subject['basePath']).to eq 'http://example.org/some_value'
-    end
-  end
-
-  context 'overriding the version' do
-    before :all do
-      class ApiVersionMountedApi < Grape::API
-        desc 'This gets something.'
-        get '/something' do
-          { bla: 'something' }
-        end
-      end
-
-      class SimpleApiWithApiVersion < Grape::API
-        API_VERSION = '101'.freeze
-
-        mount ApiVersionMountedApi
-        add_swagger_documentation api_version: API_VERSION
-      end
-    end
-
-    def app
-      SimpleApiWithApiVersion
-    end
-
-    it 'retrieves the api version on /swagger_doc' do
-      get '/swagger_doc.json'
-      expect(JSON.parse(last_response.body)['apiVersion']).to eq SimpleApiWithApiVersion::API_VERSION
-    end
-
-    it 'retrieves the same api version for mounted-api' do
-      get '/swagger_doc/something.json'
-      expect(JSON.parse(last_response.body)['apiVersion']).to eq SimpleApiWithApiVersion::API_VERSION
-    end
-  end
-
-  context 'mounting in a versioned api' do
-    before :all do
-      class SimpleApiToMountInVersionedApi < Grape::API
-        desc 'This gets something.'
-        get '/something' do
-          { bla: 'something' }
-        end
-      end
-
-      class SimpleApiWithVersionInPath < Grape::API
-        version 'v1', using: :path
-
-        mount SimpleApiToMountInVersionedApi
-        add_swagger_documentation
-      end
-    end
-
-    def app
-      SimpleApiWithVersionInPath
-    end
-
-    it 'gets the documentation on a versioned path /v1/swagger_doc' do
-      get '/v1/swagger_doc.json'
-      expect(last_response.status).to eq 200
-      expect(JSON.parse(last_response.body)).to eq(
-        'apiVersion' => '0.1',
-        'swaggerVersion' => '1.2',
-        'info' => {},
-        'produces' => Grape::ContentTypes::CONTENT_TYPES.values.uniq,
-        'apis' => [
-          { 'path' => '/something.{format}', 'description' => 'Operations about somethings' },
-          { 'path' => '/swagger_doc.{format}', 'description' => 'Operations about swagger_docs' }
-        ]
-      )
-    end
-
-    it 'gets the resource specific documentation on a versioned path /v1/swagger_doc/something' do
-      get '/v1/swagger_doc/something.json'
-      expect(last_response.status).to eq 200
-      expect(JSON.parse(last_response.body)).to eq(
-        'apiVersion' => '0.1',
-        'swaggerVersion' => '1.2',
-        'basePath' => 'http://example.org',
-        'resourcePath' => '/something',
-        'produces' => Grape::ContentTypes::CONTENT_TYPES.values.uniq,
-        'apis' => [{
-          'path' => '/0.1/something.{format}',
-          'operations' => [{
-            'notes' => '',
-            'summary' => 'This gets something.',
-            'nickname' => 'GET--version-something---format-',
-            'method' => 'GET',
-            'parameters' => [],
-            'type' => 'void'
-          }]
-        }]
-      )
-    end
-  end
-
-  context 'overriding hiding the documentation paths' do
-    before :all do
-      class HideDocumentationPathMountedApi < Grape::API
-        desc 'This gets something.'
-        get '/something' do
-          { bla: 'something' }
-        end
-      end
-
-      class SimpleApiWithHiddenDocumentation < Grape::API
-        mount HideDocumentationPathMountedApi
-        add_swagger_documentation hide_documentation_path: true
-      end
-    end
-
-    def app
-      SimpleApiWithHiddenDocumentation
-    end
-
-    subject do
-      get '/swagger_doc.json'
-      JSON.parse(last_response.body)
-    end
-
-    it "it doesn't show the documentation path on /swagger_doc" do
-      expect(subject).to eq(
-        'apiVersion' => '0.1',
-        'swaggerVersion' => '1.2',
-        'info' => {},
-        'produces' => Grape::ContentTypes::CONTENT_TYPES.values.uniq,
-        'apis' => [
-          { 'path' => '/something.{format}', 'description' => 'Operations about somethings' }
-        ]
-      )
-    end
-  end
-
-  context 'overriding hiding the documentation paths in prefixed API' do
-    before :all do
-      class HideDocumentationPathPrefixedMountedApi < Grape::API
-        desc 'This gets something.'
-        get '/something' do
-          { bla: 'something' }
-        end
-      end
-
-      class PrefixedApiWithHiddenDocumentation < Grape::API
-        prefix 'abc'
-        mount HideDocumentationPathPrefixedMountedApi
-        add_swagger_documentation hide_documentation_path: true
-      end
-    end
-
-    def app
-      PrefixedApiWithHiddenDocumentation
-    end
-
-    subject do
-      get '/abc/swagger_doc/something.json'
-      JSON.parse(last_response.body)
-    end
-
-    it "it doesn't show the documentation path on /abc/swagger_doc/something.json" do
-      expect(subject).to eq(
-        'apiVersion' => '0.1',
-        'swaggerVersion' => '1.2',
-        'basePath' => 'http://example.org',
-        'resourcePath' => '/something',
-        'produces' => Grape::ContentTypes::CONTENT_TYPES.values.uniq,
-        'apis' => [{
-          'path' => '/abc/something.{format}',
-          'operations' => [{
-            'notes' => '',
-            'summary' => 'This gets something.',
-            'nickname' => 'GET-abc-something---format-',
-            'method' => 'GET',
-            'parameters' => [],
-            'type' => 'void'
-          }]
-        }]
-      )
-    end
-  end
-
-  context 'overriding hiding the documentation paths in prefixed and versioned API' do
-    before :all do
-      class HideDocumentationPathMountedApi2 < Grape::API
-        desc 'This gets something.'
-        get '/something' do
-          { bla: 'something' }
-        end
-      end
-
-      class PrefixedAndVersionedApiWithHiddenDocumentation < Grape::API
-        prefix 'abc'
-        version 'v20', using: :path
-
-        mount HideDocumentationPathMountedApi2
-
-        add_swagger_documentation hide_documentation_path: true, api_version: version
-      end
-    end
-
-    def app
-      PrefixedAndVersionedApiWithHiddenDocumentation
-    end
-
-    subject do
-      get '/abc/v20/swagger_doc/something.json'
-      JSON.parse(last_response.body)
-    end
-
-    it "it doesn't show the documentation path on /abc/v1/swagger_doc/something.json" do
-      expect(subject).to eq(
-        'apiVersion' => 'v20',
-        'swaggerVersion' => '1.2',
-        'basePath' => 'http://example.org',
-        'resourcePath' => '/something',
-        'produces' => Grape::ContentTypes::CONTENT_TYPES.values.uniq,
-        'apis' => [{
-          'path' => '/abc/v20/something.{format}',
-          'operations' => [{
-            'notes' => '',
-            'summary' => 'This gets something.',
-            'nickname' => 'GET-abc--version-something---format-',
-            'method' => 'GET',
-            'parameters' => [],
-            'type' => 'void'
-          }]
-        }]
-      )
-    end
-  end
-
-  context 'overriding the mount-path' do
-    before :all do
-      class DifferentMountMountedApi < Grape::API
-        desc 'This gets something.'
-        get '/something' do
-          { bla: 'something' }
-        end
-      end
-
-      class SimpleApiWithDifferentMount < Grape::API
-        MOUNT_PATH = '/api_doc'.freeze
-
-        mount DifferentMountMountedApi
-        add_swagger_documentation mount_path: MOUNT_PATH
-      end
-    end
-
-    def app
-      SimpleApiWithDifferentMount
-    end
-
-    # it "retrieves the given base-path on /api_doc" do
-    #   get '/api_doc.json'
-    #     JSON.parse(last_response.body)["apis"].each do |api|
-    #     api["path"].should start_with SimpleApiWithDifferentMount::MOUNT_PATH
-    #   end
-    # end
-
-    it 'retrieves the same given base-path for mounted-api' do
-      get '/api_doc/something.json'
-      JSON.parse(last_response.body)['apis'].each do |api|
-        expect(api['path']).to_not start_with SimpleApiWithDifferentMount::MOUNT_PATH
-      end
-    end
-
-    it 'does not respond to swagger_doc' do
-      get '/swagger_doc.json'
-      expect(last_response.status).to eq 404
-    end
-  end
-
-  context 'overriding the markdown' do
-    before :all do
-      class MarkDownMountedApi < Grape::API
-        desc 'This gets something.', notes: '_test_'
-        get '/something' do
-          { bla: 'something' }
-        end
-      end
-
-      class SimpleApiWithMarkdown < Grape::API
-        mount MarkDownMountedApi
-        add_swagger_documentation markdown: GrapeSwagger::Markdown::KramdownAdapter.new, info: { description: '_test_' }
-      end
-    end
-
-    subject do
-      Class.new(Grape::API) do
-        mount MarkDownMountedApi
-      end
-    end
-
-    def app
-      SimpleApiWithMarkdown
-    end
-
-    context 'with instance' do
-      before do
-        subject.add_swagger_documentation markdown: GrapeSwagger::Markdown::KramdownAdapter.new, info: { description: '_test_' }
-      end
-
-      it 'parses markdown for a mounted-api' do
-        get '/swagger_doc/something.json'
-        expect(JSON.parse(last_response.body)['apis'][0]['operations'][0]['notes']).to eq("<p><em>test</em></p>\n")
-      end
-
-      it 'parses markdown for swagger info' do
-        get '/swagger_doc.json'
-        expect(JSON.parse(last_response.body)['info']).to eq('description' => "<p><em>test</em></p>\n")
-      end
-    end
-
-    context 'with class' do
-      before do
-        subject.add_swagger_documentation markdown: GrapeSwagger::Markdown::KramdownAdapter, info: { description: '_test_' }
-      end
-
-      it 'parses markdown for a mounted-api' do
-        get '/swagger_doc/something.json'
-        expect(JSON.parse(last_response.body)['apis'][0]['operations'][0]['notes']).to eq("<p><em>test</em></p>\n")
-      end
-
-      it 'parses markdown for swagger info' do
-        get '/swagger_doc.json'
-        expect(JSON.parse(last_response.body)['info']).to eq('description' => "<p><em>test</em></p>\n")
-      end
-    end
-  end
-
-  context 'prefixed and versioned API' do
-    before :all do
-      class VersionedMountedApi < Grape::API
-        prefix 'api'
-        version 'v1'
-
-        desc 'This gets something.'
-        get '/something' do
-          { bla: 'something' }
-        end
-      end
-
-      class SimpleApiWithVersion < Grape::API
-        mount VersionedMountedApi
-        add_swagger_documentation api_version: 'v1'
-      end
-    end
-
-    def app
-      SimpleApiWithVersion
-    end
-
-    it 'parses version and places it in the path' do
-      get '/swagger_doc/something.json'
-
-      JSON.parse(last_response.body)['apis'].each do |api|
-        expect(api['path']).to start_with '/api/v1/'
-      end
-    end
-  end
-
-  context 'protected API' do
-    before :all do
-      class ProtectedApi < Grape::API
-        desc 'This gets something.'
-        get '/something' do
-          { bla: 'something' }
-        end
-      end
-
-      class SimpleApiWithProtection < Grape::API
-        mount ::ProtectedApi
-        add_swagger_documentation
-      end
-    end
-
-    def app
-      SimpleApiWithProtection
-    end
-
-    # it "uses https schema in mount point" do
-    #   get '/swagger_doc.json', {}, 'rack.url_scheme' => 'https'
-    #   JSON.parse(last_response.body)["basePath"].should == "https://example.org:80"
-    # end
-
-    it 'uses https schema in endpoint doc' do
-      get '/swagger_doc/something.json', {}, 'rack.url_scheme' => 'https'
-      expect(JSON.parse(last_response.body)['basePath']).to eq 'https://example.org:80'
-    end
-  end
-
-  context ':hide_format' do
-    context 'with no explicit api format specified' do
-      before :all do
-        class HidePathsApi < Grape::API
-          desc 'This gets something.'
-          get '/something' do
-            { bla: 'something' }
-          end
-        end
-
-        class SimpleApiWithHiddenPaths < Grape::API
-          mount HidePathsApi
-          add_swagger_documentation hide_format: true
-        end
-      end
-
-      def app
-        SimpleApiWithHiddenPaths
-      end
-
-      it 'does not end with format' do
-        get '/swagger_doc/something.json'
-        JSON.parse(last_response.body)['apis'].each do |api|
-          expect(api['path']).to_not end_with '.{format}'
-        end
-      end
-    end
-
-    context 'with single api format specified' do
-      before :all do
-        class SingleFormatApi < Grape::API
-          format :json
-          desc 'This gets something.'
-          get '/something' do
-            { bla: 'something' }
-          end
-        end
-
-        class SimpleApiWithSingleFormat < Grape::API
-          mount SingleFormatApi
-          add_swagger_documentation hide_format: true
-        end
-      end
-
-      def app
-        SimpleApiWithSingleFormat
-      end
-
-      it 'does not end with format' do
-        get '/swagger_doc/something.json'
-        JSON.parse(last_response.body)['apis'].each do |api|
-          expect(api['path']).to_not end_with '.{format}'
-          expect(api['path']).to_not end_with '(.json)'
-        end
-      end
-    end
-  end
-
-  context 'multiple documentations' do
-    before :all do
-      class FirstApi < Grape::API
-        desc 'This is the first API'
-        get '/first' do
-          { first: 'hip' }
-        end
-
-        add_swagger_documentation mount_path: '/first/swagger_doc'
-      end
-
-      class SecondApi < Grape::API
-        desc 'This is the second API'
-        get '/second' do
-          { second: 'hop' }
-        end
-
-        add_swagger_documentation mount_path: '/second/swagger_doc'
-      end
-
-      class SimpleApiWithMultipleMountedDocumentations < Grape::API
-        mount FirstApi
-        mount SecondApi
-      end
-    end
-
-    def app
-      SimpleApiWithMultipleMountedDocumentations
-    end
-
-    it 'retrieves the first swagger-documentation on /first/swagger_doc' do
-      get '/first/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' => '/first.{format}', 'description' => 'Operations about firsts' }
-        ]
-      )
-    end
-
-    it 'retrieves the second swagger-documentation on /second/swagger_doc' do
-      get '/second/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' => '/second.{format}', 'description' => 'Operations about seconds' }
-        ]
-      )
-    end
-  end
-
-  context ':formatting' do
-    before :all do
-      class JSONDefaultFormatAPI < Grape::API
-        desc 'This gets something.'
-        get '/something' do
-          { bla: 'something' }
-        end
-      end
-
-      class SimpleJSONFormattedAPI < Grape::API
-        mount JSONDefaultFormatAPI
-        add_swagger_documentation format: :json
-      end
-    end
-
-    def app
-      SimpleJSONFormattedAPI
-    end
-
-    subject do
-      get '/swagger_doc/something'
-      last_response
-    end
-
-    it 'defaults to JSON format when none is specified' do
-      get '/swagger_doc/something'
-      expect(subject.headers['Content-Type']).to eq 'application/json'
-      expect(-> { JSON.parse(subject.body) }).to_not raise_error
-    end
-  end
-
-  context 'documented namespace description' do
-    before :all do
-      class NestedNamespaceWithDescAPI < Grape::API
-        namespace :nestedspace, desc: 'Description for nested space' do
-          desc 'Nested get'
-          get '/somethingelse' do
-            { foo: 'bar' }
-          end
-        end
-      end
-
-      class NamespaceWithDescAPI < Grape::API
-        namespace :aspace, desc: 'Description for aspace' do
-          desc 'This gets something.'
-          get '/something' do
-            { bla: 'something' }
-          end
-        end
-
-        mount NestedNamespaceWithDescAPI
-
-        add_swagger_documentation format: :json
-      end
-      get '/swagger_doc'
-    end
-
-    def app
-      NamespaceWithDescAPI
-    end
-
-    subject do
-      JSON.parse(last_response.body)['apis']
-    end
-
-    it 'shows the namespace description in the json spec' do
-      expect(subject[0]['description']).to eql('Description for aspace')
-    end
-
-    it 'shows the nested namespace description in the json spec' do
-      expect(subject[1]['description']).to eql('Description for nested space')
-    end
-  end
-
-  context 'override nickname' do
-    before :all do
-      class NicknameAPI < Grape::API
-        desc 'This gets something.', nickname: 'getSomething'
-        get '/something' do
-          { bla: 'something' }
-        end
-        add_swagger_documentation
-      end
-    end
-
-    def app
-      NicknameAPI
-    end
-
-    it 'documents the user-specified nickname' do
-      get '/swagger_doc/something.json'
-      ret = JSON.parse(last_response.body)
-      expect(ret['apis'][0]['operations'][0]['nickname']).to eq 'getSomething'
-    end
-  end
-
-  context 'invalid name' do
-    subject do
-      Class.new(Grape::API) do
-        get 'hidden', hidden: true
-        add_swagger_documentation
-      end
-    end
-
-    def app
-      subject
-    end
-
-    it 'returns a 404 for an non-existent route' do
-      get '/swagger_doc/invalid.json'
-      expect(last_response.status).to eq 404
-      expect(JSON.parse(last_response.body)).to eq('error' => 'Not Found')
-    end
-
-    it 'returns a 404 for a hidden route' do
-      get '/swagger_doc/hidden.json'
-      expect(last_response.status).to eq 404
-      expect(JSON.parse(last_response.body)).to eq('error' => 'Not Found')
-    end
-  end
-end