grape-swagger 1.6.1 → 2.0.1

data/spec/issues/430_entity_definitions_spec.rb

@@ -1,94 +0,0 @@
-# frozen_string_literal: true
-
-require 'spec_helper'
-
-describe 'definition names' do
-  before :all do
-    module TestDefinition
-      module DummyEntities
-        module WithVeryLongName
-          module AnotherGroupingModule
-            class Class1
-              class Entity < Grape::Entity
-                expose :first_thing
-              end
-            end
-
-            class Class2
-              class Entities < Grape::Entity
-                expose :second_thing
-              end
-            end
-
-            class Class3
-              class Entity < Grape::Entity
-                expose :third_thing
-
-                def self.entity_name
-                  'FooKlass'
-                end
-              end
-            end
-
-            class Class4
-              class FourthEntity < Grape::Entity
-                expose :fourth_thing
-              end
-            end
-
-            class Class5
-              class FithEntity < Class4::FourthEntity
-                expose :fith_thing
-              end
-            end
-
-            class Class6
-              class SixthEntity < Grape::Entity
-                expose :sixth_thing
-
-                def self.entity_name
-                  'BarKlass'
-                end
-              end
-            end
-
-            class Class7
-              class SeventhEntity < Class6::SixthEntity
-                expose :seventh_thing
-
-                private_class_method :entity_name
-              end
-            end
-          end
-        end
-      end
-
-      class NameApi < Grape::API
-        add_swagger_documentation models: [
-          DummyEntities::WithVeryLongName::AnotherGroupingModule::Class1::Entity,
-          DummyEntities::WithVeryLongName::AnotherGroupingModule::Class2::Entities,
-          DummyEntities::WithVeryLongName::AnotherGroupingModule::Class3::Entity,
-          DummyEntities::WithVeryLongName::AnotherGroupingModule::Class4::FourthEntity,
-          DummyEntities::WithVeryLongName::AnotherGroupingModule::Class5::FithEntity,
-          DummyEntities::WithVeryLongName::AnotherGroupingModule::Class6::SixthEntity,
-          DummyEntities::WithVeryLongName::AnotherGroupingModule::Class7::SeventhEntity
-        ]
-      end
-    end
-  end
-
-  let(:app) { TestDefinition::NameApi }
-
-  subject do
-    get '/swagger_doc'
-    JSON.parse(last_response.body)['definitions']
-  end
-
-  specify { expect(subject).to include 'TestDefinition_DummyEntities_WithVeryLongName_AnotherGroupingModule_Class1' }
-  specify { expect(subject).to include 'TestDefinition_DummyEntities_WithVeryLongName_AnotherGroupingModule_Class2' }
-  specify { expect(subject).to include 'FooKlass' }
-  specify { expect(subject).to include 'TestDefinition_DummyEntities_WithVeryLongName_AnotherGroupingModule_Class4_FourthEntity' }
-  specify { expect(subject).to include 'TestDefinition_DummyEntities_WithVeryLongName_AnotherGroupingModule_Class5_FithEntity' }
-  specify { expect(subject).to include 'BarKlass' }
-  specify { expect(subject).to include 'TestDefinition_DummyEntities_WithVeryLongName_AnotherGroupingModule_Class7_SeventhEntity' }
-end

data/spec/issues/532_allow_custom_format_spec.rb

@@ -1,38 +0,0 @@
-# frozen_string_literal: true
-
-require 'spec_helper'
-
-describe '#532 allow custom format' do
-  let(:app) do
-    Class.new(Grape::API) do
-      namespace :issue_532 do
-        params do
-          requires :logs, type: String, documentation: { format: 'log' }
-          optional :phone_number, type: Integer, documentation: { format: 'phone_number' }
-        end
-
-        post do
-          present params
-        end
-      end
-
-      add_swagger_documentation format: :json
-    end
-  end
-
-  subject do
-    get '/swagger_doc'
-    JSON.parse(last_response.body)
-  end
-
-  let(:parameters) { subject['paths']['/issue_532']['post']['parameters'] }
-
-  specify do
-    expect(parameters).to eql(
-      [
-        { 'in' => 'formData', 'name' => 'logs', 'type' => 'string', 'format' => 'log', 'required' => true },
-        { 'in' => 'formData', 'name' => 'phone_number', 'type' => 'integer', 'format' => 'phone_number', 'required' => false }
-      ]
-    )
-  end
-end

