panelbeater 0.1.0

data/Rakefile

@@ -0,0 +1,72 @@
+require "rubygems"
+require "rake/gempackagetask"
+require "rake/rdoctask"
+
+
+
+task :default => :package do
+  puts "Don't forget to write some tests!"
+end
+
+# This builds the actual gem. For details of what all these options
+# mean, and other ones you can add, check the documentation here:
+#
+#   http://rubygems.org/read/chapter/20
+#
+spec = Gem::Specification.new do |s|
+
+  # Change these as appropriate
+  s.name              = "panelbeater"
+  s.version           = "0.1.0"
+  s.summary           = "A gem for communicating with the cPanel and WHM API's"
+  s.author            = "Jamie Dyer"
+  s.email             = "jamie@kernowsoul.com"
+  s.homepage          = "http://kernowsoul.com"
+
+  s.has_rdoc          = false
+  # You should probably have a README of some kind. Change the filename
+  # as appropriate
+  # s.extra_rdoc_files  = %w(README)
+  # s.rdoc_options      = %w(--main README)
+
+  # Add any extra files to include in the gem (like your README)
+  s.files             = %w() + Dir.glob("{**/*}")
+  s.test_files = Dir.glob('test/fixtures/*') + Dir.glob('test/*.rb') + Dir.glob('test/*.example')
+  
+  s.require_paths = ["lib"]
+
+  # If you want to depend on other gems, add them here, along with any
+  # relevant versions
+  s.add_dependency("json")
+
+  # If your tests use any gems, include them here
+  s.add_development_dependency("shoulda")
+  s.add_development_dependency("fakeweb")
+
+  # If you want to publish automatically to rubyforge, you'll may need
+  # to tweak this, and the publishing task below too.
+end
+
+# This task actually builds the gem. We also regenerate a static
+# .gemspec file, which is useful if something (i.e. GitHub) will
+# be automatically building a gem for this project. If you're not
+# using GitHub, edit as appropriate.
+Rake::GemPackageTask.new(spec) do |pkg|
+  pkg.gem_spec = spec
+
+  # Generate the gemspec file for github.
+  file = File.dirname(__FILE__) + "/#{spec.name}.gemspec"
+  File.open(file, "w") {|f| f << spec.to_ruby }
+end
+
+# Generate documentation
+Rake::RDocTask.new do |rd|
+  
+  rd.rdoc_files.include("lib/**/*.rb")
+  rd.rdoc_dir = "rdoc"
+end
+
+desc 'Clear out RDoc and generated packages'
+task :clean => [:clobber_rdoc, :clobber_package] do
+  rm "#{spec.name}.gemspec"
+end

data/Readme.markdown

@@ -0,0 +1 @@
+#cPanel gem

data/cpanel-gem.gemspec

@@ -0,0 +1,30 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{cpanel-gem}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Jamie Dyer"]
+  s.date = %q{2010-01-29}
+  s.email = %q{jamie@kernowsoul.com}
+  s.files = ["cpanel-gem.gemspec", "lib", "lib/cpanel_api", "lib/cpanel_api/cpanel", "lib/cpanel_api/cpanel/commands.rb", "lib/cpanel_api/model.rb", "lib/cpanel_api/remote.rb", "lib/cpanel_api/response.rb", "lib/cpanel_api/whm", "lib/cpanel_api/whm/commands.rb", "lib/cpanel_api.rb", "Rakefile", "Readme.markdown", "test", "test/fixtures", "test/fixtures/applist.json", "test/fixtures/createacct_fail.json", "test/fixtures/createacct_success.json", "test/fixtures/passwd_fail.json", "test/fixtures/passwd_success.json", "test/test_helper.rb", "test/whm_test.rb", "~"]
+  s.homepage = %q{http://kernowsoul.com}
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{A gem for communicating with cPanel}
+  s.test_files = ["test/fixtures/applist.json", "test/fixtures/createacct_fail.json", "test/fixtures/createacct_success.json", "test/fixtures/passwd_fail.json", "test/fixtures/passwd_success.json", "test/test_helper.rb", "test/whm_test.rb"]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<shoulda>, [">= 0"])
+    else
+      s.add_dependency(%q<shoulda>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<shoulda>, [">= 0"])
+  end
+end

