lumberg 1.0.1 → 2.0.1

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
+
+

data/lib/lumberg/cpanel/ssl.rb

@@ -0,0 +1,220 @@
+module Lumberg
+  module Cpanel
+    class Ssl < Base
+      def self.api_module; "SSL"; end
+
+      # Public: Install an SSL certificate, key, and cabundle.
+      #
+      # options - Hash options for API call params (default: {}):
+      #  :cabundle - Contents of the CA bundle file (optional)
+      #  :crt      - Contents of the certificate file
+      #  :domain   - Domain name for the cert (optional)
+      #  :key      - Contents of the key file associated with the CSR
+      #  :subject - String subject line.
+      #
+      # Returns Hash API response.
+      def installssl(options = {})
+        perform_request({
+          api_function: "installssl"
+        }.merge(options))
+      end
+
+      # Public: List CSRs associated with your cPanel account.
+      #
+      # options - Hash options for API call params (default: {}):
+      #
+      # Returns Hash API response.
+      def listcsrs(options = {})
+        perform_request({
+          api_function: "listcsrs",
+        }.merge(options))
+      end
+
+      # Public: Print a specific Certificate Signing Request.
+      #
+      # options - Hash options for API call params (default: {}):
+      #   :domain   - The name of the domain the CSR was generated for.
+      #   :textmode - 0 for human readable, 1 for binary.
+      #
+      # Returns Hash API response.
+      def showcsr(options = {})
+        perform_request({
+          api_function:    "showcsr",
+          api_version:     1,
+          user:            options[:user],
+          response_key:    "data",
+          "arg-0"       => options[:domain],
+          "arg-1"       => options[:textmode]
+        })
+      end
+
+      # Public: Print a key that has already been generated.
+      #
+      # options - Hash options for API call params (default: {}):
+      #   :domain   - The name of the domain the CSR was generated for.
+      #   :textmode - 0 for human readable, 1 for binary.
+      #
+      # Returns Hash API response.
+      def showkey(options = {})
+        perform_request({
+          api_function:    "showkey",
+          api_version:     1,
+          user:            options[:user],
+          response_key:    "data",
+          "arg-0"       => options[:domain],
+          "arg-1"       => options[:textmode]
+        })
+      end
+
+      # Public: Print the current cert for a specific host.
+      #
+      # options - Hash options for API call params (default: {}):
+      #
+      # Returns Hash API response.
+      def showcrt(options = {})
+        perform_request({
+          api_function:    "showcrt",
+          api_version:     1,
+          user:            options[:user],
+          response_key:    "data",
+          "arg-0"       => options[:domain],
+          "arg-1"       => options[:textmode]
+        })
+      end
+
+      # Public: List SSL certificates currently installed for a cPanel account.
+      #
+      # options - Hash options for API call params (default: {}):
+      #
+      # Returns Hash API response.
+      def listcrts(options = {})
+        perform_request({
+          api_function: "listcrts",
+        }.merge(options))
+      end
+
+      # Public: List SSL keys associated with a domain.
+      #
+      # options - Hash options for API call params (default: {}):
+      #
+      # Returns Hash API response.
+      def listkeys(options = {})
+        perform_request({
+          api_function: "listkeys",
+        }.merge(options))
+      end
+
+      # Public: Fetch the cabundle that corresponds to the certificate
+      #
+      # options - Hash options for API call params (default: {}):
+      #  :crt   - Contents of the certificate file
+      #
+      # Returns Hash API response.
+      def fetchcabundle(options = {})
+        perform_request({
+          api_function: "fetchcabundle",
+        }.merge(options))
+      end
+
+      # Public: Query for SSL related items installed via cPanel
+      #
+      # options   - Hash options for API call params (default: {}):
+      #  :domains - The domains you wish to query.
+      #  :items   - The type of SSL items for which you wish to query.
+      #             Acceptable values include 'key', 'crt', and 'csr'.
+      #
+      # Returns Hash API response.
+      def listsslitems(options = {})
+        perform_request({
+          api_function: "listsslitems",
+        }.merge(options))
+      end
+
+      # Public: Generate 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.
+      #
+      # Returns Hash API response.
+      def gencsr(options = {})
+        options[:companydivision] = options.delete(:company_division)
+
+        perform_request({
+          api_function: "gencsr",
+          response_key: "cpanelresult",
+        }.merge(options))
+      end
+
+      # Public: Generate a self-signed SSL certificate for a specific domain.
+      #
+      # 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.
+      #
+      # Returns Hash API response.
+      def gencrt(options = {})
+        options[:companydivision] = options.delete(:company_division)
+
+        perform_request({
+          api_function: "gencrt",
+        }.merge(options))
+      end
+
+      # Public: Generate an SSL key. You must have access to the 'sslmanager'.
+      #
+      # options - Hash options for API call params (default: {}):
+      #  :host       - The domain that corresponds to the csr.
+      #  :keysize    - The size of the key
+      #                Optional, may range from 1024 to 4096.
+      #
+      # Returns Hash API response.
+      def genkey(options = {})
+        perform_request({
+          api_function: "genkey",
+        }.merge(options))
+      end
+
+      # Public: Upload an SSL certificate.
+      #
+      # options - Hash options for API call params (default: {}):
+      #  :crt    - Contents of the SSL certificate
+      #
+      # Returns Hash API response.
+      def uploadcrt(options = {})
+        perform_request({
+          api_function: "uploadcrt",
+        }.merge(options))
+      end
+
+      # Public: Removes a domain's SSL certificate. This function requires
+      # access to the 'sslinstall' feature
+      #
+      # options - Hash options for API call params (default: {})
+      #           domain: String domain corresponding to the SSL certificate
+      #           to remove
+      #
+      # Returns Hash API response
+      def remove(options = {})
+        perform_request({
+          api_version: 1, api_function: "delete", response_key: "data"
+        }.merge(options))
+      end
+    end
+  end
+end

