grape-swagger 0.31.1 → 0.32.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5e20b96cce4f137604bc4133b23249fde90b242160469cd6ed347d2840bd5b74
-  data.tar.gz: 5e6d17f9875b63983b186d920dc28cdc4a957f13bc9f511a61991dbc7196ce50
+  metadata.gz: ea7cb947847696a10190ade08cfbe8bf19364a4b5855d932abda009c672122c4
+  data.tar.gz: 8a9c2f4a2bff62b247b795b6082d825d9403382ef56626f93ed697b4b654dc54
 SHA512:
-  metadata.gz: f2596bf6f153d0447fec637fc4c035fa2bc1d3806feebf2f71a9e6fcd9c950a40d7bbd02fa703ad11994a0b4969fb014a0342a4dc01a7c3224c6670d126ffb73
-  data.tar.gz: 39e5bfb7503ae7ea188231768db59fd89b8ef41494edb18ec8bf3e1cc458fda5fcf6db381663e06681e2b4b476e454147a4494232c316901a88caf2955ea7e92
+  metadata.gz: 45dfe914ee2225ab36174fd182563a56aaf8cfb78f9aaccdc8a4070e47acb41e0010f31c283d6bef76819a296539457da5095191e17e181d0acf4271f743bcf0
+  data.tar.gz: 0ab65509589c8537b7f77810dd76be2fb50e092796570a333704a9b06893e8a5756988465214752df3b0a2093a731e33e10b229b7c879568e28d2f247a79dd68

data/.rubocop_todo.yml

@@ -1,11 +1,18 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2018-09-28 22:03:50 -0400 using RuboCop version 0.59.2.
+# on 2018-11-04 01:12:26 +0100 using RuboCop version 0.60.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: 1
+# Configuration parameters: Include.
+# Include: **/*.gemfile, **/Gemfile, **/gems.rb
+Bundler/DuplicatedGem:
+  Exclude:
+    - 'Gemfile'
+
 # Offense count: 1
 # Configuration parameters: Include.
 # Include: **/*.gemspec
@@ -35,6 +42,6 @@ Style/ClassVars:
   Exclude:
     - 'lib/grape-swagger/doc_methods.rb'
 
-# Offense count: 21
+# Offense count: 22
 Style/Documentation:
   Enabled: false

data/.travis.yml

@@ -11,22 +11,22 @@ after_success:
   - bundle exec danger
 
 rvm:
-  - 2.5.1
-  - 2.4.4
+  - 2.4.5
+  - 2.5.3
+  - 2.6.0-preview2
 env:
   - MODEL_PARSER=grape-swagger-entity
   - MODEL_PARSER=grape-swagger-representable
-  - GRAPE_VERSION=0.17.0
-  - GRAPE_VERSION=0.18.0
   - GRAPE_VERSION=0.19.2
   - GRAPE_VERSION=1.0.3
+  - GRAPE_VERSION=1.2.0
   - GRAPE_VERSION=HEAD
 
 matrix:
   fast_finish: true
 
   include:
-    - rvm: 2.3.7
+    - rvm: 2.3.8
       env:
     - rvm: ruby-head
       env:
@@ -34,6 +34,6 @@ matrix:
       env:
 
   allow_failures:
-    - rvm: 2.3.7
+    - rvm: 2.3.8
     - rvm: ruby-head
     - rvm: jruby-head

data/CHANGELOG.md

