lumberg 0.9.5

data/lib/lumberg/whm/server.rb

@@ -0,0 +1,290 @@
+require 'cgi'
+
+module Lumberg
+  module Whm
+    class Server < Base
+      # Server
+      attr_accessor :host
+
+      # Remote access hash
+      attr_accessor :hash
+
+      # Base URL to the WHM API
+      attr_accessor :base_url
+
+      # API username - :default => root
+      attr_accessor :user
+
+      # Raw HTTP response from WHM
+      attr_accessor :raw_response
+
+      # WHM parsed response
+      attr_reader :response
+
+      # HTTP Params used for API requests
+      attr_accessor :params
+
+      # WHM API function name
+      attr_reader :function
+
+      # Use ssl?
+      attr_accessor :ssl
+
+      # HTTP SSL verify mode
+      attr_accessor :ssl_verify
+
+      # Returned params to transfor to booleans
+      attr_accessor :boolean_params
+
+      # Force response type...ARG!
+      attr_accessor :force_response_type
+
+      #
+      # ==== Required 
+      #  * <tt>:host</tt> - PENDING
+      #  * <tt>:hash</tt> - PENDING
+      #
+      # ==== Optional 
+      #  * <tt>:user</tt> - PENDING
+      #  * <tt>:ssl</tt> - PENDING
+      def initialize(options)
+        Args.new(options) do |c|
+          c.requires  :host, :hash
+          c.optionals :user, :ssl
+        end
+
+        @ssl_verify ||= false
+        @ssl        = options.delete(:ssl)
+        @host       = options.delete(:host)
+        @hash       = format_hash(options.delete(:hash))
+        @user       = (options.has_key?(:user) ? options.delete(:user) : 'root')
+
+        @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'
+
+        @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
+      end
+
+      def get_hostname
+        perform_request('gethostname', {:key => 'hostname'})
+      end
+
+      def version
+        perform_request('version', {:key => 'version'})
+      end
+
+      def load_average
+        @force_response_type = :query
+        result = perform_request('loadavg')
+        result[:success] = result[:params].has_key?(:one)
+        result
+      end
+
+      def system_load_average(options = {})
+        Args.new(options) do |c|
+          c.requires "api.version".to_sym
+        end
+
+        perform_request('systemloadavg', options.merge(:key => 'data'))
+      end
+
+      def languages
+        perform_request('getlanglist', {:key => 'lang'})
+      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
+
+      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
+        @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/, '')
+      end
+
+      def format_query(hash)
+        elements = []
+        hash.each do |key, value|
+          value = 1 if value === true
+          value = 0 if value === false
+          elements << "#{CGI::escape(key.to_s)}=#{CGI::escape(value.to_s)}"
+        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
+      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, ""
+        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
+        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
+
+      # Creates WHM::Whatever.new(:server => @server)
+      # automagically
+      def auto_accessors
+        [:account, :dns, :reseller]
+      end
+
+      def method_missing(meth, *args, &block)
+        if auto_accessors.include?(meth.to_sym)
+          ivar = instance_variable_get("@#{meth}")
+          if ivar.nil?
+            constant = Whm.const_get(meth.to_s.capitalize)
+            return instance_variable_set("@#{meth}", constant.new(:server => self))
+          else
+            return ivar
+          end
+        else
+          super
+        end
+      end
+
+      def prepare_request(uri)
+        # Setup request URL
+        url = uri.path
+        query = uri.query
+        url << "?" + query unless query.nil? || query.empty?
+
+        # Add Auth Header
+        req = Net::HTTP::Get.new(url)
+        req.add_field("Authorization", "WHM #{@user}:#{@hash}")
+
+        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

data/lib/net_http_hacked.rb

@@ -0,0 +1,42 @@
+module Net
+  class HTTP
+    @skip_bad_headers = false
+
+    class << self
+      # Accessor for @skip_bad_headers
+      def skip_bad_headers
+        @skip_bad_headers
+      end
+
+      # Mutator for @skip_bad_headers
+      def skip_bad_headers=(value)
+        @skip_bad_headers = value
+      end
+    end
+  end
+
+  class << HTTPResponse
+    # Parses each response header and strips out bad headers if skip_bad_headers is set
+    def each_response_header(sock)
+      key = value = nil
+      while true
+        line = sock.readuntil("\n", true).sub(/\s+\z/, '')
+        break if line.empty?
+        if line[0] == ?\s or line[0] == ?\t and value
+          value << ' ' unless value.empty?
+          value << line.strip
+        else
+          tmp_key, tmp_value = line.strip.split(/\s*:\s*/, 2)
+          next if tmp_value.nil? && Net::HTTP.skip_bad_headers
+
+          yield key, value if key
+
+          key   = tmp_key
+          value = tmp_value
+          raise HTTPBadResponse, 'wrong header line format' if value.nil?
+        end
+      end
+      yield key, value if key
+    end
+  end
+end

