voxxit-whm_xml 0.3.0

data/README.rdoc

@@ -0,0 +1,87 @@
+= WHM XML-API Ruby Wrapper
+
+This is a Ruby wrapper for the cPanel WHM XML-API interface. It will allow you to perform multiple functions available on your cPanel WHM server. For more information on the XML-API, see the cPanel website at http://twiki.cpanel.net/twiki/bin/view/AllDocumentation/AutomationIntegration/XmlApi.
+
+== Requirements
+
+The following Ruby gems are required to be installed in order to make use this gem:
+
+xml-simple (>= 1.0.12)::      http://xml-simple.rubyforge.org
+activesupport (>= 2.3.2)::    http://as.rubyonrails.org
+curb (>= 0.3.2)::             http://curb.rubyforge.org
+validatable (>= 1.6.7)::      http://validatable.rubyforge.org
+
+== Usage
+
+First off, you must have root access to a cPanel WHM server. With this gem, you can either use <b>password</b> or <b>remote access key</b> authentication. To get to the remote access key in WHM (which is likely the more secure method of connecting), go under "Cluster/Remote Access", and click on "Setup Remote Access Key". You can either copy the pre-generated one, or re-generate it.
+
+==== Installation
+
+You can install this gem simply by doing the following:
+
+    $ gem sources -a http://gems.github.com
+    $ gem install ivanoats-whm_xml_api_ruby
+
+You can also include it in a Rails project:
+
+    $ script/plugin install git://github.com/ivanoats/whm_xml_api_ruby.git
+
+==== Connecting
+
+To access the functions of the server, all you need to do is initialize a new Server class:
+
+    server = Whm::Server.new(
+      :username => "root",
+      :remote_access_key => "sd00fsd2i3rj...",
+      :host => "dedicated.server.com"
+    )
+    
+    server.version
+    => "11.24.2"
+    
+== Currently Available Methods
+
+As of WHM version 11.24.2, these are the methods that are available via this gem:
+
+* <tt>account_summary</tt>
+* <tt>change_account_password</tt>
+* <tt>change_package</tt>
+* <tt>create_account</tt>
+* <tt>generate_ssl_certificate</tt>
+* <tt>hostname</tt>
+* <tt>limit_bandwidth_usage</tt>
+* <tt>list_accounts</tt>
+* <tt>list_packages</tt>
+* <tt>modify_account</tt>
+* <tt>suspend_account</tt>
+* <tt>terminate_account</tt>
+* <tt>unsuspend_account</tt>
+* <tt>version</tt>
+
+== Authors and credits
+
+Authors::     Ivan Storck, Josh Delsman, Padraic McGee
+Home page::   http://github.com/ivanoats/whm_xml_api_ruby
+
+== License
+
+Copyright (c) 2008-2009 Ivan Storck
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,11 @@
+require 'rubygems'
+require 'rake/rdoctask'
+
+desc 'Generate documentation for whm_xml_api_ruby'
+Rake::RDocTask.new do |rd|
+  rd.rdoc_dir = 'html'
+  rd.rdoc_files.include("README.rdoc", "lib/**/*.rb")
+  rd.main = "README.rdoc"
+  rd.title = "whm_xml_api_ruby -- A Ruby wrapper for cPanel's WHM"
+  rd.options << "--all"
+end

data/lib/parameters.rb

