lumberg 1.0.1 → 2.0.0.pre4

data/lib/lumberg/cpanel/file_manager.rb

@@ -0,0 +1,146 @@
+module Lumberg
+  module Cpanel
+    # Public: This module provides access to file functions such as listing
+    # directories and viewing files.
+    class FileManager < Base
+      def self.api_module; "Fileman"; end
+
+      # Public: list files and attributes contained within a specified
+      # directory
+      #
+      # options   - Hash options for API call params (default: {})
+      #   :check_leaf - Boolean value of "1" will cause the function to add
+      #                 "isleaf" parameter to the output key, e.g: true value
+      #                 (1) indicates a directory that has no subdirectories
+      #                 (default: '')
+      #
+      #   :directory - String directory that contains the files you wish to
+      #                browse, and '/' represents your home directory.
+      #                (default: 'your home directory')
+      #
+      #   :list - A Boolean value of "1" indicates the function to look for
+      #           keys that begin with "filepath-*". These keys are used to
+      #           indicate specific files to list (default: '')
+      #
+      #   :path - String parameter allows you to specify files you want listed
+      #           with the output if :list is set to "1". This can be any
+      #           number of parameters such as "filelist-A", "filelist-B", etc.
+      #           Each of these keys indicate a file you wish to view
+      #           (default:'')
+      #
+      #   :need_mime - A Boolean value of "1" indicates that you would like the
+      #                function to add the 'mimename' and 'mimetype' to output
+      #                (default: '')
+      #
+      #
+      #   :show_dot_files - A Boolean value of "1" indicates that you'd like
+      #                     the function to add dotfiles to output
+      #                     (default: '')
+      #
+      #   :types - String filter allowing you to specify which file types you
+      #            wish to view. Acceptable values include "dir", "file" and
+      #            "special". Separate each type using a pipe (|) to add
+      #            multiple values. (default: '')
+      #
+      # Examples
+      #   api_args = { host: "x.x.x.x", hash: "pass", api_username: "user" }
+      #   file_manager = Lumberg::Cpanel::FileManager.new(api_args.dup)
+      #
+      #   file_manager.list
+      #
+      # Returns Hash API response.
+      def list(options = {})
+        options[:dir]          = options.delete(:directory)
+        options[:filelist]     = options.delete(:list)
+        options[:filepath]     = options.delete(:path)
+        options[:needmime]     = options.delete(:need_mime)
+        options[:checkleaf]    = options.delete(:check_leaf)
+        options[:showdotfiles] = options.delete(:show_dot_files)
+
+        perform_request({ :api_function => 'listfiles' }.merge(options))
+      end
+
+      # Public: View a file within your home directory. This function also
+      # display additional information about the file such as the contents of a
+      # tarball, a link to an image and more
+      #
+      # options - Hash options for API call params (default: {})
+      #   :directory - String directory in which the file is located. Path must
+      #                be relative to user's home, e.g: 'public_html/files/'
+      #                (default: '')
+      #   :file - String path to the file you wish to view
+      #
+      # Returns Hash API response.
+      def show(options = {})
+        options[:dir] = options.delete(:directory)
+
+        perform_request({ :api_function => 'viewfile' }.merge(options))
+      end
+
+      # Public: Retrieve information about specific files
+      #
+      # options - Hash options for API call params (default: {})
+      #   :directory - String directory whose files you wish to review, (e.g:
+      #                /home/user/public_html/files). (default: 'your home')
+      #
+      #   :file - String name of the file whose statistics you wish to review.
+      #           You may define multiple files by separating each value with a
+      #           pipe, e.g: 'file1|file2|file3'
+      #
+      # Returns Hash API response.
+      def stat(options = {})
+        options[:dir] = options.delete(:directory)
+
+        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' })
+      end
+
+      # Public: Perform an operation on a file or group of files. You can use
+      # this function to copy, move, rename, chmod, extract and compress, link
+      # and unlink, and trash files and directories.
+      #
+      # options - Hash options for API call params (default: {})
+      #   :name - String naming the operation to perform. Acceptable values
+      #           include 'copy', 'move', 'rename', 'chmod', 'extract',
+      #           'compress', 'link', 'unlink', and 'trash' (move to .trash
+      #           directory)
+      #   :source_files - String files on which you wish to perform the
+      #                   operation. You can include multiple files by
+      #                   separating each file with a comma (,). Do not add
+      #                   spaces.
+      #   :destination_files - String list of destination filenames. If
+      #                        multiple sourcefiles are listed with multiple
+      #                        destination files ('destfiles'), the function
+      #                        attempts to handle each transaction on a 1-to-1
+      #                        basis. If only 1 file is specified in
+      #                        'sourcefiles', it will be moved, or copied, or
+      #                        etc. to the first directory listed.
+      #   :decode_uri - Boolean value. Entering '1' will cause the function to
+      #                 decode the URI-encoded variables :source_files and
+      #                 :destination_files
+      #   :metadata - String parameter which contains any added values required
+      #               by the named operation. When using 'compress', tihs would
+      #               be the archive type. Acceptable values for the compress
+      #               operation include: tar, gz, bz2, zip, tar.gz and tar.bz2.
+      #               The chmod operation requires octal octal permissions like
+      #               0755 or 0700.
+      #
+      # Returns Hash API response
+      def operate(options={})
+        options[:op] = options.delete(:name)
+        options[:doubledecode] = options.delete(:decode_uri)
+        options[:sourcefiles] = options.delete(:source_files)
+        options[:destfiles] = options.delete(:destination_files)
+
+        perform_request({ :api_function => "fileop" }.merge(options))
+      end
+    end
+  end
+end
+

