grape-swagger 0.11.0 → 0.20.0

data/spec/response_model_spec.rb

@@ -1,121 +0,0 @@
-require 'spec_helper'
-
-describe 'responseModel' do
-  before :all do
-    module MyAPI
-      module Entities
-        class Kind < Grape::Entity
-          expose :title, documentation: { type: 'string', desc: 'Title of the kind.' }
-        end
-
-        class Something < Grape::Entity
-          expose :text, documentation: { type: 'string', desc: 'Content of something.' }
-          expose :kind, using: Kind, documentation: { type: 'MyAPI::Kind', desc: 'The kind of this something.' }
-          expose :kind2, using: Kind, documentation: { desc: 'Secondary kind.' }
-          expose :kind3, using: 'MyAPI::Entities::Kind', documentation: { desc: 'Tertiary kind.' }
-          expose :tags, using: 'MyAPI::Entities::Tag', documentation: { desc: 'Tags.', is_array: true }
-          expose :relation, using: 'MyAPI::Entities::Relation', documentation: { type: 'MyAPI::Relation', desc: 'A related model.' }
-        end
-
-        class Relation < Grape::Entity
-          expose :name, documentation: { type: 'string', desc: 'Name' }
-        end
-
-        class Tag < Grape::Entity
-          expose :name, documentation: { type: 'string', desc: 'Name' }
-        end
-
-        class Error < Grape::Entity
-          expose :code, documentation: { type: 'string', desc: 'Error code' }
-          expose :message, documentation: { type: 'string', desc: 'Error message' }
-        end
-      end
-
-      class ResponseModelApi < Grape::API
-        format :json
-        desc 'This returns something or an error',
-             entity: Entities::Something,
-             http_codes: [
-               [200, 'OK', Entities::Something],
-               [403, 'Refused to return something', Entities::Error]
-             ]
-
-        get '/something/:id' do
-          if params[:id] == 1
-            something = OpenStruct.new text: 'something'
-            present something, with: Entities::Something
-          else
-            error = OpenStruct.new code: 'some_error', message: 'Some error'
-            present error, with: Entities::Error
-          end
-        end
-
-        add_swagger_documentation
-      end
-    end
-  end
-
-  def app
-    MyAPI::ResponseModelApi
-  end
-
-  subject do
-    get '/swagger_doc/something'
-    JSON.parse(last_response.body)
-  end
-
-  it 'should document specified models' do
-    expect(subject['apis'][0]['operations'][0]['responseMessages']).to eq(
-      [
-        {
-          'code' => 200,
-          'message' => 'OK',
-          'responseModel' => 'MyAPI::Something'
-        },
-        {
-          'code' => 403,
-          'message' => 'Refused to return something',
-          'responseModel' => 'MyAPI::Error'
-        }
-      ]
-    )
-
-    expect(subject['models'].keys).to include 'MyAPI::Error'
-    expect(subject['models']['MyAPI::Error']).to eq(
-      'id' => 'MyAPI::Error',
-      'properties' => {
-        'code' => { 'type' => 'string', 'description' => 'Error code' },
-        'message' => { 'type' => 'string', 'description' => 'Error message' }
-      }
-    )
-
-    expect(subject['models'].keys).to include 'MyAPI::Something'
-    expect(subject['models']['MyAPI::Something']).to eq(
-      'id' => 'MyAPI::Something',
-      'properties' => {
-        'text' => { 'type' => 'string', 'description' => 'Content of something.' },
-        'kind' => { '$ref' => 'MyAPI::Kind', 'description' => 'The kind of this something.' },
-        'kind2' => { '$ref' => 'MyAPI::Kind', 'description' => 'Secondary kind.' },
-        'kind3' => { '$ref' => 'MyAPI::Kind', 'description' => 'Tertiary kind.' },
-        'tags' => { 'items' => { '$ref' => 'MyAPI::Tag' }, 'type' => 'array', 'description' => 'Tags.' },
-        'relation' => { '$ref' => 'MyAPI::Relation', 'description' => 'A related model.' }
-      }
-    )
-
-    expect(subject['models'].keys).to include 'MyAPI::Kind'
-    expect(subject['models']['MyAPI::Kind']).to eq(
-      'id' => 'MyAPI::Kind',
-      'properties' => {
-        'title' => { 'type' => 'string', 'description' => 'Title of the kind.' }
-      }
-    )
-
-    expect(subject['models'].keys).to include 'MyAPI::Relation'
-    expect(subject['models']['MyAPI::Relation']).to eq(
-      'id' => 'MyAPI::Relation',
-      'properties' => {
-        'name' => { 'type' => 'string', 'description' => 'Name' }
-      }
-    )
-  end
-end

data/spec/simple_mounted_api_spec.rb

