solusvm 1.2.1 → 1.3.0

data/lib/solusvm/node.rb

@@ -9,11 +9,19 @@ module Solusvm
     # * +type+ - a valid virtualization type; e.g: [openvz|xen|xen hvm|kvm]
     def list(type)
       validate_server_type(type) do
-        perform_request(:action => 'listnodes', :type => type)
+        perform_request(action: 'listnodes', type: type)
         parse_returned_params_as_list('nodes')
       end
     end
 
+    # Lists existing node groups
+    def list_groups
+      perform_request(action: 'listnodegroups')
+
+      # return list of node groups with numeric values excluded
+      returned_parameters['nodegroups'].to_s.split(',').map {|group| group.split('|')[1]}
+    end
+
     # Lists existing nodes ids of a given type.
     #
     # Parameters:
@@ -21,36 +29,36 @@ module Solusvm
     # * +type+ - a valid virtualization type; e.g: [openvz|xen|xen hvm|kvm]
     def ids(type)
       validate_server_type(type) do
-        perform_request(:action => 'node-idlist', :type => type)
-        returned_parameters['nodes'].split(',')
+        perform_request(action: 'node-idlist', type: type)
+        parse_returned_params_as_list('nodes')
       end
     end
 
     # Retrieves statistics from a specific node.
     def statistics(nodeid)
-      perform_request(:action => 'node-statistics', :nodeid => 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)
+      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)
+      perform_request(action: 'node-iplist', nodeid: nodeid)
       if statusmsg.match /no available ip/i
         []
       else
-        returned_parameters['ips'].split(',')
+        parse_returned_params_as_list('ips')
       end
     end
 
     # Lists virtual servers from a specific node.
     def virtualservers(nodeid)
-      perform_request({:action => "node-virtualservers", :nodeid => nodeid}, "virtualserver")
+      perform_request({action: "node-virtualservers", nodeid: nodeid}, "virtualserver")
 
       if returned_parameters["virtualservers"] && returned_parameters["virtualservers"]["virtualserver"]
         returned_parameters["virtualservers"]["virtualserver"]

data/lib/solusvm/reseller.rb

@@ -27,7 +27,7 @@ module Solusvm
     # * <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
+      perform_request(options.merge(action: 'reseller-create')) && returned_parameters
     end
 
     # Changes the available resources for a specific reseller.
@@ -49,22 +49,22 @@ module Solusvm
     # * <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
+      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
+      perform_request({action: 'reseller-info', username: username}) && returned_parameters
     end
 
     # Deletes an existing reseller.
     def delete(username)
-      perform_request({:action => 'reseller-delete', :username => username})
+      perform_request({action: 'reseller-delete', username: username})
     end
 
     # Lists existing resellers.
     def list
-      perform_request(:action => 'reseller-list')
+      perform_request(action: 'reseller-list')
       parse_returned_params_as_list('usernames')
     end
 

data/lib/solusvm/server.rb

@@ -22,167 +22,173 @@ module Solusvm
     # * <tt>:issuelicense</tt> - 1|2 1 = cPanel monthly 2= cPanel yearly
     def create(hostname, password, options = {})
       options.reverse_merge!(
-        :type         => 'xen',
-        :username     => nil,
-        :ips          => 1,
-        :node         => nil,
-        :plan         => nil,
-        :template     => nil,
-        :password     => password,
-        :hostname     => hostname
-      ).merge!(:action => 'vserver-create')
+        type:         'xen',
+        username:     nil,
+        ips:          1,
+        node:         nil,
+        plan:         nil,
+        template:     nil,
+        password:     password,
+        hostname:     hostname
+      ).merge!(action: 'vserver-create')
       perform_request(options) && returned_parameters
     end
 
     # Boots a server.
     def boot(vid)
-      perform_request(:action => 'vserver-boot', :vserverid => vid)
+      perform_request(action: 'vserver-boot', vserverid: vid)
     end
 
     # Reboots a server.
     def reboot(vid)