data/lib/lumberg/cpanel/sub_domain.rb

@@ -0,0 +1,61 @@
+module Lumberg
+  module Cpanel
+    class SubDomain < Base
+      # Public: Add a subdomain.
+      #
+      # options - Hash options for API call params (default: {}):
+      #   :domain      - String local part of the subdomain to add.
+      #                  "sub" if "sub.domain.com".
+      #   :rootdomain  - String domain on which to add the subdomain.
+      #   :dir         - String docroot for subdomain (optional, default:
+      #                  "public_html/[:domain value]")
+      #   :disallowdot - String value (optional). Set to "1" to strip "."
+      #                  chars from specified :domain value.
+      #
+      # Returns Hash API response.
+      def add(options = {})
+        perform_request({
+          api_function: "addsubdomain"
+        }.merge(options))
+      end
+
+      # Public: Remove a subdomain.
+      #
+      # options - Hash options for API call params (default: {}):
+      #   :domain - String subdomain to delete.
+      #
+      # Returns Hash API response.
+      def remove(options = {})
+        perform_request({
+          api_function: "delsubdomain"
+        }.merge(options))
+      end
+
+      # Public: Get list of subdomains.
+      #
+      # 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: "listsubdomains"
+        }.merge(options))
+      end
+
+      # Public: Modify the document root of a subdomain
+      #
+      # options - Hash options for API call params (default: {}):
+      #   :dir         - String docroot to which you want to move the subdomain
+      #   :subdomain   - String subdomain whose docroot you want to modify
+      #   :rootdomain  - String domain on which to modify the subdomain
+      #
+      # Returns Hash API response
+      def modify(options = {})
+        perform_request({
+          api_function: "changedocroot"
+        }.merge(options))
+      end
+    end
+  end
+end

data/lib/lumberg/cpanel/support.rb

