grape-swagger/spec/swagger_v2/simple_mounted_api_spec.rb

require 'spec_helper'

describe 'a simple mounted api' do
  before :all do
    class CustomType; end

    class SimpleMountedApi < Grape::API
      desc 'Document root'
      get do
      end

      desc 'This gets something.',
        notes: '_test_'

      get '/simple' do
        { bla: 'something' }
      end

      desc 'This gets something for URL using - separator.',
        notes: '_test_'

      get '/simple-test' do
        { bla: 'something' }
      end

      desc 'this gets something else',
        headers: {
          'XAuthToken' => { description: 'A required header.', required: true },
          'XOtherHeader' => { description: 'An optional header.', required: false }
        },
        http_codes: [
          { code: 403, message: 'invalid pony' },
          { code: 405, message: 'no ponies left!' }
        ]

      get '/simple_with_headers' do
        { bla: 'something_else' }
      end

      desc 'this takes an array of parameters',
        params: {
          'items[]' => { description: 'array of items' }
        }

      post '/items' do
        {}
      end

      desc 'this uses a custom parameter',
        params: {
          'custom' => { type: CustomType, description: 'array of items' }
        }

      get '/custom' do
        {}
      end
    end

    class SimpleApi < Grape::API
      mount SimpleMountedApi
      add_swagger_documentation
    end
  end

  def app
    SimpleApi
  end

  it 'retrieves swagger-documentation on /swagger_doc' do
    get '/swagger_doc.json'
    expect(JSON.parse(last_response.body)).to eq(
      {
        "info"=>{"title"=>"API title", "version"=>"v1"},
        "swagger"=>"2.0",
        "produces"=>["application/xml", "application/json", "application/octet-stream", "text/plain"],
        "host"=>"example.org",
        "schemes" => ["https", "http"],
        "paths"=>
        {"/simple"=>{"get"=>{"produces"=>["application/json"], "responses"=>{"200"=>{"description"=>"This gets something."}}}},
         "/simple-test"=>{"get"=>{"produces"=>["application/json"], "responses"=>{"200"=>{"description"=>"This gets something for URL using - separator."}}}},
         "/simple_with_headers"=>
          {"get"=>
            {"produces"=>["application/json"],
             "responses"=>
              {"200"=>{"description"=>"this gets something else"},
               "403"=>{"description"=>"invalid pony"},
               "405"=>{"description"=>"no ponies left!"}},
            "headers"=>{
              'XAuthToken' => {"description"=>'A required header.', "required"=>true },
              'XOtherHeader' => {"description"=>'An optional header.', "required"=>false }
            }}},
         "/items"=>{"post"=>{"produces"=>["application/json"], "responses"=>{"201"=>{"description"=>"this takes an array of parameters"}}}},
         "/custom"=>{"get"=>{"produces"=>["application/json"], "responses"=>{"200"=>{"description"=>"this uses a custom parameter"}}}}}}
    )
  end

  it 'retrieves the documentation for mounted-api' do
    get '/swagger_doc/simple.json'
    expect(JSON.parse(last_response.body)).to eq({
      "info"=>{"title"=>"API title", "version"=>"v1"},
      "swagger"=>"2.0",
      "produces"=>["application/xml", "application/json", "application/octet-stream", "text/plain"],
      "host"=>"example.org",
      "schemes" => ["https", "http"],
      "paths"=>{"/simple"=>{"get"=>{"produces"=>["application/json"], "responses"=>{"200"=>{"description"=>"This gets something."}}}}}})
  end

  context 'retrieves the documentation for mounted-api that' do
    it "contains '-' in URL" do
      get '/swagger_doc/simple-test.json'
      expect(JSON.parse(last_response.body)).to eq({
        "info"=>{"title"=>"API title", "version"=>"v1"},
        "swagger"=>"2.0",
        "produces"=>["application/xml", "application/json", "application/octet-stream", "text/plain"],
        "host"=>"example.org",
        "schemes" => ["https", "http"],
        "paths"=>{
          "/simple-test"=>{"get"=>{
            "produces"=>["application/json"],
            "responses"=>{
              "200"=>{"description"=>"This gets something for URL using - separator."}}}}}}
        )
    end

    it 'includes headers' do
      get '/swagger_doc/simple_with_headers.json'
      expect(JSON.parse(last_response.body)['paths']).to eq(
      {"/simple_with_headers"=>
        {"get"=>
          {"produces"=>["application/json"],
          "headers"=>{
            'XAuthToken' => {"description"=>'A required header.', "required"=>true },
            'XOtherHeader' => {"description"=>'An optional header.', "required"=>false }},
           "responses"=>
            {"200"=>{"description"=>"this gets something else"},
             "403"=>{"description"=>"invalid pony"},
             "405"=>{"description"=>"no ponies left!"}}}}}
      )
    end

    it 'supports multiple parameters' do
      get '/swagger_doc/items.json'
      expect(JSON.parse(last_response.body)['paths']).to eq(
        {
          "/items"=>{
            "post"=>{
              "produces"=>["application/json"],
              "responses"=>{
                "201"=>{
                  "description"=>"this takes an array of parameters"}}}}}
        )
    end

    it 'supports custom types' do
      get '/swagger_doc/custom.json'
      expect(JSON.parse(last_response.body)['paths']).to eq(
        {
          "/custom"=>{
            "get"=>{
              "produces"=>["application/json"],
              "responses"=>{
                "200"=>{
                  "description"=>"this uses a custom parameter"}}}}}
      )
    end
  end
end