solusvm 0.10.1 → 1.0.0.beta

data/lib/solusvm/cli/server_cli.rb

@@ -0,0 +1,168 @@
+module Solusvm
+  class ServerCli < BaseCli
+
+    desc "status VSERVERID", "Checks the status of a server"
+    def status(vserverid)
+      say server.status(vserverid)
+    end
+
+    desc "info VSERVERID", "Retrieves information from a server"
+    def info(vserverid)
+      say server.info(vserverid)
+    end
+
+    desc "vnc VSERVERID", "Retrieves vnc information from a server"
+    def vnc(vserverid)
+      say server.vnc(vserverid)
+    end
+
+    desc "console VSERVERID", "Retrieves console information from a server"
+    def console(vserverid)
+      say server.console(vserverid)
+    end
+
+    desc "info-all VSERVERID", "Retrieves all availavle information from a server"
+    def info_all(vserverid)
+      say server.info_all(vserverid)
+    end
+
+    desc "change-plan VSERVERID NEWPLAN", "Changes the plan of a server"
+    def change_plan(vserverid, newplan)
+      say server.change_plan(vserverid, newplan)
+    end
+
+    desc "change-owner VSERVERID CLIENTID", "Changes the owner of a server"
+    def change_owner(vserverid, clientid)
+      say server.change_owner(vserverid, clientid)
+    end
+
+    desc "change-consolepass VSERVERID NEWPASSWORD", "Changes the console password of a server"
+    def change_consolepass(vserverid, newpassword)
+      say server.change_consolepass(vserverid, newpassword)
+    end
+
+    desc "change-vncpass VSERVERID NEWPASSWORD", "Changes the vnc password of a server"
+    def change_vncpass(vserverid, newpassword)
+      say server.change_vncpass(vserverid, newpassword)
+    end
+
+    desc "change-rootpass VSERVERID NEWPASSWORD", "Changes the root password of a server"
+    def change_rootpass(vserverid, newpassword)
+      say server.change_rootpassword(vserverid, newpassword)
+    end
+
+    desc "change-bootorder VSERVERID BOOTORDER", "Changes the boot order of a server [cd(Hard Disk CDROM)|dc(CDROM Hard Disk)|c(Hard Disk)|d(CDROM)]"
+    def change_bootorder(vserverid, newbootorder)
+      say server.change_bootorder(vserverid, newbootorder)
+    end
+
+    desc "change-hostname VSERVERID HOSTNAME", "Changes the hostname of a server"
+    def change_hostname(vserverid, newhostname)
+      say server.change_hostname(vserverid, newhostname)
+    end
+
+    desc "addip VSERVERID", "Adds an ip to the server"
+    def addip(vserverid)
+      say server.add_ip(vserverid)
+    end
+
+    desc "boot VSERVERID", "Boots up a server"
+    def boot(vserverid)
+      say server.boot(vserverid)
+    end
+
+    desc "reboot VSERVERID", "Reboots a server"
+    def reboot(vserverid)
+      say server.reboot(vserverid)
+    end
+
+    desc "shutdown VSERVERID", "Shuts down a server"
+    def shutdown(vserverid)
+      say server.shutdown(vserverid)
+    end
+
+    desc "suspend VSERVERID", "Suspends a server"
+    def suspend(vserverid)
+      say server.suspend(vserverid)
+    end
+
+    desc "resume VSERVERID", "Resumes a server"
+    def resume(vserverid)
+      say server.resume(vserverid)
+    end
+
+    desc "check-exists VSERVERID", "Checks if a server exists"
+    def check_exists(vserverid)
+      say server.check_exists(vserverid)
+    end
+
+    desc "terminate VSERVERID", "Terminates a server"
+    def terminate(vserverid)
+      say server.terminate(vserverid)
+    end
+
+    desc "rebuild VSERVERID", "Rebuilds a server"
+    method_option :template, :type => :string, :desc => "VPS template to boot from",  :aliases => ["-t", "--template"]
+    def rebuild(vserverid)
+      say server.rebuild(vserverid, {:template => options[:template]})
+    end
+
+    desc "tun-switcher VSERVERID SWITCH(on|off)", "Enable/Disable TUN/TAP"
+    def tun_switcher(vserverid, switch)
+      say switch(vserverid, switch, :tun_enable, :tun_disable)
+    end
+
+    desc "network-switcher VSERVERID SWITCH(on|off)", "Enable/Disable Network mode"
+    def network_switcher(vserverid, switch)
+      say switch(vserverid, switch, :network_enable, :network_disable)
+    end
+
+    desc "pae-switcher VSERVERID SWITCH(on|off)", "Enable/Disable PAE"
+    def pae_switcher(vserverid, switch)
+      say switch(vserverid, switch, :pae_enable, :pae_disable)
+    end
+
+    desc "mountiso VSERVERID ISO", "Mounts an iso"
+    def mountiso(vserverid, iso)
+      say server.mountiso(vserverid, iso)
+    end
+
+    desc "unmountiso VSERVERID", "Unmounts an iso"
+    def unmountiso(vserverid)
+      say server.unmountiso(vserverid)
+    end
+
+    desc "create HOSTNAME PASSWORD", "Creates a new server"
+    method_option :plan, :type => :string, :desc => "Plan to use",  :aliases => ["-p", "--plan"]
+    method_option :ips,  :type => :string, :desc => "Number of ips to add to the vps",  :aliases => ["-i", "--ips"]
+    method_option :kind, :type => :string, :desc => "Type of VPS (#{Solusvm::Server::VALID_SERVER_TYPES.join(',')})",  :aliases => ["-k", "--kind"]
+    method_option :username, :type => :string, :desc => "The client to put the VPS under",  :aliases => ["-u", "--username"]
+    method_option :template, :type => :string, :desc => "VPS template to boot from",  :aliases => ["-t", "--template"]
+    method_option :node, :type => :string, :desc => "Node to provision on",  :aliases => ["-n", "--node"]
+    def create(hostname, password)
+      say server.create(hostname, password, {
+        :plan => options[:plan], :ips => options[:ips], :type => options[:kind], 
+        :username => options[:username], :template => options[:template], :node => options[:node]
+      })
+    end
+
+    private
+
+    def server
+      @server ||= begin
+        configure
+        Solusvm::Server.new
+      end
+    end
+
+    def switch(vserverid, switch_value, on_method, off_method)
+      if switch_value == "on"
+        server.send(on_method, vserverid)
+      elsif switch_value == "off"
+        server.send(off_method, vserverid)
+      else
+        "Invalid switch value. Valid values are on|off"
+      end
+    end
+  end
+end

