class WashoutBuilder::Document::Generator

class that is used to generate HTML documentation for a soap service

Attributes

config[RW]

class that is used to generate HTML documentation for a soap service

@!attribute soap_actions

@return [Hash] Hash that contains all the actions to which the web service responds to and information about them

@!attribute config

@return [WashOut::SoapConfig] holds the soap configuration for the soap service

@!attribute controller_name

@return [String] The name of the controller that acts like a soap service
controller_name[RW]

class that is used to generate HTML documentation for a soap service

@!attribute soap_actions

@return [Hash] Hash that contains all the actions to which the web service responds to and information about them

@!attribute config

@return [WashOut::SoapConfig] holds the soap configuration for the soap service

@!attribute controller_name

@return [String] The name of the controller that acts like a soap service
route_details[RW]

class that is used to generate HTML documentation for a soap service

@!attribute soap_actions

@return [Hash] Hash that contains all the actions to which the web service responds to and information about them

@!attribute config

@return [WashOut::SoapConfig] holds the soap configuration for the soap service

@!attribute controller_name

@return [String] The name of the controller that acts like a soap service
soap_actions[RW]

class that is used to generate HTML documentation for a soap service

@!attribute soap_actions

@return [Hash] Hash that contains all the actions to which the web service responds to and information about them

@!attribute config

@return [WashOut::SoapConfig] holds the soap configuration for the soap service

@!attribute controller_name

@return [String] The name of the controller that acts like a soap service

Public Class Methods

new(route_details, controller) click to toggle source

Method used to initialize the instance of object @see controller_class

@param [String] controller The name of the controller that acts like a soap service @return [void] @api public

# File lib/washout_builder/document/generator.rb, line 24
def initialize(route_details, controller)
  self.route_details = route_details
  controller_class_name = controller_class(controller)
  self.config = controller_class_name.soap_config
  self.soap_actions = controller_class_name.soap_actions
  self.controller_name = controller
end

Public Instance Methods

actions_with_exceptions() click to toggle source

Returns an array with all the operations that can raise an exception at least or more

@return [Array<String>] Returns an array with all the names of all operations that can raise an exception or more @api public

# File lib/washout_builder/document/generator.rb, line 178
def actions_with_exceptions
  soap_actions.select { |_operation, formats| !formats[:raises].blank? }
end
all_soap_action_names() click to toggle source

Returns the names of all operations sorted alphabetically

@return [Array<String>] An array with all the names of all operations sorted alphabetically @api public

# File lib/washout_builder/document/generator.rb, line 157
def all_soap_action_names
  operations.map(&:to_s).sort_by(&:downcase).uniq unless soap_actions.blank?
end
argument_types(type) click to toggle source

Returns either the input arguments of a operation or the output types of that operation depending on the argument

@param [String] type The type of the arguments that need to be returned (“input” or anything else ) @return [Array<WashOutParam>, Array<Error>] If the argument is “input” will return the arguments of the operation , ottherwise the return type @api public

# File lib/washout_builder/document/generator.rb, line 124
def argument_types(type)
  format_type = (type == 'input') ? 'builder_in' : 'builder_out'
  types = []
  unless soap_actions.blank?
    soap_actions.each do |_operation, formats|
      (formats[format_type.to_sym] || []).each do |p|
        types << p
      end
    end
  end
  types
end
complex_types() click to toggle source

@return [Array<WashOut::Param>] Returns an array with all the complex types sorted alphabetically @api public

# File lib/washout_builder/document/generator.rb, line 166
def complex_types
  classes_defined = []
  (input_types + output_types).each do |p|
    classes_defined.concat(p.get_nested_complex_types(config, classes_defined))
  end
  sort_complex_types(classes_defined, 'class')
end
controller_class(controller) click to toggle source

Retrives the class of the controller by using its name

@param [String] controller The name of the controller @return [Class] Returns the class of the controller @api public

# File lib/washout_builder/document/generator.rb, line 49
def controller_class(controller)
  "#{controller}_controller".camelize.constantize
end
controller_route_helpers() click to toggle source
# File lib/washout_builder/document/generator.rb, line 32
def controller_route_helpers
  route_details[:route_set].url_helpers
end
endpoint() click to toggle source

Retrieves the endpoint of the soap service based on its namespace @see namespace

@return [String] Returns the current soap service's endpoint based on its namespace @api public

# File lib/washout_builder/document/generator.rb, line 58
def endpoint
  namespace.blank? ? nil : namespace.gsub('/wsdl', '/action')
end
exceptions_raised() click to toggle source

Returns all the exception raised by all operations @see actions_with_exceptions

@return [Array<Class>] Returns an array with all the exception classes that are raised by all operations @api public

# File lib/washout_builder/document/generator.rb, line 187
def exceptions_raised
  actions_with_exceptions.map { |_operation, formats| formats[:raises].is_a?(Array) ? formats[:raises] : [formats[:raises]] }.flatten
end
fault_types() click to toggle source

Returns all the exception classes raised by all operations sorted alphabetically @see WashoutBuilder::Type#all_fault_classes @see get_complex_fault_types @see sort_complex_types