-      perform_request(:action => 'vserver-reboot', :vserverid => vid)
+      perform_request(action: 'vserver-reboot', vserverid: vid)
     end
 
     # Suspends a server.
     def suspend(vid)
-      perform_request(:action => 'vserver-suspend', :vserverid => vid)
+      perform_request(action: 'vserver-suspend', vserverid: vid)
     end
 
     # Resumes a server.
     def resume(vid)
-      perform_request(:action => 'vserver-unsuspend', :vserverid => vid)
+      perform_request(action: 'vserver-unsuspend', vserverid: vid)
     end
 
     # Shuts down a server.
     def shutdown(vid)
-      perform_request(:action => 'vserver-shutdown', :vserverid => vid)
+      perform_request(action: 'vserver-shutdown', vserverid: vid)
     end
 
     # Enable TUN/TAP.
     def tun_enable(vid)
-      perform_request(:action => 'vserver-tun-enable', :vserverid => 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)
+      perform_request(action: 'vserver-tun-disable', vserverid: vid)
     end
 
     # Enable Network Mode.
     def network_enable(vid)
-      perform_request(:action => 'vserver-network-enable', :vserverid => 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)
+      perform_request(action: 'vserver-network-disable', vserverid: vid)
     end
 
     # Enable PAE.
     def pae_enable(vid)
-      perform_request(:action => 'vserver-pae', :vserverid => vid, :pae => "on")
+      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")
+      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)
+      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)
+      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)
+      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)
+      perform_request(action: 'vserver-addip', vserverid: vid)
+      returned_parameters['ipaddress']
+    end
+
+    # Deletes an IP address for a specific server.
+    def del_ip(vid, ip_address)
+      perform_request(action: 'vserver-delip', vserverid: vid, ipaddr: ip_address)
     end
 
     # Changes server plan.
     def change_plan(vid, plan)
-      perform_request(:action => 'vserver-change', :vserverid => vid, :plan => 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)
+      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)
+      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)
+      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)
+      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)
+      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)
+      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)
+      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)
+      perform_request(action: 'vserver-vnc', vserverid: vid)
       returned_parameters
     end
 
     # Retrieves server console information.
     def console(vid)
-      perform_request(:action => 'vserver-console', :vserverid => 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)
+      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)
+      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)
+      perform_request(action: 'vserver-mountiso', vserverid: vid, iso: iso)
     end
 
     # Unmounts a given iso.
     def unmountiso(vid)
-      perform_request(:action => 'vserver-unmountiso', :vserverid => vid)
+      perform_request(action: 'vserver-unmountiso', vserverid: vid)
     end
   end
 end

data/lib/solusvm/version.rb

@@ -1,3 +1,3 @@
 module Solusvm
-  VERSION = "1.2.1"
+  VERSION = "1.3.0"
 end

data/solusvm.gemspec

@@ -11,6 +11,7 @@ Gem::Specification.new do |s|
   s.homepage    = "http://www.site5.com"
   s.summary     = "Wrapper for the SolusVM Admin::API"
   s.description = "Solusvm allows for easy interaction with the SolusVM Admin::API."
+  s.license     = 'MIT'
 
   s.rubyforge_project = "solusvm"
   s.files             = `git ls-files`.split("\n")

data/test/cli/test_client_cli.rb

@@ -10,23 +10,22 @@ class TestClientCli < Test::Unit::TestCase
   end
 
   def test_should_delegate_client_create_to_client
-    Solusvm.expects(:config).with("thelogin", "thekey", { :url => "theurl" })
     api = mock do
       expects(:successful?).returns(true)
       expects(:create).with() do |options|
         expected = {
-          :username => "theusername",
-          :password => "thepassword",
-          :email => "theemail",
-          :firstname => "thefirstname",
-          :lastname => "thelastname",
-          :company => "thecompany"
+          username: "theusername",
+          password: "thepassword",
+          email: "theemail",
+          firstname: "thefirstname",
+          lastname: "thelastname",
+          company: "thecompany"
         }
 
         expected.all? { |k,v| options[k] == v }
       end.returns("theresult")
     end
