lumberg 2.0.0.pre4 → 2.0.0.pre5

data/lib/lumberg/cpanel/domain_lookup.rb

@@ -13,7 +13,7 @@ module Lumberg
       #
       # Returns Hash API response.
       def list
-        perform_request({ :api_function => 'getbasedomains' })
+        perform_request({ api_function: 'getbasedomains' })
       end
 
       # Public: Retrieve the absolute and relative paths to a specific domain's
@@ -34,7 +34,7 @@ module Lumberg
       #
       # Returns Hash API response.
       def document_root(options = {})
-        perform_request({ :api_function => 'getdocroot' }.merge(options))
+        perform_request({ api_function: 'getdocroot' }.merge(options))
       end
       alias :docroot :document_root
 
@@ -48,7 +48,7 @@ module Lumberg
       #
       # Returns Hash API response.
       def document_roots
-        perform_request({ :api_function => 'getdocroots' })
+        perform_request({ api_function: 'getdocroots' })
       end
       alias :docroots :document_roots
 
@@ -63,7 +63,7 @@ module Lumberg
       #
       # Returns Hash API response.
       def count
-        perform_request({ :api_function => 'countbasedomains' })
+        perform_request({ api_function: 'countbasedomains' })
       end
     end
   end

data/lib/lumberg/cpanel/email.rb

@@ -9,7 +9,7 @@ module Lumberg
       # Returns Hash API response.
       def main_discard(options = {})
         perform_request(
-          :api_function => "checkmaindiscard"
+          api_function: "checkmaindiscard"
         )
       end
 
@@ -31,7 +31,7 @@ module Lumberg
       # Returns Hash API response.
       def add_forwarder(options = {})
         perform_request({
-          :api_function => "addforward"
+          api_function: "addforward"
         }.merge(options))
       end
 
@@ -44,7 +44,7 @@ module Lumberg
       # Returns Hash API response.
       def forwarders(options = {})
         perform_request({
-          :api_function => "listforwards"
+          api_function: "listforwards"
         }.merge(options))
       end
 
@@ -56,7 +56,7 @@ module Lumberg
       # Returns Hash API response.
       def domains_with_aliases(options = {})
         perform_request(
-          :api_function => "listaliasbackups"
+          api_function: "listaliasbackups"
         )
       end
 
@@ -71,11 +71,11 @@ module Lumberg
       # Returns Hash API response.
       def add_mailing_list(options = {})
         perform_request({
-          :api_function => "addlist",
-          :api_version  => 1,
-          "arg-0"       => options[:list],
-          "arg-1"       => options[:password],
-          "arg-2"       => options[:domain]
+          api_function: "addlist",
+          api_version:  1,
+          "arg-0"    => options[:list],
+          "arg-1"    => options[:password],
+          "arg-2"    => options[:domain]
         })
       end
 
@@ -89,7 +89,7 @@ module Lumberg
       # Returns Hash API response.
       def mailing_lists(options = {})
         perform_request({
-          :api_function => "listlists"
+          api_function: "listlists"
         }.merge(options))
       end
 
@@ -101,7 +101,7 @@ module Lumberg
       # Returns Hash API response.
       def domains(options = {})
         perform_request({
-          :api_function => "listmaildomains"
+          api_function: "listmaildomains"
         }.merge(options))
       end
 
@@ -119,7 +119,7 @@ module Lumberg
       #
       # Returns Hash API response.
       def change_mx(options = {})
-        perform_request({ :api_function => "changemx" }.merge(options))
+        perform_request({ api_function: "changemx" }.merge(options))
       end
 
       # Public: Add an MX record
@@ -134,7 +134,7 @@ module Lumberg
       #
       # Returns Hash API response.
       def add_mx(options = {})
-        perform_request({ :api_function => "addmx" }.merge(options))
+        perform_request({ api_function: "addmx" }.merge(options))
       end
 
       # Public: Get list of mail exchanger information.