data/lib/solusvm/cli.rb

@@ -0,0 +1,22 @@
+require 'solusvm'
+require 'solusvm/cli/base_cli'
+require 'solusvm/cli/server_cli'
+require 'solusvm/cli/node_cli'
+require 'solusvm/cli/general_cli'
+require 'solusvm/cli/reseller_cli'
+require 'solusvm/cli/client_cli'
+
+module Solusvm
+  class Cli < Thor
+    register(ServerCli,  'server', 'server <command>', 'Server commands')
+    register(NodeCli,    'node', 'node <command>', 'Node commands')
+    register(GeneralCli, 'general', 'general <command>', 'General commands')
+    register(ResellerCli, 'reseller', 'reseller <command>', 'Reseller commands')
+    register(ClientCli, 'client', 'client <command>', 'Client commands')
+
+    desc "version", "Outputs the current program version"
+    def version
+      say Solusvm::VERSION
+    end
+  end
+end

data/lib/solusvm/client.rb

@@ -1,35 +1,49 @@
 module Solusvm
-  # Solusvm::Client is the class for working with clients
+  # Solusvm::Client is the class for working with clients.
   class Client < Base
-    # Creates a client
+    # Creates a client.
     #
     # Options:
+    #
     # * <tt>:username</tt>
     # * <tt>:password</tt>
     # * <tt>:email</tt>
     # * <tt>:firstname</tt>
     # * <tt>:lastname</tt>
+    # * <tt>:company</tt>
     def create(options ={})
-      options.merge!(:action => 'client-create')
-      perform_request(options)
+      perform_request(options.merge(:action => 'client-create')) && returned_parameters
     end
 
-    # change client password for the solus admin
-    def change_password(username, password)
-      perform_request({:action => "client-updatepassword", :username => username, :password => password})
-      statusmsg.match /success/i
+    # Change client password for the solus admin.
+    def change_password(username, new_password)
+      perform_request({:action => "client-updatepassword", :username => username, :password => new_password})
     end
 
