lumberg 1.0.1 → 1.0.3

data/.travis.yml

@@ -1,11 +1,17 @@
+language: ruby
 script: "bundle exec rake spec"
 notifications:
-  disabled: true
+  email:
+    recipients:
+      - engineering@internal.site5.com
+    on_success: never
+    on_failure: always
 rvm:
   - 1.8.7
   - 1.9.2
   - 1.9.3
   - ree
-  - rbx
   - rbx-head
-  - jruby
+  - rbx-18mode
+  - jruby-18mode
+  - jruby-19mode

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2011 Site5 LLC 
+Copyright (c) 2012 Site5.com <http://www.site5.com>
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -243,4 +243,4 @@ remove any sensitive information from your cassettes.
 Copyright
 =========
 
-Copyright (c) 2011 Site5. See LICENSE for details.
+Copyright (c) 2012 Site5.com. See LICENSE for details.

data/Rakefile

@@ -14,6 +14,8 @@ begin
 rescue LoadError
 end
 
+load 'vcr/tasks/vcr.rake'
+
 RSpec::Core::RakeTask.new :spec
 Bundler::GemHelper.install_tasks
 
@@ -26,7 +28,7 @@ task :sanitize_cassettes do
       files.each do |file|
         old = File.read(file)
         if old.match(/#{ENV['WHM_HASH']}|#{ENV['WHM_HOST']}/)
-          puts "Sanitizing #{file}" 
+          puts "Sanitizing #{file}"
           old.gsub!(ENV['WHM_HASH'], 'iscool')
           old.gsub!(ENV['WHM_HOST'], 'myhost.com')
           File.open(file, 'w') do |f|

data/lib/lumberg.rb

@@ -3,21 +3,46 @@ $:.unshift(File.dirname(__FILE__))
 # External Libs
 require 'json'
 require 'uri'
-require 'net/http'
-require 'net/https'
+require 'excon'
+require 'faraday'
+require 'faraday_middleware'
+require 'logger'
 
 # Internal Libs
-require 'net_http_hacked'
+require 'lumberg/format_whm'
 require 'lumberg/version'
 require 'lumberg/exceptions'
+require 'lumberg/config'
 require 'lumberg/whm/args'
 require 'lumberg/whm'
 
 module Lumberg
-  class << self
-    def base_path
-      File.dirname(__FILE__)
-    end
+    
+  extend self
+  
+  attr_accessor :configuration
+  
+  def base_path
+    File.dirname(__FILE__)
   end
+  
+  self.configuration ||= Lumberg::Config.new
+
+   # Specificy the config via block
+   #
+   # ==== Attributes
+   #
+   # * +debug+ - Set to true to log debug info to $stderr, or a file path
+   #
+   # ==== Example
+   #
+   #   Lumberg.config do |c|
+   #     c.dubug "path/to/file.log"
+   #   end
+   def config
+     yield self.configuration if block_given?
+     self.configuration.options
+   end
+   
 end
 

data/lib/lumberg/config.rb

@@ -0,0 +1,19 @@
+module Lumberg
+  # Holds the configuration for Lumberg
+  class Config
+    attr_accessor :options
+
+    def initialize
+      @options = {}
+    end
+
+    def [](v)
+      @options[v]
+    end
+
+    # Debug output.  value can be either true to output to $stderr or a path to a file
+    def debug(output)
+      @options[:debug] = output
+    end
+  end
+end

data/lib/lumberg/format_whm.rb

@@ -0,0 +1,102 @@
+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)
+      env[:body] = format_response(env[: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 :error
+          message = response['error']
+        when :unknown
+          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
+
+  end
+end

data/lib/lumberg/version.rb

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

data/lib/lumberg/whm/server.rb

@@ -1,5 +1,4 @@
-require 'cgi'
-require 'base64'
+Faraday.register_middleware :response, :format_whm => Lumberg::FormatWhm
 
 module Lumberg
   module Whm
@@ -19,9 +18,6 @@ module Lumberg
       # API username - :default => root
       attr_accessor :user
 
-      # Raw HTTP response from WHM
-      attr_accessor :raw_response
-
       # WHM parsed response
       attr_reader :response
 
@@ -44,11 +40,11 @@ module Lumberg
       attr_accessor :force_response_type
 
       #
-      # ==== Required 
+      # ==== Required
       #  * <tt>:host</tt> - PENDING
       #  * <tt>:hash</tt> - PENDING
       #
-      # ==== Optional 
+      # ==== Optional
       #  * <tt>:user</tt> - PENDING
       #  * <tt>:ssl</tt> - PENDING
       #  * <tt>:basic_auth</tt>
@@ -63,30 +59,19 @@ module Lumberg
         @host       = options.delete(:host)
         @hash       = format_hash(options.delete(:hash))
         @user       = (options.has_key?(:user) ? options.delete(:user) : 'root')
-        @basic_auth = options.has_key?(:basic_auth) && options.delete(:basic_auth)
-
+        @basic_auth = options.delete(:basic_auth)
         @base_url   = format_url(options)
       end
 
       def perform_request(function, options = {})
-        @function = function
-
         # WHM sometime uses different keys for the result hash
-        @key  = options.delete(:key) || 'result'
-
+        @key      = options.delete(:key) || 'result'
+        @function = function
         @params   = format_query(options)
-        uri       = URI.parse("#{@base_url}#{function}?#{@params}")
 
         yield self if block_given?
 
-        req = prepare_request(uri)
-
-        # Do the request
-        res = do_request(uri, req)
-
-        @raw_response = res
-        @response     = JSON.parse(@raw_response.body)
-        format_response
+        do_request(@base_url, function, @params)
       end
 
       def get_hostname
@@ -185,136 +170,59 @@ module Lumberg
         perform_request('reboot', {:key => "reboot"})
       end
 
-      protected
-      def response_type
-        if !@force_response_type.nil?
-          @force_response_type
-        elsif !@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
+    private
 
-      def format_response
-        success, message, params = false, nil, {}
-
-        case response_type
-          when :action
-            success, message, params = format_action_response
-          when :query
-            success, message, params = format_query_response
-          when :error
-            message = @response['error']
-          when :unknown
-            message = "Unknown error occurred #{@response.inspect}"
-        end
- 
-        params = Whm::to_bool(params, @boolean_params) unless @boolean_params.nil?
-
-        # Reset this for subsequent requests
+      def do_request(uri, function, params)
+        @response = Faraday.new(:url => uri, :ssl => ssl_options) do |c|
+          c.basic_auth @user, @hash
+          c.params = params
+          c.request :url_encoded
+          c.response :format_whm, @force_response_type, @key, @boolean_params
+          c.response :logger, create_logger_instance
+          c.response :json
+          c.adapter :excon
+        end.get(function).body
         @force_response_type = nil
-        {:success => success, :message => message, :params => Whm::symbolize_keys(params)}
-      end
-
-      def format_url(options = {})
-        @ssl = true if @ssl.nil?
-        port  = (@ssl ? 2087 : 2086)
-        proto = (@ssl ? 'https' : 'http')
-
-        "#{proto}://#{@host}:#{port}/json-api/"
-      end
-
-      def format_hash(hash)
-        raise Lumberg::WhmArgumentError.new("Missing WHM hash") unless hash.is_a?(String)
-        hash.gsub(/\n|\s/, '')
+        @response
       end
 
       def format_query(hash)
-        elements = []
-        hash.each do |key, value|
+        hash.inject({}) do |params, (key, value)|
           value = 1 if value === true
           value = 0 if value === false
-          elements << "#{CGI::escape(key.to_s)}=#{CGI::escape(value.to_s)}"
+          params[key] = value
+          params
         end
-        elements.sort.join('&')
       end
 
-      private
-
-      def do_request(uri, req)
-        begin
-          Net::HTTP.skip_bad_headers = true
-          http = Net::HTTP.new(uri.host, uri.port)
-          http.set_debug_output($stderr) if ENV['LUMBERG_DEBUG']
-
-          enable_ssl(http) if uri.port == 2087
-
-          http.start do |h|
-            h.request(req)
-          end
-        rescue Exception => e
-          puts "Error when sending the request. 
-                 Enable debug output by setting the environment variable LUMBERG_DEBUG and try again."
-          raise e
-        ensure
-          Net::HTTP.skip_bad_headers = false
-        end
+      def create_logger_instance
+        Logger.new(Lumberg.configuration[:debug].is_a?(TrueClass) ? $stderr : Lumberg.configuration[:debug])
       end
 
-      def format_action_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, ""
+      def ssl_options
+        if @ssl_verify
+          {
+            :verify_mode => OpenSSL::SSL::VERIFY_PEER,
+            :ca_file     => File.join(Lumberg::base_path, "cacert.pem")
+          }
         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
+          {
+            :verify_mode => OpenSSL::SSL::VERIFY_NONE
+          }
         end
-
-        return success, message, res
       end
 
-      def format_query_response
-        success = @response['status'].to_i == 1
-        message = @response['statusmsg']
+      def format_url(options = {})
+        @ssl = true if @ssl.nil?
+        port  = (@ssl ? 2087 : 2086)
+        proto = (@ssl ? 'https' : 'http')
 
-        # returns the rest as a params arg
-        res = @response.dup
-        res.delete('status')
-        res.delete('statusmsg')
+        "#{proto}://#{@host}:#{port}/json-api/"
+      end
 
-        return success, message, res
+      def format_hash(hash)
+        raise Lumberg::WhmArgumentError.new("Missing WHM hash") unless hash.is_a?(String)
+        hash.gsub(/\n|\s/, '')
       end
 
       # Creates WHM::Whatever.new(:server => @server)
@@ -337,35 +245,6 @@ module Lumberg
         end
       end
 
-      def prepare_request(uri)
-        # Setup request URL
-        url = uri.path
-        query = uri.query
-        url << "?" + query unless query.nil? || query.empty?
-
-        req = Net::HTTP::Get.new(url)
-
-        # Add Auth Header
-        if basic_auth
-          encoded = Base64.encode64("#{@user}:#{@hash}")
-          auth = "Basic #{encoded}"
-        else
-          auth = "WHM #{@user}:#{@hash}"
-        end
-        req.add_field("Authorization", auth)
-        req
-      end
-
-      def enable_ssl(http)
-        if @ssl_verify
-          http.verify_mode = OpenSSL::SSL::VERIFY_PEER
-          http.ca_file = File.join(Lumberg::base_path, "cacert.pem")
-        else
-          http.verify_mode = OpenSSL::SSL::VERIFY_NONE
-        end
-        http.use_ssl = true 
-      end
-
     end
   end
 end