lumberg 1.0.1 → 2.0.1

data/lib/lumberg/whm/account.rb

@@ -1,18 +1,18 @@
 module Lumberg
   module Whm
     # Some WHM functions require different params for the same 'thing'
-    # e.g. some accept 'username' while others accept 'user' 
-    # Be sure to keep our API consistent and work around those inconsistencies internally 
+    # e.g. some accept 'username' while others accept 'user'
+    # Be sure to keep our API consistent and work around those inconsistencies internally
     class Account < Base
 
       # Creates a hosting account and sets up its associated domain information
       #
-      # ==== Required 
+      # ==== Required
       #  * <tt>:username</tt> - PENDING
       #  * <tt>:domain</tt> - PENDING
       #  * <tt>:password</tt> - PENDING
       #
-      # ==== Optional 
+      # ==== Optional
       #  * <tt>:plan</tt> - PENDING
       #  * <tt>:pkgname</tt> - PENDING
       #  * <tt>:savepkg</tt> - PENDING
@@ -22,71 +22,44 @@ module Lumberg
       #  * <tt>:cgi</tt> - PENDING
       #  * <tt>:</tt> - PENDING
       def create(options = {})
-        Args.new(options) do |c|
-          c.requires  :username, :domain, :password
-          c.booleans  :savepkg, :ip, :cgi, :frontpage, :hasshell, :useregns, :reseller, :forcedns
-          c.optionals :plan, :pkgname, :savepkg, :featurelist, :quota, :ip, :cgi, 
-                       :frontpage, :hasshell, :contactemail, :cpmod, :maxftp, :maxsql, :maxpop, :maxlst, 
-                       :maxsub, :maxpark, :maxaddon, :bwlimit, :customip, :language, :useregns, :hasuseregns, 
-                       :reseller, :forcedns, :mxcheck
-        end
-
         server.perform_request('createacct', options)
       end
 
       # Permanently removes a cPanel account
       #
-      # ==== Required 
+      # ==== Required
       #  * <tt>:username</tt> - PENDING
       def remove(options = {})
-        Args.new(options) do |c|
-          c.requires  :username
-          c.booleans  :keepdns
-        end
-
         options[:user] = options.delete(:username)
         server.perform_request('removeacct', options)
       end
 
       # Changes the password of a domain owner (cPanel) or reseller (WHM) account
       #
-      # ==== Required 
+      # ==== Required
       #  * <tt>:username</tt> - PENDING
       #  * <tt>:password</tt> - PENDING
       def change_password(options = {})
-        Args.new(options) do |c|
-          c.requires  :username, :password
-          c.booleans  :db_pass_update
-        end
-
         options[:user] = options.delete(:username)
         options[:pass] = options.delete(:password)
-        server.perform_request('passwd', options.merge(:key => 'passwd'))
+        server.perform_request('passwd', options.merge(response_key: 'passwd'))
       end
 
       # Displays pertinent information about a specific account
       #
-      # ==== Required 
+      # ==== Required
       #  * <tt>:username</tt> - PENDING
       def summary(options = {})
-        Args.new(options) do |c|
-          c.requires  :username
-        end
-
         options[:user] = options.delete(:username)
         server.perform_request('accountsummary', options)
       end
 
       # Modifies the bandwidth usage (transfer) limit for a specific account
       #
-      # ==== Required 
+      # ==== Required
       #  * <tt>:username</tt> - PENDING
       #  * <tt>:bwlimit</tt> - PENDING
       def limit_bandwidth(options = {})
-        Args.new(options) do |c|
-          c.requires :username, :bwlimit
-        end
-
         verify_user(options[:username]) do
           options[:user] = options.delete(:username)
           server.perform_request('limitbw', options) do |s|
@@ -98,14 +71,10 @@ module Lumberg
       # Lists all accounts on the server, and also allows you to search for a specific account or set of accounts
 
       #
-      # ==== Optional 
+      # ==== Optional
       #  * <tt>:searchtype</tt> - PENDING
       #  * <tt>:search</tt> - PENDING
       def list(options = {})
-        Args.new(options) do |c|
-          c.optionals :searchtype, :search
-        end
-
         server.perform_request('listaccts', options) do |s|
           s.boolean_params = :suspended
         end