-    Solusvm::Client.stubs(:new => api)
+    Solusvm::Client.expects(:new).with(solusvm_params).returns(api)
 
     $stdout.expects(:puts).with("theresult")
     Solusvm::Cli.start(cli_expand_base_arguments([
@@ -41,8 +40,7 @@ class TestClientCli < Test::Unit::TestCase
   end
 
   def test_should_delegate_client_change_password_to_client
-    Solusvm.expects(:config).with("thelogin", "thekey", { :url => "theurl" })
-    Solusvm::Client.stubs(:new => mock do
+    Solusvm::Client.expects(:new).with(solusvm_params).returns(mock do
       expects(:successful?).returns(true)
       expects(:change_password).with("theusername", "thepassword").returns("theresult")
     end)
@@ -52,8 +50,7 @@ class TestClientCli < Test::Unit::TestCase
   end
 
   def test_should_delegate_client_authenticate_to_client
-    Solusvm.expects(:config).with("thelogin", "thekey", { :url => "theurl" })
-    Solusvm::Client.stubs(:new => mock do
+    Solusvm::Client.expects(:new).with(solusvm_params).returns(mock do
       expects(:successful?).returns(true)
       expects(:authenticate).with("theusername", "thepassword").returns("theresult")
     end)
@@ -63,8 +60,7 @@ class TestClientCli < Test::Unit::TestCase
   end
 
   def test_should_delegate_client_check_exists_to_client
-    Solusvm.expects(:config).with("thelogin", "thekey", { :url => "theurl" })
-    Solusvm::Client.stubs(:new => mock do
+    Solusvm::Client.expects(:new).with(solusvm_params).returns(mock do
       expects(:successful?).returns(true)
       expects(:exists?).with("theusername").returns("theresult")
     end)
@@ -74,8 +70,7 @@ class TestClientCli < Test::Unit::TestCase
   end
 
   def test_should_delegate_client_delete_to_client
-    Solusvm.expects(:config).with("thelogin", "thekey", { :url => "theurl" })
-    Solusvm::Client.stubs(:new => mock do
+    Solusvm::Client.stubs(:new).with(solusvm_params).returns(mock do
       expects(:successful?).returns(true)
       expects(:delete).with("theusername").returns("theresult")
     end)
@@ -85,8 +80,7 @@ class TestClientCli < Test::Unit::TestCase
   end
 
   def test_should_delegate_client_list_to_client
-    Solusvm.expects(:config).with("thelogin", "thekey", { :url => "theurl" })
-    Solusvm::Client.stubs(:new => mock do
+    Solusvm::Client.expects(:new).with(solusvm_params).returns(mock do
       expects(:successful?).returns(true)
       expects(:list).returns("theresult")
     end)
@@ -94,4 +88,4 @@ class TestClientCli < Test::Unit::TestCase
     $stdout.expects(:puts).with("theresult")
     Solusvm::Cli.start(cli_expand_base_arguments(["client", "list"]))
   end
-end
+end

data/test/cli/test_general_cli.rb

@@ -10,8 +10,7 @@ class TestGeneralCli < Test::Unit::TestCase
   end
 
   def test_should_delegate_templates_to_general
-    Solusvm.expects(:config).with("thelogin", "thekey", { :url => "theurl" })
-    Solusvm::General.stubs(:new => mock do
+    Solusvm::General.expects(:new).with(solusvm_params).returns(mock do
       expects(:successful?).returns(true)
       expects(:templates).with("type").returns("thetemplates")
     end)
@@ -21,8 +20,7 @@ class TestGeneralCli < Test::Unit::TestCase
   end
 
   def test_should_delegate_plans_to_general
-    Solusvm.expects(:config).with("thelogin", "thekey", { :url => "theurl" })
-    Solusvm::General.stubs(:new => mock do
+    Solusvm::General.expects(:new).with(solusvm_params).returns(mock do
       expects(:successful?).returns(true)
       expects(:plans).with("type").returns("theplans")
     end)
@@ -32,8 +30,7 @@ class TestGeneralCli < Test::Unit::TestCase
   end
 
   def test_should_delegate_isos_to_general
-    Solusvm.expects(:config).with("thelogin", "thekey", { :url => "theurl" })
-    Solusvm::General.stubs(:new => mock do
+    Solusvm::General.expects(:new).with(solusvm_params).returns(mock do
       expects(:successful?).returns(true)
       expects(:isos).with("type").returns("theisos")
     end)
@@ -41,4 +38,4 @@ class TestGeneralCli < Test::Unit::TestCase
     $stdout.expects(:puts).with("theisos")
     Solusvm::Cli.start(cli_expand_base_arguments(["general", "isos", "type"]))
   end
-end
+end

data/test/cli/test_node_cli.rb

@@ -10,8 +10,7 @@ class TestNodeCli < Test::Unit::TestCase
   end
 
   def test_should_delegate_node_available_ips_to_node
-    Solusvm.expects(:config).with("thelogin", "thekey", { :url => "theurl" })
-    Solusvm::Node.stubs(:new => mock do
+    Solusvm::Node.expects(:new).with(solusvm_params).returns(mock do
       expects(:successful?).returns(true)
       expects(:available_ips).with("thevserverid").returns("theips")
     end)
@@ -21,8 +20,7 @@ class TestNodeCli < Test::Unit::TestCase
   end
 
   def test_should_delegate_node_stats_to_node
-    Solusvm.expects(:config).with("thelogin", "thekey", { :url => "theurl" })
-    Solusvm::Node.stubs(:new => mock do
+    Solusvm::Node.expects(:new).with(solusvm_params).returns(mock do
       expects(:successful?).returns(true)
       expects(:statistics).with("thevserverid").returns("thestats")
     end)
@@ -32,8 +30,7 @@ class TestNodeCli < Test::Unit::TestCase
   end
 
   def test_should_delegate_node_xenresources_to_node
-    Solusvm.expects(:config).with("thelogin", "thekey", { :url => "theurl" })
-    Solusvm::Node.stubs(:new => mock do
+    Solusvm::Node.expects(:new).with(solusvm_params).returns(mock do
       expects(:successful?).returns(true)
       expects(:xenresources).with("thevserverid").returns("theresources")
     end)
@@ -43,8 +40,7 @@ class TestNodeCli < Test::Unit::TestCase
   end
 
   def test_should_delegate_node_virtualservers_to_node
-    Solusvm.expects(:config).with("thelogin", "thekey", { :url => "theurl" })
-    Solusvm::Node.stubs(:new => mock do
+    Solusvm::Node.expects(:new).with(solusvm_params).returns(mock do
       expects(:successful?).returns(true)
       expects(:virtualservers).with("thevserverid").returns("thedata")
     end)
@@ -54,8 +50,7 @@ class TestNodeCli < Test::Unit::TestCase
   end
 
   def test_should_delegate_nodes_list_to_node
-    Solusvm.expects(:config).with("thelogin", "thekey", { :url => "theurl" })
-    Solusvm::Node.stubs(:new => mock do
+    Solusvm::Node.expects(:new).with(solusvm_params).returns(mock do
       expects(:successful?).returns(true)
       expects(:list).with("type").returns("thenodes")
     end)
@@ -65,8 +60,7 @@ class TestNodeCli < Test::Unit::TestCase
   end
 
   def test_should_delegate_nodes_ids_to_node
-    Solusvm.expects(:config).with("thelogin", "thekey", { :url => "theurl" })
-    Solusvm::Node.stubs(:new => mock do
+    Solusvm::Node.expects(:new).with(solusvm_params).returns(mock do
       expects(:successful?).returns(true)
       expects(:ids).with("type").returns("thenodes")
     end)
@@ -75,4 +69,4 @@ class TestNodeCli < Test::Unit::TestCase
     Solusvm::Cli.start(cli_expand_base_arguments(["node", "list-ids", "type"]))
   end
 
-end
+end