solusvm 1.4.0 → 2.0.0.beta1

data/lib/solusvm/server.rb

@@ -1,25 +1,30 @@
-module Solusvm
-  # Solusvm::Server is the class for working with servers.
+module SolusVM
+  # SolusVM::Server is the class for working with virtual 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
+    # Public: Creates a new virtual server.
+    #
+    # hostname - The server hostname
+    # password - The server password
+    # options  - A Hash of options
+    #            :type            - openvz|xen|xen hvm|kvm
+    #            :node            - name of node
+    #            :nodegroup       - name of nodegroup
+    #            :username        - client username
+    #            :plan            - plan name
+    #            :template        - template or iso name
+    #            :ips             - amount of ips
+    #            :hvmt            - 0|1 Default is 0. This allows to define
+    #                               templates & isos for Xen HVM
+    #            :custommemory    - overide plan memory with this amount
+    #            :customdiskspace - overide plan diskspace with this amount
+    #            :custombandwidth - overide plan bandwidth with this amount
+    #            :customcpu       - overide plan cpu cores with this amount
+    #            :customextraip   - add this amount of extra ips
+    #            :issuelicense    - 1|2 1 = cPanel monthly, 2 = cPanel yearly
+    #
+    # Returns a Hash with the new server info, or false if the server was not
+    # created successfully.
     def create(hostname, password, options = {})
       options.reverse_merge!(
         type:         'xen',
@@ -34,141 +39,254 @@ module Solusvm
       perform_request(options) && returned_parameters
     end
 
-    # Boots a server.
+    # Public: Boots a server.
+    #
+    # vid - The virtual server ID in SolusVM
+    #
+    # Returns true if the server was successfully booted.
     def boot(vid)
       perform_request(action: 'vserver-boot', vserverid: vid)
     end
 
-    # Reboots a server.
+    # Public: Reboots a server.
+    #
+    # vid - The virtual server ID in SolusVM
+    #
+    # Returns true if the server was successfully rebooted.
     def reboot(vid)
       perform_request(action: 'vserver-reboot', vserverid: vid)
     end
 
-    # Suspends a server.
+    # Public: Suspends a server.
+    #
+    # vid - The virtual server ID in SolusVM
+    #
+    # Returns true if the server was successfully suspended.
     def suspend(vid)
       perform_request(action: 'vserver-suspend', vserverid: vid)
     end
 
-    # Resumes a server.
+    # Public: Resumes a server.
+    #
+    # vid - The virtual server ID in SolusVM
+    #
+    # Returns true if the server was successfully resumed.
     def resume(vid)
       perform_request(action: 'vserver-unsuspend', vserverid: vid)
     end
 
-    # Shuts down a server.
+    # Public: Shuts down a server.
+    #
+    # vid - The virtual server ID in SolusVM
+    #
+    # Returns true if the server was successfully shutdown.
     def shutdown(vid)
       perform_request(action: 'vserver-shutdown', vserverid: vid)
     end
 
-    # Enable TUN/TAP.
+    # Public: Enable TUN/TAP.
+    #
+    # vid - The virtual server ID in SolusVM
+    #
+    # Returns true if TUN/TAP was successfully enabled.
     def tun_enable(vid)
       perform_request(action: 'vserver-tun-enable', vserverid: vid)
     end
 
-    # Disable TUN/TAP.
+    # Public: Disable TUN/TAP.
+    #
+    # vid - The virtual server ID in SolusVM
+    #
+    # Returns true if TUN/TAP was successfully disabled.
     def tun_disable(vid)
       perform_request(action: 'vserver-tun-disable', vserverid: vid)
     end
 
-    # Enable Network Mode.
+    # Public: Enable Network Mode.
+    #
+    # vid - The virtual server ID in SolusVM
+    #
+    # Returns true if Network Mode was successfully enabled.
     def network_enable(vid)
       perform_request(action: 'vserver-network-enable', vserverid: vid)
     end
 
-    # Disables Network Mode.
+    # Public: Disables Network Mode.
+    #
+    # vid - The virtual server ID in SolusVM
+    #
+    # Returns true if Network Mode was successfully disabled.
     def network_disable(vid)
       perform_request(action: 'vserver-network-disable', vserverid: vid)
     end
 
-    # Enable PAE.
+    # Public: Enable PAE.
+    #
+    # vid - The virtual server ID in SolusVM
+    #
+    # Returns true if PAE was successfully enabled.
     def pae_enable(vid)
       perform_request(action: 'vserver-pae', vserverid: vid, pae: "on")
     end
 
-    # Disables PAE.
+    # Public: Disables PAE.
+    #
+    # vid - The virtual server ID in SolusVM
+    #
+    # Returns true if PAE was successfully disabled.
     def pae_disable(vid)
       perform_request(action: 'vserver-pae', vserverid: vid, pae: "off")
     end
 
-    # Terminates a server.
+    # Public: Terminates a server.
+    #
+    # vid - The virtual server ID in SolusVM
+    #
+    # Returns true if the server was successfully terminated.
     def terminate(vid, deleteclient = false)
       perform_request(action: 'vserver-terminate', vserverid: vid, deleteclient: deleteclient)
     end
 
-    # Checks if a specific server exists.
+    # Public: Checks if a specific server exists.
+    #
+    # vid - The virtual server ID in SolusVM
+    #
+    # Returns true if the server exists.
     def exists?(vid)
       perform_request(action: 'vserver-checkexists', vserverid: vid)
-      !statusmsg.match(/Virtual server exists/i).nil?
+      !!statusmsg.match(/Virtual server exists/i)
     end
 
-    # Checks the status of specific server (disabled|online|offline).
+    # Public: Checks the status of specific server (disabled|online|offline).
+    #
+    # vid - The virtual server ID in SolusVM
+    #
+    # Returns the server's status.
     def status(vid)
       perform_request(action: 'vserver-status', vserverid: vid)
       statusmsg
     end
 
-    # Adds an IP address for a specific server.
+    # Public: Adds an IP address for a specific server.
+    #
+    # vid - The virtual server ID in SolusVM
+    #
+    # Returns the IP as a String.
     def add_ip(vid)
       perform_request(action: 'vserver-addip', vserverid: vid)
       returned_parameters['ipaddress']
     end
 
-    # Deletes an IP address for a specific server.
+    # Public: Deletes an IP address for a specific server.
+    #
+    # vid        - The virtual server ID in SolusVM
+    # ip_address - The IP address to remove
+    #
+    # Returns true if the IP was successfully deleted.
     def del_ip(vid, ip_address)
       perform_request(action: 'vserver-delip', vserverid: vid, ipaddr: ip_address)
     end
 
-    # Changes server plan.
+    # Public: Changes server plan.
+    #
+    # vid  - The virtual server ID in SolusVM
+    # plan - The new plan ID
+    #
+    # Returns true if the server's plan was successfully changed.
     def change_plan(vid, plan)
       perform_request(action: 'vserver-change', vserverid: vid, plan: plan)
     end
 
-    # Changes server owner.
+    # Public: Changes server owner.
+    #
+    # vid       - The virtual server ID in SolusVM
+    # client_id - The new client ID
+    #
+    # Returns true if the server's owner was successfully changed.
     def change_owner(vid, client_id)
       perform_request(action: 'vserver-changeowner', vserverid: vid, clientid: client_id)
     end
 
-    # Changes server console password.
+    # Public: Changes server console password.
+    #
+    # vid          - The virtual server ID in SolusVM
+    # new_password - The new console password
+    #
+    # Returns true if the server's console password was successfully changed.
     def change_consolepass(vid, new_password)
       perform_request(action: 'vserver-consolepass', vserverid: vid, consolepassword: new_password)
     end
 
-    # Changes server vnc password.
+    # Public: Changes server VNC password.
+    #
+    # vid          - The virtual server ID in SolusVM
+    # new_password - The new VNC password
+    #
+    # Returns true if the server's VNC password was successfully changed.
     def change_vncpass(vid, new_password)
       perform_request(action: 'vserver-vncpass', vserverid: vid, vncpassword: new_password)
     end
 
-    # Changes server root password.
+    # Public: Changes server root password.
+    #
+    # vid          - The virtual server ID in SolusVM
+    # new_password - The new root password
+    #
+    # Returns true if the server's root password was successfully changed.
     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)].
