apipie-rails 0.9.1 → 0.9.2

data/CHANGELOG.md

@@ -4,6 +4,14 @@
 Also deleted the `Gemfile` that was now a broken symlink.
 please use `export BUNDLE_GEMFILE='gemfiles/Gemfile.rails61'; bundle exec rspec` to run the test suite
 
+## [v0.9.2](https://github.com/Apipie/apipie-rails/tree/v0.9.2) (2023-02-07)
+[Full Changelog](https://github.com/Apipie/apipie-rails/compare/v0.9.1...v0.9.2)
+* [Rubocop] More Rubocop Auto corrections [#795](https://github.com/Apipie/apipie-rails/pull/795)[#781](https://github.com/Apipie/apipie-rails/pull/781)[#791](https://github.com/Apipie/apipie-rails/pull/791)[#788](https://github.com/Apipie/apipie-rails/pull/788) (Rubocop Challenger)
+* [Fix] Can't include translation in full description ([#446](https://github.com/Apipie/apipie-rails/issues/446)) [#808](https://github.com/Apipie/apipie-rails/pull/808)( Peter Nagy)
+* [Refactor] Move swagger param description creation [#810](https://github.com/Apipie/apipie-rails/pull/810) (Panos Dalitsouris)
+* [Rubocop] Redo rubocop TODOs, set HashSyntax config to most used style [#814](https://github.com/Apipie/apipie-rails/pull/814) (Mathieu Jobin)
+* [Fix] Swagger missing i18n [#815](https://github.com/Apipie/apipie-rails/pull/815) (@jirubio)
+
 ## [v0.9.1](https://github.com/Apipie/apipie-rails/tree/v0.9.1) (2023-01-16)
 [Full Changelog](https://github.com/Apipie/apipie-rails/compare/v0.9.0...v0.9.1)
 * [Refactor] Create test cache files under a not version controlled directory [#809](https://github.com/Apipie/apipie-rails/pull/809) (Panos Dalitsouris)

data/app/controllers/apipie/apipies_controller.rb

@@ -98,12 +98,11 @@ module Apipie
       return nil unless Apipie.configuration.translate
       lang = Apipie.configuration.default_locale
       [:resource, :method, :version].each do |par|
-        if params[par]
-          splitted = params[par].split('.')
-          if splitted.length > 1 && (Apipie.configuration.languages.include?(splitted.last) || Apipie.configuration.default_locale == splitted.last)
-            lang = splitted.last
-            params[par].sub!(".#{lang}", '')
-          end
+        next unless params[par]
+        splitted = params[par].split('.')
+        if splitted.length > 1 && (Apipie.configuration.languages.include?(splitted.last) || Apipie.configuration.default_locale == splitted.last)
+          lang = splitted.last
+          params[par].sub!(".#{lang}", '')
         end
       end
       lang

data/lib/apipie/apipie_module.rb

@@ -70,11 +70,11 @@ module Apipie
   end
 
   def self.app_info_version_valid?(version)
-    version && self.configuration.app_info.has_key?(version)
+    version && self.configuration.app_info.key?(version)
   end
 
   def self.api_base_url_version_valid?(version)
-    version && self.configuration.api_base_url.has_key?(version)
+    version && self.configuration.api_base_url.key?(version)
   end
 
   def self.record(record)

data/lib/apipie/application.rb

@@ -147,7 +147,7 @@ module Apipie
 
     def get_param_group(controller, name)
       key = "#{controller.name}##{name}"
-      if @param_groups.has_key?(key)
+      if @param_groups.key?(key)
         return @param_groups[key]
       else
         raise "param group #{key} not defined"
@@ -185,7 +185,7 @@ module Apipie
         resource_description.method_description(method_name.to_sym)
       end
     end
-    alias :[] :get_method_description
+    alias [] get_method_description
 
     # options:
     # => "users"
@@ -198,7 +198,7 @@ module Apipie
           version = crumbs.first
         end
         version ||= Apipie.configuration.default_version
-        if @resource_descriptions.has_key?(version)
+        if @resource_descriptions.key?(version)
           return @resource_descriptions[version][crumbs.last]
         end
       else
@@ -373,7 +373,7 @@ module Apipie
     def get_resource_name(klass)
       if klass.class == String
         klass
-      elsif @controller_to_resource_id.has_key?(klass)
+      elsif @controller_to_resource_id.key?(klass)
         @controller_to_resource_id[klass]
       elsif Apipie.configuration.namespaced_resources? && klass.respond_to?(:controller_path)
         return nil if klass == ActionController::Base
@@ -408,9 +408,9 @@ module Apipie
     # Make sure that the version/resource_name/method_name are valid combination
     # resource_name and method_name can be nil
     def valid_search_args?(version, resource_name, method_name)
-      return false unless self.resource_descriptions.has_key?(version)
+      return false unless self.resource_descriptions.key?(version)
       if resource_name
-        return false unless self.resource_descriptions[version].has_key?(resource_name)
+        return false unless self.resource_descriptions[version].key?(resource_name)
         if method_name
           resource_description = self.resource_descriptions[version][resource_name]
           return false unless resource_description.valid_method_name?(method_name)

data/lib/apipie/configuration.rb

@@ -14,13 +14,13 @@ module Apipie
       :swagger_allow_additional_properties_in_response, :swagger_responses_use_refs,
       :swagger_schemes, :swagger_security_definitions, :swagger_global_security
 
-    alias_method :validate?, :validate
-    alias_method :required_by_default?, :required_by_default
-    alias_method :namespaced_resources?, :namespaced_resources
-    alias_method :swagger_include_warning_tags?, :swagger_include_warning_tags
-    alias_method :swagger_json_input_uses_refs?, :swagger_json_input_uses_refs
-    alias_method :swagger_responses_use_refs?, :swagger_responses_use_refs
-    alias_method :swagger_generate_x_computed_id_field?, :swagger_generate_x_computed_id_field
+    alias validate? validate
+    alias required_by_default? required_by_default
+    alias namespaced_resources? namespaced_resources
+    alias swagger_include_warning_tags? swagger_include_warning_tags
+    alias swagger_json_input_uses_refs? swagger_json_input_uses_refs
+    alias swagger_responses_use_refs? swagger_responses_use_refs
+    alias swagger_generate_x_computed_id_field? swagger_generate_x_computed_id_field
 
     # matcher to be used in Dir.glob to find controllers to be reloaded e.g.
     #
@@ -51,17 +51,17 @@ module Apipie
     def validate_value
       return (validate? && @validate_value)
     end
-    alias_method :validate_value?, :validate_value
+    alias validate_value? validate_value
 
     def validate_presence
       return (validate? && @validate_presence)
     end
-    alias_method :validate_presence?, :validate_presence
+    alias validate_presence? validate_presence
 
     def validate_key
       return (validate? && @validate_key)
     end
-    alias_method :validate_key?, :validate_key
+    alias validate_key? validate_key
 
     def process_value?
       @process_params
@@ -73,7 +73,7 @@ module Apipie
     #
     #     rake apipie:cache
     attr_accessor :use_cache
-    alias_method :use_cache?, :use_cache
+    alias use_cache? use_cache
 
     attr_writer :cache_dir
     def cache_dir

data/lib/apipie/dsl_definition.rb

@@ -70,7 +70,7 @@ module Apipie
       def short(short)
         _apipie_dsl_data[:short_description] = short
       end
-      alias :short_description :short
+      alias short_description short
 
       def path(path)
         _apipie_dsl_data[:path] = path
@@ -160,7 +160,7 @@ module Apipie
       def api_versions(*versions)
         _apipie_dsl_data[:api_versions].concat(versions)
       end
-      alias :api_version :api_versions
+      alias api_version api_versions
 
       # Describe the next method.
       #
@@ -177,8 +177,8 @@ module Apipie
         end
         _apipie_dsl_data[:description] = description
       end
-      alias :description :desc
-      alias :full_description :desc
+      alias description desc
+      alias full_description desc
 
       # describe next method with document in given path
       # in convension, these doc located under "#{Rails.root}/doc"
@@ -246,14 +246,14 @@ module Apipie
               if Apipie.configuration.validate_presence?
                 method_params.each do |_, param|
                   # check if required parameters are present
-                  raise ParamMissing.new(param) if param.required && !params.has_key?(param.name)
+                  raise ParamMissing.new(param) if param.required && !params.key?(param.name)
                 end
               end
 
               if Apipie.configuration.validate_value?
                 method_params.each do |_, param|
                   # params validations
-                  param.validate(params[:"#{param.name}"]) if params.has_key?(param.name)
+                  param.validate(params[:"#{param.name}"]) if params.key?(param.name)
                 end
               end
 
@@ -272,7 +272,7 @@ module Apipie
                 @api_params ||= {}
                 method_params.each do |_, param|
                   # params processing
-                  @api_params[param.as] = param.process_value(params[:"#{param.name}"]) if params.has_key?(param.name)
+                  @api_params[param.as] = param.process_value(params[:"#{param.name}"]) if params.key?(param.name)
                 end
               end
             end
@@ -293,9 +293,10 @@ module Apipie
       end
 
       def _apipie_handle_validate_key_error params, param
-        if Apipie.configuration.action_on_non_validated_keys == :raise
+        case Apipie.configuration.action_on_non_validated_keys
+        when :raise
           raise UnknownParam, param
-        elsif Apipie.configuration.action_on_non_validated_keys == :skip
+        when :skip
           params.delete(param)
           Rails.logger.warn(UnknownParam.new(param).to_s)
         end
@@ -525,7 +526,7 @@ module Apipie
         end
       end
       # backwards compatibility
-      alias_method :apipie_update_params, :apipie_update_methods
+      alias apipie_update_params apipie_update_methods
 
       def _apipie_concern_subst
         @_apipie_concern_subst ||= {:controller_path => self.controller_path,

data/lib/apipie/error_description.rb

@@ -31,10 +31,10 @@ module Apipie
       end
     end
 
-    def to_json
+    def to_json(lang)
       {
         :code => code,
-        :description => description,
+        :description => Apipie.app.translate(description, lang),
         :metadata => metadata
       }
     end

data/lib/apipie/extractor/writer.rb

@@ -103,7 +103,7 @@ module Apipie
         call = call.stringify_keys
         ordered_call = OrderedHash.new
         %w[title verb path versions query request_data response_data code show_in_doc recorded].each do |k|
-          next unless call.has_key?(k)
+          next unless call.key?(k)
           ordered_call[k] = case call[k]
                      when ActiveSupport::HashWithIndifferentAccess
                        convert_file_value(call[k]).to_hash
@@ -116,9 +116,10 @@ module Apipie
 
       def convert_file_value hash
         hash.each do |k, v|
-          if v.is_a?(Rack::Test::UploadedFile) || v.is_a?(ActionDispatch::Http::UploadedFile)
+          case v
+          when Rack::Test::UploadedFile, ActionDispatch::Http::UploadedFile
             hash[k] = "<FILE CONTENT '#{v.original_filename}'>"
-          elsif v.is_a?(Hash)
+          when Hash
             hash[k] = convert_file_value(v)
           end
         end
@@ -134,8 +135,8 @@ module Apipie
         old_examples = self.load_recorded_examples
         merged_examples = []
         (new_examples.keys + old_examples.keys).uniq.each do |key|
-          if new_examples.has_key?(key)
-            if old_examples.has_key?(key)
+          if new_examples.key?(key)
+            if old_examples.key?(key)
               records = deep_merge_examples(new_examples[key], old_examples[key])
             else
               records = new_examples[key]
@@ -407,12 +408,11 @@ module Apipie
           if line =~ /\s*\b(module|class|def)\b /
             break
           end
-          if line =~ /do\s*(\|.*?\|)?\s*$/
-            block_level -= 1
-            if block_level == 0
-              added_lines.concat(lines_to_add)
-              lines_to_add = []
-            end
+          next unless line =~ /do\s*(\|.*?\|)?\s*$/
+          block_level -= 1
+          if block_level == 0
+            added_lines.concat(lines_to_add)
+            lines_to_add = []
           end
         end
         return added_lines.reverse.join

data/lib/apipie/generator/swagger/context.rb

@@ -0,0 +1,27 @@
+class Apipie::Generator::Swagger::Context
+  attr_reader :default_in_value, :language, :http_method, :controller_method
+
+  def initialize(
+    allow_null:,
+    http_method:,
+    controller_method:,
+    default_in_value: nil,
+    language: nil,
+    in_schema: true
+  )
+    @default_in_value = default_in_value
+    @allow_null = allow_null
+    @language = language
+    @in_schema = in_schema
+    @http_method = http_method
+    @controller_method = controller_method
+  end
+
+  def allow_null?
+    @allow_null == true
+  end
+
+  def in_schema?
+    @in_schema == true
+  end
+end

data/lib/apipie/generator/swagger/operation_id.rb

@@ -0,0 +1,51 @@
+class Apipie::Generator::Swagger::OperationId
+  def initialize(path:, http_method:, param: nil)
+    @path = path
+    @http_method = http_method
+    @param = param
+  end
+
+  # @return [String]
+  def to_s
+    base = normalized_http_method + path
+
+    if @param.present?
+      "#{base}_param_#{@param}"
+    else
+      base
+    end
+  end
+
+  # @param [Apipie::MethodDescription::Api, Apipie::MethodDescription] describable
+  # @param [String, Symbol, nil] param
+  #
+  # @return [Apipie::Generator::Swagger::OperationId]
+  def self.from(describable, param: nil)
+    path, http_method =
+      if describable.is_a?(Apipie::MethodDescription::Api)
+        [describable.path, describable.http_method]
+      elsif describable.is_a?(Apipie::MethodDescription)
+        [describable.apis.first.path, describable.apis.first.http_method]
+      end
+
+    new(path: path, http_method: http_method, param: param)
+  end
+
+  private
+
+  # Converts an http path for example `/api/concerns/:id` to `_api_concerns_id`
+  #
+  # @return [String]
+  def path
+    @path.gsub(/\//, '_').gsub(/:(\w+)/, '\1').gsub(/_$/, '')
+  end
+
+  # Converts an http method like `GET` to `get` Using lowercase http method,
+  #   because the 'swagger-codegen' tool outputs strange method names if the
+  #   http method is in uppercase
+  #
+  # @return [String]
+  def normalized_http_method
+    @http_method.to_s.downcase
+  end
+end

data/lib/apipie/generator/swagger/param_description/builder.rb

@@ -0,0 +1,105 @@
+class Apipie::Generator::Swagger::ParamDescription::Builder
+  # @param [Apipie::ParamDescription] param_description
+  # @param [TrueClass, FalseClass] in_schema
+  # @param [String] controller_method
+  def initialize(param_description, in_schema:, controller_method:)
+    @param_description = param_description
+    @in_schema = in_schema
+    @controller_method = controller_method
+  end
+
+  # @param [String, nil] prefix
+  def with_name(prefix: nil)
+    @name = Apipie::Generator::Swagger::ParamDescription::Name.
+      new(@param_description, prefixed_by: prefix)
+
+    self
+  end
+
+  # @param [String] language
+  def with_description(language:)
+    @description = Apipie::Generator::Swagger::ParamDescription::Description.
+      new(@param_description, language: language)
+
+    self
+  end
+
+  # @param [TrueClass, FalseClass] with_null
+  def with_type(with_null:)
+    @type = Apipie::Generator::Swagger::ParamDescription::Type.
+      new(@param_description, with_null: with_null, controller_method: @controller_method)
+
+    self
+  end
+
+  def with_in(http_method:, default_in_value: nil)
+    @in = Apipie::Generator::Swagger::ParamDescription::In.new(
+      @param_description,
+      in_schema: @in_schema,
+      default_in_value: default_in_value,
+      http_method: http_method
+    )
+
+    self
+  end
+
+  # @return [Hash]
+  def to_swagger
+    definition = {}
+
+    definition.merge!(@name.to_hash) if @name.present?
+    definition.merge!(@type.to_hash) if @type.present?
+    definition.merge!(@in.to_hash) if @in.present?
+
+    definition.merge!(for_default)
+    definition.merge!(for_required)
+    definition.merge!(@description.to_hash) if @description.present?
+
+    warn_optional_without_default_value(definition)
+
+    definition
+  end
+
+  private
+
+  def for_required
+    return {} if !required?
+
+    {
+      required: true
+    }
+  end
+
+  def for_default
+    return {} if @param_description.options[:default_value].blank?
+
+    {
+      default: @param_description.options[:default_value],
+    }
+  end
+
+  def required?
+    required_from_path? || (!@in_schema && @param_description.required)
+  end
+
+  def required_from_path?
+    @param_description.options[:added_from_path] == true
+  end
+
+  def warn_optional_without_default_value(definition)
+    if !required? && !definition.key?(:default)
+      method =
+        if @param_description.is_a?(Apipie::ResponseDescriptionAdapter::PropDesc)
+          @controller_method
+        else
+          @param_description.method_description.method
+        end
+
+      Apipie::Generator::Swagger::Warning.for_code(
+        Apipie::Generator::Swagger::Warning::OPTIONAL_WITHOUT_DEFAULT_VALUE_CODE,
+        method,
+        { parameter: @param_description.name }
+      ).warn_through_writer
+    end
+  end
+end

data/lib/apipie/generator/swagger/param_description/composite.rb

@@ -0,0 +1,111 @@
+class Apipie::Generator::Swagger::ParamDescription::Composite
+  # @param [Array<Apipie::ParamDescription>] param_descriptions
+  # @param [Apipie::Generator::Swagger::Context] context
+  def initialize(param_descriptions, context)
+    @param_descriptions = param_descriptions
+    @context = context
+    @schema = {
+      type: 'object',
+      properties: {}
+    }
+    @required_params = []
+  end
+
+  def to_swagger
+    return if @param_descriptions.blank?
+
+    @param_descriptions.each do |param_description|
+      validate(param_description)
+
+      if param_description.required
+        @required_params.push(param_description.name.to_sym)
+      end
+
+      param_type = Apipie::Generator::Swagger::TypeExtractor.
+        new(param_description.validator).
+        extract
+
+      has_nested_params = param_type == 'object' &&
+        param_description.validator.params_ordered.present?
+
+      if has_nested_params
+        schema = Apipie::Generator::Swagger::ParamDescription::Composite.new(
+          param_description.validator.params_ordered,
+          Apipie::Generator::Swagger::Context.new(
+            allow_null: @context.allow_null?,
+            http_method: @context.http_method,
+            controller_method: @context.controller_method
+          )
+        ).to_swagger
+
+        return if schema.blank?
+
+        if param_description.additional_properties
+          schema[:additionalProperties] = true
+        end
+
+        if param_description.is_array?
+          schema = for_array(schema)
+        end
+
+        if @context.allow_null?
+          schema = with_null(schema)
+        end
+
+        if schema.present?
+          @schema[:properties][param_description.name.to_sym] = schema
+        end
+      else
+        param_entry = Apipie::Generator::Swagger::ParamDescription::Builder.
+          new(
+            param_description,
+            in_schema: @context.in_schema?,
+            controller_method: @context.controller_method
+          ).
+          with_description(language: @context.language).
+          with_type(with_null: @context.allow_null?).
+          with_in(
+            default_in_value: @context.default_in_value,
+            http_method: @context.http_method
+          ).
+          to_swagger
+
+        @schema[:properties][param_description.name.to_sym] = param_entry
+      end
+    end
+
+    if !Apipie.configuration.swagger_allow_additional_properties_in_response
+      @schema[:additionalProperties] = false
+    end
+
+    if @required_params.length > 0
+      @schema[:required] = @required_params
+    end
+
+    @schema
+  end
+
+  private
+
+  def for_array(schema)
+    {
+      type: 'array',
+      items: schema
+    }
+  end
+
+  def with_null(schema)
+    # Ideally we would write schema[:type] = ["object", "null"]
+    # but due to a bug in the json-schema gem, we need to use anyOf
+    # see https://github.com/ruby-json-schema/json-schema/issues/404
+    {
+      anyOf: [ schema, { type: 'null' } ]
+    }
+  end
+
+  def validate(param_description)
+    if !param_description.respond_to?(:required)
+      raise "Unexpected param_desc format"
+    end
+  end
+end

data/lib/apipie/generator/swagger/param_description/description.rb

@@ -0,0 +1,15 @@
+class Apipie::Generator::Swagger::ParamDescription::Description
+  def initialize(param_description, language:)
+    @param_description = param_description
+    @language = language
+  end
+
+  # @return [Hash]
+  def to_hash
+    description = @param_description.options[:desc]
+
+    return {} if description.blank?
+
+    { description: Apipie.app.translate(description, @language) }
+  end
+end

data/lib/apipie/generator/swagger/param_description/in.rb

@@ -0,0 +1,37 @@
+class Apipie::Generator::Swagger::ParamDescription::In
+  IN_KEYWORD_DEFAULT_VALUES = {
+    form_data: 'formData',
+    query: 'query'
+  }
+
+  def initialize(param_description, in_schema:, default_in_value:, http_method:)
+    @param_description = param_description
+    @in_schema = in_schema
+    @default_in_value = default_in_value
+    @http_method = http_method
+  end
+
+  # @return [Hash]
+  def to_hash
+    # The "name" and "in" keys can only be set on root parameters (non-nested)
+    return {} if @in_schema
+
+    { in: in_value }
+  end
+
+  private
+
+  def in_value
+    return @default_in_value if @default_in_value.present?
+
+    if body_allowed_for_current_method?
+      IN_KEYWORD_DEFAULT_VALUES[:form_data]
+    else
+      IN_KEYWORD_DEFAULT_VALUES[:query]
+    end
+  end
+
+  def body_allowed_for_current_method?
+    ['get', 'head'].exclude?(@http_method)
+  end
+end

data/lib/apipie/generator/swagger/param_description/name.rb

@@ -0,0 +1,18 @@
+class Apipie::Generator::Swagger::ParamDescription::Name
+def initialize(param_description, prefixed_by: nil)
+    @param_description = param_description
+    @prefixed_by = prefixed_by
+  end
+
+  # @return [Hash]
+  def to_hash
+    name =
+      if @prefixed_by.present?
+        "#{@prefixed_by}[#{@param_description.name}]"
+      else
+        @param_description.name
+      end
+
+    { name: name }
+  end
+end