issue 572: is_array should only be applied to success

- updates travis
- adds changelog entry

Author: LeFnord

.rubocop.yml

@@ -5,6 +5,10 @@ AllCops:
 
 inherit_from: .rubocop_todo.yml
 
+Metrics/BlockLength:
+  Exclude:
+    - spec/**/*
+
 Metrics/LineLength:
   Exclude:
     - spec/**/*

.travis.yml

@@ -3,40 +3,39 @@ language: ruby
 sudo: false
 
 before_install:
+  - gem update --system
   - gem install bundler
 
 after_success:
+  - bundle exec danger
   - coveralls
 
+rvm:
+  - 2.4.0
+  - 2.3.3
+
+env:
+  - MODEL_PARSER=grape-swagger-entity
+  - MODEL_PARSER=grape-swagger-representable
+  - GRAPE_VERSION=0.16.2
+  - GRAPE_VERSION=0.17.0
+  - GRAPE_VERSION=0.18.0
+  - GRAPE_VERSION=0.19.1
+  - GRAPE_VERSION=HEAD
+
 matrix:
   fast_finish: true
+
   include:
-    - rvm: 2.4.0
-      script:
-        - bundle exec danger
-    - rvm: 2.4.0
-      env: MODEL_PARSER=grape-swagger-entity
-    - rvm: 2.4.0
-      env: MODEL_PARSER=grape-swagger-representable
-    - rvm: 2.4.0
-      env: GRAPE_VERSION=0.16.2
-    - rvm: 2.4.0
-      env: GRAPE_VERSION=0.17.0
-    - rvm: 2.4.0
-      env: GRAPE_VERSION=0.18.0
-    - rvm: 2.4.0
-      env: GRAPE_VERSION=0.19.0
-    - rvm: 2.4.0
-      env: GRAPE_VERSION=HEAD
-    - rvm: 2.3.3
-      env: MODEL_PARSER=grape-swagger-entity
-    - rvm: 2.3.3
-      env: MODEL_PARSER=grape-swagger-representable
-    - rvm: 2.3.3
     - rvm: 2.2.6
+      env:
     - rvm: ruby-head
+      env:
     - rvm: jruby-head
+      env:
     - rvm: rbx-2
+      env:
+
   allow_failures:
     - rvm: ruby-head
     - rvm: jruby-head

CHANGELOG.md

@@ -11,6 +11,7 @@
 #### Fixes
 
 * [#562](https://github.com/ruby-grape/grape-swagger/pull/562): The guard method should allow regular object methods as arguments - [@tim-vandecasteele](https://github.com/tim-vandecasteele).
+* [#574](https://github.com/ruby-grape/grape-swagger/pull/574): Issue #572: is_array should only be applied to success - [@LeFnord](https://github.com/LeFnord).
 
 * Your contribution here.
 

Gemfile

@@ -23,7 +23,7 @@ group :development, :test do
   gem 'rake'
   gem 'rdoc'
   gem 'rspec', '~> 3.0'
-  gem 'rubocop', '~> 0.40'
+  gem 'rubocop', '~> 0.46'
 end
 group :test do
   gem 'coveralls', require: false

lib/grape-swagger/endpoint.rb

@@ -195,13 +195,12 @@ def response_object(route)
         end
 
         next if memo.key?(204)
-        next unless !response_model.start_with?('Swagger_doc') &&
-                    ((@definitions[response_model] && value[:code].to_s.start_with?('2')) || value[:model])
+        next unless !response_model.start_with?('Swagger_doc') && (@definitions[response_model] || value[:model])
 
         @definitions[response_model][:description] = description_object(route)
         # TODO: proof that the definition exist, if model isn't specified
         reference = { '$ref' => "#/definitions/#{response_model}" }
-        memo[value[:code]][:schema] = if route.options[:is_array]
+        memo[value[:code]][:schema] = if route.options[:is_array] && value[:code] < 300
                                         { 'type' => 'array', 'items' => reference }
                                       else
                                         reference

spec/issues/572_array_post_body_spec.rb

@@ -0,0 +1,49 @@
+require 'spec_helper'
+
+describe '#572 is_array is applied to all possible responses' do
+  include_context "#{MODEL_PARSER} swagger example"
+
+  let(:app) do
+    Class.new(Grape::API) do
+      namespace :issue_572 do
+        desc 'get issue',
+             is_array: true,
+             success: Entities::UseResponse,
+             failure: [
+               [401, 'BadKittenError', Entities::ApiError],
+               [404, 'NoTreatsError', Entities::ApiError],
+               [429, 'TooManyScratchesError', Entities::ApiError]
+             ]
+
+        get
+      end
+
+      add_swagger_documentation format: :json
+    end
+  end
+
+  subject do
+    get '/swagger_doc'
+    JSON.parse(last_response.body)
+  end
+
+  let(:codes) { %w(200 401 404 429) }
+
+  let(:responses) { subject['paths']['/issue_572']['get']['responses'] }
+
+  specify { expect(responses.keys.sort).to eq codes }
+
+  specify do
+    expect(responses['200']['schema']).to include 'type'
+    expect(responses['200']['schema']['type']).to eql 'array'
+  end
+
+  describe 'no array types' do
+    specify do
+      codes[1..-1].each do |code|
+        expect(responses[code]['schema']).not_to include 'type'
+        expect(responses[code]['schema'].keys).to eql ['$ref']
+      end
+    end
+  end
+end