grape-swagger 0.25.2 → 0.25.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 152d9012cfd228b57f5bd894703832545865d0b7
-  data.tar.gz: d2fb99d11bb2c0329df1310fff779277c0b9c950
+  metadata.gz: 7ff792817a48d392666a4e84933495fa6e68b66e
+  data.tar.gz: 9368606ffd2008f4491145cf3e3803579abde016
 SHA512:
-  metadata.gz: 8bfede986d83fcd0bcbf29533872902269700906b81e35235efdf26f260fff8d79316192c579ca2248602bcc8abfef557a6df353d53fba03379616242b1f88ba
-  data.tar.gz: ae63ced69632be01f0f22944e0b261811bb14ea8c023ce7bed1556041d6bc1624d045d2beb1f3a73b347f2c019beb83b6f0cf316c446f2ef7a47f4ba98bf7552
+  metadata.gz: 84b8254773002e828481160615dc3176121d3f440de4937949ca086d53129aae064d72ad4ef5810c23789e3918228ccc083f6794eddb918ccebdc576224a8a30
+  data.tar.gz: 5960d2a66afffdb1f37a625d553e974aa782be32b7166b3199ac89e7b6dd347d8c6f97e431d81faf328482763a47ce39da5528f503b9f1c1de090eac9b96a246

data/.rubocop.yml

@@ -8,3 +8,6 @@ inherit_from: .rubocop_todo.yml
 Metrics/LineLength:
   Exclude:
     - spec/**/*
+
+Style/IndentHash:
+  EnforcedStyle: consistent

data/.rubocop_todo.yml

@@ -18,7 +18,7 @@ Metrics/BlockLength:
 # Offense count: 3
 # Configuration parameters: CountComments.
 Metrics/ClassLength:
-  Max: 247
+  Max: 265
 
 # Offense count: 10
 Metrics/CyclomaticComplexity:
@@ -28,7 +28,7 @@ Metrics/CyclomaticComplexity:
 # Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives.
 # URISchemes: http, https
 Metrics/LineLength:
-  Max: 160
+  Max: 120
 
 # Offense count: 34
 # Configuration parameters: CountComments.

data/.travis.yml

@@ -1,37 +1,37 @@
 language: ruby
 
 sudo: false
+before_install:
+  - gem install bundler
 
 matrix:
   include:
-    - rvm: 2.3.1
+    - rvm: 2.3.3
       script:
         - bundle exec danger
-    - rvm: 2.3.1
+    - rvm: 2.3.3
       env: MODEL_PARSER=grape-swagger-entity
-    - rvm: 2.3.1
+    - rvm: 2.3.3
       env: MODEL_PARSER=grape-swagger-representable
-    - rvm: 2.3.1
+    - rvm: 2.3.3
       env: GRAPE_VERSION=0.14.0
-    - rvm: 2.3.1
+    - rvm: 2.3.3
       env: GRAPE_VERSION=0.15.0
-    - rvm: 2.3.1
+    - rvm: 2.3.3
       env: GRAPE_VERSION=0.16.2
-    - rvm: 2.3.1
+    - rvm: 2.3.3
       env: GRAPE_VERSION=0.17.0
-    - rvm: 2.3.1
+    - rvm: 2.3.3
       env: GRAPE_VERSION=0.18.0
-    - rvm: 2.3.1
+    - rvm: 2.3.3
       env: GRAPE_VERSION=HEAD
-    - rvm: 2.3.0
     - rvm: 2.2
-    - rvm: 2.1
     - rvm: ruby-head
-    - rvm: jruby-9.1.2.0
+    - rvm: jruby-9.1.6.0
     - rvm: jruby-head
     - rvm: rbx-2
   allow_failures:
     - rvm: ruby-head
-    - rvm: jruby-9.1.2.0
+    - rvm: jruby-9.1.6.0
     - rvm: jruby-head
     - rvm: rbx-2

data/CHANGELOG.md

@@ -8,6 +8,18 @@
 
 * Your contribution here.
 
