grape-swagger 1.4.2 → 1.6.0

data/lib/grape-swagger/endpoint.rb

@@ -5,7 +5,7 @@ require 'active_support/core_ext/string/inflections'
 require 'grape-swagger/endpoint/params_parser'
 
 module Grape
-  class Endpoint
+  class Endpoint # rubocop:disable Metrics/ClassLength
     def content_types_for(target_class)
       content_types = (target_class.content_types || {}).values
 
@@ -27,7 +27,8 @@ module Grape
       object = {
         info: info_object(options[:info].merge(version: options[:doc_version])),
         swagger: '2.0',
-        produces: content_types_for(target_class),
+        produces: options[:produces] || content_types_for(target_class),
+        consumes: options[:consumes],
         authorizations: options[:authorizations],
         securityDefinitions: options[:security_definitions],
         security: options[:security],
@@ -117,7 +118,7 @@ module Grape
       method[:summary]     = summary_object(route)
       method[:description] = description_object(route)
       method[:produces]    = produces_object(route, options[:produces] || options[:format])
-      method[:consumes]    = consumes_object(route, options[:format])
+      method[:consumes]    = consumes_object(route, options[:consumes] || options[:format])
       method[:parameters]  = params_object(route, options, path)
       method[:security]    = security_object(route)
       method[:responses]   = response_object(route, options)
@@ -240,7 +241,8 @@ module Grape
       if route.http_codes.is_a?(Array) && route.http_codes.any? { |code| success_code?(code) }
         route.http_codes.clone
       else
-        success_codes_from_route(route) + (route.http_codes || route.options[:failure] || [])
+        success_codes_from_route(route) + default_code_from_route(route) +
+          (route.http_codes || route.options[:failure] || [])
       end
     end
 
@@ -267,6 +269,21 @@ module Grape
 
     private
 
+    def default_code_from_route(route)
+      entity = route.options[:default_response]
+      return [] if entity.nil?
+
+      default_code = { code: 'default', message: 'Default Response' }
+      if entity.is_a?(Hash)
+        default_code[:message] = entity[:message] || default_code[:message]
+        default_code[:model] = entity[:model] if entity[:model].present?
+      else
+        default_code[:model] = entity
+      end
+
+      [default_code]
+    end
+
     def build_memo_schema(memo, route, value, response_model, options)
       if memo[value[:code]][:schema] && value[:as]
         memo[value[:code]][:schema][:properties].merge!(build_reference(route, value, response_model, options))
@@ -294,7 +311,7 @@ module Grape
                   else
                     build_reference_hash(response_model)
                   end
-      return reference unless value[:code] < 300
+      return reference unless value[:code] == 'default' || value[:code] < 300
 
       if value.key?(:as) && value.key?(:is_array)
         reference[value[:as]] = build_reference_array(reference[value[:as]])
@@ -348,13 +365,39 @@ module Grape
     end
 
     def merge_params(route)
+      path_params = get_path_params(route.app&.inheritable_setting&.namespace_stackable)
       param_keys = route.params.keys
+
+      # Merge path params options into route params
+      route_params = route.params
+      route_params.each_key do |key|
+        path = path_params[key] || {}
+        params = route_params[key]
+        params = {} unless params.is_a? Hash
+        route_params[key] = path.merge(params)
+      end
+
       route.params.delete_if { |key| key.is_a?(String) && param_keys.include?(key.to_sym) }.to_a
     end
 
+    # Iterates over namespaces recursively
+    # to build a hash of path params with options, including type
+    def get_path_params(stackable_values)
+      params = {}
+      return param unless stackable_values
+      return params unless stackable_values.is_a? Grape::Util::StackableValues
+
+      stackable_values&.new_values&.dig(:namespace)&.each do |namespace|
+        space = namespace.space.to_s.gsub(':', '')
+        params[space] = namespace.options || {}
+      end
+      inherited_params = get_path_params(stackable_values.inherited_values)
+      inherited_params.merge(params)
+    end
+
     def default_type(params)
       default_param_type = { required: true, type: 'Integer' }
-      params.each { |param| param[-1] = param.last == '' ? default_param_type : param.last }
+      params.each { |param| param[-1] = param.last.empty? ? default_param_type : param.last }
     end
 
     def expose_params(value)

data/lib/grape-swagger/rake/oapi_tasks.rb

@@ -46,9 +46,12 @@ module GrapeSwagger
           resource - if given only for that it would be generated (optional)'
         task fetch: :environment do
           # :nocov:
-          make_request
+          urls_for(api_class).each do |url|
+            make_request(url)
+
+            save_to_file? ? File.write(file(url), @oapi) : $stdout.print(@oapi)
+          end
 
-          save_to_file? ? File.write(file, @oapi) : $stdout.print(@oapi)
           # :nocov:
         end
       end
@@ -64,10 +67,15 @@ module GrapeSwagger
           ::Rake::Task['oapi:fetch'].invoke
           exit if error?
 
-          output = system "swagger-cli validate #{file}"
+          urls_for(api_class).each do |url|
+            @output = system "swagger-cli validate #{file(url)}"
+
+            FileUtils.rm(
+              file(url)
+            )
+          end
 
-          $stdout.puts 'install swagger-cli with `npm install swagger-cli -g`' if output.nil?
-          FileUtils.rm(file)
+          $stdout.puts 'install swagger-cli with `npm install swagger-cli -g`' if @output.nil?
           # :nocov:
         end
       end
@@ -75,23 +83,28 @@ module GrapeSwagger
       # helper methods
       #
       # rubocop:disable Style/StringConcatenation
-      def make_request
-        get url_for
+      def make_request(url)
+        get url
 
         @oapi = JSON.pretty_generate(
-          JSON.parse(
-            last_response.body, symolize_names: true
-          )
+          JSON.parse(last_response.body, symolize_names: true)
         ) + "\n"
       end
       # rubocop:enable Style/StringConcatenation
 
-      def url_for
-        oapi_route = api_class.routes[-2]
-        path = oapi_route.path.sub(/\(\.\w+\)$/, '').sub(/\(\.:\w+\)$/, '')
-        path.sub!(':version', oapi_route.version.to_s)
+      def urls_for(api_class)
+        api_class.routes
+                 .map(&:path)
+                 .select { |e| e.include?('doc') }
+                 .reject { |e| e.include?(':name') }
+                 .map { |e| format_path(e) }
+                 .map { |e| [e, ENV.fetch('resource', nil)].join('/').chomp('/') }
+      end
 
-        [path, ENV['resource']].join('/').chomp('/')
+      def format_path(path)
+        oapi_route = api_class.routes.select { |e| e.path == path }.first
+        path = path.sub(/\(\.\w+\)$/, '').sub(/\(\.:\w+\)$/, '')
+        path.sub(':version', oapi_route.version.to_s)
       end
 
       def save_to_file?
@@ -102,8 +115,15 @@ module GrapeSwagger
         JSON.parse(@oapi).keys.first == 'error'
       end
 
-      def file
-        name = ENV['store'] == 'true' || ENV['store'].blank? ? 'swagger_doc.json' : ENV['store']
+      def file(url)
+        api_version = url.split('/').last
+
+        name = if ENV['store'] == 'true' || ENV['store'].blank?
+                 "swagger_doc_#{api_version}.json"
+               else
+                 ENV['store'].sub('.json', "_#{api_version}.json")
+               end
+
         File.join(Dir.getwd, name)
       end
 

data/lib/grape-swagger/version.rb

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

data/lib/grape-swagger.rb

@@ -31,8 +31,8 @@ module SwaggerRouting
 
       # want to match emojis … ;)
       # route_match = route_match
-      #   .match('\/([\p{Alnum}|\p{Emoji}|\-|\_]*?)[\.\/\(]') || route_match.match('\/([\p{Alpha}|\p{Emoji}|\-|\_]*)$')
-      route_match = route_match.match('\/([\p{Alnum}|\-|\_]*?)[\.\/\(]') || route_match.match('\/([\p{Alpha}|\-|\_]*)$')
+      #   .match('\/([\p{Alnum}p{Emoji}\-\_]*?)[\.\/\(]') || route_match.match('\/([\p{Alpha}\p{Emoji}\-\_]*)$')
+      route_match = route_match.match('\/([\p{Alnum}\-\_]*?)[\.\/\(]') || route_match.match('\/([\p{Alpha}\-\_]*)$')
       next unless route_match
 
       resource = route_match.captures.first

data/spec/issues/579_align_put_post_parameters_spec.rb

@@ -103,8 +103,8 @@ describe '#579 put / post parameters spec' do
         [
           { 'in' => 'path', 'name' => 'guid', 'type' => 'string', 'format' => 'guid', 'required' => true },
           {
-            'name' => 'Issue579ImplicitBodyParameter', 'in' => 'body', 'required' => true, 'schema' => {
-              '$ref' => '#/definitions/putIssue579ImplicitBodyParameter'
+            'name' => 'putIssue579ImplicitBodyParameterGuid', 'in' => 'body', 'required' => true, 'schema' => {
+              '$ref' => '#/definitions/putIssue579ImplicitBodyParameterGuid'
             }
           }
         ]
@@ -130,8 +130,8 @@ describe '#579 put / post parameters spec' do
         [
           { 'in' => 'path', 'name' => 'guid', 'type' => 'string', 'format' => 'guid', 'required' => true },
           {
-            'name' => 'Issue579ExplicitBodyParameter', 'in' => 'body', 'required' => true, 'schema' => {
-              '$ref' => '#/definitions/putIssue579ExplicitBodyParameter'
+            'name' => 'putIssue579ExplicitBodyParameterGuid', 'in' => 'body', 'required' => true, 'schema' => {
+              '$ref' => '#/definitions/putIssue579ExplicitBodyParameterGuid'
             }
           }
         ]
@@ -157,7 +157,7 @@ describe '#579 put / post parameters spec' do
         [
           { 'in' => 'path', 'name' => 'guid', 'type' => 'string', 'format' => 'guid', 'required' => true },
           {
-            'name' => 'Issue579NamespaceParamGuidBodyParameter', 'in' => 'body', 'required' => true, 'schema' => {
+            'name' => 'putIssue579NamespaceParamGuidBodyParameter', 'in' => 'body', 'required' => true, 'schema' => {
               '$ref' => '#/definitions/putIssue579NamespaceParamGuidBodyParameter'
             }
           }

data/spec/issues/677_consumes_produces_add_swagger_documentation_options_spec.rb

@@ -0,0 +1,100 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe '#677 consumes and produces options are included in add_swagger_documentation options' do
+  describe 'no override' do
+    let(:app) do
+      Class.new(Grape::API) do
+        resource :accounts do
+          route_param :account_number, type: String do
+            resource :records do
+              route_param :id do
+                post do
+                  { message: 'hello world' }
+                end
+              end
+            end
+          end
+        end
+
+        add_swagger_documentation \
+          format: :json
+      end
+    end
+
+    subject do
+      get '/swagger_doc'
+      JSON.parse(last_response.body)
+    end
+
+    specify do
+      expect(subject['paths']['/accounts/{account_number}/records/{id}']['post']['produces']).to eq ['application/json']
+      expect(subject['paths']['/accounts/{account_number}/records/{id}']['post']['consumes']).to eq ['application/json']
+    end
+  end
+
+  describe 'override produces' do
+    let(:app) do
+      Class.new(Grape::API) do
+        resource :accounts do
+          route_param :account_number, type: String do
+            resource :records do
+              route_param :id do
+                post do
+                  { message: 'hello world' }
+                end
+              end
+            end
+          end
+        end
+
+        add_swagger_documentation \
+          format: :json,
+          produces: ['text/plain']
+      end
+    end
+
+    subject do
+      get '/swagger_doc'
+      JSON.parse(last_response.body)
+    end
+
+    specify do
+      expect(subject['paths']['/accounts/{account_number}/records/{id}']['post']['produces']).to eq ['text/plain']
+      expect(subject['paths']['/accounts/{account_number}/records/{id}']['post']['consumes']).to eq ['application/json']
+    end
+  end
+
+  describe 'override consumes' do
+    let(:app) do
+      Class.new(Grape::API) do
+        resource :accounts do
+          route_param :account_number, type: String do
+            resource :records do
+              route_param :id do
+                post do
+                  { message: 'hello world' }
+                end
+              end
+            end
+          end
+        end
+
+        add_swagger_documentation \
+          format: :json, \
+          consumes: ['application/json', 'application/x-www-form-urlencoded']
+      end
+    end
+
+    subject do
+      get '/swagger_doc'
+      JSON.parse(last_response.body)
+    end
+
+    specify do
+      expect(subject['paths']['/accounts/{account_number}/records/{id}']['post']['produces']).to eq ['application/json']
+      expect(subject['paths']['/accounts/{account_number}/records/{id}']['post']['consumes']).to eq ['application/json', 'application/x-www-form-urlencoded']
+    end
+  end
+end

data/spec/issues/751_deeply_nested_objects_spec.rb

@@ -75,7 +75,7 @@ describe '751 deeply nested objects' do
   end
 
   describe 'Correctness of vrp Points' do
-    let(:get_points_response) { subject['definitions']['postVrpSubmit']['properties']['vrp']['properties']['points'] }
+    let(:get_points_response) { subject['definitions']['vrp']['properties']['vrp']['properties']['points'] }
     specify do
       expect(get_points_response).to eql(
         'type' => 'array',
@@ -111,7 +111,7 @@ describe '751 deeply nested objects' do
   end
 
   describe 'Correctness of vrp Services' do
-    let(:get_service_response) { subject['definitions']['postVrpSubmit']['properties']['vrp']['properties']['services'] }
+    let(:get_service_response) { subject['definitions']['vrp']['properties']['vrp']['properties']['services'] }
     specify do
       expect(get_service_response).to include(
         'type' => 'array',

data/spec/issues/847_route_param_options_spec.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe '#847 route_param type is included in documentation' do
+  let(:app) do
+    Class.new(Grape::API) do
+      resource :accounts do
+        route_param :account_number, type: String do
+          resource :records do
+            route_param :id do
+              get do
+                { message: 'hello world' }
+              end
+            end
+          end
+        end
+      end
+
+      add_swagger_documentation
+    end
+  end
+  let(:parameters) { subject['paths']['/accounts/{account_number}/records/{id}']['get']['parameters'] }
+
+  subject do
+    get '/swagger_doc'
+    JSON.parse(last_response.body)
+  end
+
+  specify do
+    account_number_param = parameters.find { |param| param['name'] == 'account_number' }
+    expect(account_number_param['type']).to eq 'string'
+    id_param = parameters.find { |param| param['name'] == 'id' }
+    # Default is still integer
+    expect(id_param['type']).to eq 'integer'
+  end
+end

data/spec/lib/move_params_spec.rb

@@ -103,15 +103,30 @@ describe GrapeSwagger::DocMethods::MoveParams do
         subject.to_definition(path, params, route, definitions)
         expect(params).to eql(
           [
-            { name: 'InBody', in: 'body', required: true, schema: { '$ref' => '#/definitions/postInBody' } }
+            { name: 'postInBody', in: 'body', required: true, schema: { '$ref' => '#/definitions/postInBody' } }
           ]
         )
         expect(subject.definitions['postInBody']).not_to include :description
         expect(subject.definitions['postInBody']).to eql expected_post_defs
       end
+
+      context 'with a nickname' do
+        let(:route_options) { { nickname: 'post-body' } }
+
+        specify do
+          subject.to_definition(path, params, route, definitions)
+          expect(params).to eql(
+            [
+              { name: 'post-body', in: 'body', required: true, schema: { '$ref' => '#/definitions/post-body' } }
+            ]
+          )
+          expect(subject.definitions['post-body']).not_to include :description
+          expect(subject.definitions['post-body']).to eql expected_post_defs
+        end
+      end
     end
 
-    describe 'POST' do
+    describe 'PUT' do
       let(:params) { paths['/in_body/{key}'][:put][:parameters] }
       let(:route) { Grape::Router::Route.new('PUT', path.dup, **route_options) }
 
@@ -120,12 +135,28 @@ describe GrapeSwagger::DocMethods::MoveParams do
         expect(params).to eql(
           [
             { in: 'path', name: 'key', description: nil, type: 'integer', format: 'int32', required: true },
-            { name: 'InBody', in: 'body', required: true, schema: { '$ref' => '#/definitions/putInBody' } }
+            { name: 'putInBody', in: 'body', required: true, schema: { '$ref' => '#/definitions/putInBody' } }
           ]
         )
         expect(subject.definitions['putInBody']).not_to include :description
         expect(subject.definitions['putInBody']).to eql expected_put_defs
       end
+
+      context 'with a nickname' do
+        let(:route_options) { { nickname: 'put-body' } }
+
+        specify do
+          subject.to_definition(path, params, route, definitions)
+          expect(params).to eql(
+            [
+              { in: 'path', name: 'key', description: nil, type: 'integer', format: 'int32', required: true },
+              { name: 'put-body', in: 'body', required: true, schema: { '$ref' => '#/definitions/put-body' } }
+            ]
+          )
+          expect(subject.definitions['put-body']).not_to include :description
+          expect(subject.definitions['put-body']).to eql expected_put_defs
+        end
+      end
     end
   end
 
@@ -167,56 +198,39 @@ describe GrapeSwagger::DocMethods::MoveParams do
       let(:params) { [{ in: 'body', name: 'address[street][name]', description: 'street', type: 'string', required: true }] }
       before do
         subject.instance_variable_set(:@definitions, definitions)
-        subject.send(:build_definition, name, params, verb)
+        subject.send(:build_definition, name, params)
       end
 
-      describe 'verb given' do
-        let(:verb) { 'post' }
-        let(:name) { 'Foo' }
-        let(:definitions) { {} }
+      let(:name) { 'FooBar' }
+      let(:definitions) { {} }
 
-        specify do
-          definition = definitions.to_a.first
-          expect(definition.first).to eql 'postFoo'
-          expect(definition.last).to eql(type: 'object', properties: {})
-        end
-      end
-
-      describe 'no verb given' do
-        let(:name) { 'FooBar' }
-        let(:definitions) { {} }
-        let(:verb) { nil }
-
-        specify do
-          definition = definitions.to_a.first
-          expect(definition.first).to eql 'FooBar'
-          expect(definition.last).to eql(type: 'object', properties: {})
-        end
+      specify do
+        definition = definitions.to_a.first
+        expect(definition.first).to eql 'FooBar'
+        expect(definition.last).to eql(type: 'object', properties: {})
       end
     end
 
     describe 'build_body_parameter' do
-      describe 'name given' do
-        let(:name) { 'Foo' }
-        let(:reference) { 'Bar' }
+      let(:name) { 'Foo' }
+      let(:reference) { 'Bar' }
+      let(:expected_param) do
+        { name: name, in: 'body', required: true, schema: { '$ref' => "#/definitions/#{name}" } }
+      end
+      specify do
+        parameter = subject.send(:build_body_parameter, name, {})
+        expect(parameter).to eql expected_param
+      end
+
+      describe 'body_name option specified' do
+        let(:route_options) { { body_name: 'body' } }
         let(:expected_param) do
-          { name: name, in: 'body', required: true, schema: { '$ref' => "#/definitions/#{reference}" } }
+          { name: route_options[:body_name], in: 'body', required: true, schema: { '$ref' => "#/definitions/#{name}" } }
         end
         specify do
-          parameter = subject.send(:build_body_parameter, reference, name, {})
+          parameter = subject.send(:build_body_parameter, name, route_options)
           expect(parameter).to eql expected_param
         end
-
-        describe 'body_name option specified' do
-          let(:route_options) { { body_name: 'body' } }
-          let(:expected_param) do
-            { name: route_options[:body_name], in: 'body', required: true, schema: { '$ref' => "#/definitions/#{reference}" } }
-          end
-          specify do
-            parameter = subject.send(:build_body_parameter, reference, name, route_options)
-            expect(parameter).to eql expected_param
-          end
-        end
       end
     end
 

data/spec/lib/oapi_tasks_spec.rb

@@ -25,9 +25,12 @@ RSpec.describe GrapeSwagger::Rake::OapiTasks do
 
   subject { described_class.new(Api::Base) }
 
+  let(:api_class) { subject.send(:api_class) }
+  let(:docs_url) { subject.send(:urls_for, api_class).first }
+
   describe '.new' do
     it 'accepts class name as a constant' do
-      expect(described_class.new(::Api::Base).send(:api_class)).to eq(Api::Base)
+      expect(described_class.new(Api::Base).send(:api_class)).to eq(Api::Base)
     end
 
     it 'accepts class name as a string' do
@@ -38,7 +41,7 @@ RSpec.describe GrapeSwagger::Rake::OapiTasks do
   describe '#make_request' do
     describe 'complete documentation' do
       before do
-        subject.send(:make_request)
+        subject.send(:make_request, docs_url)
       end
 
       describe 'not storing' do
@@ -51,7 +54,7 @@ RSpec.describe GrapeSwagger::Rake::OapiTasks do
         end
 
         it 'requests doc url' do
-          expect(subject.send(:url_for)).to eql '/api/swagger_doc'
+          expect(docs_url).to eql '/api/swagger_doc'
         end
       end
 
@@ -68,10 +71,14 @@ RSpec.describe GrapeSwagger::Rake::OapiTasks do
     describe 'documentation for resource' do
       before do
         ENV['resource'] = resource
-        subject.send(:make_request)
+        subject.send(:make_request, docs_url)
       end
 
-      let(:response) { JSON.parse(subject.send(:make_request)) }
+      let(:response) do
+        JSON.parse(
+          subject.send(:make_request, docs_url)
+        )
+      end
 
       after { ENV.delete('resource') }
 
@@ -83,7 +90,7 @@ RSpec.describe GrapeSwagger::Rake::OapiTasks do
         end
 
         it 'requests doc url' do
-          expect(subject.send(:url_for)).to eql "/api/swagger_doc/#{resource}"
+          expect(docs_url).to eql "/api/swagger_doc/#{resource}"
         end
 
         it 'has only one resource path' do
@@ -115,7 +122,7 @@ RSpec.describe GrapeSwagger::Rake::OapiTasks do
 
     describe 'call it' do
       before do
-        subject.send(:make_request)
+        subject.send(:make_request, docs_url)
       end
       specify do
         expect(subject).to respond_to :oapi
@@ -128,7 +135,7 @@ RSpec.describe GrapeSwagger::Rake::OapiTasks do
   describe '#file' do
     describe 'no store given' do
       it 'returns swagger_doc.json' do
-        expect(subject.send(:file)).to end_with 'swagger_doc.json'
+        expect(subject.send(:file, docs_url)).to end_with 'swagger_doc.json'
       end
     end
 
@@ -139,7 +146,7 @@ RSpec.describe GrapeSwagger::Rake::OapiTasks do
         before { ENV['store'] = 'true' }
 
         it 'returns swagger_doc.json' do
-          expect(subject.send(:file)).to end_with 'swagger_doc.json'
+          expect(subject.send(:file, docs_url)).to end_with 'swagger_doc.json'
         end
       end
 
@@ -148,7 +155,7 @@ RSpec.describe GrapeSwagger::Rake::OapiTasks do
         before { ENV['store'] = name }
 
         it 'returns swagger_doc.json' do
-          expect(subject.send(:file)).to end_with name
+          expect(subject.send(:file, docs_url)).to include(name.split('.')[0])
         end
       end
     end

data/spec/spec_helper.rb

@@ -5,10 +5,6 @@ if RUBY_ENGINE == 'ruby'
   require 'coveralls'
 
   SimpleCov.formatter = Coveralls::SimpleCov::Formatter
-  SimpleCov.start do
-    add_filter 'spec/'
-    add_filter 'example/'
-  end
   Coveralls.wear!
 end
 

data/spec/swagger_v2/api_documentation_spec.rb

@@ -21,21 +21,7 @@ describe 'API with additional options' do
     expect(subject).to eq(
       [
         { description: 'Swagger compatible API description' },
-        {
-          description: 'Swagger compatible API description for specific API',
-          params: {
-            'locale' => {
-              desc: 'Locale of API documentation',
-              required: false,
-              type: 'Symbol'
-            },
-            'name' => {
-              desc: 'Resource name of mounted API',
-              required: true,
-              type: 'String'
-            }
-          }
-        }
+        { description: 'Swagger compatible API description for specific API', params: {} }
       ]
     )
   end