-    # checks wether a specific client exists
+    # Checks wether a specific client exists.
     def exists?(username)
       perform_request({:action => 'client-checkexists', :username => username})
-      statusmsg.match /client exists/i
     end
 
-    # Verify a clients login. Returns true when the specified login is correct
+    # Verify a clients login. Returns true when the specified login is correct.
     def authenticate(username, password)
       perform_request({:action => 'client-authenticate', :username => username, :password => password})
-      statusmsg.match /validated/i
+    end
+
+    # Deletes an existing client.
+    def delete(username)
+      perform_request({:action => "client-delete", :username => username})
+    end
+
+    # Lists existing clients.
+    def list
+      perform_request({:action => "client-list"}, "client")
+
+      if returned_parameters["clients"] && returned_parameters["clients"]["client"]
+        returned_parameters["clients"]["client"]
+      elsif returned_parameters["clients"]
+        []
+      end
     end
   end
 end

data/lib/solusvm/general.rb

@@ -1,30 +1,38 @@
 module Solusvm
+  # Solusvm::General is the class for retrieving general information.
   class General < Base
-    def nodes(type)
-      validate_server_type!(type)
-      perform_request(:action => 'listnodes', :type => type)
-      returned_parameters['nodes'].split(',')
-    end
-
+    
+    # Lists available templates.
+    #
+    # Parameters:
+    #
+    # * +type+ - a valid virtualization type; e.g: [openvz|xen|xen hvm|kvm]
     def templates(type)
       validate_server_type!(type)
       perform_request(:action => 'listtemplates', :type => type)
       returned_parameters['templates'].split(',')
     end
 
-    def node_statistics(nodeid)
-      perform_request(:action => 'node-statistics', :nodeid => nodeid)
-      returned_parameters
+    # Lists available plans.
+    #
+    # Parameters:
+    #
+    # * +type+ - a valid virtualization type; e.g: [openvz|xen|xen hvm|kvm]
+    def plans(type)
+      validate_server_type!(type)
+      perform_request(:action => 'listplans', :type => type)
+      returned_parameters['plans'].split(',')
     end
 
-    # List a nodes available IPs
-    def node_available_ips(nodeid)
-      perform_request(:action => 'node-iplist', :nodeid => nodeid)
-      if statusmsg.match /no available ip/i
-        []
-      else
-        returned_parameters['ips'].split(',')
-      end
+    # Lists available isos.
+    #
+    # Parameters:
+    #
+    # * +type+ - a valid virtualization type; e.g: [openvz|xen|xen hvm|kvm]
+    def isos(type)
+      validate_server_type!(type)
+      perform_request(:action => 'listiso', :type => type)
+      returned_parameters['iso'].split(',')
     end
   end
 end

data/lib/solusvm/node.rb

@@ -0,0 +1,60 @@
+module Solusvm
+  # Solusvm::Node is the class for working with nodes.
+  class Node < Base
+
+    # Lists existing nodes of a given type.
+    #
+    # Parameters:
+    #
+    # * +type+ - a valid virtualization type; e.g: [openvz|xen|xen hvm|kvm]
+    def list(type)
+      validate_server_type!(type)
+      perform_request(:action => 'listnodes', :type => type)
+      returned_parameters['nodes'].split(',')
+    end
+
+    # Lists existing nodes ids of a given type.
+    #
+    # Parameters:
+    #
+    # * +type+ - a valid virtualization type; e.g: [openvz|xen|xen hvm|kvm]
+    def ids(type)
+      validate_server_type!(type)
+      perform_request(:action => 'node-idlist', :type => type)
+      returned_parameters['nodes'].split(',')
+    end
+
+    # Retrieves statistics from a specific node.
+    def statistics(nodeid)
+      perform_request(:action => 'node-statistics', :nodeid => nodeid)
+      returned_parameters
+    end
+
+    # Retrieves available xen resources from a specific node.
+    def xenresources(nodeid)
+      perform_request(:action => 'node-xenresources', :nodeid => nodeid)
+      returned_parameters
+    end
+
+    # Retrieves a list of available IPs for a specific node.
+    def available_ips(nodeid)
+      perform_request(:action => 'node-iplist', :nodeid => nodeid)
+      if statusmsg.match /no available ip/i
+        []
+      else
+        returned_parameters['ips'].split(',')
+      end
+    end
+
+    # Lists virtual servers from a specific node.
+    def virtualservers(nodeid)
+      perform_request({:action => "node-virtualservers", :nodeid => nodeid}, "virtualserver")
+
+      if returned_parameters["virtualservers"] && returned_parameters["virtualservers"]["virtualserver"]
+        returned_parameters["virtualservers"]["virtualserver"]
+      elsif returned_parameters["virtualservers"]
+        []
+      end
+    end
+  end
+end