+    # Public: Changes server boot order
+    #
+    # vid       - The virtual server ID in SolusVM
+    # bootorder - The boot order, one of the following:
+    #             :cd - Hard Disk CDROM
+    #             :dc - CDROM Hard Disk
+    #             :c  - Hard Disk
+    #             :d  - CDROM
+    #
+    # Returns true if the boot order was successfully changed.
     def change_bootorder(vid, bootorder)
       perform_request(action: 'vserver-bootorder', vserverid: vid, bootorder: bootorder.to_s)
     end
 
-    # Changes server hostname.
+    # Public: Changes server hostname.
+    #
+    # vid      - The virtual server ID in SolusVM
+    # hostname - The new hostname
+    #
+    # Returns true if the server's hostname was successfully changed.
     def change_hostname(vid, hostname)
       perform_request(action: 'vserver-hostname', vserverid: vid, hostname: hostname)
     end
 
-    # Retrieves server information.
+    # Public: Retrieves server information.
+    #
+    # vid - The virtual server ID in SolusVM
+    #
+    # Returns a Hash.
     def info(vid, reboot = false)
       perform_request(action: 'vserver-info', vserverid: vid, reboot: reboot)
       returned_parameters
     end
 
-    # Retrieves server vnc information.
+    # Public: Retrieves server vnc information.
+    #
+    # vid - The virtual server ID in SolusVM
+    #
+    # Returns a Hash.
     def vnc(vid)
       perform_request(action: 'vserver-vnc', vserverid: vid)
       returned_parameters
     end
 
