grape-swagger 1.2.1 → 1.4.1

data/lib/grape-swagger/endpoint.rb

@@ -11,7 +11,7 @@ module Grape
 
       if content_types.empty?
         formats       = [target_class.format, target_class.default_format].compact.uniq
-        formats       = Grape::Formatter.formatters({}).keys if formats.empty?
+        formats       = Grape::Formatter.formatters(**{}).keys if formats.empty?
         content_types = Grape::ContentTypes::CONTENT_TYPES.select do |content_type, _mime_type|
           formats.include? content_type
         end.values
@@ -78,11 +78,11 @@ module Grape
     def path_and_definition_objects(namespace_routes, options)
       @paths = {}
       @definitions = {}
+      add_definitions_from options[:models]
       namespace_routes.each_value do |routes|
         path_item(routes, options)
       end
 
-      add_definitions_from options[:models]
       [@paths, @definitions]
     end
 
@@ -201,26 +201,26 @@ module Grape
     def response_object(route, options)
       codes(route).each_with_object({}) do |value, memo|
         value[:message] ||= ''
-        memo[value[:code]] = { description: value[:message] }
-
+        memo[value[:code]] = { description: value[:message] ||= '' } unless memo[value[:code]].present?
         memo[value[:code]][:headers] = value[:headers] if value[:headers]
 
         next build_file_response(memo[value[:code]]) if file_response?(value[:model])
 
-        response_model = @item
-        response_model = expose_params_from_model(value[:model]) if value[:model]
-
         if memo.key?(200) && route.request_method == 'DELETE' && value[:model].nil?
           memo[204] = memo.delete(200)
           value[:code] = 204
+          next
         end
 
-        next if value[:code] == 204
-        next unless !response_model.start_with?('Swagger_doc') && (@definitions[response_model] || value[:model])
+        # Explicitly request no model with { model: '' }
+        next if value[:model] == ''
 
-        @definitions[response_model][:description] = description_object(route)
+        response_model = value[:model] ? expose_params_from_model(value[:model]) : @item
+        next unless @definitions[response_model]
+        next if response_model.start_with?('Swagger_doc')
 
-        memo[value[:code]][:schema] = build_reference(route, value, response_model, options)
+        @definitions[response_model][:description] ||= "#{response_model} model"
+        build_memo_schema(memo, route, value, response_model, options)
         memo[value[:code]][:examples] = value[:examples] if value[:examples]
       end
     end
@@ -267,15 +267,52 @@ module Grape
 
     private
 
+    def build_memo_schema(memo, route, value, response_model, options)
+      if memo[value[:code]][:schema] && value[:as]
+        memo[value[:code]][:schema][:properties].merge!(build_reference(route, value, response_model, options))
+
+        if value[:required]
+          memo[value[:code]][:schema][:required] ||= []
+          memo[value[:code]][:schema][:required] << value[:as].to_s
+        end
+
+      elsif value[:as]
+        memo[value[:code]][:schema] = {
+          type: :object,
+          properties: build_reference(route, value, response_model, options)
+        }
+        memo[value[:code]][:schema][:required] = [value[:as].to_s] if value[:required]
+      else
+        memo[value[:code]][:schema] = build_reference(route, value, response_model, options)
+      end
+    end
+
     def build_reference(route, value, response_model, settings)
       # TODO: proof that the definition exist, if model isn't specified
-      reference = { '$ref' => "#/definitions/#{response_model}" }
+      reference = if value.key?(:as)
+                    { value[:as] => build_reference_hash(response_model) }
+                  else
+                    build_reference_hash(response_model)
+                  end
       return reference unless value[:code] < 300
 
-      reference = { type: 'array', items: reference } if route.options[:is_array]
+      if value.key?(:as) && value.key?(:is_array)
+        reference[value[:as]] = build_reference_array(reference[value[:as]])
+      elsif route.options[:is_array]
+        reference = build_reference_array(reference)
+      end
+
       build_root(route, reference, response_model, settings)
     end
 
+    def build_reference_hash(response_model)
+      { '$ref' => "#/definitions/#{response_model}" }
+    end
+
+    def build_reference_array(reference)
+      { type: 'array', items: reference }
+    end
+
     def build_root(route, reference, response_model, settings)
       default_root = response_model.underscore
       default_root = default_root.pluralize if route.options[:is_array]
