solusvm 1.2.1 → 1.3.0

data/.travis.yml

@@ -7,11 +7,6 @@ notifications:
     on_success: never
     on_failure: always
 rvm:
-  - 1.8.7
   - 1.9.2
   - 1.9.3
-  - ree
-  - rbx-head
-  - rbx-18mode
-  - jruby-18mode
   - jruby-19mode

data/README.markdown

@@ -15,8 +15,7 @@ Rubinius 2.0, and JRuby 1.6.2.
 Basic Examples
 --------------
 
-    Solusvm.config('api_id', 'api_password', :url => 'http://www.example.com/api')
-    server = Solusvm::Server.new
+    server = Solusvm::Server.new(api_key: 'key', api_id: 'id', url: 'url')
 
     # 200 is the id of the virtual server
     server.shutdown(200) # => true
@@ -152,6 +151,7 @@ Contributors
 * [Maran H.](http://github.com/maran)
 * [Joshua Priddle](http://github.com/itspriddle)
 * [Vince Stratful](http://github.com/Vincepbell)
+* [Rubem Nakamura](http://github.com/rubemz)
 
 Note on Patches/Pull Requests
 -----------------------------
@@ -168,4 +168,4 @@ Note on Patches/Pull Requests
 Copyright
 ---------
 
-Copyright (c) 2010-2012 Site5.com. See LICENSE for details.
+Copyright (c) 2010-2013 Site5.com. See LICENSE for details.

data/lib/solusvm.rb

@@ -3,28 +3,6 @@ require 'rubygems'
 require 'xmlsimple'
 require 'faraday'
 
-module Solusvm
-  class << self
-    attr_accessor :api_endpoint, :api_id, :api_key, :api_options
-
-    # Specifies the login and url for making requests
-    #
-    # example:
-    #
-    #   Solusvm.config('id', 'key', :url => 'http://www.example.com/api', :logger => RAILS_LOGGER, :logger_method => :log_info)
-    #
-    # Options:
-    # * <tt>:logger</tt> - Log object used for logging API responses
-    # * <tt>:logger_method</tt> - The method that performs the logging on the Log object
-    def config(api_id, api_key, options={})
-      @api_id       = api_id
-      @api_key      = api_key
-      @api_endpoint = URI.parse(options.delete(:url))
-      @api_options  = options
-    end
-  end
-end
-
 require 'solusvm/hash'
 require 'solusvm/base'
 require 'solusvm/general'

data/lib/solusvm/base.rb

@@ -5,6 +5,10 @@ module Solusvm
 
     attr_reader :returned_parameters
 
+    def initialize(config = {})
+      @config = config
+    end
+
     # Prepares and sends the API request to the URL specificed in Solusvm.config
     #
     #  class MyClass < Base
@@ -20,9 +24,9 @@ module Solusvm
     # <tt>force_array</tt> - see parse_response
     def perform_request(options = {}, force_array = false)
       ca_path  = File.join(File.dirname(__FILE__), "..", "cacert.pem")
-      ssl      = {:verify => true, :ca_file => File.expand_path(ca_path)}
+      ssl      = {verify: true, ca_file: File.expand_path(ca_path)}
 
-      response = Faraday.new(:url => api_endpoint, :ssl => ssl) do |c|
+      response = Faraday.new(url: api_endpoint, ssl: ssl) do |c|
         c.params = options.merge(api_login)
         c.adapter :net_http
       end.get
@@ -74,20 +78,45 @@ module Solusvm
     #   my_class.create_server("example.com")
     #   my_class.successful? # => true
     def successful?
-      returned_parameters["status"] == "success"
+      returned_parameters["status"].nil? || returned_parameters["status"] == "success"
     end
 
-    # URI parsed API URL
+    # Returns the API endpoint set in the instance configuration. Otherwise,
+    # it returns the default configuration.
+    #
+    # Returns a String
     def api_endpoint
-      Solusvm.api_endpoint.dup
+      @config.fetch(:url)
+    end
+
+    # Returns the API id set in the instance configuration. Otherwise,
+    # it returns the default configuration.
+    #
+    # Returns a String
+    def api_id
+      @config.fetch(:api_id)
+    end
+
+    # Returns the API key set in the instance configuration. Otherwise,
+    # it returns the default configuration.
+    #
+    # Returns a String
+    def api_key
+      @config.fetch(:api_key)
+    end
+
+    def api_options(option)
+      if options = @config[:options]
+        options[option.to_sym]
+      end
     end
 
     def api_login
-      {:id => Solusvm.api_id, :key => Solusvm.api_key}
+      {id: api_id, key: api_key}
     end
 
     def log_messages(options)
-      logger, logger_method = Solusvm.api_options[:logger], Solusvm.api_options[:logger_method]
+      logger, logger_method = api_options(:logger), api_options(:logger_method)
 
       if logger && logger.respond_to?(logger_method)
         logger.send(logger_method, "[Start] => #{options[:action]}")
@@ -107,7 +136,7 @@ module Solusvm
     def validate_server_type(type, &block)
       type = type.strip
 
-      if valid = VALID_SERVER_TYPES.include?(type)
+      if VALID_SERVER_TYPES.include?(type)
         yield
       else
         @returned_parameters = {

data/lib/solusvm/cli/base_cli.rb

@@ -40,9 +40,9 @@ module Solusvm
     end
 
     # Default required options
-    class_option :api_login, :type => :string, :desc => "API ID; Required.",  :aliases => ["-I", "--api-login"]
-    class_option :api_key,   :type => :string, :desc => "API KEY; Required.", :aliases => ["-K", "--api-key"]
-    class_option :api_url,   :type => :string, :desc => "API URL; Required.", :aliases => ["-U", "--api-url"]
+    class_option :api_login, type: :string, desc: "API ID; Required.",  aliases: ["-I", "--api-login"]
+    class_option :api_key,   type: :string, desc: "API KEY; Required.", aliases: ["-K", "--api-key"]
+    class_option :api_url,   type: :string, desc: "API URL; Required.", aliases: ["-U", "--api-url"]
 
     no_tasks do
       def api
@@ -63,16 +63,16 @@ module Solusvm
 
     protected
 
-    def configure
-      Solusvm.config(
-        present_or_exit(:api_login, :id, "api_login required"),
-        present_or_exit(:api_key, :key, "api_key required"),
-        :url => present_or_exit(:api_url, :url, "api_url required")
-      )
+    def api_params()
+      {
+        api_id: present_or_exit(:api_login, :id, "api_login required"),
+        api_key: present_or_exit(:api_key, :key, "api_key required"),
+        url: present_or_exit(:api_url, :url, "api_url required")
+      }
     end
 
     def present_or_exit(options_key, default_option_key, message)
       options[options_key] || BaseCli.default_option(default_option_key) || (say(message) && raise(SystemExit))
     end
   end
-end
+end

data/lib/solusvm/cli/client_cli.rb

@@ -2,12 +2,12 @@ module Solusvm
   class ClientCli < BaseCli
 
     desc "create", "Creates a new h"
-    method_option :username, :type => :string, :desc => "Username",  :aliases => ["-u", "--username"]
-    method_option :password, :type => :string, :desc => "Password",  :aliases => ["-p", "--password"]
-    method_option :email, :type => :string, :desc => "Email",  :aliases => ["-e", "--email"]
-    method_option :firstname, :type => :string, :desc => "Firstname",  :aliases => ["-f", "--firstname"]
-    method_option :lastname, :type => :string, :desc => "Lastname",  :aliases => ["-l", "--lastname"]
-    method_option :company, :type => :string, :desc => "Company",  :aliases => ["-c", "--company"]
+    method_option :username, type: :string, desc: "Username",  aliases: ["-u", "--username"]
+    method_option :password, type: :string, desc: "Password",  aliases: ["-p", "--password"]
+    method_option :email, type: :string, desc: "Email",  aliases: ["-e", "--email"]
+    method_option :firstname, type: :string, desc: "Firstname",  aliases: ["-f", "--firstname"]
+    method_option :lastname, type: :string, desc: "Lastname",  aliases: ["-l", "--lastname"]
+    method_option :company, type: :string, desc: "Company",  aliases: ["-c", "--company"]
     def create
       output api.create(options)
     end
@@ -41,9 +41,8 @@ module Solusvm
 
     def api
       @client ||= begin
-        configure
-        Solusvm::Client.new
+        Solusvm::Client.new(api_params())
       end
     end
   end
-end
+end

data/lib/solusvm/cli/general_cli.rb

@@ -20,9 +20,8 @@ module Solusvm
 
     def api
       @general ||= begin
-        configure
-        Solusvm::General.new
+        Solusvm::General.new(api_params)
       end
     end
   end
-end
+end

data/lib/solusvm/cli/node_cli.rb

@@ -35,9 +35,8 @@ module Solusvm
 
     def api
       @node ||= begin
-        configure
-        Solusvm::Node.new
+        Solusvm::Node.new(api_params)
       end
     end
   end
-end
+end

data/lib/solusvm/cli/reseller_cli.rb

@@ -2,46 +2,46 @@ module Solusvm
   class ResellerCli < BaseCli
 
     desc "create", "Creates a new reseller"
-    method_option :username, :type => :string, :desc => "Username",  :aliases => ["-u", "--username"]
-    method_option :password, :type => :string, :desc => "Password",  :aliases => ["-p", "--password"]
-    method_option :email, :type => :string, :desc => "Email",  :aliases => ["-e", "--email"]
-    method_option :firstname, :type => :string, :desc => "Firstname",  :aliases => ["-f", "--firstname"]
-    method_option :lastname, :type => :string, :desc => "Lastname",  :aliases => ["-l", "--lastname"]
-    method_option :company, :type => :string, :desc => "Company",  :aliases => ["-c", "--company"]
-    method_option :usernameprefix, :type => :string, :desc => "Prefix for reseller client usernames (optional)",  :aliases => ["-up", "--usernameprefix"]
-    method_option :maxvps, :type => :string, :desc => "Maximum amount of virtual servers (optional)",  :aliases => ["-mvps", "--maxvps"]
-    method_option :maxusers, :type => :string, :desc => "Maximum amount of users (optional)",  :aliases => ["-mu", "--maxusers"]
-    method_option :maxmem, :type => :string, :desc => "Maximum amount of memory (optional)",  :aliases => ["-mm", "--maxmem"]
-    method_option :maxburst, :type => :string, :desc => "Maximum amount of burst memory or swapspace (optional)",  :aliases => ["-mb", "--maxburst"]
-    method_option :maxbw, :type => :string, :desc => "Maximum amount of bandwith (optional)",  :aliases => ["-mb", "--maxbw"]
-    method_option :maxdisk, :type => :string, :desc => "Maximum amount of disk (optional)",  :aliases => ["-mb", "--maxdisk"]
-    method_option :maxipv4, :type => :string, :desc => "Maximum amount of ipv4 addresses (optional)",  :aliases => ["-mipv4", "--maxipv4"]
-    method_option :maxipv6, :type => :string, :desc => "Maximum amount of ipv6 addresses (optional)",  :aliases => ["-mipv6", "--maxipv6"]
-    method_option :nodegroups, :type => :string, :desc => "Comma separated list of node groups (optional)",  :aliases => ["-ng", "--nodegroups"]
-    method_option :mediagroups, :type => :string, :desc => "Comma separated list of media groups (optional)",  :aliases => ["-mg", "--mediagroups"]
-    method_option :openvz, :type => :string, :desc => "y|n Allow building of openvz virtual servers (optional)",  :aliases => ["-ovz", "--openvz"]
-    method_option :xenpv, :type => :string, :desc => "y|n Allow building of xen pv virtual servers (optional)",  :aliases => ["-xpv", "--xenpv"]
-    method_option :xenhvm, :type => :string, :desc => "y|n Allow building of xen hvm virtual servers (optional)",  :aliases => ["-xhvm", "--xenhvm"]
-    method_option :kvm, :type => :string, :desc => "y|n Allow building of kvmvirtual servers (optional)",  :aliases => ["-kvm"]
+    method_option :username, type: :string, desc: "Username",  aliases: ["-u", "--username"]
+    method_option :password, type: :string, desc: "Password",  aliases: ["-p", "--password"]
+    method_option :email, type: :string, desc: "Email",  aliases: ["-e", "--email"]
+    method_option :firstname, type: :string, desc: "Firstname",  aliases: ["-f", "--firstname"]
+    method_option :lastname, type: :string, desc: "Lastname",  aliases: ["-l", "--lastname"]
+    method_option :company, type: :string, desc: "Company",  aliases: ["-c", "--company"]
+    method_option :usernameprefix, type: :string, desc: "Prefix for reseller client usernames (optional)",  aliases: ["-up", "--usernameprefix"]
+    method_option :maxvps, type: :string, desc: "Maximum amount of virtual servers (optional)",  aliases: ["-mvps", "--maxvps"]
+    method_option :maxusers, type: :string, desc: "Maximum amount of users (optional)",  aliases: ["-mu", "--maxusers"]
+    method_option :maxmem, type: :string, desc: "Maximum amount of memory (optional)",  aliases: ["-mm", "--maxmem"]
+    method_option :maxburst, type: :string, desc: "Maximum amount of burst memory or swapspace (optional)",  aliases: ["-mb", "--maxburst"]
+    method_option :maxbw, type: :string, desc: "Maximum amount of bandwith (optional)",  aliases: ["-mb", "--maxbw"]
+    method_option :maxdisk, type: :string, desc: "Maximum amount of disk (optional)",  aliases: ["-mb", "--maxdisk"]
+    method_option :maxipv4, type: :string, desc: "Maximum amount of ipv4 addresses (optional)",  aliases: ["-mipv4", "--maxipv4"]
+    method_option :maxipv6, type: :string, desc: "Maximum amount of ipv6 addresses (optional)",  aliases: ["-mipv6", "--maxipv6"]
+    method_option :nodegroups, type: :string, desc: "Comma separated list of node groups (optional)",  aliases: ["-ng", "--nodegroups"]
+    method_option :mediagroups, type: :string, desc: "Comma separated list of media groups (optional)",  aliases: ["-mg", "--mediagroups"]
+    method_option :openvz, type: :string, desc: "y|n Allow building of openvz virtual servers (optional)",  aliases: ["-ovz", "--openvz"]
+    method_option :xenpv, type: :string, desc: "y|n Allow building of xen pv virtual servers (optional)",  aliases: ["-xpv", "--xenpv"]
+    method_option :xenhvm, type: :string, desc: "y|n Allow building of xen hvm virtual servers (optional)",  aliases: ["-xhvm", "--xenhvm"]
+    method_option :kvm, type: :string, desc: "y|n Allow building of kvmvirtual servers (optional)",  aliases: ["-kvm"]
     def create
       output api.create(options)
     end
 
     desc "change", "Changes the available resources of a reseller"
-    method_option :maxvps, :type => :string, :desc => "Maximum amount of virtual servers (optional)",  :aliases => ["-mvps", "--maxvps"]
-    method_option :maxusers, :type => :string, :desc => "Maximum amount of users (optional)",  :aliases => ["-mu", "--maxusers"]
-    method_option :maxmem, :type => :string, :desc => "Maximum amount of memory (optional)",  :aliases => ["-mm", "--maxmem"]
-    method_option :maxburst, :type => :string, :desc => "Maximum amount of burst memory or swapspace (optional)",  :aliases => ["-mb", "--maxburst"]
-    method_option :maxbw, :type => :string, :desc => "Maximum amount of bandwith (optional)",  :aliases => ["-mb", "--maxbw"]
-    method_option :maxdisk, :type => :string, :desc => "Maximum amount of disk (optional)",  :aliases => ["-mb", "--maxdisk"]
-    method_option :maxipv4, :type => :string, :desc => "Maximum amount of ipv4 addresses (optional)",  :aliases => ["-mipv4", "--maxipv4"]
-    method_option :maxipv6, :type => :string, :desc => "Maximum amount of ipv6 addresses (optional)",  :aliases => ["-mipv6", "--maxipv6"]
-    method_option :nodegroups, :type => :string, :desc => "Comma separated list of node groups (optional)",  :aliases => ["-ng", "--nodegroups"]
-    method_option :mediagroups, :type => :string, :desc => "Comma separated list of media groups (optional)",  :aliases => ["-mg", "--mediagroups"]
-    method_option :openvz, :type => :string, :desc => "y|n Allow building of openvz virtual servers (optional)",  :aliases => ["-ovz", "--openvz"]
-    method_option :xenpv, :type => :string, :desc => "y|n Allow building of xen pv virtual servers (optional)",  :aliases => ["-xpv", "--xenpv"]
-    method_option :xenhvm, :type => :string, :desc => "y|n Allow building of xen hvm virtual servers (optional)",  :aliases => ["-xhvm", "--xenhvm"]
-    method_option :kvm, :type => :string, :desc => "y|n Allow building of kvmvirtual servers (optional)",  :aliases => ["-kvm"]
+    method_option :maxvps, type: :string, desc: "Maximum amount of virtual servers (optional)",  aliases: ["-mvps", "--maxvps"]
+    method_option :maxusers, type: :string, desc: "Maximum amount of users (optional)",  aliases: ["-mu", "--maxusers"]
+    method_option :maxmem, type: :string, desc: "Maximum amount of memory (optional)",  aliases: ["-mm", "--maxmem"]
+    method_option :maxburst, type: :string, desc: "Maximum amount of burst memory or swapspace (optional)",  aliases: ["-mb", "--maxburst"]
+    method_option :maxbw, type: :string, desc: "Maximum amount of bandwith (optional)",  aliases: ["-mb", "--maxbw"]
+    method_option :maxdisk, type: :string, desc: "Maximum amount of disk (optional)",  aliases: ["-mb", "--maxdisk"]
+    method_option :maxipv4, type: :string, desc: "Maximum amount of ipv4 addresses (optional)",  aliases: ["-mipv4", "--maxipv4"]
+    method_option :maxipv6, type: :string, desc: "Maximum amount of ipv6 addresses (optional)",  aliases: ["-mipv6", "--maxipv6"]
+    method_option :nodegroups, type: :string, desc: "Comma separated list of node groups (optional)",  aliases: ["-ng", "--nodegroups"]
+    method_option :mediagroups, type: :string, desc: "Comma separated list of media groups (optional)",  aliases: ["-mg", "--mediagroups"]
+    method_option :openvz, type: :string, desc: "y|n Allow building of openvz virtual servers (optional)",  aliases: ["-ovz", "--openvz"]
+    method_option :xenpv, type: :string, desc: "y|n Allow building of xen pv virtual servers (optional)",  aliases: ["-xpv", "--xenpv"]
+    method_option :xenhvm, type: :string, desc: "y|n Allow building of xen hvm virtual servers (optional)",  aliases: ["-xhvm", "--xenhvm"]
+    method_option :kvm, type: :string, desc: "y|n Allow building of kvmvirtual servers (optional)",  aliases: ["-kvm"]
     def change_resources
       output api.change_resources(options)
     end
@@ -65,9 +65,8 @@ module Solusvm
 
     def api
       @reseller ||= begin
-        configure
-        Solusvm::Reseller.new
+        Solusvm::Reseller.new(api_params)
       end
     end
   end
-end
+end

data/lib/solusvm/cli/server_cli.rb

@@ -102,9 +102,9 @@ module Solusvm
     end
 
     desc "rebuild VSERVERID", "Rebuilds a server"
-    method_option :template, :type => :string, :desc => "VPS template to boot from",  :aliases => ["-t", "--template"]
+    method_option :template, type: :string, desc: "VPS template to boot from",  aliases: ["-t", "--template"]
     def rebuild(vserverid)
-      output api.rebuild(vserverid, {:template => options[:template]})
+      output api.rebuild(vserverid, {template: options[:template]})
     end
 
     desc "tun-switcher VSERVERID SWITCH(on|off)", "Enable/Disable TUN/TAP"
@@ -133,16 +133,16 @@ module Solusvm
     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"]
+    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)
       output api.create(hostname, password, {
-        :plan => options[:plan], :ips => options[:ips], :type => options[:kind],
-        :username => options[:username], :template => options[:template], :node => options[:node]
+        plan: options[:plan], ips: options[:ips], type: options[:kind],
+        username: options[:username], template: options[:template], node: options[:node]
       })
     end
 
@@ -150,8 +150,7 @@ module Solusvm
 
     def api
       @server ||= begin
-        configure
-        Solusvm::Server.new
+        Solusvm::Server.new(api_params)
       end
     end
 
@@ -165,4 +164,4 @@ module Solusvm
       end
     end
   end
-end
+end

data/lib/solusvm/client.rb

@@ -12,32 +12,32 @@ module Solusvm
     # * <tt>:lastname</tt>
     # * <tt>:company</tt>
     def create(options ={})
-      perform_request(options.merge(:action => 'client-create')) && returned_parameters
+      perform_request(options.merge(action: 'client-create')) && returned_parameters
     end
 
     # Change client password for the solus admin.
     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.
     def exists?(username)
-      perform_request({:action => 'client-checkexists', :username => username})
+      perform_request({action: 'client-checkexists', username: username})
     end
 
     # 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})
+      perform_request({action: 'client-authenticate', username: username, password: password})
     end
 
     # Deletes an existing client.
     def delete(username)
-      perform_request({:action => "client-delete", :username => username})
+      perform_request({action: "client-delete", username: username})
     end
 
     # Lists existing clients.
     def list
-      perform_request({:action => "client-list"}, "client")
+      perform_request({action: "client-list"}, "client")
 
       if returned_parameters["clients"] && returned_parameters["clients"]["client"]
         returned_parameters["clients"]["client"]

data/lib/solusvm/general.rb

@@ -9,7 +9,7 @@ module Solusvm
     # * +type+ - a valid virtualization type; e.g: [openvz|xen|xen hvm|kvm]
     def templates(type)
       validate_server_type(type) do
-        perform_request(:action => 'listtemplates', :type => type)
+        perform_request(action: 'listtemplates', type: type)
         parse_returned_params_as_list('templates')
       end
     end
@@ -21,7 +21,7 @@ module Solusvm
     # * +type+ - a valid virtualization type; e.g: [openvz|xen|xen hvm|kvm]
     def plans(type)
       validate_server_type(type) do
-        perform_request(:action => 'listplans', :type => type)
+        perform_request(action: 'listplans', type: type)
         parse_returned_params_as_list('plans')
       end
     end
@@ -33,7 +33,7 @@ module Solusvm
     # * +type+ - a valid virtualization type; e.g: [openvz|xen|xen hvm|kvm]
     def isos(type)
       validate_server_type(type) do
-        perform_request(:action => 'listiso', :type => type)
+        perform_request(action: 'listiso', type: type)
         parse_returned_params_as_list('iso')
       end
     end