apipie-rails 0.9.3 → 1.0.0

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

@@ -74,7 +74,7 @@ class Apipie::Generator::Swagger::ParamDescription::Composite
       end
     end
 
-    if !Apipie.configuration.swagger_allow_additional_properties_in_response
+    if !Apipie.configuration.generator.swagger.allow_additional_properties_in_response
       @schema[:additionalProperties] = false
     end
 
@@ -85,6 +85,14 @@ class Apipie::Generator::Swagger::ParamDescription::Composite
     @schema
   end
 
+  # @param [Symbol, String] param_type
+  #
+  # @return [Apipie::Generator::Swagger::ParamDescription::ReferencedComposite]
+  def referenced(param_type)
+    Apipie::Generator::Swagger::ParamDescription::ReferencedComposite.
+      new(self, param_type)
+  end
+
   private
 
   def for_array(schema)

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

@@ -32,6 +32,6 @@ class Apipie::Generator::Swagger::ParamDescription::In
   end
 
   def body_allowed_for_current_method?
-    ['get', 'head'].exclude?(@http_method)
+    %w[get head].exclude?(@http_method)
   end
 end

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

@@ -0,0 +1,61 @@
+class Apipie::Generator::Swagger::ParamDescription::PathParamsComposite
+  # @param [Array<Apipie::ParamDescription>] param_descriptions
+  # @param [Apipie::Generator::Swagger::Context] context
+  def initialize(param_descriptions, context)
+    @param_descriptions = param_descriptions
+    @context = context
+    @result = []
+  end
+
+  # @return [Array]
+  def to_swagger
+    @param_descriptions.each do |desc|
+      context = @context.dup
+
+      type = Apipie::Generator::Swagger::TypeExtractor.new(desc.validator).extract
+
+      if type == 'object' && desc.validator.params_ordered.blank?
+        warn_param_ignored_in_form_data(desc.name)
+        next
+      end
+
+      has_nested_params = type == 'object' &&
+                          desc.validator.params_ordered.present?
+
+      if has_nested_params
+        context.add_to_prefix!(desc.name)
+
+        out = Apipie::Generator::Swagger::ParamDescription::PathParamsComposite
+              .new(desc.validator.params_ordered, context)
+              .to_swagger
+
+        @result.concat(out)
+      else
+        param_entry =
+          Apipie::Generator::Swagger::ParamDescription::Builder
+          .new(desc, in_schema: false, controller_method: context.controller_method)
+          .with_description(language: context.language)
+          .with_name(prefix: context.prefix)
+          .with_type(with_null: context.allow_null?)
+          .with_in(
+            http_method: context.http_method,
+            default_in_value: context.default_in_value
+          ).to_swagger
+
+        @result << param_entry
+      end
+    end
+
+    @result.sort_by { |p| p[:required] ? 0 : 1 }
+  end
+
+  private
+
+  def warn_param_ignored_in_form_data(name)
+    Apipie::Generator::Swagger::Warning.for_code(
+      Apipie::Generator::Swagger::Warning::PARAM_IGNORED_IN_FORM_DATA_CODE,
+      @context.controller_method.ruby_name,
+      { parameter: name }
+    ).warn_through_writer
+  end
+end

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

@@ -0,0 +1,36 @@
+# A Composite that keeps track when a param description has been added to references
+#   and returns the reference instead of the complete object
+class Apipie::Generator::Swagger::ParamDescription::ReferencedComposite
+  # @param [Apipie::Generator::Swagger::ParamDescription::Composite] composite
+  # @param [Symbol, String] param_type
+  def initialize(composite, param_type)
+    @composite = composite
+    @param_type = param_type.to_sym
+  end
+
+  def to_swagger
+    return ref_to(:name) if added?(:name)
+
+    schema_obj = @composite.to_swagger
+
+    return nil if schema_obj.nil?
+
+    add(schema_obj)
+
+    { '$ref' => ref_to(@param_type) }
+  end
+
+  private
+
+  def ref_to(name)
+    "#/definitions/#{name}"
+  end
+
+  def add(schema)
+    Apipie::Generator::Swagger::ReferencedDefinitions.instance.add!(@param_type, schema)
+  end
+
+  def added?(name)
+    Apipie::Generator::Swagger::ReferencedDefinitions.instance.added?(name)
+  end
+end

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

@@ -44,7 +44,7 @@ class Apipie::Generator::Swagger::ParamDescription::Type
   private
 
   def params_in_body_use_reference?
-    Apipie.configuration.swagger_json_input_uses_refs
+    Apipie.configuration.generator.swagger.json_input_uses_refs
   end
 
   # @return [Apipie::Generator::Swagger::Type, String]