data/lib/panelbeater.rb

@@ -0,0 +1,10 @@
+require 'net/https'
+require 'json'
+require 'uri'
+require 'logger'
+
+require 'panelbeater/remote'
+require 'panelbeater/response'
+require 'panelbeater/model'
+require 'panelbeater/cpanel/commands'
+require 'panelbeater/whm/commands'

data/lib/panelbeater/cpanel/commands.rb

@@ -0,0 +1,10 @@
+module CpanelApi
+  module Cpanel
+    module Commands
+    
+      def addsubdomain(user, subdomain, rootdomain, directory)
+        cpanel(user, {:xmlin => "<cpanelaction><module>SubDomain</module><func>addsubdomain</func><args><domain>#{subdomain}</domain><rootdomain>#{rootdomain}</rootdomain><dir>#{directory}</dir></args></cpanelaction>"})
+      end
+    end
+  end
+end

data/lib/panelbeater/model.rb

@@ -0,0 +1,26 @@
+module CpanelApi
+  module Model
+    
+    def key_mappings(map, hash)
+      map.each_key do |k|
+        if hash.has_key? k
+          hash[map[k]] = hash[k]
+          hash.delete(k)
+        end
+      end
+      hash
+    end
+
+    def filter_options(hash)
+      hash.each do |k,v|
+        if v == true
+          hash[k] = 1
+        elsif v == false
+          hash[k] = 0
+        end
+      end
+      hash.delete_if {|k,v| v.nil? }
+    end
+    
+  end
+end

data/lib/panelbeater/remote.rb

@@ -0,0 +1,43 @@
+module CpanelApi
+  module Remote
+    
+    @@default_port = 2087
+    @@default_user = 'root'
+    
+    def set_server(options={})
+  		self.base_url = options[:url]
+  		self.user     = options[:user] ||= @@default_user
+  		self.api_key  = options[:api_key].gsub(/\n|\r/, '')
+  		self.port     = options[:port] ||= @@default_port
+  	end
+    
+    def connect(server, port, command, username, api_key, options={})
+      http = Net::HTTP.new(server, port)
+      http.use_ssl = true
+      http.start do |http|
+        req = Net::HTTP::Get.new "/json-api/#{command}#{map_options_to_url(options)}"
+        req.add_field 'Authorization', "WHM #{username}:#{api_key}"
+        # req.each_header {|k,v| @log.info "#{k}: #{v}"}
+        http.request(req)
+        # puts response.to_yaml
+        # response.value
+        # response.body
+      end
+    end
+    
+    def do_request(command, options={}, mappings=nil)
+      options = key_mappings(mappings, options) unless mappings.nil?
+      options = filter_options(options)
+      response = connect self.base_url, self.port, command, self.user, self.api_key, options
+      # if response.code == '200'
+      #   response.json = JSON.parse(response.body)
+      # end
+      CpanelApi::Response.new(response)
+    end
+    
+    def map_options_to_url(options={})
+      '?' + options.map { |k,v| "%s=%s" % [URI.encode(k.to_s), URI.encode(v.to_s)] }.join('&') unless options.nil?
+    end
+    
+  end
+end

data/lib/panelbeater/response.rb

@@ -0,0 +1,17 @@
+module CpanelApi
+  class Response
+    
+    def initialize(response)
+      @response = response
+    end
+    
+    def json
+      JSON.parse @response.body
+    end
+    
+    def method_missing(method, *args)
+      @response.send(method) if @response.respond_to?(method)
+    end
+    
+  end
+end

data/lib/panelbeater/whm/commands.rb

