whm_xml 0.3.2

data/spec/fixtures/modifyacct.xml

@@ -0,0 +1,40 @@
+<modifyacct>
+  <result>
+    <messages>Changing shell for user.
+      Shell changed.
+    </messages>
+    <newcfg>
+      <cpuser>
+        <BWLIMIT>5242880000</BWLIMIT>
+        <CONTACTEMAIL>owner@domain.com</CONTACTEMAIL>
+        <CONTACTEMAIL2></CONTACTEMAIL2>
+        <DEADDOMAINS>oldsub.domain.com</DEADDOMAINS>
+        <DEMO>0</DEMO>
+        <DOMAIN>domain.com</DOMAIN>
+        <DOMAINS>sub.domain.com</DOMAINS>
+        <DOMAINS>addondomain.com</DOMAINS>
+        <FEATURELIST>reseller_gold</FEATURELIST>
+        <HASCGI>0</HASCGI>
+        <IP>192.168.1.1</IP>
+        <LANG>english</LANG>
+        <MAXADDON>5</MAXADDON>
+        <MAXFTP>0</MAXFTP>
+        <MAXLST>1</MAXLST>
+        <MAXPARK>4</MAXPARK>
+        <MAXPOP>3</MAXPOP>
+        <MAXSQL>6</MAXSQL>
+        <MAXSUB>3</MAXSUB>
+        <OWNER>root</OWNER>
+        <PLAN>reseller_gold</PLAN>
+        <RS>x3</RS>
+        <STARTDATE>1175808157</STARTDATE>
+        <USER>user</USER>
+      </cpuser>
+      <domain>domain.com</domain>
+      <setshell>/bin/bash</setshell>
+      <user>user</user>
+    </newcfg>
+    <status>1</status>
+    <statusmsg>Account Modified</statusmsg>
+  </result>
+</modifyacct>

data/spec/fixtures/passwd.xml

@@ -0,0 +1,33 @@
+<passwd>
+  <passwd>
+    <rawout>Changing password for user
+Password for user has been changed
+Updating ftp passwords for user
+Ftp password files updated.
+Ftp vhost passwords synced
+Unable to find pgpass file.
+</rawout>
+    <services>
+      <app>system</app>
+    </services>
+    <services>
+      <app>ftp</app>
+    </services>
+    <services>
+      <app>mail</app>
+    </services>
+    <services>
+      <app>mySQL</app>
+    </services>
+    <services>
+      <app>postgresql</app>
+    </services>
+    <services>
+      <app>FrontPage</app>
+    </services>
+    <status>1</status>
+    <statusmsg>Password changed for user user</statusmsg>
+  </passwd>
+</passwd>
+
+<!-- Web Host Manager  (c) cPanel, Inc. 2008 http://cpanel.net/  Unauthorized copying is prohibited. -->

data/spec/fixtures/removeacct.xml

@@ -0,0 +1,21 @@
+<removeacct>
+  <result>
+    <rawout>Running pre removal script (/scripts/prekillacct)......DoneCollecting Domain Name and IP...User: user
+Domain: example.com
+...DoneKilling all processes owned by user......DoneCleaning passwd,shadow,group......DoneRemoving User from Group..........DoneRemoving Web Logs......DoneRemoving Crontab......DoneRemoving Virtual Hosts...Removed Extra Entries from httpd.conf
+example.com not found in httpd.conf.
+...DoneRemoving PostgreSQL databases and users......DoneRemoving System User......DoneRemoving Group......DoneRemoving DNS Entries...example.com =&gt; deleted from r15. 
+...DoneRemoving Email Setup...Removing /etc/valiases/example.com
+...DoneRemoving mailman lists......DoneRemoving MySQL databases and users......DoneRemoving remotedomains,secondarymx,localdomains entries......DoneRemoving Counter Data......DoneAdding ip back to the ip address pool...System has 0 free ips.
+...DoneRemoving user's cPanel Databases &amp; Updating......DoneReloading Services......DoneRemoving mail and service configs...
+...DoneSending Contacts......DoneUpdating internal databases...Updating ftp passwords for user
+Purging ftp user user
+Ftp password files updated.
+Ftp vhost passwords synced
+...DoneRunning post removal scripts (/scripts/legacypostkillacct, /scripts/postkillacct)......DoneAccount Removal Complete!!!...user account removed...Done</rawout>
+    <status>1</status>
+    <statusmsg>user account removed</statusmsg>
+  </result>
+</removeacct>
+
+<!-- Web Host Manager  (c) cPanel, Inc. 2008 http://cpanel.net/  Unauthorized copying is prohibited. -->

