grape-swagger 0.27.3 → 0.28.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 4f8965c701e729810dda5456398ca1be10ede83f
-  data.tar.gz: ea1d30739c20e4317301e8f4117c62ae9b48a3aa
+SHA256:
+  metadata.gz: 5d425dcb8ef7eb5f98bba7c012f624b7cfd0052e91a5b3f7f5d7374c7d7529b2
+  data.tar.gz: 83c9d09cc29e30b73a263fdc66eaffe587a9503efcbf2b427cb1dd46280ed7e2
 SHA512:
-  metadata.gz: e3ddeb7ee947dbc7bcfbc5aa6c102e71c68bf9f366f2a9fdb0db56c7ea8beba030d5eea0353821c32ba4c0596e82e48f37f9e99f5d215e1ddcb0ea1cd954f782
-  data.tar.gz: 96e40804304834a0c1615cc0a1915b370a1b84c9df308311972fedbc92ccf7e771f87120b9963d216532c825aed47538b6e9c335ddb5b8f8378edb2ea99899b1
+  metadata.gz: 5d4f19f682ba1a5f999429ec3568107b8873ada3c9e033363d90be6d669e653f16ea7ac1da116bd1702326c4dc5ed65746819d34fb67ca41cbfd2cc0611dbe4d
+  data.tar.gz: 022cdcba56eb3e8c9bf38c406851b40546053bb170204e429a92d218e96ad7a1fc507802eb5f90bb8d8b77e1a5509e63a54a4a27424db1b95b1b62a9e4e5c667

data/.rubocop.yml

@@ -6,6 +6,9 @@ AllCops:
     - example/**/*
   TargetRubyVersion: 2.4
 
+Layout/EmptyLinesAroundArguments:
+  Enabled: false
+
 Layout/IndentHash:
   EnforcedStyle: consistent
 
@@ -14,6 +17,7 @@ Metrics/BlockLength:
     - spec/**/*
 
 Metrics/LineLength:
+  Max: 120
   Exclude:
     - spec/**/*
 
@@ -21,6 +25,8 @@ Metrics/MethodLength:
   Exclude:
     - spec/**/*
 
+Naming:
+  Enabled: false
 
-Style/FileName:
+Style/RegexpLiteral:
   Enabled: false

data/.rubocop_todo.yml

@@ -1,67 +1,46 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2016-11-24 18:42:08 +0800 using RuboCop version 0.45.0.
+# on 2017-12-13 08:44:09 +0100 using RuboCop version 0.52.0.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
 # versions of RuboCop, may require this file to be generated again.
 
-# Offense count: 29
+# Offense count: 1
+# Configuration parameters: Include.
+# Include: **/*.gemspec
+Gemspec/RequiredRubyVersion:
+  Exclude:
+    - 'grape-swagger.gemspec'
+
+
+# Offense count: 30
 Metrics/AbcSize:
   Max: 56
 
-# Offense count: 1
-# Configuration parameters: CountComments.
-Metrics/BlockLength:
-  Max: 29
-
 # Offense count: 3
 # Configuration parameters: CountComments.
 Metrics/ClassLength:
-  Max: 275
+  Max: 280
 
-# Offense count: 12
+# Offense count: 10
 Metrics/CyclomaticComplexity:
-  Max: 15
-
-# Offense count: 129
-# Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives.
-# URISchemes: http, https
-Metrics/LineLength:
-  Max: 120
+  Max: 13
 
-# Offense count: 35
+# Offense count: 20
 # Configuration parameters: CountComments.
 Metrics/MethodLength:
   Max: 40
 
-# Offense count: 7
+# Offense count: 6
 Metrics/PerceivedComplexity:
-  Max: 16
+  Max: 14
 
 # Offense count: 3
 Style/ClassVars:
   Exclude:
     - 'lib/grape-swagger/doc_methods.rb'
 
-# Offense count: 23
+# Offense count: 20
 Style/Documentation:
   Enabled: false
-
-Style/MixinGrouping:
-  Exclude:
-    - spec/**/*
-
-# Offense count: 1
-# Cop supports --auto-correct.
-Style/MultilineIfModifier:
-  Exclude:
-    - 'lib/grape-swagger/grape/route.rb'
-
-# Offense count: 5
-# Cop supports --auto-correct.
-# Configuration parameters: EnforcedStyle, SupportedStyles, AllowInnerSlashes.
-# SupportedStyles: slashes, percent_r, mixed
-Style/RegexpLiteral:
-  Exclude:
-    - 'lib/grape-swagger.rb'

data/.travis.yml

@@ -7,36 +7,37 @@ before_install:
   - gem install bundler
 
 after_success:
