lumberg 0.9.5

data/lib/lumberg/whm/base.rb

@@ -0,0 +1,28 @@
+module Lumberg
+  module Whm
+    class Base
+      # Whm::Server
+      attr_accessor :server
+
+      #
+      # ==== Required 
+      #  * <tt>:server</tt> - PENDING
+      def initialize(options = {})
+        Args.new(options) do |c|
+          c.requires :server
+        end
+     
+        @server = setup_server options.delete(:server) 
+      end
+
+      def setup_server(value)
+        if value.is_a?(Whm::Server) 
+          value
+        else
+          Whm::Server.new value
+        end
+      end
+
+    end
+  end
+end

data/lib/lumberg/whm/dns.rb

@@ -0,0 +1,205 @@
+module Lumberg
+  module Whm
+    class Dns < Base
+      # Creates a DNS zone. All zone information other than domain name and IP address is created based on the standard zone template in WHM.
+      # Your MX, nameserver, domain PTR, and A records will all be generated automatically
+      #
+      # ==== Required 
+      #  * <tt>:domain</tt> - PENDING
+      #  * <tt>:ip</tt> - PENDING
+      #
+      # ==== Optional 
+      #  * <tt>:template</tt> - PENDING
+      #  * <tt>:trueowner</tt> - PENDING
+      def add_zone(options = {})
+        Args.new(options) do |c|
+          c.requires :domain, :ip
+          c.optionals :template, :trueowner
+        end
+
+        server.perform_request('adddns', options)
+      end
+
+      # Adds a DNS zone record to the server
+      #
+      # ==== Required 
+      #  * <tt>:zone</tt> - PENDING
+      #
+      # ==== Optional 
+      #  * <tt>:name</tt> - PENDING
+      #  * <tt>:address</tt> - PENDING
+      #  * <tt>:type</tt> - PENDING
+      #  * <tt>:class</tt> - PENDING
+      #  * <tt>:cname</tt> - PENDING
+      #  * <tt>:exchange</tt> - PENDING
+      #  * <tt>:nsdname</tt> - PENDING
+      #  * <tt>:ptdrname</tt> - PENDING
+      #  * <tt>:preference</tt> - PENDING
+      #  * <tt>:ttl</tt> - PENDING
+      def add_zone_record(options = {})
+        Args.new(options) do |c|
+          c.requires :zone
+          c.optionals :name, :address, :type, :class, :cname, :exchange, :nsdname, :ptdrname, :preference, :ttl
+        end
+
+        server.perform_request('addzonerecord', options)
+      end
+
+      # Generates a list of all domains and corresponding DNS zones associated with your server
+      def list_zones(options = {})
+        server.perform_request('listzones', options.merge(:key => 'zone'))
+      end
+
+      # Return zone records for a domain.
+      # 
+      # To use this function most effectively, you may first wish to run the dumpzone function for the domain(s) whose record(s) you wish to retrieve. 
+      # The Line output variable from that function call can then be used as a reference to create the input for this function.
+      #
+      # ==== Required 
+      #  * <tt>:domain</tt> - PENDING
+      #  * <tt>:Line</tt> - PENDING
+      def get_zone_record(options = {})
+        Args.new(options) do |c|
+          c.requires :domain, :Line
+        end
+
+        server.perform_request('getzonerecord', options)
+      end
+
+      # Displays the DNS zone configuration for a specific domain
+      #
+      # ==== Required 
+      #  * <tt>:domain</tt> - PENDING
+      def dump_zone(options = {})
+        Args.new(options) do |c|
+          c.requires :domain
+        end
+
+        server.perform_request('dumpzone', options)
+      end
+
+      # Attempts to resolve an IP address for a specified domain name
+      #
+      # ==== Required 
+      #  * <tt>:domain</tt> - PENDING
+      #  * <tt>:"api.version".to_sym</tt> - PENDING
+      def resolve_domain(options = {})
+        Args.new(options) do |c|
+          c.requires :domain, "api.version".to_sym
+        end
+
+        server.perform_request('resolvedomainname', options.merge(:key => 'data'))
+      end
+
+      # Allows you to edit a DNS zone record on the server.
+      #
+      # To use this function most effectively, you should first run the dumpzone function for the domain(s) whose record(s) you wish to edit. 
+      # The output of that function call will be used as a reference to create the input for this function.
+      #
+      # ==== Required 
+      #  * <tt>:domain</tt> - PENDING
+      #  * <tt>:Line</tt> - PENDING
+      #
+      # ==== Optional 
+      #  * <tt>:address</tt> - PENDING
+      #  * <tt>:class</tt> - PENDING
+      #  * <tt>:cname</tt> - PENDING
+      #  * <tt>:exchange</tt> - PENDING
+      #  * <tt>:preference</tt> - PENDING
+      #  * <tt>:expire</tt> - PENDING
+      #  * <tt>:minimum</tt> - PENDING
+      #  * <tt>:mname</tt> - PENDING
+      def edit_zone_record(options = {})
+        Args.new(options) do |c|
+          c.requires :domain, :Line
+          c.optionals :address, :class, :cname, :exchange, :preference, :expire, :minimum, :mname,
+                      :name, :nsdname, :raw, :refresh, :retry, :rname, :serial, :ttl, :type, :txtdata
+        end
+
+        server.perform_request('editzonerecord', options)
+      end
+
+      # Deletes a DNS zone
+      #
+      # ==== Required 
+      #  * <tt>:domain</tt> - PENDING
+      def kill_dns(options = {})
+        Args.new(options) do |c|
+          c.requires :domain
+        end
+
+        server.perform_request('killdns', options)
+      end
+
+      # Obtains the IP address of a registered nameserver from the root nameservers
+      #
+      # ==== Required 
+      #  * <tt>:nameserver</tt> - PENDING
+      def lookup_nameserver_ip(options = {})
+        Args.new(options) do |c|
+          c.requires :nameserver
+        end
+
+        server.perform_request('lookupnsip', options.merge(:key => 'ip'))
+      end
+
+      # Allows you to remove a DNS zone record from the server.
+      # 
+      # To use this function most effectively, you should first run the dumpzone function for the domain(s) whose record(s) you wish to remove. 
+      # The output of that function call will be used as a reference to create the input for this function.
+      #
+      # ==== Required 
+      #  * <tt>:zone</tt> - PENDING
+      #  * <tt>:Line</tt> - PENDING
+      def remove_zone_record(options = {})
+        Args.new(options) do |c|
+          c.requires :zone, :Line
+        end
+
+        server.perform_request('removezonerecord', options)
+      end
+
+      # Restore a DNS zone to its default values. This includes any subdomain DNS records associated with the domain.
+      # 
+      # This function can be useful for restoring DNS zones that have become corrupted or have been improperly edited. 
+      # It will also restore zone file subdomains listed in the server's httpd.conf file, along with default settings for new accounts.
+      #
+      # ==== Required 
+      #  * <tt>:domain</tt> - PENDING
+      #  * <tt>:zone</tt> - PENDING
+      def reset_zone(options = {})
+        Args.new(options) do |c|
+          c.requires :domain, :zone
+        end
+
+        server.perform_request('resetzone', options)
+      end
+
+      # This function will list a specified domain's MX records
+      #
+      # *This function is only available in version 11.27/11.28+*
+      #
+      # ==== Required 
+      #  * <tt>:domain</tt> - PENDING
+      #  * <tt>:"api.version".to_sym</tt> - PENDING
+      def list_mxs(options = {})
+        Args.new(options) do |c|
+          c.requires :domain, "api.version".to_sym
+        end
+
+        server.perform_request('listmxs', options.merge(:key => 'data'))
+      end
+
+      # This function will add an MX record
+      #
+      # *This function is only available in version 11.27/11.28+*
+      def save_mx(options = {})
+        Args.new(options) do |c|
+          c.requires "api.version".to_sym, :domain, :name, :exchange, :preference
+        end
+
+        server.perform_request('savemxs', options)
+      end
+    end
+  end
+end