@@ -0,0 +1,333 @@
+module CpanelApi
+  module Whm
+    class Commands
+      include Model
+      include Remote
+      include Cpanel
+    
+      attr_accessor :base_url
+      attr_accessor :user
+      attr_accessor :api_key
+      attr_accessor :port
+    
+      def initialize(options={})
+        @log = Logger.new(STDOUT)
+        @log.level = Logger::INFO
+        set_server(options)
+      end
+  
+      # Each WHM API command has its own method
+    
+      # Get a users account summary
+      def accountsummary(user)
+        do_request 'accountsummary', {:user => user}
+      end
+  
+  
+      # Add a new package
+      #
+      # required params:
+      # name
+      # quota
+      # maxftp
+      # maxsql
+      # maxpop
+      # maxlists
+      # maxsub
+      # maxpark
+      # maxaddon
+      # bwlimit
+  
+      def addpkg(options={}, mappings=nil)
+        default_options = { :featurelist => 'default',
+                            :ip => 0,
+                            :cgi => 1,
+                            :frontpage => 0,
+                            :cpmod => 'x3',
+                            :hasshell => 0 }
+        all_options = default_options.merge!(options)
+        do_request 'addpkg', all_options, mappings
+      end
+  
+      # Returns a list of available commands
+      def applist
+        do_request 'applist'
+      end
+    
+      # Change a users package
+      def changepackage(user, package)
+        do_request 'changepackage', {:user => user, :pkg => package}
+      end
+    
+      # Call cpanel API1 and API2 commands
+      #
+      # user (string)
+      # The name of the user that owns the cPanel account to be affected.
+      # xmlin (XML)
+      # XML container for the function. Format <cpanelaction><module><func><args></args></func></module></cpanelaction>
+      # module (string)
+      # Name of the module to access. (See http://www.cpanel.net/plugins/api2/index.html for module and function names)
+      # apiversion (integer)
+      # Version of the API to access. (1 = API1, no input defaults to API2)
+      # func (string)
+      # Name of the function to access. (See http://www.cpanel.net/plugins/api2/index.html for module and function names)
+      # args (XML or string)
+      # List of arguments or argument container. See examples for API1 and API2 passing arguments.
+    
+      def cpanel(user, options={})
+        default_options = { :apiversion => 2 }
+        all_options = default_options.merge!(options).merge!(:user => user)
+        do_request 'cpanel', all_options
+      end
+    
+      # Create a new account
+      #
+      # username (string)
+      # User name of the account. Ex: user
+      # domain (string)
+      # Domain name. Ex: domain.tld
+      # plan (string)
+      # Package to use for account creation. Ex: reseller_gold
+      # quota (integer)
+      # Disk space quota in MB. (0-999999, 0 is unlimited)
+      # password (string)
+      # Password to access cPanel. Ex: p@ss!w0rd$123
+      # ip (string)
+      # Whether or not the domain has a dedicated IP address. (y = Yes, n = No)
+      # cgi (string)
+      # Whether or not the domain has cgi access. (y = Yes, n = No)
+      # frontpage (string)
+      # Whether or not the domain has FrontPage extensions installed. (y = Yes, n = No)
+      # hasshell (string)
+      # Whether or not the domain has shell / ssh access. (y = Yes, n = No)
+      # contactemail (string)
+      # Contact email address for the account. Ex: user@otherdomain.tld
+      # cpmod (string)
+      # cPanel theme name. Ex: x3
+      # maxftp (string)
+      # Maximum number of FTP accounts the user can create. (0-999999 | unlimited, null | 0 is unlimited)
+      # maxsql (string)
+      # Maximum number of SQL databases the user can create. (0-999999 | unlimited, null | 0 is unlimited)
+      # maxpop (string)
+      # Maximum number of email accounts the user can create. (0-999999 | unlimited, null | 0 is unlimited)
+      # maxlst (string)
+      # Maximum number of mailing lists the user can create. (0-999999 | unlimited, null | 0 is unlimited)
+      # maxsub (string)
+      # Maximum number of subdomains the user can create. (0-999999 | unlimited, null | 0 is unlimited)
+      # maxpark (string)
+      # Maximum number of parked domains the user can create. (0-999999 | unlimited, null | 0 is unlimited)
+      # maxaddon (string)
+      # Maximum number of addon domains the user can create. (0-999999 | unlimited, null | 0 is unlimited)
+      # bwlimit (string)
+      # Bandiwdth limit in MB. (0-999999, 0 is unlimited)
+      # customip (string)
+      # Specific IP address for the site.
+      # useregns (boolean)
+      # Use the registered nameservers for the domain instead of the ones configured on the server. (1 = Yes, 0 = No)
+      # hasuseregns (boolean)
+      # Set to 1 if you are using the above option.
+      # reseller (boolean)
+      # Give reseller privileges to the account. (1 = Yes, 0 = No)
+  
+      def createacct(options={}, mappings=nil)
+        default_options = { :featurelist => 'default',
+                            :ip => 'n',
+                            :cgi => 'y',
+                            :frontpage => 'n',
+                            :cpmod => 'x3',
+                            :hasshell => 'n',
+                            :maxlst => 0,
+                            :reseller => 0 }
+        all_options = default_options.merge!(options)
+        do_request 'createacct', all_options, mappings
+      end
+    
+      # Edits an existing package
+      #
+      # name (string)
+      # Name of the package.
+      # featurelist (string)
+      # Name of the feature list to be used for the package.
+      # quota (integer)
+      # Disk space quota for the package (in MB). (max is unlimited)
+      # ip (boolean)
+      # Whether or not the account has a dedicated IP. Yes=1, No=0.
+      # cgi (boolean)
+      # Whether or not the account has cgi access. Yes=1, No=0.
+      # frontpage (boolean)
+      # Whether or not the account can install FrontPage extensions. Yes=1, No=0.
+      # cpmod (string)
+      # What to change the default package them to. Format: cpmod=themename
+      # maxftp (integer)
+      # The maximum amount of FTP accounts a user assigned to the package can create. (max is 999)
+      # maxsql (integer)
+      # The maximum amount of SQL databases a user assigned to the package can create. (max is 999)
+      # maxpop (integer)
+      # The maximum amount of email accounts a user assigned to the package can create. (max is 999)
+      # maxlists (integer)
+      # The maximum amount of email lists a user assigned to the package can create. (max is 999)
+      # maxsub (integer)
+      # The maximum amount of subdomains a user assigned to the package can create. (max is 999)
+      # maxpark (integer)
+      # The maximum amount of parked domains a user assigned to the package can create. (max is 999)
+      # maxaddon (integer)
+      # The maximum amount of addon domains a user assigned to the package can create. (max is 999)
+      # hasshell (boolean)
+      # Whether or not the account has shell access. Yes=1, No=0.
+      # bwlimit (integer)
+    
+      def editpkg(name, options={}, mappings=nil)
+        default_options = { :featurelist => 'default',
+                            :ip => 'n',
+                            :cgi => 'y',
+                            :frontpage => 'n',
+                            :cpmod => 'x3',
+                            :hasshell => 'n',
+                            :maxlists => '0' }
+        all_options = default_options.merge!(options).merge!(:name => name)
+        do_request 'editpkg', all_options, mappings
+      end
+  
+      def fetchsslinfo
+    
+      end
+  
+      def generatessl
+    
+      end
+    
+      # Get the hostname of the server
+      def gethostname
+        do_request 'gethostname'
+      end
+  
+      # List of available languages
+      def getlanglist
+        do_request 'getlanglist'
+      end
+    
+      # Deletes a package from the server
+      def killpkg(package)
+        do_request 'killpkg', {:pkg => package}
+      end
+    
+      # Searches for an account
+      #
+      # searchtype
+      # Type of account search. (domain | owner | user | ip | package )
+      # search
+      # Search criteria. (Perl Regular Expression)
+    
+      def listaccts(term, options={})
+        default_options = {:searchtype => 'user'}
+        all_options = default_options.merge!(options).merge!(:search => term)
+        do_request 'listaccts', all_options
+      end
+    
+      # Reseller functionality not needed yet
+      def listacls
+    
+      end
+  
+      def listcrts
+    
+      end
+    
+      # List packages on server
+      def listpkgs
+        do_request 'listpkgs'
+      end
+    
+      # Reseller functionality not needed yet
+      def listresellers
+    
+      end
+    
+      # List suspended accounts
+      def listsuspended
+        do_request 'listsuspended'
+      end
+    
+      # Get the server load average
+      def loadavg
+        do_request 'loadavg'
+      end
+    
+      # Change and accounts password
+      def passwd(user, password)
+        do_request 'passwd', {:user => user, :pass => password}
+      end
+    
+      # Reboot the server, don't know if this works or if it takes any arguments
+      def reboot
+        do_request 'reboot'
+      end
+    
+      # Remore and account from the server
+      def removeacct(user, options={})
+        default_options = {:keepdns => false}
+        all_options = default_options.merge!(options).merge!(:user => user)
+        do_request 'removeacct', all_options
+      end
+    
+      # Reseller functionality not needed yet
+      def resellerstats
+    
+      end
+    
+      # Restart a service on the server
+      #
+      # service
+      # Service to restart (bind | interchange | ftp | httpd | imap | cppop | exim | mysql | postgres | ssh | tomcat)
+    
+      def restartservice(service)
+        do_request 'restartservice', :service => service
+      end
+    
+      # Reseller functionality not needed yet
+      def saveacllist
+    
+      end
+    
+      # Reseller functionality not needed yet
+      def setacls
+    
+      end
+    
+      # Reseller functionality not needed yet
+      def setupreseller
+    
+      end
+    
+      # Get bandwidth usage for all users, don't know if this takes additional parameters
+      def showbw
+        do_request 'showbw'
+      end
+    
+      # Suspend an account
+      def suspendacct(user, reason)
+        do_request 'suspendacct', {:user => user, :reason => reason}
+      end
+    
+      # Reseller functionality not needed yet
+      def terminatereseller
+    
+      end
+    
+      # Reseller functionality not needed yet
+      def unsetupreseller
+    
+      end
+    
+      # Unsuspend an account
+      def unsuspendacct(user)
+        do_request 'unsuspendacct', :user => user
+      end
+    
+      # Get the of WHM
+      def version
+        do_request 'version'
+      end
+    end
+  end
+end