@@ -0,0 +1,29 @@
+module Lumberg
+  module Cpanel
+    class Support < Base
+      def self.api_module; "Contactus"; end
+
+      # Public: Send a support request.
+      #
+      # options - Hash options for API call params (default: {}):
+      #  :email   - String destination email address.
+      #  :issue   - String brief explantation of issue (body text).
+      #  :subject - String subject line.
+      #
+      # Returns Hash API response.
+      def open_ticket(options = {})
+        perform_request({
+          api_function: "sendcontact"
+        }.merge(options))
+      end
+
+      # Public: Check if you can open a support ticket, or if you are able to
+      # contact your hosting provider through Cpanel
+      #
+      # Returns Hash API response
+      def contactable
+        perform_request({ api_function: "isenabled" })
+      end
+    end
+  end
+end

data/lib/lumberg/cpanel/zone_edit.rb

@@ -0,0 +1,134 @@
+module Lumberg
+  module Cpanel
+    # Public: This module allows users to modify their domains
+    class ZoneEdit < Base
+      # Public: Retrieve a list of your account's zones and zone file contents.
+      #
+      # Returns Hash API Response
+      def list
+        perform_request({ api_function: 'fetchzones' })
+      end
+
+      # Public: Add an A, CNAME, or TXT record to a zone file, specified by
+      # line number
+      #
+      # options - Hash options for API call params (default: {})
+      #   :domain - String addon domain for which yo wish to add an entry
+      #   :name - String name of the record, aka subdomain
+      #   :type - String type of the record you wish to add to the zone file.
+      #           Acceptable values include A, CNAME or TXT
+      #   :txt  - String text you wish to contain in your TXT record. Required
+      #           parameter when you specify "TXT" in the :type parameter
+      #           (default: '')
+      #   :cname - String required parameter when you specify CNAME in the
+      #            :type parameter (default: '')
+      #   :address - String ip address to map to the subdomain. (default: '')
+      #   :ttl - Integer time to live in seconds (default: 0)
+      #   :class - String class to be used for the record. Ordinarily this
+      #            parameter is not required (default: '')
+      #
+      # Returns Hash API response.
+      def create(options = {})
+        options[:txtdata] = options.delete(:txt)
+        perform_request({ api_function: 'add_zone_record' }.merge(options))
+      end
+
+      # Public: Show dns zone for a domain
+      #
+      # options - Hash options for API call params (default: {})
+      #   :domain - String domain that corresponds to the zone file you wish to
+      #             show
+      #   :get_custom_entries - Boolean parameter. Entering a value of "1" will
+      #                         cause the function to return only non-essential
+      #                         A and CNAME records. These will include www.*,
+      #                         ftp.*, mail.* and localhost.* (default: '')
+      #   :keys - String parameter that may contain a serie of values, all of
+      #           which act the same way. Each value searches the data
+      #           structure, like a grep, for a single hash (line of the zone
+      #           file). Acceptable values include: line, ttl, name, class,
+      #           address, type, txtdata, preference and exchange.
+      #
+      # Returns Hash API response.
+      def show(options = {})
+        options[:customonly] = options.delete(:get_custom_entries)
+        perform_request({ api_function: 'fetchzone' }.merge(options))
+      end
+
+      # Public: Revert a zone file to its original state.
+      #
+      # options - Hash options for API call params (default: {})
+      #   :domain - String domain that corresponds to the zone file you wish to
+      #             revert
+      #
+      # Returns Hash API response
+      def reset(options = {})
+        perform_request({ api_function: 'resetzone' })
+      end
+
+      # Public: Edit an A, CNAME, or TXT record in a zone file, specified by
+      # line number.  This function works nicely with "show" method to easily
+      # fetch line number and record information.
+      #
+      # options - Hash options for API call params (default: {})
+      #   :domain - String domain that corresponds to the zone you wish to edit
+      #   :line - Integer line number of the zone file you wish to edit
+      #   :type - The type fo record you wish to add to the zone file.
+      #           Acceptable values include A, CNAME or TXT. Each type of
+      #           record requires a specific parameter
+      #   :txt  - String text you wish to contain in your TXT record. Required
+      #           parameter when you specify "TXT" in the :type parameter
+      #           (default: '')
+      #   :cname - String required parameter when you specify CNAME in the
+      #            :type parameter (default: '')
+      #   :address - String ip address to map to the subdomain. (default: '')
+      #   :ttl - Integer time to live in seconds (default: 0)
+      #   :class - String class to be used for the record. Ordinarily this
+      #            parameter is not required (default: '')
+      #
+      # Returns Hash API response.
+      def edit(options = {})
+        options[:Line]    = options.delete(:line)
+        options[:txtdata] = options.delete(:txt)
+        perform_request({ api_function: 'edit_zone_record' }.merge(options))
+      end
+
+      # Public: Remove lines from a DNS zone file. You may only remove A, TXT,
+      # and CNAME records with this function.
+      #
+      # options - Hash options for API call params (default: {})
+      #   :domain - String domain that corresponds to the zone you wish to
+      #             remove a line
+      #   :line - Integer line number of the zone file you wish to remove. Use
+      #           "show" method to obtain the line number of a record
+      #
+      # Returns Hash API response.
+      def remove(options = {})
+        perform_request({ api_function: 'remove_zone_record' }.merge(options))
+      end
+
+      # Public: Retrieve a list of domains, created within cPanel, associated
+      # with your cPanel account.
+      #
+      # options - Hash options for API call params (default: {})
+      #   :domain - String domain parameter which allows you to append one
+      #             domain name to the end of the resulting output
+      #             (default: '')
+      #
+      # Returns Hash API response.
+      def show_domains(options = {})
+        perform_request({ api_function: 'fetch_cpanel_generated_domains' })
+      end
+
+      # Public: Retrieve a list of zone modifications for a specific domain.
+      #
+      # options - Hash options for API call params (default: {})
+      #   :domain - String domain whose zone modifications you wish to view
+      #
+      # Returns Hash API response.
+      def modifications_for(options = {})
+        perform_request({ api_function: 'fetchzone_records' }.merge(options))
+      end
+    end
+  end
+end
+