@return [Array<Class>] Returns all the exception classes that can be raised by all operations with their ancestors also sorted alphabetically @api public

# File lib/washout_builder/document/generator.rb, line 221
def fault_types
  base_fault = [WashoutBuilder::Type.all_fault_classes.first]
  fault_types = get_complex_fault_types(base_fault)
  sort_complex_types(fault_types, 'fault')
end
filter_exceptions_raised() click to toggle source

Fiters the exceptions raised by checking if they classes inherit from WashOout::SoapError @see exceptions_raised @return [Array<Class>] returns the exceptions that are raised by all operations filtering only the ones that inherit from WashOut::SoapError @api public

# File lib/washout_builder/document/generator.rb, line 195
def filter_exceptions_raised
  exceptions_raised.select { |x| WashoutBuilder::Type.valid_fault_class?(x) } unless actions_with_exceptions.blank?
end
get_complex_fault_types(base_fault_array) click to toggle source

Retuens all the exception classes that can be raised by all operations with their ancestors also @see filter_exceptions_raised @see WashoutBuilder::Document::ExceptionModel#get_fault_class_ancestors

@param [Array<Class>] base_fault_array An array with the base exception classes from which we try to identify their ancestors @return [Array>Class>] Returns all the exception classes that can be raised by all operations with their ancestors also @api public

# File lib/washout_builder/document/generator.rb, line 206
def get_complex_fault_types(base_fault_array)
  fault_types = []
  classes_defined = filter_exceptions_raised
  classes_defined = classes_defined.blank? ? base_fault_array : classes_defined.concat(base_fault_array)
  classes_defined.each { |exception_class| exception_class.get_fault_class_ancestors(fault_types, true) } unless classes_defined.blank?
  fault_types
end
input_types() click to toggle source

Returns the arguments of all operations @see argument_types @return [Array<WashOut::Param>] An array with all the arguments types of all operations the service responds to @api public

# File lib/washout_builder/document/generator.rb, line 141
def input_types
  argument_types('input')
end
namespace() click to toggle source

Returns the namespace used for the controller by using the soap configuration of the controller

@return [String] description of returned object @api public

# File lib/washout_builder/document/generator.rb, line 40
def namespace
  controller_route_helpers.url_for(controller: controller_name, action: "_generate_wsdl", only_path: true)
end
operation_exceptions(operation_name) click to toggle source

Returns the exceptions that a specific operation can raise

@param [String] operation_name describe operation_name @return [Array<Class>] returns an array with all the exception classes that the operation send as argument can raise @api public

# File lib/washout_builder/document/generator.rb, line 99
def operation_exceptions(operation_name)
  hash_object = soap_actions.find { |operation, _formats| operation.to_s.downcase == operation_name.to_s.downcase }
  return if hash_object.blank?
  faults = hash_object[1][:raises]
  faults = faults.is_a?(Array) ? faults : [faults]
  faults.select { |x| WashoutBuilder::Type.valid_fault_class?(x) }
end
operations() click to toggle source
returns a collection of all operation that the service responds to

@return [Array<String>] returns a collection of all operation that the service responds to @api public

# File lib/washout_builder/document/generator.rb, line 82
def operations
  soap_actions.map { |operation, _formats| operation }
end
output_types() click to toggle source

Returns the arguments of all operations @see argument_types @return [Array<Error>] An array with all the exceptions that all operations can raise @api public

# File lib/washout_builder/document/generator.rb, line 149
def output_types
  argument_types('output')
end
service() click to toggle source

Returns the service name using camelcase letter

@return [String] Returns the service name using camelcase letter @api public

# File lib/washout_builder/document/generator.rb, line 66
def service
  controller_name.blank? ? nil : controller_name.camelize
end
service_description() click to toggle source

Returns the service description if the service can respond to description method

@return [String] Returns the service description if the service can respond to description method @api public

# File lib/washout_builder/document/generator.rb, line 74
def service_description
  config.respond_to?(:description) ? config.description : nil
end
sort_complex_types(types, type) click to toggle source

Sorts a hash by a key alphabetically

@param [Hash] types Any kind of hash

@option types [String, Symbol] :type The name of the key should be the same as the second argument

@param [String, Symbol] type The key that is used for sorting alphabetically @return [Hash] options Same hash sorted alphabetically by the specified key and without duplicates

@option options [String, Symbol] :type The name of the key should be the same as the second argument

@api public

# File lib/washout_builder/document/generator.rb, line 115
def sort_complex_types(types, type)
  types.sort_by { |hash| hash[type.to_sym].to_s.downcase }.uniq { |hash| hash[type.to_sym] } unless types.blank?
end
sorted_operations() click to toggle source

returns the operations of a service by sorting them alphabetically and removes duplicates

@return [Array<String>] returns a collection of all operation that the service responds to sorted alphabetically @api public

# File lib/washout_builder/document/generator.rb, line 90
def sorted_operations
  soap_actions.sort_by { |operation, _formats| operation.downcase }.uniq unless soap_actions.blank?
end