@@ -99,9 +99,16 @@ class Apipie::Generator::Swagger::ParamDescription::Type
   end
 
   def warn_hash_without_internal_typespec
+    method_id =
+      if @param_description.is_a?(Apipie::ResponseDescriptionAdapter::PropDesc)
+        @controller_method.method
+      else
+        Apipie::Generator::Swagger::MethodDescription::Decorator.new(@param_description.method_description).ruby_name
+      end
+
     Apipie::Generator::Swagger::Warning.for_code(
       Apipie::Generator::Swagger::Warning::HASH_WITHOUT_INTERNAL_TYPESPEC_CODE,
-      @controller_method,
+      method_id,
       { parameter: @param_description.name }
     ).warn_through_writer
   end

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

@@ -0,0 +1,36 @@
+class Apipie::Generator::Swagger::PathDecorator < SimpleDelegator
+  def param_names
+    @param_names ||= scan(/:(\w+)/).map { |ar| ar[0].to_sym }
+  end
+
+  # @param [Symbol] param_name
+  def param?(param_name)
+    param_names.include?(param_name)
+  end
+
+  # @param [String] controller_method
+  #
+  # @return [Apipie::Generator::Swagger::PathDecorator]
+  def swagger_path(controller_method = nil)
+    current_path = gsub(/:(\w+)/, '{\1}').gsub(%r{/$}, '')
+
+    unless current_path.starts_with?('/')
+      warn_for_missing_slash(controller_method) if controller_method.present?
+
+      current_path = "/#{current_path}"
+    end
+
+    current_path
+  end
+
+  private
+
+  # @param [String] controller_method
+  def warn_for_missing_slash(controller_method)
+    Apipie::Generator::Swagger::Warning.for_code(
+      Apipie::Generator::Swagger::Warning::ADDED_MISSING_SLASH_CODE,
+      controller_method,
+      { path: self }
+    ).warn_through_writer
+  end
+end

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

@@ -0,0 +1,17 @@
+class Apipie::Generator::Swagger::ReferencedDefinitions
+  include Singleton
+
+  attr_reader :definitions
+
+  def initialize
+    @definitions = {}
+  end
+
+  def add!(param_type, schema)
+    @definitions[param_type] = schema
+  end
+
+  def added?(name)
+    @definitions.key?(name)
+  end
+end

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

@@ -0,0 +1,30 @@
+class Apipie::Generator::Swagger::ResourceDescriptionsCollection
+  # @param [Hash{String->Apipie::ResourceDescription}] resource_descriptions
+  def initialize(resource_descriptions)
+    @resource_descriptions = resource_descriptions
+  end
+
+  # @return [Array<Apipie::ResourceDescription>]
+  def filter(version:, resource_id:, method_name: nil)
+    resources = []
+
+    # If resource_id is blank, take just resources which have some methods because
+    # we dont want to show eg ApplicationController as resource
+    # otherwise, take only the specified resource
+    @resource_descriptions[version].each do |resource_description_id, resource_description|
+      if (resource_id.blank? && resource_description._methods.present?) || resource_description_id == resource_id
+        resources << resource_description
+      end
+    end
+
+    if method_name.present?
+      resources = resources.select do |resource_description|
+        resource_description._methods.select do |method_description_name, _|
+          method_description_name == method_name
+        end.present?
+      end
+    end
+
+    resources
+  end
+end

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

@@ -0,0 +1,56 @@
+class Apipie::Generator::Swagger::ResourceDescriptionComposite
+  # @param [Array<Apipie::ResourceDescription>] resource_descriptions
+  def initialize(resource_descriptions, language:)
+    @resource_descriptions = resource_descriptions
+    @language = language
+  end
+
+  # @return [Hash{Symbol->Array | Hash}]
+  def to_swagger
+    {
+      tags: tags,
+      paths: paths
+    }
+  end
+
+  # @return [Array]
+  def tags
+    results = []
+
+    @resource_descriptions.each do |resource_description|
+      next unless resource_description._full_description
+
+      results << {
+        name: resource_description._id,
+        description: Apipie.app.translate(
+          resource_description._full_description,
+          @language
+        )
+      }
+    end
+
+    results
+  end
+
+  # @return [Hash]
+  def paths
+    results = {}
+
+    @resource_descriptions.each do |resource_description|
+      resource_description._methods.each_value do |method_description|
+        next unless method_description.show
+
+        result = Apipie::Generator::Swagger::MethodDescription::ApiSchemaService
+                 .new(
+                   Apipie::Generator::Swagger::MethodDescription::Decorator.new(method_description),
+                   language: @language
+                 )
+                 .call
+
+        results.deep_merge!(result)
+      end
+    end
+
+    results
+  end
+end

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

