grape-swagger 0.11.0 → 0.20.0

data/spec/array_entity_spec.rb

@@ -1,34 +0,0 @@
-require 'spec_helper'
-
-describe 'Array Entity' do
-  before :all do
-    class Something < Grape::Entity
-      expose :text, documentation: { type: 'string', desc: 'Content of something.' }
-    end
-  end
-
-  def app
-    Class.new(Grape::API) do
-      format :json
-
-      desc 'This returns something or an error',
-           is_array: true,
-           entity: Something
-      post :action do
-      end
-
-      add_swagger_documentation
-    end
-  end
-
-  subject do
-    get '/swagger_doc/action'
-    JSON.parse(last_response.body)
-  end
-
-  it 'reads param type correctly' do
-    expect(subject['models'].keys).to include 'Something'
-    expect(subject['apis'][0]['operations'][0]['type']).to eq('array')
-    expect(subject['apis'][0]['operations'][0]['items']).to eq('$ref' => 'Something')
-  end
-end

data/spec/array_params_spec.rb

@@ -1,85 +0,0 @@
-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
-
-      params do
-        optional :raw_array, type: Array
-      end
-      get :raw_array_splines do
-      end
-
-      params do
-        optional :raw_array, type: Array[Integer], documentation: { is_array: true }
-      end
-      get :raw_array_integers do
-      end
-
-      params do
-        requires :a_array, type: Array do
-          requires :param_1, type: Integer
-          requires :b_array, type: Array do
-            requires :param_2, type: String
-          end
-        end
-      end
-      post :nested_array do
-      end
-
-      add_swagger_documentation
-    end
-  end
-
-  it 'gets array types' do
-    get '/swagger_doc/splines'
-    expect(last_response.status).to eq 200
-    body = JSON.parse last_response.body
-    parameters = body['apis'].first['operations'].first['parameters']
-    expect(parameters).to eq [
-      { 'paramType' => 'form', 'name' => 'a_array[][param_1]', 'description' => '', 'type' => 'integer', 'required' => true, 'allowMultiple' => false, 'format' => 'int32' },
-      { 'paramType' => 'form', 'name' => 'a_array[][param_2]', 'description' => '', 'type' => 'string', 'required' => true, 'allowMultiple' => false }
-    ]
-  end
-
-  it 'get raw array type' do
-    get '/swagger_doc/raw_array_splines'
-    expect(last_response.status).to eq 200
-    body = JSON.parse last_response.body
-    parameters = body['apis'].first['operations'].first['parameters']
-    expect(parameters).to eq [
-      { 'paramType' => 'query', 'name' => 'raw_array', 'description' => '', 'type' => 'Array', 'required' => false, 'allowMultiple' => false }
-    ]
-  end
-
-  it 'get raw array integer' do
-    get '/swagger_doc/raw_array_integers'
-    expect(last_response.status).to eq 200
-    body = JSON.parse last_response.body
-    parameters = body['apis'].first['operations'].first['parameters']
-    expect(parameters).to eq [
-      { 'paramType' => 'query', 'name' => 'raw_array', 'description' => '', 'type' => 'array', 'required' => false, 'allowMultiple' => false, 'items' => { 'type' => 'integer', 'format' => 'int32' } }
-    ]
-  end
-
-  it 'get nested array integer' do
-    get '/swagger_doc/nested_array'
-    expect(last_response.status).to eq 200
-    body = JSON.parse last_response.body
-    parameters = body['apis'].first['operations'].first['parameters']
-    expect(parameters).to eq [
-      { 'paramType' => 'form', 'name' => 'a_array[][param_1]', 'description' => '', 'type' => 'integer', 'required' => true, 'allowMultiple' => false, 'format' => 'int32' },
-      { 'paramType' => 'form', 'name' => 'a_array[][b_array][][param_2]', 'description' => '', 'type' => 'string', 'required' => true, 'allowMultiple' => false }
-    ]
-  end
-end

data/spec/grape-swagger_helper_spec.rb