data/lib/lumberg/cpanel.rb

@@ -0,0 +1,32 @@
+module Lumberg
+  module Cpanel
+    require "lumberg/cpanel/base"
+    require "lumberg/cpanel/addon_domain"
+    require "lumberg/cpanel/sub_domain"
+    require "lumberg/cpanel/park"
+    require "lumberg/cpanel/email"
+    require "lumberg/cpanel/backups"
+    require "lumberg/cpanel/box_trapper"
+    require "lumberg/cpanel/branding"
+    require "lumberg/cpanel/contact"
+    require "lumberg/cpanel/cron"
+    require "lumberg/cpanel/ssl"
+    require "lumberg/cpanel/dns_lookup"
+    require "lumberg/cpanel/domain_lookup"
+    require "lumberg/cpanel/password"
+    require "lumberg/cpanel/password_strength"
+    require "lumberg/cpanel/file_manager"
+    require "lumberg/cpanel/zone_edit"
+    require "lumberg/cpanel/support"
+    require "lumberg/cpanel/random_data"
+    require "lumberg/cpanel/net"
+    require "lumberg/cpanel/mime"
+    require "lumberg/cpanel/redirect"
+    require "lumberg/cpanel/gpg"
+    require "lumberg/cpanel/locale"
+    require "lumberg/cpanel/mysql"
+    require "lumberg/cpanel/domain_keys"
+    require "lumberg/cpanel/ftp"
+    require "lumberg/cpanel/mysql_db"
+  end
+end

data/lib/lumberg/format_whm.rb