data/lib/solusvm/reseller.rb

@@ -0,0 +1,72 @@
+module Solusvm
+  class Reseller < Base
+
+    # Creates a reseller.
+    #
+    # Options:
+    #
+    # * <tt>:username</tt>
+    # * <tt>:password</tt>
+    # * <tt>:email</tt>
+    # * <tt>:firstname</tt>
+    # * <tt>:lastname</tt>
+    # * <tt>:company</tt> - (optional)
+    # * <tt>:usernameprefix</tt> - prefix for reseller client usernames (optional)
+    # * <tt>:maxvps</tt> - maximum amount of virtual servers (optional)
+    # * <tt>:maxusers</tt> - maximum amount of users (optional)
+    # * <tt>:maxmem</tt> - maximum amount memory - (optional)
+    # * <tt>:maxburst</tt> - maximum amount of burst memory or swapspace (optional)
+    # * <tt>:maxdisk</tt> - maximum amount of diskspace (optional)
+    # * <tt>:maxbw</tt> - maximum amount of bandwidth (optional)
+    # * <tt>:maxipv4</tt> - maximum amount of ipv4 addresses (optional)
+    # * <tt>:maxipv6</tt> - maximum amount of ipv6 addresses (optional)
+    # * <tt>:nodegroups</tt> - comma seperated list of node groups (optional)
+    # * <tt>:mediagroups</tt> - comma seperated list of media groups (optional)
+    # * <tt>:openvz</tt> - y|n Allow building of openvz virtual servers (optional)
+    # * <tt>:xenpv</tt> - y|n Allow building of xen pv virtual servers (optional)
+    # * <tt>:xenhvm</tt> - y|n Allow building of xen hvm virtual servers (optional)
+    # * <tt>:kvm</tt> - y|n Allow building of kvmvirtual servers (optional)
+    def create(options ={})
+      perform_request(options.merge(:action => 'reseller-create')) && returned_parameters
+    end
+
+    # Changes the available resources for a specific reseller.
+    #
+    # Options:
+    #
+    # * <tt>:maxvps</tt> - maximum amount of virtual servers (optional)
+    # * <tt>:maxusers</tt> - maximum amount of users (optional)
+    # * <tt>:maxmem</tt> - maximum amount memory - (optional)
+    # * <tt>:maxburst</tt> - maximum amount of burst memory or swapspace (optional)
+    # * <tt>:maxdisk</tt> - maximum amount of diskspace (optional)
+    # * <tt>:maxbw</tt> - maximum amount of bandwidth (optional)
+    # * <tt>:maxipv4</tt> - maximum amount of ipv4 addresses (optional)
+    # * <tt>:maxipv6</tt> - maximum amount of ipv6 addresses (optional)
+    # * <tt>:nodegroups</tt> - comma seperated list of node groups (optional)
+    # * <tt>:mediagroups</tt> - comma seperated list of media groups (optional)
+    # * <tt>:openvz</tt> - y|n Allow building of openvz virtual servers (optional)
+    # * <tt>:xenpv</tt> - y|n Allow building of xen pv virtual servers (optional)
+    # * <tt>:xenhvm</tt> - y|n Allow building of xen hvm virtual servers (optional)
+    # * <tt>:kvm</tt> - y|n Allow building of kvmvirtual servers (optional)
+    def change_resources(username, options={})
+      perform_request(options.merge(:action => 'reseller-modifyresources', :username => username)) && returned_parameters
+    end
+
+    # Retrieves information from an existing reseller.
+    def info(username)
+      perform_request({:action => 'reseller-info', :username => username}) && returned_parameters
+    end
+
+    # Deletes an existing reseller.
+    def delete(username)
+      perform_request({:action => 'reseller-delete', :username => username})
+    end
+
+    # Lists existing resellers.
+    def list
+      perform_request(:action => 'reseller-list')
+      returned_parameters['usernames'].split(',')
+    end
+
+  end
+end

