grape-swagger 1.6.1 → 2.0.1

data/spec/issues/579_align_put_post_parameters_spec.rb

@@ -1,179 +0,0 @@
-# frozen_string_literal: true
-
-require 'spec_helper'
-
-describe '#579 put / post parameters spec' do
-  let(:app) do
-    Class.new(Grape::API) do
-      namespace :issue_579 do
-        class BodySpec < Grape::Entity
-          expose :guid, documentation: { type: String, format: 'guid', in: 'body' }
-          expose :name, documentation: { type: String, in: 'body' }
-          expose :content, documentation: { type: String, in: 'body' }
-        end
-
-        class Spec < Grape::Entity
-          expose :guid, documentation: { type: String, format: 'guid' }
-          expose :name, documentation: { type: String }
-          expose :content, documentation: { type: String }
-        end
-
-        namespace :implicit do
-          namespace :body_parameter do
-            desc 'update spec',
-                 success: BodySpec,
-                 params: BodySpec.documentation
-            put ':guid' do
-              # your code goes here
-            end
-          end
-
-          namespace :form_parameter do
-            desc 'update spec',
-                 success: Spec,
-                 params: Spec.documentation
-            put ':guid' do
-              # your code goes here
-            end
-          end
-        end
-
-        namespace :explicit do
-          namespace :body_parameter do
-            desc 'update spec',
-                 success: BodySpec,
-                 params: BodySpec.documentation
-            params do
-              requires :guid
-            end
-            put ':guid' do
-              # your code goes here
-            end
-          end
-
-          namespace :form_parameter do
-            desc 'update spec',
-                 success: Spec,
-                 params: Spec.documentation
-            params do
-              requires :guid
-            end
-            put ':guid' do
-              # your code goes here
-            end
-          end
-        end
-
-        namespace :namespace_param do
-          route_param :guid do
-            namespace :body_parameter do
-              desc 'update spec',
-                   success: BodySpec,
-                   params: BodySpec.documentation
-              put do
-                # your code goes here
-              end
-            end
-
-            namespace :form_parameter do
-              desc 'update spec',
-                   success: Spec,
-                   params: Spec.documentation
-              put do
-                # your code goes here
-              end
-            end
-          end
-        end
-      end
-
-      add_swagger_documentation format: :json
-    end
-  end
-
-  subject do
-    get '/swagger_doc'
-    JSON.parse(last_response.body)
-  end
-
-  describe 'implicit path param given' do
-    let(:body_parameters) { subject['paths']['/issue_579/implicit/body_parameter/{guid}']['put']['parameters'] }
-    specify do
-      expect(body_parameters).to eql(
-        [
-          { 'in' => 'path', 'name' => 'guid', 'type' => 'string', 'format' => 'guid', 'required' => true },
-          {
-            'name' => 'putIssue579ImplicitBodyParameterGuid', 'in' => 'body', 'required' => true, 'schema' => {
-              '$ref' => '#/definitions/putIssue579ImplicitBodyParameterGuid'
-            }
-          }
-        ]
-      )
-    end
-
-    let(:form_parameters) { subject['paths']['/issue_579/implicit/form_parameter/{guid}']['put']['parameters'] }
-    specify do
-      expect(form_parameters).to eql(
-        [
-          { 'in' => 'path', 'name' => 'guid', 'type' => 'string', 'format' => 'guid', 'required' => true },
-          { 'in' => 'formData', 'name' => 'name', 'type' => 'string', 'required' => false },
-          { 'in' => 'formData', 'name' => 'content', 'type' => 'string', 'required' => false }
-        ]
-      )
-    end
-  end
-
-  describe 'explicit path param given' do
-    let(:body_parameters) { subject['paths']['/issue_579/explicit/body_parameter/{guid}']['put']['parameters'] }
-    specify do
-      expect(body_parameters).to eql(
-        [
-          { 'in' => 'path', 'name' => 'guid', 'type' => 'string', 'format' => 'guid', 'required' => true },
-          {
-            'name' => 'putIssue579ExplicitBodyParameterGuid', 'in' => 'body', 'required' => true, 'schema' => {
-              '$ref' => '#/definitions/putIssue579ExplicitBodyParameterGuid'
-            }
-          }
-        ]
-      )
-    end
-
-    let(:form_parameters) { subject['paths']['/issue_579/explicit/form_parameter/{guid}']['put']['parameters'] }
-    specify do
-      expect(form_parameters).to eql(
-        [
-          { 'in' => 'path', 'name' => 'guid', 'type' => 'string', 'format' => 'guid', 'required' => true },
-          { 'in' => 'formData', 'name' => 'name', 'type' => 'string', 'required' => false },
-          { 'in' => 'formData', 'name' => 'content', 'type' => 'string', 'required' => false }
-        ]
-      )
-    end
-  end
-
-  describe 'explicit as route param given' do
-    let(:body_parameters) { subject['paths']['/issue_579/namespace_param/{guid}/body_parameter']['put']['parameters'] }
-    specify do
-      expect(body_parameters).to eql(
-        [
-          { 'in' => 'path', 'name' => 'guid', 'type' => 'string', 'format' => 'guid', 'required' => true },
-          {
-            'name' => 'putIssue579NamespaceParamGuidBodyParameter', 'in' => 'body', 'required' => true, 'schema' => {
-              '$ref' => '#/definitions/putIssue579NamespaceParamGuidBodyParameter'
-            }
-          }
-        ]
-      )
-    end
-
-    let(:form_parameters) { subject['paths']['/issue_579/namespace_param/{guid}/form_parameter']['put']['parameters'] }
-    specify do
-      expect(form_parameters).to eql(
-        [
-          { 'in' => 'path', 'name' => 'guid', 'type' => 'string', 'format' => 'guid', 'required' => true },
-          { 'in' => 'formData', 'name' => 'name', 'type' => 'string', 'required' => false },
-          { 'in' => 'formData', 'name' => 'content', 'type' => 'string', 'required' => false }
-        ]
-      )
-    end
-  end
-end