data/spec/issues/533_specify_status_code_spec.rb

@@ -1,78 +0,0 @@
-# frozen_string_literal: true
-
-require 'spec_helper'
-
-describe '#533 specify status codes' do
-  include_context "#{MODEL_PARSER} swagger example"
-
-  let(:app) do
-    Class.new(Grape::API) do
-      namespace :issue_533 do
-        desc 'Get a list of stuff',
-             success: { code: 202, model: Entities::UseResponse, message: 'a changed status code' }
-        get do
-          status 202
-          { foo: 'that is the response' }
-        end
-
-        desc 'Post some stuff',
-             success: { code: 202, model: Entities::UseResponse, message: 'a changed status code' }
-        post do
-          status 202
-          { foo: 'that is the response' }
-        end
-
-        desc 'Post some stuff',
-             success: { code: 204, message: 'a changed status code' }
-        patch do
-          status 204
-        end
-
-        desc 'Delete some stuff',
-             success: { code: 203 }
-        delete do
-          status 203
-        end
-      end
-
-      add_swagger_documentation format: :json
-    end
-  end
-
-  subject do
-    get '/swagger_doc'
-    JSON.parse(last_response.body)['paths']['/issue_533']
-  end
-
-  let(:get_response) { get '/issue_533' }
-  specify { expect(get_response.status).to eql 202 }
-  let(:get_response_documentation) { subject['get']['responses'] }
-  specify do
-    expect(get_response_documentation.keys.first).to eql '202'
-    expect(get_response_documentation['202']).to include 'schema'
-  end
-
-  let(:post_response) { post '/issue_533' }
-  specify { expect(post_response.status).to eql 202 }
-  let(:post_response_documentation) { subject['post']['responses'] }
-  specify do
-    expect(post_response_documentation.keys.first).to eql '202'
-    expect(post_response_documentation['202']).to include 'schema'
-  end
-
-  let(:patch_response) { patch '/issue_533' }
-  specify { expect(patch_response.status).to eql 204 }
-  let(:patch_response_documentation) { subject['patch']['responses'] }
-  specify do
-    expect(patch_response_documentation.keys.first).to eql '204'
-    expect(patch_response_documentation['204']).not_to include 'schema'
-  end
-
-  let(:delete_response) { delete '/issue_533' }
-  specify { expect(delete_response.status).to eql 203 }
-  let(:delete_response_documentation) { subject['delete']['responses'] }
-  specify do
-    expect(delete_response_documentation.keys.first).to eql '203'
-    expect(delete_response_documentation['203']).not_to include 'schema'
-  end
-end

data/spec/issues/537_enum_values_spec.rb

@@ -1,50 +0,0 @@
-# frozen_string_literal: true
-
-require 'spec_helper'
-
-describe '#537 enum values spec' do
-  let(:app) do
-    Class.new(Grape::API) do
-      namespace :issue_537 do
-        class Spec < Grape::Entity
-          expose :enum_property, documentation: { values: %i[foo bar] }
-          expose :enum_property_default, documentation: { values: %w[a b c], default: 'c' }
-          expose :own_format, documentation: { format: 'log' }
-        end
-
-        desc 'create account',
-             success: Spec
-        get do
-          { message: 'hi' }
-        end
-      end
-
-      add_swagger_documentation format: :json
-    end
-  end
-
-  subject do
-    get '/swagger_doc'
-    JSON.parse(last_response.body)
-  end
-
-  let(:property) { subject['definitions']['Spec']['properties']['enum_property'] }
-  specify do
-    expect(property).to include 'enum'
-    expect(property['enum']).to eql %w[foo bar]
-  end
-
-  let(:property_default) { subject['definitions']['Spec']['properties']['enum_property_default'] }
-  specify do
-    expect(property_default).to include 'enum'
-    expect(property_default['enum']).to eql %w[a b c]
-    expect(property_default).to include 'default'
-    expect(property_default['default']).to eql 'c'
-  end
-
-  let(:own_format) { subject['definitions']['Spec']['properties']['own_format'] }
-  specify do
-    expect(own_format).to include 'format'
-    expect(own_format['format']).to eql 'log'
-  end
-end