data/lib/solusvm/server.rb

@@ -1,5 +1,25 @@
 module Solusvm
+  # Solusvm::Server is the class for working with servers.
   class Server < Base
+
+    # Creates a server.
+    #
+    # Options:
+    #
+    # * <tt>:type</tt> - openvz|xen|xen hvm|kvm
+    # * <tt>:node</tt> - name of node
+    # * <tt>:nodegroup</tt> - name of nodegroup
+    # * <tt>:username</tt> - client username
+    # * <tt>:plan</tt> - plan name
+    # * <tt>:template</tt> - template or iso name
+    # * <tt>:ips</tt> - amount of ips
+    # * <tt>:hvmt</tt> - 0|1 Default is 0. This allows to define templates & isos for Xen HVM
+    # * <tt>:custommemory</tt> - overide plan memory with this amount
+    # * <tt>:customdiskspace</tt> - overide plan diskspace with this amount
+    # * <tt>:custombandwidth</tt> - overide plan bandwidth with this amount
+    # * <tt>:customcpu</tt> - overide plan cpu cores with this amount
+    # * <tt>:customextraip</tt> - add this amount of extra ips
+    # * <tt>:issuelicense</tt> - 1|2 1 = cPanel monthly 2= cPanel yearly
     def create(hostname, password, options = {})
       options.reverse_merge!(
         :type         => 'xen',
@@ -11,64 +31,158 @@ module Solusvm
         :password     => password,
         :hostname     => hostname
       ).merge!(:action => 'vserver-create')
-      perform_request(options)
-      returned_parameters
+      perform_request(options) && returned_parameters
     end
 
+    # Boots a server.
     def boot(vid)
       perform_request(:action => 'vserver-boot', :vserverid => vid)
     end
 
+    # Reboots a server.
     def reboot(vid)
       perform_request(:action => 'vserver-reboot', :vserverid => vid)
     end
 
+    # Suspends a server.
     def suspend(vid)
       perform_request(:action => 'vserver-suspend', :vserverid => vid)
     end
 
+    # Resumes a server.
     def resume(vid)
       perform_request(:action => 'vserver-unsuspend', :vserverid => vid)
     end
 
+    # Shuts down a server.
     def shutdown(vid)
       perform_request(:action => 'vserver-shutdown', :vserverid => vid)
     end
 
+    # Enable TUN/TAP.
+    def tun_enable(vid)
+      perform_request(:action => 'vserver-tun-enable', :vserverid => vid)
+    end
+
+    # Disable TUN/TAP.
+    def tun_disable(vid)
+      perform_request(:action => 'vserver-tun-disable', :vserverid => vid)
+    end
+
+    # Enable Network Mode.
+    def network_enable(vid)
+      perform_request(:action => 'vserver-network-enable', :vserverid => vid)
+    end
+
+    # Disables Network Mode.
+    def network_disable(vid)
+      perform_request(:action => 'vserver-network-disable', :vserverid => vid)
+    end
+
+    # Enable PAE.
+    def pae_enable(vid)
+      perform_request(:action => 'vserver-pae', :vserverid => vid, :pae => "on")
+    end
+
+    # Disables PAE.
+    def pae_disable(vid)
+      perform_request(:action => 'vserver-pae', :vserverid => vid, :pae => "off")
+    end
+
+    # Terminates a server.
     def terminate(vid, deleteclient = false)
       perform_request(:action => 'vserver-terminate', :vserverid => vid, :deleteclient => deleteclient)
     end
 
+    # Checks if a specific server exists.
     def exists?(vid)
       perform_request(:action => 'vserver-checkexists', :vserverid => vid)
       !statusmsg.match(/Virtual server exists/i).nil?
     end
 
+    # Checks the status of specific server (disabled|online|offline).
     def status(vid)
       perform_request(:action => 'vserver-status', :vserverid => vid)
       statusmsg
     end
 
+    # Adds an IP address for a specific server.
     def add_ip(vid)
       perform_request(:action => 'vserver-addip', :vserverid => vid)
     end
 
