grape-swagger 0.26.1 → 0.27.0

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

@@ -1,24 +1,22 @@
+# frozen_string_literal: true
+
 module GrapeSwagger
   module DocMethods
     class OperationId
       class << self
         def build(route, path = nil)
           if route.options[:nickname]
-            operation_id = route.options[:nickname]
+            route.options[:nickname]
           else
             verb = route.request_method.to_s.downcase
-
             operation = manipulate(path) unless path.nil?
-
-            operation_id = "#{verb}#{operation}"
+            "#{verb}#{operation}"
           end
-
-          operation_id
         end
 
         def manipulate(path)
           operation = path.split('/').map(&:capitalize).join
-          operation.gsub!(/\-(\w)/, &:upcase).delete!('-') if operation.include?('-')
+          operation.gsub!(/\-(\w)/, &:upcase).delete!('-') if operation[/\-(\w)/]
           operation.gsub!(/\_(\w)/, &:upcase).delete!('_') if operation.include?('_')
           operation.gsub!(/\.(\w)/, &:upcase).delete!('.') if operation.include?('.')
           if path.include?('{')

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module GrapeSwagger
   module DocMethods
     class OptionalObject

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

@@ -1,11 +1,11 @@
+# frozen_string_literal: true
+
 module GrapeSwagger
   module DocMethods
     class ParseParams
       class << self
-        def call(param, settings, route, definitions)
-          path = route.path
+        def call(param, settings, path, route, definitions)
           method = route.request_method
-
           additional_documentation = settings.fetch(:documentation, {})
           settings.merge!(additional_documentation)
           data_type = DataType.call(settings)

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

@@ -1,9 +1,11 @@
+# frozen_string_literal: true
+
 module GrapeSwagger
   module DocMethods
     class PathString
       class << self
         def build(route, options = {})
-          path = route.path
+          path = route.path.dup
           # always removing format
           path.sub!(/\(\.\w+?\)$/, '')
           path.sub!('(.:format)', '')

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module GrapeSwagger
   module DocMethods
     class ProducesConsumes

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module GrapeSwagger
   module DocMethods
     class StatusCodes
@@ -8,8 +10,6 @@ module GrapeSwagger
             post: { code: 201, message: 'created {item}' },
             put: { code: 200, message: 'updated {item}' },
             patch: { code: 200, message: 'patched {item}' },
-            # 200 for delete would only be used, if a success entity is given,
-            # else it would be set to 204
             delete: { code: 200, message: 'deleted {item}' },
             head: { code: 200, message: 'head {item}' },
             options: { code: 200, message: 'option {item}' }

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module GrapeSwagger
   module DocMethods
     class TagNameDescription

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

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module GrapeSwagger
   module DocMethods
     class Version

data/lib/grape-swagger/endpoint.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'active_support'
 require 'active_support/core_ext/string/inflections.rb'
 
@@ -35,14 +37,18 @@ 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]
-      }.delete_if { |_, value| value.blank? }
+      }
+
+      GrapeSwagger::DocMethods::Extensions.add_extensions_to_info(infos, result)
+
+      result.delete_if { |_, value| value.blank? }
     end
 
     # sub-objects of info object
@@ -108,10 +114,10 @@ module Grape
       method[:description] = description_object(route)
       method[:produces]    = produces_object(route, options[:produces] || options[:format])
       method[:consumes]    = consumes_object(route, options[:format])
-      method[:parameters]  = params_object(route)
+      method[:parameters]  = params_object(route, path)
       method[:security]    = security_object(route)
       method[:responses]   = response_object(route)
-      method[:tags]        = route.options.fetch(:tags, tag_object(route))
+      method[:tags]        = route.options.fetch(:tags, tag_object(route, path))
       method[:operationId] = GrapeSwagger::DocMethods::OperationId.build(route, path)
       method.delete_if { |_, value| value.blank? }
 
@@ -138,9 +144,12 @@ module Grape
     end
 
     def produces_object(route, format)
