lumberg 1.0.0 → 1.0.1

data/.gitignore

@@ -7,3 +7,4 @@ test.rb
 *~
 coverage/
 doc/
+Gemfile.lock

data/.rvmrc

@@ -1 +1,49 @@
-rvm 1.9.2@lumberg
+#!/usr/bin/env bash
+
+# This is an RVM Project .rvmrc file, used to automatically load the ruby
+# development environment upon cd'ing into the directory
+
+# First we specify our desired <ruby>[@<gemset>], the @gemset name is optional.
+environment_id="ruby-1.9.2-p180@lumberg"
+
+#
+# First we attempt to load the desired environment directly from the environment
+# file. This is very fast and efficicent compared to running through the entire
+# CLI and selector. If you want feedback on which environment was used then
+# insert the word 'use' after --create as this triggers verbose mode.
+#
+if [[ -d "${rvm_path:-$HOME/.rvm}/environments" \
+  && -s "${rvm_path:-$HOME/.rvm}/environments/$environment_id" ]] ; then
+  \. "${rvm_path:-$HOME/.rvm}/environments/$environment_id"
+
+  [[ -s ".rvm/hooks/after_use" ]] && . ".rvm/hooks/after_use"
+else
+  # If the environment file has not yet been created, use the RVM CLI to select.
+  rvm --create use  "$environment_id"
+fi
+
+#
+# If you use an RVM gemset file to install a list of gems (*.gems), you can have
+# it be automatically loaded. Uncomment the following and adjust the filename if
+# necessary.
+#
+# filename=".gems"
+# if [[ -s "$filename" ]] ; then
+#   rvm gemset import "$filename" | grep -v already | grep -v listed | grep -v complete | sed '/^$/d'
+# fi
+
+#
+# If you use bundler and would like to run bundle each time you enter the
+# directory, you can uncomment the following code.
+#
+#   # Ensure that Bundler is installed. Install it if it is not.
+#   if ! command -v bundle >/dev/null; then
+#      printf "The rubygem 'bundler' is not installed. Installing it now.\n"
+#      gem install bundler
+#   fi
+#
+#   # Bundle while reducing excess noise.
+#   printf "Bundling your gems. This may take a few minutes on a fresh clone.\n"
+#   bundle | grep -v '^Using ' | grep -v ' is complete' | sed '/^$/d'
+#
+

data/.travis.yml

@@ -0,0 +1,11 @@
+script: "bundle exec rake spec"
+notifications:
+  disabled: true
+rvm:
+  - 1.8.7
+  - 1.9.2
+  - 1.9.3
+  - ree
+  - rbx
+  - rbx-head
+  - jruby

data/README.md