+    # Changes server plan.
     def change_plan(vid, plan)
       perform_request(:action => 'vserver-change', :vserverid => vid, :plan => plan)
     end
 
+    # Changes server owner.
+    def change_owner(vid, client_id)
+      perform_request(:action => 'vserver-changeowner', :vserverid => vid, :clientid => client_id)
+    end
+
+    # Changes server console password.
+    def change_consolepass(vid, new_password)
+      perform_request(:action => 'vserver-consolepass', :vserverid => vid, :consolepassword => new_password)
+    end
+
+    # Changes server vnc password.
+    def change_vncpass(vid, new_password)
+      perform_request(:action => 'vserver-vncpass', :vserverid => vid, :vncpassword => new_password)
+    end
+
+    # Changes server root password.
+    def change_rootpassword(vid, new_password)
+      perform_request(:action => 'vserver-rootpassword', :vserverid => vid, :rootpassword => new_password)
+    end
+
+    # Changes server boot order [cd(Hard Disk CDROM)|dc(CDROM Hard Disk)|c(Hard Disk)|d(CDROM)].
+    def change_bootorder(vid, bootorder)
+      perform_request(:action => 'vserver-bootorder', :vserverid => vid, :bootorder => bootorder.to_s)
+    end
+
+    # Changes server hostname.
+    def change_hostname(vid, hostname)
+      perform_request(:action => 'vserver-hostname', :vserverid => vid, :hostname => hostname)
+    end
+
+    # Retrieves server information.
     def info(vid, reboot = false)
       perform_request(:action => 'vserver-info', :vserverid => vid, :reboot => reboot)
       returned_parameters
     end
+
+    # Retrieves server vnc information.
+    def vnc(vid)
+      perform_request(:action => 'vserver-vnc', :vserverid => vid)
+      returned_parameters
+    end
+
+    # Retrieves server console information.
+    def console(vid)
+      perform_request(:action => 'vserver-console', :vserverid => vid)
+      returned_parameters
+    end
     
+    # Retrieves all available server information.
     def info_all(vid)
       perform_request(:action => 'vserver-infoall', :vserverid => vid)
       returned_parameters
     end
 
+    # Rebuilds a server using a given template.
     def rebuild(vid, template)
       perform_request(:action => 'vserver-rebuild', :vserverid => vid, :template => template)
     end
+
+    # Mounts a given iso.
+    def mountiso(vid, iso)
+      perform_request(:action => 'vserver-mountiso', :vserverid => vid, :iso => iso)
+    end
+
+    # Unmounts a given iso.
+    def unmountiso(vid)
+      perform_request(:action => 'vserver-unmountiso', :vserverid => vid)
+    end
   end
 end

data/lib/solusvm/version.rb

@@ -1,3 +1,3 @@
 module Solusvm
-  VERSION = "0.10.1"
+  VERSION = "1.0.0.beta"
 end

data/lib/solusvm.rb

@@ -26,11 +26,11 @@ module Solusvm
   end
 end
 
-directory = File.expand_path(File.dirname(__FILE__))
-
-require File.join(directory, 'solusvm', 'exceptions')
-require File.join(directory, 'solusvm', 'hash')
-require File.join(directory, 'solusvm', 'base')
-require File.join(directory, 'solusvm', 'general')
-require File.join(directory, 'solusvm', 'client')
-require File.join(directory, 'solusvm', 'server')
+require 'solusvm/exceptions'
+require 'solusvm/hash'
+require 'solusvm/base'
+require 'solusvm/general'
+require 'solusvm/client'
+require 'solusvm/server'
+require 'solusvm/reseller'
+require 'solusvm/node'

data/solusvm.gemspec

@@ -19,9 +19,12 @@ Gem::Specification.new do |s|
   s.require_paths     = ["lib"]
 
   s.add_runtime_dependency 'xml-simple'
+  s.add_runtime_dependency 'thor'
   s.add_runtime_dependency 'jruby-openssl' if RUBY_PLATFORM == 'java'
 
   s.add_development_dependency 'redgreen', '~> 1.2.2'
   s.add_development_dependency 'fakeweb', '~> 1.3.0'
+  s.add_development_dependency 'mocha', '~> 0.10.3'
+  s.add_development_dependency 'rdoc', '~> 3.12'
   s.add_development_dependency 'rake', '~> 0.9.2.2'
 end