data/spec/issues/582_file_response_spec.rb

@@ -1,55 +0,0 @@
-# frozen_string_literal: true
-
-require 'spec_helper'
-
-describe '#582 respond with a file' do
-  include_context "#{MODEL_PARSER} swagger example"
-
-  let(:app) do
-    Class.new(Grape::API) do
-      namespace :issue_582 do
-        desc 'produces given',
-             success: File,
-             produces: ['application/pdf', 'text/csv']
-        get '/produces_given' do
-          'responds a file'
-        end
-
-        desc 'automatic produces',
-             success: 'file'
-        get '/automatic_produces' do
-          'responds a file'
-        end
-      end
-
-      add_swagger_documentation format: :json
-    end
-  end
-
-  subject do
-    get '/swagger_doc'
-    JSON.parse(last_response.body)
-  end
-
-  describe 'produces given' do
-    let(:produces) { subject['paths']['/issue_582/produces_given']['get']['produces'] }
-    let(:response) { subject['paths']['/issue_582/produces_given']['get']['responses']['200'] }
-
-    specify do
-      expect(produces).to eql ['application/pdf', 'text/csv']
-      expect(response).to include 'schema'
-      expect(response['schema']).to eql 'type' => 'file'
-    end
-  end
-
-  describe 'automatic_produces' do
-    let(:produces) { subject['paths']['/issue_582/automatic_produces']['get']['produces'] }
-    let(:response) { subject['paths']['/issue_582/automatic_produces']['get']['responses']['200'] }
-
-    specify do
-      expect(produces).to eql ['application/octet-stream']
-      expect(response).to include 'schema'
-      expect(response['schema']).to eql 'type' => 'file'
-    end
-  end
-end

data/spec/issues/587_range_parameter_delimited_by_dash_spec.rb

@@ -1,26 +0,0 @@
-# frozen_string_literal: true
-
-require 'spec_helper'
-
-describe '#587 process route with parameters delimited by dash' do
-  let(:app) do
-    Class.new(Grape::API) do
-      namespace :range_parameter do
-        desc 'Get a array with range'
-        get '/range/:range_start-:range_end' do
-          present []
-        end
-      end
-
-      add_swagger_documentation format: :json
-    end
-  end
-
-  subject do
-    get '/swagger_doc'
-    JSON.parse(last_response.body)['paths']
-  end
-
-  specify { expect(subject.keys).to include '/range_parameter/range/{range_start}-{range_end}' }
-  specify { expect(subject['/range_parameter/range/{range_start}-{range_end}']['get']['operationId']).to eql 'getRangeParameterRangeRangeStart-RangeEnd' }
-end