@@ -1,81 +1,111 @@
-Lumberg
-=======
+Lumberg [![Lumberg Build Status][Build Icon]][Build Status]
+===========================================================
 
 ![Lumberg logo](http://i.imgur.com/xC4Sw.jpg)
 
-Ruby library for the WHM & cPanel API. It is currently what we consider to be beta-ish. Please report any issues you find. :)
+Ruby library for the WHM & cPanel API. It is currently what we consider to be
+beta-ish. Please report any issues you find. :)
 
 [RDoc](http://rdoc.info/github/site5/lumberg/master/frames)
 
-Confirmed to work with ruby 1.8.7, 1.9.2 and JRuby 1.6.0 on cPanel 11.28+
+Confirmed to work with ruby 1.8.7, 1.9.2, Rubinius, REE and JRuby 1.6.0 on
+cPanel 11.28+
+
+[Build Status]: http://travis-ci.org/site5/lumberg
+[Build Icon]: https://secure.travis-ci.org/site5/lumberg.png?branch=master
+
 
 Install
 -------
 
     gem install lumberg
 
+
 Usage
 -----
 
 Create a server object and connect to WHM using your host and hash:
 
-    require 'lumberg'
-    server = Lumberg::Whm::Server.new(:host => WHM_HOST, :hash => WHM_HASH)
+```ruby
+require 'lumberg'
+server = Lumberg::Whm::Server.new(
+  :host => WHM_HOST,
+  :hash => WHM_HASH
+)
+```
+
+If you are using HTTP Basic Authentication with a username/password:
+
+```ruby
+server = Lumberg::Whm::Server.new(
+  :host => WHM_HOST,
+  :user => USERNAME,
+  :hash => 'my_password'
+)
+```
 
-You can access the modules of WHM by calling server.<module>. For example, server.account or server.dns. Here are the currently supported modules:
+You can access the modules of WHM by calling `server.<module>`. For example,
+`server.account` or `server.dns`. Here are the currently supported modules:
 
 * Account
 * DNS
 * Reseller
 
-
 Here's how to get a list of accounts:
 
-    account = server.account
-    result  = account.list
+```ruby
+account = server.account
+result  = account.list
+```
 
 Most responses will return success and a message
 
-    p "Returned #{result[:success]} with message: #{result[:message]}"
+```ruby
+p "Returned #{result[:success]} with message: #{result[:message]}"
 
-    Returned true with message: Ok
+Returned true with message: Ok
+```
 
 You can grab the data you need from the results hash
 
-    num_accounts = result[:params][:acct].size
-    p "There are #{num_accounts} accounts"
-
-    There are 6 accounts
-
-
-Here's an example of what the renurned data looks like for a single account
-
-    pp result[:params][:acct].first
-
-    {:startdate=>false,
-     :plan=>"default",
-     :suspended=>false,
-     :theme=>"x3",
-     :shell=>"/usr/local/cpanel/bin/jailshell",
-     :maxpop=>"unlimited",
-     :maxlst=>"unlimited",
-     :maxaddons=>"*unknown*",
-     :suspendtime=>nil,
-     :ip=>false,
-     :maxsub=>"unlimited",
-     :domain=>"bob.com",
-     :maxsql=>"unlimited",
-     :partition=>"home",
-     :maxftp=>"unlimited",
-     :user=>"bob",
-     :suspendreason=>"not suspended",
-     :unix_startdate=>false,
-     :diskused=>false,
-     :maxparked=>"*unknown*",
-     :email=>"*unknown*",
-     :disklimit=>"unlimited",
-     :owner=>"root"}
-
+```ruby
+num_accounts = result[:params][:acct].size
+p "There are #{num_accounts} accounts"
+
+There are 6 accounts
+```
+
+Here's an example of what the returned data looks like for a single account
+
+```ruby
+pp result[:params][:acct].first
+
+{
+  :startdate=>false,
+  :plan           => "default",
+  :suspended      => false,
+  :theme          => "x3",
+  :shell          => "/usr/local/cpanel/bin/jailshell",
+  :maxpop         => "unlimited",
+  :maxlst         => "unlimited",
+  :maxaddons      => "*unknown*",
+  :suspendtime    => nil,
+  :ip             => false,
+  :maxsub         => "unlimited",
+  :domain         => "bob.com",
+  :maxsql         => "unlimited",
+  :partition      => "home",
+  :maxftp         => "unlimited",
+  :user           => "bob",
+  :suspendreason  => "not suspended",
+  :unix_startdate => false,
+  :diskused       => false,
+  :maxparked      => "*unknown*",
+  :email          => "*unknown*",
+  :disklimit      => "unlimited",
+  :owner          => "root"
+}
+```
 
 
 Account Example
@@ -83,80 +113,110 @@ Account Example
 
 Creating a new account requires only a username, domain, and password.
 
-    result = server.account.create(:username => 'newuser', :domain => 'newuser.com', :password => 'password')
-    if result[:success]
-      p result[:message]
-    end 
+```ruby
+result = server.account.create(
+  :username => 'newuser',
+  :domain   => 'newuser.com',
+  :password => 'password'
+)
 
-    Account Creation Ok
+if result[:success]
+  p result[:message]
+end
 
+Account Creation Ok
+```
 
 You can list all accounts or search for a specific account.
 
-    result = server.account.list(:search => 'new', :searchtype => 'user')
-    acct   = result[:params][:acct].first
-    p "Found user '#{acct[:user]}' with domain '#{acct[:domain]}'"
+```ruby
+result = server.account.list(:search => 'new', :searchtype => 'user')
+acct   = result[:params][:acct].first
+p "Found user '#{acct[:user]}' with domain '#{acct[:domain]}'"
 
-    Found user 'newuser' with domain 'newuser.com'
+Found user 'newuser' with domain 'newuser.com'
+```
 
 
 Suspending an account is simple and the reason for suspension is optional.
 
-    result = server.account.suspend(:username => 'newuser', :reason => 'bad user')
-    p "user was suspended successfully" if result[:success]
+```ruby
+result = server.account.suspend(:username => 'newuser', :reason => 'bad user')
+p "user was suspended successfully" if result[:success]
 
-    user was suspended successfully
+user was suspended successfully
+```
 
-We can look at the account list again to see the reason for the user's suspension.
+We can look at the account list again to see the reason for the user's
+suspension.
 
-    result = server.account.list(:search => 'new', :searchtype => 'user')
-    acct   = result[:params][:acct].first
-    p "user '#{acct[:user]}' was suspended with reason '#{acct[:suspendreason]}'"
+```ruby
+result = server.account.list(:search => 'new', :searchtype => 'user')
+acct   = result[:params][:acct].first
+p "user '#{acct[:user]}' was suspended with reason '#{acct[:suspendreason]}'"
 
-    user 'newuser' was suspended with reason 'bad user'
+user 'newuser' was suspended with reason 'bad user'
+```
 
 Finally, we remove the user and delete their account.
 
-    result = server.account.remove(:username => 'newuser')
-    p result[:message]
-
-    newuser account removed
+```ruby
+result = server.account.remove(:username => 'newuser')
+p result[:message]
 
+newuser account removed
+```
 
 
 Reseller Example
 ----------------
 
-Creating a reseller works by changing the status of an existing user account, so first we create a user account and then we can create that user as a reseller.
+Creating a reseller works by changing the status of an existing user account,
+so first we create a user account and then we can create that user as a reseller.
 
-    result = server.account.create(:username => 'rtest', :domain => 'resellerexample.com', :password => 'password')
-    if result[:success] 
-      result = server.reseller.create(:username => 'rtest', :makeowner => true)
-      p "created reseller rtest" if result[:success]
-    end     
+```ruby
+result = server.account.create(
+  :username => 'rtest',
+  :domain   => 'resellerexample.com',
+  :password => 'password'
+)
 
-    created reseller rtest
+if result[:success]
+  result = server.reseller.create(:username => 'rtest', :makeowner => true)
+  p "created reseller rtest" if result[:success]
+end
 
-You can get a list of all of the reseller acccounts easily.
+created reseller rtest
+```
 
-    result = server.reseller.list
-    p result[:params][:resellers].inspect
+You can get a list of all of the reseller accounts easily.
 
-    ["samir", "rtest"]
+```
+result = server.reseller.list
+p result[:params][:resellers].inspect
 
-Suspending a reseller is pretty straightforward. It's optional to provide a reason for the suspension.
+["samir", "rtest"]
+```
 
-    result = server.reseller.suspend(:username => 'rtest', :reason => 'bad user')
-    p "reseller was suspended successfully" if result[:success]
+Suspending a reseller is pretty straightforward. It's optional to provide a
+reason for the suspension.
 
-    user was suspended successfully
-    
-Deleting the reseller removes the reseller status from the user account. To also delete the user account, set the :terminatereseller argument.
+```ruby
+result = server.reseller.suspend(:username => 'rtest', :reason => 'bad user')
+p "reseller was suspended successfully" if result[:success]
 
-    result = server.reseller.terminate(:reseller => 'rtest', :terminatereseller => true)
-    p result[:message]
+user was suspended successfully
+```
 
-    Account Terminations Complete
+Deleting the reseller removes the reseller status from the user account. To
+also delete the user account, set the `:terminatereseller` argument.
+
+```ruby
+result = server.reseller.terminate(:reseller => 'rtest', :terminatereseller => true)
+p result[:message]
+
+Account Terminations Complete
+```
 
 Contributors
 ============
@@ -166,15 +226,18 @@ Contributors
 
 Note on Patches/Pull Requests
 =============================
-All HTTP interactions are recorded using VCR and FakeWeb. Please be sure to remove any sensitive information from your cassettes.
- 
+
+All HTTP interactions are recorded using VCR and FakeWeb. Please be sure to
+remove any sensitive information from your cassettes.
+
 * Fork the project.
 * Add yourself to the Contributors list
 * Make your feature addition or bug fix.
 * Add tests for it. This is important so I don't break it in a
   future version unintentionally.
 * Commit, do not mess with rakefile, version, or history.
-  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+  (if you want to have your own version, that is fine but bump version in a
+  commit by itself I can ignore when I pull)
 * Send me a pull request. Bonus points for topic branches.
 
 Copyright

data/Rakefile

@@ -47,3 +47,5 @@ RSpec::Core::RakeTask.new(:rcov) do |t|
   t.rcov = true
   t.rcov_opts = %w{--exclude osx\/objc,gems\/,spec\/,features\/}
 end
+
+task :default => :spec

data/lib/lumberg/version.rb

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

data/lib/lumberg/whm/server.rb

@@ -1,4 +1,5 @@
 require 'cgi'
+require 'base64'
 
 module Lumberg
   module Whm
@@ -12,6 +13,9 @@ module Lumberg
       # Base URL to the WHM API
       attr_accessor :base_url
 
+      # Enable Basic Authentication with API - default false
+      attr_accessor :basic_auth
+
       # API username - :default => root
       attr_accessor :user
 
@@ -47,10 +51,11 @@ module Lumberg
       # ==== Optional 
       #  * <tt>:user</tt> - PENDING
       #  * <tt>:ssl</tt> - PENDING
+      #  * <tt>:basic_auth</tt>
       def initialize(options)
         Args.new(options) do |c|
           c.requires  :host, :hash
-          c.optionals :user, :ssl
+          c.optionals :user, :ssl, :basic_auth
         end
 
         @ssl_verify ||= false
@@ -58,6 +63,7 @@ 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)
 
         @base_url   = format_url(options)
       end