+      return ['application/octet-stream'] if file_response?(route.attributes.success) &&
+                                             !route.attributes.produces.present?
+
       mime_types = GrapeSwagger::DocMethods::ProducesConsumes.call(format)
 
-      route_mime_types = [:formats, :content_types, :produces].map do |producer|
+      route_mime_types = %i(formats content_types produces).map do |producer|
         possible = route.options[producer]
         GrapeSwagger::DocMethods::ProducesConsumes.call(possible) if possible.present?
       end.flatten.compact.uniq
@@ -153,12 +162,12 @@ module Grape
       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 = GrapeSwagger::DocMethods::ProducesConsumes.call(format) if %i(post put).include?(method)
 
       mime_types
     end
 
-    def params_object(route)
+    def params_object(route, path)
       parameters = partition_params(route).map do |param, value|
         value = { required: false }.merge(value) if value.is_a?(Hash)
         _, value = default_type([[param, value]]).first if value == ''
@@ -167,11 +176,11 @@ module Grape
         elsif value[:documentation]
           expose_params(value[:documentation][:type])
         end
-        GrapeSwagger::DocMethods::ParseParams.call(param, value, route, @definitions)
+        GrapeSwagger::DocMethods::ParseParams.call(param, value, path, route, @definitions)
       end
 
       if GrapeSwagger::DocMethods::MoveParams.can_be_moved?(parameters, route.request_method)
-        parameters = GrapeSwagger::DocMethods::MoveParams.to_definition(parameters, route, @definitions)
+        parameters = GrapeSwagger::DocMethods::MoveParams.to_definition(path, parameters, route, @definitions)
       end
 
       parameters
@@ -185,6 +194,7 @@ module Grape
 
       codes.each_with_object({}) do |value, memo|
         memo[value[:code]] = { description: value[:message] }
+        next build_file_response(memo[value[:code]]) if file_response?(value[:model])
 
         response_model = @item
         response_model = expose_params_from_model(value[:model]) if value[:model]
@@ -201,7 +211,7 @@ module Grape
         # 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] && value[:code] < 300
-                                        { 'type' => 'array', 'items' => reference }
+                                        { type: 'array', items: reference }
                                       else
                                         reference
                                       end
@@ -223,11 +233,11 @@ module Grape
       [default_code]
     end
 
-    def tag_object(route)
+    def tag_object(route, path)
       version = GrapeSwagger::DocMethods::Version.get(route)
       version = [version] unless version.is_a?(Array)
       Array(
-        route.path.split('{')[0].split('/').reject(&:empty?).delete_if do |i|
+        path.split('{')[0].split('/').reject(&:empty?).delete_if do |i|
           i == route.prefix.to_s || version.map(&:to_s).include?(i)
         end.first
       )
@@ -235,23 +245,31 @@ module Grape
 
     private
 
+    def file_response?(value)
+      value.to_s.casecmp('file').zero? ? true : false
+    end
+
+    def build_file_response(memo)
+      memo['schema'] = { type: 'file' }
+    end
+
     def partition_params(route)
       declared_params = route.settings[:declared_params] if route.settings[:declared_params].present?
-      required, exposed = route.params.partition { |x| x.first.is_a? String }
+      required = merge_params(route)
       required = GrapeSwagger::DocMethods::Headers.parse(route) + required unless route.headers.nil?
 
       default_type(required)
-      default_type(exposed)
 
       request_params = unless declared_params.nil? && route.headers.nil?
                          parse_request_params(required)
                        end || {}
 
-      if route.params.present? && !route.settings[:declared_params].present?
-        request_params = route.params.merge(request_params)
-      end
+      request_params.empty? ? required : request_params
+    end
 
-      request_params
+    def merge_params(route)
+      param_keys = route.params.keys
+      route.params.delete_if { |key| key.is_a?(String) && param_keys.include?(key.to_sym) }.to_a
     end
 
     def default_type(params)