@@ -0,0 +1,67 @@
+module Whm #:nodoc:
+  # Allows for parameter requirements and validations for methods
+  module Parameters
+    # Check the included hash for the included parameters, and ensure they aren't blank.
+    #
+    # ==== Example
+    # 
+    #    class User
+    #      def initialize
+    #        requires!(options, :username, :password)
+    #      end
+    #    end
+    #
+    #    >> User.new
+    #    ArgumentError: Missing required parameter: username
+    #
+    #    >> User.new(:username => "john")
+    #    ArgumentError: Missing required parameter: password
+    def requires!(hash, *params)
+      params.each do |param| 
+        if param.is_a?(Array)
+          raise ArgumentError.new("Missing required parameter: #{param.first}") unless hash.has_key?(param.first) 
+          raise ArgumentError.new("Required parameter cannot be blank: #{param.first}") if hash[param.first].blank?
+        else
+          raise ArgumentError.new("Missing required parameter: #{param}") unless hash.has_key?(param) 
+          raise ArgumentError.new("Required parameter cannot be blank: #{param}") if hash[param].blank?
+        end
+      end
+    end
+    
+    # Checks to see if supplied params (which are booleans) contain
+    # either a 1 ("Yes") or 0 ("No") value.
+    def booleans!(hash, *params)
+      params.each do |param|
+        if param.is_a?(Array)
+          raise ArgumentError.new("Boolean parameter must be \"1\" or \"0\": #{param.first}") unless hash[param.first].to_s.match(/(1|0)/)          
+        else
+          raise ArgumentError.new("Boolean parameter must be \"1\" or \"0\": #{param}") unless hash[param].to_s.match(/(1|0)/)
+        end
+      end
+    end
+    
+    # Checks the hash to see if the hash includes any parameter
+    # which is not included in the list of valid parameters.
+    #
+    # ==== Example
+    #
+    #    class User
+    #      def initialize
+    #        valid_options!(options, :username)
+    #      end
+    #    end
+    #
+    #    >> User.new(:username => "josh")
+    #    => #<User:0x18a1190 @username="josh">
+    #
+    #    >> User.new(:username => "josh", :credit_card => "5105105105105100")
+    #    ArgumentError: Not a valid parameter: credit_card
+    def valid_options!(hash, *params)
+      keys = hash.keys
+      
+      keys.each do |key|
+        raise ArgumentError.new("Not a valid parameter: #{key}") unless params.include?(key)
+      end
+    end  
+  end
+end

data/lib/whm_xml.rb

@@ -0,0 +1,16 @@
+$:.unshift(File.dirname(__FILE__))
+
+require 'rubygems'
+require 'curb'            # As opposed to Net::HTTP (for faster requests)
+require 'xmlsimple'       # For simple XML parsing
+require 'active_support'  # For stringifying keys, etc.
+require 'parameters'      # For parameter requirements in methods
+require 'validatable'     # For object validation
+
+require 'whm_xml/exceptions'
+require 'whm_xml/server'
+require 'whm_xml/account'
+
+module Whm
+  VERSION = '0.3.0'
+end

data/lib/whm_xml/exceptions.rb

@@ -0,0 +1,4 @@
+module Whm #:nodoc:
+  class CommandFailedError < StandardError #:nodoc:
+  end
+end

data/lib/whm_xml/server.rb