@@ -113,10 +82,10 @@ module Lumberg
 
       # Modifies settings for an account
       #
-      # ==== Required 
+      # ==== Required
       #  * <tt>:username</tt> - PENDING
       #
-      # ==== Optional 
+      # ==== Optional
       #  * <tt>:domain</tt> - PENDING
       #  * <tt>:newuser</tt> - PENDING
       #  * <tt>:owner</tt> - PENDING
@@ -133,11 +102,6 @@ module Lumberg
       #  * <tt>:MAXADDON</tt> - PENDING
       #  * <tt>:shell</tt> - PENDING
       def modify(options = {})
-        Args.new(options) do |c|
-          c.requires :username
-          c.optionals :domain, :newuser, :owner, :CPTHEME, :HASCGI, :LANG, :LOCALE, :MAXFTP, :MAXSQL, :MAXPOP, :MAXLST, :MAXSUB, :MAXPARK, :MAXADDON, :shell
-        end
-
         options[:user] = options.delete(:username)
         server.perform_request('modifyacct', options) do |s|
           s.boolean_params = :DEMO
@@ -146,24 +110,20 @@ module Lumberg
 
       # Changes an account's disk space usage quota
       #
-      # ==== Required 
+      # ==== Required
       #  * <tt>:username</tt> - PENDING
       #  * <tt>:quota</tt> - PENDING
       def edit_quota(options = {})
-        Args.new(options) do |c|
-          c.requires :username, :quota
-        end
-
         options[:user] = options.delete(:username)
         server.perform_request('editquota', options)
       end
 
       # Adds a new hosting package
       #
-      # ==== Required 
+      # ==== Required
       #  * <tt>:name</tt> - PENDING
       #
-      # ==== Optional 
+      # ==== Optional
       #  * <tt>:featurelist</tt> - PENDING
       #  * <tt>:quota</tt> - PENDING
       #  * <tt>:ip</tt> - PENDING
@@ -181,69 +141,46 @@ module Lumberg
       #  * <tt>:hasshell</tt> - PENDING
       #  * <tt>:bwlimit</tt> - PENDING
       def add_package(options = {})
-        Args.new(options) do |c|
-          c.requires :name
-          c.optionals :featurelist, :quota, :ip, :cgi, :frontpage, :cpmod, :language, :maxftp, :maxsql, :maxpop, :maxlists, :maxsub, :maxpark, :maxaddon, :hasshell, :bwlimit
-          c.booleans :ip, :cgi, :frontpage, :hasshell
-        end
-
         server.perform_request('addpkg', options)
       end
 
       # Changes the hosting package associated with a cPanel account
       #
-      # ==== Required 
+      # ==== Required
       #  * <tt>:username</tt> - PENDING
       #  * <tt>:pkg</tt> - PENDING
       def change_package(options = {})
-        Args.new(options) do |c|
-          c.requires :username, :pkg
-        end
-
         options[:user] = options.delete(:username)
         server.perform_request('changepackage', options)
       end
 
       # Obtains user data for a specific domain
       #
-      # ==== Required 
+      # ==== Required
       #  * <tt>:domain</tt> - PENDING
       def domain_user_data(options = {})
-        Args.new(options) do |c|
-          c.requires :domain
-        end
-
-        server.perform_request('domainuserdata', options.merge(:key => 'userdata')) do |s|
+        server.perform_request('domainuserdata', options.merge(response_key: 'userdata')) do |s|
           s.boolean_params = :hascgi
         end
       end
 
       # Prevents a cPanel user from accessing his or her account. Once an account is suspended, it can be un-suspended to allow a user to access the account again
       #
-      # ==== Required 
+      # ==== Required
       #  * <tt>:username</tt> - PENDING
       #
-      # ==== Optional 
+      # ==== 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('suspendacct', options)
       end
 
       # Unsuspend a suspended account. When a user's account is unsuspended, he or she will be able to access cPanel again
       #
-      # ==== Required 
+      # ==== 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('unsuspendacct', options)
       end
@@ -255,15 +192,11 @@ module Lumberg
 
       # Generates a list of features you are allowed to use in WHM. Each feature will display either a 1 or 0. You are only able to use features with a corresponding 1
       #
