grape-swagger 0.34.1 → 1.2.1

data/UPGRADING.md

@@ -1,5 +1,35 @@
 ## Upgrading Grape-swagger
 
+### Upgrading to >= 1.2.0
+
+- The entity_name class method is now called on parent classes for inherited entities. Now you can do this
+
+```ruby
+module Some::Long::Module
+  class Base < Grape::Entity
+    # ... other shared logic
+    def self.entity_name
+      "V2::#{self.to_s.demodulize}"
+    end
+  end
+
+  def MyEntity < Base
+    # ....
+  end
+
+  def OtherEntity < Base
+    # revert back to the default behavior by hiding the method
+    private_class_method :entity_name
+  end
+end
+```
+
+- Full class name is modified to use `_` separator (e.g. `A_B_C` instead of `A::B::C`).
+
+### Upgrading to >= 1.1.0
+
+Full class name is used for referencing entity by default (e.g. `A::B::C` instead of just `C`). `Entity` and `Entities` suffixes and prefixes are omitted (e.g. if entity name is `Entities::SomeScope::MyFavourite::Entity` only `SomeScope::MyFavourite` will be used).
+
 ### Upgrading to >= 0.26.1
 
 The format can now be specified,

data/grape-swagger.gemspec

@@ -14,7 +14,7 @@ Gem::Specification.new do |s|
   s.license     = 'MIT'
 
   s.required_ruby_version = '>= 2.4'