data/test/fixtures/applist.json

@@ -0,0 +1 @@
+{"app":["accountsummary","acctcounts","adddns","addip","addpkg","addzonerecord","applist","changepackage","configureservice","cpanel","createacct","delip","domainuserdata","dumpzone","editpkg","editquota","editzonerecord","fetchsslinfo","generatessl","gethostname","getlanglist","getresellerips","getzonerecord","installssl","killdns","killpkg","limitbw","listaccts","listacls","listcrts","listips","listpkgs","listresellers","listsuspended","listzones","loadavg","lookupnsip","modifyacct","myprivs","nvget","nvset","passwd","reboot","removeacct","removezonerecord","resellerstats","resetzone","restartservice","saveacllist","servicestatus","setacls","sethostname","setresellerips","setresellerlimits","setresellermainip","setresellernameservers","setresellerpackagelimit","setresolvers","setsiteip","setupreseller","showbw","suspendacct","suspendreseller","terminatereseller","unsetupreseller","unsuspendacct","unsuspendreseller","version"]}

data/test/fixtures/createacct_fail.json

@@ -0,0 +1 @@
+{"result":[{"status":0,"statusmsg":"Sorry, that's an invalid domain\n","rawout":null,"options":null}]}

data/test/fixtures/createacct_success.json

