zeus-api 0.1.0

data/lib/api/virtualserver/VirtualServerMappingRegistry.rb

@@ -0,0 +1,367 @@
+
+require 'rubygems'
+gem 'soap4r'
+
+require 'soap/mapping'
+
+module VirtualServerMappingRegistry
+  EncodedRegistry = ::SOAP::Mapping::EncodedRegistry.new
+  LiteralRegistry = ::SOAP::Mapping::LiteralRegistry.new
+  NsC_10 = "http://soap.zeus.com/zxtm/1.0/"
+
+  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("http://soap.zeus.com/zxtm/1.0/", "StringArray") }
+  )
+
+  EncodedRegistry.register(
+    :class => VirtualServerBasicInfo,
+    :schema_type => XSD::QName.new(NsC_10, "VirtualServer.BasicInfo"),
+    :schema_element => [
+      ["port", ["SOAP::SOAPInt", XSD::QName.new(nil, "port")]],
+      ["protocol", ["VirtualServerProtocol", XSD::QName.new(nil, "protocol")]],
+      ["default_pool", ["SOAP::SOAPString", XSD::QName.new(nil, "default_pool")]]
+    ]
+  )
+
+  EncodedRegistry.set(
+    VirtualServerBasicInfoArray,
+    ::SOAP::SOAPArray,
+    ::SOAP::Mapping::EncodedRegistry::TypedArrayFactory,
+    { :type => XSD::QName.new(NsC_10, "VirtualServer.BasicInfo") }
+  )
+
+  EncodedRegistry.set(
+    VirtualServerCookieDomainRewriteModeArray,
+    ::SOAP::SOAPArray,
+    ::SOAP::Mapping::EncodedRegistry::TypedArrayFactory,
+    { :type => XSD::QName.new(NsC_10, "VirtualServer.CookieDomainRewriteMode") }
+  )
+
+  EncodedRegistry.set(
+    VirtualServerCookieSecureFlagRewriteModeArray,
+    ::SOAP::SOAPArray,
+    ::SOAP::Mapping::EncodedRegistry::TypedArrayFactory,
+    { :type => XSD::QName.new(NsC_10, "VirtualServer.CookieSecureFlagRewriteMode") }
+  )
+
+  EncodedRegistry.register(
+    :class => VirtualServerFTPPortRange,
+    :schema_type => XSD::QName.new(NsC_10, "VirtualServer.FTPPortRange"),
+    :schema_element => [
+      ["low", ["SOAP::SOAPInt", XSD::QName.new(nil, "low")]],
+      ["high", ["SOAP::SOAPInt", XSD::QName.new(nil, "high")]]
+    ]
+  )
+
+  EncodedRegistry.set(
+    VirtualServerFTPPortRangeArray,
+    ::SOAP::SOAPArray,
+    ::SOAP::Mapping::EncodedRegistry::TypedArrayFactory,
+    { :type => XSD::QName.new(NsC_10, "VirtualServer.FTPPortRange") }
+  )
+
+  EncodedRegistry.set(
+    VirtualServerLocationDefaultRewriteModeArray,
+    ::SOAP::SOAPArray,
+    ::SOAP::Mapping::EncodedRegistry::TypedArrayFactory,
+    { :type => XSD::QName.new(NsC_10, "VirtualServer.LocationDefaultRewriteMode") }
+  )
+
+  EncodedRegistry.register(
+    :class => VirtualServerPortRange,
+    :schema_type => XSD::QName.new(NsC_10, "VirtualServer.PortRange"),
+    :schema_element => [
+      ["low", ["SOAP::SOAPInt", XSD::QName.new(nil, "low")]],
+      ["high", ["SOAP::SOAPInt", XSD::QName.new(nil, "high")]]
+    ]
+  )
+
+  EncodedRegistry.set(
+    VirtualServerPortRangeArray,
+    ::SOAP::SOAPArray,
+    ::SOAP::Mapping::EncodedRegistry::TypedArrayFactory,
+    { :type => XSD::QName.new(NsC_10, "VirtualServer.PortRange") }
+  )
+
+  EncodedRegistry.set(
+    VirtualServerProtocolArray,
+    ::SOAP::SOAPArray,
+    ::SOAP::Mapping::EncodedRegistry::TypedArrayFactory,
+    { :type => XSD::QName.new(NsC_10, "VirtualServer.Protocol") }
+  )
+
+  EncodedRegistry.register(
+    :class => VirtualServerRegexReplacement,
+    :schema_type => XSD::QName.new(NsC_10, "VirtualServer.RegexReplacement"),
+    :schema_element => [
+      ["regex", ["SOAP::SOAPString", XSD::QName.new(nil, "regex")]],
+      ["replacement", ["SOAP::SOAPString", XSD::QName.new(nil, "replacement")]]
+    ]
+  )
+
+  EncodedRegistry.set(
+    VirtualServerRegexReplacementArray,
+    ::SOAP::SOAPArray,
+    ::SOAP::Mapping::EncodedRegistry::TypedArrayFactory,
+    { :type => XSD::QName.new(NsC_10, "VirtualServer.RegexReplacement") }
+  )
+
+  EncodedRegistry.register(
+    :class => VirtualServerRule,
+    :schema_type => XSD::QName.new(NsC_10, "VirtualServer.Rule"),
+    :schema_element => [
+      ["name", ["SOAP::SOAPString", XSD::QName.new(nil, "name")]],
+      ["enabled", ["SOAP::SOAPBoolean", XSD::QName.new(nil, "enabled")]],
+      ["run_frequency", ["VirtualServerRuleRunFlag", XSD::QName.new(nil, "run_frequency")]]
+    ]
+  )
+
+  EncodedRegistry.set(
+    VirtualServerRuleArray,
+    ::SOAP::SOAPArray,
+    ::SOAP::Mapping::EncodedRegistry::TypedArrayFactory,
+    { :type => XSD::QName.new(NsC_10, "VirtualServer.Rule") }
+  )
+
+  EncodedRegistry.set(
+    VirtualServerRuleArrayArray,
+    ::SOAP::SOAPArray,
+    ::SOAP::Mapping::EncodedRegistry::TypedArrayFactory,
+    { :type => XSD::QName.new(NsC_10, "VirtualServer.RuleArray") }
+  )
+
+  EncodedRegistry.set(
+    VirtualServerSIPDangerousRequestModeArray,
+    ::SOAP::SOAPArray,
+    ::SOAP::Mapping::EncodedRegistry::TypedArrayFactory,
+    { :type => XSD::QName.new(NsC_10, "VirtualServer.SIPDangerousRequestMode") }
+  )
+
+  EncodedRegistry.set(
+    VirtualServerSIPModeArray,
+    ::SOAP::SOAPArray,
+    ::SOAP::Mapping::EncodedRegistry::TypedArrayFactory,
+    { :type => XSD::QName.new(NsC_10, "VirtualServer.SIPMode") }
+  )
+
+  EncodedRegistry.set(
+    VirtualServerSSLClientCertificateHeadersArray,
+    ::SOAP::SOAPArray,
+    ::SOAP::Mapping::EncodedRegistry::TypedArrayFactory,
+    { :type => XSD::QName.new(NsC_10, "VirtualServer.SSLClientCertificateHeaders") }
+  )
+
+  EncodedRegistry.set(
+    VirtualServerSSLRequestClientCertModeArray,
+    ::SOAP::SOAPArray,
+    ::SOAP::Mapping::EncodedRegistry::TypedArrayFactory,
+    { :type => XSD::QName.new(NsC_10, "VirtualServer.SSLRequestClientCertMode") }
+  )
+
+  EncodedRegistry.register(
+    :class => VirtualServerSSLSite,
+    :schema_type => XSD::QName.new(NsC_10, "VirtualServer.SSLSite"),
+    :schema_element => [
+      ["dest_address", ["SOAP::SOAPString", XSD::QName.new(nil, "dest_address")]],
+      ["certificate", ["SOAP::SOAPString", XSD::QName.new(nil, "certificate")]]
+    ]
+  )
+
+  EncodedRegistry.set(
+    VirtualServerSSLSiteArray,
+    ::SOAP::SOAPArray,
+    ::SOAP::Mapping::EncodedRegistry::TypedArrayFactory,
+    { :type => XSD::QName.new(NsC_10, "VirtualServer.SSLSite") }
+  )
+
+  EncodedRegistry.set(
+    VirtualServerSSLSiteArrayArray,
+    ::SOAP::SOAPArray,
+    ::SOAP::Mapping::EncodedRegistry::TypedArrayFactory,
+    { :type => XSD::QName.new(NsC_10, "VirtualServer.SSLSiteArray") }
+  )
+
+  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 => VirtualServerCookieDomainRewriteMode,
+    :schema_type => XSD::QName.new(NsC_10, "VirtualServer.CookieDomainRewriteMode")
+  )
+
+  EncodedRegistry.register(
+    :class => VirtualServerCookieSecureFlagRewriteMode,
+    :schema_type => XSD::QName.new(NsC_10, "VirtualServer.CookieSecureFlagRewriteMode")
+  )
+
+  EncodedRegistry.register(
+    :class => VirtualServerLocationDefaultRewriteMode,
+    :schema_type => XSD::QName.new(NsC_10, "VirtualServer.LocationDefaultRewriteMode")
+  )
+
+  EncodedRegistry.register(
+    :class => VirtualServerProtocol,
+    :schema_type => XSD::QName.new(NsC_10, "VirtualServer.Protocol")
+  )
+
+  EncodedRegistry.register(
+    :class => VirtualServerRuleRunFlag,
+    :schema_type => XSD::QName.new(NsC_10, "VirtualServer.RuleRunFlag")
+  )
+
+  EncodedRegistry.register(
+    :class => VirtualServerSIPDangerousRequestMode,
+    :schema_type => XSD::QName.new(NsC_10, "VirtualServer.SIPDangerousRequestMode")
+  )
+
+  EncodedRegistry.register(
+    :class => VirtualServerSIPMode,
+    :schema_type => XSD::QName.new(NsC_10, "VirtualServer.SIPMode")
+  )
+
+  EncodedRegistry.register(
+    :class => VirtualServerSSLClientCertificateHeaders,
+    :schema_type => XSD::QName.new(NsC_10, "VirtualServer.SSLClientCertificateHeaders")
+  )
+
+  EncodedRegistry.register(
+    :class => VirtualServerSSLRequestClientCertMode,
+    :schema_type => XSD::QName.new(NsC_10, "VirtualServer.SSLRequestClientCertMode")
+  )
+
+  LiteralRegistry.register(
+    :class => VirtualServerBasicInfo,
+    :schema_type => XSD::QName.new(NsC_10, "VirtualServer.BasicInfo"),
+    :schema_element => [
+      ["port", ["SOAP::SOAPInt", XSD::QName.new(nil, "port")]],
+      ["protocol", ["VirtualServerProtocol", XSD::QName.new(nil, "protocol")]],
+      ["default_pool", ["SOAP::SOAPString", XSD::QName.new(nil, "default_pool")]]
+    ]
+  )
+
+  LiteralRegistry.register(
+    :class => VirtualServerFTPPortRange,
+    :schema_type => XSD::QName.new(NsC_10, "VirtualServer.FTPPortRange"),
+    :schema_element => [
+      ["low", ["SOAP::SOAPInt", XSD::QName.new(nil, "low")]],
+      ["high", ["SOAP::SOAPInt", XSD::QName.new(nil, "high")]]
+    ]
+  )
+
+  LiteralRegistry.register(
+    :class => VirtualServerPortRange,
+    :schema_type => XSD::QName.new(NsC_10, "VirtualServer.PortRange"),
+    :schema_element => [
+      ["low", ["SOAP::SOAPInt", XSD::QName.new(nil, "low")]],
+      ["high", ["SOAP::SOAPInt", XSD::QName.new(nil, "high")]]
+    ]
+  )
+
+  LiteralRegistry.register(
+    :class => VirtualServerRegexReplacement,
+    :schema_type => XSD::QName.new(NsC_10, "VirtualServer.RegexReplacement"),
+    :schema_element => [
+      ["regex", ["SOAP::SOAPString", XSD::QName.new(nil, "regex")]],
+      ["replacement", ["SOAP::SOAPString", XSD::QName.new(nil, "replacement")]]
+    ]
+  )
+
+  LiteralRegistry.register(
+    :class => VirtualServerRule,
+    :schema_type => XSD::QName.new(NsC_10, "VirtualServer.Rule"),
+    :schema_element => [
+      ["name", ["SOAP::SOAPString", XSD::QName.new(nil, "name")]],
+      ["enabled", ["SOAP::SOAPBoolean", XSD::QName.new(nil, "enabled")]],
+      ["run_frequency", ["VirtualServerRuleRunFlag", XSD::QName.new(nil, "run_frequency")]]
+    ]
+  )
+
+  LiteralRegistry.register(
+    :class => VirtualServerSSLSite,
+    :schema_type => XSD::QName.new(NsC_10, "VirtualServer.SSLSite"),
+    :schema_element => [
+      ["dest_address", ["SOAP::SOAPString", XSD::QName.new(nil, "dest_address")]],
+      ["certificate", ["SOAP::SOAPString", XSD::QName.new(nil, "certificate")]]
+    ]
+  )
+
+  LiteralRegistry.register(
+    :class => VirtualServerCookieDomainRewriteMode,
+    :schema_type => XSD::QName.new(NsC_10, "VirtualServer.CookieDomainRewriteMode")
+  )
+
+  LiteralRegistry.register(
+    :class => VirtualServerCookieSecureFlagRewriteMode,
+    :schema_type => XSD::QName.new(NsC_10, "VirtualServer.CookieSecureFlagRewriteMode")
+  )
+
+  LiteralRegistry.register(
+    :class => VirtualServerLocationDefaultRewriteMode,
+    :schema_type => XSD::QName.new(NsC_10, "VirtualServer.LocationDefaultRewriteMode")
+  )
+
+  LiteralRegistry.register(
+    :class => VirtualServerProtocol,
+    :schema_type => XSD::QName.new(NsC_10, "VirtualServer.Protocol")
+  )
+
+  LiteralRegistry.register(
+    :class => VirtualServerRuleRunFlag,
+    :schema_type => XSD::QName.new(NsC_10, "VirtualServer.RuleRunFlag")
+  )
+
+  LiteralRegistry.register(
+    :class => VirtualServerSIPDangerousRequestMode,
+    :schema_type => XSD::QName.new(NsC_10, "VirtualServer.SIPDangerousRequestMode")
+  )
+
+  LiteralRegistry.register(
+    :class => VirtualServerSIPMode,
+    :schema_type => XSD::QName.new(NsC_10, "VirtualServer.SIPMode")
+  )
+
+  LiteralRegistry.register(
+    :class => VirtualServerSSLClientCertificateHeaders,
+    :schema_type => XSD::QName.new(NsC_10, "VirtualServer.SSLClientCertificateHeaders")
+  )
+
+  LiteralRegistry.register(
+    :class => VirtualServerSSLRequestClientCertMode,
+    :schema_type => XSD::QName.new(NsC_10, "VirtualServer.SSLRequestClientCertMode")
+  )
+end