@@ -110,6 +116,75 @@ module Lumberg
         perform_request('getlanglist', {:key => 'lang'})
       end
 
+      def list_ips
+        perform_request('listips', {:key => 'result'})
+      end
+
+      def add_ip(options = {})
+        Args.new(options) do |c|
+          c.requires :ip, :netmask
+        end
+
+        perform_request('addip', options.merge(:key => 'addip'))
+      end
+
+      def delete_ip(options = {})
+        Args.new(options) do |c|
+          c.requires :ip
+          c.optionals :ethernetdev
+          c.booleans :skipifshutdown
+        end
+
+        perform_request('delip', options.merge(:key => 'delip'))
+      end
+
+      def set_hostname(options = {})
+        Args.new(options) do |c|
+          c.requires :hostname
+        end
+
+        perform_request('sethostname', options.merge(:key => 'sethostname'))
+      end
+
+      def set_resolvers(options = {})
+        Args.new(options) do |c|
+          c.requires :nameserver1
+          c.optionals :nameserver2, :nameserver3
+        end
+
+        perform_request('setresolvers', options.merge(:key => 'setresolvers'))
+      end
+
+      def show_bandwidth(options = {})
+        Args.new(options) do |c|
+          c.optionals :month, :year, :showres, :search, :searchtype
+        end
+
+        perform_request('showbw', options.merge(:key => 'bandwidth'))
+      end
+
+      def set_nv_var(options = {})
+        Args.new(options) do |c|
+          c.requires :key
+          c.optionals :value
+        end
+
+        perform_request('nvset', options.merge(:key => 'nvset'))
+      end
+
+      def get_nv_var(options = {})
+        Args.new(options) do |c|
+          c.requires :key
+          c.optionals :value
+        end
+
+        perform_request('nvget', options.merge(:key => 'nvget'))
+      end
+
+      def reboot
+        perform_request('reboot', {:key => "reboot"})
+      end
+
       protected
       def response_type
         if !@force_response_type.nil?