data/lib/grape-swagger/errors.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module GrapeSwagger
   module Errors
     class UnregisteredParser < StandardError; end

data/lib/grape-swagger/model_parsers.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module GrapeSwagger
   class ModelParsers
     include Enumerable

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rake'
 require 'rake/tasklib'
 require 'rack/test'

data/lib/grape-swagger/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module GrapeSwagger
-  VERSION = '0.26.1'.freeze
+  VERSION = '0.27.0'
 end

data/spec/issues/403_versions_spec.rb

@@ -1,4 +1,6 @@
 # encoding: utf-8
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe 'describing versions' do

data/spec/issues/427_entity_as_string_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe '#427 nested entity given as string' do

data/spec/issues/430_entity_definitions_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe 'definition names' do

data/spec/issues/532_allow_custom_format_spec.rb

@@ -1,6 +1,8 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
-describe '#542 array of type in post params' do
+describe '#532 allow custom format' do
   let(:app) do
     Class.new(Grape::API) do
       namespace :issue_532 do

data/spec/issues/533_specify_status_code_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe '#533 specify status codes' do

data/spec/issues/537_enum_values_spec.rb

@@ -1,11 +1,13 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe '#537 enum values spec' do
   let(:app) do
     Class.new(Grape::API) do
-      namespace :issue_539 do
+      namespace :issue_537 do
         class Spec < Grape::Entity
-          expose :enum_property, documentation: { values: [:foo, :bar] }
+          expose :enum_property, documentation: { values: %i(foo bar) }
           expose :enum_property_default, documentation: { values: %w(a b c), default: 'c' }
           expose :own_format, documentation: { format: 'log' }
         end

data/spec/issues/539_array_post_body_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe '#539 post params given as array' do

data/spec/issues/542_array_of_type_in_post_body_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe '#542 array of type in post params' do

data/spec/issues/553_align_array_put_post_params_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe '#553 array of type in post/put params' do

data/spec/issues/572_array_post_body_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe '#572 is_array is applied to all possible responses' do

data/spec/issues/579_align_put_post_parameters_spec.rb

