gitlab-grape-swagger 1.5.0

data/spec/issues/677_consumes_produces_add_swagger_documentation_options_spec.rb

@@ -0,0 +1,100 @@
+# 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

@@ -0,0 +1,55 @@
+# 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/721_set_default_parameter_location_based_on_consumes_spec.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe '#721 set default parameter location based on consumes' do
+  let(:app) do
+    Class.new(Grape::API) do
+      namespace :issue_721 do
+        desc 'create item' do
+          consumes ['application/json']
+        end
+
+        params do
+          requires :logs, type: String
+          optional :phone_number, type: Integer
+        end
+
+        post do
+          present params
+        end
+
+        desc 'modify item' do
+          consumes ['application/x-www-form-urlencoded']
+        end
+
+        params do
+          requires :id, type: Integer
+          requires :logs, type: String
+          optional :phone_number, type: Integer
+        end
+
+        put ':id' do
+          present params
+        end
+      end
+
+      add_swagger_documentation
+    end
+  end
+
+  subject do
+    get '/swagger_doc'
+    JSON.parse(last_response.body)
+  end
+
+  let(:post_parameters) { subject['paths']['/issue_721']['post']['parameters'] }
+  let(:post_schema) { subject['definitions']['postIssue721'] }
+  let(:put_parameters) { subject['paths']['/issue_721/{id}']['put']['parameters'] }
+
+  specify do
+    expect(post_parameters).to eql(
+      [{'in'=>'body', 'name'=>'postIssue721', 'required'=>true, 'schema'=>{'$ref'=>'#/definitions/postIssue721'}}]
+    )
+    expect(post_schema).to eql(
+      {'description'=>'create item', 'properties'=>{'logs'=>{'type'=>'string'}, 'phone_number'=>{'format'=>'int32', 'type'=>'integer'}}, 'required'=>['logs'], 'type'=>'object'}
+    )
+    puts put_parameters
+    expect(put_parameters).to eql(
+      [{'in'=>'path', 'name'=>'id', 'type'=>'integer', 'format'=>'int32', 'required'=>true}, {'in'=>'formData', 'name'=>'logs', 'type'=>'string', 'required'=>true}, {'in'=>'formData', 'name'=>'phone_number', 'type'=>'integer', 'format'=>'int32', 'required'=>false}]
+    )
+  end
+end

data/spec/issues/751_deeply_nested_objects_spec.rb

@@ -0,0 +1,190 @@
+# 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

data/spec/issues/776_multiple_presents_spec.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe '#776 multiple presents spec' do
+  include_context "#{MODEL_PARSER} swagger example"
+
+  let(:app) do
+    Class.new(Grape::API) do
+      namespace :issue_776 do
+        desc 'Get multiple presents',
+             success: [
+               { model: Entities::EnumValues, as: :gender },
+               { model: Entities::Something, as: :somethings, is_array: true, required: true }
+             ]
+
+        get do
+          present :gender, { number: 1, gender: 'Male' }, with: Entities::EnumValues
+          present :somethings, [
+            { id: 1, text: 'element_1', links: %w[link1 link2] },
+            { id: 2, text: 'element_2', links: %w[link1 link2] }
+          ], with: Entities::Something, is_array: true
+        end
+      end
+
+      add_swagger_documentation format: :json
+    end
+  end
+
+  subject do
+    get '/swagger_doc'
+    JSON.parse(last_response.body)
+  end
+
+  let(:definitions) { subject['definitions'] }
+  let(:schema) { subject['paths']['/issue_776']['get']['responses']['200']['schema'] }
+
+  specify { expect(definitions.keys).to include 'EnumValues', 'Something' }
+
+  specify do
+    expect(schema).to eql({
+      'properties' => {
+        'somethings' => {
+          'items' => {
+            '$ref' => '#/definitions/Something'
+          },
+          'type' => 'array'
+        },
+        'gender' => {
+          '$ref' => '#/definitions/EnumValues'
+        }
+      },
+      'type' => 'object',
+      'required' => [
+        'somethings'
+      ]
+    })
+  end
+end

data/spec/issues/784_extensions_on_params_spec.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe '#532 allow custom format' do
+  let(:app) do
+    Class.new(Grape::API) do
+      namespace :issue_784 do
+        desc 'issue_784' do
+          consumes ['application/x-www-form-urlencoded']
+        end
+
+        params do
+          requires :logs, type: String, documentation: { format: 'log', x: { name: 'Log' } }
+          optional :phone_number, type: Integer, documentation: { format: 'phone_number', x: { name: 'PhoneNumber' } }
+        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_784']['post']['parameters'] }
+
+  specify do
+    expect(parameters).to eql(
+      [
+        { 'in' => 'formData', 'name' => 'logs', 'type' => 'string', 'format' => 'log', 'required' => true, 'x-name' => 'Log' },
+        { 'in' => 'formData', 'name' => 'phone_number', 'type' => 'integer', 'format' => 'phone_number', 'required' => false, 'x-name' => 'PhoneNumber' }
+      ]
+    )
+  end
+end

