solusvm 1.4.0 → 2.0.0.beta1

data/lib/solusvm/cli.rb

@@ -6,17 +6,17 @@ 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')
+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
+      say SolusVM::VERSION
     end
   end
 end

data/lib/solusvm/cli/base_cli.rb

@@ -3,8 +3,8 @@ require 'thor'
 require 'thor/group'
 require 'solusvm/version'
 
-module Solusvm
-  class BaseCli < Thor
+module SolusVM
+  class BaseCLI < Thor
     include Thor::Actions
 
     class << self
@@ -72,7 +72,7 @@ module Solusvm
     end
 
     def present_or_exit(options_key, default_option_key, message)
-      options[options_key] || BaseCli.default_option(default_option_key) || (say(message) && raise(SystemExit))
+      options[options_key] || BaseCLI.default_option(default_option_key) || (say(message) && raise(SystemExit))
     end
   end
 end

data/lib/solusvm/cli/client_cli.rb

@@ -1,5 +1,5 @@
-module Solusvm
-  class ClientCli < BaseCli
+module SolusVM
+  class ClientCLI < BaseCLI
 
     desc "create", "Creates a new h"
     method_option :username, type: :string, desc: "Username",  aliases: ["-u", "--username"]
@@ -40,9 +40,7 @@ module Solusvm
     private
 
     def api
-      @client ||= begin
-        Solusvm::Client.new(api_params())
-      end
+      @client ||= SolusVM::Client.new(api_params())
     end
   end
 end

data/lib/solusvm/cli/general_cli.rb

@@ -1,5 +1,5 @@
-module Solusvm
-  class GeneralCli < BaseCli
+module SolusVM
+  class GeneralCLI < BaseCLI
 
     desc "templates TYPE", "Lists existing templates for a given type [openvz|xen|xen hvm|kvm]"
     def templates(type)
@@ -19,9 +19,7 @@ module Solusvm
     private
 
     def api
-      @general ||= begin
-        Solusvm::General.new(api_params)
-      end
+      @general ||= SolusVM::General.new(api_params)
     end
   end
 end

data/lib/solusvm/cli/node_cli.rb

@@ -1,5 +1,5 @@
-module Solusvm
-  class NodeCli < BaseCli
+module SolusVM
+  class NodeCLI < BaseCLI
 
     desc "list TYPE", "Lists existing nodes for a given type [openvz|xen|xen hvm|kvm]"
     def list(type)
@@ -34,9 +34,7 @@ module Solusvm
     private
 
     def api
-      @node ||= begin
-        Solusvm::Node.new(api_params)
-      end
+      @node ||= SolusVM::Node.new(api_params)
     end
   end
 end

data/lib/solusvm/cli/reseller_cli.rb

@@ -1,5 +1,5 @@
-module Solusvm
-  class ResellerCli < BaseCli
+module SolusVM
+  class ResellerCLI < BaseCLI
 
     desc "create", "Creates a new reseller"
     method_option :username, type: :string, desc: "Username",  aliases: ["-u", "--username"]
@@ -64,9 +64,7 @@ module Solusvm
     private
 
     def api
-      @reseller ||= begin
-        Solusvm::Reseller.new(api_params)
-      end
+      @reseller ||= SolusVM::Reseller.new(api_params)
     end
   end
 end

data/lib/solusvm/cli/server_cli.rb

@@ -1,5 +1,5 @@
-module Solusvm
-  class ServerCli < BaseCli
+module SolusVM
+  class ServerCLI < BaseCLI
 
     desc "status VSERVERID", "Checks the status of a server"
     def status(vserverid)
@@ -135,7 +135,7 @@ module Solusvm
     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 :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"]
@@ -149,9 +149,7 @@ module Solusvm
     private
 
     def api
-      @server ||= begin
-        Solusvm::Server.new(api_params)
-      end
+      @server ||= SolusVM::Server.new(api_params)
     end
 
     def switch(vserverid, switch_value, on_method, off_method)

data/lib/solusvm/client.rb

@@ -1,49 +1,67 @@
-module Solusvm
-  # Solusvm::Client is the class for working with clients.
+module SolusVM
+  # SolusVM::Client is the class for working with clients.
   class Client < Base
-    # Creates a client.
+    # Public: Creates a client.
     #
-    # Options:
+    # options - A Hash of options:
+    #           :username
+    #           :password
+    #           :email
+    #           :firstname
+    #           :lastname
+    #           :company
     #
-    # * <tt>:username</tt>
-    # * <tt>:password</tt>
-    # * <tt>:email</tt>
-    # * <tt>:firstname</tt>
-    # * <tt>:lastname</tt>
-    # * <tt>:company</tt>
-    def create(options ={})
+    # Returns a Hash with the new client info, or false if the client was not
+    # created successfully.
+    def create(options = {})
       perform_request(options.merge(action: 'client-create')) && returned_parameters
     end
 