-      # ==== Required 
+      # ==== Required
       #  * <tt>:username</tt> - PENDING
       def privs(options ={})
-        Args.new(options) do |c|
-          c.requires  :username
-        end
-    
         verify_user(options[:username]) do
-          resp = server.perform_request('myprivs', options.merge(:key => 'privs')) do |s|
+          resp = server.perform_request('myprivs', options.merge(response_key: 'privs')) do |s|
             s.boolean_params = :all
           end
           # if you get this far, it's successful
@@ -274,21 +207,16 @@ module Lumberg
 
       # Changes the IP address of a website, or a user account, hosted on your server
       #
-      # ==== Required 
+      # ==== Required
       #  * <tt>:ip</tt> - PENDING
       def set_site_ip(options = {})
-        Args.new(options) do |c|
-          c.requires :ip
-          c.one_of :username, :domain
-        end
-
         options[:user] = options.delete(:username) if options[:username]
         server.perform_request('setsiteip', options)
       end
 
       # Restores a user's account from a backup file. You may restore a monthly, weekly, or daily backup
       #
-      # ==== Required 
+      # ==== Required
       #  * <tt>:username</tt> - PENDING
       #  * <tt>:type</tt> - PENDING
       #  * <tt>:all</tt> - PENDING
@@ -297,18 +225,13 @@ module Lumberg
       #  * <tt>:mysql</tt> - PENDING
       #  * <tt>:subs</tt> - PENDING
       def restore_account(options = {})
-        Args.new(options) do |c|
-          c.requires "api.version".to_sym, :username, :type, :all, :ip, :mail, :mysql, :subs
-          c.booleans :all, :ip, :mail, :mysql, :subs
-        end
-
         options[:user] = options.delete(:username) if options[:username]
-        server.perform_request('restoreaccount', options.merge(:key => 'metadata'))
+        server.perform_request('restoreaccount', options.merge(response_key: 'metadata'))
       end
 
-      protected 
+      protected
       # Some WHM API methods always return a result, even if the user
-      # doesn't actually exist. This makes it seem like your request 
+      # doesn't actually exist. This makes it seem like your request
       # was successful when it really wasn't
       #
       # Example
@@ -316,7 +239,7 @@ module Lumberg
       #      change_password()
       #   end
       def verify_user(username, &block)
-        exists = summary(:username => username)
+        exists = summary(username: username)
         if exists[:success]
           yield
         else

data/lib/lumberg/whm/base.rb

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

data/lib/lumberg/whm/cert.rb

@@ -0,0 +1,88 @@
+module Lumberg
+  module Whm
+    class Cert < Base
+
+      # Displays the SSL certificate, private key, and CA bundle/intermediate
+      # certificate associated with a specified domain. Alternatively, it can
+      # display the private key and CA bundle associated with a specified cert
+      #
+      # ==== Required
+      #  * <tt>:domain</tt> - PENDING
+      #  * <tt>:crtdata</tt> - PENDING
+      #
+      # ==== Optional
+      #  * <tt>none</tt> - PENDING
+      def fetchsslinfo(options = {})
+        server.force_response_type = :ssl
+        result = server.perform_request('fetchsslinfo', options)
+      end
+
+      # Public: Generates a Certificate Signing Request
+      #
+      # options - Hash options for API call params (default: {}):
+      #           :city     - The city in which your server resides.
+      #           :company  - The name of the company.
+      #           :company_division - The division of your company.
+      #           :country  - A two letter abbreviation for the country.
+      #           :email    - A valid email address that will correspond to
+      #                       the certificate signing request
+      #           :host     - The domain that corresponds to the csr.
+      #           :state    - A two letter abbreviation that corresponds to the
+      #                       state.
+      #           :pass     - The password of the csr.
+      #           :xemail   - Email address to which the certificate will be
+      #                       sent (String)
+      #           :noemail  - (Boolean) and dependent value. Set to "1" when
+      #                       :xemail is empty
+      #
+      # Returns Hash API response.
+      def generatessl(options = {})
+        options[:co]  = options.delete(:company)
+        options[:cod] = options.delete(:company_division)
+
+        server.force_response_type = :ssl
+        result = server.perform_request('generatessl', options)
+      end
+
+      # Install an SSL certificate
+      #
+      # ==== Required
+      #  * <tt>:user</tt> - PENDING
+      #  * <tt>:domain</tt> - PENDING
+      #  * <tt>:cert</tt> - PENDING
+      #  * <tt>:key</tt> - PENDING
+      #  * <tt>:cab</tt> - PENDING
+      #  * <tt>:ip</tt> - PENDING
+      #
+      # ==== Optional
+      #  * <tt>none</tt> - PENDING
+      def installssl(options = {})
+        result = server.perform_request('installssl', options)
+      end
+
+      # List all the domains on the server that have SSL certificates installed
+      #
+      # ==== Required
+      #  * <tt>none</tt> - PENDING
+      #
+      # ==== Optional
+      #  * <tt>none</tt> - PENDING
+      def listcrts(options = {})
+        server.force_response_type = :ssl
+        result = server.perform_request('listcrts', options.merge(response_key: 'crt'))
+      end
+
+      # Public: Gets information about each vhost on the server and the SSL
+      # certificates that are installed on them.
+      #
+      # Returs a Hash
+      def fetch_ssl_vhosts
+        server.perform_request(
+          'fetch_ssl_vhosts', { 
+            :"api.version" => 1,
+            response_key:  "data"
+          })
+      end
+    end
+  end
+end