data/spec/issues/605_root_route_documentation_spec.rb

@@ -1,23 +0,0 @@
-# frozen_string_literal: true
-
-require 'spec_helper'
-
-describe '#605 root route documentation' do
-  let(:app) do
-    Class.new(Grape::API) do
-      get do
-        { message: 'hello world' }
-      end
-
-      add_swagger_documentation format: :json
-    end
-  end
-
-  subject do
-    get '/swagger_doc'
-    JSON.parse(last_response.body)['paths']
-  end
-
-  specify { expect(app.combined_routes.keys).to include '/' }
-  specify { expect(subject.keys).to include '/' }
-end

data/spec/issues/650_params_array_spec.rb

@@ -1,59 +0,0 @@
-# frozen_string_literal: true
-
-require 'spec_helper'
-
-describe '#605 Group Params as Array' do
-  let(:app) do
-    Class.new(Grape::API) do
-      params do
-        requires :array_of_range_string, type: [String], values: %w[a b c]
-        requires :array_of_range_integer, type: [Integer], values: [1, 2, 3]
-      end
-      post '/array_of_range' do
-        { 'declared_params' => declared(params) }
-      end
-
-      params do
-        requires :array_with_default_string, type: [String], default: 'abc'
-        requires :array_with_default_integer, type: Array[Integer], default: 123
-      end
-      post '/array_with_default' do
-        { 'declared_params' => declared(params) }
-      end
-
-      add_swagger_documentation
-    end
-  end
-
-  describe 'retrieves the documentation for typed group range parameters' do
-    subject do
-      get '/swagger_doc/array_of_range'
-      JSON.parse(last_response.body)
-    end
-
-    specify do
-      expect(subject['paths']['/array_of_range']['post']['parameters']).to eql(
-        [
-          { 'in' => 'formData', 'name' => 'array_of_range_string', 'type' => 'array', 'items' => { 'type' => 'string', 'enum' => %w[a b c] }, 'required' => true },
-          { 'in' => 'formData', 'name' => 'array_of_range_integer', 'type' => 'array', 'items' => { 'type' => 'integer', 'format' => 'int32', 'enum' => [1, 2, 3] }, 'required' => true }
-        ]
-      )
-    end
-  end
-
-  describe 'retrieves the documentation for typed group parameters with default' do
-    subject do
-      get '/swagger_doc/array_with_default'
-      JSON.parse(last_response.body)
-    end
-
-    specify do
-      expect(subject['paths']['/array_with_default']['post']['parameters']).to eql(
-        [
-          { 'in' => 'formData', 'name' => 'array_with_default_string', 'type' => 'array', 'items' => { 'type' => 'string', 'default' => 'abc' }, 'required' => true },
-          { 'in' => 'formData', 'name' => 'array_with_default_integer', 'type' => 'array', 'items' => { 'type' => 'integer', 'format' => 'int32', 'default' => 123 }, 'required' => true }
-        ]
-      )
-    end
-  end
-end

data/spec/issues/677_consumes_produces_add_swagger_documentation_options_spec.rb

