lumberg 1.1.1 → 2.0.0.pre3

data/lib/lumberg/format_whm.rb

@@ -26,6 +26,8 @@ module Lumberg
           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 :error
           message = response['error']
         when :unknown
@@ -98,5 +100,26 @@ module Lumberg
       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
   end
-end
+end

data/lib/lumberg/version.rb

@@ -1,3 +1,3 @@
 module Lumberg
-  VERSION = '1.1.1'
+  VERSION = '2.0.0.pre3'
 end

data/lib/lumberg/whm.rb

@@ -5,6 +5,7 @@ module Lumberg
     autoload :Account,  'lumberg/whm/account'
     autoload :Dns,      'lumberg/whm/dns'
     autoload :Reseller, 'lumberg/whm/reseller'
+    autoload :Cert,      'lumberg/whm/cert'
 
     class << self
 
@@ -24,7 +25,7 @@ module Lumberg
             arg
         end
       end
-    
+
       # Recursively converts values of 0 or 1 to true or false
       def to_bool(hash, *keys)
         if keys.empty?

data/lib/lumberg/whm/account.rb

@@ -42,7 +42,7 @@ module Lumberg
       def change_password(options = {})
         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
@@ -159,7 +159,7 @@ module Lumberg
       # ==== Required
       #  * <tt>:domain</tt> - PENDING
       def domain_user_data(options = {})
-        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
@@ -196,7 +196,7 @@ module Lumberg
       #  * <tt>:username</tt> - PENDING
       def privs(options ={})
         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
@@ -226,7 +226,7 @@ module Lumberg
       #  * <tt>:subs</tt> - PENDING
       def restore_account(options = {})
         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

data/lib/lumberg/whm/cert.rb

@@ -0,0 +1,69 @@
+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
+
+      # Generates a CSR
+      #
+      # ==== Required
+      #  * <tt>:xemail</tt> - PENDING
+      #  * <tt>:host</tt> - PENDING
+      #  * <tt>:country</tt> - PENDING
+      #  * <tt>:state</tt> - PENDING
+      #  * <tt>:city</tt> - PENDING
+      #  * <tt>:co</tt> - PENDING
+      #  * <tt>:cod</tt> - PENDING
+      #  * <tt>:email</tt> - PENDING
+      #  * <tt>:pass</tt> - PENDING
+      #
+      # ==== Optional
+      #  * <tt>none</tt> - PENDING
+      def generatessl(options = {})
+        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
+    end
+  end
+end

data/lib/lumberg/whm/dns.rb

@@ -37,7 +37,7 @@ module Lumberg
 
       # 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.
@@ -66,7 +66,7 @@ module Lumberg
       #  * <tt>:domain</tt> - PENDING
       #  * <tt>:"api.version".to_sym</tt> - PENDING
       def resolve_domain(options = {})
-        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.
@@ -104,7 +104,7 @@ module Lumberg
       # ==== Required
       #  * <tt>:nameserver</tt> - PENDING
       def lookup_nameserver_ip(options = {})
-        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.
@@ -131,6 +131,30 @@ module Lumberg
         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+*
@@ -139,7 +163,7 @@ module Lumberg
       #  * <tt>:domain</tt> - PENDING
       #  * <tt>:"api.version".to_sym</tt> - PENDING
       def list_mxs(options = {})
-        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

data/lib/lumberg/whm/reseller.rb

@@ -15,7 +15,7 @@ module Lumberg
       # Lists the usernames of all resellers on the server
       def list
         # This method is funky. That is all
-        result = server.perform_request('listresellers', :key => 'reseller')
+        result = server.perform_request('listresellers', :response_key => 'reseller')
         result[:success] = true
         result[:params]  = {:resellers => result.delete(:params)}
         result
@@ -115,7 +115,7 @@ module Lumberg
       #  * <tt>:username</tt> - PENDING
       def account_counts(options = {})
         options[:user] = options.delete(:username)
-        server.perform_request('acctcounts', options.merge(:key => 'reseller'))
+        server.perform_request('acctcounts', options.merge(:response_key => 'reseller'))
       end
 
       # Defines a reseller's nameservers. Additionally, you may use it to reset a reseller's nameservers to the default settings
@@ -140,7 +140,7 @@ module Lumberg
 
       # Lists the saved reseller ACL lists on the server
       def list_acls
-        server.perform_request('listacls', {:key => 'acls'})
+        server.perform_request('listacls', {:response_key => 'acls'})
       end
 
       # Creates a new reseller ACL list
@@ -148,7 +148,7 @@ module Lumberg
       # ==== Required
       #  * <tt>:acllist</tt> - PENDING
       def save_acl_list(options = {})
-        server.perform_request('saveacllist', options.merge(:key => 'results'))
+        server.perform_request('saveacllist', options.merge(:response_key => 'results'))
       end
 
       # Sets the ACL for a reseller, or modifies specific ACL items for a reseller

data/lib/lumberg/whm/server.rb

@@ -39,6 +39,9 @@ module Lumberg
       # Force response type...ARG!
       attr_accessor :force_response_type
 
+      # HTTP read/open timeout
+      attr_accessor :timeout
+
       #
       # ==== Required
       #  * <tt>:host</tt> - PENDING
@@ -55,12 +58,16 @@ module Lumberg
         @hash       = format_hash(options.delete(:hash))
         @user       = (options.has_key?(:user) ? options.delete(:user) : 'root')
         @basic_auth = options.delete(:basic_auth)
+        @timeout    = options.delete(:timeout)
+
+        validate_server_host
+
         @base_url   = format_url(options)
       end
 
       def perform_request(function, options = {})
         # WHM sometime uses different keys for the result hash
