lumberg 1.0.1 → 2.0.1

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

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/mysql_db.rb

@@ -0,0 +1,190 @@
+module Lumberg
+  module Cpanel
+    # Public: Allows you to manage MySQL Databases, users and other related settings.
+    class MysqlDb < Base
+      def self.api_module; "Mysql"; end
+
+      # Public: Add a new MySQL database to a cPanel account.
+      #
+      # options - Hash options for API call params (default: {}).
+      #   :dbname - String name of the MySQL database to add.
+      #
+      # Returns Hash API response.
+      def add_db(options = {})
+        perform_request({
+          api_function: 'adddb',
+          'arg-0' => options.delete(:dbname)
+        }.merge(default_options(options)))
+      end
+
+      # Public: Create a new MySQL user.
+      #
+      # options - Hash options for API call params (default: {}).
+      #   :username - String MySQL user to create.
+      #   :password - String password for the new MySQL user.
+      #
+      # Returns Hash API respone.
+      def add_user(options = {})
+        perform_request({
+          api_function: 'adduser',
+          'arg-0' => options.delete(:username),
+          'arg-1' => options.delete(:password)
+        }.merge(default_options(options)))
+      end
+
+      # Public: Grant a user permission to access a cPanel account's database.
+      #
+      # options - Hash options for API call params (default: {})
+      #   :dbname - String name of the database to allow the user to access.
+      #   :dbuser - String MySQL user who should be given access to the database.
+      #   :perms_list - A space-separated String containing a list of permissions
+      #                 to grant to the user
+      #                 (e.g. "all" or "alter drop create delete insert update lock" )
+      #
+      # Returns Hash API respone.
+      def add_user_db(options = {})
+        perform_request({
+          api_function: 'adduserdb',
+          'arg-0' => options.delete(:dbname),
+          'arg-1' => options.delete(:dbuser),
+          'arg-2' => options.delete(:perms_list)
+        }.merge(default_options(options)))
+      end
+
+      # Public: Retrieve the number of database users an account has created.
+      #
+      # Returns Hash API response.
+      def number_of_dbs(options = {})
+        perform_request({
+          api_function: 'number_of_dbs'
+        }.merge(default_options(options)))
+      end
+
+      # Public: Run a MySQL database check.
+      #
+      # options - Hash options for API call params (default: {}).
+      #   :dbname - String name of the MySQL database to check.
+      #
+      # Returns Hash API response.
+      def check_db(options = {})
+        perform_request({
+          api_function: 'checkdb',
+          'arg-0' => options.delete(:dbname)
+        }.merge(default_options(options)))
+      end
+
+      # Public: Run a MySQL database repair.
+      #
+      # options - Hash options for API call params (default: {}).
+      #   :dbname - String name of the MySQL database to repair.
+      #
+      # Returns Hash API response.
+      def repair_db(options = {})
+        perform_request({
+          api_function: 'repairdb',
+          'arg-0' => options.delete(:dbname)
+        }.merge(default_options(options)))
+      end
+
+      # Public: Force an update of MySQL privileges and passwords.
+      #
+      # options - Hash options for API call params (default: {})
+      #
+      # Returns Hash API response.
+      def update_privs(options = {})
+        perform_request({
+          api_function: 'updateprivs'
+        }.merge(default_options(options)))
+      end
+
+      # Public: Refresh the cache of MySQL information. This includes users,
+      #         databases, routines and other related information.
+      #
+      # options - Hash options for API call params (default: {})
+      #
+      # Returns Hash API response.
+      def init_cache(options = {})
+        perform_request({
+          api_function: 'initcache'
+        }.merge(default_options(options)))
+      end
+
+      # Public: Disallow a MySQL user from accessing a database.
+      #
+      # options - Hash options for API call params (default: {})
+      #   :dbname - String MySQL database from which to remove the user's permissions.
+      #   :dbuser - String name of the MySQL user to remove.
+      #
+      # Returns Hash API response.
+      def del_user_db(options = {})
+        perform_request({
+          api_function: 'deluserdb',
+          'arg-0' => options.delete(:dbname),
+          'arg-1' => options.delete(:dbuser)
+        }.merge(default_options(options)))
+      end
+
+      # Public: Remove a user from MySQL.
+      #
+      # options - Hash options for API call params (default: {})
+      #   :dbuser - String name of the MySQL user to remove.
+      #             This value must be prefixed with the cPanel username.
+      #             (e.g. cpuser_dbuser)
+      #
+      # Returns Hash API response.
+      def del_user(options = {})
+        perform_request({
+          api_function: 'deluser',
+          'arg-0' => options.delete(:dbuser)
+        }.merge(default_options(options)))
+      end
+
+      # Public: Remove a database from MySQL.
+      #
+      # options - Hash options for API call params (default: {}).
+      #   :dbname - String name of the MySQL database to remove.
+      #            This value must be prefixed with the cPanel username
+      #            (e.g., cpuser_dbname).
+      #
+      # Returns Hash API response.
+      def del_db(options = {})
+        perform_request({
+          api_function: 'deldb',
+          'arg-0' => options.delete(:dbname)
+        }.merge(default_options(options)))
+      end
+
+      # Public: Authorize a remote host to access a cPanel account's MySQL users.
+      #
+      # options - Hash options for API call params (default: {})
+      #   :hostname - String IP address or hostname that should be provided access.
+      #
+      # Returns Hash API response.
+      def add_host(options = {})
+        perform_request({
+         api_function: 'addhost',
+         'arg-0' => options.delete(:hostname)
+        }.merge(default_options(options)))
+      end
+
+      # Public: Remove host access permissions from MySQL.
+      #
+      # options - Hash options for API call params (default: {})
+      #   :host - String IP address or hostname that should be provided access.
+      #
+      # Returns Hash API response.
+      def del_host(options = {})
+        perform_request({
+          api_function: 'delhost',
+          'arg-0' => options.delete(:host)
+        }.merge(default_options(options)))
+      end
+
+      private
+
+      def default_options(options)
+        { api_version: 1, response_key: 'data' }.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/password_strength.rb