@@ -292,7 +329,7 @@ module Grape
     end
 
     def file_response?(value)
-      value.to_s.casecmp('file').zero? ? true : false
+      value.to_s.casecmp('file').zero?
     end
 
     def build_file_response(memo)
@@ -364,7 +401,7 @@ module Grape
     end
 
     def hidden_parameter?(value)
-      return false if value.dig(:required)
+      return false if value[:required]
 
       if value.dig(:documentation, :hidden).is_a?(Proc)
         value.dig(:documentation, :hidden).call
@@ -381,6 +418,9 @@ module Grape
         default_code[:message] = entity[:message] || route.description || default_code[:message].sub('{item}', @item)
         default_code[:examples] = entity[:examples] if entity[:examples]
         default_code[:headers] = entity[:headers] if entity[:headers]
+        default_code[:as] = entity[:as] if entity[:as]
+        default_code[:is_array] = entity[:is_array] if entity[:is_array]
+        default_code[:required] = entity[:required] if entity[:required]
       else
         default_code = GrapeSwagger::DocMethods::StatusCodes.get[route.request_method.downcase.to_sym]
         default_code[:model] = entity if entity

data/lib/grape-swagger/errors.rb

@@ -3,7 +3,9 @@
 module GrapeSwagger
   module Errors
     class UnregisteredParser < StandardError; end
+
     class SwaggerSpec < StandardError; end
+
     class SwaggerSpecDeprecated < SwaggerSpec
       class << self
         def tell!(what)

data/lib/grape-swagger/model_parsers.rb

@@ -16,14 +16,14 @@ module GrapeSwagger
       subhash = @parsers.except(klass).to_a
       insert_at = subhash.index(subhash.assoc(before_klass))
       insert_at = subhash.length - 1 if insert_at.nil?
-      @parsers = Hash[subhash.insert(insert_at, [klass, ancestor])]
+      @parsers = subhash.insert(insert_at, [klass, ancestor]).to_h
     end
 
     def insert_after(after_klass, klass, ancestor)
       subhash = @parsers.except(klass).to_a
       insert_at = subhash.index(subhash.assoc(after_klass))
       insert_at = subhash.length - 1 if insert_at.nil?
-      @parsers = Hash[subhash.insert(insert_at + 1, [klass, ancestor])]
+      @parsers = subhash.insert(insert_at + 1, [klass, ancestor]).to_h
     end
 
     def each

data/lib/grape-swagger/rake/oapi_tasks.rb

@@ -74,6 +74,7 @@ module GrapeSwagger
 
       # helper methods
       #
+      # rubocop:disable Style/StringConcatenation
       def make_request
         get url_for
 
@@ -83,6 +84,7 @@ module GrapeSwagger
           )
         ) + "\n"
       end
+      # rubocop:enable Style/StringConcatenation
 
       def url_for
         oapi_route = api_class.routes[-2]

data/lib/grape-swagger/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module GrapeSwagger
-  VERSION = '1.2.1'
+  VERSION = '1.4.1'
 end

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/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/lib/move_params_spec.rb

@@ -97,7 +97,7 @@ describe GrapeSwagger::DocMethods::MoveParams do
     let(:route_options) { { requirements: {} } }
     describe 'POST' do
       let(:params) { paths[path][:post][:parameters] }
-      let(:route) { Grape::Router::Route.new('POST', path.dup, route_options) }
+      let(:route) { Grape::Router::Route.new('POST', path.dup, **route_options) }
 
       specify do
         subject.to_definition(path, params, route, definitions)
@@ -113,7 +113,7 @@ describe GrapeSwagger::DocMethods::MoveParams do
 
     describe 'POST' do
       let(:params) { paths['/in_body/{key}'][:put][:parameters] }
-      let(:route) { Grape::Router::Route.new('PUT', path.dup, route_options) }
+      let(:route) { Grape::Router::Route.new('PUT', path.dup, **route_options) }
 
       specify do
         subject.to_definition(path, params, route, definitions)

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/entity_parser.rb