-    # Change client password for the solus admin.
+    # Public: Change client password for the Solus admin.
+    #
+    # username     - The client's username
+    # new_password - The new password
+    #
+    # Returns true if the client's password was successfully changed.
     def change_password(username, new_password)
-      perform_request({action: "client-updatepassword", username: username, password: new_password})
+      perform_request(action: "client-updatepassword", username: username, password: new_password)
     end
 
-    # Checks wether a specific client exists.
+    # Public: Checks if a specific client exists.
+    #
+    # username - The client's username
+    #
+    # Returns true if the client exists.
     def exists?(username)
-      perform_request({action: 'client-checkexists', username: 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.
+    # Public: Verify a client's login.
+    #
+    # username - The client's username
+    # password - The client's password
+    #
+    # Returns true if the given credentials are correct.
     def authenticate(username, password)
-      perform_request({action: 'client-authenticate', username: username, password: password})
+      perform_request(action: 'client-authenticate', username: username, password: password)
     end
 
-    # Deletes an existing client.
+    # Public: Deletes an existing client.
+    #
+    # username - The client's username
+    #
+    # Returns true if the client was successfully deleted.
     def delete(username)
-      perform_request({action: "client-delete", username: username})
+      perform_request(action: "client-delete", username: username)
     end
 
-    # Lists existing clients.
+    # Public: Lists existing clients.
+    #
+    # Returns an Array if clients were found, otherwise nil.
     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
+      perform_request(action: "client-list")
+      returned_parameters["clients"]
     end
   end
 end

data/lib/solusvm/errors.rb

@@ -0,0 +1,3 @@
+module SolusVM
+  class AuthenticationError < StandardError; end
+end

data/lib/solusvm/general.rb

@@ -1,12 +1,11 @@
-module Solusvm
-  # Solusvm::General is the class for retrieving general information.
+module SolusVM
+  # SolusVM::General is the class for retrieving general information.
   class General < Base
-
-    # Lists available templates.
+    # Public: Lists available templates.
     #
-    # Parameters:
+    # type - a valid virtualization type; e.g: [openvz|xen|xen hvm|kvm]
     #
-    # * +type+ - a valid virtualization type; e.g: [openvz|xen|xen hvm|kvm]
+    # Returns an Array.
     def templates(type)
       validate_server_type(type) do
         perform_request(action: 'listtemplates', type: type)
@@ -14,11 +13,11 @@ module Solusvm
       end
     end
 
-    # Lists available plans.
+    # Public: Lists available plans.
     #
-    # Parameters:
+    # type - a valid virtualization type; e.g: [openvz|xen|xen hvm|kvm]
     #
-    # * +type+ - a valid virtualization type; e.g: [openvz|xen|xen hvm|kvm]
+    # Returns an Array.
     def plans(type)
       validate_server_type(type) do
         perform_request(action: 'listplans', type: type)
@@ -26,11 +25,11 @@ module Solusvm
       end
     end
 
-    # Lists available isos.
+    # Public: Lists available ISOS.
     #
-    # Parameters:
+    # type - a valid virtualization type; e.g: [openvz|xen|xen hvm|kvm]
     #
-    # * +type+ - a valid virtualization type; e.g: [openvz|xen|xen hvm|kvm]
+    # Returns an Array.
     def isos(type)
       validate_server_type(type) do
         perform_request(action: 'listiso', type: type)

data/lib/solusvm/hash.rb

@@ -1,14 +1,4 @@
 class Hash
-  unless method_defined?(:to_query)
-    def to_query
-      elements = []
-      self.each do |key, value|
-        elements << "#{CGI::escape(key.to_s)}=#{CGI::escape(value.to_s)}"
-      end
-      elements.join('&')
-    end
-  end
-
   unless method_defined?(:reverse_merge)
     def reverse_merge(other_hash)
       other_hash.merge(self)
@@ -20,4 +10,4 @@ class Hash
       replace(reverse_merge(other_hash))
     end
   end
-end
+end

data/lib/solusvm/node.rb

@@ -1,12 +1,11 @@
-module Solusvm
-  # Solusvm::Node is the class for working with nodes.
+module SolusVM
+  # SolusVM::Node is the class for working with nodes.
   class Node < Base
-
-    # Lists existing nodes of a given type.
+    # Public: Lists existing nodes of a given type.
     #
-    # Parameters:
+    # type - a valid virtualization type; e.g: [openvz|xen|xen hvm|kvm]
     #
-    # * +type+ - a valid virtualization type; e.g: [openvz|xen|xen hvm|kvm]
+    # Returns an Array.
     def list(type)
       validate_server_type(type) do
         perform_request(action: 'listnodes', type: type)
@@ -14,7 +13,9 @@ module Solusvm
       end
     end
 
-    # Lists existing node groups
+    # Public: Lists existing node groups
+    #
+    # Returns an Array.
     def list_groups
       perform_request(action: 'listnodegroups')
 
@@ -22,11 +23,11 @@ module Solusvm
       returned_parameters['nodegroups'].to_s.split(',').map {|group| group.split('|')[1]}
     end
 
-    # Lists existing nodes ids of a given type.
+    # Public: Lists existing nodes ids of a given type.
     #
-    # Parameters:
+    # type - a valid virtualization type; e.g: [openvz|xen|xen hvm|kvm]
     #
-    # * +type+ - a valid virtualization type; e.g: [openvz|xen|xen hvm|kvm]
+    # Returns an Array.
     def ids(type)
       validate_server_type(type) do
         perform_request(action: 'node-idlist', type: type)
@@ -34,19 +35,31 @@ module Solusvm
       end
     end
 
-    # Retrieves statistics from a specific node.
+    # Public: Retrieves statistics from a specific node.
+    #
+    # nodeid - The node ID
+    #
+    # Returns a Hash.
     def statistics(nodeid)
       perform_request(action: 'node-statistics', nodeid: nodeid)
       returned_parameters
     end
 
     # Retrieves available xen resources from a specific node.
+    #
+    # nodeid - The node ID
+    #
+    # Returns a Hash.
     def xenresources(nodeid)
       perform_request(action: 'node-xenresources', nodeid: nodeid)
       returned_parameters
     end
 
-    # Retrieves a list of available IPs for a specific node.
+    # Public: Retrieves a list of available IPs for a specific node.
+    #
+    # nodeid - The node ID
+    #
+    # Returns an Array.
     def available_ips(nodeid)
       perform_request(action: 'node-iplist', nodeid: nodeid)
       if statusmsg.match /no available ip/i
@@ -56,15 +69,14 @@ module Solusvm
       end
     end
 
-    # Lists virtual servers from a specific node.
+    # Public: Lists virtual servers from a specific node.
+    #
+    # nodeid - The node ID
+    #
+    # Returns an Array if virtual servers were found, otherwise nil.
     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
+      perform_request(action: "node-virtualservers", nodeid: nodeid)
+      returned_parameters["virtualservers"]
     end
   end
-end
+end

data/lib/solusvm/reseller.rb

@@ -1,72 +1,76 @@
-module Solusvm
+module SolusVM
+  # SolusVM::Server is the class for working with reseller accounts.
   class Reseller < Base
-
-    # Creates a reseller.
+    # Public: Creates a reseller.
     #
-    # Options:
+    # options - A Hash of options:
+    #           :username
+    #           :password
+    #           :email
+    #           :firstname
+    #           :lastname
+    #           :company        - (optional)
+    #           :usernameprefix - prefix for reseller client usernames (optional)
+    #           :maxvps         - maximum amount of virtual servers (optional)
+    #           :maxusers       - maximum amount of users (optional)
+    #           :maxmem         - maximum amount memory (optional)
+    #           :maxburst       - maximum amount of burst memory or swapspace
+    #                             (optional)
+    #           :maxdisk        - maximum amount of diskspace (optional)
+    #           :maxbw          - maximum amount of bandwidth (optional)
+    #           :maxipv4        - maximum amount of ipv4 addresses (optional)
+    #           :maxipv6        - maximum amount of ipv6 addresses (optional)
+    #           :nodegroups     - comma separated list of node groups (optional)
+    #           :mediagroups    - comma separated list of media groups
+    #                             (optional)
+    #           :openvz         - y|n Allow building of openvz virtual servers
+    #                             (optional)
+    #           :xenpv          - y|n Allow building of xen pv virtual servers
+    #                             (optional)
+    #           :xenhvm         - y|n Allow building of xen hvm virtual servers
+    #                             (optional)
+    #           :kvm            - y|n Allow building of kvmvirtual servers
+    #                             (optional)
     #
-    # * <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 ={})
+    # Returns a Hash with the new client info, or false if the client was not
+    # created successfully.
+    def create(options = {})
       perform_request(options.merge(action: 'reseller-create')) && returned_parameters
     end
 
     # Changes the available resources for a specific reseller.
     #
-    # Options:
+    # options - A Hash of options, see `#create` for details
     #
-    # * <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={})
+    # Returns a Hash with the new reseller info, or false if the reseller was
+    # not created successfully.
+    def change_resources(username, options = {})
       perform_request(options.merge(action: 'reseller-modifyresources', username: username)) && returned_parameters
     end
 
-    # Retrieves information from an existing reseller.
+    # Public: Retrieves information from an existing reseller.
+    #
+    # username - The reseller's username
+    #
+    # Returns a Hash with the reseller info, or false if the reseller was not
+    # found.
     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.
+    # Public: Deletes an existing reseller.
+    #
+    # Returns true if the reseller was deleted.
     def delete(username)
-      perform_request({action: 'reseller-delete', username: username})
+      perform_request(action: 'reseller-delete', username: username)
     end
 
-    # Lists existing resellers.
+    # Public: Lists existing resellers.
+    #
+    # Returns an Array.
     def list
       perform_request(action: 'reseller-list')
       parse_returned_params_as_list('usernames')
     end
-
   end
-end
+end