@@ -0,0 +1 @@
+{"result":[{"status":1,"statusmsg":"Account Creation Ok","rawout":"<table style=\"border-bottom: 1px #ccc dotted;\"><tr><td width=\"100%\"><pre>Checking input data...System has 0 free ips.\n...Done</pre></td><td width=\"30\"><img align=absmiddle src=\"/cPanel_magic_revision_1264774563/cjt/images/icons/success.png\"></td></tr></table>\n<table style=\"border-bottom: 1px #ccc dotted;\"><tr><td width=\"100%\"><pre>WWWAcct 12.5.0 (c) 1997-2009 cPanel, Inc....\n\nDns Zone check is enabled.\n+===================================+\n| New Account Info                  |\n+===================================+\n| Domain: bob.com\n| Ip: 77.72.7.154 (n)\n| HasCgi: y\n| UserName: bob\n| PassWord: FjW1tJ2dJlfRJU\n| CpanelMod: x3\n| HomeRoot: /home\n| Quota: 0 Meg\n| NameServer1: ns1.krystal.co.uk\n| NameServer2: ns2.krystal.co.uk\n| NameServer3: \n| NameServer4: \n| Contact Email: \n| Package: default\n| Feature List: default\n| Language: en\n+===================================+\n...Done</pre></td><td width=\"30\"><img align=absmiddle src=\"/cPanel_magic_revision_1264774563/cjt/images/icons/success.png\"></td></tr></table>\n<table style=\"border-bottom: 1px #ccc dotted;\"><tr><td width=\"100%\"><pre>Running pre creation script (/scripts/prewwwacct)......Done</pre></td><td width=\"30\"><img align=absmiddle src=\"/cPanel_magic_revision_1264774563/cjt/images/icons/success.png\"></td></tr></table>\n<table style=\"border-bottom: 1px #ccc dotted;\"><tr><td width=\"100%\"><pre>Adding User...Removing Shell Access (n)\n...Done</pre></td><td width=\"30\"><img align=absmiddle src=\"/cPanel_magic_revision_1264774563/cjt/images/icons/success.png\"></td></tr></table>\n<table style=\"border-bottom: 1px #ccc dotted;\"><tr><td width=\"100%\"><pre>Copying skel files from /root/cpanel3-skel/ to /home/bob/......Done</pre></td><td width=\"30\"><img align=absmiddle src=\"/cPanel_magic_revision_1264774563/cjt/images/icons/success.png\"></td></tr></table>\n<table style=\"border-bottom: 1px #ccc dotted;\"><tr><td width=\"100%\"><pre>Adding Entries to httpd.conf......Done</pre></td><td width=\"30\"><img align=absmiddle src=\"/cPanel_magic_revision_1264774563/cjt/images/icons/success.png\"></td></tr></table>\n<table style=\"border-bottom: 1px #ccc dotted;\"><tr><td width=\"100%\"><pre>Setting up Mail & Local Domains...localdomains...valiases ...vdomainaliases...vfilters......Done</pre></td><td width=\"30\"><img align=absmiddle src=\"/cPanel_magic_revision_1264774563/cjt/images/icons/success.png\"></td></tr></table>\n<table style=\"border-bottom: 1px #ccc dotted;\"><tr><td width=\"100%\"><pre>Configuring DNS......Done</pre></td><td width=\"30\"><img align=absmiddle src=\"/cPanel_magic_revision_1264774563/cjt/images/icons/success.png\"></td></tr></table>\n<table style=\"border-bottom: 1px #ccc dotted;\"><tr><td width=\"100%\"><pre>Restarting apache......Done</pre></td><td width=\"30\"><img align=absmiddle src=\"/cPanel_magic_revision_1264774563/cjt/images/icons/success.png\"></td></tr></table>\nChanging password for bob\nPassword for bob has been changed\n<table style=\"border-bottom: 1px #ccc dotted;\"><tr><td width=\"100%\"><pre>Updating Authentication Databases...Updating ftp passwords for bob\nFtp password files updated.\nFtp vhost passwords synced\n...Done</pre></td><td width=\"30\"><img align=absmiddle src=\"/cPanel_magic_revision_1264774563/cjt/images/icons/success.png\"></td></tr></table>\n<table style=\"border-bottom: 1px #ccc dotted;\"><tr><td width=\"100%\"><pre>Verifying MX Records and Setting up Databases...Reconfiguring Mail Routing:\n<ul><li>LOCAL MAIL EXCHANGER: This server will serve as a primary mail exchanger for bob.com's mail.:<br /> This configuration has been manually selected.<br /><br /></li></ul>...Done</pre></td><td width=\"30\"><img align=absmiddle src=\"/cPanel_magic_revision_1264774563/cjt/images/icons/success.png\"></td></tr></table>\n<table style=\"border-bottom: 1px #ccc dotted;\"><tr><td width=\"100%\"><pre>Setting up Proxy Subdomains......Done</pre></td><td width=\"30\"><img align=absmiddle src=\"/cPanel_magic_revision_1264774563/cjt/images/icons/success.png\"></td></tr></table>\nBind reload skipped on vps (nameserver disabled)\n<table style=\"border-bottom: 1px #ccc dotted;\"><tr><td width=\"100%\"><pre>Sending Account Information......Done</pre></td><td width=\"30\"><img align=absmiddle src=\"/cPanel_magic_revision_1264774563/cjt/images/icons/success.png\"></td></tr></table>\nSystem has 0 free ips.\n<table style=\"border-bottom: 1px #ccc dotted;\"><tr><td width=\"100%\"><pre>Running post creation scripts (/scripts/legacypostwwwacct, /scripts/postwwwacct, /scripts/postwwwacctuser)......Done</pre></td><td width=\"30\"><img align=absmiddle src=\"/cPanel_magic_revision_1264774563/cjt/images/icons/success.png\"></td></tr></table>\nwwwacct creation finished\n<table style=\"border-bottom: 1px #ccc dotted;\"><tr><td width=\"100%\"><pre>Setting up Domain Pointers......Done</pre></td><td width=\"30\"><img align=absmiddle src=\"/cPanel_magic_revision_1264774563/cjt/images/icons/success.png\"></td></tr></table>\n<table style=\"border-bottom: 1px #ccc dotted;\"><tr><td width=\"100%\"><pre>Setting Reseller Privs......Done</pre></td><td width=\"30\"><img align=absmiddle src=\"/cPanel_magic_revision_1264774563/cjt/images/icons/success.png\"></td></tr></table>\n<table style=\"border-bottom: 1px #ccc dotted;\"><tr><td width=\"100%\"><pre>Account Creation Complete!!!...Account Creation Ok...Done</pre></td><td width=\"30\"><img align=absmiddle src=\"/cPanel_magic_revision_1264774563/cjt/images/icons/success.png\"></td></tr></table>\n","options":{"nameserver4":null,"nameserver":"ns1.krystal.co.uk","nameserverentry2":null,"nameserverentry3":null,"nameserverentry4":null,"nameserverentry":null,"ip":"77.72.7.154","nameservera2":null,"nameservera3":null,"package":"default","nameservera4":null,"nameserver2":"ns2.krystal.co.uk","nameservera":null,"nameserver3":null}}]}