@@ -0,0 +1,179 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe '#579 put / post parameters spec' do
+  let(:app) do
+    Class.new(Grape::API) do
+      namespace :issue_579 do
+        class BodySpec < Grape::Entity
+          expose :guid, documentation: { type: String, format: 'guid', in: 'body' }
+          expose :name, documentation: { type: String, in: 'body' }
+          expose :content, documentation: { type: String, in: 'body' }
+        end
+
+        class Spec < Grape::Entity
+          expose :guid, documentation: { type: String, format: 'guid' }
+          expose :name, documentation: { type: String }
+          expose :content, documentation: { type: String }
+        end
+
+        namespace :implicit do
+          namespace :body_parameter do
+            desc 'update spec',
+                 success: BodySpec,
+                 params: BodySpec.documentation
+            put ':guid' do
+              # your code goes here
+            end
+          end
+
+          namespace :form_parameter do
+            desc 'update spec',
+                 success: Spec,
+                 params: Spec.documentation
+            put ':guid' do
+              # your code goes here
+            end
+          end
+        end
+
+        namespace :explicit do
+          namespace :body_parameter do
+            desc 'update spec',
+                 success: BodySpec,
+                 params: BodySpec.documentation
+            params do
+              requires :guid
+            end
+            put ':guid' do
+              # your code goes here
+            end
+          end
+
+          namespace :form_parameter do
+            desc 'update spec',
+                 success: Spec,
+                 params: Spec.documentation
+            params do
+              requires :guid
+            end
+            put ':guid' do
+              # your code goes here
+            end
+          end
+        end
+
+        namespace :namespace_param do
+          route_param :guid do
+            namespace :body_parameter do
+              desc 'update spec',
+                   success: BodySpec,
+                   params: BodySpec.documentation
+              put do
+                # your code goes here
+              end
+            end
+
+            namespace :form_parameter do
+              desc 'update spec',
+                   success: Spec,
+                   params: Spec.documentation
+              put do
+                # your code goes here
+              end
+            end
+          end
+        end
+      end
+
+      add_swagger_documentation format: :json
+    end
+  end
+
+  subject do
+    get '/swagger_doc'
+    JSON.parse(last_response.body)
+  end
+
+  describe 'implicit path param given' do
+    let(:body_parameters) { subject['paths']['/issue_579/implicit/body_parameter/{guid}']['put']['parameters'] }
+    specify do
+      expect(body_parameters).to eql(
+        [
+          { 'in' => 'path', 'name' => 'guid', 'type' => 'string', 'format' => 'guid', 'required' => true },
+          {
+            'name' => 'Issue579ImplicitBodyParameter', 'in' => 'body', 'required' => true, 'schema' => {
+              '$ref' => '#/definitions/putIssue579ImplicitBodyParameter'
+            }
+          }
+        ]
+      )
+    end
+
+    let(:form_parameters) { subject['paths']['/issue_579/implicit/form_parameter/{guid}']['put']['parameters'] }
+    specify do
+      expect(form_parameters).to eql(
+        [
+          { 'in' => 'path', 'name' => 'guid', 'type' => 'string', 'format' => 'guid', 'required' => true },
+          { 'in' => 'formData', 'name' => 'name', 'type' => 'string', 'required' => false },
+          { 'in' => 'formData', 'name' => 'content', 'type' => 'string', 'required' => false }
+        ]
+      )
+    end
+  end
+
+  describe 'explicit path param given' do
+    let(:body_parameters) { subject['paths']['/issue_579/explicit/body_parameter/{guid}']['put']['parameters'] }
+    specify do
+      expect(body_parameters).to eql(
+        [
+          { 'in' => 'path', 'name' => 'guid', 'type' => 'string', 'format' => 'guid', 'required' => true },
+          {
+            'name' => 'Issue579ExplicitBodyParameter', 'in' => 'body', 'required' => true, 'schema' => {
+              '$ref' => '#/definitions/putIssue579ExplicitBodyParameter'
+            }
+          }
+        ]
+      )
+    end
+
+    let(:form_parameters) { subject['paths']['/issue_579/explicit/form_parameter/{guid}']['put']['parameters'] }
+    specify do
+      expect(form_parameters).to eql(
+        [
+          { 'in' => 'path', 'name' => 'guid', 'type' => 'string', 'format' => 'guid', 'required' => true },
+          { 'in' => 'formData', 'name' => 'name', 'type' => 'string', 'required' => false },
+          { 'in' => 'formData', 'name' => 'content', 'type' => 'string', 'required' => false }
+        ]
+      )
+    end
+  end
+
+  describe 'explicit as route param given' do
+    let(:body_parameters) { subject['paths']['/issue_579/namespace_param/{guid}/body_parameter']['put']['parameters'] }
+    specify do
+      expect(body_parameters).to eql(
+        [
+          { 'in' => 'path', 'name' => 'guid', 'type' => 'string', 'format' => 'guid', 'required' => true },
+          {
+            'name' => 'Issue579NamespaceParamGuidBodyParameter', 'in' => 'body', 'required' => true, 'schema' => {
+              '$ref' => '#/definitions/putIssue579NamespaceParamGuidBodyParameter'
+            }
+          }
+        ]
+      )
+    end
+
+    let(:form_parameters) { subject['paths']['/issue_579/namespace_param/{guid}/form_parameter']['put']['parameters'] }
+    specify do
+      expect(form_parameters).to eql(
+        [
+          { 'in' => 'path', 'name' => 'guid', 'type' => 'string', 'format' => 'guid', 'required' => true },
+          { 'in' => 'formData', 'name' => 'name', 'type' => 'string', 'required' => false },
+          { 'in' => 'formData', 'name' => 'content', 'type' => 'string', 'required' => false }
+        ]
+      )
+    end
+  end
+end