@@ -0,0 +1,63 @@
+module Lumberg
+  module Cpanel
+    # Public: This module provides access to cPanel's password scoring system.
+    class PasswordStrength < Base
+      def self.api_module; "PasswdStrength"; end
+
+      # Public: Retrieve the strength of a specified password. This API call
+      #         is only available in cPanel & WHM 11.32.
+      #
+      # options - Hash options for API call params (default: {})
+      #   :password - String password to test strength
+      #
+      # Examples
+      #   api_args = { host: "x.x.x.x", hash: "pass", api_username: "user" }
+      #   passwd_strength = Lumberg::Cpanel::PasswordStrength.new(api_args.dup)
+      #
+      #   passwd_strength.strength(password: "weakpass")
+      #
+      # Returns Hash API response.
+      def strength(options = {})
+        perform_request(options.merge(api_function: 'get_password_strength'))
+      end
+
+      # Public: Return the required password strength for a specific
+      #         application.
+      #
+      # options - Hash options for API call params (default: {})
+      #   :app - String The application corresponding to the password strength
+      #          you would like to retrieve. Accepted values include 'htaccess',
+      #          'passwd', 'ftp', 'createacct', 'bandmin', 'cpaddons', 'pop',
+      #          'sshkey', 'postgres', 'webdisk', and 'mysql'.
+      #
+      # Examples
+      #   api_args = { host: "x.x.x.x", hash: "pass", api_username: "user" }
+      #   password_strength = Lumberg::Cpanel::PasswordStrength.new(api_args.dup)
+      #
+      #   password_strength.required_strength(app: 'htaccess')
+      #
+      # Returns Hash API response.
+      def required_strength(options = {})
+        perform_request(options.merge(api_function: 'get_required_strength'))
+      end
+
+      # Public: Return password strength settings set in WHM's 'Main >>
+      #         Security Center >> Password Strength Configuration' section.
+      #         If this requirement is in place, this function will return
+      #         all password strength requirements on a per-application basis.
+      #
+      # options - Hash options for API call params (default: {})
+      #
+      # Examples
+      #   api_args = { host: "x.x.x.x", hash: "pass", api_username: "user" }
+      #   password_strength = Lumberg::Cpanel::PasswordStrength.new(api_args.dup)
+      #
+      #   password_strength.all_required_strengths
+      #
+      # Returns Hash API response.
+      def all_required_strengths(options = {})
+        perform_request(options.merge(api_function: 'appstrengths'))
+      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
+