data/test/fixtures/passwd_fail.json

@@ -0,0 +1 @@
+{"passwd":[{"status":0,"services":null,"statusmsg":"Sorry, the user bob2 does not exist.","rawout":null}]}

data/test/fixtures/passwd_success.json

@@ -0,0 +1 @@
+{"passwd":[{"status":1,"services":[{"app":"system"},{"app":"ftp"},{"app":"mail"},{"app":"mySQL"}],"statusmsg":"Password changed for user bob","rawout":"Changing password for bob\nPassword for bob has been changed\nUpdating ftp passwords for bob\nFtp password files updated.\nFtp vhost passwords synced\n"}]}

data/test/test_helper.rb

@@ -0,0 +1,25 @@
+$:.unshift File.join( File.dirname(File.dirname(__FILE__)), 'lib' )
+ 
+require 'rubygems'
+
+require 'panelbeater'
+ 
+require 'test/unit'
+require 'shoulda'
+require 'fakeweb'
+ 
+class Test::Unit::TestCase
+  
+  # we don't want any connections to the outside world
+  FakeWeb.allow_net_connect = false
+  
+  # include RR::Adapters::TestUnit
+  
+  # def response(name)
+  #   Pepper::Stanzas::Epp.parse File.read( File.join(File.dirname(__FILE__),"fixtures", "#{name}.xml") )
+  # end
+  
+  def fixture(name)
+    File.read( File.join(File.dirname(__FILE__),"fixtures", "#{name}.json") )
+  end
+end