data/lib/lumberg/cpanel/gpg.rb

@@ -0,0 +1,36 @@
+module Lumberg
+  module Cpanel
+    # Public: Allows users to create and manage GnuPG keys
+    class Gpg < Base
+      # Public: List public GPG keys installed for the user
+      #
+      # Returns Hash API response
+      def list
+        perform_request({ :api_function => 'listgpgkeys' })
+      end
+
+      # Public: Count the number of public GPG keys installed for a user. You
+      # must have access to the 'gpg' feature to use this function.
+      #
+      # Returns Hash API response
+      def count
+        perform_request({ :api_function => 'number_of_public_keys' })
+      end
+
+      # Public: List GPG private (secret) keys associated with a user
+      #
+      # Returns Hash API response
+      def list_private
+        perform_request({ :api_function => 'listsecretgpgkeys' })
+      end
+
+      # Public: Count the number of private GPG keys installed for a user
+      #
+      # Returns Hash API response
+      def count_private
+        perform_request({ :api_function => 'number_of_private_keys' })
+      end
+    end
+  end
+end
+

data/lib/lumberg/cpanel/locale.rb

@@ -0,0 +1,15 @@
+module Lumberg
+  module Cpanel
+    # Public: Allows access into cPanel's language system
+    class Locale < Base
+      # Public: Retrieve a user's character set encoding
+      #
+      # Returns Hash API response
+      def show
+        perform_request({ :api_function => 'get_encoding' })
+      end
+    end
+  end
+end
+
+

data/lib/lumberg/cpanel/mime.rb

@@ -0,0 +1,34 @@
+module Lumberg
+  module Cpanel
+    # Public: Allows users to list mime types and handlers
+    class Mime < Base
+      # Public: List mime types associated with Apache
+      #
+      # options - Hash options for API call params (default: {})
+      #   :system - String parameter allows you to specify whether or not to
+      #             only return system wide mime types (default: '')
+      #   :user - String parameter allows you to specify whether or not to
+      #             only return user defined mime types (default: '')
+      #
+      # Returns Hash API response
+      def list(options = {})
+        perform_request({ :api_function => 'listmime' }.merge(options))
+      end
+
+      # Public: List handlers associated with Apache
+      #
+      # options - Hash options for API call params (default: {})
+      #   :system - String parameter allows you to specify whether or not to
+      #             only return system wide handlers (default: '')
+      #   :user - String parameter allows you to specify whether or not to
+      #             only return user defined handlers (default: '')
+      #
+      # Returns Hash API response
+      def handlers(options = {})
+        perform_request({ :api_function => 'listhandlers' }.merge(options))
+      end
+    end
+  end
+end
+
+

data/lib/lumberg/cpanel/mysql.rb