+### 0.25.3 (December 18, 2016)
+
+#### Features
+
+* [#554](https://github.com/ruby-grape/grape-swagger/pull/554): Updates travis.yml to align with grape  - [@LeFnord](https://github.com/LeFnord).
+
+#### Fixes
+
+* [#546](https://github.com/ruby-grape/grape-swagger/pull/546): Move development dependencies to Gemfile - [@olleolleolle](https://github.com/olleolleolle).
+* [#547](https://github.com/ruby-grape/grape-swagger/pull/547): Use entity_name event if type come from a string - [@frodrigo](https://github.com/frodrigo).
+* [#548](https://github.com/ruby-grape/grape-swagger/pull/548): Remove dots from operation id - [@frodrigo](https://github.com/frodrigo).
+* [#553](https://github.com/ruby-grape/grape-swagger/pull/553): Align array params for post, put request - addition to [#540](https://github.com/ruby-grape/grape-swagger/pull/540) - [@LeFnord](https://github.com/LeFnord).
 
 ### 0.25.2 (November 30, 2016)
 
@@ -34,7 +46,7 @@
 * [#524](https://github.com/ruby-grape/grape-swagger/pull/524): Use route tags for global tag set - [@LeFnord](https://github.com/LeFnord).
 * [#523](https://github.com/ruby-grape/grape-swagger/pull/523): Allow specifying custom tags at the route level - [@jordanfbrown](https://github.com/jordanfbrown).
 * [#520](https://github.com/ruby-grape/grape-swagger/pull/520): Response model can have required attributes - [@WojciechKo](https://github.com/WojciechKo).
-* [#510](https://github.com/ruby-grape/grape-swagger/pull/510): Use 'token_owner' instead of 'oauth_token' on Swagger UI endpoint authorization. - [@texpert](https://github.com/texpert).
+* [#510](https://github.com/ruby-grape/grape-swagger/pull/510): Use 'token_owner' instead of 'oauth_token' on Swagger UI endpoint authorization - [@texpert](https://github.com/texpert).
 
 #### Fixes
 
@@ -50,7 +62,7 @@
 * [#502](https://github.com/ruby-grape/grape-swagger/pull/502): Adds specs for rake tasks - [@LeFnord](https://github.com/LeFnord).
 * [#501](https://github.com/ruby-grape/grape-swagger/pull/501): Adds getting of a specified resource for Rake Tasks - [@LeFnord](https://github.com/LeFnord).
 * [#500](https://github.com/ruby-grape/grape-swagger/pull/500): Adds Rake tasks to get and validate OAPI/Swagger documentation - [@LeFnord](https://github.com/LeFnord).
-* [#493](https://github.com/ruby-grape/grape-swagger/pull/493): Swagger UI endpoint authorization. - [@texpert](https://github.com/texpert).
+* [#493](https://github.com/ruby-grape/grape-swagger/pull/493): Swagger UI endpoint authorization - [@texpert](https://github.com/texpert).
 * [#492](https://github.com/ruby-grape/grape/pull/492): Define security requirements on endpoint methods - [@tomregelink](https://github.com/tomregelink).
 * [#497](https://github.com/ruby-grape/grape-swagger/pull/497): Use ruby-grape-danger in Dangerfile - [@dblock](https://github.com/dblock).
 

data/Gemfile

@@ -1,23 +1,36 @@
 source 'http://rubygems.org'
 
+ruby RUBY_VERSION
+
 gemspec
 
-case version = ENV['GRAPE_VERSION'] || '~> 0.18'
-when 'HEAD'
-  gem 'grape', github: 'ruby-grape/grape'
-else
-  gem 'grape', version
-end
+gem 'grape', case version = ENV['GRAPE_VERSION'] || '~> 0.18'
+             when 'HEAD'
+               { github: 'ruby-grape/grape' }
+             else
+               version
+             end
 
 gem ENV['MODEL_PARSER'] if ENV.key?('MODEL_PARSER')
 
-if RUBY_VERSION < '2.2.2'
-  gem 'rack', '<2.0.0'
-  gem 'activesupport', '<5.0.0'
+group :development, :test do
+  gem 'bundler'
+  gem 'kramdown'
+  gem 'pry', platforms: [:mri]
+  gem 'pry-byebug', platforms: [:mri]
+  gem 'rack'
+  gem 'rack-cors'
+  gem 'rack-test'
+  gem 'rake'
+  gem 'rdoc'
+  gem 'redcarpet', platforms: [:mri]
+  gem 'rouge', platforms: [:mri]
+  gem 'rspec', '~> 3.0'
+  gem 'rubocop', '~> 0.40'
+  gem 'shoulda'
 end
-
 group :test do
-  gem 'ruby-grape-danger', '~> 0.1.0', require: false
   gem 'grape-entity'
   gem 'grape-swagger-entity'
+  gem 'ruby-grape-danger', '~> 0.1.0', require: false
 end

data/UPGRADING.md

@@ -1,5 +1,27 @@
-Upgrading Grape-swagger
-=======================
+## Upgrading Grape-swagger
+
+### Upgrading to >= 0.25.2
+
+Avoids ambiguous documentation of array parameters,
+by enforcing correct usage of both possibilities:
+
+1. Array of primitive types
+  ```ruby
+  params do
+    requires :foo, type: Array[String]
+  end
+  ```
+
+2. Array of objects
+  ```ruby
+  params do
+    requires :put_params, type: Array do
+      requires :op, type: String
+      requires :path, type: String
+      requires :value, type: String
+    end
+  end
+```
 
 ### Upgrading to >= 0.25.0
 

data/grape-swagger.gemspec

@@ -13,20 +13,6 @@ Gem::Specification.new do |s|
 
   s.add_runtime_dependency 'grape', '>= 0.12.0'
 
-  s.add_development_dependency 'rake'
-  s.add_development_dependency 'shoulda'
-  s.add_development_dependency 'rdoc'
-  s.add_development_dependency 'rspec', '~> 3.0'
-  s.add_development_dependency 'bundler'
-  s.add_development_dependency 'rack-test'
-  s.add_development_dependency 'rack-cors'
-  s.add_development_dependency 'rubocop', '~> 0.40'
-  s.add_development_dependency 'kramdown'
-  s.add_development_dependency 'redcarpet' unless RUBY_PLATFORM.eql?('java') || RUBY_ENGINE.eql?('rbx')
-  s.add_development_dependency 'rouge' unless RUBY_PLATFORM.eql?('java') || RUBY_ENGINE.eql?('rbx')
-  s.add_development_dependency 'pry' unless RUBY_PLATFORM.eql?('java') || RUBY_ENGINE.eql?('rbx')
-  s.add_development_dependency 'pry-byebug' unless RUBY_PLATFORM.eql?('java') || RUBY_ENGINE.eql?('rbx')
-
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec}/*`.split("\n")
   s.require_paths = ['lib']

data/lib/grape-swagger/doc_methods.rb

@@ -1,5 +1,4 @@
 require 'grape-swagger/doc_methods/status_codes'
-
 require 'grape-swagger/doc_methods/produces_consumes'
 require 'grape-swagger/doc_methods/data_type'
 require 'grape-swagger/doc_methods/extensions'

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

@@ -32,7 +32,12 @@ module GrapeSwagger
         def parse_multi_type(raw_data_type)
           case raw_data_type
           when /\A\[.*\]\z/
-            raw_data_type.gsub(/[\[\s+\]]/, '').split(',').first
+            type_as_string = raw_data_type.gsub(/[\[\s+\]]/, '').split(',').first
+            begin
+              Object.const_get(type_as_string)
+            rescue NameError
+              type_as_string
+            end
           when Array
             raw_data_type.first
           else
@@ -71,6 +76,10 @@ module GrapeSwagger
         def mapping(value)
           PRIMITIVE_MAPPINGS[value] || 'string'
         end
+
+        def collections
+          %w(csv ssv tsv pipes multi)
+        end
       end
 
       PRIMITIVE_MAPPINGS = {

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

@@ -12,9 +12,10 @@ module GrapeSwagger
           @definitions = definitions
           unify!(params)
 
-          return correct_array_param(params) if should_correct_array?(params)
-
           params_to_move = movable_params(params)
+
+          return (params + correct_array_param(params_to_move)) if should_correct_array?(params_to_move)
+
           params << parent_definition_of_params(params_to_move, route)
 
           params
@@ -33,7 +34,7 @@ module GrapeSwagger
         end
 
         def parent_definition_of_params(params, route)
-          definition_name = GrapeSwagger::DocMethods::OperationId.manipulate(parse_model(route.path))
+          definition_name = OperationId.manipulate(parse_model(route.path))
           referenced_definition = build_definition(definition_name, params, route.request_method.downcase)
           definition = @definitions[referenced_definition]
 

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

@@ -20,6 +20,7 @@ module GrapeSwagger
           operation = path.split('/').map(&:capitalize).join
           operation.gsub!(/\-(\w)/, &:upcase).delete!('-') if operation.include?('-')
           operation.gsub!(/\_(\w)/, &:upcase).delete!('_') if operation.include?('_')
+          operation.gsub!(/\.(\w)/, &:upcase).delete!('.') if operation.include?('.')
           if path.include?('{')
             operation.gsub!(/\{(\w)/, &:upcase)
             operation.delete!('{').delete!('}')

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

@@ -8,7 +8,7 @@ module GrapeSwagger
 
           additional_documentation = settings.fetch(:documentation, {})
           settings.merge!(additional_documentation)
-          data_type = GrapeSwagger::DocMethods::DataType.call(settings)
+          data_type = DataType.call(settings)
 
           value_type = settings.merge(data_type: data_type, path: path, param_name: param, method: method)
 
@@ -52,8 +52,8 @@ module GrapeSwagger
         end
 
         def document_type_and_format(data_type)
-          if GrapeSwagger::DocMethods::DataType.primitive?(data_type)
-            data = GrapeSwagger::DocMethods::DataType.mapping(data_type)
+          if DataType.primitive?(data_type)
+            data = DataType.mapping(data_type)
             @parsed_param[:type], @parsed_param[:format] = data
           else
             @parsed_param[:type] = data_type
@@ -64,7 +64,7 @@ module GrapeSwagger
           if value_type[:documentation].present?
             param_type = value_type[:documentation][:param_type]
             doc_type = value_type[:documentation][:type]
-            type = GrapeSwagger::DocMethods::DataType.mapping(doc_type) if doc_type && !DataType.request_primitive?(doc_type)
+            type = DataType.mapping(doc_type) if doc_type && !DataType.request_primitive?(doc_type)
             collection_format = value_type[:documentation][:collectionFormat]
           end
 
@@ -74,14 +74,14 @@ module GrapeSwagger
           if definitions[value_type[:data_type]]
             array_items['$ref'] = "#/definitions/#{@parsed_param[:type]}"
           else
-            array_items[:type] = type || @parsed_param[:type]
+            array_items[:type] = type || @parsed_param[:type] == 'array' ? 'string' : @parsed_param[:type]
           end
           array_items[:format] = @parsed_param.delete(:format) if @parsed_param[:format]
 
           @parsed_param[:in] = param_type || 'formData'
           @parsed_param[:items] = array_items
           @parsed_param[:type] = 'array'
-          @parsed_param[:collectionFormat] = collection_format if %w(csv ssv tsv pipes multi).include?(collection_format)
+          @parsed_param[:collectionFormat] = collection_format if DataType.collections.include?(collection_format)
         end
 
         def param_type(value_type)
@@ -91,7 +91,7 @@ module GrapeSwagger
           elsif param_type
             param_type
           elsif %w(POST PUT PATCH).include?(value_type[:method])
-            GrapeSwagger::DocMethods::DataType.request_primitive?(value_type[:data_type]) ? 'formData' : 'body'
+            DataType.request_primitive?(value_type[:data_type]) ? 'formData' : 'body'
           else
             'query'
           end

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

@@ -20,7 +20,7 @@ module GrapeSwagger
             path.sub!('/{version}', '')
           end
 
-          path = "#{GrapeSwagger::DocMethods::OptionalObject.build(:base_path, options)}#{path}" if options[:add_base_path]
+          path = "#{OptionalObject.build(:base_path, options)}#{path}" if options[:add_base_path]
 
           [item, path.start_with?('/') ? path : "/#{path}"]
         end

data/lib/grape-swagger/endpoint.rb

@@ -9,7 +9,9 @@ module Grape
       if content_types.empty?
         formats       = [target_class.format, target_class.default_format].compact.uniq
         formats       = Grape::Formatter::Base.formatters({}).keys if formats.empty?
-        content_types = Grape::ContentTypes::CONTENT_TYPES.select { |content_type, _mime_type| formats.include? content_type }.values
+        content_types = Grape::ContentTypes::CONTENT_TYPES.select do |content_type, _mime_type|
+          formats.include? content_type
+        end.values
       end
 
       content_types.uniq
@@ -151,7 +153,9 @@ module Grape
 
     def consumes_object(route, format)
       method = route.request_method.downcase.to_sym
-      format = route.settings[:description][:consumes] if route.settings[:description] && route.settings[:description][:consumes]
+      if route.settings[:description] && route.settings[:description][:consumes]
+        format = route.settings[:description][:consumes]
+      end
       mime_types = GrapeSwagger::DocMethods::ProducesConsumes.call(format) if [:post, :put].include?(method)
 
       mime_types
@@ -199,10 +203,11 @@ module Grape
 
         @definitions[response_model][:description] = description_object(route, markdown)
         # 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]
-                                        { 'type' => 'array', 'items' => { '$ref' => "#/definitions/#{response_model}" } }
+                                        { 'type' => 'array', 'items' => reference }
                                       else
-                                        { '$ref' => "#/definitions/#{response_model}" }
+                                        reference
                                       end
       end
     end
@@ -223,7 +228,11 @@ module Grape
     end
 
     def tag_object(route)
-      Array(route.path.split('{')[0].split('/').reject(&:empty?).delete_if { |i| ((i == route.prefix.to_s) || (i == route.version)) }.first)
+      Array(
+        route.path.split('{')[0].split('/').reject(&:empty?).delete_if do |i|
+          i == route.prefix.to_s || i == route.version
+        end.first
+      )
     end
 
     private
@@ -240,7 +249,9 @@ module Grape
                          parse_request_params(required)
                        end || {}
 
-      request_params = route.params.merge(request_params) if route.params.present? && !route.settings[:declared_params].present?
+      if route.params.present? && !route.settings[:declared_params].present?
+        request_params = route.params.merge(request_params)
+      end
 
       request_params
     end
@@ -295,7 +306,10 @@ module Grape
       raise GrapeSwagger::Errors::UnregisteredParser, "No parser registered for #{model_name}." unless parser
 
       properties = parser.new(model, self).call
-      raise GrapeSwagger::Errors::SwaggerSpec, "Empty model #{model_name}, swagger 2.0 doesn't support empty definitions." unless properties && properties.any?
+      unless properties && properties.any?
+        raise GrapeSwagger::Errors::SwaggerSpec,
+              "Empty model #{model_name}, swagger 2.0 doesn't support empty definitions."
+      end
 
       @definitions[model_name] = GrapeSwagger::DocMethods::BuildModelDefinition.build(model, properties)
 

data/lib/grape-swagger/markdown/redcarpet_adapter.rb

@@ -6,7 +6,9 @@ module GrapeSwagger
 
         def block_code(code, language)
           language ||= 'text'
-          "<div class=\"code_highlight\"><pre><code class=\"highlight #{language}\">#{CGI.escapeHTML(code)}</code></pre></div>"
+          "<div class=\"code_highlight\">
+            <pre><code class=\"highlight #{language}\">#{CGI.escapeHTML(code)}</code></pre>
+          </div>"
         end
       end
 
@@ -31,7 +33,8 @@ module GrapeSwagger
       # when you want to have rouge as syntax highlighter add rouge to the gemfile or run:
       # $ (sudo) gem install rouge
       #
-      # GrapeSwagger::Markdown::RedcarpetAdapter.new({highlighter: :none},{no_links: true}) # will use no syntax highlighter and won't render links.
+      # GrapeSwagger::Markdown::RedcarpetAdapter.new({highlighter: :none},{no_links: true})
+      # will use no syntax highlighter and won't render links.
       ###
       def initialize(options = {})
         require 'redcarpet'

data/lib/grape-swagger/version.rb

@@ -1,3 +1,3 @@
 module GrapeSwagger
-  VERSION = '0.25.2'.freeze
+  VERSION = '0.25.3'.freeze
 end

data/spec/issues/427_entity_as_string_spec.rb

@@ -1,6 +1,4 @@
 require 'spec_helper'
-require 'grape-entity'
-require 'grape-swagger-entity'
 
 describe '#427 nested entity given as string' do
   let(:app) do

data/spec/issues/430_entity_definitions_spec.rb

@@ -1,6 +1,4 @@
 require 'spec_helper'
-require 'grape-entity'
-require 'grape-swagger-entity'
 
 describe 'definition names' do
   before :all do

data/spec/issues/539_array_post_body_spec.rb

@@ -1,6 +1,4 @@
 require 'spec_helper'
-require 'grape-entity'
-require 'grape-swagger-entity'
 
 describe '#539 post params given as array' do
   let(:app) do

data/spec/issues/542_array_of_type_in_post_body_spec.rb

@@ -1,6 +1,4 @@
 require 'spec_helper'
-require 'grape-entity'
-require 'grape-swagger-entity'
 
 describe '#542 array of type in post params' do
   let(:app) do

data/spec/issues/553_align_array_put_post_params_spec.rb

@@ -0,0 +1,142 @@
+require 'spec_helper'
+
+describe '#553 array of type in post/put params' do
+  let(:app) do
+    Class.new(Grape::API) do
+      namespace :in_form_data do
+        desc 'create foo'
+        params do
+          requires :guid, type: Array[String]
+        end
+        post do
+          # your code goes here
+        end
+
+        desc 'put specific foo'
+        params do
+          requires :id
+          requires :guid, type: Array[String]
+        end
+        put ':id' do
+          # your code goes here
+        end
+      end
+
+      namespace :in_body do
+        desc 'create foo'
+        params do
+          requires :guid, type: Array[String], documentation: { param_type: 'body' }
+        end
+        post do
+          # your code goes here
+        end
+
+        desc 'put specific foo'
+        params do
+          requires :id
+          requires :guid, type: Array[String], documentation: { param_type: 'body' }
+        end
+        put ':id' do
+          # your code goes here
+        end
+      end
+
+      add_swagger_documentation format: :json
+    end
+  end
+
+  subject do
+    get '/swagger_doc'
+    JSON.parse(last_response.body)
+  end
+
+  describe 'type for Array specified' do
+    describe 'in formData' do
+      describe 'post request' do
+        let(:params) { subject['paths']['/in_form_data']['post']['parameters'] }
+
+        specify do
+          expect(params).to eql([{
+            'in' => 'formData',
+            'name' => 'guid',
+            'type' => 'array',
+            'items' => { 'type' => 'string' },
+            'required' => true
+          }])
+        end
+      end
+
+      describe 'put request' do
+        let(:params) { subject['paths']['/in_form_data/{id}']['put']['parameters'] }
+
+        specify do
+          expect(params).to eql(
+            [
+              {
+                'in' => 'path',
+                'name' => 'id',
+                'type' => 'string',
+                'required' => true
+              },
+              {
+                'in' => 'formData',
+                'name' => 'guid',
+                'type' => 'array',
+                'items' => { 'type' => 'string' },
+                'required' => true
+              }
+            ]
+          )
+        end
+      end
+    end
+
+    describe 'in body' do
+      describe 'post request' do
+        let(:params) { subject['paths']['/in_body']['post']['parameters'] }
+
+        specify do
+          expect(params).to eql(
+            [
+              {
+                'in' => 'body',
+                'name' => 'guid',
+                'required' => true,
+                'schema' => {
+                  'type' => 'array',
+                  'items' => { 'type' => 'string' }
+                }
+              }
+            ]
+          )
+        end
+      end
+
+      describe 'put request' do
+        let(:params) { subject['paths']['/in_body/{id}']['put']['parameters'] }
+
+        specify do
+          expect(params).to eql(
+            [
+              {
+                'in' => 'path',
+                'name' => 'id',
+                'type' => 'string',
+                'required' => true
+              },
+              {
+                'in' => 'body',
+                'name' => 'guid',
+                'required' => true,
+                'schema' => {
+                  'type' => 'array',
+                  'items' => { 'type' => 'string' }
+                }
+              }
+            ]
+          )
+        end
+      end
+    end
+  end
+end

data/spec/lib/data_type_spec.rb

@@ -1,6 +1,15 @@
 require 'spec_helper'
 
 describe GrapeSwagger::DocMethods::DataType do
+  before do
+    stub_const 'MyEntity', Class.new
+    MyEntity.class_eval do
+      def self.entity_name
+        'MyInteger'
+      end
+    end
+  end
+
   subject { described_class.call(value) }
 
   describe 'standards' do
@@ -36,6 +45,12 @@ describe GrapeSwagger::DocMethods::DataType do
     it { expect(subject).to eql 'string' }
   end
 
+  describe 'Types in array with entity_name' do
+    let(:value) { { type: '[MyEntity]' } }
+
+    it { expect(subject).to eql 'MyInteger' }
+  end
+
   describe 'Rack::Multipart::UploadedFile' do
     let(:value) { { type: Rack::Multipart::UploadedFile } }
 

data/spec/spec_helper.rb

@@ -8,6 +8,9 @@ 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")
 
+require 'grape-entity'
+require 'grape-swagger-entity'
+
 Bundler.setup :default, :test
 
 require 'rack'

data/spec/swagger_v2/operation_id_api_spec.rb

@@ -0,0 +1,25 @@
+require 'spec_helper'
+
+describe 'an operation id api' do
+  def app
+    Class.new(Grape::API) do
+      version '0.1'
+
+      desc 'Show this endpoint'
+      get '/simple_opp' do
+        { foo: 'bar' }
+      end
+
+      add_swagger_documentation format: :json
+    end
+  end
+
+  subject do
+    get '/0.1/swagger_doc.json'
+    JSON.parse(last_response.body)
+  end
+
+  it 'uses build name as operationId' do
+    expect(subject['paths']['/0.1/simple_opp']['get']['operationId']).to eql('get01SimpleOpp')
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: grape-swagger
 version: !ruby/object:Gem::Version
-  version: 0.25.2
+  version: 0.25.3
 platform: ruby
 authors:
 - Tim Vandecasteele
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-11-29 00:00:00.000000000 Z
+date: 2016-12-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: grape
@@ -24,188 +24,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.12.0
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: shoulda
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rdoc
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rack-test
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rack-cors
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rubocop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.40'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.40'
-- !ruby/object:Gem::Dependency
-  name: kramdown
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: redcarpet
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rouge
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: pry
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: pry-byebug
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 description: 
 email:
 - tim.vandecasteele@gmail.com
@@ -264,6 +82,7 @@ files:
 - spec/issues/533_specify_status_code_spec.rb
 - spec/issues/539_array_post_body_spec.rb
 - spec/issues/542_array_of_type_in_post_body_spec.rb
+- spec/issues/553_align_array_put_post_params_spec.rb
 - spec/lib/data_type_spec.rb
 - spec/lib/endpoint_spec.rb
 - spec/lib/extensions_spec.rb
@@ -320,6 +139,7 @@ files:
 - spec/swagger_v2/namespace_tags_spec.rb
 - spec/swagger_v2/namespaced_api_spec.rb
 - spec/swagger_v2/nicknamed_api_spec.rb
+- spec/swagger_v2/operation_id_api_spec.rb
 - spec/swagger_v2/param_multi_type_spec.rb
 - spec/swagger_v2/param_type_spec.rb
 - spec/swagger_v2/param_values_spec.rb
@@ -364,6 +184,7 @@ test_files:
 - spec/issues/533_specify_status_code_spec.rb
 - spec/issues/539_array_post_body_spec.rb
 - spec/issues/542_array_of_type_in_post_body_spec.rb
+- spec/issues/553_align_array_put_post_params_spec.rb
 - spec/lib/data_type_spec.rb
 - spec/lib/endpoint_spec.rb
 - spec/lib/extensions_spec.rb
@@ -420,6 +241,7 @@ test_files:
 - spec/swagger_v2/namespace_tags_spec.rb
 - spec/swagger_v2/namespaced_api_spec.rb
 - spec/swagger_v2/nicknamed_api_spec.rb
+- spec/swagger_v2/operation_id_api_spec.rb
 - spec/swagger_v2/param_multi_type_spec.rb
 - spec/swagger_v2/param_type_spec.rb
 - spec/swagger_v2/param_values_spec.rb