grape-swagger 1.1.0 → 1.4.0

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.1.0'
+  VERSION = '1.4.0'
 end

data/spec/issues/427_entity_as_string_spec.rb

@@ -35,5 +35,5 @@ describe '#427 nested entity given as string' do
     JSON.parse(last_response.body)['definitions']
   end
 
-  specify { expect(subject.keys).to include 'RoleEntity', 'Permission::WithoutRole' }
+  specify { expect(subject.keys).to include 'RoleEntity', 'Permission_WithoutRole' }
 end

data/spec/issues/430_entity_definitions_spec.rb

@@ -55,6 +55,8 @@ describe 'definition names' do
             class Class7
               class SeventhEntity < Class6::SixthEntity
                 expose :seventh_thing
+
+                private_class_method :entity_name
               end
             end
           end
@@ -82,11 +84,11 @@ describe 'definition names' do
     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 '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 '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' }
+  specify { expect(subject).to include 'TestDefinition_DummyEntities_WithVeryLongName_AnotherGroupingModule_Class7_SeventhEntity' }
 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/data_type_spec.rb

@@ -49,6 +49,18 @@ describe GrapeSwagger::DocMethods::DataType do
     it { is_expected.to eq 'MyInteger' }
   end
 
+  describe 'Types in array with inherited entity_name' do
+    before do
+      stub_const 'EntityBase', Class.new
+      allow(EntityBase).to receive(:entity_name).and_return 'MyInteger'
+      stub_const 'MyEntity', Class.new(EntityBase)
+    end
+
+    let(:value) { { type: '[MyEntity]' } }
+
+    it { is_expected.to eq 'MyInteger' }
+  end
+
   describe 'Rack::Multipart::UploadedFile' do
     let(:value) { { type: Rack::Multipart::UploadedFile } }
 

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,12 +1,13 @@
 # frozen_string_literal: true
 
+# rubocop:disable Lint/EmptyClass
 class EmptyClass
 end
+# rubocop:enable Lint/EmptyClass
 
 module GrapeSwagger
   class EmptyModelParser
-    attr_reader :model
-    attr_reader :endpoint
+    attr_reader :model, :endpoint
 
     def initialize(model, endpoint)
       @model = model

data/spec/support/mock_parser.rb

@@ -2,8 +2,7 @@
 
 module GrapeSwagger
   class MockParser
-    attr_reader :model
-    attr_reader :endpoint
+    attr_reader :model, :endpoint
 
     def initialize(model, endpoint)
       @model = model

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'
         }
       }
     }

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
@@ -112,7 +128,7 @@ RSpec.shared_context 'mock swagger example' do
             'description' => "it's a mock"
           }
         },
-        'description' => 'This returns something'
+        'description' => 'ApiError model'
       },
       'UseItemResponseAsType' => {
         'type' => 'object',
@@ -122,7 +138,7 @@ RSpec.shared_context 'mock swagger example' do
             'description' => "it's a mock"
           }
         },
-        'description' => 'This returns something'
+        'description' => 'UseItemResponseAsType model'
       }
     }
   end
@@ -137,7 +153,7 @@ RSpec.shared_context 'mock swagger example' do
             'description' => "it's a mock"
           }
         },
-        'description' => 'This returns something'
+        'description' => 'UseResponse model'
       },
       'ApiError' => {
         'type' => 'object',
@@ -147,7 +163,7 @@ RSpec.shared_context 'mock swagger example' do
             'description' => "it's a mock"
           }
         },
-        'description' => 'This returns something'
+        'description' => 'ApiError model'
       }
     }
   end
@@ -162,7 +178,7 @@ RSpec.shared_context 'mock swagger example' do
             'description' => "it's a mock"
           }
         },
-        'description' => 'This returns something'
+        'description' => 'ApiError model'
       }
     }
   end
@@ -296,7 +312,7 @@ RSpec.shared_context 'mock swagger example' do
               'description' => "it's a mock"
             }
           },
-          'description' => 'nested route inside namespace'
+          'description' => 'QueryInput model'
         },
         'ApiError' => {
           'type' => 'object',
@@ -306,7 +322,7 @@ RSpec.shared_context 'mock swagger example' do
               'description' => "it's a mock"
             }
           },
-          'description' => 'This gets Things.'
+          'description' => 'ApiError model'
         },
         'Something' => {
           'type' => 'object',
@@ -316,7 +332,7 @@ RSpec.shared_context 'mock swagger example' do
               'description' => "it's a mock"
             }
           },
-          'description' => 'This gets Things.'
+          'description' => 'Something model'
         }
       }
     }