apipie-rails 0.9.1 → 0.9.2

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

@@ -0,0 +1,108 @@
+class Apipie::Generator::Swagger::ParamDescription::Type
+  def initialize(param_description, with_null:, controller_method:)
+    @param_description = param_description
+    @with_null = with_null
+    @controller_method = controller_method
+  end
+
+  # @return [Hash]
+  def to_hash
+    type_definition = {}
+
+    case type.to_s
+    when 'array'
+      type_definition.merge!(for_array_type)
+    when 'enum'
+      type_definition.merge!(for_enum_type)
+    when 'object'
+      # We only get here if there is no specification
+      # of properties for this object.
+      type_definition.merge!(for_object_type)
+      warn_hash_without_internal_typespec
+    else
+      type_definition.merge!({ type: type.to_s })
+    end
+
+    if @param_description.is_array?
+      type_definition = {
+        items: type_definition,
+        type: 'array'
+      }
+
+      if @with_null
+        type_definition[:type] = [type_definition[:type], 'null']
+      end
+    end
+
+    if @with_null
+      type_definition[:type] = [type_definition[:type], 'null']
+    end
+
+    type_definition
+  end
+
+  private
+
+  def params_in_body_use_reference?
+    Apipie.configuration.swagger_json_input_uses_refs
+  end
+
+  # @return [Apipie::Generator::Swagger::Type, String]
+  def type
+    @_type ||= Apipie::Generator::Swagger::TypeExtractor.
+      new(validator).
+      extract
+  end
+
+  def for_array_type
+    validator_opts = validator.param_description.options
+    items_type = validator_opts[:of].to_s || validator_opts[:array_of].to_s
+
+    if items_type == 'Hash' && params_in_body_use_reference?
+      reference_name = Apipie::Generator::Swagger::OperationId.
+        from(@param_description.method_description, param: @param_description.name).
+        to_s
+
+      items = {
+        '$ref' => reference_name
+      }
+    else
+      items = { type: 'string' }
+    end
+
+    enum = @param_description.options[:in]
+
+    items[:enum] = enum if enum.present?
+
+    {
+      type: 'array',
+      items: items
+    }
+  end
+
+  def for_enum_type
+    {
+      type: 'string',
+      enum: @param_description.validator.values
+    }
+  end
+
+  def for_object_type
+    {
+      type: 'object',
+      additionalProperties: true
+    }
+  end
+
+  def validator
+    @_validator ||= @param_description.validator
+  end
+
+  def warn_hash_without_internal_typespec
+    Apipie::Generator::Swagger::Warning.for_code(
+      Apipie::Generator::Swagger::Warning::HASH_WITHOUT_INTERNAL_TYPESPEC_CODE,
+      @controller_method,
+      { parameter: @param_description.name }
+    ).warn_through_writer
+  end
+end

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

@@ -0,0 +1,18 @@
+module Apipie::Generator::Swagger::ParamDescription
+  # @param [Apipie::MethodDescription] method_description
+  # @param [String] name
+  #
+  # @return [Apipie::ParamDescription]
+  def self.create_for_missing_param(method_description, name)
+    Apipie::ParamDescription.new(
+      method_description,
+      name,
+      Numeric,
+      {
+        in: "path",
+        required: true,
+        added_from_path: true,
+      }
+    )
+  end
+end

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

@@ -34,8 +34,6 @@ class Apipie::Generator::Swagger::TypeExtractor
     extract
   end
 
-  private
-
   def extract
     expected_type =
       if string?
@@ -51,6 +49,8 @@ class Apipie::Generator::Swagger::TypeExtractor
     TYPES[expected_type] || @validator.expected_type
   end
 
+  private
+
   def string?
     @validator.blank?
   end

data/lib/apipie/method_description.rb

@@ -10,8 +10,7 @@ module Apipie
       @from_concern = dsl_data[:from_concern]
       @apis = ApisService.new(resource, method, dsl_data).call
 