@@ -145,7 +145,7 @@ module Lumberg
       # Returns Hash API response.
       def mx(options = {})
         perform_request({
-          :api_function => "listmxs"
+          api_function: "listmxs"
         }.merge(options))
       end
 
@@ -158,7 +158,7 @@ module Lumberg
       #
       # Returns Hash API response.
       def delete_mx(options = {})
-        perform_request({ :api_function => "delmx" }.merge(options))
+        perform_request({ api_function: "delmx" }.merge(options))
       end
 
       # Public: Set a mail exchanger for a specified domain to local,
@@ -171,7 +171,7 @@ module Lumberg
       #
       # Returns Hash API response.
       def set_mx_type(options = {})
-        perform_request({ :api_function => "setmxcheck" }.merge(options))
+        perform_request({ api_function: "setmxcheck" }.merge(options))
       end
 
       # Public: Set mail delivery for a domain.
@@ -186,8 +186,8 @@ module Lumberg
       # Returns Hash API response.
       def set_mail_delivery(options = {})
         perform_request({
-          :api_function => "setalwaysaccept",
-          :mxcheck      => options[:delivery]
+          api_function: "setalwaysaccept",
+          mxcheck:      options[:delivery]
         }.merge(options))
       end
 
@@ -201,7 +201,7 @@ module Lumberg
       # Returns Hash API response.
       def check_local_delivery(options = {})
         perform_request({
-          :api_function => "getalwaysaccept"
+          api_function: "getalwaysaccept"
         }.merge(options))
       end
 
@@ -245,7 +245,7 @@ module Lumberg
       # Returns Hash API response.
       def add_filter(options = {})
         perform_request({
-          :api_function => "storefilter"
+          api_function: "storefilter"
         }.merge(options))
       end
 
@@ -264,7 +264,7 @@ module Lumberg
         func = options.delete(:old_style) ? "listfilters" : "filterlist"
 
         perform_request({
-          :api_function => func
+          api_function: func
         }.merge(options))
       end
 
@@ -280,7 +280,7 @@ module Lumberg
       # Returns Hash API response.
       def add_account(options = {})
         perform_request({
-          :api_function => "addpop"
+          api_function: "addpop"
         }.merge(options))
       end
 
@@ -306,15 +306,15 @@ module Lumberg
       # Returns Hash API response.
       def accounts(options = {})
         styles = {
-          :with_disk    => "listpopswithdisk",
-          :without_disk => "listpops",
-          :with_image   => "listpopswithimage",
-          :single       => "listpopssingle"
+          with_disk:    "listpopswithdisk",
+          without_disk: "listpops",
+          with_image:   "listpopswithimage",
+          single:       "listpopssingle"
         }
         func = styles.fetch(options.delete(:style), styles[:with_disk])
 
         perform_request({
-          :api_function => func
+          api_function: func
         }.merge(options))
       end
 
@@ -326,7 +326,7 @@ module Lumberg
       # Returns Hash API response.
       def default_address(options = {})
         perform_request({
-          :api_function => "listdefaultaddresses"
+          api_function: "listdefaultaddresses"
         }.merge(options))
       end
 
@@ -339,7 +339,7 @@ module Lumberg
       # Returns Hash API response.
       def disk_usage(options = {})
         perform_request({
-          :api_function => "getdiskusage"
+          api_function: "getdiskusage"
         }.merge(options))
       end
 
@@ -353,7 +353,7 @@ module Lumberg
       # Returns Hash API response.
       def mail_dir(options = {})
         perform_request({
-          :api_function => "getabsbrowsedir"
+          api_function: "getabsbrowsedir"
         }.merge(options))
       end
 
@@ -370,7 +370,7 @@ module Lumberg
       # Returns Hash API response.
       def mail_dirs(options = {})
         perform_request({
-          :api_function => "browseboxes"
+          api_function: "browseboxes"
         }.merge(options))
       end
 