-    # Retrieves server console information.
+    # Public: Retrieves server console information.
     #
+    # vid    - The virtual server ID in SolusVM
     # params - A Hash to pass optional parameters to vserver-console call:
     #          :access - A String that can be 'enable' or 'disable'
-    #          :time   - A Integer that can be 1|2|3|4|5|6|7|8
+    #          :time   - An Integer that can be 1|2|3|4|5|6|7|8
     #
     # returns a Hash
     def console(vid, params = {})
@@ -176,23 +294,41 @@ module Solusvm
       returned_parameters
     end
 
-    # Retrieves all available server information.
+    # Public: Retrieves all available server information.
+    #
+    # vid - The virtual server ID in SolusVM
+    #
+    # Returns a Hash.
     def info_all(vid)
       perform_request(action: 'vserver-infoall', vserverid: vid)
       returned_parameters
     end
 
-    # Rebuilds a server using a given template.
+    # Public: Rebuilds a server using a given template.
+    #
+    # vid - The virtual server ID in SolusVM
+    # template - The template to use
+    #
+    # Returns true if the server was successfully rebuilt.
     def rebuild(vid, template)
       perform_request(action: 'vserver-rebuild', vserverid: vid, template: template)
     end
 
-    # Mounts a given iso.
+    # Public: Mounts a given ISO image.
+    #
+    # vid - The virtual server ID in SolusVM
+    # iso - The ISO image to mount
+    #
+    # Returns true if the ISO was mounted successfully.
     def mountiso(vid, iso)
       perform_request(action: 'vserver-mountiso', vserverid: vid, iso: iso)
     end
 
-    # Unmounts a given iso.
+    # Public: Unmounts a given ISO image.
+    #
+    # vid - The virtual server ID in SolusVM
+    #
+    # Returns true if the ISO was unmounted successfully.
     def unmountiso(vid)
       perform_request(action: 'vserver-unmountiso', vserverid: vid)
     end

data/lib/solusvm/version.rb

@@ -1,3 +1,3 @@
-module Solusvm
-  VERSION = "1.4.0"
+module SolusVM
+  VERSION = "2.0.0.beta1"
 end

data/test/cli/test_base_cli.rb

@@ -1,15 +1,15 @@
 require 'test_helper'
 require 'solusvm/cli'
 
-class TestBaseCli < Test::Unit::TestCase
+class TestBaseCLI < Test::Unit::TestCase
 
   def setup
     # Prevents mocha from stubbing non existent methods so that we now if the CLI is failing because
     # something was moved around.
     Mocha::Configuration.prevent(:stubbing_non_existent_method)
 
-    @base_cli = Solusvm::BaseCli.new
-    @api      = Solusvm::Base.new
+    @base_cli = SolusVM::BaseCLI.new
+    @api      = SolusVM::Base.new
 
     @base_cli.stubs(:api).returns(@api)
   end
@@ -22,6 +22,16 @@ class TestBaseCli < Test::Unit::TestCase
     @base_cli.output(["val1", "val2"])
   end
 