data/lib/lumberg/whm/reseller.rb

@@ -0,0 +1,268 @@
+module Lumberg
+  module Whm
+    class Reseller < Base
+      # Gives reseller status to an account.
+      #
+      # *Note:* The user must already exist to be made a reseller. This function will not create an account. If the account does not yet exist, you can use the createacct function to set it up before conferring reseller privileges.
+      #
+      # ==== Required 
+      #  * <tt>:username</tt> - PENDING
+      def create(options = {})
+        Args.new(options) do |c| 
+          c.requires :username 
+          c.booleans :makeowner
+        end
+        options[:user] = options.delete(:username)
+        server.perform_request('setupreseller', options)
+      end
+
+      # Lists the usernames of all resellers on the server
+      def list
+        # This method is funky. That is all
+        result = server.perform_request('listresellers', :key => 'reseller')
+        result[:success] = true
+        result[:params]  = {:resellers => result.delete(:params)}
+        result
+      end
+
+      # Adds IP addresses to a reseller account
+      #
+      # ==== Required 
+      #  * <tt>:username</tt> - PENDING
+      #
+      # ==== Optional 
+      #  * <tt>:ips</tt> - PENDING
+      def add_ips(options = {})
+        Args.new(options) do |c|
+          c.requires :username
+          c.optionals :ips
+          c.booleans :delegate
+        end
+
+        options[:user] = options.delete(:username)
+        server.perform_request('setresellerips', options)
+      end
+
+      # Specifies the amount of bandwidth and disk space a reseller is able to use
+      #
+      # ==== Required 
+      #  * <tt>:username</tt> - PENDING
+      #
+      # ==== Optional 
+      #  * <tt>:account_limit</tt> - PENDING
+      #  * <tt>:bandwidth_limit</tt> - PENDING
+      #  * <tt>:diskspace_limit</tt> - PENDING
+      def set_limits(options = {})
+        Args.new(options) do |c|
+          c.requires :username
+          c.optionals :account_limit, :bandwidth_limit, :diskspace_limit
+          c.booleans :enable_account_limit, :enable_resource_limits, :enable_overselling,
+                     :enable_overselling_bandwidth, :enable_overselling_diskspace, :enable_package_limits,
+                     :enable_package_limit_numbers
+        end
+
+        options[:user] = options.delete(:username)
+        server.perform_request('setresellerlimits', options)
+      end
+
+      # Terminates a reseller's main account, as well as all accounts owned by the reseller
+      #
+      # ==== Required 
+      #  * <tt>:reseller</tt> - PENDING
+      def terminate(options = {})
+        Args.new(options) do |c|
+          c.requires :reseller
+          c.booleans :terminatereseller
+        end
+      
+        # WTF, seriously?
+        wtf = "I understand this will irrevocably remove all the "
+        wtf << "accounts owned by the reseller #{options[:reseller]}"
+        options[:verify]  = wtf
+
+        server.perform_request('terminatereseller', options)
+      end
+
+      # Assigns a main, shared IP address to a reseller
+      #
+      # ==== Required 
+      #  * <tt>:username</tt> - PENDING
+      #  * <tt>:ip</tt> - PENDING
+      def set_main_ip(options = {})
+        Args.new(options) do |c|
+          c.requires :username, :ip
+        end
+
+        options[:user] = options.delete(:username)
+        server.perform_request('setresellermainip', options)
+      end
+
+      # Sets which packages resellers are able to use. It also allows you to define the number of times a package can be used by a reseller
+      #
+      # ==== Required 
+      #  * <tt>:username</tt> - PENDING
+      #  * <tt>:no_limit</tt> - PENDING
+      #  * <tt>:package</tt> - PENDING
+      #
+      # ==== Optional 
+      #  * <tt>:allowed</tt> - PENDING
+      #  * <tt>:number</tt> - PENDING
+      def set_package_limit(options = {})
+        Args.new(options) do |c|
+          c.requires :username, :no_limit, :package
+          c.booleans :no_limit, :allowed
+          c.optionals :allowed, :number
+        end
+
+        options[:user] = options.delete(:username)
+        server.perform_request('setresellerpackagelimit', options)
+      end
+
+      # Suspends a reseller's account. The suspension will prevent the reseller from accessing his or her account
+      #
+      # ==== Required 
+      #  * <tt>:username</tt> - PENDING
+      #
+      # ==== Optional 
+      #  * <tt>:reason</tt> - PENDING
+      def suspend(options = {})
+        Args.new(options) do |c|
+          c.requires :username
+          c.optionals :reason
+        end
+
+        options[:user] = options.delete(:username)
+        server.perform_request('suspendreseller', options)
+      end
+
+      # Unsuspends a reseller's account
+      #
+      # ==== Required 
+      #  * <tt>:username</tt> - PENDING
+      def unsuspend(options = {})
+        Args.new(options) do |c|
+          c.requires :username
+        end
+
+        options[:user] = options.delete(:username)
+        server.perform_request('unsuspendreseller', options)
+      end
+
+      # Lists the total number of accounts owned by a reseller, as well as how many suspended accounts the reseller owns, and what the reseller's account creation limit is, if any.
+      # If no reseller is specified, counts will be provided for the reseller who is currently logged in.
+      # 
+      # *Note:* Counts for other users will only be provided if the user issuing the function call has root-level permissions or owns the provided account.
+      #
+      # ==== Required 
+      #  * <tt>:username</tt> - PENDING
+      def account_counts(options = {})
+        Args.new(options) do |c|
+          c.requires :username
+        end
+
+        options[:user] = options.delete(:username)
+        server.perform_request('acctcounts', options.merge(:key => 'reseller'))
+      end
+
+      # Defines a reseller's nameservers. Additionally, you may use it to reset a reseller's nameservers to the default settings
+      #
+      # ==== Required 
+      #  * <tt>:username</tt> - PENDING
+      #
+      # ==== Optional 
+      #  * <tt>:nameservers</tt> - PENDING
+      def set_nameservers(options = {})
+        Args.new(options) do |c|
+          c.requires :username
+          c.optionals :nameservers
+        end
+
+        options[:user] = options.delete(:username)
+        server.perform_request('setresellernameservers', options)
+      end
+
+      # Shows account statistics for a specific reseller's accounts
+      #
+      # ==== Required 
+      #  * <tt>:reseller</tt> - PENDING
+      def stats(options = {})
+        Args.new(options) do |c|
+          c.requires :reseller
+        end
+
+        server.perform_request('resellerstats', options)
+      end
+
+      # Lists the saved reseller ACL lists on the server
+      def list_acls
+        server.perform_request('listacls', {:key => 'acls'})
+      end
+
+      # Creates a new reseller ACL list
+      #
+      # ==== Required 
+      #  * <tt>:acllist</tt> - PENDING
+      def save_acl_list(options = {})
+        optional_args = [
+                  "acl-add-pkg", "acl-add-pkg-ip", "acl-add-pkg-shell", "acl-all", "acl-allow-addoncreate", 
+                  "acl-allow-parkedcreate", "acl-allow-unlimited-disk-pkgs", "acl-allow-unlimited-pkgs", 
+                  "acl-clustering", "acl-create-acct", "acl-create-dns", "acl-demo-setup", "acl-disallow-shell", 
+                  "acl-edit-account", "acl-edit-dns", "acl-edit-mx", "acl-edit-pkg", "acl-frontpage", 
+                  "acl-kill-acct", "acl-kill-dns", "acl-limit-bandwidth", "acl-list-accts", "acl-mailcheck",
+                  "acl-mod-subdomains", "acl-news", "acl-onlyselfandglobalpkgs", "acl-park-dns", "acl-passwd", 
+                  "acl-quota", "acl-rearrange-accts", "acl-res-cart", "acl-status", "acl-resftp", "acl-restart", 
+                  "acl-show-bandwidth", "acl-ssl", "acl-ssl-gencrt", "acl-stats", "acl-suspend-acct", "acl-upgrade-account"
+        ].collect { |option| option.to_sym }
+
+        Args.new(options) do |c|
+          c.requires :acllist
+          c.booleans *optional_args 
+          c.optionals *optional_args
+        end
+
+        server.perform_request('saveacllist', options.merge(:key => 'results'))
+      end
+
+      # Sets the ACL for a reseller, or modifies specific ACL items for a reseller
+      #
+      # ==== Required 
+      #  * <tt>:reseller</tt> - PENDING
+      #
+      # ==== Optional 
+      #  * <tt>:acllist</tt> - PENDING
+      #  * <tt>:*optional_args</tt> - PENDING
+      def set_acls(options = {})
+        optional_args = [
+                  "acl-add-pkg", "acl-add-pkg-ip", "acl-add-pkg-shell", "acl-all", "acl-allow-addoncreate", 
+                  "acl-allow-parkedcreate", "acl-allow-unlimited-disk-pkgs", "acl-allow-unlimited-pkgs", 
+                  "acl-clustering", "acl-create-acct", "acl-create-dns", "acl-demo-setup", "acl-disallow-shell", 
+                  "acl-edit-account", "acl-edit-dns", "acl-edit-mx", "acl-edit-pkg", "acl-frontpage", 
+                  "acl-kill-acct", "acl-kill-dns", "acl-limit-bandwidth", "acl-list-accts", "acl-mailcheck",
+                  "acl-mod-subdomains", "acl-news", "acl-onlyselfandglobalpkgs", "acl-park-dns", "acl-passwd", 
+                  "acl-quota", "acl-rearrange-accts", "acl-res-cart", "acl-status", "acl-resftp", "acl-restart", 
+                  "acl-show-bandwidth", "acl-ssl", "acl-ssl-gencrt", "acl-stats", "acl-suspend-acct", "acl-upgrade-account"
+        ].collect { |option| option.to_sym }
+
+        Args.new(options) do |c|
+          c.requires :reseller
+          c.booleans *optional_args
+          c.optionals :acllist, *optional_args
+        end
+
+        server.perform_request('setacls', options)
+      end
+
+      # Removes reseller status from an account
+      #
+      #  *Note:* This function will not delete the account; it will only remove its reseller status
+      def unsetup(options = {})
+        Args.new(options) do |c|
+          c.requires :username
+        end
+
+        options[:user] = options.delete(:username)
+        server.perform_request('unsetupreseller', options)
+      end
+    end
+  end
+end