@@ -145,23 +145,23 @@ RSpec.shared_context 'entity swagger example' do
 
   let(:swagger_nested_type) do
     {
-      'ApiError' => { 'type' => 'object', 'properties' => { 'code' => { 'type' => 'integer', 'format' => 'int32', 'description' => 'status code' }, 'message' => { 'type' => 'string', 'description' => 'error message' } }, 'description' => 'This returns something' },
+      'ApiError' => { 'type' => 'object', 'properties' => { 'code' => { 'type' => 'integer', 'format' => 'int32', 'description' => 'status code' }, 'message' => { 'type' => 'string', 'description' => 'error message' } }, 'description' => 'ApiError model' },
       'ResponseItem' => { 'type' => 'object', 'properties' => { 'id' => { 'type' => 'integer', 'format' => 'int32' }, 'name' => { 'type' => 'string' } } },
-      'UseItemResponseAsType' => { 'type' => 'object', 'properties' => { 'description' => { 'type' => 'string' }, 'responses' => { '$ref' => '#/definitions/ResponseItem' } }, 'description' => 'This returns something' }
+      'UseItemResponseAsType' => { 'type' => 'object', 'properties' => { 'description' => { 'type' => 'string' }, 'responses' => { '$ref' => '#/definitions/ResponseItem' } }, 'description' => 'UseItemResponseAsType model' }
     }
   end
 
   let(:swagger_entity_as_response_object) do
     {
-      'ApiError' => { 'type' => 'object', 'properties' => { 'code' => { 'type' => 'integer', 'format' => 'int32', 'description' => 'status code' }, 'message' => { 'type' => 'string', 'description' => 'error message' } }, 'description' => 'This returns something' },
+      'ApiError' => { 'type' => 'object', 'properties' => { 'code' => { 'type' => 'integer', 'format' => 'int32', 'description' => 'status code' }, 'message' => { 'type' => 'string', 'description' => 'error message' } }, 'description' => 'ApiError model' },
       'ResponseItem' => { 'type' => 'object', 'properties' => { 'id' => { 'type' => 'integer', 'format' => 'int32' }, 'name' => { 'type' => 'string' } } },
-      'UseResponse' => { 'type' => 'object', 'properties' => { 'description' => { 'type' => 'string' }, '$responses' => { 'type' => 'array', 'items' => { '$ref' => '#/definitions/ResponseItem' } } }, 'description' => 'This returns something' }
+      'UseResponse' => { 'type' => 'object', 'properties' => { 'description' => { 'type' => 'string' }, '$responses' => { 'type' => 'array', 'items' => { '$ref' => '#/definitions/ResponseItem' } } }, 'description' => 'UseResponse model' }
     }
   end
 
   let(:swagger_params_as_response_object) do
     {
-      'ApiError' => { 'type' => 'object', 'properties' => { 'code' => { 'description' => 'status code', 'type' => 'integer', 'format' => 'int32' }, 'message' => { 'description' => 'error message', 'type' => 'string' } }, 'description' => 'This returns something' }
+      'ApiError' => { 'type' => 'object', 'properties' => { 'code' => { 'description' => 'status code', 'type' => 'integer', 'format' => 'int32' }, 'message' => { 'description' => 'error message', 'type' => 'string' } }, 'description' => 'ApiError model' }
     }
   end
 
@@ -300,7 +300,7 @@ RSpec.shared_context 'entity swagger example' do
           'type' => 'object',
           'required' => ['elements'],
           'properties' => { 'elements' => { 'type' => 'array', 'items' => { '$ref' => '#/definitions/QueryInputElement' }, 'description' => 'Set of configuration' } },
-          'description' => 'nested route inside namespace'
+          'description' => 'QueryInput model'
         },
         'QueryInputElement' => {
           'type' => 'object',
@@ -310,7 +310,7 @@ RSpec.shared_context 'entity swagger example' do
         'ApiError' => {
           'type' => 'object',
           'properties' => { 'code' => { 'type' => 'integer', 'format' => 'int32', 'description' => 'status code' }, 'message' => { 'type' => 'string', 'description' => 'error message' } },
-          'description' => 'This gets Things.'
+          'description' => 'ApiError model'
         },
         'Something' => {
           'type' => 'object',
@@ -320,7 +320,7 @@ RSpec.shared_context 'entity swagger example' do
             'links' => { 'type' => 'array', 'items' => { 'type' => 'link' } },
             'others' => { 'type' => 'text' }
           },
-          'description' => 'This gets Things.'
+          'description' => 'Something model'
         }
       }
     }