@@ -0,0 +1,63 @@
+class Apipie::Generator::Swagger::Schema
+  # @param [Array<Apipie::ResourceDescription>] resource_descriptions
+  def initialize(resource_descriptions, version:, language:, clear_warnings:)
+    @resource_descriptions = resource_descriptions
+    @language = language
+    @clear_warnings = clear_warnings
+    @swagger = {
+      swagger: '2.0',
+      info: {
+        title: Apipie.configuration.app_name.to_s,
+        description: "#{Apipie.app_info(version, @language)}#{Apipie.configuration.copyright}",
+        version: version.to_s,
+        'x-copyright': Apipie.configuration.copyright
+      },
+      basePath: Apipie.api_base_url(version),
+      consumes: [],
+      paths: {},
+      definitions: {},
+      schemes: Apipie.configuration.generator.swagger.schemes,
+      tags: [],
+      securityDefinitions: Apipie.configuration.generator.swagger.security_definitions,
+      security: Apipie.configuration.generator.swagger.global_security
+    }
+  end
+
+  def generate
+    if Apipie.configuration.generator.swagger.api_host.present?
+      @swagger[:host] = Apipie.configuration.generator.swagger.api_host
+    end
+
+    if Apipie.configuration.generator.swagger.content_type_input == :json
+      @swagger[:consumes] = ['application/json']
+      @swagger[:info][:title] += ' (params in:body)'
+    else
+      @swagger[:consumes] = ['application/x-www-form-urlencoded', 'multipart/form-data']
+      @swagger[:info][:title] += ' (params in:formData)'
+    end
+
+    if @clear_warnings
+      Apipie::Generator::Swagger::WarningWriter.instance.clear!
+    end
+
+    @swagger.merge!(tags_and_paths)
+
+    if Apipie.configuration.generator.swagger.generate_x_computed_id_field?
+      @swagger[:info]['x-computed-id'] =
+        Apipie::Generator::Swagger::ComputedInterfaceId.instance.id
+    end
+
+    @swagger[:definitions] =
+      Apipie::Generator::Swagger::ReferencedDefinitions.instance.definitions
+
+    @swagger
+  end
+
+  private
+
+  def tags_and_paths
+    Apipie::Generator::Swagger::ResourceDescriptionComposite
+      .new(@resource_descriptions, language: @language)
+      .to_swagger
+  end
+end

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

@@ -25,21 +25,10 @@ class Apipie::Generator::Swagger::TypeExtractor
     @validator = validator
   end
 
-  # @param [Hash<Symbol, Apipie::Generator::Swagger::Warning>] warnings
-  def extract_with_warnings(warnings = {})
-    if boolean? && warnings[:boolean].present?
-      Apipie::Generator::Swagger::WarningWriter.instance.warn(warnings[:boolean])
-    end
-
-    extract
-  end
-
   def extract
     expected_type =
       if string?
         :string
-      elsif boolean?
-        :boolean
       elsif enum?
         :enum
       else
@@ -59,12 +48,4 @@ class Apipie::Generator::Swagger::TypeExtractor
     @validator.is_a?(Apipie::Validator::EnumValidator) ||
       (@validator.respond_to?(:is_enum?) && @validator.is_enum?)
   end
-
-  def boolean?
-    @_boolean ||= enum? && boolean_values?
-  end
-
-  def boolean_values?
-    @validator.values.to_set == Set.new([true, false])
-  end
 end

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

@@ -7,7 +7,6 @@ class Apipie::Generator::Swagger::Warning
   OPTIONAL_WITHOUT_DEFAULT_VALUE_CODE = 105
   PARAM_IGNORED_IN_FORM_DATA_CODE = 106
   PATH_PARAM_NOT_DESCRIBED_CODE = 107
