zeus-api 0.1.0

data/lib/api/pool/PoolMappingRegistry.rb

@@ -0,0 +1,134 @@
+
+require 'rubygems'
+gem 'soap4r'
+
+require 'soap/mapping'
+
+module PoolMappingRegistry
+  EncodedRegistry = ::SOAP::Mapping::EncodedRegistry.new
+  LiteralRegistry = ::SOAP::Mapping::LiteralRegistry.new
+  NsC_10 = "http://soap.zeus.com/zxtm/1.0/"
+
+  EncodedRegistry.set(
+    PoolLoadBalancingAlgorithmArray,
+    ::SOAP::SOAPArray,
+    ::SOAP::Mapping::EncodedRegistry::TypedArrayFactory,
+    { :type => XSD::QName.new("http://soap.zeus.com/zxtm/1.0/", "Pool.LoadBalancingAlgorithm") }
+  )
+
+  EncodedRegistry.register(
+    :class => PoolPriorityValueDefinition,
+    :schema_type => XSD::QName.new(NsC_10, "Pool.PriorityValueDefinition"),
+    :schema_element => [
+      ["node", ["SOAP::SOAPString", XSD::QName.new(nil, "node")]],
+      ["priority", ["SOAP::SOAPInt", XSD::QName.new(nil, "priority")]]
+    ]
+  )
+
+  EncodedRegistry.set(
+    PoolPriorityValueDefinitionArray,
+    ::SOAP::SOAPArray,
+    ::SOAP::Mapping::EncodedRegistry::TypedArrayFactory,
+    { :type => XSD::QName.new(NsC_10, "Pool.PriorityValueDefinition") }
+  )
+
+  EncodedRegistry.set(
+    PoolPriorityValueDefinitionArrayArray,
+    ::SOAP::SOAPArray,
+    ::SOAP::Mapping::EncodedRegistry::TypedArrayFactory,
+    { :type => XSD::QName.new(NsC_10, "Pool.PriorityValueDefinitionArray") }
+  )
+
+  EncodedRegistry.register(
+    :class => PoolWeightingsDefinition,
+    :schema_type => XSD::QName.new(NsC_10, "Pool.WeightingsDefinition"),
+    :schema_element => [
+      ["node", ["SOAP::SOAPString", XSD::QName.new(nil, "node")]],
+      ["weighting", ["SOAP::SOAPInt", XSD::QName.new(nil, "weighting")]]
+    ]
+  )
+
+  EncodedRegistry.set(
+    PoolWeightingsDefinitionArray,
+    ::SOAP::SOAPArray,
+    ::SOAP::Mapping::EncodedRegistry::TypedArrayFactory,
+    { :type => XSD::QName.new(NsC_10, "Pool.WeightingsDefinition") }
+  )
+
+  EncodedRegistry.set(
+    PoolWeightingsDefinitionArrayArray,
+    ::SOAP::SOAPArray,
+    ::SOAP::Mapping::EncodedRegistry::TypedArrayFactory,
+    { :type => XSD::QName.new(NsC_10, "Pool.WeightingsDefinitionArray") }
+  )
+
+  EncodedRegistry.set(
+    StringArray,
+    ::SOAP::SOAPArray,
+    ::SOAP::Mapping::EncodedRegistry::TypedArrayFactory,
+    { :type => XSD::QName.new("http://www.w3.org/2001/XMLSchema", "string") }
+  )
+
+  EncodedRegistry.set(
+    StringArrayArray,
+    ::SOAP::SOAPArray,
+    ::SOAP::Mapping::EncodedRegistry::TypedArrayFactory,
+    { :type => XSD::QName.new(NsC_10, "StringArray") }
+  )
+
+  EncodedRegistry.set(
+    BooleanArray,
+    ::SOAP::SOAPArray,
+    ::SOAP::Mapping::EncodedRegistry::TypedArrayFactory,
+    { :type => XSD::QName.new("http://www.w3.org/2001/XMLSchema", "boolean") }
+  )
+
+  EncodedRegistry.set(
+    BooleanArrayArray,
+    ::SOAP::SOAPArray,
+    ::SOAP::Mapping::EncodedRegistry::TypedArrayFactory,
+    { :type => XSD::QName.new(NsC_10, "booleanArray") }
+  )
+
+  EncodedRegistry.set(
+    IntArray,
+    ::SOAP::SOAPArray,
+    ::SOAP::Mapping::EncodedRegistry::TypedArrayFactory,
+    { :type => XSD::QName.new("http://www.w3.org/2001/XMLSchema", "int") }
+  )
+
+  EncodedRegistry.set(
+    UnsignedIntArray,
+    ::SOAP::SOAPArray,
+    ::SOAP::Mapping::EncodedRegistry::TypedArrayFactory,
+    { :type => XSD::QName.new("http://www.w3.org/2001/XMLSchema", "unsignedInt") }
+  )
+
+  EncodedRegistry.register(
+    :class => PoolLoadBalancingAlgorithm,
+    :schema_type => XSD::QName.new(NsC_10, "Pool.LoadBalancingAlgorithm")
+  )
+
+  LiteralRegistry.register(
+    :class => PoolPriorityValueDefinition,
+    :schema_type => XSD::QName.new(NsC_10, "Pool.PriorityValueDefinition"),
+    :schema_element => [
+      ["node", ["SOAP::SOAPString", XSD::QName.new(nil, "node")]],
+      ["priority", ["SOAP::SOAPInt", XSD::QName.new(nil, "priority")]]
+    ]
+  )
+
+  LiteralRegistry.register(
+    :class => PoolWeightingsDefinition,
+    :schema_type => XSD::QName.new(NsC_10, "Pool.WeightingsDefinition"),
+    :schema_element => [
+      ["node", ["SOAP::SOAPString", XSD::QName.new(nil, "node")]],
+      ["weighting", ["SOAP::SOAPInt", XSD::QName.new(nil, "weighting")]]
+    ]
+  )
+
+  LiteralRegistry.register(
+    :class => PoolLoadBalancingAlgorithm,
+    :schema_type => XSD::QName.new(NsC_10, "Pool.LoadBalancingAlgorithm")
+  )
+end