-      desc = dsl_data[:description] || ''
-      @full_description = Apipie.markup_to_html(desc)
+      @full_description = dsl_data[:description] || ''
 
       @errors = dsl_data[:errors].map do |args|
         Apipie::ErrorDescription.from_dsl_data(args)
@@ -40,7 +39,7 @@ module Apipie
       @params_ordered = ParamDescription.unify(@params_ordered)
       @headers = dsl_data[:headers]
 
-      @show = if dsl_data.has_key? :show
+      @show = if dsl_data.key? :show
         dsl_data[:show]
       else
         true
@@ -166,8 +165,8 @@ module Apipie
         :name => @method,
         :apis => method_apis_to_json(lang),
         :formats => formats,
-        :full_description => Apipie.app.translate(@full_description, lang),
-        :errors => errors.map(&:to_json),
+        :full_description => Apipie.markup_to_html(Apipie.app.translate(@full_description, lang)),
+        :errors => errors.map{ |error| error.to_json(lang) }.flatten,
         :params => params_ordered.map{ |param| param.to_json(lang) }.flatten,
         :returns => @returns.map{ |return_item| return_item.to_json(lang) }.flatten,
         :examples => @examples,

data/lib/apipie/param_description.rb

@@ -12,9 +12,9 @@ module Apipie
     attr_reader :additional_properties, :is_array
     attr_accessor :parent, :required
 
-    alias_method :response_only?, :response_only
-    alias_method :request_only?, :request_only
-    alias_method :is_array?, :is_array
+    alias response_only? response_only
+    alias request_only? request_only
+    alias is_array? is_array
 
     def self.from_dsl_data(method_description, args)
       param_name, validator, desc_or_options, options, block = args
@@ -71,7 +71,7 @@ module Apipie
       @request_only = (@options[:only_in] == :request)
       raise ArgumentError.new("'#{@options[:only_in]}' is not a valid value for :only_in") if (!@response_only && !@request_only) && @options[:only_in].present?
 
-      @show = if @options.has_key? :show
+      @show = if @options.key? :show
         @options[:show]
       else
         true
@@ -212,7 +212,7 @@ module Apipie
     # action awareness is being inherited from ancestors (in terms of
     # nested params)
     def action_aware?
-      if @options.has_key?(:action_aware)
+      if @options.key?(:action_aware)
         return @options[:action_aware]
       elsif @parent
         @parent.action_aware?
@@ -237,7 +237,7 @@ module Apipie
     # crate/update actions.
     def action_awareness
       if action_aware?
-        if !@options.has_key?(:allow_nil)
+        if !@options.key?(:allow_nil)
           if @required
             @allow_nil = false
           else
@@ -268,7 +268,7 @@ module Apipie
     end
 
     def is_required?
-      if @options.has_key?(:required)
+      if @options.key?(:required)
         if (@options[:required] == true) || (@options[:required] == false)
           @options[:required]
         else

data/lib/apipie/resource_description.rb

@@ -35,7 +35,7 @@ module Apipie
 
     def update_from_dsl_data(dsl_data)
       @_name = dsl_data[:resource_name] if dsl_data[:resource_name]
-      @_full_description = Apipie.markup_to_html(dsl_data[:description])
+      @_full_description = dsl_data[:description]
       @_short_description = dsl_data[:short_description]
       @_path = dsl_data[:path] || ""
       @_formats = dsl_data[:formats]
@@ -71,7 +71,7 @@ module Apipie
     end
 
     def remove_method_description(method_name)
-      if @_methods.has_key?(method_name)
+      if @_methods.key?(method_name)
         @_methods.delete(method_name)
       end
     end
@@ -110,7 +110,7 @@ module Apipie
         :api_url => api_url,
         :name => @_name,
         :short_description => Apipie.app.translate(@_short_description, lang),
-        :full_description => Apipie.app.translate(@_full_description, lang),
+        :full_description => Apipie.markup_to_html(Apipie.app.translate(@_full_description, lang)),
         :version => _version,
         :formats => @_formats,
         :metadata => @_metadata,