data/lib/lumberg/whm/dns.rb

@@ -4,28 +4,23 @@ module Lumberg
       # 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 
+      # ==== Required
       #  * <tt>:domain</tt> - PENDING
       #  * <tt>:ip</tt> - PENDING
       #
-      # ==== Optional 
+      # ==== 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 
+      # ==== Required
       #  * <tt>:zone</tt> - PENDING
       #
-      # ==== Optional 
+      # ==== Optional
       #  * <tt>:name</tt> - PENDING
       #  * <tt>:address</tt> - PENDING
       #  * <tt>:type</tt> - PENDING
@@ -37,70 +32,53 @@ module Lumberg
       #  * <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'))
+        server.perform_request('listzones', options.merge(response_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. 
+      #
+      # 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 
+      # ==== 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 
+      # ==== 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 
+      # ==== 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'))
+        server.perform_request('resolvedomainname', options.merge(response_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. 
+      # 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 
+      # ==== Required
       #  * <tt>:domain</tt> - PENDING
       #  * <tt>:Line</tt> - PENDING
       #
-      # ==== Optional 
+      # ==== Optional
       #  * <tt>:address</tt> - PENDING
       #  * <tt>:class</tt> - PENDING
       #  * <tt>:cname</tt> - PENDING
@@ -110,94 +88,88 @@ module Lumberg
       #  * <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 
+      # ==== 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 
+      # ==== 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'))
+        server.perform_request('lookupnsip', options.merge(response_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. 
+      #
+      # 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 
+      # ==== 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. 
+      #
+      # 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 
+      # ==== 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 change a specified domain's MX records
+      #
+      # ==== Required
+      #  * <tt>:domain</tt>        - PENDING
+      #  * <tt>:exchange</tt>      - PENDING
+      #  * <tt>:oldexchange</tt>   - PENDING
+      #  * <tt>:oldpreference</tt> - PENDING
+      #  * <tt>:preference</tt>    - PENDING
+      #  * <tt>:alwaysaccept</tt>  - PENDING
+      def change_mx(options = {})
+        server.perform_request('changemx', options.merge(response_key: 'data'))
+      end
+
+      # This function will add an MX record to a  specified domain
+      #
+      # ==== Required
+      #  * <tt>:domain</tt>        - PENDING
+      #  * <tt>:exchange</tt>      - PENDING
+      #  * <tt>:preference</tt>    - PENDING
+      #  * <tt>:alwaysaccept</tt>  - PENDING
+      def add_mx(options = {})
+        server.perform_request('addmx', options.merge(response_key: 'data'))
+      end
+
       # This function will list a specified domain's MX records
       #
       # *This function is only available in version 11.27/11.28+*
       #
-      # ==== Required 
+      # ==== 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'))
+        server.perform_request('listmxs', options.merge(response_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