grape-swagger 1.3.0 → 1.4.2

data/lib/grape-swagger.rb

@@ -29,7 +29,10 @@ module SwaggerRouting
       route_match = route_path.split(/^.*?#{route.prefix}/).last
       next unless route_match
 
-      route_match = route_match.match('\/([\w|-]*?)[\.\/\(]') || route_match.match('\/([\w|-]*)$')
+      # want to match emojis … ;)
+      # route_match = route_match
+      #   .match('\/([\p{Alnum}|\p{Emoji}|\-|\_]*?)[\.\/\(]') || route_match.match('\/([\p{Alpha}|\p{Emoji}|\-|\_]*)$')
+      route_match = route_match.match('\/([\p{Alnum}|\-|\_]*?)[\.\/\(]') || route_match.match('\/([\p{Alpha}|\-|\_]*)$')
       next unless route_match
 
       resource = route_match.captures.first
@@ -85,7 +88,7 @@ module SwaggerRouting
     route_name = name.match(%r{^/?([^/]*).*$})[1]
     return route_name unless route_name.include? ':'
 
-    matches = name.match(/\/[a-z]+/)
+    matches = name.match(/\/\p{Alpha}+/)
     matches.nil? ? route_name : matches[0].delete('/')
   end
 

data/spec/issues/537_enum_values_spec.rb

@@ -15,6 +15,7 @@ describe '#537 enum values spec' do
         desc 'create account',
              success: Spec
         get do
+          { message: 'hi' }
         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/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,111 @@
+# 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
+        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

data/spec/lib/format_data_spec.rb

@@ -87,5 +87,29 @@ describe GrapeSwagger::DocMethods::FormatData do
         expect(subject.to_format(params)).to eq expected_params
       end
     end
+
+    context 'when array params are not related' do
+      let(:params) do
+        [
+          { name: 'id', required: true, type: 'string' },
+          { name: 'description', required: false, type: 'string' },
+          { name: 'ids[]', required: true, type: 'array', items: { type: 'string' } },
+          { name: 'user_ids[]', required: true, type: 'array', items: { type: 'string' } }
+        ]
+      end
+
+      let(:expected_params) do
+        [
+          { name: 'id', required: true, type: 'string' },
+          { name: 'description', required: false, type: 'string' },
+          { name: 'ids[]', required: true, type: 'array', items: { type: 'string' } },
+          { name: 'user_ids[]', required: true, type: 'array', items: { type: 'string' } }
+        ]
+      end
+
+      it 'parses params correctly and adds array type all concerned elements' do
+        expect(subject.to_format(params)).to eq expected_params
+      end
+    end
   end
 end

data/spec/spec_helper.rb

@@ -19,7 +19,7 @@ MODEL_PARSER = ENV.key?('MODEL_PARSER') ? ENV['MODEL_PARSER'].to_s.downcase.sub(
 require 'grape'
 require 'grape-swagger'
 
-Dir[File.join(Dir.getwd, 'spec/support/*.rb')].sort.each { |f| require f }
+Dir[File.join(Dir.getwd, 'spec/support/*.rb')].each { |f| require f }
 require "grape-swagger/#{MODEL_PARSER}" if MODEL_PARSER != 'mock'
 require File.join(Dir.getwd, "spec/support/model_parsers/#{MODEL_PARSER}_parser.rb")
 

data/spec/support/empty_model_parser.rb

@@ -1,7 +1,9 @@
 # frozen_string_literal: true
 
+# rubocop:disable Lint/EmptyClass
 class EmptyClass
 end
+# rubocop:enable Lint/EmptyClass
 
 module GrapeSwagger
   class EmptyModelParser

data/spec/support/model_parsers/mock_parser.rb

@@ -40,21 +40,37 @@ RSpec.shared_context 'mock swagger example' do
       end
 
       class UseNestedWithAddress < OpenStruct; end
+
       class TypedDefinition < OpenStruct; end
+
       class UseItemResponseAsType < OpenStruct; end
+
       class OtherItem < OpenStruct; end
+
       class EnumValues < OpenStruct; end
+
       class AliasedThing < OpenStruct; end
+
       class FourthLevel < OpenStruct; end
+
       class ThirdLevel < OpenStruct; end
+
       class SecondLevel < OpenStruct; end
+
       class FirstLevel < OpenStruct; end
+
       class QueryInputElement < OpenStruct; end
+
       class QueryInput < OpenStruct; end
+
       class ApiError < OpenStruct; end
+
       class SecondApiError < OpenStruct; end
+
       class RecursiveModel < OpenStruct; end
+
       class DocumentedHashAndArrayModel < OpenStruct; end
+
       module NestedModule
         class ApiResponse < OpenStruct; end
       end

data/spec/support/namespace_tags.rb

@@ -3,12 +3,15 @@
 RSpec.shared_context 'namespace example' do
   before :all do
     module TheApi
+      # rubocop:disable Lint/EmptyClass
       class CustomType; end
+      # rubocop:enable Lint/EmptyClass
 
       class NamespaceApi < Grape::API
         namespace :hudson do
           desc 'Document root'
           get '/' do
+            { message: 'hi' }
           end
         end
 

data/spec/support/the_paths_definitions.rb

@@ -8,7 +8,7 @@ RSpec.shared_context 'the api paths/defs' do
           produces: ['application/json'],
           consumes: ['application/json'],
           parameters: [
-            { in: 'body', name: 'in_body_1', description: 'in_body_1', type: 'integer', format: 'int32', required: true },
+            { in: 'body', name: 'in_body_1', description: 'in_body_1', type: 'integer', format: 'int32', required: true, example: 23 },
             { in: 'body', name: 'in_body_2', description: 'in_body_2', type: 'string', required: false },
             { in: 'body', name: 'in_body_3', description: 'in_body_3', type: 'string', required: false }
           ],
@@ -31,7 +31,7 @@ RSpec.shared_context 'the api paths/defs' do
             { in: 'path', name: 'key', description: nil, type: 'integer', format: 'int32', required: true },
             { in: 'body', name: 'in_body_1', description: 'in_body_1', type: 'integer', format: 'int32', required: true },
             { in: 'body', name: 'in_body_2', description: 'in_body_2', type: 'string', required: false },
-            { in: 'body', name: 'in_body_3', description: 'in_body_3', type: 'string', required: false }
+            { in: 'body', name: 'in_body_3', description: 'in_body_3', type: 'string', required: false, example: 'my example string' }
           ],
           responses: { 200 => { description: 'put in body /wo entity', schema: { '$ref' => '#/definitions/InBody' } } },
           tags: ['in_body'],
@@ -85,7 +85,7 @@ RSpec.shared_context 'the api paths/defs' do
     {
       type: 'object',
       properties: {
-        in_body_1: { type: 'integer', format: 'int32', description: 'in_body_1' },
+        in_body_1: { type: 'integer', format: 'int32', description: 'in_body_1', example: 23 },
         in_body_2: { type: 'string', description: 'in_body_2' },
         in_body_3: { type: 'string', description: 'in_body_3' }
       },
@@ -99,7 +99,7 @@ RSpec.shared_context 'the api paths/defs' do
       properties: {
         in_body_1: { type: 'integer', format: 'int32', description: 'in_body_1' },
         in_body_2: { type: 'string', description: 'in_body_2' },
-        in_body_3: { type: 'string', description: 'in_body_3' }
+        in_body_3: { type: 'string', description: 'in_body_3', example: 'my example string' }
       },
       required: [:in_body_1]
     }

data/spec/swagger_v2/api_swagger_v2_additional_properties_spec.rb

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe 'parsing additional_parameters' do
+  let(:app) do
+    Class.new(Grape::API) do
+      namespace :things do
+        class Element < Grape::Entity
+          expose :id
+        end
+
+        params do
+          optional :closed, type: Hash, documentation: { additional_properties: false, in: 'body' } do
+            requires :only
+          end
+          optional :open, type: Hash, documentation: { additional_properties: true }
+          optional :type_limited, type: Hash, documentation: { additional_properties: String }
+          optional :ref_limited, type: Hash, documentation: { additional_properties: Element }
+          optional :fallback, type: Hash, documentation: { additional_properties: { type: 'integer' } }
+        end
+        post do
+          present params
+        end
+      end
+
+      add_swagger_documentation format: :json, models: [Element]
+    end
+  end
+
+  subject do
+    get '/swagger_doc/things'
+    JSON.parse(last_response.body)
+  end
+
+  describe 'POST' do
+    specify do
+      expect(subject.dig('paths', '/things', 'post', 'parameters')).to eql(
+        [
+          { 'name' => 'Things', 'in' => 'body', 'required' => true, 'schema' => { '$ref' => '#/definitions/postThings' } }
+        ]
+      )
+    end
+
+    specify do
+      expect(subject.dig('definitions', 'postThings')).to eql(
+        'type' => 'object',
+        'properties' => {
+          'closed' => {
+            'type' => 'object',
+            'additionalProperties' => false,
+            'properties' => {
+              'only' => { 'type' => 'string' }
+            },
+            'required' => ['only']
+          },
+          'open' => {
+            'type' => 'object',
+            'additionalProperties' => true
+          },
+          'type_limited' => {
+            'type' => 'object',
+            'additionalProperties' => {
+              'type' => 'string'
+            }
+          },
+          'ref_limited' => {
+            'type' => 'object',
+            'additionalProperties' => {
+              '$ref' => '#/definitions/Element'
+            }
+          },
+          'fallback' => {
+            'type' => 'object',
+            'additionalProperties' => {
+              'type' => 'integer'
+            }
+          }
+        }
+      )
+    end
+  end
+end

data/spec/swagger_v2/api_swagger_v2_mounted_spec.rb

@@ -81,6 +81,7 @@ describe 'swagger spec v2.0' do
           requires :id, type: Integer
         end
         delete '/dummy/:id' do
+          {}
         end
 
         namespace :other_thing do

data/spec/swagger_v2/api_swagger_v2_param_type_body_nested_spec.rb

@@ -13,7 +13,7 @@ describe 'moving body/formData Params to definitions' do
                detail: 'more details description',
                success: Entities::UseNestedWithAddress
           params do
-            optional :contact, type: Hash do
+            optional :contact, type: Hash, documentation: { additional_properties: true } do
               requires :name, type: String, documentation: { desc: 'name', in: 'body' }
               optional :addresses, type: Array do
                 requires :street, type: String, documentation: { desc: 'street', in: 'body' }
@@ -96,6 +96,27 @@ describe 'moving body/formData Params to definitions' do
           end
         end
 
+        namespace :nested_params_array do
+          desc 'post in body with array of nested parameters',
+               detail: 'more details description',
+               success: Entities::UseNestedWithAddress
+          params do
+            optional :contacts, type: Array, documentation: { additional_properties: false } do
+              requires :name, type: String, documentation: { desc: 'name', in: 'body' }
+              optional :addresses, type: Array do
+                requires :street, type: String, documentation: { desc: 'street', in: 'body' }
+                requires :postcode, type: String, documentation: { desc: 'postcode', in: 'body' }
+                requires :city, type: String, documentation: { desc: 'city', in: 'body' }
+                optional :country, type: String, documentation: { desc: 'country', in: 'body' }
+              end
+            end
+          end
+
+          post '/in_body' do
+            { 'declared_params' => declared(params) }
+          end
+        end
+
         add_swagger_documentation
       end
     end
@@ -126,6 +147,7 @@ describe 'moving body/formData Params to definitions' do
           'properties' => {
             'contact' => {
               'type' => 'object',
+              'additionalProperties' => true,
               'properties' => {
                 'name' => { 'type' => 'string', 'description' => 'name' },
                 'addresses' => {
@@ -280,4 +302,54 @@ describe 'moving body/formData Params to definitions' do
       end
     end
   end
+
+  describe 'array of nested body parameters given' do
+    subject do
+      get '/swagger_doc/nested_params_array'
+      JSON.parse(last_response.body)
+    end
+
+    describe 'POST' do
+      specify do
+        expect(subject['paths']['/nested_params_array/in_body']['post']['parameters']).to eql(
+          [
+            { 'name' => 'NestedParamsArrayInBody', 'in' => 'body', 'required' => true, 'schema' => { '$ref' => '#/definitions/postNestedParamsArrayInBody' } }
+          ]
+        )
+      end
+
+      specify do
+        expect(subject['definitions']['postNestedParamsArrayInBody']).to eql(
+          'type' => 'object',
+          'properties' => {
+            'contacts' => {
+              'type' => 'array',
+              'items' => {
+                'type' => 'object',
+                'additionalProperties' => false,
+                'properties' => {
+                  'name' => { 'type' => 'string', 'description' => 'name' },
+                  'addresses' => {
+                    'type' => 'array',
+                    'items' => {
+                      'type' => 'object',
+                      'properties' => {
+                        'street' => { 'type' => 'string', 'description' => 'street' },
+                        'postcode' => { 'type' => 'string', 'description' => 'postcode' },
+                        'city' => { 'type' => 'string', 'description' => 'city' },
+                        'country' => { 'type' => 'string', 'description' => 'country' }
+                      },
+                      'required' => %w[street postcode city]
+                    }
+                  }
+                },
+                'required' => %w[name]
+              }
+            }
+          },
+          'description' => 'post in body with array of nested parameters'
+        )
+      end
+    end
+  end
 end

data/spec/swagger_v2/api_swagger_v2_response_with_headers_spec.rb

@@ -19,7 +19,8 @@ describe 'response with headers' do
         end
 
         desc 'A 204 can have headers too' do
-          success Hash[status: 204, message: 'No content', headers: { 'Location' => { description: 'Location of resource', type: 'string' } }]
+          foo = { status: 204, message: 'No content', headers: { 'Location' => { description: 'Location of resource', type: 'string' } } }
+          success foo
           failure [[400, 'Bad Request', Entities::ApiError, { 'application/json' => { code: 400, message: 'Bad request' } }, { 'Date' => { description: 'Date of failure', type: 'string' } }]]
         end
         delete '/no_content_response_headers' do
@@ -27,7 +28,8 @@ describe 'response with headers' do
         end
 
         desc 'A file can have headers too' do
-          success Hash[status: 200, model: 'File', headers: { 'Cache-Control' => { description: 'Directive for caching', type: 'string' } }]
+          foo = { status: 200, model: 'File', headers: { 'Cache-Control': { description: 'Directive for caching', type: 'string' } } }
+          success foo
           failure [[404, 'NotFound', Entities::ApiError, { 'application/json' => { code: 404, message: 'Not found' } }, { 'Date' => { description: 'Date of failure', type: 'string' } }]]
         end
         get '/file_response_headers' do

data/spec/swagger_v2/api_swagger_v2_spec.rb

@@ -80,6 +80,7 @@ describe 'swagger spec v2.0' do
         requires :id, type: Integer
       end
       delete '/dummy/:id' do
+        {}
       end
 
       namespace :other_thing do

data/spec/swagger_v2/boolean_params_spec.rb

@@ -9,8 +9,10 @@ describe 'Boolean Params' do
 
       params do
         requires :a_boolean, type: Grape::API::Boolean
+        optional :another_boolean, type: Grape::API::Boolean, default: false
       end
       post :splines do
+        { message: 'hi' }
       end
 
       add_swagger_documentation
@@ -26,7 +28,8 @@ describe 'Boolean Params' do
 
   it 'converts boolean types' do
     expect(subject).to eq [
-      { 'in' => 'formData', 'name' => 'a_boolean', 'type' => 'boolean', 'required' => true }
+      { 'in' => 'formData', 'name' => 'a_boolean', 'type' => 'boolean', 'required' => true },
+      { 'in' => 'formData', 'name' => 'another_boolean', 'type' => 'boolean', 'required' => false, 'default' => false }
     ]
   end
 end

data/spec/swagger_v2/float_api_spec.rb

@@ -11,6 +11,7 @@ describe 'Float Params' do
         requires :a_float, type: Float
       end
       post :splines do
+        { message: 'hi' }
       end
 
       add_swagger_documentation

data/spec/swagger_v2/inheritance_and_discriminator_spec.rb

@@ -33,6 +33,7 @@ describe 'Inheritance and Discriminator' do
           }
         end
       end
+
       class NameApi < Grape::API
         add_swagger_documentation models: [Entities::Pet, Entities::Cat]
       end

data/spec/swagger_v2/namespace_tags_prefix_spec.rb

@@ -17,6 +17,7 @@ describe 'namespace tags check while using prefix and version' do
         namespace :hudson do
           desc 'Document root'
           get '/' do
+            { message: 'hi' }
           end
         end