#
# CatalogRuleService
#
# This class provides a facade for SOAP method calls to the
# ZXTM Virtual Server web service.
#
class CatalogRuleService
  
  attr_accessor :driver
  
  def initialize(endpoint=nil, username=nil, password=nil)
    @driver = CatalogRulePort.new(endpoint)
    @driver.options["protocol.http.ssl_config.verify_mode"] = OpenSSL::SSL::VERIFY_NONE
    @driver.options["protocol.http.basic_auth"] << [endpoint, username, password]
  end

  # Creates a new rule
  #
  # Args
  #   name (String)   - Rule name
  #   text (String)   - Rule text
  #
  # Examples
  #   create("route-traffic", ["text_of_rule"])  - Creates new rule called "route-traffic" with text of rule as supplied.
  #  
  def create(name, text)
    @driver.addRule([name], [text])
  end

  # List rules by name
  #
  # Args
  #   None
  #
  # Examples
  #   list - Returns a list of rule names
  #  
  def list
    @driver.getRuleNames
  end

  # Checks whether the text of a rule is valid TrafficScript
  #
  # Args
  #   text (String)   - Rule text
  #
  # Returns
  #   valid (boolean)  - True if valid
  #
  # Examples
  #   valid?("text_of_rule")  - Calls a check on the rule, returns boolean
  #  
  def valid?(text)
    res = @driver.checkSyntax([text])
    return res.first.valid
  end

  # Returns a list of errors for the rule
  #
  # Args
  #   text (String)   - Rule text
  #
  # Returns
  #   errors (Array)  - Array of errors
  #
  # Examples
  #   errors("text_of_rule")
  #    
  def errors(text)
    res = @driver.checkSyntax([text])
    return res.first.errors
  end

  # Returns a list of warnings for the rule
  #
  # Args
  #   text (String)   - Rule text
  #
  # Returns
  #   warnings (Array)  - Array of errors
  #
  # Examples
  #   warnings("text_of_rule")
  #    
  def warnings(text)
    res = @driver.checkSyntax([text])
    return res.first.warnings
  end

  # Copies a rule
  #
  # Args
  #   name (String)       - Name of current rule
  #   new_name (String)   - Name of new rule
  #
  # Examples
  #   copy(name, new_name)  - Copies rule called "name" to a new rule, called "new_name"
  #  
  def copy(name, new_name)
    @driver.copyRule([name], [new_name])
  end

  # Deletes a rule
  #
  # Args
  #   name (String)       - Name of rule
  #
  # Examples
  #   delete(name)        - Deletes rule called "name"
  #  
  def delete(name)
    @driver.deleteRule([name])
  end

  # Fetches details about a rule
  #
  # Args
  #   name (String)       - Name of rule
  #
  # Returns
  #
  # Examples
  #   details(name)        - returns CatalogRuleRuleInfo object for rule
  #  
  def details(name)
    @driver.getRuleDetails([name]).first
  end

  # Renames a rule
  #
  #   name (String)       - Name of current rule
  #   new_name (String)   - Name of new rule
  #
  # Examples
  #   rename(name, new_name)  - Copies rule called "name" to a new rule, called "new_name"
  def rename(name, new_name)
    @driver.renameRule([name], [new_name])
  end

  # Sets or returns the note for a rule
  #
  #   name (String)       - Name of rule
  #   note (String)       - Text of note
  #
  # Examples
  #   note(name, note)  - Sets the note for a rule called "name"
  #   note(name) - Returns the note for the rule "name"
  def note(name, note=nil)
    if note.nil?
      details(name).rule_notes
    else
      @driver.setRuleNotes([name], [note])
    end

  end

  # Sets or returns the text for a rule
  #
  #   name (String)       - Name of rule
  #   text (String)       - Text of rule
  #
  # Examples
  #   text(name, text)  - Sets the text for a rule called "name"
  #   text(name) - Returns the text for the rule "name"
  def text(name, text=nil)
    if text.nil?
      details(name).rule_text
    else
      @driver.setRuleText([name], [text])
    end
  end

end