+  def test_should_use_retry_middleware_if_retry_request
+    retry_middleware =  Faraday::Request.lookup_middleware :retry
+
+    @api = SolusVM::Base.new(solusvm_params.merge(retry_request: true))
+    assert_equal @api.conn.builder[0], retry_middleware
+
+    @api = SolusVM::Base.new(solusvm_params)
+    assert_not_equal @api.conn.builder[0], retry_middleware
+  end
+
   def test_should_print_error_if_not_successful
     @api.stubs(:successful?).returns(false)
     @api.stubs(:statusmsg).returns("the message")
@@ -29,4 +39,4 @@ class TestBaseCli < Test::Unit::TestCase
 
     @base_cli.output("result")
   end
-end
+end

data/test/cli/test_client_cli.rb

@@ -1,7 +1,7 @@
 require 'test_helper'
 require 'solusvm/cli'
 
-class TestClientCli < Test::Unit::TestCase
+class TestClientCLI < Test::Unit::TestCase
 
   def setup
     # Prevents mocha from stubbing non existent methods so that we now if the CLI is failing because
@@ -25,10 +25,10 @@ class TestClientCli < Test::Unit::TestCase
         expected.all? { |k,v| options[k] == v }
       end.returns("theresult")
     end
-    Solusvm::Client.expects(:new).with(solusvm_params).returns(api)
+    SolusVM::Client.expects(:new).with(solusvm_params).returns(api)
 
     $stdout.expects(:puts).with("theresult")
-    Solusvm::Cli.start(cli_expand_base_arguments([
+    SolusVM::CLI.start(cli_expand_base_arguments([
       "client", "create",
       "--username", "theusername",
       "--password", "thepassword",
@@ -40,52 +40,52 @@ class TestClientCli < Test::Unit::TestCase
   end
 
   def test_should_delegate_client_change_password_to_client
-    Solusvm::Client.expects(:new).with(solusvm_params).returns(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)
 
     $stdout.expects(:puts).with("theresult")
-    Solusvm::Cli.start(cli_expand_base_arguments(["client", "change-password", "theusername", "thepassword"]))
+    SolusVM::CLI.start(cli_expand_base_arguments(["client", "change-password", "theusername", "thepassword"]))
   end
 
   def test_should_delegate_client_authenticate_to_client
-    Solusvm::Client.expects(:new).with(solusvm_params).returns(mock do
+    SolusVM::Client.expects(:new).with(solusvm_params).returns(mock do
       expects(:successful?).returns(true)
       expects(:authenticate).with("theusername", "thepassword").returns("theresult")
     end)
 
     $stdout.expects(:puts).with("theresult")
-    Solusvm::Cli.start(cli_expand_base_arguments(["client", "authenticate", "theusername", "thepassword"]))
+    SolusVM::CLI.start(cli_expand_base_arguments(["client", "authenticate", "theusername", "thepassword"]))
   end
 
   def test_should_delegate_client_check_exists_to_client
-    Solusvm::Client.expects(:new).with(solusvm_params).returns(mock do
+    SolusVM::Client.expects(:new).with(solusvm_params).returns(mock do
       expects(:successful?).returns(true)
       expects(:exists?).with("theusername").returns("theresult")
     end)
 
     $stdout.expects(:puts).with("theresult")
-    Solusvm::Cli.start(cli_expand_base_arguments(["client", "check-exists", "theusername"]))
+    SolusVM::CLI.start(cli_expand_base_arguments(["client", "check-exists", "theusername"]))
   end
 
   def test_should_delegate_client_delete_to_client
-    Solusvm::Client.stubs(:new).with(solusvm_params).returns(mock do
+    SolusVM::Client.stubs(:new).with(solusvm_params).returns(mock do
       expects(:successful?).returns(true)
       expects(:delete).with("theusername").returns("theresult")
     end)
 
     $stdout.expects(:puts).with("theresult")
-    Solusvm::Cli.start(cli_expand_base_arguments(["client", "delete", "theusername"]))
+    SolusVM::CLI.start(cli_expand_base_arguments(["client", "delete", "theusername"]))
   end
 
   def test_should_delegate_client_list_to_client
-    Solusvm::Client.expects(:new).with(solusvm_params).returns(mock do
+    SolusVM::Client.expects(:new).with(solusvm_params).returns(mock do
       expects(:successful?).returns(true)
       expects(:list).returns("theresult")
     end)
 
     $stdout.expects(:puts).with("theresult")
-    Solusvm::Cli.start(cli_expand_base_arguments(["client", "list"]))
+    SolusVM::CLI.start(cli_expand_base_arguments(["client", "list"]))
   end
 end