@@ -1,152 +0,0 @@
-require 'spec_helper'
-
-describe 'helpers' do
-  before :all do
-    class HelperTestAPI < Grape::API
-    end
-  end
-
-  subject do
-    HelperTestAPI.add_swagger_documentation
-  end
-
-  context 'parsing parameters' do
-    it 'parses params as query strings for a GET' do
-      params = {
-        name: { type: 'String', desc: 'A name', required: true, default: 'default' },
-        level: 'max'
-      }
-      path = '/coolness'
-      method = 'GET'
-      expect(subject.parse_params(params, path, method)).to eq [
-        { paramType: 'query', name: :name, description: 'A name', type: 'string', required: true, allowMultiple: false, defaultValue: 'default' },
-        { paramType: 'query', name: :level, description: '', type: 'string', required: false, allowMultiple: false }
-      ]
-    end
-
-    it 'parses params as query strings for a GET with an example' do
-      params = {
-        name: { type: 'String', desc: 'A name', required: true, default: 'default api value', documentation: { example: 'default swagger value' } },
-        level: 'max'
-      }
-      path = '/coolness'
-      method = 'GET'
-      expect(subject.parse_params(params, path, method)).to eq [
-        { paramType: 'query', name: :name, description: 'A name', type: 'string', required: true, allowMultiple: false, defaultValue: 'default swagger value' },
-        { paramType: 'query', name: :level, description: '', type: 'string', required: false, allowMultiple: false }
-      ]
-    end
-
-    it 'parses params as form for a POST' do
-      params = {
-        name: { type: 'String', desc: 'A name', required: true },
-        level: 'max'
-      }
-      path = '/coolness'
-      method = 'POST'
-      expect(subject.parse_params(params, path, method)).to eq [
-        { paramType: 'form', name: :name, description: 'A name', type: 'string', required: true, allowMultiple: false },
-        { paramType: 'form', name: :level, description: '', type: 'string', required: false, allowMultiple: false }
-      ]
-    end
-
-    it 'parses file param' do
-      params = {
-        rack: {
-          type: 'Rack::Multipart::UploadedFile',
-          desc: 'rack file',
-          datafile: 'content',
-          required: true
-        }
-      }
-      path = '/coolness'
-      method = 'POST'
-      expect(subject.parse_params(params, path, method)).to eq [
-        {
-          paramType: 'body',
-          name: :rack,
-          description: 'rack file',
-          type: 'File',
-          required: true,
-          allowMultiple: false
-        }
-      ]
-    end
-
-    it 'parses symbol param as string' do
-      params = {
-        animal: { type: 'Symbol', desc: 'An animal you like', required: true, values: [:cat, :dog] }
-      }
-      path = '/coolness'
-      method = 'POST'
-      expect(subject.parse_params(params, path, method)).to eq [
-        {
-          paramType: 'form',
-          name: :animal,
-          description: 'An animal you like',
-          type: 'string',
-          required: true,
-          allowMultiple: false,
-          enum: [:cat, :dog]
-        }
-      ]
-    end
-
-    context 'custom type' do
-      before :all do
-        class CustomType
-        end
-      end
-      it 'parses a custom parameters' do
-        params = {
-          option: { type: CustomType, desc: 'Custom option' }
-        }
-        path = '/coolness'
-        method = 'GET'
-        expect(subject.parse_params(params, path, method)).to eq [
-          { paramType: 'query', name: :option, description: 'Custom option', type: 'CustomType', required: false, allowMultiple: false }
-        ]
-      end
-    end
-  end
-
-  context 'parsing the path' do
-    it 'parses the path' do
-      path = ':abc/def(.:format)'
-      expect(subject.parse_path(path, nil)).to eq '{abc}/def.{format}'
-    end
-
-    it 'parses a path that has vars with underscores in the name' do
-      path = 'abc/:def_g(.:format)'
-      expect(subject.parse_path(path, nil)).to eq 'abc/{def_g}.{format}'
-    end
-
-    it 'parses a path that has vars with numbers in the name' do
-      path = 'abc/:sha1(.:format)'
-      expect(subject.parse_path(path, nil)).to eq 'abc/{sha1}.{format}'
-    end
-
-    it 'parses a path that has multiple variables' do
-      path1 = 'abc/:def/:geh(.:format)'
-      path2 = 'abc/:def:geh(.:format)'
-      expect(subject.parse_path(path1, nil)).to eq 'abc/{def}/{geh}.{format}'
-      expect(subject.parse_path(path2, nil)).to eq 'abc/{def}{geh}.{format}'
-    end
-
-    it 'parses the path with a specified version' do
-      path = ':abc/{version}/def(.:format)'
-      expect(subject.parse_path(path, 'v1')).to eq '{abc}/v1/def.{format}'
-    end
-  end
-
-  context 'parsing header parameters' do
-    it 'parses params for the header' do
-      params = {
-        'XAuthToken' => { description: 'A required header.', required: true, default: 'default' }
-      }
-      expect(subject.parse_header_params(params)).to eq [
-        { paramType: 'header', name: 'XAuthToken', description: 'A required header.', type: 'string', required: true, defaultValue: 'default' }
-      ]
-    end
-  end
-end