data/spec/fixtures/suspendacct.xml

@@ -0,0 +1,26 @@
+<suspendacct>
+  <result>
+    <status>1</status>
+    <statusmsg>&lt;script&gt;if (self['clear_ui_status']) { clear_ui_status(); }&lt;/script&gt;
+Changing Shell to /bin/false...Changing shell for user.
+Warning: &quot;/bin/false&quot; is not listed in /etc/shells
+Shell changed.
+Done
+Locking Password...Locking password for user user.
+passwd: Success
+Done
+Suspending mysql users
+Notification =&gt; system@example.com via EMAIL [level =&gt; 3]
+Using Quota v3 Support
+Suspended document root /home/user/public_html
+Using Quota v3 Support
+Suspending FTP accounts...
+Updating ftp passwords for user
+Ftp password files updated.
+Ftp vhost passwords synced
+user's account has been suspended
+</statusmsg>
+  </result>
+</suspendacct>
+
+<!-- Web Host Manager  (c) cPanel, Inc. 2008 http://cpanel.net/  Unauthorized copying is prohibited. -->

data/spec/fixtures/unsuspendacct.xml

@@ -0,0 +1,20 @@
+<unsuspendacct>
+  <result>
+    <status>1</status>
+    <statusmsg>&lt;script&gt;if (self['clear_ui_status']) { clear_ui_status(); }&lt;/script&gt;
+Changing shell for user.
+Shell changed.
+Unlocking password for user user.
+passwd: Success.
+Unsuspending FTP accounts...
+Updating ftp passwords for user
+Ftp password files updated.
+Ftp vhost passwords synced
+user's account is now active
+Unsuspending mysql users
+Notification =&gt; system@example.com via EMAIL [level =&gt; 3]
+</statusmsg>
+  </result>
+</unsuspendacct>
+
+<!-- Web Host Manager  (c) cPanel, Inc. 2008 http://cpanel.net/  Unauthorized copying is prohibited. -->

data/spec/fixtures/version.xml

@@ -0,0 +1,5 @@
+<version>
+  <version>11.24.2</version>
+</version>
+
+<!-- Web Host Manager  (c) cPanel, Inc. 2008 http://cpanel.net/  Unauthorized copying is prohibited. -->

data/spec/package_spec.rb