-  INFERRING_BOOLEAN_CODE = 108
 
   CODES = {
     missing_method_summary: MISSING_METHOD_SUMMARY_CODE,
@@ -17,8 +16,7 @@ class Apipie::Generator::Swagger::Warning
     optional_param_in_path: OPTIONAL_PARAM_IN_PATH_CODE,
     optional_without_default_value: OPTIONAL_WITHOUT_DEFAULT_VALUE_CODE,
     param_ignored_in_form_data: PARAM_IGNORED_IN_FORM_DATA_CODE,
-    path_param_not_described_code: PATH_PARAM_NOT_DESCRIBED_CODE,
-    inferring_boolean: INFERRING_BOOLEAN_CODE
+    path_param_not_described_code: PATH_PARAM_NOT_DESCRIBED_CODE
   }
 
   MESSAGES = {
@@ -29,8 +27,7 @@ class Apipie::Generator::Swagger::Warning
     OPTIONAL_PARAM_IN_PATH_CODE => "The parameter :%{parameter} is 'in-path'.  Ignoring 'not required' in DSL",
     OPTIONAL_WITHOUT_DEFAULT_VALUE_CODE => "The parameter :%{parameter} is optional but default value is not specified (use :default_value => ...)",
     PARAM_IGNORED_IN_FORM_DATA_CODE => "Ignoring param :%{parameter} -- cannot include Hash without fields in a formData specification",
-    PATH_PARAM_NOT_DESCRIBED_CODE => "The parameter :%{name} appears in the path %{path} but is not described",
-    INFERRING_BOOLEAN_CODE => "The parameter [%{parameter}] is Enum with [true, false] values. Inferring 'boolean'"
+    PATH_PARAM_NOT_DESCRIBED_CODE => "The parameter :%{name} appears in the path %{path} but is not described"
   }
 
   attr_reader :code
@@ -46,7 +43,7 @@ class Apipie::Generator::Swagger::Warning
   end
 
   def warning_message
-    "WARNING (#{@code}): [#{@method_id}] -- #{@info_message}"
+    "WARNING (#{@code}): [#{@method_id}] -- #{@info_message}\n"
   end
 
   def warn

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

@@ -18,6 +18,12 @@ class Apipie::Generator::Swagger::WarningWriter
     @issued_warnings.count > 0
   end
 
+  def clear!
+    @issued_warnings = []
+
+    self
+  end
+
   private
 
   # @param [Apipie::Generator::Swagger::Warning] warning
@@ -43,6 +49,6 @@ class Apipie::Generator::Swagger::WarningWriter
 
   # @return [FalseClass, TrueClass, Array]
   def suppress_warnings_config
-    Apipie.configuration.swagger_suppress_warnings
+    Apipie.configuration.generator.swagger.suppress_warnings
   end
 end

data/lib/apipie/helpers.rb

@@ -25,10 +25,10 @@ module Apipie
         @url_prefix << request_script_name
         @url_prefix << Apipie.configuration.doc_base_url
       end