data/spec/issues/809_utf8_routes_spec.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe '#605 root route documentation' do
+  let(:app) do
+    Class.new(Grape::API) do
+      resource :grunnbeløp do
+        desc 'returnerer grunnbeløp'
+        get do
+          { message: 'hello world' }
+        end
+      end
+
+      resource :εσόδων do
+        desc 'εσόδων'
+        get do
+          { message: 'hello world' }
+        end
+      end
+
+      resource :数 do
+        desc '数'
+        get do
+          { message: 'hello world' }
+        end
+      end
+
+      resource :amount do
+        desc 'returns amount'
+        get do
+          { message: 'hello world' }
+        end
+      end
+
+      resource :👍 do
+        desc 'returns 👍'
+        get do
+          { message: 'hello world' }
+        end
+      end
+
+      add_swagger_documentation
+    end
+  end
+
+  subject do
+    get '/swagger_doc'
+    JSON.parse(last_response.body)['paths']
+  end
+
+  specify do
+    expect(subject.keys).to match_array ['/grunnbeløp', '/amount', '/εσόδων', '/数']
+  end
+end

data/spec/issues/832_array_hash_float_decimal_spec.rb

@@ -0,0 +1,114 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe '#832 array of objects with nested Float/BigDecimal fields' do
+  let(:app) do
+    Class.new(Grape::API) do
+      resource :issue_832 do
+        desc 'issue_832' do
+          consumes ['application/x-www-form-urlencoded']
+        end
+        params do
+          requires :array_param, type: Array do
+            requires :float_param, type: Float
+            requires :big_decimal_param, type: BigDecimal
+            requires :object_param, type: Hash do
+              requires :float_param, type: Float
+              requires :big_decimal_param, type: BigDecimal
+              requires :object_param, type: Hash do
+                requires :float_param, type: Float
+                requires :big_decimal_param, type: BigDecimal
+                requires :array_param, type: Array do
+                  requires :integer_param, type: Integer
+                end
+              end
+            end
+          end
+        end
+        post do
+          {  message: 'hello world' }
+        end
+      end
+
+      add_swagger_documentation
+    end
+  end
+  let(:parameters) { subject['paths']['/issue_832']['post']['parameters'] }
+
+  subject do
+    get '/swagger_doc'
+    JSON.parse(last_response.body)
+  end
+
+  specify do
+    expect(parameters).to eql(
+      [
+        {
+          'in' => 'formData',
+          'name' => 'array_param[float_param]',
+          'type' => 'array',
+          'required' => true,
+          'items' => {
+            'type' => 'number',
+            'format' => 'float'
+          }
+        }, {
+          'in' => 'formData',
+          'name' => 'array_param[big_decimal_param]',
+          'type' => 'array',
+          'required' => true,
+          'items' => {
+            'type' => 'number',
+            'format' => 'double'
+          }
+        }, {
+          'in' => 'formData',
+          'name' => 'array_param[object_param][float_param]',
+          'type' => 'array',
+          'required' => true,
+          'items' => {
+            'type' => 'number',
+            'format' => 'float'
+          }
+        }, {
+          'in' => 'formData',
+          'name' => 'array_param[object_param][big_decimal_param]',
+          'type' => 'array',
+          'required' => true,
+          'items' => {
+            'type' => 'number',
+            'format' => 'double'
+          }
+        }, {
+          'in' => 'formData',
+          'name' => 'array_param[object_param][object_param][float_param]',
+          'type' => 'array',
+          'required' => true,
+          'items' => {
+            'type' => 'number',
+            'format' => 'float'
+          }
+        }, {
+          'in' => 'formData',
+          'name' => 'array_param[object_param][object_param][big_decimal_param]',
+          'type' => 'array',
+          'required' => true,
+          'items' => {
+            'type' => 'number',
+            'format' => 'double'
+          }
+        }, {
+          'in' => 'formData',
+          'name' => 'array_param[object_param][object_param][array_param][integer_param]',
+          'type' => 'array',
+          'required' => true,
+          'items' => {
+            'type' => 'integer',
+            'format' => 'int32'
+          }
+        }
+      ]
+    )
+  end
+end