@@ -1,213 +0,0 @@
-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 for URL in camelcase.',
-           notes: '_test_'
-      get '/SimpleTest' do
-        { bla: 'something else' }
-      end
-
-      desc 'this gets something else',
-           headers: {
-             'XAuthToken' => { description: 'A required header.', required: true },
-             'XOtherHeader' => { description: 'An optional header.', required: false }
-           },
-           http_codes: {
-             403 => 'invalid pony',
-             405 => '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(
-      'apiVersion' => '0.1',
-      'swaggerVersion' => '1.2',
-      'info' => {},
-      'produces' => Grape::ContentTypes::CONTENT_TYPES.values.uniq,
-      'apis' => [
-        { 'path' => '/simple.{format}', 'description' => 'Operations about simples' },
-        { 'path' => '/simple-test.{format}', 'description' => 'Operations about simple-tests' },
-        { 'path' => '/SimpleTest.{format}', 'description' => 'Operations about SimpleTests' },
-        { 'path' => '/simple_with_headers.{format}', 'description' => 'Operations about simple_with_headers' },
-        { 'path' => '/items.{format}', 'description' => 'Operations about items' },
-        { 'path' => '/custom.{format}', 'description' => 'Operations about customs' },
-        { 'path' => '/swagger_doc.{format}', 'description' => 'Operations about swagger_docs' }
-      ]
-    )
-  end
-
-  it 'retrieves the documentation for mounted-api' 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.{format}',
-        'operations' => [{
-          'notes' => '_test_',
-          'summary' => 'This gets something.',
-          'nickname' => 'GET-simple---format-',
-          'method' => 'GET',
-          'parameters' => [],
-          'type' => 'void'
-        }]
-      }]
-    )
-  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(
-        'apiVersion' => '0.1',
-        'swaggerVersion' => '1.2',
-        'basePath' => 'http://example.org',
-        'resourcePath' => '/simple-test',
-        'produces' => Grape::ContentTypes::CONTENT_TYPES.values.uniq,
-        'apis' => [{
-          'path' => '/simple-test.{format}',
-          'operations' => [{
-            'notes' => '_test_',
-            'summary' => 'This gets something for URL using - separator.',
-            'nickname' => 'GET-simple-test---format-',
-            'method' => 'GET',
-            'parameters' => [],
-            'type' => 'void'
-          }]
-        }]
-      )
-    end
-
-    it 'uses camelcase' do
-      get '/swagger_doc/SimpleTest.json'
-      expect(JSON.parse(last_response.body)).to eq(
-        'apiVersion' => '0.1',
-        'swaggerVersion' => '1.2',
-        'basePath' => 'http://example.org',
-        'resourcePath' => '/SimpleTest',
-        'produces' => Grape::ContentTypes::CONTENT_TYPES.values.uniq,
-        'apis' => [{
-          'path' => '/SimpleTest.{format}',
-          'operations' => [{
-            'notes' => '_test_',
-            'summary' => 'This gets something for URL in camelcase.',
-            'nickname' => 'GET-SimpleTest---format-',
-            'method' => 'GET',
-            'parameters' => [],
-            'type' => 'void'
-          }]
-        }]
-      )
-    end
-
-    it 'includes headers' do
-      get '/swagger_doc/simple_with_headers.json'
-      expect(JSON.parse(last_response.body)['apis']).to eq [{
-        'path' => '/simple_with_headers.{format}',
-        'operations' => [{
-          'notes' => '',
-          'summary' => 'this gets something else',
-          'nickname' => 'GET-simple_with_headers---format-',
-          'method' => 'GET',
-          'parameters' => [
-            { 'paramType' => 'header', 'name' => 'XAuthToken', 'description' => 'A required header.', 'type' => 'string', 'required' => true },
-            { 'paramType' => 'header', 'name' => 'XOtherHeader', 'description' => 'An optional header.', 'type' => 'string', 'required' => false }
-          ],
-          'type' => 'void',
-          'responseMessages' => [
-            { 'code' => 403, 'message' => 'invalid pony' },
-            { 'code' => 405, 'message' => 'no ponies left!' }
-          ]
-        }]
-      }]
-    end
-
-    it 'supports multiple parameters' do
-      get '/swagger_doc/items.json'
-      expect(JSON.parse(last_response.body)['apis']).to eq [{
-        'path' => '/items.{format}',
-        'operations' => [{
-          'notes' => '',
-          'summary' => 'this takes an array of parameters',
-          'nickname' => 'POST-items---format-',
-          'method' => 'POST',
-          'parameters' => [{ 'paramType' => 'form', 'name' => 'items[]', 'description' => 'array of items', 'type' => 'string', 'required' => false, 'allowMultiple' => false }],
-          'type' => 'void'
-        }]
-      }]
-    end
-
-    it 'supports custom types' do
-      get '/swagger_doc/custom.json'
-      expect(JSON.parse(last_response.body)['apis']).to eq [{
-        'path' => '/custom.{format}',
-        'operations' => [{
-          'notes' => '',
-          'summary' => 'this uses a custom parameter',
-          'nickname' => 'GET-custom---format-',
-          'method' => 'GET',
-          'parameters' => [{ 'paramType' => 'query', 'name' => 'custom', 'description' => 'array of items', 'type' => 'CustomType', 'required' => false, 'allowMultiple' => false }],
-          'type' => 'void'
-        }]
-      }]
-    end
-  end
-end

data/spec/support/i18n_helper.rb

@@ -1,8 +0,0 @@
-module I18nHelper
-  def with_translations(locale, translations)
-    I18n.backend.store_translations locale, translations
-    yield
-  ensure
-    I18n.reload!
-  end
-end