@@ -0,0 +1,66 @@
+module Lumberg
+  module Cpanel
+    # Public: Allows you to access information about an account's MySQL users,
+    # databases, and permissions
+    class Mysql < Base
+      def self.api_module; "MysqlFE"; end
+      # Public: Retrieve a list of databases that belong to username
+      #
+      # options - Hash options for API call params (default: {})
+      #   :regex - String regular expression to filter results (optional)
+      #
+      # Returns Hash API response
+      def list(options = {})
+        perform_request({ :api_function => 'listdbs' }.merge(options))
+      end
+
+      # Public: List all of the MySQL users available to a cPanel account
+      #
+      # Returns Hash API response
+      def accounts
+        perform_request({ :api_function => 'listusers' })
+      end
+
+      # Public: Retrieve a list of remote MySQL connection hosts
+      #
+      # Returns Hash API response
+      def remote_hosts
+        perform_request({ :api_function => 'listhosts' })
+      end
+
+      # Public: Retrieve a list of existing database backups
+      #
+      # Returns Hash API response
+      def backups
+        perform_request({ :api_function => 'listdbsbackup' })
+      end
+
+      # Public: List users who can access a particular database
+      #
+      # options - Hash options for API call params (default: {})
+      #   :db - String name of the database whose users you wish to review. Be
+      #         sure to use Cpanel convention's full mysql database name, e.g:
+      #         cpanelaccount_databasename
+      #
+      # Returns Hash API response
+      def usernames_for_db(options = {})
+        perform_request({ :api_function => 'listusersindb' })
+      end
+
+      # Public: Retrieve a list of permissions that correspond to a specific
+      # user and database
+      #
+      # options - Hash options for API call params (default: {})
+      #   :db - String database that corresponds to th user whose permission
+      #         you wish to view
+      #   :username - String user whose permissions you wish to view
+      #
+      # Returns Hash API response
+      def permissions(options = {})
+        perform_request({ :api_function => 'userdbprivs' }.merge(options))
+      end
+    end
+  end
+end
+
+

data/lib/lumberg/cpanel/net.rb

@@ -0,0 +1,28 @@
+module Lumberg
+  module Cpanel
+    # Public: Allows users to access networking functions
+    class Net < Base
+      # Public: Perform a traceroute back to your local IP address while
+      # displaying packet speed at each hop in milliseconds.
+      #
+      # Returns Hash API response
+      def traceroute
+        perform_request({ :api_function => 'traceroute' })
+      end
+
+      # Public: Performs an A record DNS query for the hostname presented via
+      # the 'host' variable, with a 60 second timeout. If more than one A record
+      # exists for a given FQDN, all will be returned.
+      #
+      # options - Hash options for API call params (default: {})
+      #   :host - String fully qualified domain name, either host.domain.com or
+      #           domain.com
+      #
+      # Returns Hash API response
+      def query_hostname(options = {})
+        perform_request({ :api_function => 'dnszone' }.merge(options))
+      end
+    end
+  end
+end
+

data/lib/lumberg/cpanel/park.rb

@@ -0,0 +1,58 @@
+module Lumberg
+  module Cpanel
+    class Park < Base
+      # Public: Add a parked domain.
+      #
+      # options - Hash options for API call params (default: {}):
+      #   :domain    - String domain to park.
+      #   :topdomain - String domain to park on top of (optional, default:
+      #                account primary domain).
+      #
+      # Returns Hash API response.
+      def add(options = {})
+        perform_request({
+          :api_function => "park"
+        }.merge(options))
+      end
+
+      # Public: Remove a parked domain.
+      #
+      # options - Hash options for API call params (default: {}):
+      #   :domain - String parked domain to remove.
+      #
+      # Returns Hash API response.
+      def remove(options = {})
+        perform_request({
+          :api_function => "unpark"
+        }.merge(options))
+      end
+
+      # Public: Get a list of parked domains.
+      #
+      # options - Hash options for API call params (default: {}):
+      #   :regex - String regular expression to filter search results
+      #            (optional).
+      #
+      # Returns Hash API response.
+      def list(options = {})
+        perform_request({
+          :api_function => "listparkeddomains"
+        }.merge(options))
+      end
+
+      # Public: Get a list addon domains.
+      #
+      # options - Hash options for API call params (default: {}):
+      #   :regex - String regular expresion to filter search results
+      #            (optional).
+      #
+      # Returns Hash API response.
+      def list_addon_domains(options = {})
+        perform_request({
+          :api_function => "listaddondomains"
+        }.merge(options))
+      end
+
+    end
+  end
+end

data/lib/lumberg/cpanel/password.rb