data/lib/api/virtualserver/VirtualServerService.rb

@@ -0,0 +1,156 @@
+
+#
+# VirtualServerService
+#
+# This class provides a facade for SOAP method calls to the
+# ZXTM Virtual Server web service.
+class VirtualServerService
+  
+  attr_accessor :driver
+  
+  def initialize(endpoint=nil, username=nil, password=nil)
+    @driver = VirtualServerPort.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 virtual servers
+  #
+  # Args
+  #   status            - Symbol (possible values: :all, :enabled, :disabled)
+  #
+  # Examples
+  #   names(:all)       - Returns all virtual server names (default)
+  #   names(:enabled)   - Returns enabled virtual server names
+  #   names(:disabled)  - Returns disabled virtual server names
+  #
+  def list(status=nil)
+    result = []
+    valid_status = [:all, :enabled, :disabled]
+    status = :all if status.nil? or !valid_status.include?(status)
+
+    vs_names = @driver.getVirtualServerNames
+    return vs_names if status == :all
+
+    enabled_vs = @driver.getEnabled(vs_names)
+
+    case status
+    when :enabled
+      vs_names.length.times do |i|
+        result << vs_names[i] if enabled_vs[i]
+      end      
+    when :disabled
+      vs_names.length.times do |i|
+        result << vs_names[i] unless enabled_vs[i]
+      end
+    end
+
+    return result
+  end
+
+  # Creates new virtual server
+  #
+  # Args
+  #   name (String)          - Virtual server's name
+  #   vs_info (Hash)         - Virtual server's properties
+  #
+  # Examples
+  #   create("web")          - Creates new virtual server called "web" with default properties
+  #   create("web", {:port => "80", :protocol => "http", :default_pool => "web-pool"})
+  #
+  def create(name=nil, vs_info={})
+    default_port = "80"
+    default_protocol = "http"
+    default_pool = "discard"
+
+    vs_basic_info = VirtualServerBasicInfo.new
+    vs_basic_info.port = vs_info[:port] || default_port
+    vs_basic_info.protocol = vs_info[:protocol] || default_protocol
+    vs_basic_info.default_pool = vs_info[:default_pool] || default_pool
+
+    @driver.addVirtualServer([name], [vs_basic_info])
+  end
+
+  # Enables a virtual server
+  #
+  # Args
+  #   name (String)          - Virtual server's name to enable
+  #
+  # Examples
+  #   enable("web")          - Enables a virtual server called "web"
+  #
+  def enable(vs_name=nil)
+    @driver.setEnabled([vs_name], [true])
+  end
+
+  # Disables a virtual server
+  #
+  # Args
+  #   name (String)          - Virtual server's name to disable
+  #
+  # Examples
+  #   disable("web")         - Disables a virtual server called "web"
+  #
+  def disable(vs_name=nil)
+    @driver.setEnabled([vs_name], [false])
+  end
+  
+  # Adds a request rule (and enables it)
+  #
+  # Args
+  #   name (String)          - Virtual server's name
+  #   rule (String)          - Rule name
+  #
+  # Examples
+  #   add_request_rule("test", "some-rule")
+  #  
+  def add_request_rule(vs_name, rule)
+    vsr = VirtualServerRule.new
+    vsr.name = rule
+    vsr.enabled = true
+    @driver.addRules([vs_name],[[vsr]])
+  end  
+
+  # Removes a request rule
+  #
+  # Args
+  #   name (String)          - Virtual server's name
+  #   rule (String)          - Rule name
+  #
+  # Examples
+  #   remove_request_rule("test", "some-rule")
+  #  
+  def remove_request_rule(vs_name, rule)
+    @driver.removeRules([vs_name], [[rule]])
+  end
+
+  # Adds a response rule (and enables it)
+  #
+  # Args
+  #   name (String)          - Virtual server's name
+  #   rule (String)          - Rule name
+  #
+  # Examples
+  #   add_request_rule("test", "some-rule")
+  #    
+  def add_response_rule(vs_name, rule)
+    vsr = VirtualServerRule.new
+    vsr.name = rule
+    vsr.enabled = true
+    @driver.addResponseRules([vs_name], [[vsr]])
+  end
+  
+  # Removes a response rule
+  #
+  # Args
+  #   name (String)          - Virtual server's name
+  #   rule (String)          - Rule name
+  #
+  # Examples
+  #   remove_response_rule("test", "some-rule")
+  #  
+  def remove_response_rule(vs_name, rule)
+    @driver.removeResponseRules([vs_name], [[rule]])
+  end
+
+end