@@ -1,100 +0,0 @@
-# frozen_string_literal: true
-
-require 'spec_helper'
-
-describe '#677 consumes and produces options are included in add_swagger_documentation options' do
-  describe 'no override' do
-    let(:app) do
-      Class.new(Grape::API) do
-        resource :accounts do
-          route_param :account_number, type: String do
-            resource :records do
-              route_param :id do
-                post do
-                  { message: 'hello world' }
-                end
-              end
-            end
-          end
-        end
-
-        add_swagger_documentation \
-          format: :json
-      end
-    end
-
-    subject do
-      get '/swagger_doc'
-      JSON.parse(last_response.body)
-    end
-
-    specify do
-      expect(subject['paths']['/accounts/{account_number}/records/{id}']['post']['produces']).to eq ['application/json']
-      expect(subject['paths']['/accounts/{account_number}/records/{id}']['post']['consumes']).to eq ['application/json']
-    end
-  end
-
-  describe 'override produces' do
-    let(:app) do
-      Class.new(Grape::API) do
-        resource :accounts do
-          route_param :account_number, type: String do
-            resource :records do
-              route_param :id do
-                post do
-                  { message: 'hello world' }
-                end
-              end
-            end
-          end
-        end
-
-        add_swagger_documentation \
-          format: :json,
-          produces: ['text/plain']
-      end
-    end
-
-    subject do
-      get '/swagger_doc'
-      JSON.parse(last_response.body)
-    end
-
-    specify do
-      expect(subject['paths']['/accounts/{account_number}/records/{id}']['post']['produces']).to eq ['text/plain']
-      expect(subject['paths']['/accounts/{account_number}/records/{id}']['post']['consumes']).to eq ['application/json']
-    end
-  end
-
-  describe 'override consumes' do
-    let(:app) do
-      Class.new(Grape::API) do
-        resource :accounts do
-          route_param :account_number, type: String do
-            resource :records do
-              route_param :id do
-                post do
-                  { message: 'hello world' }
-                end
-              end
-            end
-          end
-        end
-
-        add_swagger_documentation \
-          format: :json, \
-          consumes: ['application/json', 'application/x-www-form-urlencoded']
-      end
-    end
-
-    subject do
-      get '/swagger_doc'
-      JSON.parse(last_response.body)
-    end
-
-    specify do
-      expect(subject['paths']['/accounts/{account_number}/records/{id}']['post']['produces']).to eq ['application/json']
-      expect(subject['paths']['/accounts/{account_number}/records/{id}']['post']['consumes']).to eq ['application/json', 'application/x-www-form-urlencoded']
-    end
-  end
-end

data/spec/issues/680_keep_204_error_schemas_spec.rb

@@ -1,55 +0,0 @@
-# frozen_string_literal: true
-
-require 'spec_helper'
-
-describe 'when the main endpoint response is a 204 all error schemas are lost' do
-  let(:app) do
-    Class.new(Grape::API) do
-      namespace :issue_680 do
-        desc 'delete something',
-             is_array: true,
-             success: { status: 204 },
-             failure: [
-               [401, 'Unauthorized', Entities::ApiError],
-               [403, 'Forbidden', Entities::ApiError],
-               [404, 'Not Found', Entities::ApiError]
-             ]
-
-        delete do
-          status 204
-        end
-      end
-
-      add_swagger_documentation format: :json
-    end
-  end
-
-  subject do
-    get '/swagger_doc'
-    JSON.parse(last_response.body)
-  end
-
-  context 'when an endpoint can return a 204' do
-    let(:responses) { subject['paths']['/issue_680']['delete']['responses'] }
-
-    it 'returns the description but not a schema for a 204 response' do
-      expect(responses['204']['description']).to eq('delete something')
-      expect(responses['204']['schema']).to be_nil
-    end
-
-    it 'returns a description AND a schema for a 401 response' do
-      expect(responses['401']['description']).to eq('Unauthorized')
-      expect(responses['401']['schema']).to_not be_nil
-    end
-
-    it 'returns a description AND a schema for a 403 response' do
-      expect(responses['403']['description']).to eq('Forbidden')
-      expect(responses['403']['schema']).to_not be_nil
-    end
-
-    it 'returns a description AND a schema for a 404 response' do
-      expect(responses['404']['description']).to eq('Not Found')
-      expect(responses['404']['schema']).to_not be_nil
-    end
-  end
-end

data/spec/issues/751_deeply_nested_objects_spec.rb