data/spec/issues/539_array_post_body_spec.rb

@@ -1,65 +0,0 @@
-# frozen_string_literal: true
-
-require 'spec_helper'
-
-describe '#539 post params given as array' do
-  let(:app) do
-    Class.new(Grape::API) do
-      namespace :issue_539 do
-        class Element < Grape::Entity
-          expose :id
-          expose :description
-          expose :role
-        end
-
-        class ArrayOfElements < Grape::Entity
-          expose :elements,
-                 documentation: {
-                   type: Element, is_array: true, param_type: 'body', required: true
-                 }
-        end
-
-        desc 'create account',
-             params: ArrayOfElements.documentation
-        post do
-          present params
-        end
-      end
-
-      add_swagger_documentation format: :json
-    end
-  end
-
-  subject do
-    get '/swagger_doc'
-    JSON.parse(last_response.body)
-  end
-
-  let(:parameters) { subject['paths']['/issue_539']['post']['parameters'] }
-  let(:definitions) { subject['definitions'] }
-
-  specify do
-    expect(parameters).to eql(
-      [
-        {
-          'in' => 'body', 'name' => 'elements', 'required' => true, 'schema' => {
-            'type' => 'array', 'items' => { '$ref' => '#/definitions/Element' }
-          }
-        }
-      ]
-    )
-  end
-
-  specify do
-    expect(definitions).to eql(
-      'Element' => {
-        'type' => 'object',
-        'properties' => {
-          'id' => { 'type' => 'string' },
-          'description' => { 'type' => 'string' },
-          'role' => { 'type' => 'string' }
-        }
-      }
-    )
-  end
-end

data/spec/issues/542_array_of_type_in_post_body_spec.rb

@@ -1,46 +0,0 @@
-# frozen_string_literal: true
-
-require 'spec_helper'
-
-describe '#542 array of type in post params' do
-  let(:app) do
-    Class.new(Grape::API) do
-      namespace :issue_542 do
-        params do
-          requires :logs, type: Array[String], documentation: { param_type: 'body' }
-        end
-
-        post do
-          present params
-        end
-      end
-
-      add_swagger_documentation format: :json
-    end
-  end
-
-  subject do
-    get '/swagger_doc'
-    JSON.parse(last_response.body)
-  end
-
-  let(:parameters) { subject['paths']['/issue_542']['post']['parameters'] }
-
-  specify do
-    expect(parameters).to eql(
-      [
-        {
-          'in' => 'body',
-          'name' => 'logs',
-          'required' => true,
-          'schema' => {
-            'type' => 'array',
-            'items' => {
-              'type' => 'string'
-            }
-          }
-        }
-      ]
-    )
-  end
-end

data/spec/issues/553_align_array_put_post_params_spec.rb