@@ -268,10 +343,16 @@ module Lumberg
         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}")
 
+        # 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
 

data/lumberg.gemspec

@@ -16,11 +16,10 @@ Gem::Specification.new do |s|
 
   s.add_dependency 'json'
   s.add_runtime_dependency('jruby-openssl', '~> 0.7.3') if RUBY_PLATFORM == 'java'
-  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.add_development_dependency 'rspec', '~> 2.8.0'
+  s.add_development_dependency 'fakeweb', '~> 1.3.0'
+  s.add_development_dependency 'vcr', '~> 1.11.3'
+  s.add_development_dependency 'rake', '~> 0.9.2.2'
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")

data/spec/vcr_cassettes/whm/server/addip.yml

@@ -0,0 +1,22 @@
+--- 
+- !ruby/struct:VCR::HTTPInteraction 
+  request: !ruby/struct:VCR::Request 
+    method: :get
+    uri: https://myhost.com:2087/json-api/addip?ip=208.77.188.166&netmask=255.255.255.0
+    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.87
+      transfer-encoding: 
+      - chunked
+      content-type: 
+      - text/plain
+    body: "{\"addip\":[{\"errors\":[],\"status\":1,\"statusmsg\":\"Success\",\"msgs\":\"eth0:cp242 is now up.  208.77.188.166/255.255.255.0 broadcast 208.77.188.255 has been added\\nSystem has 240 free ips.\"}]}"
+    http_version: "1.1"

data/spec/vcr_cassettes/whm/server/delip.yml

@@ -0,0 +1,22 @@
+--- 
+- !ruby/struct:VCR::HTTPInteraction 
+  request: !ruby/struct:VCR::Request 
+    method: :get
+    uri: https://myhost.com:2087/json-api/delip?ip=208.77.188.166
+    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.87
+      transfer-encoding: 
+      - chunked
+      content-type: 
+      - text/plain
+    body: "{\"delip\":[{\"status\":1,\"statusmsg\":\"208.77.188.166 has been removed.\",\"warnings\":[\"Skipping shutdown of ethernet device 208.77.188.166 is bound to.\"]}]}"
+    http_version: "1.1"