Uses Ruby 2.7

- adepts specs
- changes method signature
- fixes grape version to 1.2.5

will be the last release to support it

Author: LeFnord

.rubocop.yml

@@ -4,26 +4,26 @@ AllCops:
   Exclude:
     - vendor/**/*
     - example/**/*
-  TargetRubyVersion: 2.6
+  TargetRubyVersion: 2.7
 
 Layout/EmptyLinesAroundArguments:
   Enabled: false
 
-Layout/IndentFirstHashElement:
+Layout/FirstHashElementIndentation:
   EnforcedStyle: consistent
 
+Layout/LineLength:
+  Max: 120
+  Exclude:
+    - spec/**/*
+
 Metrics/BlockLength:
   Exclude:
     - spec/**/*
 
 Metrics/ClassLength:
   Max: 300
 
-Metrics/LineLength:
-  Max: 120
-  Exclude:
-    - spec/**/*
-
 Metrics/MethodLength:
   Exclude:
     - spec/**/*

.travis.yml

@@ -7,25 +7,27 @@ after_success:
   - bundle exec danger
 
 rvm:
-  - 2.4.9
   - 2.5.7
   - 2.6.5
+  - 2.7.0
 env:
-  - MODEL_PARSER=grape-swagger-entity
-  - MODEL_PARSER=grape-swagger-representable
+  - GRAPE_VERSION=1.2.5 MODEL_PARSER=grape-swagger-entity
+  - GRAPE_VERSION=1.2.5 MODEL_PARSER=grape-swagger-representable
   - GRAPE_VERSION=1.0.3
-  - GRAPE_VERSION=1.2.4
-  - GRAPE_VERSION=HEAD
+  - GRAPE_VERSION=1.2.5
 
 matrix:
   fast_finish: true
 
   include:
+    - rvm: 2.4.9
+      env:
     - rvm: ruby-head
       env:
     - rvm: jruby-head
       env:
 
   allow_failures:
+    - rvm: 2.4.9
     - rvm: ruby-head
     - rvm: jruby-head

grape-swagger.gemspec

@@ -14,7 +14,7 @@ Gem::Specification.new do |s|
   s.license     = 'MIT'
 
   s.required_ruby_version = '>= 2.4'