+  - coveralls
   - bundle exec danger
 
 rvm:
-  - 2.4.1
-  - 2.3.4
+  - 2.5.0
+  - 2.4.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.2
-  - GRAPE_VERSION=1.0.0
+  - GRAPE_VERSION=1.0.1
   - GRAPE_VERSION=HEAD
 
 matrix:
   fast_finish: true
 
   include:
-    - rvm: 2.2.7
+    - rvm: 2.3.6
       env:
     - rvm: ruby-head
       env:
     - rvm: jruby-head
       env:
-    - rvm: rbx-2
+    - rvm: rbx-3
       env:
 
   allow_failures:
+    - rvm: 2.3.6
     - rvm: ruby-head
     - rvm: jruby-head
-    - rvm: rbx-2
+    - rvm: rbx-3

data/CHANGELOG.md

@@ -8,6 +8,22 @@
 
 * Your contribution here.
 
+### 0.28.0 (February 3, 2018)
+
+#### Features
+
+* [#622](https://github.com/ruby-grape/grape-swagger/pull/622): Add support for 'brackets' collection format - [@korstiaan](https://github.com/korstiaan).
+
+#### Fixes
+
+* [#631](https://github.com/ruby-grape/grape-swagger/pull/631): Fix order of mounts with overrides - [@adie](https://github.com/adie).
+* [#267](https://github.com/ruby-grape/grape-swagger/pull/634): Fix mounting APIs in route_param namespaces - [@milgner](https://github.com/milgner), [@wojciechka](https://github.com/wojciechka).
+* [#642](https://github.com/ruby-grape/grape-swagger/pull/642): Fix examples link in readme - [@iBublik](https://github.com/iBublik).
+* [#641](https://github.com/ruby-grape/grape-swagger/pull/641): Exclude default success code if http_codes define one already - [@anakinj](https://github.com/anakinj).
+* [#651](https://github.com/ruby-grape/grape-swagger/pull/651): Apply `values` and `default` of array params to its items - [@yewton](https://github.com/yewton).
+* [#654](https://github.com/ruby-grape/grape-swagger/pull/654): Allow setting the consumes for PATCH methods - [@anakinj](https://github.com/anakinj).
+* [#656](https://github.com/ruby-grape/grape-swagger/pull/656): Fix `description` field may be null - [@soranoba](https://github.com/soranoba).
+
 ### 0.27.3 (July 11, 2017)
 
 #### Features

data/Gemfile

@@ -17,6 +17,7 @@ gem ENV['MODEL_PARSER'] if ENV.key?('MODEL_PARSER')
 
 group :development, :test do
   gem 'bundler'
+  gem 'grape-entity'
   gem 'pry', platforms: [:mri]
   gem 'pry-byebug', platforms: [:mri]
   gem 'rack'
@@ -25,12 +26,11 @@ group :development, :test do
   gem 'rake'
   gem 'rdoc'
   gem 'rspec', '~> 3.0'
-  gem 'rubocop', '~> 0.49'
+  gem 'rubocop', '~>0.51', require: false
 end
 
 group :test do
   gem 'coveralls', require: false
-  gem 'grape-entity', '~>0.5'
   gem 'grape-swagger-entity'
   gem 'ruby-grape-danger', '~> 0.1.1', require: false
   gem 'simplecov', require: false

data/README.md

@@ -17,8 +17,7 @@
 * [Routes Configuration](#routes)
 * [Using Grape Entities](#grape-entity)
 * [Securing the Swagger UI](#oauth)
-* [Markdown (deprecated)](#md_usage)
-* [Example](#example)
+* [Examples](#examples)
 * [Rake Tasks](#rake)
 
 
@@ -110,7 +109,7 @@ gem 'grape-swagger-entity'
 gem 'grape-swagger-representable'
 ```
 
-If you are not using Rails, make sure to load the parser inside your application initialization logic, e.g., via `require 'grape-swagger/entity'` or `require 'grape-swagger/representable`.
+If you are not using Rails, make sure to load the parser inside your application initialization logic, e.g., via `require 'grape-swagger/entity'` or `require 'grape-swagger/representable'`.
 
 ### Custom Model Parsers
 
@@ -265,10 +264,6 @@ add_swagger_documentation \
 ```
 
 
-#### markdown: (deprecated) <a name="markdown" />
-OAPI accepts GFM for descriptions
-
-
 #### endpoint_auth_wrapper: <a name="endpoint_auth_wrapper" />
 Specify the middleware to use for securing endpoints.
 
@@ -462,7 +457,7 @@ Or by using a route setting:
 
 ```ruby
 route_setting :swagger, { hidden: true }
-gem '/kittens' do
+get '/kittens' do
 ```
 
 Endpoints can be conditionally hidden by providing a callable object such as a lambda which evaluates to the desired
@@ -565,7 +560,7 @@ desc 'Get all kittens!', {
   nickname: 'getKittens',
   success: Entities::Kitten, # or success
   failure: [[401, 'KittenBitesError', Entities::BadKitten]] # or failure
-  # also explicit as hash: [{ code: 401, mssage: 'KittenBitesError', model: Entities::BadKitten }]
+  # also explicit as hash: [{ code: 401, message: 'KittenBitesError', model: Entities::BadKitten }]
   produces: [ "array", "of", "mime_types" ],
   consumes: [ "array", "of", "mime_types" ]
   }
@@ -1198,15 +1193,7 @@ The lambda is checking whether the user is authenticated (if not, the token_owne
 role - only admins can see this endpoint.
 
 
-## Markdown in Detail (deprecated) <a name="md_usage" />
-
-Usage of option `markdown` will no longer be supported,
-cause OAPI accepts [GFM](https://help.github.com/articles/github-flavored-markdown) and plain text.
-(see: [description of `Info`](https://github.com/OAI/OpenAPI-Specification/blob/OpenAPI.next/versions/2.0.md#info-object))
-
-
-<a="example" />
-## Examples
+## Examples <a="example" />
 
 Go into example directory and run it: `$ bundle exec rackup`
 go to: `http://localhost:9292/swagger_doc` to get it

data/Rakefile

@@ -1,4 +1,3 @@
-# encoding: utf-8
 # frozen_string_literal: true
 
 require 'rubygems'

data/grape-swagger.gemspec

@@ -13,7 +13,7 @@ Gem::Specification.new do |s|
   s.summary     = 'Add auto generated documentation to your Grape API that can be displayed with Swagger.'
   s.license     = 'MIT'
 
-  s.required_ruby_version = '>= 2.2'
+  s.required_ruby_version = '>= 2.3'
   s.add_runtime_dependency 'grape', '>= 0.16.2'
 
   s.files         = `git ls-files`.split("\n")

data/lib/grape-swagger.rb

@@ -29,11 +29,9 @@ module Grape
         version_for(options)
         options = { target_class: self }.merge(options)
         @target_class = options[:target_class]
-        auth_wrapper = options[:endpoint_auth_wrapper]
+        auth_wrapper = options[:endpoint_auth_wrapper] || Class.new
 
-        if auth_wrapper && auth_wrapper.method_defined?(:before) && !middleware.flatten.include?(auth_wrapper)
-          use auth_wrapper
-        end
+        use auth_wrapper if auth_wrapper.method_defined?(:before) && !middleware.flatten.include?(auth_wrapper)
 
         documentation_class.setup(options)
         mount(documentation_class)
@@ -72,7 +70,7 @@ module Grape
           resource = '/' if resource.empty?
           @target_class.combined_routes[resource] ||= []
           next if doc_klass.hide_documentation_path && route.path.match(/#{doc_klass.mount_path}($|\/|\(\.)/)
-          @target_class.combined_routes[resource] << route
+          @target_class.combined_routes[resource].unshift route
         end
       end
 
@@ -90,16 +88,24 @@ module Grape
         end
       end
 
+      def determine_namespaced_routes(name, parent_route)
+        if parent_route.nil?
+          @target_class.combined_routes.values.flatten
+        else
+          parent_route.reject do |route|
+            !route_path_start_with?(route, name) || !route_instance_variable_equals?(route, name)
+          end
+        end
+      end
+
       def combine_namespace_routes(namespaces)
         # iterate over each single namespace
-        namespaces.each do |name, _|
+        namespaces.each_key do |name, _|
           # get the parent route for the namespace
           parent_route_name = extract_parent_route(name)
           parent_route = @target_class.combined_routes[parent_route_name]
           # fetch all routes that are within the current namespace
-          namespace_routes = parent_route.reject do |route|
-            !route_path_start_with?(route, name) || !route_instance_variable_equals?(route, name)
-          end
+          namespace_routes = determine_namespaced_routes(name, parent_route)
 
           # default case when not explicitly specified or nested == true
           standalone_namespaces = namespaces.reject do |_, ns|
@@ -118,11 +124,15 @@ module Grape
             @target_class.combined_namespace_routes[parent_route_name] = [] unless parent_route
             @target_class.combined_namespace_routes[parent_route_name].push(*namespace_routes)
           end
+          # rubocop:enable Style/Next
         end
       end
 
       def extract_parent_route(name)
-        name.match(%r{^/?([^/]*).*$})[1]
+        route_name = name.match(%r{^/?([^/]*).*$})[1]
+        return route_name unless route_name.include? ':'
+        matches = name.match(/\/[a-z]+/)
+        matches.nil? ? route_name : matches[0].delete('/')
       end
 
       def route_instance_variable(route)

data/lib/grape-swagger/doc_methods.rb

@@ -25,9 +25,6 @@ module GrapeSwagger
     end
 
     def setup(options)
-      # FIXME: move out after next minor is released
-      GrapeSwagger::Errors::SwaggerSpecDeprecated.tell!(options[:markdown]) if options.key?(:markdown)
-
       options = defaults.merge(options)
 
       # options could be set on #add_swagger_documentation call,

data/lib/grape-swagger/doc_methods/data_type.rb

@@ -80,7 +80,7 @@ module GrapeSwagger
         end
 
         def collections
-          %w[csv ssv tsv pipes multi]
+          %w[csv ssv tsv pipes multi brackets]
         end
       end
 

data/lib/grape-swagger/doc_methods/extensions.rb

@@ -68,7 +68,7 @@ module GrapeSwagger
         def concatenate(extensions)
           result = {}
 
-          extensions.values.each do |extension|
+          extensions.each_value do |extension|
             extension.each do |key, value|
               result["x-#{key}"] = value
             end

data/lib/grape-swagger/doc_methods/move_params.rb

@@ -198,7 +198,7 @@ module GrapeSwagger
         end
 
         def property_keys
-          %i[type format description minimum maximum items]
+          %i[type format description minimum maximum items enum]
         end
 
         def deletable?(param)

data/lib/grape-swagger/doc_methods/parse_params.rb

@@ -22,8 +22,8 @@ module GrapeSwagger
           document_description(settings)
           document_type_and_format(settings, data_type)
           document_array_param(value_type, definitions) if value_type[:is_array]
-          document_default_value(settings)
-          document_range_values(settings)
+          document_default_value(settings) unless value_type[:is_array]
+          document_range_values(settings) unless value_type[:is_array]
           document_required(settings)
 
           @parsed_param
@@ -79,6 +79,12 @@ module GrapeSwagger
           end
           array_items[:format] = @parsed_param.delete(:format) if @parsed_param[:format]
 
+          values = value_type[:values] || nil
+          enum_or_range_values = parse_enum_or_range_values(values)
+          array_items.merge!(enum_or_range_values) if enum_or_range_values
+
+          array_items[:default] = value_type[:default] if value_type[:default].present?
+
           @parsed_param[:in] = param_type || 'formData'
           @parsed_param[:items] = array_items
           @parsed_param[:type] = 'array'

data/lib/grape-swagger/doc_methods/tag_name_description.rb

@@ -7,6 +7,7 @@ module GrapeSwagger
         def build(paths)
           paths.values.each_with_object([]) do |path, memo|
             tags = path.values.first[:tags]
+            next if tags.nil?
 
             case tags
             when String

data/lib/grape-swagger/endpoint.rb

@@ -77,7 +77,7 @@ module Grape
     def path_and_definition_objects(namespace_routes, options)
       @paths = {}
       @definitions = {}
-      namespace_routes.keys.each do |key|
+      namespace_routes.each_key do |key|
         routes = namespace_routes[key]
         path_item(routes, options)
       end
@@ -143,6 +143,7 @@ module Grape
     def description_object(route)
       description = route.description if route.description.present?
       description = route.options[:detail] if route.options.key?(:detail)
+      description ||= ''
 
       description
     end
@@ -161,14 +162,11 @@ module Grape
       route_mime_types.present? ? route_mime_types : mime_types
     end
 
-    def consumes_object(route, format)
-      method = route.request_method.downcase.to_sym
-      if route.settings[:description] && route.settings[:description][:consumes]
-        format = route.settings[:description][:consumes]
-      end
-      mime_types = GrapeSwagger::DocMethods::ProducesConsumes.call(format) if %i[post put].include?(method)
+    SUPPORTS_CONSUMES = %i[post put patch].freeze
 
-      mime_types
+    def consumes_object(route, format)
+      return unless SUPPORTS_CONSUMES.include?(route.request_method.downcase.to_sym)
+      GrapeSwagger::DocMethods::ProducesConsumes.call(route.settings.dig(:description, :consumes) || format)
     end
 
     def params_object(route, path)
@@ -191,12 +189,11 @@ module Grape
     end
 
     def response_object(route)
-      codes = (route.http_codes || route.options[:failure] || [])
-
-      codes = apply_success_codes(route) + codes
+      codes = http_codes_from_route(route)
       codes.map! { |x| x.is_a?(Array) ? { code: x[0], message: x[1], model: x[2] } : x }
 
       codes.each_with_object({}) do |value, memo|
+        value[:message] ||= ''
         memo[value[:code]] = { description: value[:message] }
         next build_file_response(memo[value[:code]]) if file_response?(value[:model])
 
@@ -222,7 +219,15 @@ module Grape
       end
     end
 
-    def apply_success_codes(route)
+    def http_codes_from_route(route)
+      if route.http_codes.is_a?(Array) && route.http_codes.any? { |code| code[:code].between?(200, 299) }
+        route.http_codes.clone
+      else
+        success_codes_from_route(route) + (route.http_codes || route.options[:failure] || [])
+      end
+    end
+
+    def success_codes_from_route(route)
       default_code = GrapeSwagger::DocMethods::StatusCodes.get[route.request_method.downcase.to_sym]
       if @entity.is_a?(Hash)
         default_code[:code] = @entity[:code] if @entity[:code].present?
@@ -257,6 +262,7 @@ module Grape
       memo['schema'] = { type: 'file' }
     end
 
+    # rubocop:disable Style/IfUnlessModifier
     def partition_params(route)
       declared_params = route.settings[:declared_params] if route.settings[:declared_params].present?
       required = merge_params(route)
@@ -270,6 +276,7 @@ module Grape
 
       request_params.empty? ? required : request_params
     end
+    # rubocop:enable Style/IfUnlessModifier
 
     def merge_params(route)
       param_keys = route.params.keys
@@ -326,7 +333,7 @@ module Grape
       raise GrapeSwagger::Errors::UnregisteredParser, "No parser registered for #{model_name}." unless parser
 
       properties = parser.new(model, self).call
-      unless properties && properties.any?
+      unless properties&.any?
         raise GrapeSwagger::Errors::SwaggerSpec,
               "Empty model #{model_name}, swagger 2.0 doesn't support empty definitions."
       end

data/lib/grape-swagger/version.rb

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

data/spec/issues/267_nested_namespaces.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe 'nested namespaces' do
+  let(:app) do
+    Class.new(Grape::API) do
+      route_param :root do
+        resources :apps do
+          route_param :app_id do
+            resource :build do
+              desc 'Builds an application'
+              post do
+                { name: 'Test' }
+              end
+            end
+          end
+        end
+      end
+
+      add_swagger_documentation version: 'v1'
+    end
+  end
+
+  describe 'combined_namespace_routes' do
+    it 'parses root namespace properly' do
+      expect(app.combined_namespace_routes.keys).to include('apps')
+    end
+  end
+
+  describe '#extract_parent_route' do
+    it 'extracts parent for non-namespaced path properly' do
+      expect(app.send(:extract_parent_route, '/apps/:app_id/build')).to eq('apps')
+    end
+
+    it 'extracts parent for namespaced path properly' do
+      expect(app.send(:extract_parent_route, '/:root/apps/:app_id/build')).to eq('apps')
+    end
+  end
+
+  describe 'retrieves swagger-documentation on /swagger_doc' do
+    let(:route_name) { '{root}/apps/{app_id}/build' }
+
+    subject do
+      get '/swagger_doc.json'
+      JSON.parse(last_response.body)
+    end
+
+    context 'paths' do
+      specify do
+        expect(subject['paths'].keys).to include "/#{route_name}"
+      end
+    end
+  end
+end

data/spec/issues/403_versions_spec.rb

@@ -1,4 +1,3 @@
-# encoding: utf-8
 # frozen_string_literal: true
 
 require 'spec_helper'

data/spec/issues/650_params_array_spec.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe '#605 Group Params as Array' do
+  let(:app) do
+    Class.new(Grape::API) do
+      params do
+        requires :array_of_range_string, type: [String], values: %w[a b c]
+        requires :array_of_range_integer, type: [Integer], values: [1, 2, 3]
+      end
+      post '/array_of_range' do
+        { 'declared_params' => declared(params) }
+      end
+
+      params do
+        requires :array_with_default_string, type: [String], default: 'abc'
+        requires :array_with_default_integer, type: Array[Integer], default: 123
+      end
+      post '/array_with_default' do
+        { 'declared_params' => declared(params) }
+      end
+
+      add_swagger_documentation
+    end
+  end
+
+  describe 'retrieves the documentation for typed group range parameters' do
+    subject do
+      get '/swagger_doc/array_of_range'
+      JSON.parse(last_response.body)
+    end
+
+    specify do
+      expect(subject['paths']['/array_of_range']['post']['parameters']).to eql(
+        [
+          { 'in' => 'formData', 'name' => 'array_of_range_string', 'type' => 'array', 'items' => { 'type' => 'string', 'enum' => %w[a b c] }, 'required' => true },
+          { 'in' => 'formData', 'name' => 'array_of_range_integer', 'type' => 'array', 'items' => { 'type' => 'integer', 'format' => 'int32', 'enum' => [1, 2, 3] }, 'required' => true }
+        ]
+      )
+    end
+  end
+
+  describe 'retrieves the documentation for typed group parameters with default' do
+    subject do
+      get '/swagger_doc/array_with_default'
+      JSON.parse(last_response.body)
+    end
+
+    specify do
+      expect(subject['paths']['/array_with_default']['post']['parameters']).to eql(
+        [
+          { 'in' => 'formData', 'name' => 'array_with_default_string', 'type' => 'array', 'items' => { 'type' => 'string', 'default' => 'abc' }, 'required' => true },
+          { 'in' => 'formData', 'name' => 'array_with_default_integer', 'type' => 'array', 'items' => { 'type' => 'integer', 'format' => 'int32', 'default' => 123 }, 'required' => true }
+        ]
+      )
+    end
+  end
+end

data/spec/lib/optional_object_spec.rb

@@ -40,6 +40,7 @@ describe GrapeSwagger::DocMethods::OptionalObject do
       let(:options) do
         { host: proc { |request| request.host =~ /^example/ ? '/api-example' : '/api' } }
       end
+      # rubocop:enable RegexpMatch
       specify do
         expect(subject.build(key, options, request)).to eql '/api-example'
       end

data/spec/swagger_v2/api_swagger_v2_detail_spec.rb

@@ -48,7 +48,7 @@ describe 'details' do
             { 'declared_params' => declared(params) }
           end
 
-          add_swagger_documentation markdown: 'foo'
+          add_swagger_documentation
         end
       end
     end

data/spec/swagger_v2/api_swagger_v2_format-content_type_spec.rb

@@ -49,6 +49,14 @@ describe 'format, content_type' do
           { 'declared_params' => declared(params) }
         end
 
+        desc 'This uses consumes for consumes',
+             failure: [{ code: 400, model: Entities::ApiError }],
+             consumes: ['application/www_url_encoded'],
+             entity: Entities::UseResponse
+        patch '/use_consumes' do
+          { 'declared_params' => declared(params) }
+        end
+
         add_swagger_documentation
       end
     end
@@ -123,6 +131,7 @@ describe 'format, content_type' do
     specify do
       expect(subject['paths']['/use_consumes']['post']).to include('consumes')
       expect(subject['paths']['/use_consumes']['post']['consumes']).to eql ['application/www_url_encoded']
+      expect(subject['paths']['/use_consumes']['patch']['consumes']).to eql ['application/www_url_encoded']
     end
   end
 end

data/spec/swagger_v2/api_swagger_v2_mounted_spec.rb

@@ -131,7 +131,7 @@ describe 'swagger spec v2.0' do
 
         specify do
           unexpected_paths = mounted_paths - [expected_path]
-          subject.keys.each do |path|
+          subject.each_key do |path|
             unexpected_paths.each do |unexpected_path|
               expect(path).not_to start_with unexpected_path
             end

data/spec/swagger_v2/api_swagger_v2_status_codes_spec.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe 'http status code behaivours' do
+  include_context "#{MODEL_PARSER} swagger example"
+
+  subject do
+    get '/swagger_doc'
+    JSON.parse(last_response.body)
+  end
+
+  context 'when non-default success codes are deifined' do
+    let(:app) do
+      Class.new(Grape::API) do
+        desc 'Has explicit success http_codes defined' do
+          http_codes [{ code: 202, message: 'We got it!' },
+                      { code: 204, message: 'Or returned no content' },
+                      { code: 400, message: 'Bad request' }]
+        end
+
+        post '/accepting_endpoint' do
+          'We got the message!'
+        end
+        add_swagger_documentation
+      end
+    end
+
+    it 'only includes the defined http_codes' do
+      expect(subject['paths']['/accepting_endpoint']['post']['responses'].keys.sort).to eq(%w[202 204 400].sort)
+    end
+  end
+
+  context 'when no success codes defined' do
+    let(:app) do
+      Class.new(Grape::API) do
+        desc 'Has explicit error http_codes defined' do
+          http_codes [{ code: 400, message: 'Error!' },
+                      { code: 404, message: 'Not found' }]
+        end
+
+        post '/error_endpoint' do
+          'We got the message!'
+        end
+        add_swagger_documentation
+      end
+    end
+
+    it 'adds the success codes to the response' do
+      expect(subject['paths']['/error_endpoint']['post']['responses'].keys.sort).to eq(%w[201 400 404].sort)
+    end
+  end
+
+  context 'when success and error codes are defined' do
+    let(:app) do
+      Class.new(Grape::API) do
+        desc 'Has success and error codes defined' do
+          http_codes [{ code: 200, message: 'Found' },
+                      { code: 404, message: 'Not found' }]
+        end
+
+        get '/endpoint' do
+          'We got the message!'
+        end
+        add_swagger_documentation
+      end
+    end
+
+    it 'adds the success codes and error codes to the response' do
+      expect(subject['paths']['/endpoint']['get']['responses'].keys.sort).to eq(%w[200 404].sort)
+    end
+  end
+end

data/spec/swagger_v2/guarded_endpoint_spec.rb

@@ -14,14 +14,6 @@ class SampleAuth < Grape::Middleware::Base
       @protected_endpoint || false
     end
 
-    def access_token
-      @_access_token
-    end
-
-    def access_token=(token)
-      @_access_token = token
-    end
-
     def resource_owner
       @resource_owner = true if access_token == '12345'
     end

data/spec/swagger_v2/mount_override_api_spec.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe 'mount override api' do
+  def app
+    old_api = Class.new(Grape::API) do
+      desc 'old endpoint', success: { code: 200, message: 'old message' }
+      params do
+        optional :param, type: Integer, desc: 'old param'
+      end
+      get do
+        'old'
+      end
+    end
+
+    new_api = Class.new(Grape::API) do
+      desc 'new endpoint', success: { code: 200, message: 'new message' }
+      params do
+        optional :param, type: String, desc: 'new param'
+      end
+      get do
+        'new'
+      end
+    end
+
+    Class.new(Grape::API) do
+      mount new_api
+      mount old_api
+
+      add_swagger_documentation format: :json
+    end
+  end
+
+  context 'actual api request' do
+    subject do
+      get '/'
+      last_response.body
+    end
+
+    it 'returns data from new endpoint' do
+      is_expected.to eq 'new'
+    end
+  end
+
+  context 'api documentation' do
+    subject do
+      get '/swagger_doc'
+      JSON.parse(last_response.body)['paths']['/']['get']
+    end
+
+    it 'shows documentation from new endpoint' do
+      expect(subject['summary']).to eql('new endpoint')
+      expect(subject['parameters'][0]['description']).to eql('new param')
+      expect(subject['parameters'][0]['type']).to eql('string')
+      expect(subject['responses']['200']['description']).to eql('new message')
+    end
+  end
+end

data/spec/swagger_v2/params_array_collection_fromat_spec.rb

@@ -31,6 +31,14 @@ describe 'Group Array Params, using collection format' do
         { 'declared_params' => declared(params) }
       end
 
+      params do
+        optional :array_of_strings, type: Array[String], desc: 'array in brackets collection format', documentation: { collectionFormat: 'brackets' }
+      end
+
+      get '/array_of_strings_brackets_collection_format' do
+        { 'declared_params' => declared(params) }
+      end
+
       add_swagger_documentation
     end
   end
@@ -65,6 +73,21 @@ describe 'Group Array Params, using collection format' do
     end
   end
 
+  describe 'documentation for array parameters in brackets collectionFormat set from documentation' do
+    subject do
+      get '/swagger_doc/array_of_strings_brackets_collection_format'
+      JSON.parse(last_response.body)
+    end
+
+    specify do
+      expect(subject['paths']['/array_of_strings_brackets_collection_format']['get']['parameters']).to eql(
+        [
+          { 'in' => 'formData', 'name' => 'array_of_strings', 'type' => 'array', 'items' => { 'type' => 'string' }, 'required' => false, 'collectionFormat' => 'brackets', 'description' => 'array in brackets collection format' }
+        ]
+      )
+    end
+  end
+
   describe 'documentation for array parameters with collectionFormat set to invalid option' do
     subject do
       get '/swagger_doc/array_of_strings_invalid_collection_format'

data/spec/swagger_v2/params_array_spec.rb

@@ -101,7 +101,7 @@ describe 'Group Params as Array' do
           { 'in' => 'formData', 'name' => 'typed_group[id]', 'description' => 'integer given', 'type' => 'array', 'items' => { 'type' => 'integer', 'format' => 'int32' }, 'required' => true },
           { 'in' => 'formData', 'name' => 'typed_group[name]', 'description' => 'string given', 'type' => 'array', 'items' => { 'type' => 'string' }, 'required' => true },
           { 'in' => 'formData', 'name' => 'typed_group[email]', 'description' => 'email given', 'type' => 'array', 'items' => { 'type' => 'string' }, 'required' => false },
-          { 'in' => 'formData', 'name' => 'typed_group[others]', 'type' => 'array', 'items' => { 'type' => 'integer', 'format' => 'int32' }, 'enum' => [1, 2, 3], 'required' => false }
+          { 'in' => 'formData', 'name' => 'typed_group[others]', 'type' => 'array', 'items' => { 'type' => 'integer', 'format' => 'int32', 'enum' => [1, 2, 3] }, 'required' => false }
         ]
       )
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: grape-swagger
 version: !ruby/object:Gem::Version
-  version: 0.27.3
+  version: 0.28.0
 platform: ruby
 authors:
 - Tim Vandecasteele
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-07-11 00:00:00.000000000 Z
+date: 2018-02-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: grape
@@ -75,6 +75,7 @@ files:
 - lib/grape-swagger/model_parsers.rb
 - lib/grape-swagger/rake/oapi_tasks.rb
 - lib/grape-swagger/version.rb
+- spec/issues/267_nested_namespaces.rb
 - spec/issues/403_versions_spec.rb
 - spec/issues/427_entity_as_string_spec.rb
 - spec/issues/430_entity_definitions_spec.rb
@@ -89,6 +90,7 @@ files:
 - spec/issues/582_file_response_spec.rb
 - spec/issues/587_range_parameter_delimited_by_dash_spec.rb
 - spec/issues/605_root_route_documentation_spec.rb
+- spec/issues/650_params_array_spec.rb
 - spec/lib/data_type_spec.rb
 - spec/lib/endpoint_spec.rb
 - spec/lib/extensions_spec.rb
@@ -129,6 +131,7 @@ files:
 - spec/swagger_v2/api_swagger_v2_request_params_fix_spec.rb
 - spec/swagger_v2/api_swagger_v2_response_spec.rb
 - spec/swagger_v2/api_swagger_v2_spec.rb
+- spec/swagger_v2/api_swagger_v2_status_codes_spec.rb
 - spec/swagger_v2/api_swagger_v2_type-format_spec.rb
 - spec/swagger_v2/boolean_params_spec.rb
 - spec/swagger_v2/default_api_spec.rb
@@ -141,6 +144,7 @@ files:
 - spec/swagger_v2/guarded_endpoint_spec.rb
 - spec/swagger_v2/hide_api_spec.rb
 - spec/swagger_v2/host.rb
+- spec/swagger_v2/mount_override_api_spec.rb
 - spec/swagger_v2/mounted_target_class_spec.rb
 - spec/swagger_v2/namespace_tags_prefix_spec.rb
 - spec/swagger_v2/namespace_tags_spec.rb
@@ -171,7 +175,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.2'
+      version: '2.3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -179,12 +183,13 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.12
+rubygems_version: 2.7.3
 signing_key: 
 specification_version: 4
 summary: Add auto generated documentation to your Grape API that can be displayed
   with Swagger.
 test_files:
+- spec/issues/267_nested_namespaces.rb
 - spec/issues/403_versions_spec.rb
 - spec/issues/427_entity_as_string_spec.rb
 - spec/issues/430_entity_definitions_spec.rb
@@ -199,6 +204,7 @@ test_files:
 - spec/issues/582_file_response_spec.rb
 - spec/issues/587_range_parameter_delimited_by_dash_spec.rb
 - spec/issues/605_root_route_documentation_spec.rb
+- spec/issues/650_params_array_spec.rb
 - spec/lib/data_type_spec.rb
 - spec/lib/endpoint_spec.rb
 - spec/lib/extensions_spec.rb
@@ -239,6 +245,7 @@ test_files:
 - spec/swagger_v2/api_swagger_v2_request_params_fix_spec.rb
 - spec/swagger_v2/api_swagger_v2_response_spec.rb
 - spec/swagger_v2/api_swagger_v2_spec.rb
+- spec/swagger_v2/api_swagger_v2_status_codes_spec.rb
 - spec/swagger_v2/api_swagger_v2_type-format_spec.rb
 - spec/swagger_v2/boolean_params_spec.rb
 - spec/swagger_v2/default_api_spec.rb
@@ -251,6 +258,7 @@ test_files:
 - spec/swagger_v2/guarded_endpoint_spec.rb
 - spec/swagger_v2/hide_api_spec.rb
 - spec/swagger_v2/host.rb
+- spec/swagger_v2/mount_override_api_spec.rb
 - spec/swagger_v2/mounted_target_class_spec.rb
 - spec/swagger_v2/namespace_tags_prefix_spec.rb
 - spec/swagger_v2/namespace_tags_spec.rb