@@ -0,0 +1,326 @@
+module Whm #:nodoc:
+  # The Server class initializes a new connection with the cPanel WHM server, and 
+  # contains all functions that can be run on a cPanel WHM server as of version 11.24.2.
+  class Server
+    include Parameters
+
+    # Hostname of the WHM server (e.g., <tt>dedicated.server.com</tt>)
+    attr_reader :host
+    
+    # WHM XML-API username
+    attr_reader :username
+    
+    # WHM XML-API password. Use this, or the remote key, to authenticate with the server
+    attr_reader :password
+    
+    # WHM XML-API remote key. Use this, or the password, to authenticate with the server
+    attr_reader :remote_key
+    
+    # If you'd like increased verbosity of commands, set this to <tt>true</tt>. Defaults to <tt>false</tt>
+    attr_accessor :debug
+    
+    attr_accessor :attributes
+    
+    # Initialize the connection with WHM using the hostname, 
+    # user and password/remote key. Will default to asking for 
+    # a password, but remote_key is required if a password 
+    # is not used.
+    #
+    # ==== Example
+    #
+    # Password authentication with debugging enabled:
+    #
+    #    Whm::Server.new(
+    #      :host => "dedicated.server.com",
+    #      :username => "root",
+    #      :password => "s3cUr3!p@5sw0rD",
+    #      :debug => true
+    #    )
+    #
+    # Remote key authentication with port 8000, and SSL to off (defaults to port 2087, and SSL on):
+    #
+    #    Whm::Server.new(
+    #      :host => "dedicated.server.com",
+    #      :username => "root",
+    #      :remote_key => "cf975b8930b0d0da69764c5d8dc8cf82 ...",
+    #      :port => 8000,
+    #      :ssl => false
+    #    )
+    def initialize(options = {})
+      requires!(options, :host, :username)
+      requires!(options, :password) unless options[:remote_key]
+      
+      @host       = options[:host]
+      @username   = options[:username] || "root"
+      @remote_key = options[:remote_key].gsub(/(\r|\n)/, "") unless options[:password]
+      @password   = options[:password] unless options[:remote_key]
+      @debug      = options[:debug] || false
+      @port       = options[:port] || 2087
+      @ssl        = options[:ssl] || true
+    end
+
+    # Displays pertient account information for a specific account.
+    #
+    # ==== Options
+    # * <tt>:user</tt> - Username associated with the acount to display (string)
+    def account_summary(options = {})
+      requires!(options, :user)
+      
+      data = get_xml(:url => "accountsummary", :params => options)
+      check_for_cpanel_errors_on(data)["acct"]
+    end
+    
+    # Changes the password of a domain owner (cPanel) or reseller (WHM) account.
+    #
+    # ==== Options
+    # * <tt>:user</tt> - Username of the user whose password should be changed (string)
+    # * <tt>:pass</tt> - New password for that user (string)
+    def change_account_password(options = {})
+      requires!(options, :user, :pass)
+      
+      data = get_xml(:url => "passwd", :params => options)
+	    check_for_cpanel_errors_on(data)["passwd"]
+    end
+    
+    # Changes the hosting package associated with an account.
+    # Returns <tt>true</tt> if it is successful, or 
+    # <tt>false</tt> if it is not.
+    #
+    # ==== Options
+    # * <tt>:user</tt> - Username of the account to change the package for (string)
+    # * <tt>:pkg</tt> - Name of the package that the account should use (string)
+    def change_package(options = {})
+      requires!(options, :user, :pkg)
+      
+      data = get_xml(:url => "changepackage", :params => options)
+      check_for_cpanel_errors_on(data)
+      
+      data["status"] == "1" ? true : false
+    end
+    
+    # Creates a hosting account and sets up it's associated domain information.
+    #
+    # ==== Options
+    # * <tt>:username</tt> - Username of the account (string)
+    # * <tt>:domain</tt> - Domain name (string)
+    # * <tt>:pkgname</tt> - Name of a new package to be created based on the settings used (string)
+    # * <tt>:savepkg</tt> - Save the settings used as a new package (boolean)
+    # * <tt>:featurelist</tt> - Name of the feature list to be used when creating a new package (string)
+    # * <tt>:quota</tt> - Disk space quota in MB. Must be between 0-999999, with 0 being unlimited (integer)
+    # * <tt>:password</tt> - User's password to access cPanel (string)
+    # * <tt>:ip</tt> - Whether or not the domain has a dedicated IP address, either <tt>"y"</tt> (Yes) or <tt>"n"</tt> (No) (string)
+    # * <tt>:cgi</tt> - Whether or not the domain has CGI access (boolean)
+    # * <tt>:frontpage</tt> - Whether or not the domain has FrontPage extensions installed (boolean)
+    # * <tt>:hasshell</tt> - Whether or not the domain has shell/SSH access (boolean)
+    # * <tt>:contactemail</tt> - Contact email address for the account (string)
+    # * <tt>:cpmod</tt> - cPanel theme name (string)
+    # * <tt>:maxftp</tt> - Maximum number of FTP accounts the user can create. Must be between 0-999999, with 0 being unlimited (integer)
+    # * <tt>:maxsql</tt> - Maximum number of SQL databases the user can create. Must be between 0-999999, with 0 being unlimited (integer)
+    # * <tt>:maxpop</tt> - Maximum number of email accounts the user can create. Must be between 0-999999, with 0 being unlimited (integer)
+    # * <tt>:maxlst</tt> - Maximum number of mailing lists the user can create. Must be between 0-999999, with 0 being unlimited (integer)
+    # * <tt>:maxsub</tt> - Maximum number of subdomains the user can create. Must be between 0-999999, with 0 being unlimited (integer)
+    # * <tt>:maxpark</tt> - Maximum number of parked domains the user can create. Must be between 0-999999, with 0 being unlimited (integer)
+    # * <tt>:maxaddon</tt> - Maximum number of addon domains the user can create. Must be between 0-999999, with 0 being unlimited (integer)
+    # * <tt>:bwlimit</tt> - Bandwidth limit in MB. Must be between 0-999999, with 0 being unlimited (integer)
+    # * <tt>:customip</tt> - Specific IP for the site (string)
+    # * <tt>:language</tt> - Language to use in the account's cPanel interface (string)
+    # * <tt>:useregns</tt> - Use the registered nameservers for the domain instead of the ones configured on the server (boolean)
+    # * <tt>:hasuseregns</tt> - Must be set to <tt>1</tt> if the above <tt>:useregns</tt> is set to <tt>1</tt> (boolean)
+    # * <tt>:reseller</tt> - Give reseller privileges to the account (boolean)
+    def create_account(options = {})
+      requires!(options, :domain, :username)
+      
+	    data = get_xml(:url => "createacct", :params => options)
+	    check_for_cpanel_errors_on(data)
+    end
+    
+    # Generates an SSL certificate
+    #
+    # ==== Options
+    # * <tt>:xemail</tt> - Email address of the domain owner (string)
+    # * <tt>:host</tt> - Domain the SSL certificate is for, or the SSL host (string)
+    # * <tt>:country</tt> - Country the organization is located in (string)
+    # * <tt>:state</tt> - State the organization is located in (string)
+    # * <tt>:city</tt> - City the organization is located in (string)
+    # * <tt>:co</tt> - Name of the organization/company (string)
+    # * <tt>:cod</tt> - Name of the department (string)
+    # * <tt>:email</tt> - Email to send the certificate to (string)
+    # * <tt>:pass</tt> - Certificate password (string)
+    def generate_ssl_certificate(options = {})
+      requires!(options, :city, :co, :cod, :country, :email, :host, :pass, :state, :xemail)
+      data = get_xml(:url => "generatessl", :params => options)
+      check_for_cpanel_errors_on(data)
+    end
+    
+    # Displays the server's hostname.
+    def hostname      
+      data = get_xml(:url => "gethostname")
+      check_for_cpanel_errors_on(data)["hostname"]
+    end
+    
+    # Modifies the bandwidth usage (transfer) limit for a specific account.
+    #
+    # ==== Options
+    # * <tt>:user</tt> - Name of user to modify the bandwidth usage (transfer) limit for (string)
+    # * <tt>:bwlimit</tt> - Bandwidth usage (transfer) limit in MB (string)
+    def limit_bandwidth_usage(options = {})
+      requires!(options, :user, :bwlimit)
+      
+      data = get_xml(:url => "limitbw", :params => options)
+      check_for_cpanel_errors_on(data)["bwlimit"]
+    end
+    
+    # Lists all accounts on the server, or allows you to search for 
+    # a specific account or set of accounts.
+    #
+    # ==== Options
+    # * <tt>:searchtype</tt> - Type of account search (<tt>"domain"</tt>, <tt>"owner"</tt>, <tt>"user"</tt>, <tt>"ip"</tt> or <tt>"package"</tt>)
+    # * <tt>:search</tt> - Search criteria, in Perl regular expression format (string)
+    def list_accounts(options = {})
+      data = get_xml(:url => "listaccts", :params => options)
+      check_for_cpanel_errors_on(data)["acct"]
+    end
+    
+    # Lists all hosting packages that are available for use by 
+    # the current WHM user. If the current user is a reseller, 
+    # they may not see some packages that exist if those packages 
+    # are not available to be used for account creation at this time.
+    def list_packages
+      data = get_xml(:url => "listpkgs")
+      check_for_cpanel_errors_on(data)["package"]
+    end
+    
+    # Modifies account specific settings. We recommend changing the 
+    # account's package instead with change_package. If the account 
+    # is associated with a package, the account's settings will be 
+    # changed whenever the package is changed. That may overwrite 
+    # any changes you make with this function.
+    #
+    # ==== Options
+    # * <tt>:CPTHEME</tt> - cPanel theme name (string)
+    # * <tt>:domain</tt> - Domain name (string)
+    # * <tt>:HASCGI</tt> - Whether or not the domain has CGI access (boolean)
+    # * <tt>:LANG</tt> - Language to use in the account's cPanel interface (boolean)
+    # * <tt>:MAXFTP</tt> - Maximum number of FTP accounts the user can create. Must be between 0-999999, with 0 being unlimited (integer)
+    # * <tt>:MAXSQL</tt> - Maximum number of SQL databases the user can create. Must be between 0-999999, with 0 being unlimited (integer)
+    # * <tt>:MAXPOP</tt> - Maximum number of email accounts the user can create. Must be between 0-999999, with 0 being unlimited (integer)
+    # * <tt>:MAXLST</tt> - Maximum number of mailing lists the user can create. Must be between 0-999999, with 0 being unlimited (integer)
+    # * <tt>:MAXSUB</tt> - Maximum number of subdomains the user can create. Must be between 0-999999, with 0 being unlimited (integer)
+    # * <tt>:MAXPARK</tt> - Maximum number of parked domains the user can create. Must be between 0-999999, with 0 being unlimited (integer)
+    # * <tt>:MAXADDON</tt> - Maximum number of addon domains the user can create. Must be between 0-999999, with 0 being unlimited (integer)
+    # * <tt>:shell</tt> - Whether or not the domain has shell/SSH access (boolean)
+    # * <tt>:user</tt> - User name of the account (string)
+    def modify_account(options = {})
+      booleans!(options, :HASCGI, :LANG, :shell)
+      requires!(options, :user, :domain, :HASCGI, :CPTHEME, :LANG, :MAXPOP, :MAXFTP, :MAXLST, :MAXSUB, 
+        :MAXPARK, :MAXADDON, :MAXSQL, :shell)
+        
+      data = get_xml(:url => "modifyacct", :params => options)
+      
+      check_for_cpanel_errors_on(data)
+    end
+    
+    # Suspend an account. Returns <tt>true</tt> if it is successful, 
+    # or <tt>false</tt> if it is not.
+    #
+    # ==== Options
+    # * <tt>:user</tt> - Username to suspend (string)
+    # * <tt>:reason</tt> - Reason for suspension (string)
+    def suspend_account(options = {})
+      requires!(options, :user, :reason)
+      
+      data = get_xml(:url => "suspendacct", :params => options)
+      check_for_cpanel_errors_on(data)
+      
+      data["status"] == "1" ? true : false
+    end
+    
+    # Terminates a hosting account. <b>Please note that this action is irreversible!</b>
+    #
+    # ==== Options
+    # * <tt>:user</tt> - Username to terminate (string)
+    # * <tt>:keepdns</tt> - Keep DNS entries for the domain ("y" or "n")
+    def terminate_account(options = {})
+      requires!(options, :user)
+            
+      data = get_xml(:url => "removeacct", :params => {
+        :user => options[:user], 
+        :keepdns => options[:keepdns] || "n"
+      })
+      
+      check_for_cpanel_errors_on(data)
+    end
+    
+    # Unsuspend a suspended account. Returns <tt>true</tt> if it
+    # is successful, or <tt>false</tt> if it is not.
+    #
+    # ==== Options
+    # * <tt>:user</tt> - Username to unsuspend (string)
+    def unsuspend_account(options = {})
+      requires!(options, :user)
+      
+      data = get_xml(:url => "unsuspendacct", :params => options)
+      check_for_cpanel_errors_on(data)
+      
+      data["status"] == "1" ? true : false
+    end
+    
+    # Returns the cPanel WHM version.
+    def version    
+      data = get_xml(:url => 'version')
+      check_for_cpanel_errors_on(data)["version"]
+    end
+    
+    private
+    
+    # Grabs the XML response for a command to the server, and parses it.
+    #
+    # ==== Options
+    # * <tt>:url</tt> - URL of the XML API function (string)
+    # * <tt>:params</tt> - Passed in parameter hash (hash)
+    def get_xml(options = {})
+      requires!(options, :url)
+      
+      prefix = @ssl ? "https" : "http"
+      params = []
+      
+      unless options[:params].nil?
+        for key, value in options[:params]
+          params << Curl::PostField.content(key.to_s, value)
+        end
+      end
+      
+      request = Curl::Easy.new("#{prefix}://#{@host}:#{@port}/xml-api/#{options[:url]}") do |connection|
+        puts "WHM: Requesting #{options[:url]}..." if @debug
+        
+        connection.userpwd = "#{@username}:#{@password}" if @password
+        connection.headers["Authorization"] = "WHM #{@username}:#{@remote_key}" if @remote_key
+        connection.verbose = true if @debug
+        connection.timeout = 60
+      end
+          
+      if request.http_post(params)
+        xml = XmlSimple.xml_in(request.body_str, { 'ForceArray' => false })
+        xml["result"].nil? ? xml : xml["result"]
+      end
+    end
+    
+    # Returns the data, unless a <tt>status</tt> is equal to <tt>0</tt>,
+    # in which case a CommandFailedError exception is 
+    # thrown with the <tt>statusmsg</tt> from the fetched XML.
+    #
+    # If the command does not support status messaging,
+    # then just return the raw data.
+    def check_for_cpanel_errors_on(data)
+      if data["status"]
+        if data["status"] == 1
+          data
+        else
+          raise CommandFailedError, data["statusmsg"]
+        end
+      else
+        data
+      end
+    end
+  end
+end