data/lib/apipie/response_description.rb

@@ -116,12 +116,12 @@ module Apipie
     def additional_properties
       !!@response_object.additional_properties
     end
-    alias :allow_additional_properties :additional_properties
+    alias allow_additional_properties additional_properties
 
     def to_json(lang=nil)
       {
           :code => code,
-          :description => description,
+          :description => Apipie.app.translate(description, lang),
           :is_array => is_array?,
           :returns_object => params_ordered.map{ |param| param.to_json(lang).tap{|h| h.delete(:validations) }}.flatten,
           :additional_properties => additional_properties,

data/lib/apipie/response_description_adapter.rb

@@ -107,9 +107,10 @@ module Apipie
 
       def add_sub_property(prop_desc)
         raise "Only properties with expected_type 'object' can have sub-properties" unless @expected_type == 'object'
-        if prop_desc.is_a? PropDesc
+        case prop_desc
+        when PropDesc
           @sub_properties << prop_desc
-        elsif prop_desc.is_a? Modifier
+        when Modifier
           prop_desc.apply(self)
         else
           raise "Unrecognized prop_desc type (#{prop_desc.class})"
@@ -130,7 +131,7 @@ module Apipie
       attr_reader :name, :required, :expected_type, :options, :description
       attr_accessor :additional_properties
 
-      alias_method :desc, :description
+      alias desc description
 
       def is_array?
         @is_array
@@ -170,9 +171,10 @@ module Apipie
     end
 
     def add(prop_desc)
-      if prop_desc.is_a? PropDesc
+      case prop_desc
+      when PropDesc
         @property_descs << prop_desc
-      elsif prop_desc.is_a? Modifier
+      when Modifier
         prop_desc.apply(self)
       else
         raise "Unrecognized prop_desc type (#{prop_desc.class})"

data/lib/apipie/swagger_generator.rb

@@ -36,7 +36,6 @@ module Apipie
     def generate_from_resources(version, resources, method_name, lang, clear_warnings=false)
       init_swagger_vars(version, lang, clear_warnings)
 
-      @lang = lang
       @only_method = method_name
       add_resources(resources)
 
@@ -143,13 +142,6 @@ module Apipie
       warn(Apipie::Generator::Swagger::Warning::NO_RETURN_CODES_SPECIFIED_CODE)
     end
 
-    def warn_hash_without_internal_typespec(param_name)
-      warn(
-        Apipie::Generator::Swagger::Warning::HASH_WITHOUT_INTERNAL_TYPESPEC_CODE,
-        { parameter: param_name }
-      )
-    end
-
     def warn_optional_param_in_path(param_name)
       warn(
         Apipie::Generator::Swagger::Warning::OPTIONAL_PARAM_IN_PATH_CODE,
@@ -261,7 +253,7 @@ module Apipie
           warning_tags = []
         end
 
-        op_id = swagger_op_id_for_path(api.http_method, api.path)
+        op_id = Apipie::Generator::Swagger::OperationId.from(api).to_s
 
         include_op_id_in_computed_interface_id(op_id)
 
@@ -275,7 +267,7 @@ module Apipie
             summary: Apipie.app.translate(api.short_description, @current_lang),
             parameters: swagger_params_array_for_method(ruby_method, api.path),
             responses: responses,
-            description: ruby_method.full_description
+            description: Apipie.app.translate(ruby_method.full_description, @current_lang)
         }
 
         if methods[method_key][:summary].nil?
@@ -283,6 +275,7 @@ module Apipie
           warn_missing_method_summary
         end
       end
+
     end
 
     #--------------------------------------------------------------------------
@@ -308,16 +301,6 @@ module Apipie
       remove_colons method.resource.controller.name + "::" + method.method
     end
 
-    def swagger_id_for_typename(typename)
-      typename
-    end
-
-    def swagger_op_id_for_path(http_method, path)
-      # using lowercase http method, because the 'swagger-codegen' tool outputs
-      # strange method names if the http method is in uppercase
-      http_method.downcase + path.gsub(/\//,'_').gsub(/:(\w+)/, '\1').gsub(/_$/,'')
-    end
-
     def swagger_param_type(param_desc)
       if param_desc.blank?
         raise ArgumentError, 'param_desc is required'
@@ -343,11 +326,10 @@ module Apipie
     def json_schema_for_method_response(method, return_code, allow_nulls)
       @definitions = {}
       for response in method.returns
-        if response.code.to_s == return_code.to_s
-          schema = response_schema(response, allow_nulls) if response.code.to_s == return_code.to_s
-          schema[:definitions] = @definitions if @definitions != {}
-          return schema
-        end
+        next unless response.code.to_s == return_code.to_s
+        schema = response_schema(response, allow_nulls)
+        schema[:definitions] = @definitions if @definitions != {}
+        return schema
       end
       nil
     end
@@ -364,9 +346,22 @@ module Apipie
         @disable_default_value_warning = true
 
         if responses_use_reference? && response.typename
-          schema = {"$ref" => gen_referenced_block_from_params_array(swagger_id_for_typename(response.typename), response.params_ordered, allow_nulls)}
+          schema = {
+            "$ref" => gen_referenced_block_from_params_array(
+              response.typename,
+              response.params_ordered,
+              allow_nulls
+            )
+          }
         else
-          schema = json_schema_obj_from_params_array(response.params_ordered, allow_nulls)
+          schema = Apipie::Generator::Swagger::ParamDescription::Composite.new(
+            response.params_ordered,
+            Apipie::Generator::Swagger::Context.new(
+              allow_null: allow_nulls,
+              http_method: @current_http_method,
+              controller_method: @current_method
+            )
+          ).to_swagger
         end
 
       ensure
@@ -397,7 +392,7 @@ module Apipie
 
       for response in method.returns
         swagger_response_block = {
-            description: response.description
+            description: Apipie.app.translate(response.description, @current_lang)
         }
 
         schema = response_schema(response)
@@ -434,105 +429,14 @@ module Apipie
 
       missing.each do |name|
         warn_path_parameter_not_described(name, path)
-        result[name.to_sym] = OpenStruct.new({
-                                                 required: true,
-                                                 _gen_added_from_path: true,
-                                                 name: name,
-                                                 validator: Apipie::Validator::NumberValidator.new(nil),
-                                                 options: {
-                                                     in: "path"
-                                                 }
-                                             })
-      end
-
-      result
-    end
-
-    #--------------------------------------------------------------------------
-    # The core routine for creating a swagger parameter definition block.
-    # The output is slightly different when the parameter is inside a schema block.
-    #--------------------------------------------------------------------------
-    def swagger_atomic_param(param_desc, in_schema, name, allow_nulls)
-      def save_field(entry, openapi_key, v, apipie_key=openapi_key, translate=false)
-        if v.key?(apipie_key)
-          if translate
-            entry[openapi_key] = Apipie.app.translate(v[apipie_key], @current_lang)
-          else
-            entry[openapi_key] = v[apipie_key]
-          end
-        end
-      end
-
-      swagger_def = {}
-      swagger_def[:name] = name if !name.nil?
-
-      swg_param_type = swagger_param_type(param_desc)
-      swagger_def[:type] = swg_param_type.to_s
-      if (swg_param_type.is_a? Apipie::Generator::Swagger::Type) && !swg_param_type.str_format.nil?
-        swagger_def[:format] = swg_param_type.str_format
-      end
-
-      if swagger_def[:type] == "array"
-        array_of_validator_opts = param_desc.validator.param_description.options
-        items_type = array_of_validator_opts[:of].to_s || array_of_validator_opts[:array_of].to_s
-        if items_type == "Hash"
-          ref_name = "#{swagger_op_id_for_path(param_desc.method_description.apis.first.http_method, param_desc.method_description.apis.first.path)}_param_#{param_desc.name}"
-          swagger_def[:items] = {"$ref" => gen_referenced_block_from_params_array(ref_name, param_desc.validator.param_description.validator.params_ordered, allow_nulls)}
-        else
-          swagger_def[:items] = {type: "string"}
-        end
-
-        enum = param_desc.options.fetch(:in, [])
-        swagger_def[:items][:enum] = enum if enum.any?
-      end
-
-      if swagger_def[:type] == "enum"
-        swagger_def[:type] = "string"
-        swagger_def[:enum] = param_desc.validator.values
-      end
 
-      if swagger_def[:type] == "object"  # we only get here if there is no specification of properties for this object
-        swagger_def[:additionalProperties] = true
-        warn_hash_without_internal_typespec(param_desc.name)
+        result[name.to_sym] = Apipie::Generator::Swagger::ParamDescription.
+          create_for_missing_param(method, name)
       end
 
-      if param_desc.is_array?
-        new_swagger_def = {
-            items: swagger_def,
-            type: 'array'
-        }
-        swagger_def = new_swagger_def
-        if allow_nulls
-          swagger_def[:type] = [swagger_def[:type], "null"]
-        end
-      end
-
-      if allow_nulls
-        swagger_def[:type] = [swagger_def[:type], "null"]
-      end
-
-      if !in_schema
-        # the "name" and "in" keys can only be set on root parameters (non-nested)
-        swagger_def[:in] = @default_value_for_param_in if name.present?
-        swagger_def[:required] = param_desc.required if param_desc.required
-      end
-
-      save_field(swagger_def, :description, param_desc.options, :desc, true) unless param_desc.options[:desc].nil?
-      save_field(swagger_def, :default, param_desc.options, :default_value)
-
-      if param_desc.respond_to?(:_gen_added_from_path) && !param_desc.required
-        warn_optional_param_in_path(param_desc.name)
-        swagger_def[:required] = true
-      end
-
-      if !swagger_def[:required] && !swagger_def.key?(:default)
-        warn_optional_without_default_value(param_desc.name) unless @disable_default_value_warning
-      end
-
-      swagger_def
+      result
     end
 
-
     #--------------------------------------------------------------------------
     # JSON schema and referenced-object generation
     #--------------------------------------------------------------------------
@@ -541,79 +445,24 @@ module Apipie
       "#/definitions/#{name}"
     end
 
-
-    def json_schema_obj_from_params_array(params_array, allow_nulls = false)
-      (param_defs, required_params) = json_schema_param_defs_from_params_array(params_array, allow_nulls)
-
-      result = {type: "object"}
-      result[:properties] = param_defs
-      result[:additionalProperties] = false unless Apipie.configuration.swagger_allow_additional_properties_in_response
-      result[:required] = required_params if required_params.length > 0
-
-      param_defs.length > 0 ? result : nil
-    end
-
     def gen_referenced_block_from_params_array(name, params_array, allow_nulls=false)
       return ref_to(:name) if @definitions.key(:name)
 
-      schema_obj = json_schema_obj_from_params_array(params_array, allow_nulls)
+      schema_obj = Apipie::Generator::Swagger::ParamDescription::Composite.new(
+        params_array,
+        Apipie::Generator::Swagger::Context.new(
+          allow_null: allow_nulls,
+          http_method: @current_http_method,
+          controller_method: @current_method
+        )
+      ).to_swagger
+
       return nil if schema_obj.nil?
 
       @definitions[name.to_sym] = schema_obj
       ref_to(name.to_sym)
     end
 
-    def json_schema_param_defs_from_params_array(params_array, allow_nulls = false)
-      param_defs = {}
-      required_params = []
-
-      params_array ||= []
-
-
-      for param_desc in params_array
-        if !param_desc.respond_to?(:required)
-          # pp param_desc
-          raise ("unexpected param_desc format")
-        end
-
-        required_params.push(param_desc.name.to_sym) if param_desc.required
-
-        param_type = swagger_param_type(param_desc)
-
-        if param_type == "object" && param_desc.validator.params_ordered
-          schema = json_schema_obj_from_params_array(param_desc.validator.params_ordered, allow_nulls)
-          if param_desc.additional_properties
-            schema[:additionalProperties] = true
-          end
-
-          if param_desc.is_array?
-            new_schema = {
-                type: 'array',
-                items: schema
-            }
-            schema = new_schema
-          end
-
-          if allow_nulls
-            # 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
-            new_schema = {
-                anyOf: [schema, {type: "null"}]
-            }
-            schema = new_schema
-          end
-          param_defs[param_desc.name.to_sym] = schema if !schema.nil?
-        else
-          param_defs[param_desc.name.to_sym] = swagger_atomic_param(param_desc, true, nil, allow_nulls)
-        end
-      end
-
-      [param_defs, required_params]
-    end
-
-
-
     #--------------------------------------------------------------------------
     # swagger "Params" block generation
     #--------------------------------------------------------------------------
@@ -638,7 +487,15 @@ module Apipie
         if params_in_body_use_reference?
           swagger_schema_for_body = {"$ref" => gen_referenced_block_from_params_array("#{swagger_op_id_for_method(method)}_input", body_param_defs_array)}
         else
-          swagger_schema_for_body = json_schema_obj_from_params_array(body_param_defs_array)
+          swagger_schema_for_body =
+            Apipie::Generator::Swagger::ParamDescription::Composite.new(
+              body_param_defs_array,
+              Apipie::Generator::Swagger::Context.new(
+                allow_null: false,
+                http_method: @current_http_method,
+                controller_method: @current_method
+              )
+            ).to_swagger
         end
 
         swagger_body_param = {
@@ -675,20 +532,7 @@ module Apipie
 
 
     def add_params_from_hash(swagger_params_array, param_defs, prefix=nil, default_value_for_in=nil)
-
-      if default_value_for_in
-        @default_value_for_param_in = default_value_for_in
-      else
-        if body_allowed_for_current_method
-          @default_value_for_param_in = "formData"
-        else
-          @default_value_for_param_in = "query"
-        end
-      end
-
-
       param_defs.each do |name, desc|
-
         if !prefix.nil?
           name = "#{prefix}[#{name}]"
         end
@@ -701,13 +545,21 @@ module Apipie
             warn_param_ignored_in_form_data(desc.name)
           end
         else
-          param_entry = swagger_atomic_param(desc, false, name, false)
+          param_entry = Apipie::Generator::Swagger::ParamDescription::Builder.
+            new(desc, in_schema: false, controller_method: @current_method).
+            with_description(language: @current_lang).
+            with_name(prefix: prefix).
+            with_type(with_null: @allow_null).
+            with_in(
+              http_method: @current_http_method,
+              default_in_value: default_value_for_in
+            ).to_swagger
+
           if param_entry[:required]
             swagger_params_array.unshift(param_entry)
           else
             swagger_params_array.push(param_entry)
           end
-
         end
       end
     end

data/lib/apipie/validator.rb

@@ -347,10 +347,10 @@ module Apipie
         if @hash_params
           @hash_params.each do |k, p|
             if Apipie.configuration.validate_presence?
-              raise ParamMissing.new(p) if p.required && !value.has_key?(k)
+              raise ParamMissing.new(p) if p.required && !value.key?(k)
             end
             if Apipie.configuration.validate_value?
-              p.validate(value[k]) if value.has_key?(k)
+              p.validate(value[k]) if value.key?(k)
             end
           end
         end
@@ -360,7 +360,7 @@ module Apipie
       def process_value(value)
         if @hash_params && value
           return @hash_params.each_with_object({}) do |(key, param), api_params|
-            if value.has_key?(key)
+            if value.key?(key)
               api_params[param.as] = param.process_value(value[key])
             end
           end