@@ -383,7 +383,7 @@ module Lumberg
       #
       # Returns Hash API response.
       def remove(options = {})
-        perform_request({ :api_function => 'delpop' }.merge(options))
+        perform_request({ api_function: 'delpop' }.merge(options))
       end
 
       # Public: Modify an email account's quota.
@@ -397,14 +397,14 @@ module Lumberg
       #
       # Returns Hash API response.
       def edit_quota(options = {})
-        perform_request({ :api_function => 'editquota' }.merge(options))
+        perform_request({ api_function: 'editquota' }.merge(options))
       end
 
       # Public: Retrieve a list of character encodings supported by cPanel
       #
       # Returns Hash API response.
       def acceptable_encodings
-        perform_request({ :api_function => 'fetchcharmaps' })
+        perform_request({ api_function: 'fetchcharmaps' })
       end
 
       # Public: Retrieve the destination for email forwarded by a domain
@@ -415,7 +415,7 @@ module Lumberg
       #
       # Returns Hash API response
       def listdomainforwards(options = {})
-        perform_request({ :api_function => "listdomainforwards" }.merge(options))
+        perform_request({ api_function: "listdomainforwards" }.merge(options))
       end
 
       # Public: Retrieve a list of auto responders associated with a domain
@@ -428,14 +428,14 @@ module Lumberg
       #
       # Returns Hash API response
       def listautoresponders(options = {})
-        perform_request({ :api_function => "listautoresponders" }.merge(options))
+        perform_request({ api_function: "listautoresponders" }.merge(options))
       end
 
       # Public: Retrieve a list of domains that use domain-level filters
       #
       # Returns Hash API response
       def listfilterbackups
-        perform_request({ :api_function => "listfilterbackups" })
+        perform_request({ api_function: "listfilterbackups" })
       end
 
       # Public: Retrieve a list of email filters
@@ -453,7 +453,7 @@ module Lumberg
       #
       # Returns Hash API response
       def filterlist(options={})
-        perform_request({ :api_function => "filterlist" }.merge(options))
+        perform_request({ api_function: "filterlist" }.merge(options))
       end
 
       # Public: Test the action of account-level mail filters. You can only
@@ -471,7 +471,7 @@ module Lumberg
       # Returns Hash API response
       def tracefilter(options={})
         options[:msg] = options.delete(:message)
-        perform_request({ :api_function => "tracefilter" }.merge(options))
+        perform_request({ api_function: "tracefilter" }.merge(options))
       end
 
       # Public: Retrieve information about an auto responder used by a
@@ -483,7 +483,7 @@ module Lumberg
       #
       # Returns Hash API response
       def fetchautoresponder(options={})
-        perform_request({ :api_function => "fetchautoresponder" }.merge(options))
+        perform_request({ api_function: "fetchautoresponder" }.merge(options))
       end
     end
   end

data/lib/lumberg/cpanel/file_manager.rb

@@ -57,7 +57,7 @@ module Lumberg
         options[:checkleaf]    = options.delete(:check_leaf)
         options[:showdotfiles] = options.delete(:show_dot_files)
 
-        perform_request({ :api_function => 'listfiles' }.merge(options))
+        perform_request({ api_function: 'listfiles' }.merge(options))
       end
 
       # Public: View a file within your home directory. This function also
@@ -74,7 +74,7 @@ module Lumberg
       def show(options = {})
         options[:dir] = options.delete(:directory)
 
-        perform_request({ :api_function => 'viewfile' }.merge(options))
+        perform_request({ api_function: 'viewfile' }.merge(options))
       end
 
       # Public: Retrieve information about specific files
@@ -91,14 +91,14 @@ module Lumberg
       def stat(options = {})
         options[:dir] = options.delete(:directory)
 
-        perform_request({ :api_function => 'statfiles' }.merge(options))
+        perform_request({ api_function: 'statfiles' }.merge(options))
       end
 
       # Public: Retrieve disk usage statistics about your account.
       #
       # Returns Hash API response.
       def disk_usage