@@ -1,190 +0,0 @@
-# frozen_string_literal: true
-
-require 'spec_helper'
-
-describe '751 deeply nested objects' do
-  let(:app) do
-    Class.new(Grape::API) do
-      content_type :json, 'application/json; charset=UTF-8'
-      default_format :json
-      class Vrp < Grape::API
-        def self.vrp_request_timewindow(this)
-          this.optional(:start, types: [String, Float, Integer])
-          this.optional(:end, types: [String, Float, Integer])
-        end
-
-        def self.vrp_request_point(this)
-          this.requires(:id, type: String, allow_blank: false)
-          this.optional(:matrix_index, type: Integer)
-          this.optional(:location, type: Hash) do
-            requires(:lat, type: Float, allow_blank: false)
-            requires(:lon, type: Float, allow_blank: false)
-          end
-          this.at_least_one_of :matrix_index, :location
-        end
-
-        def self.vrp_request_activity(this)
-          this.optional(:duration, types: [String, Float, Integer])
-          this.requires(:point_id, type: String, allow_blank: false)
-          this.optional(:timewindows, type: Array) do
-            Vrp.vrp_request_timewindow(self)
-          end
-        end
-
-        def self.vrp_request_service(this)
-          this.requires(:id, type: String, allow_blank: false)
-          this.optional(:skills, type: Array[String])
-
-          this.optional(:activity, type: Hash) do
-            Vrp.vrp_request_activity(self)
-          end
-          this.optional(:activities, type: Array) do
-            Vrp.vrp_request_activity(self)
-          end
-          this.mutually_exclusive :activity, :activities
-        end
-      end
-
-      namespace :vrp do
-        resource :submit do
-          desc 'Submit Problems', nickname: 'vrp'
-          params do
-            optional(:vrp, type: Hash, documentation: { param_type: 'body' }) do
-              optional(:points, type: Array) do
-                Vrp.vrp_request_point(self)
-              end
-
-              optional(:services, type: Array) do
-                Vrp.vrp_request_service(self)
-              end
-            end
-          end
-          post do
-            { vrp: params[:vrp] }.to_json
-          end
-        end
-      end
-
-      add_swagger_documentation format: :json
-    end
-  end
-
-  subject do
-    get '/swagger_doc'
-    JSON.parse(last_response.body)
-  end
-
-  describe 'Correctness of vrp Points' do
-    let(:get_points_response) { subject['definitions']['vrp']['properties']['vrp']['properties']['points'] }
-    specify do
-      expect(get_points_response).to eql(
-        'type' => 'array',
-        'items' => {
-          'type' => 'object',
-          'properties' => {
-            'id' => {
-              'type' => 'string'
-            },
-            'matrix_index' => {
-              'type' => 'integer',
-              'format' => 'int32'
-            },
-            'location' => {
-              'type' => 'object',
-              'properties' => {
-                'lat' => {
-                  'type' => 'number',
-                  'format' => 'float'
-                },
-                'lon' => {
-                  'type' => 'number',
-                  'format' => 'float'
-                }
-              },
-              'required' => %w[lat lon]
-            }
-          },
-          'required' => ['id']
-        }
-      )
-    end
-  end
-
-  describe 'Correctness of vrp Services' do
-    let(:get_service_response) { subject['definitions']['vrp']['properties']['vrp']['properties']['services'] }
-    specify do
-      expect(get_service_response).to include(
-        'type' => 'array',
-        'items' => {
-          'type' => 'object',
-          'properties' => {
-            'id' => {
-              'type' => 'string'
-            },
-            'skills' => {
-              'type' => 'array',
-              'items' => {
-                'type' => 'string'
-              }
-            },
-            'activity' => {
-              'type' => 'object',
-              'properties' => {
-                'duration' => {
-                  'type' => 'string'
-                },
-                'point_id' => {
-                  'type' => 'string'
-                },
-                'timewindows' => {
-                  'type' => 'array',
-                  'items' => {
-                    'type' => 'object',
-                    'properties' => {
-                      'start' => {
-                        'type' => 'string'
-                      },
-                      'end' => {
-                        'type' => 'string'
-                      }
-                    }
-                  }
-                }
-              },
-              'required' => ['point_id']
-            }, 'activities' => {
-              'type' => 'array',
-              'items' => {
-                'type' => 'object',
-                'properties' => {
-                  'duration' => {
-                    'type' => 'string'
-                  },
-                  'point_id' => {
-                    'type' => 'string'
-                  },
-                  'timewindows' => {
-                    'type' => 'array',
-                    'items' => {
-                      'type' => 'object',
-                      'properties' => {
-                        'start' => {
-                          'type' => 'string'
-                        },
-                        'end' => {
-                          'type' => 'string'
-                        }
-                      }
-                    }
-                  }
-                },
-                'required' => ['point_id']
-              }
-            }
-          },
-          'required' => ['id']
-        }
-      )
-    end
-  end
-end