@@ -1,144 +0,0 @@
-# frozen_string_literal: true
-
-require 'spec_helper'
-
-describe '#553 array of type in post/put params' do
-  let(:app) do
-    Class.new(Grape::API) do
-      namespace :in_form_data do
-        desc 'create foo'
-        params do
-          requires :guid, type: Array[String]
-        end
-        post do
-          # your code goes here
-        end
-
-        desc 'put specific foo'
-        params do
-          requires :id
-          requires :guid, type: Array[String]
-        end
-        put ':id' do
-          # your code goes here
-        end
-      end
-
-      namespace :in_body do
-        desc 'create foo'
-        params do
-          requires :guid, type: Array[String], documentation: { param_type: 'body' }
-        end
-        post do
-          # your code goes here
-        end
-
-        desc 'put specific foo'
-        params do
-          requires :id
-          requires :guid, type: Array[String], documentation: { param_type: 'body' }
-        end
-        put ':id' do
-          # your code goes here
-        end
-      end
-
-      add_swagger_documentation format: :json
-    end
-  end
-
-  subject do
-    get '/swagger_doc'
-    JSON.parse(last_response.body)
-  end
-
-  describe 'type for Array specified' do
-    describe 'in formData' do
-      describe 'post request' do
-        let(:params) { subject['paths']['/in_form_data']['post']['parameters'] }
-
-        specify do
-          expect(params).to eql([{
-            'in' => 'formData',
-            'name' => 'guid',
-            'type' => 'array',
-            'items' => { 'type' => 'string' },
-            'required' => true
-          }])
-        end
-      end
-
-      describe 'put request' do
-        let(:params) { subject['paths']['/in_form_data/{id}']['put']['parameters'] }
-
-        specify do
-          expect(params).to eql(
-            [
-              {
-                'in' => 'path',
-                'name' => 'id',
-                'type' => 'string',
-                'required' => true
-              },
-              {
-                'in' => 'formData',
-                'name' => 'guid',
-                'type' => 'array',
-                'items' => { 'type' => 'string' },
-                'required' => true
-              }
-            ]
-          )
-        end
-      end
-    end
-
-    describe 'in body' do
-      describe 'post request' do
-        let(:params) { subject['paths']['/in_body']['post']['parameters'] }
-
-        specify do
-          expect(params).to eql(
-            [
-              {
-                'in' => 'body',
-                'name' => 'guid',
-                'required' => true,
-                'schema' => {
-                  'type' => 'array',
-                  'items' => { 'type' => 'string' }
-                }
-              }
-            ]
-          )
-        end
-      end
-
-      describe 'put request' do
-        let(:params) { subject['paths']['/in_body/{id}']['put']['parameters'] }
-
-        specify do
-          expect(params).to eql(
-            [
-              {
-                'in' => 'path',
-                'name' => 'id',
-                'type' => 'string',
-                'required' => true
-              },
-              {
-                'in' => 'body',
-                'name' => 'guid',
-                'required' => true,
-                'schema' => {
-                  'type' => 'array',
-                  'items' => { 'type' => 'string' }
-                }
-              }
-            ]
-          )
-        end
-      end
-    end
-  end
-end

data/spec/issues/572_array_post_body_spec.rb

@@ -1,51 +0,0 @@
-# frozen_string_literal: true
-
-require 'spec_helper'
-
-describe '#572 is_array is applied to all possible responses' do
-  include_context "#{MODEL_PARSER} swagger example"
-
-  let(:app) do
-    Class.new(Grape::API) do
-      namespace :issue_572 do
-        desc 'get issue',
-             is_array: true,
-             success: Entities::UseResponse,
-             failure: [
-               [401, 'BadKittenError', Entities::ApiError],
-               [404, 'NoTreatsError', Entities::ApiError],
-               [429, 'TooManyScratchesError', Entities::ApiError]
-             ]
-
-        get
-      end
-
-      add_swagger_documentation format: :json
-    end
-  end
-
-  subject do
-    get '/swagger_doc'
-    JSON.parse(last_response.body)
-  end
-
-  let(:codes) { %w[200 401 404 429] }
-
-  let(:responses) { subject['paths']['/issue_572']['get']['responses'] }
-
-  specify { expect(responses.keys.sort).to eq codes }
-
-  specify do
-    expect(responses['200']['schema']).to include 'type'
-    expect(responses['200']['schema']['type']).to eql 'array'
-  end
-
-  describe 'no array types' do
-    specify do
-      codes[1..-1].each do |code|
-        expect(responses[code]['schema']).not_to include 'type'
-        expect(responses[code]['schema'].keys).to eql ['$ref']
-      end
-    end
-  end
-end