-  s.add_runtime_dependency 'grape', '>= 0.16.2'
+  s.add_runtime_dependency 'grape', '>= 0.16.2', '<= 1.2.5'
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec}/*`.split("\n")

lib/grape-swagger/doc_methods/move_params.rb

@@ -8,7 +8,7 @@ class MoveParams
       class << self
         attr_accessor :definitions
 
-        def can_be_moved?(params, http_verb)
+        def can_be_moved?(http_verb, params)
           move_methods.include?(http_verb) && includes_body_param?(params)
         end
 

lib/grape-swagger/endpoint.rb

@@ -186,7 +186,7 @@ def params_object(route, options, path)
         GrapeSwagger::DocMethods::ParseParams.call(param, value, path, route, @definitions)
       end
 
-      if GrapeSwagger::DocMethods::MoveParams.can_be_moved?(parameters, route.request_method)
+      if GrapeSwagger::DocMethods::MoveParams.can_be_moved?(route.request_method, parameters)
         parameters = GrapeSwagger::DocMethods::MoveParams.to_definition(path, parameters, route, @definitions)
       end
 

spec/lib/move_params_spec.rb

@@ -40,27 +40,27 @@
     describe 'movable params' do
       specify 'allowed verbs' do
         allowed_verbs.each do |verb|
-          expect(subject.can_be_moved?(movable_params, verb)).to be true
+          expect(subject.can_be_moved?(verb, movable_params)).to be true
         end
       end
 
       specify 'not allowed verbs' do
         not_allowed_verbs.each do |verb|
-          expect(subject.can_be_moved?(movable_params, verb)).to be false
+          expect(subject.can_be_moved?(verb, movable_params)).to be false
         end
       end
     end
 
     describe 'not movable params' do
       specify 'allowed verbs' do
         allowed_verbs.each do |verb|
-          expect(subject.can_be_moved?(not_movable_params, verb)).to be false
+          expect(subject.can_be_moved?(verb, not_movable_params)).to be false
         end
       end
 
       specify 'not allowed verbs' do
         not_allowed_verbs.each do |verb|
-          expect(subject.can_be_moved?(not_movable_params, verb)).to be false
+          expect(subject.can_be_moved?(verb, not_movable_params)).to be false
         end
       end
     end

spec/spec_helper.rb

@@ -19,7 +19,7 @@
 require 'grape'
 require 'grape-swagger'
 
-Dir[File.join(Dir.getwd, 'spec/support/*.rb')].each { |f| require f }
+Dir[File.join(Dir.getwd, 'spec/support/*.rb')].sort.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")
 

spec/swagger_v2/description_not_initialized.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe 'has no description, if details or description are nil' do
+  include_context "#{MODEL_PARSER} swagger example"
+
+  before :all do
+    module TheApi
+      class GfmRcDetailApi < Grape::API
+        format :json
+
+        desc nil,
+             detail: nil,
+             entity: Entities::UseResponse,
+             failure: [{ code: 400, model: Entities::ApiError }]
+        get '/use_gfm_rc_detail' do
+          { 'declared_params' => declared(params) }
+        end
+
+        add_swagger_documentation
+      end
+    end
+  end
+
+  def app
+    TheApi::GfmRcDetailApi
+  end
+
+  subject do
+    get '/swagger_doc'
+    JSON.parse(last_response.body)
+  end
+
+  specify do
+    expect(subject['paths']['/use_gfm_rc_detail']['get']).not_to include('description')
+    expect(subject['paths']['/use_gfm_rc_detail']['get']['description']).to eql(nil)
+  end
+end

spec/swagger_v2/description_not_initialized_spec.rb

@@ -2,7 +2,7 @@
 
 require 'spec_helper'
 
-describe 'docs mounted separately from api' do
+xdescribe 'docs mounted separately from api' do
   before :all do
     class ActualApi < Grape::API
       desc 'Document root'

spec/swagger_v2/mounted_target_class_spec.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe 'a parent less namespace' do
+  include_context 'namespace example'
+
+  before :all do
+    class ParentLessApi < Grape::API
+      prefix :api
+      mount TheApi::ParentLessNamespaceApi
+      add_swagger_documentation version: 'v1'
+    end
+  end
+
+  def app
+    ParentLessApi
+  end
+
+  describe 'retrieves swagger-documentation on /swagger_doc' do
+    let(:route_name) { ':animal/:breed/queues/:queue_id/reservations' }
+    subject do
+      get '/api/swagger_doc.json'
+      JSON.parse(last_response.body)
+    end
+
+    specify do
+      expect(subject['paths']['/api/{animal}/{breed}/queues/{queue_id}/reservations']['get']['operationId'])
+        .to eql('getApiAnimalBreedQueuesQueueIdReservations')
+    end
+  end
+end

spec/swagger_v2/parent_less_namespace.rb

@@ -58,20 +58,27 @@ def app
     expect(subject['paths']['/kind']['get']['parameters']).to eq [{
       'in' => 'query',
       'name' => 'something',
-      'description' => 'something as parameter',
-      'type' => 'string',
-      'required' => false,
-      'allowMultiple' => false
+      'description' => 'Something interesting.',
+      'type' => 'SomethingCustom',
+      'required' => false
     }]
 
-    expect(subject['definitions'].keys).to include 'Something'
-    expect(subject['definitions']['Something']).to eq(
-      'type' => 'object', 'properties' => { 'text' => { 'type' => 'string' } }
+    expect(subject['definitions'].keys).to include 'SomethingCustom'
+    expect(subject['definitions']['SomethingCustom']).to eq(
+      'type' => 'object', 'properties' => { 'text' => { 'type' => 'string', 'description' => 'Content of something.' } }
     )
 
-    expect(subject['definitions'].keys).to include 'Kind'
-    expect(subject['definitions']['Kind']).to eq(
-      'properties' => { 'something' => { '$ref' => '#/definitions/Something' } }
+    expect(subject['definitions'].keys).to include 'KindCustom'
+    expect(subject['definitions']['KindCustom']).to eq(
+      'type' => 'object',
+      'properties' => {
+        'title' => { 'type' => 'string', 'description' => 'Title of the kind.' },
+        'something' => {
+          '$ref' => '#/definitions/SomethingCustom',
+          'description' => 'Something interesting.'
+        }
+      },
+      'description' => 'This returns kind and something or an error'
     )
   end
 end