@@ -0,0 +1,162 @@
+require 'zlib'
+
+module Lumberg
+  class FormatWhm < Faraday::Response::Middleware
+
+    def initialize(env, *args, &block)
+      @type = args[0]
+      @key = args[1]
+      @boolean_params = args[2]
+      super(env)
+    end
+
+    def on_complete(env)
+      encoding = env[:response_headers]['content-encoding']
+
+      encoding = encoding.to_s.downcase if encoding
+
+      body = case encoding
+             when 'gzip'
+               env[:response_headers].delete('content-encoding')
+               Zlib::GzipReader.new(StringIO.new(env[:body])).read
+             when 'deflate'
+               env[:response_headers].delete('content-encoding')
+               Zlib::Inflate.inflate(env[:body])
+             else
+               env[:body]
+             end
+
+      env[:body] = format_response body
+    end
+
+    def response_values(env)
+      {status: env[:status], headers: env[:response_headers], body: env[:body]}
+    end
+
+  private
+
+    def format_response(response)
+      success, message, params = false, nil, {}
+
+      case @type || response_type(response)
+      when :action
+        success, message, params = format_action_response(response)
+      when :query
+        success, message, params = format_query_response(response)
+      when :ssl
+        success, message, params = format_ssl_response(response)
+      when :whostmgr
+        success, message, params = format_whostmgr_response(response)
+      when :error
+        message = response['error']
+      when :xfer
+        success, message, params = format_xfer_response(response)
+      else
+        message = "Unknown error occurred #{response.inspect}"
+      end
+
+      params = Whm::symbolize_keys(params)
+      params = Whm::to_bool(params, @boolean_params)
+
+      { success: success, message: message, params: params }
+    end
+
+    def response_type(response)
+      if !response.respond_to?(:has_key?)
+        :unknown
+      elsif response.has_key?('error')
+        :error
+      elsif response.has_key?(@key)
+        :action
+      elsif response.has_key?('status') && response.has_key?('statusmsg')
+        :query
+      else
+        :unknown
+      end
+    end
+
+    def format_action_response(response)
+      # Some API methods ALSO return a 'status' as
+      # part of a result. We only use this value if it's
+      # part of the results hash
+      item = response[@key]
+      unless item.is_a?(Array) || item.is_a?(Hash)
+        res = {@key => item}
+        success, message = true, ""
+      else
+        result = nil
+        if item.first.is_a?(Hash)
+          result = item.first
+          res = (item.size > 1 ? item.dup : item.first.dup)
+        else
+          res = item.dup
+
+          # more hacks for WHM silly API
+          if response.has_key?('result')
+            result_node = response['result']
+            node_with_key_status = result_node.is_a?(Hash) && result_node.has_key?('status')
+            result = (node_with_key_status ? result_node : result_node.first)
+          else
+            res.delete('status')
+            res.delete('statusmsg')
+          end
+        end
+        unless result.nil?
+          success = result['status'].to_i == 1
+          message = result['statusmsg']
+        end
+      end
+      return success, message, res
+    end
+
+    def format_query_response(response)
+      success = response['status'].to_i == 1
+      message = response['statusmsg']
+
+      # returns the rest as a params arg
+      res = response.dup
+      res.delete('status')
+      res.delete('statusmsg')
+
+      return success, message, res
+    end
+
+    def format_ssl_response(response)
+      if response.has_key?('crt')
+        success = response['crt'].any?
+        message = true
+        res = response['crt']
+      elsif response.has_key?('sslinfo')
+        success = response['sslinfo'].first.fetch('status').to_i == 1
+        message = response['sslinfo'].first.fetch('statusmsg')
+        # returns the rest as a params arg
+        res = response['sslinfo'].first.dup
+        res.delete('status')
+        res.delete('statusmsg')
+      elsif response.has_key?('results')
+        success, message = response['results'].values_at 'status', 'message'
+        # returns the rest as a params arg
+        res = response['results'].dup
+        res.delete('status')
+        res.delete('message')
+      end
+      return success, message, res
+    end
+
+    def format_whostmgr_response(response)
+      message = "successfully deleted|deleted successfully|successfully" \
+		" generated"
+      if res = response.match(/(?<message>#{message})/)
+        return true, res[:message], []
+      else
+        return false, "", []
+      end
+    end
+
+    def format_xfer_response(response)
+      metadata = response['metadata']
+
+      return metadata['result'].to_i == 1, metadata['reason'], response['data']
+    end
+  end
+end

data/lib/lumberg/version.rb

@@ -1,3 +1,3 @@
 module Lumberg
-  VERSION = '1.0.1'
+  VERSION = '2.0.1'
 end