@@ -1,3 +1,23 @@
+### Next
+
+#### Features
+
+* Your contribution here.
+
+#### Fixes
+
+* Your contribution here.
+
+### 0.32.0 (November 26, 2018)
+
+#### Features
+
+* [#717](https://github.com/ruby-grape/grape-swagger/pull/717): Adds support for grape >= 1.2 - [@myxoh](https://github.com/myxoh).
+
+#### Fixes
+
+* [#720](https://github.com/ruby-grape/grape-swagger/pull/720): Fix: corrected `termsOfService` field name in additional info - [@dblock](https://github.com/dblock).
+
 ### 0.31.1 (October 23, 2018)
 
 #### Features

data/Gemfile

@@ -6,7 +6,7 @@ ruby RUBY_VERSION
 
 gemspec
 
-gem 'grape', case version = ENV['GRAPE_VERSION'] || '~> 1.0'
+gem 'grape', case version = ENV['GRAPE_VERSION'] || '~> 1.2'
              when 'HEAD'
                { git: 'https://github.com/ruby-grape/grape' }
              else
@@ -26,7 +26,12 @@ group :development, :test do
   gem 'rake'
   gem 'rdoc'
   gem 'rspec', '~> 3.0'
-  gem 'rubocop', '~> 0.59', require: false
+  # TODO: change back after 2.6.0 release and updated rubocop version
+  if RUBY_VERSION == '2.6.0'
+    gem 'rubocop', git: 'https://github.com/rubocop-hq/rubocop.git', require: false
+  else
+    gem 'rubocop', '~> 0.60', require: false
+  end
 end
 
 group :test do

data/README.md

@@ -48,8 +48,9 @@ grape-swagger | swagger spec | grape                   | grape-entity | represen
 0.10.5        |     1.2      | >= 0.10.0 ... <= 0.14.0 |  < 0.5.0     | n/a           |
 0.11.0        |     1.2      |               >= 0.16.2 |  < 0.5.0     | n/a           |
 0.25.2        |     2.0      | >= 0.14.0 ... <= 0.18.0 | <= 0.6.0     | >= 2.4.1      |
-0.26.0        |     2.0      | >= 0.16.2               | <= 0.6.1     | >= 2.4.1      |
-0.27.0        |     2.0      | >= 0.16.2               | >= 0.5.0     | >= 2.4.1      |
+0.26.0        |     2.0      | >= 0.16.2     <= 1.1.0  | <= 0.6.1     | >= 2.4.1      |
+0.27.0        |     2.0      | >= 0.16.2 ... <= 1.1.0  | >= 0.5.0     | >= 2.4.1      |
+0.32.0        |     2.0      | >= 0.16.2               | >= 0.5.0     | >= 2.4.1      |
 
 
 ## Swagger-Spec <a name="swagger-spec"></a>

data/lib/grape-swagger.rb

@@ -2,6 +2,8 @@
 
 require 'grape'
 
+require 'grape-swagger/instance'
+
 require 'grape-swagger/version'
 require 'grape-swagger/endpoint'
 require 'grape-swagger/errors'
@@ -18,148 +20,152 @@ module GrapeSwagger
   autoload :Rake, 'grape-swagger/rake/oapi_tasks'
 end
 
-module Grape
-  class API
-    class << self
-      attr_accessor :combined_routes, :combined_namespaces, :combined_namespace_routes, :combined_namespace_identifiers
-
-      def add_swagger_documentation(options = {})
-        documentation_class = create_documentation_class
+module SwaggerRouting
+  private
 
-        version_for(options)
-        options = { target_class: self }.merge(options)
-        @target_class = options[:target_class]
-        auth_wrapper = options[:endpoint_auth_wrapper] || Class.new
+  def combine_routes(app, doc_klass)
+    app.routes.each do |route|
+      route_path = route.path
+      route_match = route_path.split(/^.*?#{route.prefix.to_s}/).last
+      next unless route_match
 
-        use auth_wrapper if auth_wrapper.method_defined?(:before) && !middleware.flatten.include?(auth_wrapper)
+      route_match = route_match.match('\/([\w|-]*?)[\.\/\(]') || route_match.match('\/([\w|-]*)$')
+      next unless route_match
 
-        documentation_class.setup(options)
-        mount(documentation_class)
+      resource = route_match.captures.first
+      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 = {}
-        combine_routes(@target_class, documentation_class)
+      @target_class.combined_routes[resource].unshift route
+    end
+  end
 
-        @target_class.combined_namespaces = {}
-        combine_namespaces(@target_class)
+  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
 
-        @target_class.combined_namespace_routes = {}
-        @target_class.combined_namespace_identifiers = {}
-        combine_namespace_routes(@target_class.combined_namespaces)
+  def combine_namespace_routes(namespaces)
+    # iterate over each single namespace
+    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 = determine_namespaced_routes(name, parent_route)
+
+      # default case when not explicitly specified or nested == true
+      standalone_namespaces = namespaces.reject do |_, ns|
+        !ns.options.key?(:swagger) ||
+          !ns.options[:swagger].key?(:nested) ||
+          ns.options[:swagger][:nested] != false
+      end
 
-        exclusive_route_keys = @target_class.combined_routes.keys - @target_class.combined_namespaces.keys
-        exclusive_route_keys.each do |key|
-          @target_class.combined_namespace_routes[key] = @target_class.combined_routes[key]
-        end
-        documentation_class
+      parent_standalone_namespaces = standalone_namespaces.select { |ns_name, _| name.start_with?(ns_name) }
+      # add only to the main route
+      # if the namespace is not within any other namespace appearing as standalone resource
+      # rubocop:disable Style/Next
+      if parent_standalone_namespaces.empty?
+        # default option, append namespace methods to parent route
+        parent_route = @target_class.combined_namespace_routes.key?(parent_route_name)
+        @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
 
-      private
+  def extract_parent_route(name)
+    route_name = name.match(%r{^/?([^/]*).*$})[1]
+    return route_name unless route_name.include? ':'
 
-      def version_for(options)
-        options[:version] = version if version
-      end
+    matches = name.match(/\/[a-z]+/)
+    matches.nil? ? route_name : matches[0].delete('/')
+  end
 
-      def combine_routes(app, doc_klass)
-        app.routes.each do |route|
-          route_path = route.path
-          route_match = route_path.split(/^.*?#{route.prefix.to_s}/).last
-          next unless route_match
+  def route_instance_variable(route)
+    route.instance_variable_get(:@options)[:namespace]
+  end
 
-          route_match = route_match.match('\/([\w|-]*?)[\.\/\(]') || route_match.match('\/([\w|-]*)$')
-          next unless route_match
+  def route_instance_variable_equals?(route, name)
+    route_instance_variable(route) == "/#{name}" ||
+      route_instance_variable(route) == "/:version/#{name}"
+  end
 
-          resource = route_match.captures.first
-          resource = '/' if resource.empty?
-          @target_class.combined_routes[resource] ||= []
-          next if doc_klass.hide_documentation_path && route.path.match(/#{doc_klass.mount_path}($|\/|\(\.)/)
+  def route_path_start_with?(route, name)
+    route_prefix = route.prefix ? "/#{route.prefix}/#{name}" : "/#{name}"
+    route_versioned_prefix = route.prefix ? "/#{route.prefix}/:version/#{name}" : "/:version/#{name}"
 
-          @target_class.combined_routes[resource].unshift route
-        end
-      end
+    route.path.start_with?(route_prefix, route_versioned_prefix)
+  end
+end
 
-      def combine_namespaces(app)
-        app.endpoints.each do |endpoint|
-          ns = endpoint.namespace_stackable(:namespace).last
+module SwaggerDocumentationAdder
+  attr_accessor :combined_namespaces, :combined_namespace_identifiers
+  attr_accessor :combined_routes, :combined_namespace_routes
+  include SwaggerRouting
 
-          # use the full namespace here (not the latest level only)
-          # and strip leading slash
-          mount_path = (endpoint.namespace_stackable(:mount_path) || []).join('/')
-          full_namespace = (mount_path + endpoint.namespace).sub(/\/{2,}/, '/').sub(/^\//, '')
-          @target_class.combined_namespaces[full_namespace] = ns if ns
+  def add_swagger_documentation(options = {})
+    documentation_class = create_documentation_class
 
-          combine_namespaces(endpoint.options[:app]) if endpoint.options[:app]
-        end
-      end
+    version_for(options)
+    options = { target_class: self }.merge(options)
+    @target_class = options[:target_class]
+    auth_wrapper = options[:endpoint_auth_wrapper] || Class.new
 
-      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
+    use auth_wrapper if auth_wrapper.method_defined?(:before) && !middleware.flatten.include?(auth_wrapper)
 
-      def combine_namespace_routes(namespaces)
-        # iterate over each single namespace
-        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 = determine_namespaced_routes(name, parent_route)
-
-          # default case when not explicitly specified or nested == true
-          standalone_namespaces = namespaces.reject do |_, ns|
-            !ns.options.key?(:swagger) ||
-              !ns.options[:swagger].key?(:nested) ||
-              ns.options[:swagger][:nested] != false
-          end
-
-          parent_standalone_namespaces = standalone_namespaces.select { |ns_name, _| name.start_with?(ns_name) }
-          # add only to the main route
-          # if the namespace is not within any other namespace appearing as standalone resource
-          # rubocop:disable Style/Next
-          if parent_standalone_namespaces.empty?
-            # default option, append namespace methods to parent route
-            parent_route = @target_class.combined_namespace_routes.key?(parent_route_name)
-            @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
+    documentation_class.setup(options)
+    mount(documentation_class)
 
-      def extract_parent_route(name)
-        route_name = name.match(%r{^/?([^/]*).*$})[1]
-        return route_name unless route_name.include? ':'
+    @target_class.combined_routes = {}
+    combine_routes(@target_class, documentation_class)
 
-        matches = name.match(/\/[a-z]+/)
-        matches.nil? ? route_name : matches[0].delete('/')
-      end
+    @target_class.combined_namespaces = {}
+    combine_namespaces(@target_class)
 
-      def route_instance_variable(route)
-        route.instance_variable_get(:@options)[:namespace]
-      end
+    @target_class.combined_namespace_routes = {}
+    @target_class.combined_namespace_identifiers = {}
+    combine_namespace_routes(@target_class.combined_namespaces)
 
-      def route_instance_variable_equals?(route, name)
-        route_instance_variable(route) == "/#{name}" ||
-          route_instance_variable(route) == "/:version/#{name}"
-      end
+    exclusive_route_keys = @target_class.combined_routes.keys - @target_class.combined_namespaces.keys
+    exclusive_route_keys.each do |key|
+      @target_class.combined_namespace_routes[key] = @target_class.combined_routes[key]
+    end
+    documentation_class
+  end
 
-      def route_path_start_with?(route, name)
-        route_prefix = route.prefix ? "/#{route.prefix}/#{name}" : "/#{name}"
-        route_versioned_prefix = route.prefix ? "/#{route.prefix}/:version/#{name}" : "/:version/#{name}"
+  private
 
-        route.path.start_with?(route_prefix, route_versioned_prefix)
-      end
+  def version_for(options)
+    options[:version] = version if version
+  end
 
-      def create_documentation_class
-        Class.new(Grape::API) do
-          extend GrapeSwagger::DocMethods
-        end
-      end
+  def combine_namespaces(app)
+    app.endpoints.each do |endpoint|
+      ns = endpoint.namespace_stackable(:namespace).last
+
+      # use the full namespace here (not the latest level only)
+      # and strip leading slash
+      mount_path = (endpoint.namespace_stackable(:mount_path) || []).join('/')
+      full_namespace = (mount_path + endpoint.namespace).sub(/\/{2,}/, '/').sub(/^\//, '')
+      @target_class.combined_namespaces[full_namespace] = ns if ns
+
+      combine_namespaces(endpoint.options[:app]) if endpoint.options[:app]
+    end
+  end
+
+  def create_documentation_class
+    Class.new(GrapeInstance) do
+      extend GrapeSwagger::DocMethods
     end
   end
 end
+
+GrapeInstance.extend(SwaggerDocumentationAdder)

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

@@ -14,7 +14,7 @@ module GrapeSwagger
 
           # required properties
           @parsed_param = {
-            in:   param_type(value_type),
+            in: param_type(value_type),
             name: settings[:full_name] || param
           }
 

data/lib/grape-swagger/endpoint.rb

@@ -25,15 +25,15 @@ module Grape
     # required keys for SwaggerObject
     def swagger_object(target_class, request, options)
       object = {
-        info:                info_object(options[:info].merge(version: options[:doc_version])),
-        swagger:             '2.0',
-        produces:            content_types_for(target_class),
-        authorizations:      options[:authorizations],
+        info: info_object(options[:info].merge(version: options[:doc_version])),
+        swagger: '2.0',
+        produces: content_types_for(target_class),
+        authorizations: options[:authorizations],
         securityDefinitions: options[:security_definitions],
-        security:            options[:security],
-        host:                GrapeSwagger::DocMethods::OptionalObject.build(:host, options, request),
-        basePath:            GrapeSwagger::DocMethods::OptionalObject.build(:base_path, options, request),
-        schemes:             options[:schemes].is_a?(String) ? [options[:schemes]] : options[:schemes]
+        security: options[:security],
+        host: GrapeSwagger::DocMethods::OptionalObject.build(:host, options, request),
+        basePath: GrapeSwagger::DocMethods::OptionalObject.build(:base_path, options, request),
+        schemes: options[:schemes].is_a?(String) ? [options[:schemes]] : options[:schemes]
       }
 
       GrapeSwagger::DocMethods::Extensions.add_extensions_to_root(options, object)
@@ -43,12 +43,12 @@ module Grape
     # building info object
     def info_object(infos)
       result = {
-        title:             infos[:title] || 'API title',
-        description:       infos[:description],
-        termsOfServiceUrl: infos[:terms_of_service_url],
-        contact:           contact_object(infos),
-        license:           license_object(infos),
-        version:           infos[:version]
+        title: infos[:title] || 'API title',
+        description: infos[:description],
+        termsOfService: infos[:terms_of_service_url],
+        contact: contact_object(infos),
+        license: license_object(infos),
+        version: infos[:version]
       }
 
       GrapeSwagger::DocMethods::Extensions.add_extensions_to_info(infos, result)
@@ -61,7 +61,7 @@ module Grape
     def license_object(infos)
       {
         name: infos.delete(:license),
-        url:  infos.delete(:license_url)
+        url: infos.delete(:license_url)
       }.delete_if { |_, value| value.blank? }
     end
 

data/lib/grape-swagger/instance.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+GrapeInstance = if defined? Grape::API::Instance
+                  Grape::API::Instance
+                else
+                  Grape::API
+                end

data/lib/grape-swagger/version.rb

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

data/spec/lib/data_type_spec.rb

@@ -3,15 +3,6 @@
 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
@@ -26,78 +17,83 @@ describe GrapeSwagger::DocMethods::DataType do
   describe 'Hash' do
     let(:value) { { type: Hash } }
 
-    it { expect(subject).to eql 'object' }
+    it { is_expected.to eq 'object' }
   end
 
   describe 'Multi types in a string' do
     let(:value) { { type: '[String, Integer]' } }
 
-    it { expect(subject).to eql 'string' }
+    it { is_expected.to eq 'string' }
   end
 
   describe 'Multi types in a string stating with A' do
     let(:value) { { type: '[Apple, Orange]' } }
 
-    it { expect(subject).to eql 'Apple' }
+    it { is_expected.to eq 'Apple' }
   end
 
   describe 'Multi types in array' do
     let(:value) { { type: [String, Integer] } }
 
-    it { expect(subject).to eql 'string' }
+    it { is_expected.to eq 'string' }
   end
 
   describe 'Types in array with entity_name' do
+    before do
+      stub_const 'MyEntity', Class.new
+      allow(MyEntity).to receive(:entity_name).and_return 'MyInteger'
+    end
+
     let(:value) { { type: '[MyEntity]' } }
 
-    it { expect(subject).to eql 'MyInteger' }
+    it { is_expected.to eq 'MyInteger' }
   end
 
   describe 'Rack::Multipart::UploadedFile' do
     let(:value) { { type: Rack::Multipart::UploadedFile } }
 
-    it { expect(subject).to eql 'file' }
+    it { is_expected.to eq 'file' }
   end
 
   describe 'Virtus::Attribute::Boolean' do
     let(:value) { { type: Virtus::Attribute::Boolean } }
 
-    it { expect(subject).to eql 'boolean' }
+    it { is_expected.to eq 'boolean' }
   end
 
   describe 'BigDecimal' do
     let(:value) { { type: BigDecimal } }
 
-    it { expect(subject).to eql 'double' }
+    it { is_expected.to eq 'double' }
   end
 
   describe 'DateTime' do
     let(:value) { { type: DateTime } }
 
-    it { expect(subject).to eql 'dateTime' }
+    it { is_expected.to eq 'dateTime' }
   end
 
   describe 'Numeric' do
     let(:value) { { type: Numeric } }
 
-    it { expect(subject).to eql 'long' }
+    it { is_expected.to eq 'long' }
   end
 
   describe 'Symbol' do
     let(:value) { { type: Symbol } }
 
-    it { expect(subject).to eql 'string' }
+    it { is_expected.to eq 'string' }
   end
 
   describe '[String]' do
     let(:value) { { type: '[String]' } }
 
-    it { expect(subject).to eq('string') }
+    it { is_expected.to eq('string') }
   end
 
   describe '[Integer]' do
     let(:value) { { type: '[Integer]' } }
 
-    it { expect(subject).to eq('integer') }
+    it { is_expected.to eq('integer') }
   end
 end

data/spec/lib/endpoint/params_parser_spec.rb

@@ -9,18 +9,20 @@ describe GrapeSwagger::Endpoint::ParamsParser do
   let(:parser) { described_class.new(params, settings) }
 
   describe '#parse_request_params' do
+    subject(:parse_request_params) { parser.parse_request_params }
+
     context 'when param is of array type' do
       let(:params) { [['param_1', { type: 'Array[String]' }]] }
 
       it 'adds is_array option' do
-        expect(parser.parse_request_params).to eq('param_1' => { type: 'Array[String]', is_array: true })
+        expect(parse_request_params['param_1']).to eq(type: 'Array[String]', is_array: true)
       end
 
       context 'and array_use_braces setting set to true' do
         let(:settings) { { array_use_braces: true } }
 
         it 'adds braces to the param key' do
-          expect(parser.parse_request_params.keys.first).to eq 'param_1[]'
+          expect(parse_request_params.keys.first).to eq 'param_1[]'
         end
       end
     end
@@ -29,7 +31,7 @@ describe GrapeSwagger::Endpoint::ParamsParser do
       let(:params) { [['param_1', { type: 'String' }]] }
 
       it 'does not change options' do
-        expect(parser.parse_request_params).to eq('param_1' => { type: 'String' })
+        expect(parse_request_params['param_1']).to eq(type: 'String')
       end
 
       context 'and array_use_braces setting set to true' do
@@ -45,18 +47,18 @@ describe GrapeSwagger::Endpoint::ParamsParser do
       let(:params) { [['param_1', { type: 'Array' }], ['param_1[param_2]', { type: 'String' }]] }
 
       it 'skips root parameter' do
-        expect(parser.parse_request_params).not_to have_key 'param_1'
+        is_expected.not_to have_key 'param_1'
       end
 
       it 'adds is_array option to the nested param' do
-        expect(parser.parse_request_params).to eq('param_1[param_2]' => { type: 'String', is_array: true })
+        expect(parse_request_params['param_1[param_2]']).to eq(type: 'String', is_array: true)
       end
 
       context 'and array_use_braces setting set to true' do
         let(:settings) { { array_use_braces: true } }
 
         it 'adds braces to the param key' do
-          expect(parser.parse_request_params.keys.first).to eq 'param_1[][param_2]'
+          expect(parse_request_params.keys.first).to eq 'param_1[][param_2]'
         end
       end
     end
@@ -65,18 +67,18 @@ describe GrapeSwagger::Endpoint::ParamsParser do
       let(:params) { [['param_1', { type: 'Hash' }], ['param_1[param_2]', { type: 'String' }]] }
 
       it 'skips root parameter' do
-        expect(parser.parse_request_params).not_to have_key 'param_1'
+        is_expected.not_to have_key 'param_1'
       end
 
       it 'does not change options to the nested param' do
-        expect(parser.parse_request_params).to eq('param_1[param_2]' => { type: 'String' })
+        expect(parse_request_params['param_1[param_2]']).to eq(type: 'String')
       end
 
       context 'and array_use_braces setting set to true' do
         let(:settings) { { array_use_braces: true } }
 
         it 'does not add braces to the param key' do
-          expect(parser.parse_request_params.keys.first).to eq 'param_1[param_2]'
+          expect(parse_request_params.keys.first).to eq 'param_1[param_2]'
         end
       end
     end

data/spec/lib/move_params_spec.rb

@@ -597,7 +597,7 @@ describe GrapeSwagger::DocMethods::MoveParams do
         let(:definition) do
           {
             type: 'array',
-            items:  {
+            items: {
               type: 'object',
               properties: {
                 description: 'Test description'

data/spec/support/model_parsers/entity_parser.rb

@@ -189,7 +189,7 @@ RSpec.shared_context 'entity swagger example' do
       'info' => {
         'title' => 'The API title to be displayed on the API homepage.',
         'description' => 'A description of the API.',
-        'termsOfServiceUrl' => 'www.The-URL-of-the-terms-and-service.com',
+        'termsOfService' => 'www.The-URL-of-the-terms-and-service.com',
         'contact' => { 'name' => 'Contact name', 'email' => 'Contact@email.com', 'url' => 'Contact URL' },
         'license' => { 'name' => 'The name of the license.', 'url' => 'www.The-URL-of-the-license.org' },
         'version' => '0.0.1'

data/spec/support/model_parsers/mock_parser.rb

@@ -181,7 +181,7 @@ RSpec.shared_context 'mock swagger example' do
       'info' => {
         'title' => 'The API title to be displayed on the API homepage.',
         'description' => 'A description of the API.',
-        'termsOfServiceUrl' => 'www.The-URL-of-the-terms-and-service.com',
+        'termsOfService' => 'www.The-URL-of-the-terms-and-service.com',
         'contact' => { 'name' => 'Contact name', 'email' => 'Contact@email.com', 'url' => 'Contact URL' },
         'license' => { 'name' => 'The name of the license.', 'url' => 'www.The-URL-of-the-license.org' },
         'version' => '0.0.1'

data/spec/support/model_parsers/representable_parser.rb

@@ -261,7 +261,7 @@ RSpec.shared_context 'representable swagger example' do
       'info' => {
         'title' => 'The API title to be displayed on the API homepage.',
         'description' => 'A description of the API.',
-        'termsOfServiceUrl' => 'www.The-URL-of-the-terms-and-service.com',
+        'termsOfService' => 'www.The-URL-of-the-terms-and-service.com',
         'contact' => { 'name' => 'Contact name', 'email' => 'Contact@email.com', 'url' => 'Contact URL' },
         'license' => { 'name' => 'The name of the license.', 'url' => 'www.The-URL-of-the-license.org' },
         'version' => '0.0.1'

data/spec/swagger_v2/api_swagger_v2_headers_spec.rb

@@ -12,7 +12,7 @@ describe 'headers' do
 
         desc 'This returns something',
              failure: [{ code: 400, model: Entities::ApiError }],
-             headers:  {
+             headers: {
                'X-Rate-Limit-Limit' => {
                  'description' => 'The number of allowed requests in the current period',
                  'type' => 'integer'

data/spec/swagger_v2/default_api_spec.rb

@@ -128,7 +128,7 @@ describe 'Default API' do
     end
 
     it 'documents the terms of service url' do
-      expect(subject['termsOfServiceUrl']).to eql('http://terms.com')
+      expect(subject['termsOfService']).to eql('http://terms.com')
     end
 
     it 'documents the contact email' do

data/spec/swagger_v2/endpoint_versioned_path_spec.rb

@@ -3,52 +3,95 @@
 require 'spec_helper'
 
 describe 'Grape::Endpoint#path_and_definitions' do
-  let(:item) do
-    Class.new(Grape::API) do
-      version 'v1', using: :path
+  context 'when mounting an API once' do
+    let(:item) do
+      Class.new(Grape::API) do
+        version 'v1', using: :path
 
-      resource :item do
-        get '/'
+        resource :item do
+          get '/'
+        end
       end
     end
-  end
 
-  let(:api) do
-    item_api = item
+    let(:api) do
+      item_api = item
 
-    Class.new(Grape::API) do
-      mount item_api
-      add_swagger_documentation add_version: true
+      Class.new(Grape::API) do
+        mount item_api
+        add_swagger_documentation add_version: true
+      end
     end
-  end
 
-  let(:options) { { add_version: true } }
-  let(:target_routes) { api.combined_namespace_routes }
+    let(:options) { { add_version: true } }
+    let(:target_routes) { api.combined_namespace_routes }
 
-  subject { api.endpoints[0].path_and_definition_objects(target_routes, options) }
+    subject { api.endpoints[0].path_and_definition_objects(target_routes, options) }
 
-  it 'is returning a versioned path' do
-    expect(subject[0].keys[0]).to eq '/v1/item'
-  end
+    it 'is returning a versioned path' do
+      expect(subject[0].keys[0]).to eq '/v1/item'
+    end
+
+    it 'tags the endpoint with the resource name' do
+      expect(subject.first['/v1/item'][:get][:tags]).to eq ['item']
+    end
+
+    context 'when custom tags are specified' do
+      let(:item) do
+        Class.new(Grape::API) do
+          version 'v1', using: :path
+
+          resource :item do
+            desc 'Item description', tags: ['special-item']
+            get '/'
+          end
+        end
+      end
 
-  it 'tags the endpoint with the resource name' do
-    expect(subject.first['/v1/item'][:get][:tags]).to eq ['item']
+      it 'tags the endpoint with the custom tags' do
+        expect(subject.first['/v1/item'][:get][:tags]).to eq ['special-item']
+      end
+    end
   end
 
-  context 'when custom tags are specified' do
+  context 'when mounting an API more than once', if: GrapeVersion.satisfy?('>= 1.2.0') do
     let(:item) do
       Class.new(Grape::API) do
-        version 'v1', using: :path
-
         resource :item do
-          desc 'Item description', tags: ['special-item']
+          desc 'Item description', tags: [configuration[:tag] || 'item']
           get '/'
         end
       end
     end
 
-    it 'tags the endpoint with the custom tags' do
-      expect(subject.first['/v1/item'][:get][:tags]).to eq ['special-item']
+    let(:api) do
+      item_api = item
+      Class.new(Grape::API) do
+        version 'v1', using: :path do
+          mount item_api
+        end
+
+        version 'v2', using: :path do
+          mount item_api, with: { tag: 'special-item' }
+        end
+
+        add_swagger_documentation add_version: true
+      end
+    end
+
+    let(:options) { { add_version: true } }
+    let(:target_routes) { api.combined_namespace_routes }
+
+    subject { api.endpoints[0].path_and_definition_objects(target_routes, options) }
+
+    it 'retrieves both apis respecting their configured tags' do
+      expect(subject.first['/v1/item'][:get][:tags]).to eq ['item']
+      expect(subject.first['/v2/item'][:get][:tags]).to eq ['special-item']
+    end
+
+    it 'retrieves both apis with descriptions' do
+      expect(subject.first['/v1/item'][:get][:description]).to eq 'Item description'
+      expect(subject.first['/v2/item'][:get][:description]).to eq 'Item description'
     end
   end
 end

data/spec/swagger_v2/grape-swagger_spec.rb

@@ -2,16 +2,16 @@
 
 require 'spec_helper'
 
-describe Grape::API do
+describe GrapeInstance do
   it 'added combined-routes' do
-    expect(Grape::API).to respond_to :combined_routes
+    expect(described_class).to respond_to :combined_routes
   end
 
   it 'added add_swagger_documentation' do
-    expect(Grape::API).to respond_to :add_swagger_documentation
+    expect(described_class).to respond_to :add_swagger_documentation
   end
 
   it 'added combined-namespaces' do
-    expect(Grape::API).to respond_to :combined_namespaces
+    expect(described_class).to respond_to :combined_namespaces
   end
 end

data/spec/swagger_v2/guarded_endpoint_spec.rb

@@ -41,7 +41,7 @@ module Extension
     description[:auth] = { scopes: scopes }
   end
 
-  Grape::API.extend self
+  GrapeInstance.extend self
 end
 
 describe 'a guarded api endpoint' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: grape-swagger
 version: !ruby/object:Gem::Version
-  version: 0.31.1
+  version: 0.32.0
 platform: ruby
 authors:
 - Tim Vandecasteele
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-10-23 00:00:00.000000000 Z
+date: 2018-11-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: grape
@@ -72,6 +72,7 @@ files:
 - lib/grape-swagger/endpoint.rb
 - lib/grape-swagger/endpoint/params_parser.rb
 - lib/grape-swagger/errors.rb
+- lib/grape-swagger/instance.rb
 - lib/grape-swagger/model_parsers.rb
 - lib/grape-swagger/rake/oapi_tasks.rb
 - lib/grape-swagger/version.rb
@@ -189,7 +190,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 2.7.8
 signing_key: 
 specification_version: 4
 summary: Add auto generated documentation to your Grape API that can be displayed