data/test/whm_test.rb

@@ -0,0 +1,80 @@
+$:.unshift File.dirname(__FILE__)
+require "test_helper"
+
+class WhmTest < Test::Unit::TestCase
+  
+  def setup
+    FakeWeb.clean_registry
+    @expected_url = 'https://cpanel.server.local:2087/json-api/'
+    @connection = CpanelApi::Whm::Commands.new({ :url => 'cpanel.server.local', :api_key => '1234' })
+  end
+  
+  
+  context "404 error handling" do
+    setup do
+      FakeWeb.register_uri(:get, "#{@expected_url}applist?", :body => '', :status => ["404", "Not Found"])
+      @response = @connection.applist
+    end
+
+    should "return an error status" do
+      assert_equal 'Not Found', @response.message
+      assert_equal '404', @response.code
+    end
+  end
+  
+  
+  
+  context "getting a list of commands the server supports" do
+    setup do
+      FakeWeb.register_uri(:get, "#{@expected_url}applist?", :body => fixture('applist'))
+      @response = @connection.applist
+    end
+
+    should "return a list of commands" do
+      assert_equal JSON.parse(fixture('applist')), @response.json
+    end
+  end
+  
+  
+  context "creating a new account" do
+    setup do
+      FakeWeb.register_uri  :get,
+      "#{@expected_url}createacct?cpmod=x3&maxlst=0&hasshell=n&reseller=0&featurelist=default&ip=n&username=amos&cgi=y&frontpage=n",
+                            :body => fixture('createacct_success')
+      @response = @connection.createacct :username => 'amos'
+    end
+
+    should "return a list of commands" do
+      assert_equal JSON.parse(fixture('createacct_success')), @response.json
+    end
+  end
+  
+  
+  context "creating a new account with key mappings" do
+    setup do
+      FakeWeb.register_uri  :get,
+      "#{@expected_url}createacct?cpmod=x3&maxlst=0&hasshell=n&reseller=0&featurelist=default&ip=n&username=amos&cgi=y&frontpage=n",
+                            :body => fixture('createacct_success')
+      @response = @connection.createacct({ :krazy => 'amos' }, { :krazy => :username })
+    end
+
+    should "return a list of commands" do
+      assert_equal JSON.parse(fixture('createacct_success')), @response.json
+    end
+  end
+  
+  
+  context "changing a users password" do
+    setup do
+      FakeWeb.register_uri  :get,
+      "#{@expected_url}passwd?user=bob&pass=hello",
+                            :body => fixture('passwd_success')
+      @response = @connection.passwd('bob', 'hello')
+    end
+
+    should "return a list of commands" do
+      assert_equal JSON.parse(fixture('passwd_success')), @response.json
+    end
+  end
+
+end

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification 
+name: panelbeater
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Jamie Dyer
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-01-29 00:00:00 +00:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: json
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: shoulda
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: fakeweb
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: 
+email: jamie@kernowsoul.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- cpanel-gem.gemspec
+- lib/panelbeater/cpanel/commands.rb
+- lib/panelbeater/model.rb
+- lib/panelbeater/remote.rb
+- lib/panelbeater/response.rb
+- lib/panelbeater/whm/commands.rb
+- lib/panelbeater.rb
+- pkg/cpanel-gem-0.1.0.gem
+- Rakefile
+- Readme.markdown
+- test/fixtures/applist.json
+- test/fixtures/createacct_fail.json
+- test/fixtures/createacct_success.json
+- test/fixtures/passwd_fail.json
+- test/fixtures/passwd_success.json
+- test/test_helper.rb
+- test/whm_test.rb
+has_rdoc: true
+homepage: http://kernowsoul.com
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+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.3.5
+signing_key: 
+specification_version: 3
+summary: A gem for communicating with the cPanel and WHM API's
+test_files: 
+- test/fixtures/applist.json
+- test/fixtures/createacct_fail.json
+- test/fixtures/createacct_success.json
+- test/fixtures/passwd_fail.json
+- test/fixtures/passwd_success.json
+- test/test_helper.rb
+- test/whm_test.rb