data/lib/api/pool/PoolService.rb

@@ -0,0 +1,245 @@
+
+#
+# PoolService
+#
+# This class provides a facade for SOAP method calls to the
+# ZXTM Pool web service.
+class PoolService
+  
+  attr_accessor :driver
+  
+  def initialize(endpoint=nil, username=nil, password=nil)
+    @driver = PoolPort.new(endpoint)
+    @driver.options["protocol.http.ssl_config.verify_mode"] = OpenSSL::SSL::VERIFY_NONE
+    @driver.options["protocol.http.basic_auth"] << [endpoint, username, password]
+  end
+
+  # Returns a list of pool names
+  #
+  # Args
+  #   N/A
+  #
+  # Examples
+  #   list()   - Returns all pool names
+  #
+  def list()
+    result = []
+    pools = @driver.getPoolNames
+    pools.length.times do |i|
+      result << pools[i]
+    end
+    return result
+  end
+
+  # Creates new pool
+  #
+  # Args
+  #   name (String)          - Pool's name
+  #   vs_info (Array)        - Pool's nodes
+  #
+  # Examples
+  #   create("web-pool", ["10.0.0.2", "10.0.0.3"])  - Creates new pool called "web-pool" with 2 nodes
+  #
+  def create(name=nil, nodes=[])
+    @driver.addPool([name], [nodes])
+  end
+  
+  # Copies a pool
+  #
+  # Args
+  #   name (String)       - Name of current pool
+  #   new_name (String)   - Name of new pool
+  #
+  # Examples
+  #   copy(name, new_name)  - Copies pool called "name" to a new pool, called "new_name"
+  #  
+  def copy(name, new_name)
+    @driver.copyPool([name], [new_name])
+  end
+
+  # Renames a pool
+  #
+  # Args
+  #   name (String)       - Current name of pool
+  #   new_name (String)   - New name of pool
+  #
+  # Examples
+  #   rename(name, new_name)  - Renames pool "name" to "new_name"
+  #  
+  def rename(name, new_name)
+    @driver.renamePool([name], [new_name])
+  end
+
+  # Deletes a pool
+  #
+  # Args
+  #   name (String)       - Name of pool
+  #
+  # Examples
+  #   delete(name)        - Deletes pool called "name"
+  #  
+  def delete(name)
+    @driver.deletePool([name])
+  end
+    
+  # Sets or return failure pool for pool
+  #
+  # Args
+  #   name (String)     - Pool name
+  #   nodes (Array)     - Nodes (["host1:port", "host2:port"])
+  #
+  # Examples
+  #   failure_pool("test", "failure_pool")
+  #   failure_pool("test") - Returns 
+  #    
+  def failure_pool(name, failure_name=nil)
+    if failure_name.nil?
+      @driver.getFailurePool([name])
+    else
+      @driver.setFailurePool([name],[failure_name])
+    end
+  end
+
+  
+  # Returns a list of nodes within a pool
+  #
+  # Args
+  #   name (String)     - Pool name
+  #
+  # Examples
+  #   list_nodes(name)   - Returns nodes for pool "name"
+  #
+  def list_nodes(name, status=nil)
+    result = []
+    valid_status = [:all, :draining]
+    status = :all if status.nil? or !valid_status.include?(status)
+    
+    case status
+    when :all
+      result = @driver.getNodes([name])
+    when :draining
+      result = @driver.getDrainingNodes([name])
+    end
+
+    return result
+    
+  end
+  
+  # Adds a node to a pool
+  #
+  # Args
+  #   name (String)     - Pool name
+  #   node (String)     - Node ("host:port")
+  #
+  # Examples
+  #   add_node("pool", "host:80") - Returns nodes for pool "name"
+  #
+  def add_node(name, node)
+    @driver.addNodes([name], [[node]])
+  end
+
+  # Adds nodes to a pool
+  #
+  # Args
+  #   name (String)     - Pool name
+  #   nodes (Array)     - Nodes (["host1:port", "host2:port"])
+  #
+  # Examples
+  #   add_nodes("pool",["host1:80", "host2:80"])
+  #  
+  def add_nodes(name, nodes)
+    @driver.addNodes([name], [nodes])
+  end
+
+  # Removes a node from a pool
+  #
+  # Args
+  #   name (String)     - Pool name
+  #   node (String)     - Node ("host:port")
+  #
+  # Examples
+  #   remove_node("pool", "host:80")
+  #
+  def remove_node(name, node)
+    @driver.removeNodes([name], [[node]])
+  end
+
+  # Removes nodes to a pool
+  #
+  # Args
+  #   name (String)     - Pool name
+  #   nodes (Array)     - Nodes (["host1:port", "host2:port"])
+  #
+  # Examples
+  #   remove_nodes("pool",["host1:80", "host2:80"])
+  #  
+  def remove_nodes(name, nodes)
+    @driver.removeNodes([name], [nodes])
+  end
+
+  # Mark a node as draining
+  #
+  # Args
+  #   name (String)     - Pool name
+  #   node (String)     - Node ("host:port")
+  #
+  # Examples
+  #   add_draining_node("pool", "host:80")
+  #
+  def drain_node(name, node)
+    @driver.addDrainingNodes([name], [[node]])
+  end
+
+  # Mark nodes as draining
+  #
+  # Args
+  #   name (String)     - Pool name
+  #   nodes (Array)     - Nodes (["host1:port", "host2:port"])
+  #
+  # Examples
+  #   add_draining_nodes("pool",["host1:80", "host2:80"])
+  #  
+  def drain_nodes(name, nodes)
+    @driver.addDrainingNodes([name], [nodes])
+  end
+
+  # Mark a draining node as active
+  #
+  # Args
+  #   name (String)     - Pool name
+  #   node (String)     - Node ("host:port")
+  #
+  # Examples
+  #   remove_draining_node("pool", "host:80")
+  #
+  def undrain_node(name, node)
+    @driver.removeDrainingNodes([name], [[node]])
+  end
+
+  # Mark draining nodes as active
+  #
+  # Args
+  #   name (String)     - Pool name
+  #   nodes (Array)     - Nodes (["host1:port", "host2:port"])
+  #
+  # Examples
+  #   remove_draining_nodes("pool",["host1:80", "host2:80"])
+  #  
+  def undrain_nodes(name, nodes)
+    @driver.removeDrainingNodes([name], [nodes])
+  end
+  
+  # Return current connection count for node
+  #
+  # Args
+  #   name (String)     - Pool name
+  #   nodes (Array)     - Nodes (["host1:port", "host2:port"])
+  #
+  # Examples
+  #   remove_draining_nodes("pool",["host1:80", "host2:80"])
+  #    
+  def connection_count(node)
+    @driver.getNodesConnectionCounts([node])
+  end
+
+end

