apipie-rails 0.9.4 → 1.0.0

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/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
@@ -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

@@ -65,7 +65,7 @@ module Apipie
     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