-        @key      = options.delete(:key) || 'result'
+        @response_key = options.delete(:response_key) || 'result'
         @function = function
         @params   = format_query(options)
 
@@ -70,11 +77,11 @@ module Lumberg
       end
 
       def get_hostname
-        perform_request('gethostname', {:key => 'hostname'})
+        perform_request('gethostname', {:response_key => 'hostname'})
       end
 
       def version
-        perform_request('version', {:key => 'version'})
+        perform_request('version', {:response_key => 'version'})
       end
 
       def load_average
@@ -85,47 +92,75 @@ module Lumberg
       end
 
       def system_load_average(options = {})
-        perform_request('systemloadavg', options.merge(:key => 'data'))
+        perform_request('systemloadavg', options.merge(:response_key => 'data'))
       end
 
       def languages
-        perform_request('getlanglist', {:key => 'lang'})
+        perform_request('getlanglist', {:response_key => 'lang'})
+      end
+
+      def themes
+        perform_request('getlanglist', {:response_key => 'themes'})
       end
 
       def list_ips
-        perform_request('listips', {:key => 'result'})
+        perform_request('listips', {:response_key => 'result'})
+      end
+
+      def get_tweaksetting(options = {})
+        request = perform_request('get_tweaksetting',
+          options.merge(
+            :response_key  => 'data',
+            :'api.version' => 1
+          )
+        )
+
+        request[:success] = !request[:params].empty?
+        request
+      end
+
+      def set_tweaksetting(options = {})
+        request = perform_request('set_tweaksetting',
+          options.merge(
+            :response_key  => 'metadata',
+            :'api.version' => 1
+          )
+        )
+
+        request[:success] = (request[:params][:reason] == 'OK')
+        request
       end
 
       def add_ip(options = {})
-        perform_request('addip', options.merge(:key => 'addip'))
+        perform_request('addip', options.merge(:response_key => 'addip'))
       end
 
       def delete_ip(options = {})
-        perform_request('delip', options.merge(:key => 'delip'))
+        perform_request('delip', options.merge(:response_key => 'delip'))
       end
 
       def set_hostname(options = {})
-        perform_request('sethostname', options.merge(:key => 'sethostname'))
+        perform_request('sethostname', options.merge(:response_key => 'sethostname'))
       end
 
       def set_resolvers(options = {})
-        perform_request('setresolvers', options.merge(:key => 'setresolvers'))
+        perform_request('setresolvers', options.merge(:response_key => 'setresolvers'))
       end
 
       def show_bandwidth(options = {})
-        perform_request('showbw', options.merge(:key => 'bandwidth'))
+        perform_request('showbw', options.merge(:response_key => 'bandwidth'))
       end
 
       def set_nv_var(options = {})
-        perform_request('nvset', options.merge(:key => 'nvset'))
+        perform_request('nvset', options.merge(:response_key => 'nvset'))
       end
 
       def get_nv_var(options = {})
-        perform_request('nvget', options.merge(:key => 'nvget'))
+        perform_request('nvget', options.merge(:response_key => 'nvget'))
       end
 
       def reboot
-        perform_request('reboot', {:key => "reboot"})
+        perform_request('reboot', {:response_key => "reboot"})
       end
 
       def account
@@ -140,6 +175,10 @@ module Lumberg
         @reseller ||= Reseller.new(:server => self)
       end
 
+      def cert
+        @cert ||= Cert.new(:server => self)
+      end
+
     private
 
       def do_request(uri, function, params)
@@ -149,12 +188,14 @@ module Lumberg
           else
             c.headers['Authorization'] = "WHM #{@user}:#{@hash}"
           end
+
           c.params = params
           c.request :url_encoded
-          c.response :format_whm, @force_response_type, @key, @boolean_params
+          c.response :format_whm, @force_response_type, @response_key, @boolean_params
           c.response :logger, create_logger_instance
           c.response :json
           c.adapter :net_http
+          c.options[:timeout] = timeout if timeout
         end.get(function).body
         @force_response_type = nil
         @response
@@ -198,6 +239,14 @@ module Lumberg
         raise Lumberg::WhmArgumentError.new("Missing WHM hash") unless hash.is_a?(String)
         hash.gsub(/\n|\s/, '')
       end
+
+      def validate_server_host
+        Resolv.getaddress(@host)
+      rescue Resolv::ResolvError
+        raise Lumberg::WhmArgumentError.new(
+          "Unable to resolve #{@host}"
+        )
+      end
     end
   end
 end

data/lumberg.gemspec

@@ -11,16 +11,17 @@ Gem::Specification.new do |s|
   s.homepage    = ""
   s.summary     = %q{Ruby library for the WHM & cPanel API}
   s.description = %q{Ruby library for the WHM & cPanel API; It's not a half day or anything like that}
+  s.license     = 'MIT'
 
   s.rubyforge_project = "lumberg"
 
   s.add_runtime_dependency 'json', '~> 1.7.3'
-  s.add_runtime_dependency 'faraday', '~> 0.8.1'
-  s.add_runtime_dependency 'faraday_middleware', '~> 0.8.4'
+  s.add_runtime_dependency 'faraday', '~> 0.8.8'
+  s.add_runtime_dependency 'faraday_middleware', '~> 0.9.0'
   s.add_runtime_dependency('jruby-openssl', '~> 0.7.3') if RUBY_PLATFORM == 'java'
   s.add_development_dependency 'rspec', '~> 2.10.0'
   s.add_development_dependency 'webmock', '~> 1.8.7'
-  s.add_development_dependency 'vcr', '~> 2.0.0rc2'
+  s.add_development_dependency 'vcr', '~> 2.4.0'
   s.add_development_dependency 'rake', '~> 0.9.2.2'
 
   s.files         = `git ls-files`.split("\n")