-        perform_request({ :api_function => 'getdiskinfo' })
+        perform_request({ api_function: 'getdiskinfo' })
       end
 
       # Public: Perform an operation on a file or group of files. You can use
@@ -138,7 +138,7 @@ module Lumberg
         options[:sourcefiles] = options.delete(:source_files)
         options[:destfiles] = options.delete(:destination_files)
 
-        perform_request({ :api_function => "fileop" }.merge(options))
+        perform_request({ api_function: "fileop" }.merge(options))
       end
     end
   end

data/lib/lumberg/cpanel/ftp.rb

@@ -0,0 +1,101 @@
+module Lumberg
+  module Cpanel
+    class Ftp < Base
+      def self.api_module; "Ftp"; end
+
+      # Public: List FTP accounts associated with the authenticated user's account
+      #
+      # options              - Hash options for API call params (default: {}):
+      #  :include_acct_types - specify which FTP account types to include
+      #  :skip_acct_types    - specify which FTP account types to exclude
+      #
+      # Returns Hash API response.
+      def list_ftp(options = {})
+        perform_request({
+          api_function: "listftp"
+        }.merge(options))
+      end
+
+      # Public: Retrieve a list of FTP sessions associated with the account
+      #
+      # Returns Hash API response.
+      def list_ftp_sessions(options = {})
+        perform_request({
+          api_function: "listftpsessions"
+        }.merge(options))
+      end
+
+      # Public: Generate a list of FTP accounts associated with a cPanel account
+      #         The list will contain each account's disk information
+      #
+      # options              - Hash options for API call params (default: {}):
+      #  :dirhtml            - prepend the 'dir' return variable with a URL
+      #  :include_acct_types - specify which FTP account types to include
+      #  :skip_acct_types    - specify which FTP account types to exclude
+      #
+      # Returns Hash API response.
+      def list_ftp_with_disk(options = {})
+        perform_request({
+          api_function: "listftpwithdisk"
+        }.merge(options))
+      end
+
+      # Public: Change an FTP account's password
+      #
+      # options   - Hash options for API call params (default: {}):
+      #  :user    - The username portion of the FTP account
+      #  :pass    - The new password for the FTP account
+      #
+      # Returns Hash API response.
+      def passwd(options = {})
+        perform_request({
+          api_function: "passwd"
+        }.merge(options))
+      end
+
+      # Public: Add a new FTP account
+      #
+      # options   - Hash options for API call params (default: {}):
+      #  :user    - The username portion of the new FTP account, without the domain
+      #  :pass    - The password for the new FTP account
+      #  :quota   - The new FTP account's quota. The default, 0, indicates that
+      #             the account will not use a quota.
+      #  :homedir - The path to the FTP account's root directory. This value
+      #             should be relative to the account's home directory
+      #
+      # Returns Hash API response.
+      def add_ftp(options = {})
+        perform_request({
+          api_function: "addftp"
+        }.merge(options))
+      end
+
+      # Public: Change an FTP account's quota
+      #
+      # options   - Hash options for API call params (default: {}):
+      #  :user    - The username portion of the FTP account
+      #  :quota   - The new quota (in megabytes) for the FTP account
+      #
+      # Returns Hash API response.
+      def set_quota(options = {})
+        perform_request({
+          api_function: "setquota"
+        }.merge(options))
+      end
+
+      # Public: Delete an FTP account
+      #
+      # options   - Hash options for API call params (default: {}):
+      #  :user    - The name of the account to be removed
+      #  :destroy - A boolean value that indicates whether or not the FTP account's
+      #             home directory should also be deleted
+      #
+      # Returns Hash API response.
+      def del_ftp(options = {})
+        perform_request({
+          api_function: "delftp"
+        }.merge(options))
+      end
+    end
+  end
+end