data/lib/api/virtualserver/VirtualServer.rb

@@ -0,0 +1,255 @@
+require 'xsd/qname'
+
+# {http://soap.zeus.com/zxtm/1.0/}VirtualServer.BasicInfo
+#   port - SOAP::SOAPInt
+#   protocol - VirtualServerProtocol
+#   default_pool - SOAP::SOAPString
+class VirtualServerBasicInfo
+  attr_accessor :port
+  attr_accessor :protocol
+  attr_accessor :default_pool
+
+  def initialize(port = nil, protocol = nil, default_pool = nil)
+    @port = port
+    @protocol = protocol
+    @default_pool = default_pool
+  end
+end
+
+# {http://soap.zeus.com/zxtm/1.0/}VirtualServer.FTPPortRange
+#   low - SOAP::SOAPInt
+#   high - SOAP::SOAPInt
+class VirtualServerFTPPortRange
+  attr_accessor :low
+  attr_accessor :high
+
+  def initialize(low = nil, high = nil)
+    @low = low
+    @high = high
+  end
+end
+
+# {http://soap.zeus.com/zxtm/1.0/}VirtualServer.PortRange
+#   low - SOAP::SOAPInt
+#   high - SOAP::SOAPInt
+class VirtualServerPortRange
+  attr_accessor :low
+  attr_accessor :high
+
+  def initialize(low = nil, high = nil)
+    @low = low
+    @high = high
+  end
+end
+
+# {http://soap.zeus.com/zxtm/1.0/}VirtualServer.RegexReplacement
+#   regex - SOAP::SOAPString
+#   replacement - SOAP::SOAPString
+class VirtualServerRegexReplacement
+  attr_accessor :regex
+  attr_accessor :replacement
+
+  def initialize(regex = nil, replacement = nil)
+    @regex = regex
+    @replacement = replacement
+  end
+end
+
+# {http://soap.zeus.com/zxtm/1.0/}VirtualServer.Rule
+#   name - SOAP::SOAPString
+#   enabled - SOAP::SOAPBoolean
+#   run_frequency - VirtualServerRuleRunFlag
+class VirtualServerRule
+  attr_accessor :name
+  attr_accessor :enabled
+  attr_accessor :run_frequency
+
+  def initialize(name = nil, enabled = nil, run_frequency = nil)
+    @name = name
+    @enabled = enabled
+    @run_frequency = run_frequency
+  end
+end
+
+# {http://soap.zeus.com/zxtm/1.0/}VirtualServer.SSLSite
+#   dest_address - SOAP::SOAPString
+#   certificate - SOAP::SOAPString
+class VirtualServerSSLSite
+  attr_accessor :dest_address
+  attr_accessor :certificate
+
+  def initialize(dest_address = nil, certificate = nil)
+    @dest_address = dest_address
+    @certificate = certificate
+  end
+end
+
+# {http://soap.zeus.com/zxtm/1.0/}StringArray
+class StringArray < ::Array
+end
+
+# {http://soap.zeus.com/zxtm/1.0/}StringArrayArray
+class StringArrayArray < ::Array
+end
+
+# {http://soap.zeus.com/zxtm/1.0/}VirtualServer.BasicInfoArray
+class VirtualServerBasicInfoArray < ::Array
+end
+
+# {http://soap.zeus.com/zxtm/1.0/}VirtualServer.CookieDomainRewriteModeArray
+class VirtualServerCookieDomainRewriteModeArray < ::Array
+end
+
+# {http://soap.zeus.com/zxtm/1.0/}VirtualServer.CookieSecureFlagRewriteModeArray
+class VirtualServerCookieSecureFlagRewriteModeArray < ::Array
+end
+
+# {http://soap.zeus.com/zxtm/1.0/}VirtualServer.FTPPortRangeArray
+class VirtualServerFTPPortRangeArray < ::Array
+end
+
+# {http://soap.zeus.com/zxtm/1.0/}VirtualServer.LocationDefaultRewriteModeArray
+class VirtualServerLocationDefaultRewriteModeArray < ::Array
+end
+
+# {http://soap.zeus.com/zxtm/1.0/}VirtualServer.PortRangeArray
+class VirtualServerPortRangeArray < ::Array
+end
+
+# {http://soap.zeus.com/zxtm/1.0/}VirtualServer.ProtocolArray
+class VirtualServerProtocolArray < ::Array
+end
+
+# {http://soap.zeus.com/zxtm/1.0/}VirtualServer.RegexReplacementArray
+class VirtualServerRegexReplacementArray < ::Array
+end
+
+# {http://soap.zeus.com/zxtm/1.0/}VirtualServer.RuleArray
+class VirtualServerRuleArray < ::Array
+end
+
+# {http://soap.zeus.com/zxtm/1.0/}VirtualServer.RuleArrayArray
+class VirtualServerRuleArrayArray < ::Array
+end
+
+# {http://soap.zeus.com/zxtm/1.0/}VirtualServer.SIPDangerousRequestModeArray
+class VirtualServerSIPDangerousRequestModeArray < ::Array
+end
+
+# {http://soap.zeus.com/zxtm/1.0/}VirtualServer.SIPModeArray
+class VirtualServerSIPModeArray < ::Array
+end
+
+# {http://soap.zeus.com/zxtm/1.0/}VirtualServer.SSLClientCertificateHeadersArray
+class VirtualServerSSLClientCertificateHeadersArray < ::Array
+end
+
+# {http://soap.zeus.com/zxtm/1.0/}VirtualServer.SSLRequestClientCertModeArray
+class VirtualServerSSLRequestClientCertModeArray < ::Array
+end
+
+# {http://soap.zeus.com/zxtm/1.0/}VirtualServer.SSLSiteArray
+class VirtualServerSSLSiteArray < ::Array
+end
+
+# {http://soap.zeus.com/zxtm/1.0/}VirtualServer.SSLSiteArrayArray
+class VirtualServerSSLSiteArrayArray < ::Array
+end
+
+# {http://soap.zeus.com/zxtm/1.0/}booleanArray
+class BooleanArray < ::Array
+end
+
+# {http://soap.zeus.com/zxtm/1.0/}booleanArrayArray
+class BooleanArrayArray < ::Array
+end
+
+# {http://soap.zeus.com/zxtm/1.0/}intArray
+class IntArray < ::Array
+end
+
+# {http://soap.zeus.com/zxtm/1.0/}unsignedIntArray
+class UnsignedIntArray < ::Array
+end
+
+# {http://soap.zeus.com/zxtm/1.0/}VirtualServer.CookieDomainRewriteMode
+class VirtualServerCookieDomainRewriteMode < ::String
+  No_rewrite = VirtualServerCookieDomainRewriteMode.new("no_rewrite")
+  Set_to_named = VirtualServerCookieDomainRewriteMode.new("set_to_named")
+  Set_to_request = VirtualServerCookieDomainRewriteMode.new("set_to_request")
+end
+
+# {http://soap.zeus.com/zxtm/1.0/}VirtualServer.CookieSecureFlagRewriteMode
+class VirtualServerCookieSecureFlagRewriteMode < ::String
+  No_modify = VirtualServerCookieSecureFlagRewriteMode.new("no_modify")
+  Set_secure = VirtualServerCookieSecureFlagRewriteMode.new("set_secure")
+  Unset_secure = VirtualServerCookieSecureFlagRewriteMode.new("unset_secure")
+end
+
+# {http://soap.zeus.com/zxtm/1.0/}VirtualServer.LocationDefaultRewriteMode
+class VirtualServerLocationDefaultRewriteMode < ::String
+  Always = VirtualServerLocationDefaultRewriteMode.new("always")
+  If_host_matches = VirtualServerLocationDefaultRewriteMode.new("if_host_matches")
+  Never = VirtualServerLocationDefaultRewriteMode.new("never")
+end
+
+# {http://soap.zeus.com/zxtm/1.0/}VirtualServer.Protocol
+class VirtualServerProtocol < ::String
+  Client_first = VirtualServerProtocol.new("client_first")
+  Dns = VirtualServerProtocol.new("dns")
+  DnsTcp = VirtualServerProtocol.new("dns-tcp")
+  Ftp = VirtualServerProtocol.new("ftp")
+  Http = VirtualServerProtocol.new("http")
+  Https = VirtualServerProtocol.new("https")
+  Imaps = VirtualServerProtocol.new("imaps")
+  Imapv2 = VirtualServerProtocol.new("imapv2")
+  Imapv3 = VirtualServerProtocol.new("imapv3")
+  Imapv4 = VirtualServerProtocol.new("imapv4")
+  Ldap = VirtualServerProtocol.new("ldap")
+  Ldaps = VirtualServerProtocol.new("ldaps")
+  Pop3 = VirtualServerProtocol.new("pop3")
+  Pop3s = VirtualServerProtocol.new("pop3s")
+  Rtsp = VirtualServerProtocol.new("rtsp")
+  Server_first = VirtualServerProtocol.new("server_first")
+  Siptcp = VirtualServerProtocol.new("siptcp")
+  Sipudp = VirtualServerProtocol.new("sipudp")
+  Smtp = VirtualServerProtocol.new("smtp")
+  Ssl = VirtualServerProtocol.new("ssl")
+  Telnet = VirtualServerProtocol.new("telnet")
+  Udp = VirtualServerProtocol.new("udp")
+  Udpstreaming = VirtualServerProtocol.new("udpstreaming")
+end
+
+# {http://soap.zeus.com/zxtm/1.0/}VirtualServer.RuleRunFlag
+class VirtualServerRuleRunFlag < ::String
+  Only_first = VirtualServerRuleRunFlag.new("only_first")
+  Run_every = VirtualServerRuleRunFlag.new("run_every")
+end
+
+# {http://soap.zeus.com/zxtm/1.0/}VirtualServer.SIPDangerousRequestMode
+class VirtualServerSIPDangerousRequestMode < ::String
+  Forbid = VirtualServerSIPDangerousRequestMode.new("forbid")
+  Forward = VirtualServerSIPDangerousRequestMode.new("forward")
+  Node = VirtualServerSIPDangerousRequestMode.new("node")
+end
+
+# {http://soap.zeus.com/zxtm/1.0/}VirtualServer.SIPMode
+class VirtualServerSIPMode < ::String
+  Fullgw = VirtualServerSIPMode.new("fullgw")
+  Route = VirtualServerSIPMode.new("route")
+  Sipgw = VirtualServerSIPMode.new("sipgw")
+end
+
+# {http://soap.zeus.com/zxtm/1.0/}VirtualServer.SSLClientCertificateHeaders
+class VirtualServerSSLClientCertificateHeaders < ::String
+  All = VirtualServerSSLClientCertificateHeaders.new("all")
+  None = VirtualServerSSLClientCertificateHeaders.new("none")
+  Simple = VirtualServerSSLClientCertificateHeaders.new("simple")
+end
+
+# {http://soap.zeus.com/zxtm/1.0/}VirtualServer.SSLRequestClientCertMode
+class VirtualServerSSLRequestClientCertMode < ::String
+  Dont_request = VirtualServerSSLRequestClientCertMode.new("dont_request")
+  Request = VirtualServerSSLRequestClientCertMode.new("request")
+  Require = VirtualServerSSLRequestClientCertMode.new("require")
+end