data/spec/server_spec.rb

@@ -0,0 +1,128 @@
+require File.dirname(__FILE__) + '/spec_helper.rb'
+require 'whm_xml'
+require 'pp'
+
+describe "A WHM Server" do 
+  
+  before do
+    @xml = Whm::Xml.new(
+      :username => "username",
+      :password => "password",
+      :host => "www.example.com"
+    )
+  end
+  
+  it "should list accounts" do 
+    data = open('fixtures/listaccts.xml').read
+    @xml.should_receive(:get_xml).with({:url=>"listaccts", :params=>{}}).and_return(XmlSimple.xml_in(data))
+    @xml.list_accounts.should_not be_nil
+  end
+  
+  it "should list packages" do
+    data = open('fixtures/listpkgs.xml').read
+    @xml.should_receive(:get_xml).with(:url => 'listpkgs').and_return(XmlSimple.xml_in(data))
+    @xml.list_packages.should_not be_nil
+  end
+  
+  it "should display hostname" do
+    data = open(File.dirname(__FILE__) + '/fixtures/gethostname.xml').read
+    @xml.should_receive(:get_xml).with('gethostname').and_return(XmlSimple.xml_in(data))
+    @xml.hostname.should_not be_nil
+  end
+  
+  it "should display version" do
+    data = open(File.dirname(__FILE__) + '/fixtures/version.xml').read
+    @xml.should_receive(:get_xml).with('version').and_return(XmlSimple.xml_in(data))
+    @xml.version.should_not be_nil
+  end
+  
+  it "should generate a ssl certificate" do
+    data = open(File.dirname(__FILE__) + '/fixtures/generatessl.xml').read
+    @xml.should_receive(:get_xml).with('generatessl',{}).and_return(XmlSimple.xml_in(data))
+    @xml.generate_certificate.should_not be_nil
+  end
+  
+  it "should generate a ssl certificate using an alias" do
+    data = open(File.dirname(__FILE__) + '/fixtures/generatessl.xml').read
+    @xml.should_receive(:get_xml).with('generatessl',{:xemail => "xemail"}).and_return(XmlSimple.xml_in(data))
+    @xml.generate_ssl_certificate({:xemail => "xemail"}).should_not be_nil
+  end
+  
+  describe "working with Accounts" do
+    before do
+      @account_options = {:username => 'test_account'}
+    end
+    
+    it "should create an account" do
+      data = open(File.dirname(__FILE__) + '/fixtures/createacct.xml').read
+      @xml.should_receive(:get_xml).with('createacct',@account_options).and_return(XmlSimple.xml_in(data))
+      @xml.create_account(@account_options).should_not be_nil
+    end
+    
+    it "should change account password" do
+      data = open(File.dirname(__FILE__) + '/fixtures/passwd.xml').read
+      @xml.should_receive(:get_xml).with('passwd',{:user => 'test_account', :pass => 'new_password'}).and_return(XmlSimple.xml_in(data))
+      @xml.change_account_password('test_account', 'new_password').should_not be_nil
+    end
+    
+    it "should limit bandwidth usage" do
+      data = open(File.dirname(__FILE__) + '/fixtures/limitbw.xml').read
+      @xml.should_receive(:get_xml).with('limitbw',{:user => 'test_account', :bwlimit => '100'}).and_return(XmlSimple.xml_in(data))
+      @xml.limit_bandwidth('test_account', '100').should_not be_nil
+    end
+    
+    it "should display account summary" do
+      data = open(File.dirname(__FILE__) + '/fixtures/accountsummary.xml').read
+      @xml.should_receive(:get_xml).with('accountsummary',{:user =>'test_account'}).and_return(XmlSimple.xml_in(data))
+      @xml.account_summary('test_account').should_not be_nil
+    end
+    
+    it "should suspend account" do
+      data = open(File.dirname(__FILE__) + '/fixtures/suspendacct.xml').read
+      @xml.should_receive(:get_xml).with('suspendacct',{:user =>'test_account', :reason => 'General Misbehaving'}).and_return(XmlSimple.xml_in(data))
+      @xml.suspend_account('test_account', 'General Misbehaving').should_not be_nil
+    end
+
+    it "should unsuspend account" do
+      data = open(File.dirname(__FILE__) + '/fixtures/unsuspendacct.xml').read
+      @xml.should_receive(:get_xml).with('unsuspendacct',{:user =>'test_account'}).and_return(XmlSimple.xml_in(data))
+      @xml.unsuspend_account('test_account').should_not be_nil
+    end
+
+    it "should terminate account" do
+      data = open(File.dirname(__FILE__) + '/fixtures/removeacct.xml').read
+      @xml.should_receive(:get_xml).with('removeacct',{:user =>'test_account', :keepdns => 'n'}).and_return(XmlSimple.xml_in(data))
+      @xml.terminate_account('test_account').should_not be_nil
+    end
+    
+    it "should change account package" do
+      data = open(File.dirname(__FILE__) + '/fixtures/changepackage.xml').read
+      @xml.should_receive(:get_xml).with('changepackage',{:user =>'test_account', :pkg => 'new_package'}).and_return(XmlSimple.xml_in(data))
+      @xml.change_package('test_account', 'new_package').should_not be_nil
+    end
+    
+    it "should display an error message" do
+      data = open(File.dirname(__FILE__) + '/fixtures/error.xml').read
+      @xml.connection.should_receive(:get_xml).with('listaccts',{}).and_return(data)
+      
+      lambda { @xml.list_accounts }.should raise_error( Whm::CommandFailed )
+    end
+
+    it "should throw an exception when an account doesn't exist" do
+      data = open(File.dirname(__FILE__) + '/fixtures/error2.xml').read
+      @xml.connection.should_receive(:get_xml).with('accountsummary',{:user => 'bad_account'}).and_return(data)
+      lambda { @xml.account_summary('bad_account') }.should raise_error( Whm::CommandFailed )
+    end
+
+  end
+end
+
+describe "A Nonexistant Server" do 
+  before do
+    @xml = Whm::Xml.new('localhost',2087,'username','password')
+  end
+  
+  it "should exceptionize on connection failure" do
+    lambda { @xml.version }.should raise_error( Whm::CantConnect )
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,21 @@
+begin
+  require 'spec'
+rescue LoadError
+  require 'rubygems'
+  gem 'rspec'
+  require 'spec'
+end
+
+dir = File.dirname(__FILE__)
+
+$:.unshift(File.join(dir, '/../lib/'))
+    
+def stdout_for(&block)
+  # Inspired by http://www.ruby-forum.com/topic/58647
+  old_stdout = $stdout
+  $stdout = StringIO.new
+  yield
+  output = $stdout.string
+  $stdout = old_stdout
+  output
+end

metadata

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification 
+name: voxxit-whm_xml
+version: !ruby/object:Gem::Version 
+  version: 0.3.0
+platform: ruby
+authors: 
+- Ivan Storck
+- Padraic McGee
+- Josh Delsman
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-04-17 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: xml-simple
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.0.12
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.3.2
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: curb
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.3.2
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: validatable
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.6.7
+    version: 
+description: The whm_xml library provides a Ruby wrapper for the cPanel Web Host Manager (WHM) XML-API
+email: ivanoats+whm_xml@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- Rakefile
+- README.rdoc
+- lib/parameters.rb
+- lib/whm_xml/exceptions.rb
+- lib/whm_xml/server.rb
+- lib/whm_xml.rb
+- spec/server_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/ivanoats/whm_xml_api_ruby
+post_install_message: 
+rdoc_options: 
+- --main
+- README.rdoc
+- --inline-source
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Web Host Manager (WHM) XML-API Ruby library
+test_files: 
+- spec/server_spec.rb