@@ -0,0 +1,83 @@
+require File.dirname(__FILE__) + '/spec_helper.rb'
+require 'lib/whm'
+require 'pp'
+
+
+describe "Whm Packages" do
+  before do
+    @server = Whm::Server.new(
+      :username => "username",
+      :password => "password",
+      :host => "dedicated.server.com"
+    )
+  end
+
+  it "should find all packages" do
+    data = open(File.dirname(__FILE__) + '/fixtures/listpkgs.xml').read    
+    @server.expects(:get_xml).returns(XmlSimple.xml_in(data, { 'ForceArray' => false }))    
+    
+    @server.packages.length.should == 3
+  end
+
+end
+
+describe "A Whm Package" do 
+  
+  before do
+    @server = Whm::Server.new(
+      :username => "username",
+      :password => "password",
+      :host => "dedicated.server.com"
+    )
+    data = open(File.dirname(__FILE__) + '/fixtures/accountsummary.xml').read    
+    @server.expects(:get_xml).with(:url => "accountsummary", :params => {:user=>"magic"}).returns(XmlSimple.xml_in(data,{ 'ForceArray' => false }))    
+    @account = @server.account("magic")
+  end
+  
+
+  it "should load account attributes" do
+    @account.attributes['user'].should == "magic"
+    @account.attributes['domain'].should == "magic.example.com"
+  end
+  
+  it "should have a name" do
+    @account.name.should == "magic"
+    @account.user.should == "magic"
+  end
+  
+  it "should change the password" do
+    @server.expects(:change_account_password).returns("new_password")
+    @account.password=("new_password").should == "new_password"
+  end
+  
+  it "should suspend an account" do
+    @server.expects(:suspend_account).returns("ok")
+    @account.suspend!.should == "ok"
+  end
+  
+  it "should unsuspend an account" do
+    @server.expects(:unsuspend_account).returns("ok")
+    @account.unsuspend!.should == "ok"
+  end
+  
+  it "should terminate an account" do
+    @server.expects(:terminate_account).returns("ok")
+    @account.terminate!.should == "ok"
+  end
+  
+  it "should change the package on an account" do
+    @server.expects(:change_package).returns("ok")
+    
+    @account.package=("new_package").should == "new_package"
+  end
+  
+  it "should read an attribute" do
+    @account.domain.should == 'magic.example.com'
+  end
+  
+  it "should write an attribute" do
+    @account.username = 'newname'    
+    @account.username.should == 'newname'
+  end
+  
+end

data/spec/server_spec.rb