data/spec/group_params_spec.rb

@@ -1,31 +0,0 @@
-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' => '', 'type' => 'string', 'required' => true, 'allowMultiple' => false },
-      { 'paramType' => 'form', 'name' => 'required_group[required_param_2]', 'description' => '', 'type' => 'string', 'required' => true, 'allowMultiple' => false }]
-  end
-end

data/spec/hash_params_spec.rb

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

data/spec/hide_api_spec.rb

@@ -1,124 +0,0 @@
-require 'spec_helper'
-
-describe 'a hide mounted api' do
-  before :all do
-    class HideMountedApi < Grape::API
-      desc 'Show this endpoint'
-      get '/simple' do
-        { foo: 'bar' }
-      end
-
-      desc 'Hide this endpoint',
-           hidden: true
-
-      get '/hide' do
-        { foo: 'bar' }
-      end
-
-      desc 'Lazily show endpoint',
-           hidden: -> { false }
-
-      get '/lazy' do
-        { foo: 'bar' }
-      end
-    end
-
-    class HideApi < Grape::API
-      mount HideMountedApi
-      add_swagger_documentation
-    end
-  end
-
-  def app
-    HideApi
-  end
-
-  subject do
-    get '/swagger_doc.json'
-    JSON.parse(last_response.body)
-  end
-
-  it "retrieves swagger-documentation that doesn't include hidden endpoints" do
-    expect(subject).to eq(
-      'apiVersion' => '0.1',
-      'swaggerVersion' => '1.2',
-      'info' => {},
-      'produces' => Grape::ContentTypes::CONTENT_TYPES.values.uniq,
-      'apis' => [
-        { 'path' => '/simple.{format}', 'description' => 'Operations about simples' },
-        { 'path' => '/lazy.{format}', 'description' => 'Operations about lazies' },
-        { 'path' => '/swagger_doc.{format}', 'description' => 'Operations about swagger_docs' }
-      ]
-    )
-  end
-end
-
-describe 'a hide mounted api with same namespace' do
-  before :all do
-    class HideNamespaceMountedApi < Grape::API
-      desc 'Show this endpoint'
-      get '/simple/show' do
-        { foo: 'bar' }
-      end
-
-      desc 'Hide this endpoint',
-           hidden: true
-
-      get '/simple/hide' do
-        { foo: 'bar' }
-      end
-
-      desc 'Lazily hide endpoint',
-           hidden: -> { true }
-
-      get '/simple/lazy' do
-        { foo: 'bar' }
-      end
-    end
-
-    class HideNamespaceApi < Grape::API
-      mount HideNamespaceMountedApi
-      add_swagger_documentation
-    end
-  end
-
-  def app
-    HideNamespaceApi
-  end
-
-  it 'retrieves swagger-documentation on /swagger_doc' 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' => '/simple.{format}', 'description' => 'Operations about simples' },
-        { 'path' => '/swagger_doc.{format}', 'description' => 'Operations about swagger_docs' }
-      ]
-    )
-  end
-
-  it "retrieves the documentation for mounted-api that doesn't include hidden endpoints" do
-    get '/swagger_doc/simple.json'
-    expect(JSON.parse(last_response.body)).to eq(
-      'apiVersion' => '0.1',
-      'swaggerVersion' => '1.2',
-      'basePath' => 'http://example.org',
-      'resourcePath' => '/simple',
-      'produces' => Grape::ContentTypes::CONTENT_TYPES.values.uniq,
-      'apis' => [{
-        'path' => '/simple/show.{format}',
-        'operations' => [{
-          'notes' => '',
-          'summary' => 'Show this endpoint',
-          'nickname' => 'GET-simple-show---format-',
-          'method' => 'GET',
-          'parameters' => [],
-          'type' => 'void'
-        }]
-      }]
-    )
-  end
-end