-      path = path.sub(/^\//,"")
+      path = path.sub(%r{^/},"")
       ret = "#{@url_prefix}/#{path}"
-      ret.insert(0,"/") unless ret =~ /\A[.\/]/
-      ret.sub!(/\/*\Z/,"")
+      ret.insert(0,"/") unless ret =~ %r{\A[./]}
+      ret.sub!(%r{/*\Z},"")
       ret
     end
 

data/lib/apipie/method_description.rb

@@ -1,5 +1,4 @@
 module Apipie
-
   class MethodDescription
     attr_reader :full_description, :method, :resource, :apis, :examples, :see, :formats, :headers, :show
     attr_accessor :metadata
@@ -159,7 +158,7 @@ module Apipie
       @formats || @resource._formats
     end
 
-    def to_json(lang=nil)
+    def to_json(lang = nil)
       {
         :doc_url => doc_url,
         :name => @method,
@@ -182,6 +181,10 @@ module Apipie
       @from_concern
     end
 
+    def method_name
+      @method
+    end
+
     private
 
     def merge_params(params, new_params)
@@ -224,5 +227,4 @@ module Apipie
       example
     end
   end
-
 end

data/lib/apipie/param_description.rb

@@ -57,6 +57,10 @@ module Apipie
         @from_concern = @options[:param_group][:from_concern]
       end
 
+      if validator.is_a?(Hash)
+        @options.merge!(validator.select{|k,v| k != :array_of })
+      end
+
       @method_description = method_description
       @name = concern_subst(name)
       @as = options[:as] || @name
@@ -85,9 +89,7 @@ module Apipie
       if validator
         if (validator != Hash) && (validator.is_a? Hash) && (validator[:array_of])
           @is_array = true
-          rest_of_options = validator
           validator = validator[:array_of]
-          options.merge!(rest_of_options.select{|k,v| k != :array_of })
           raise "an ':array_of =>' validator is allowed exclusively on response-only fields" unless @response_only
         end
         @validator = Validator::BaseValidator.find(self, validator, @options, block)

data/lib/apipie/resource_description.rb

@@ -14,27 +14,25 @@ module Apipie
   class ResourceDescription
 
     attr_reader :controller, :_short_description, :_full_description, :_methods, :_id,
-      :_path, :_name, :_params_args, :_returns_args, :_tag_list_arg, :_errors_args,
+      :_path, :_params_args, :_returns_args, :_tag_list_arg, :_errors_args,
       :_formats, :_parent, :_metadata, :_headers, :_deprecated
 
-    def initialize(controller, resource_name, dsl_data = nil, version = nil)
-
+    def initialize(controller, id, dsl_data = nil, version = nil)
       @_methods = ActiveSupport::OrderedHash.new
       @_params_args = []
       @_errors_args = []
       @_returns_args = []
 
       @controller = controller
-      @_id = resource_name
+      @_id = id
       @_version = version || Apipie.configuration.default_version
-      @_name = @_id.humanize
       @_parent = Apipie.get_resource_description(controller.superclass, version)
 
       update_from_dsl_data(dsl_data) if dsl_data
     end
 
     def update_from_dsl_data(dsl_data)
-      @_name = dsl_data[:resource_name] if dsl_data[:resource_name]
+      @_resource_name = dsl_data[:resource_name] if dsl_data[:resource_name]
       @_full_description = dsl_data[:description]
       @_short_description = dsl_data[:short_description]
       @_path = dsl_data[:path] || ""
@@ -61,8 +59,13 @@ module Apipie
       @_api_base_url || @_parent.try(:_api_base_url) || Apipie.api_base_url(_version)
     end
 
+    def name
+      @name ||= @_resource_name.presence || @_id.split('-').map(&:capitalize).join('::')
+    end
+    alias _name name
+
     def add_method_description(method_description)
-      Apipie.debug "@resource_descriptions[#{self._version}][#{self._name}]._methods[#{method_description.method}] = #{method_description}"
+      Apipie.debug "@resource_descriptions[#{self._version}][#{self._id}]._methods[#{method_description.method}] = #{method_description}"
       @_methods[method_description.method.to_sym] = method_description
     end
 
@@ -108,7 +111,7 @@ module Apipie
         :doc_url => doc_url,
         :id => _id,
         :api_url => api_url,
-        :name => @_name,
+        :name => name,
         :short_description => Apipie.app.translate(@_short_description, lang),
         :full_description => Apipie.markup_to_html(Apipie.app.translate(@_full_description, lang)),
         :version => _version,

data/lib/apipie/response_description.rb

@@ -118,7 +118,7 @@ module Apipie
     end
     alias allow_additional_properties additional_properties
 
-    def to_json(lang=nil)
+    def to_json(lang = nil)
       {
           :code => code,
           :description => Apipie.app.translate(description, lang),

data/lib/apipie/response_description_adapter.rb

@@ -1,6 +1,6 @@
 module Apipie
 
-  def self.prop(name, expected_type, options={}, sub_properties=[])
+  def self.prop(name, expected_type, options = {}, sub_properties = [])
     Apipie::ResponseDescriptionAdapter::PropDesc.new(name, expected_type, options, sub_properties)
   end
 
@@ -60,7 +60,7 @@ module Apipie
           return self.send(key) if self.respond_to?(key.to_s)
         end
 
-        def initialize(expected_type, enum_values=nil, sub_properties=nil)
+        def initialize(expected_type, enum_values = nil, sub_properties = nil)
           @expected_type = expected_type
           @enum_values = enum_values
           @is_enum = !!enum_values
@@ -84,7 +84,7 @@ module Apipie
       #======================================================================
 
 
-      def initialize(name, expected_type, options={}, sub_properties=[])
+      def initialize(name, expected_type, options = {}, sub_properties = [])
         @name = name
         @required = true
         @required = false if options[:required] == false

data/lib/apipie/routing.rb

@@ -4,7 +4,7 @@ module Apipie
       def apipie(options = {})
         namespace "apipie", :path => Apipie.configuration.doc_base_url do
           get 'apipie_checksum', :to => "apipies#apipie_checksum", :format => "json"
-          constraints(:version => /[^\/]+/, :resource => /[^\/]+/, :method => /[^\/]+/) do
+          constraints(:version => %r{[^/]+}, :resource => %r{[^/]+}, :method => %r{[^/]+}) do
             get(options.reverse_merge("(:version)/(:resource)/(:method)" => "apipies#index", :as => :apipie))
           end
         end

data/lib/apipie/rspec/response_validation_helper.rb

@@ -112,7 +112,7 @@ class ActionController::Base
 end
 
 module Apipie
-  def self.print_validation_errors(validation_errors, schema, response, error_object=nil)
+  def self.print_validation_errors(validation_errors, schema, response, error_object = nil)
     Rails.logger.warn(validation_errors.to_s)
     if Rails.env.test?
       puts "schema validation errors:"