@@ -0,0 +1,195 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+require 'lib/whm'
+
+describe Whm::Server do 
+  before do
+    @server = Whm::Server.new(
+      :username => "username",
+      :password => "password",
+      :host => "dedicated.server.com"
+    )
+  end
+  
+  it "should build a server object" do
+    @server.should_not be_nil
+    
+    @server.host.should eql("dedicated.server.com")
+    @server.username.should eql("username")
+    @server.password.should eql("password")
+  end
+  
+  it "should have default options" do
+    @server.debug.should eql(false)
+    @server.ssl.should eql(true)
+    @server.port.should eql(2087)
+  end
+  
+  it "should handle successful commands from cPanel" do
+  end
+  
+  it "should handle unsuccessful commands from cPanel" do
+  end
+  
+  it "should list accounts" do 
+    data = open(File.expand_path('spec/fixtures/listaccts.xml')).read
+    
+    @server.expects(:list_accounts).returns(XmlSimple.xml_in(data))
+    @server.list_accounts.eql?(XmlSimple.xml_in(data))
+  end
+  
+  it "should list packages" do
+    data = open('spec/fixtures/listpkgs.xml').read
+    
+    @server.expects(:list_packages).returns(XmlSimple.xml_in(data))
+    @server.list_packages.eql?(XmlSimple.xml_in(data))
+  end
+  
+  it "should display the actual server hostname" do
+    data = open('spec/fixtures/gethostname.xml').read
+    
+    @server.expects(:hostname).returns(XmlSimple.xml_in(data)["hostname"])
+    @server.hostname.eql?("ns100.example.com")
+  end
+    
+  it "should display the actual server version" do
+    data = open('spec/fixtures/version.xml').read
+    
+    @server.expects(:version).returns(XmlSimple.xml_in(data)["version"])
+    @server.version.eql?("11.24.2")
+  end
+    
+  it "should generate ssl certificates" do
+    data = open('spec/fixtures/generatessl.xml').read
+    
+    params = {
+      :city => "Houston", 
+      :co => "Domain LLC", 
+      :cod => "Web", 
+      :country => "US", 
+      :email => "test@domain.com", 
+      :host => "domain.com", 
+      :pass => "password",
+      :state => "TX", 
+      :xemail => "test@domain.com"
+    }
+    
+    @server.expects(:generate_ssl_certificate).with(params).returns(XmlSimple.xml_in(data))
+    @server.generate_ssl_certificate(params).eql?(XmlSimple.xml_in(data))
+  end
+  
+  it "should display account summaries" do
+    data = open('spec/fixtures/accountsummary.xml').read
+    
+    params = {
+      :user => "magic"
+    }
+    
+    @server.expects(:account_summary).with(params).returns(XmlSimple.xml_in(data))
+    @server.account_summary(params).eql?(XmlSimple.xml_in(data))
+  end
+  
+  it "should change packages" do
+    data = open('spec/fixtures/accountsummary.xml').read
+    
+    params = {
+      :user => "user",
+      :pkg => "new_plan"
+    }
+    
+    @server.expects(:change_package).with(params).returns(XmlSimple.xml_in(data))
+    @server.change_package(params).eql?(XmlSimple.xml_in(data))
+  end
+  
+  it "should create accounts" do
+    data = open('spec/fixtures/createacct.xml').read
+    
+    params = {
+      :user => "user",
+      :domain => "domain.com"
+    }
+    
+    @server.expects(:create_account).with(params).returns(XmlSimple.xml_in(data))
+    @server.create_account(params).eql?(XmlSimple.xml_in(data))
+  end
+  
+  it "should suspend accounts" do
+    data = open('spec/fixtures/suspendacct.xml').read
+    
+    params = {
+      :user => "user",
+      :reason => "N/A"
+    }
+    
+    @server.expects(:suspend_account).with(params).returns(XmlSimple.xml_in(data))
+    @server.suspend_account(params).eql?(XmlSimple.xml_in(data))
+  end
+  
+  it "should unsuspend accounts" do
+    data = open('spec/fixtures/unsuspendacct.xml').read
+    
+    params = {
+      :user => "user"
+    }
+    
+    @server.expects(:unsuspend_account).with(params).returns(XmlSimple.xml_in(data))
+    @server.unsuspend_account(params).eql?(XmlSimple.xml_in(data))
+  end
+  
+  it "should terminate accounts" do
+    data = open('spec/fixtures/removeacct.xml').read
+    
+    params = {
+      :user => "user"
+    }
+    
+    @server.expects(:terminate_account).with(params).returns(XmlSimple.xml_in(data))
+    @server.terminate_account(params).eql?(XmlSimple.xml_in(data))
+  end
+  
+  it "should limit an account's bandwidth usage limit" do
+    data = open('spec/fixtures/limitbw.xml').read
+    
+    params = {
+      :user => "username",
+      :bwlimit => "1"
+    }
+    
+    @server.expects(:limit_bandwidth_usage).with(params).returns(XmlSimple.xml_in(data))
+    @server.limit_bandwidth_usage(params).eql?(XmlSimple.xml_in(data))
+  end
+  
+  it "should change account passwords" do
+    data = open('spec/fixtures/passwd.xml').read
+    
+    params = {
+      :user => "username",
+      :pass => "password"
+    }
+    
+    @server.expects(:change_account_password).with(params).returns(XmlSimple.xml_in(data))
+    @server.change_account_password(params).eql?(XmlSimple.xml_in(data))
+  end
+  
+  it "should modify accounts" do
+    data = open('spec/fixtures/modifyacct.xml').read
+        
+    params = {
+      :user => "user",
+      :domain => "domain.com",
+      :HASCGI => 0,
+      :CPTHEME => "x3",
+      :LANG => "english",
+      :MAXPOP => 3,
+      :MAXFTP => 0,
+      :MAXLST => 1,
+      :MAXSUB => 3,
+      :MAXPARK => 4,
+      :MAXADDON => 5,
+      :MAXSQL => 6,
+      :shell => 1
+    }
+    
+    @server.expects(:modify_account).with(params).returns(XmlSimple.xml_in(data))
+    @server.modify_account(params).eql?(XmlSimple.xml_in(data))
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,26 @@
+begin
+  require 'spec'
+rescue LoadError
+  require 'rubygems'
+  gem 'rspec'
+  require 'spec'
+end
+
+dir = File.dirname(__FILE__)
+
+$:.unshift(File.join(dir, '/lib/'))
+
+# Enable mocha mocking/stubbing
+Spec::Runner.configure do |config|
+  config.mock_with :mocha
+end
+
+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