@@ -0,0 +1,52 @@
+module Lumberg
+  module Cpanel
+    # Public: The Passwd module allows users to change their cPanel account's
+    # password.
+    class Password < Base
+      def self.api_module; "Passwd"; end
+
+      # Public: Change a cPanel account's password.
+      #
+      # options - Hash options for API call params (default: {})
+      #   :newpass - String new password for the Cpanel account
+      #   :oldpass - String old password for the Cpanel account
+      #
+      # Examples
+      #   api_args = { host: "x.x.x.x", hash: "pass", api_username: "user" }
+      #   password = Lumberg::Cpanel::Password.new(api_args.dup)
+      #
+      #   password.modify(new: "", old: "")
+      #
+      # Returns Hash API response.
+      def modify(options = {})
+        perform_request({ :api_function => 'change_password' }.merge(options))
+      end
+
+      # Public: Enables or disables Digest Authentication for an account.
+      #         Windows Vista(R), Windows(R) 7, and Windows(R) 8 require Digest
+      #         Authentication support to be enabled in order to access your
+      #         Web Disk over a clear text, unencrypted connection. If the
+      #         server has a SSL certificate signed by a recognized certificate
+      #         authority and you are able to make an SSL connection over port
+      #         2078, you do not need to enable this.
+      #
+      # options     - Hash options for API call params (default: {})
+      #   :password - String current password for your account
+      #   :enable   - Boolean value indicating if Digest Authentication should
+      #               be enabled or disabled for the web disk user.
+      #
+      # Examples
+      #   api_args = { host: "x.x.x.x", hash: "pass", api_username: "user" }
+      #   password = Lumberg::Cpanel::Password.new(api_args.dup)
+      #
+      #   password.digest_authentication(password: "", enable: true)
+      #
+      # Returns Hash API response.
+      def digest_authentication(options = {})
+        options[:enabledigest] = options.delete([:enable]) ? 1 : 0
+        perform_request({ :api_function => 'set_digest_auth' }.merge(options))
+      end
+    end
+  end
+end
+

data/lib/lumberg/cpanel/random_data.rb

@@ -0,0 +1,25 @@
+module Lumberg
+  module Cpanel
+    # Public: Allows you to create random data
+    class RandomData < Base
+      def self.api_module; "Rand" ; end
+
+      # Public: Retrieve a random string
+      #
+      # options - Hash options for API call params (default: {})
+      #   :length - Integer length of the random string you wish to receive
+      #
+      # Examples
+      #   api_args = { host: "x.x.x.x", hash: "pass", api_username: "user" }
+      #   random_data = Lumberg::Cpanel::RandomData.new(api_args.dup)
+      #
+      #   random_data.show
+      #
+      # Returns Hash API response
+      def show(options = {})
+        perform_request({ :api_function => 'getranddata' }.merge(options))
+      end
+    end
+  end
+end
+

data/lib/lumberg/cpanel/redirect.rb

@@ -0,0 +1,44 @@
+module Lumberg
+  module Cpanel
+    # Public: Allows users to create and manage redirects
+    class Redirect < Base
+      def self.api_module; "Mime"; end
+
+      # Public: List redirects parsed from your various .htaccess files in
+      # human-readable form
+      #
+      # options - Hash options for API call params (default: {})
+      #   :regex - String value to filter results by applying perl regurlar
+      #            expressions to the "sourceurl" output key, and accepts a
+      #            simple string also (default: '')
+      #
+      # Returns Hash API response
+      def list(options = {})
+        perform_request({ :api_function => 'listredirects' }.merge(options))
+      end
+
+      # Public: This function returns either the domain name entered or '** All
+      # Public Domains **'.
+      #
+      # options - Hash options for API call params (default: {})
+      #   :domain - String value. If a domain name is entered, it will be
+      #             returned. If this is set to '.*', '** All Public Domains **'
+      #             will be returned. (default: '')
+      #   :url - String value. If a url is entered, it will be returned. If this
+      #          is set to '.*' or '(.*)', '** All Requests **' will be
+      #          returned (default: '')
+      #
+      # Returns Hash API response
+      def show(options = {})
+        if options[:domain] && options[:url]
+          raise ArgumentError,
+            "#{self.class.name}##{__method__} cannot accept both `:url` and `:domain`"
+        end
+        function = options[:domain].present? ? 'redirectname' : 'redirecturlname'
+        perform_request({ :api_function => function }.merge(options))
+      end
+    end
+  end
+end
+
+