data/lumberg.gemspec

@@ -0,0 +1,28 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "lumberg/version"
+
+Gem::Specification.new do |s|
+  s.name        = "lumberg"
+  s.version     = Lumberg::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Justin Mazzi"]
+  s.email       = ["jmazzi@site5.com"]
+  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.rubyforge_project = "lumberg"
+
+  s.add_dependency 'json'
+  s.add_development_dependency 'rspec'
+  s.add_development_dependency 'fakeweb'
+  s.add_development_dependency 'vcr'
+  s.add_development_dependency 'rcov'
+  s.add_development_dependency 'metric_fu'
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

data/spec/lumberg_spec.rb

@@ -0,0 +1,9 @@
+require 'spec_helper'
+
+module Lumberg
+  describe "Lumberg::VERSION" do
+    it "has a valid format" do
+      VERSION.should match /\d+/
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,33 @@
+#$:.unshift File.join(File.dirname(__FILE__), '..', 'lib')
+require 'rspec'
+require 'lumberg'
+require 'lumberg/exceptions'
+require 'vcr'
+require 'timeout'
+
+VCR.config do |c|
+  c.cassette_library_dir = 'spec/vcr_cassettes'
+  c.stub_with :fakeweb
+  c.default_cassette_options = {:record => :new_episodes}
+end
+
+def live_test?
+  !ENV['WHM_REAL'].nil?
+end
+
+def requires_attr(attr, &block)
+  expect { block.call }.to raise_error(Lumberg::WhmArgumentError, /Missing required parameter: #{attr}/i)
+end
+
+RSpec.configure do |c|
+  c.extend VCR::RSpec::Macros
+  c.before(:each) do
+    if live_test?
+      @whm_hash = ENV['WHM_HASH'].dup
+      @whm_host = ENV['WHM_HOST'].dup
+    else
+      @whm_hash = 'iscool'
+      @whm_host = 'myhost.com'
+    end
+  end
+end

data/spec/vcr_cassettes/whm/account/accountsummary.yml

@@ -0,0 +1,43 @@
+--- 
+- !ruby/struct:VCR::HTTPInteraction 
+  request: !ruby/struct:VCR::Request 
+    method: :get
+    uri: https://myhost.com:2087/json-api/accountsummary?user=summary
+    body: 
+    headers: 
+      authorization: 
+      - WHM root:iscool
+  response: !ruby/struct:VCR::Response 
+    status: !ruby/struct:VCR::ResponseStatus 
+      code: 200
+      message: OK
+    headers: 
+      server: 
+      - cpsrvd/11.28.64
+      transfer-encoding: 
+      - chunked
+      content-type: 
+      - text/plain
+    body: "{\"status\":1,\"statusmsg\":\"Ok\",\"acct\":[{\"startdate\":\"10 Dec 16 10:24\",\"plan\":\"default\",\"suspended\":0,\"theme\":\"na4\",\"shell\":\"/usr/local/cpanel/bin/jailshell\",\"maxpop\":\"unlimited\",\"maxlst\":\"unlimited\",\"maxaddons\":\"9999\",\"suspendtime\":null,\"ip\":\"192.1.2.3\",\"maxsub\":\"unlimited\",\"domain\":\"summary.com\",\"maxsql\":\"unlimited\",\"partition\":\"home\",\"maxftp\":\"unlimited\",\"user\":\"summary\",\"suspendreason\":\"not suspended\",\"unix_startdate\":\"1292516679\",\"diskused\":\"0M\",\"maxparked\":\"9999\",\"email\":\"timtesting@timtesting.com\",\"disklimit\":\"unlimited\",\"owner\":\"root\"}]}"
+    http_version: "1.1"
+- !ruby/struct:VCR::HTTPInteraction 
+  request: !ruby/struct:VCR::Request 
+    method: :get
+    uri: https://myhost.com:2087/json-api/accountsummary?user=notexists
+    body: 
+    headers: 
+      authorization: 
+      - WHM root:iscool
+  response: !ruby/struct:VCR::Response 
+    status: !ruby/struct:VCR::ResponseStatus 
+      code: 200
+      message: OK
+    headers: 
+      server: 
+      - cpsrvd/11.28.64
+      transfer-encoding: 
+      - chunked
+      content-type: 
+      - text/plain
+    body: "{\"status\":0,\"statusmsg\":\"Account does not exist\",\"acct\":null}"
+    http_version: "1.1"