-  s.add_runtime_dependency 'grape', '>= 0.16.2', '< 1.3.0'
+  s.add_runtime_dependency 'grape', '~> 1.3'
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec}/*`.split("\n")

data/lib/grape-swagger.rb

@@ -107,8 +107,8 @@ module SwaggerRouting
 end
 
 module SwaggerDocumentationAdder
-  attr_accessor :combined_namespaces, :combined_namespace_identifiers
-  attr_accessor :combined_routes, :combined_namespace_routes
+  attr_accessor :combined_namespaces, :combined_namespace_identifiers, :combined_routes, :combined_namespace_routes
+
   include SwaggerRouting
 
   def add_swagger_documentation(options = {})

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

@@ -4,8 +4,8 @@ module GrapeSwagger
   module DocMethods
     class BuildModelDefinition
       class << self
-        def build(model, properties, required)
-          definition = { type: 'object', properties: properties }
+        def build(model, properties, required, other_def_properties = {})
+          definition = { type: 'object', properties: properties }.merge(other_def_properties)
 
           if required.nil?
             required_attrs = required_attributes(model)
@@ -17,6 +17,57 @@ module GrapeSwagger
           definition
         end
 
+        def parse_params_from_model(parsed_response, model, model_name)
+          if parsed_response.is_a?(Hash) && parsed_response.keys.first == :allOf
+            refs_or_models = parsed_response[:allOf]
+            parsed = parse_refs_and_models(refs_or_models, model)
+
+            {
+              allOf: parsed
+            }
+          else
+            properties, required = parsed_response
+            unless properties&.any?
+              raise GrapeSwagger::Errors::SwaggerSpec,
+                    "Empty model #{model_name}, swagger 2.0 doesn't support empty definitions."
+            end
+            properties, other_def_properties = parse_properties(properties)
+
+            build(
+              model, properties, required, other_def_properties
+            )
+          end
+        end
+
+        def parse_properties(properties)
+          other_properties = {}
+
+          discriminator_key, discriminator_value =
+            properties.find do |_key, value|
+              value[:documentation].try(:[], :is_discriminator)
+            end
+
+          if discriminator_key
+            discriminator_value.delete(:documentation)
+            properties[discriminator_key] = discriminator_value
+
+            other_properties[:discriminator] = discriminator_key
+          end
+
+          [properties, other_properties]
+        end
+
+        def parse_refs_and_models(refs_or_models, model)
+          refs_or_models.map do |ref_or_models|
+            if ref_or_models.is_a?(Hash) && ref_or_models.keys.first == '$ref'
+              ref_or_models
+            else
+              properties, required = ref_or_models
+              GrapeSwagger::DocMethods::BuildModelDefinition.build(model, properties, required)
+            end
+          end
+        end
+
         private
 
         def required_attributes(model)

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

@@ -16,7 +16,7 @@ module GrapeSwagger
             'object'
           when 'Rack::Multipart::UploadedFile', 'File'
             'file'
-          when 'Virtus::Attribute::Boolean'
+          when 'Grape::API::Boolean'
             'boolean'
           when 'BigDecimal'
             'double'
@@ -48,14 +48,14 @@ module GrapeSwagger
         end
 
         def parse_entity_name(model)
-          if model.methods(false).include?(:entity_name)
+          if model.respond_to?(:entity_name)
             model.entity_name
           elsif model.to_s.end_with?('::Entity', '::Entities')
-            model.to_s.split('::')[-2]
-          elsif model.respond_to?(:name)
-            model.name.demodulize.camelize
+            model.to_s.split('::')[0..-2].join('_')
+          elsif model.to_s.start_with?('Entity::', 'Entities::', 'Representable::')
+            model.to_s.split('::')[1..-1].join('_')
           else
-            model.to_s.split('::').last
+            model.to_s.split('::').join('_')
           end
         end
 

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

@@ -16,8 +16,8 @@ module GrapeSwagger
 
         def manipulate(path)
           operation = path.split('/').map(&:capitalize).join
-          operation.gsub!(/\-(\w)/, &:upcase).delete!('-') if operation[/\-(\w)/]
-          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[/\.(\w)/]
           if path.include?('{')
             operation.gsub!(/\{(\w)/, &:upcase)

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

@@ -26,6 +26,7 @@ module GrapeSwagger
           document_range_values(settings) unless value_type[:is_array]
           document_required(settings)
           document_additional_properties(settings)
+          document_add_extensions(settings)
 
           @parsed_param
         end
@@ -62,6 +63,10 @@ module GrapeSwagger
           @parsed_param[:format] = settings[:format] if settings[:format].present?
         end
 
+        def document_add_extensions(settings)
+          GrapeSwagger::DocMethods::Extensions.add_extensions_to_root(settings, @parsed_param)
+        end
+
         def document_array_param(value_type, definitions)
           if value_type[:documentation].present?
             param_type = value_type[:documentation][:param_type]
@@ -72,6 +77,19 @@ module GrapeSwagger
 
           param_type ||= value_type[:param_type]
 
+          array_items = parse_array_item(
+            definitions,
+            type,
+            value_type
+          )
+
+          @parsed_param[:in] = param_type || 'formData'
+          @parsed_param[:items] = array_items
+          @parsed_param[:type] = 'array'
+          @parsed_param[:collectionFormat] = collection_format if DataType.collections.include?(collection_format)
+        end
+
+        def parse_array_item(definitions, type, value_type)
           array_items = {}
           if definitions[value_type[:data_type]]
             array_items['$ref'] = "#/definitions/#{@parsed_param[:type]}"
@@ -86,10 +104,7 @@ module GrapeSwagger
 
           array_items[:default] = value_type[:default] if value_type[:default].present?
 
-          @parsed_param[:in] = param_type || 'formData'
-          @parsed_param[:items] = array_items
-          @parsed_param[:type] = 'array'
-          @parsed_param[:collectionFormat] = collection_format if DataType.collections.include?(collection_format)
+          array_items
         end
 
         def document_additional_properties(settings)

data/lib/grape-swagger/endpoint.rb

@@ -175,15 +175,18 @@ module Grape
     end
 
     def params_object(route, options, path)
-      parameters = partition_params(route, options).map do |param, value|
+      parameters = build_request_params(route, options).each_with_object([]) do |(param, value), memo|
+        next if hidden_parameter?(value)
+
         value = { required: false }.merge(value) if value.is_a?(Hash)
         _, value = default_type([[param, value]]).first if value == ''
+
         if value.dig(:documentation, :type)
           expose_params(value[:documentation][:type])
         elsif value[:type]
           expose_params(value[:type])
         end
-        GrapeSwagger::DocMethods::ParseParams.call(param, value, path, route, @definitions)
+        memo << GrapeSwagger::DocMethods::ParseParams.call(param, value, path, route, @definitions)
       end
 
       if GrapeSwagger::DocMethods::MoveParams.can_be_moved?(route.request_method, parameters)
@@ -196,10 +199,7 @@ module Grape
     end
 
     def response_object(route, options)
-      codes = http_codes_from_route(route)
-      codes.map! { |x| x.is_a?(Array) ? { code: x[0], message: x[1], model: x[2], examples: x[3], headers: x[4] } : x }
-
-      codes.each_with_object({}) do |value, memo|
+      codes(route).each_with_object({}) do |value, memo|
         value[:message] ||= ''
         memo[value[:code]] = { description: value[:message] }
 
@@ -225,6 +225,12 @@ module Grape
       end
     end
 
+    def codes(route)
+      http_codes_from_route(route).map do |x|
+        x.is_a?(Array) ? { code: x[0], message: x[1], model: x[2], examples: x[3], headers: x[4] } : x
+      end
+    end
+
     def success_code?(code)
       status = code.is_a?(Array) ? code.first : code[:code]
       status.between?(200, 299)
@@ -250,7 +256,7 @@ module Grape
 
     def tag_object(route, path)
       version = GrapeSwagger::DocMethods::Version.get(route)
-      version = [version] unless version.is_a?(Array)
+      version = Array(version)
       prefix = route.prefix.to_s.split('/').reject(&:empty?)
       Array(
         path.split('{')[0].split('/').reject(&:empty?).delete_if do |i|
@@ -293,16 +299,13 @@ module Grape
       memo['schema'] = { type: 'file' }
     end
 
-    def partition_params(route, settings)
-      declared_params = route.settings[:declared_params] if route.settings[:declared_params].present?
+    def build_request_params(route, settings)
       required = merge_params(route)
       required = GrapeSwagger::DocMethods::Headers.parse(route) + required unless route.headers.nil?
 
       default_type(required)
 
-      request_params = unless declared_params.nil? && route.headers.nil?
-                         GrapeSwagger::Endpoint::ParamsParser.parse_request_params(required, settings)
-                       end || {}
+      request_params = GrapeSwagger::Endpoint::ParamsParser.parse_request_params(required, settings, self)
 
       request_params.empty? ? required : request_params
     end
@@ -340,13 +343,10 @@ module Grape
       parser = GrapeSwagger.model_parsers.find(model)
       raise GrapeSwagger::Errors::UnregisteredParser, "No parser registered for #{model_name}." unless parser
 
-      properties, required = parser.new(model, self).call
-      unless properties&.any?
-        raise GrapeSwagger::Errors::SwaggerSpec,
-              "Empty model #{model_name}, swagger 2.0 doesn't support empty definitions."
-      end
+      parsed_response = parser.new(model, self).call
 
-      @definitions[model_name] = GrapeSwagger::DocMethods::BuildModelDefinition.build(model, properties, required)
+      @definitions[model_name] =
+        GrapeSwagger::DocMethods::BuildModelDefinition.parse_params_from_model(parsed_response, model, model_name)
 
       model_name
     end
@@ -363,6 +363,16 @@ module Grape
       options[:token_owner] ? route_hidden.call(send(options[:token_owner].to_sym)) : route_hidden.call
     end
 
+    def hidden_parameter?(value)
+      return false if value.dig(:required)
+
+      if value.dig(:documentation, :hidden).is_a?(Proc)
+        value.dig(:documentation, :hidden).call
+      else
+        value.dig(:documentation, :hidden)
+      end
+    end
+
     def success_code_from_entity(route, entity)
       default_code = GrapeSwagger::DocMethods::StatusCodes.get[route.request_method.downcase.to_sym]
       if entity.is_a?(Hash)

data/lib/grape-swagger/endpoint/params_parser.rb

@@ -3,15 +3,16 @@
 module GrapeSwagger
   module Endpoint
     class ParamsParser
-      attr_reader :params, :settings
+      attr_reader :params, :settings, :endpoint
 
-      def self.parse_request_params(params, settings)
-        new(params, settings).parse_request_params
+      def self.parse_request_params(params, settings, endpoint)
+        new(params, settings, endpoint).parse_request_params
       end
 
-      def initialize(params, settings)
+      def initialize(params, settings, endpoint)
         @params = params
         @settings = settings
+        @endpoint = endpoint
       end
 
       def parse_request_params
@@ -55,7 +56,13 @@ module GrapeSwagger
         return true unless param_options.key?(:documentation) && !param_options[:required]
 
         param_hidden = param_options[:documentation].fetch(:hidden, false)
-        param_hidden = param_hidden.call if param_hidden.is_a?(Proc)
+        if param_hidden.is_a?(Proc)
+          param_hidden = if settings[:token_owner]
+                           param_hidden.call(endpoint.send(settings[:token_owner].to_sym))
+                         else
+                           param_hidden.call
+                         end
+        end
         !param_hidden
       end
 

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

@@ -10,17 +10,25 @@ module GrapeSwagger
       include Rack::Test::Methods
 
       attr_reader :oapi
-      attr_reader :api_class
 
       def initialize(api_class)
         super()
 
-        @api_class = api_class
+        if api_class.is_a? String
+          @api_class_name = api_class
+        else
+          @api_class = api_class
+        end
+
         define_tasks
       end
 
       private
 
+      def api_class
+        @api_class ||= @api_class_name.constantize
+      end
+
       def define_tasks
         namespace :oapi do
           fetch

data/lib/grape-swagger/version.rb

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

data/spec/issues/427_entity_as_string_spec.rb

@@ -35,5 +35,5 @@ describe '#427 nested entity given as string' do
     JSON.parse(last_response.body)['definitions']
   end
 
-  specify { expect(subject.keys).to include 'RoleEntity', 'WithoutRole' }
+  specify { expect(subject.keys).to include 'RoleEntity', 'Permission_WithoutRole' }
 end

data/spec/issues/430_entity_definitions_spec.rb

@@ -55,6 +55,8 @@ describe 'definition names' do
             class Class7
               class SeventhEntity < Class6::SixthEntity
                 expose :seventh_thing
+
+                private_class_method :entity_name
               end
             end
           end
@@ -82,11 +84,11 @@ describe 'definition names' do
     JSON.parse(last_response.body)['definitions']
   end
 
-  specify { expect(subject).to include 'Class1' }
-  specify { expect(subject).to include 'Class2' }
+  specify { expect(subject).to include 'TestDefinition_DummyEntities_WithVeryLongName_AnotherGroupingModule_Class1' }
+  specify { expect(subject).to include 'TestDefinition_DummyEntities_WithVeryLongName_AnotherGroupingModule_Class2' }
   specify { expect(subject).to include 'FooKlass' }
-  specify { expect(subject).to include 'FourthEntity' }
-  specify { expect(subject).to include 'FithEntity' }
+  specify { expect(subject).to include 'TestDefinition_DummyEntities_WithVeryLongName_AnotherGroupingModule_Class4_FourthEntity' }
+  specify { expect(subject).to include 'TestDefinition_DummyEntities_WithVeryLongName_AnotherGroupingModule_Class5_FithEntity' }
   specify { expect(subject).to include 'BarKlass' }
-  specify { expect(subject).to include 'SeventhEntity' }
+  specify { expect(subject).to include 'TestDefinition_DummyEntities_WithVeryLongName_AnotherGroupingModule_Class7_SeventhEntity' }
 end

data/spec/issues/784_extensions_on_params_spec.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe '#532 allow custom format' do
+  let(:app) do
+    Class.new(Grape::API) do
+      namespace :issue_784 do
+        params do
+          requires :logs, type: String, documentation: { format: 'log', x: { name: 'Log' } }
+          optional :phone_number, type: Integer, documentation: { format: 'phone_number', x: { name: 'PhoneNumber' } }
+        end
+
+        post do
+          present params
+        end
+      end
+
+      add_swagger_documentation format: :json
+    end
+  end
+
+  subject do
+    get '/swagger_doc'
+    JSON.parse(last_response.body)
+  end
+
+  let(:parameters) { subject['paths']['/issue_784']['post']['parameters'] }
+
+  specify do
+    expect(parameters).to eql(
+      [
+        { 'in' => 'formData', 'name' => 'logs', 'type' => 'string', 'format' => 'log', 'required' => true, 'x-name' => 'Log' },
+        { 'in' => 'formData', 'name' => 'phone_number', 'type' => 'integer', 'format' => 'phone_number', 'required' => false, 'x-name' => 'PhoneNumber' }
+      ]
+    )
+  end
+end