lumberg 2.0.0.pre20 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c4be4c100bbc35f27900bd8830afdc2d8e94bcc0
-  data.tar.gz: b73036c13c045581404257369e98ee8d137d6f8c
+  metadata.gz: 9592d20229a7597396c55e15b997aaeda53f9c96
+  data.tar.gz: 1dc200699df461f25dfb1d81e2ec07e4b0bf72e3
 SHA512:
-  metadata.gz: a76541ea84f819cc25ccc55f59187f9cd618059a81fa6991ace87c643b06009288d5ca94cbf12a195cb701d1788191232efc4ae4331fcdea103db05cc51d533e
-  data.tar.gz: 830331e9488dc6e735c4381229764940003185054dfbcdfba0fc50df86661830afce3797360ff65e3a61851cc534b9486c4424592ef7a1509b4266d3bdbf8d02
+  metadata.gz: c67a6453be51e33310a50b630a4e4ceeedcca36901aca1c86050b7d97e94f0354b0d009f27aedebf8182f0709a799906190eab609bdb32f6e99835fd1abaa769
+  data.tar.gz: ab01a5ec1b84502064133d536d19e226529f8151f459cc746e54e8ebbccee05fdd04b8cfa82d0c3336d3baf7df4aee5f82d7842077a239d9caaee41bbb3f05f5

data/LICENSE

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

data/README.md

@@ -7,13 +7,19 @@ beta-ish. Please report any issues you find. :)
 
 [RDoc](http://rdoc.info/github/site5/lumberg/master/frames)
 
-Confirmed to work with ruby 1.9.3, 2.0.0, 2.1.3 and JRuby 1.9 mode on
-cPanel 11.28+
+Confirmed to work with ruby 1.9.3, 2.0.0, 2.1.3, 2.2.0 and JRuby 1.9 mode.
 
 [Build Status]: http://travis-ci.org/site5/lumberg
 [Build Icon]: https://secure.travis-ci.org/site5/lumberg.png?branch=master
 
 
+## cPanel Version Targets
+
+* cPanel 11.4x: _v2.0.0_
+* cPanel 11.3x: _v2.0.0.pre10_
+* cPanel 11.2x: _v1.1.1_
+
+
 ## Install
 
     gem install lumberg
@@ -35,9 +41,10 @@ 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'
+  host:       WHM_HOST,
+  user:       USERNAME,
+  hash:       'my_password',
+  basic_auth: true
 )
 ```
 
@@ -133,7 +140,6 @@ p "Found user '#{acct[:user]}' with domain '#{acct[:domain]}'"
 Found user 'newuser' with domain 'newuser.com'
 ```
 
-
 Suspending an account is simple and the reason for suspension is optional.
 
 ```ruby
@@ -221,12 +227,6 @@ correspond to cPanel API modules. cPanel API module coverage is currently
 incomplete and we're seeking contributions. Check out [Extending
 Lumberg::Cpanel](#extending-lumbergcpanel) for details on how you can help.
 
-#### Cpanel 11.3x vs 11.4x
-
-Prefer Lumberg _v2.0.0.pre10_ if you're running Cpanel 11.3x.
-
-We're targetting Cpanel 11.4x from Lumberg _v2.0.0.pre11_ and above.
-
 #### Email example
 
 ```ruby
@@ -247,9 +247,9 @@ email.add_forwarder(
   fwdopt:   "fwd",
   fwdemail: "dest@other-domain.com"
 )
-
 ```
 
+
 ## Contributing
 
 ### Extending Lumberg::Cpanel
@@ -324,7 +324,7 @@ email.add_forwarder(
 
    - In many cases, you'll name your methods to match up
      with the documented cPanel API methods. However, the documented method
-     names are sometimes a bit lengthy, confusing, or otherwise unwiedly; feel
+     names are sometimes a bit lengthy, confusing, or otherwise unwieldy; feel
      free to give your corresponding method an improved name.
    - Use [TomDoc](http://tomdoc.org/) documentation for your methods.
      Be sure to document all required and optional parameters from the
@@ -335,6 +335,7 @@ email.add_forwarder(
      other parameters.
 
 ### Sanitizing VCR cassettes
+
 All HTTP interactions are recorded using VCR and FakeWeb. Please be sure to remove
 sensitive data from your cassettes. A Rake task is provided for this purpose:
 ```
@@ -347,13 +348,13 @@ information still present (check URLs, authorization params, etc.).
 
 * Fork the project.
 * Make your feature addition or bug fix.
-* Add tests for it. This is important so I don't break it in a
+* Add tests for it. This is important so we don't break it in a
   future version unintentionally.
-* Commit, do not mess with rakefile, version, or history.
+* 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)
-* Send me a pull request. Bonus points for topic branches.
+  commit by itself we can ignore when we pull)
+* Send us a pull request. Bonus points for topic branches.
 
 ## Copyright
 
-Copyright (c) 2012-2014 Site5.com. See LICENSE for details.
+Copyright (c) 2015 WWWH, LLC. See LICENSE for details.

data/lib/lumberg/format_whm.rb

@@ -39,24 +39,26 @@ module Lumberg
       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 :unknown
-          message = "Unknown error occurred #{response.inspect}"
+      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}
+      { success: success, message: message, params: params }
     end
 
     def response_type(response)
@@ -150,5 +152,11 @@ module Lumberg
         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 = '2.0.0.pre20'
+  VERSION = '2.0.0'
 end

data/lib/lumberg/whm.rb

@@ -1,11 +1,12 @@
 module Lumberg
   module Whm
-    autoload :Base,     'lumberg/whm/base'
-    autoload :Server,   'lumberg/whm/server'
-    autoload :Account,  'lumberg/whm/account'
-    autoload :Dns,      'lumberg/whm/dns'
-    autoload :Reseller, 'lumberg/whm/reseller'
-    autoload :Cert,      'lumberg/whm/cert'
+    autoload :Base,         'lumberg/whm/base'
+    autoload :Server,       'lumberg/whm/server'
+    autoload :Account,      'lumberg/whm/account'
+    autoload :Dns,          'lumberg/whm/dns'
+    autoload :Reseller,     'lumberg/whm/reseller'
+    autoload :Cert,         'lumberg/whm/cert'
+    autoload :TransferTool, 'lumberg/whm/transfer_tool'
 
     class << self
 
@@ -16,7 +17,7 @@ module Lumberg
             arg.map { |elem| symbolize_keys elem }
           when Hash
             Hash[
-              arg.map { |key, value|  
+              arg.map { |key, value|
                 k = key.is_a?(String) ? key.gsub('-', '_').to_sym : key
                 v = symbolize_keys value
                 [k,v]
@@ -57,8 +58,8 @@ module Lumberg
         elsif input == true
           1
         elsif input.is_a?(Hash)
-          Hash[ 
-            input.map {|k,v| 
+          Hash[
+            input.map {|k,v|
               v = from_bool(v)
               [k,v]
             }

data/lib/lumberg/whm/server.rb

@@ -232,6 +232,10 @@ module Lumberg
         @cert ||= Cert.new(server: self)
       end
 
+      def transfer_tool
+        @transfer_tool ||= TransferTool.new(server: self)
+      end
+
     private
 
       def do_request(uri, function, params)

data/lib/lumberg/whm/transfer_tool.rb

@@ -0,0 +1,165 @@
+module Lumberg
+  module Whm
+    class TransferTool < Base
+
+      # Public: Creates a new transfer session.
+      #
+      # options - Hash options for API call params. (default: {})
+      #   :host              - String hostname of the remote server.
+      #   :user              - String username to connect on remote server.
+      #   :password          - String password for account specified above.
+      #
+      # Returns Hash API Response.
+      def create(options = {})
+        default_options = { remote_server_type: 'auto',
+                            port: 22,
+                            root_escalation_method: 'sudo',
+                            transfer_threads: 2,
+                            restore_threads: 2,
+                            unrestricted_restore: 1,
+                            compressed: 1,
+                            unencrypted: 0,
+                            use_backups: 1,
+                            low_priority: 0,
+                            enable_custom_pkgacct: 0 }
+
+        options.merge!("api.version" => "1")
+
+        server.force_response_type = :xfer
+
+        server.perform_request(
+          'create_remote_root_transfer_session',
+          default_options.merge(options)
+        )
+      end
+
+      # Public: Checks a given transfer session ID.
+      #
+      # transfer_session_id - String ID of the transfer session.
+      #
+      # Returns Hash API Response.
+      def check(transfer_session_id)
+        options = { transfer_session_id: transfer_session_id }
+
+        server.force_response_type = :xfer
+
+        server.perform_request(
+          'retrieve_transfer_session_remote_analysis',
+          options.merge("api.version" => "1")
+        )
+      end
+
+      # Public: Validates a system user, preventing account conflicts.
+      #
+      # username - String username to validate.
+      #
+      # Returns Hash API Response.
+      def validate_user(username)
+        options = { user: username }
+
+        server.force_response_type = :xfer
+
+        server.perform_request(
+          'validate_system_user',
+          options.merge("api.version" => "1")
+        )
+      end
+
+      # Public: Enqueues a transfer session.
+      #
+      # options - Hash options for API call params. (default: {})
+      #   :transfer_session_id - String ID of the transfer session.
+      #   :queue               - String transfer queue name. Can be one of the
+      #                          following: LegacyAccountBackup,
+      #                          FeatureListRemoteRoot, PackageRemoteRoot,
+      #                          AccountLocal, AccountRemoteRoot and
+      #                          AccountRemoteUser.
+      #                          (default: 'AccountRemoteRoot')
+      #   :size                - Integer account size in Bytes.
+      #   :other_arguments     - Doc here
+      #   https://documentation.cpanel.net/display/SDK/WHM+API+1+-+enqueue_transfer_item
+      #
+      # Returns Hash API Reponse.
+      def enqueue(options = {})
+        default_options = { "api.version" => "1" }
+
+        options["module"] = options.delete(:queue) || "AccountRemoteRoot"
+
+        if %w(AccountRemoteRoot AccountRemoteUser AccountLocal).include?(options["module"])
+          options[:localuser] = options.delete(:localuser) || options[:user]
+        end
+
+        server.force_response_type = :xfer
+
+        server.perform_request('enqueue_transfer_item', default_options.merge(options))
+      end
+
+      # Public: Starts or restarts a transfer.
+      #
+      # transfer_session_id - String ID of the transfer session.
+      #
+      # Returns Hash API Response.
+      def start(transfer_session_id)
+        options = { transfer_session_id: transfer_session_id }
+
+        server.force_response_type = :xfer
+
+        server.perform_request(
+          'start_transfer_session',
+          options.merge("api.version" => "1")
+        )
+      end
+
+      # Public: Gets migration status.
+      #
+      # transfer_session_id - String ID of the transfer session.
+      #
+      # Returns Hash API Response.
+      def status(transfer_session_id)
+        options = { transfer_session_id: transfer_session_id }
+
+        server.force_response_type = :xfer
+
+        server.perform_request(
+          'get_transfer_session_state',
+          options.merge("api.version" => "1")
+        )
+      end
+
+      # Public: Shows transfer log.
+      #
+      # transfer_session_id - String ID of the transfer session.
+      # type                - Symbol log type, can be either `:common` or
+      #                       `:error`. (default: :common)
+      #
+      # Returns Hash API Response.
+      def show_log(transfer_session_id, log_type = :common)
+        options = { logfile: log_type == :common ? 'master.log' : 'master.error_log',
+                    transfer_session_id: transfer_session_id }
+
+        server.force_response_type = :xfer
+
+        server.perform_request(
+          'fetch_transfer_session_log',
+          options.merge("api.version" => "1")
+        )
+      end
+
+      # Public: Pauses a given transfer session.
+      #
+      # transfer_session_id - String ID of the transfer session.
+      #
+      # Returns Hash API Response.
+      def pause(transfer_session_id)
+        options = { transfer_session_id: transfer_session_id }
+
+        server.force_response_type = :xfer
+
+        server.perform_request(
+          'pause_transfer_session',
+          options.merge("api.version" => "1")
+        )
+      end
+    end
+  end
+end

data/spec/vcr_cassettes/whm/transfer_tool/check.yml

@@ -0,0 +1,44 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://myhost.com:2087/json-api/retrieve_transfer_session_remote_analysis?api.version=1&transfer_session_id=x
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Authorization:
+      - WHM root:iscool
+      Accept-Encoding:
+      - deflate
+      User-Agent:
+      - Faraday v0.9.0
+      Accept:
+      - "*/*"
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Server:
+      - cpsrvd/11.44.1.23
+      X-Keep-Alive-Count:
+      - '1'
+      Connection:
+      - Keep-Alive
+      Keep-Alive:
+      - timeout=70, max=200
+      Transfer-Encoding:
+      - chunked
+      Date:
+      - Tue, 06 Jan 2015 15:00:03 GMT
+      Cache-Control:
+      - no-cache
+      Content-Type:
+      - text/plain; charset="utf-8"
+    body:
+      encoding: UTF-8
+      string: '{"metadata":{"reason":"OK","result":"1","version":1,"command":"retrieve_transfer_session_remote_analysis"},"data":{"transfer_session_id":"x","local":{"dbs":{"dbs":{"MYSQL":{"db_db":{"owner":"db"}},"PGSQL":{}},"users":{"MYSQL":{"db_db":{"owner":"db"}},"PGSQL":{}}},"domains":{"db.local":"db","*":"nobody"},"users":{"named":1,"sync":1,"cpaneleximscanner":1,"rpc":1,"mail":1,"xfs":1,"nfsnobody":1,"cpanelhorde":1,"mysql":1,"shutdown":1,"cpanel":1,"operator":1,"cpanelroundcube":1,"vcsa":1,"dbus":1,"db":1,"news":1,"uucp":1,"haldaemon":1,"adm":1,"cpanelphpmyadmin":1,"root":1,"dovenull":1,"rpcuser":1,"gopher":1,"cpses":1,"cpaneleximfilter":1,"cpanellogaholic":1,"bin":1,"mailman":1,"mailnull":1,"cpanellogin":1,"pcap":1,"avahi-autoipd":1,"sshd":1,"lp":1,"cpanelphppgadmin":1,"games":1,"daemon":1,"smmsp":1,"dovecot":1,"ftp":1,"nobody":1,"nscd":1,"halt":1},"dedicated_ips":{},"available_ips":[],"groups":{"kmem":1,"audio":1,"utempter":1,"named":1,"man":1,"disk":1,"mail":1,"cpaneleximscanner":1,"rpc":1,"xfs":1,"cpanelhorde":1,"nfsnobody":1,"mysql":1,"slocate":1,"compiler":1,"cpanel":1,"screen":1,"cpanelroundcube":1,"vcsa":1,"dbus":1,"mailtrap":1,"proftpd":1,"wheel":1,"db":1,"mem":1,"news":1,"dip":1,"haldaemon":1,"uucp":1,"adm":1,"cpanelphpmyadmin":1,"root":1,"dovenull":1,"rpcuser":1,"gopher":1,"cpses":1,"cpaneleximfilter":1,"cpanellogaholic":1,"bin":1,"floppy":1,"mailman":1,"mailnull":1,"users":1,"cpanellogin":1,"pcap":1,"sshd":1,"utmp":1,"tty":1,"avahi-autoipd":1,"sys":1,"lp":1,"games":1,"cpanelphppgadmin":1,"smmsp":1,"daemon":1,"dovecot":1,"ftp":1,"nobody":1,"lock":1,"nscd":1}},"options":{"skip_reseller_privs":"0","unrestricted":"1"},"config":{"shared_mysql_server":"0"},"remote":{"has_owners":1,"has_package_extensions":1,"cpversion":"11.30","has_disk_used":1,"host":"192.168.1.100","dbs":{"dbs":{"MYSQL":{"mylogin_pres411":{"owner":"mylogin"}}},"PGSQL":{}},"users":{"MYSQL":{"mylogin_pres411":{"owner":"mylogin"}},"PGSQL":{}},"resellers":{"reseller":1,"root":1},"conflicts":{},"has_xfertool":1,"server_type":"WHM1130","version":"11.44.1.23"},"items":{"packages":[{"name":"reseller_one","featurelist":"default"}],"accounts":[{"has_dedicated_ip":0,"owner":"root","bytesused":73682944,"user":"mylogin","domain":"mylogin-account.local"},{"has_dedicated_ip":0,"owner":"reseller","bytesused":172032,"user":"reseller","domain":"reseller-test.com"}]}}}'
+    http_version: 
+  recorded_at: Tue, 06 Jan 2015 15:00:04 GMT
+recorded_with: VCR 2.9.2

data/spec/vcr_cassettes/whm/transfer_tool/create.yml

@@ -0,0 +1,72 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://myhost.com:2087/json-api/create_remote_root_transfer_session?api.version=1&compressed=1&enable_custom_pkgacct=0&host=192.168.1.100&low_priority=0&password=t00r&port=22&remote_server_type=auto&restore_threads=2&root_escalation_method=sudo&transfer_threads=2&unencrypted=0&unrestricted_restore=1&use_backups=1&user=mylogin
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Authorization:
+      - WHM root:iscool
+      Accept-Encoding:
+      - deflate
+      User-Agent:
+      - Faraday v0.9.0
+      Accept:
+      - "*/*"
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Server:
+      - cpsrvd/11.44.1.23
+      X-Keep-Alive-Count:
+      - '1'
+      Connection:
+      - Keep-Alive
+      Keep-Alive:
+      - timeout=70, max=200
+      Transfer-Encoding:
+      - chunked
+      Date:
+      - Tue, 06 Jan 2015 14:34:06 GMT
+      Cache-Control:
+      - no-cache
+      Content-Type:
+      - text/plain; charset="utf-8"
+    body:
+      encoding: ASCII-8BIT
+      string: !binary |-
+        eyJtZXRhZGF0YSI6eyJyZXN1bHQiOiIxIiwicmVhc29uIjoiT0siLCJjb21t
+        YW5kIjoiY3JlYXRlX3JlbW90ZV9yb290X3RyYW5zZmVyX3Nlc3Npb24iLCJ2
+        ZXJzaW9uIjoxfSwiZGF0YSI6eyJhbmFseXplX3Jhd291dCI6IkZldGNoaW5n
+        IGluZm9ybWF0aW9uIGZyb20gcmVtb3RlIGhvc3Q6IOKAnDE5Mi4xNjguMS4x
+        MDDigJ0g4oCmIOKAplxuRG9uZVxuRmV0Y2hpbmcgaW5mb3JtYXRpb24gZnJv
+        bSByZW1vdGUgaG9zdDog4oCcMTkyLjE2OC4xLjEwMOKAnSDigKYg4oCmXG5E
+        b25lXG4iLCJjcmVhdGVfcmF3b3V0IjoiQmFzaWMgY3JlZGVudGlhbCBjaGVj
+        ayDigKYg4oCmXG5Eb25lXG5GZXRjaGluZyBpbmZvcm1hdGlvbiBmcm9tIHJl
+        bW90ZSBob3N0OiDigJwxOTIuMTY4LjEuMTAw4oCdIOKApiDigKZcbkRvbmVc
+        bkZldGNoaW5nIFdITSBWZXJzaW9uIOKAplxuRG9uZVxuVGVzdGluZyDigJwx
+        OTIuMTY4LjEuMTAw4oCdIGZvciB0cmFuc2ZlciBzdHJlYW1pbmcgc3VwcG9y
+        dCB3aXRoIHBhc3N3b3JkIGF1dGhlbnRpY2F0aW9uLi4uLjxzdHJvbmc+VGhl
+        IHN5c3RlbSBpcyB1bmFibGUgdG8gc3RyZWFtIGFjY291bnQgdHJhbnNmZXJz
+        IHdpdGggcGFzc3dvcmQgYXV0aGVudGljYXRpb246PC9zdHJvbmc+IOKAnFN0
+        cmVhbWluZyBub3Qgc3VwcG9ydGVkOiBGZXRjaGluZyBzdHJlYW0gZnJvbSBS
+        ZW1vdGUgV0hNIHVzaW5nIOKAnGh0dHBz4oCdIGZyb20gaG9zdCDigJwxOTIu
+        MTY4LjEuMTAw4oCdIOKAplxuSFRUUC8xLjEgNDAxIEFjY2VzcyBEZW5pZWRc
+        clxuXG7igJ1cbkZldGNoaW5nIGluZm9ybWF0aW9uIGZyb20gcmVtb3RlIGhv
+        c3Q6IOKAnDE5Mi4xNjguMS4xMDDigJ0g4oCmIOKAplxuRG9uZVxuVGVzdGlu
+        ZyDigJwxOTIuMTY4LjEuMTAw4oCdIGZvciB0cmFuc2ZlciBzdHJlYW1pbmcg
+        c3VwcG9ydCB3aXRoIGFjY2Vzc2hhc2ggYXV0aGVudGljYXRpb24uLi4uPHN0
+        cm9uZz5UaGUgc3lzdGVtIGlzIHVuYWJsZSB0byBzdHJlYW0gYWNjb3VudCB0
+        cmFuc2ZlcnMgd2l0aCBhY2Nlc3NoYXNoIGF1dGhlbnRpY2F0aW9uOjwvc3Ry
+        b25nPiDigJxTdHJlYW1pbmcgbm90IHN1cHBvcnRlZDogRmV0Y2hpbmcgc3Ry
+        ZWFtIGZyb20gUmVtb3RlIFdITSB1c2luZyDigJxodHRwc+KAnSBmcm9tIGhv
+        c3Qg4oCcMTkyLjE2OC4xLjEwMOKAnSDigKZcbkFjY2VzcyBkZW5pZWRcclxu
+        RG9uZVxu4oCdXG5SZW1vdGUgU2VydmVyIFR5cGU6IOKAnFdITTExMzDigJ1c
+        biIsInRyYW5zZmVyX3Nlc3Npb25faWQiOiJ4In19
+    http_version: 
+  recorded_at: Tue, 06 Jan 2015 14:34:06 GMT
+recorded_with: VCR 2.9.2

data/spec/vcr_cassettes/whm/transfer_tool/enqueue.yml

@@ -0,0 +1,44 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://myhost.com:2087/json-api/enqueue_transfer_item?api.version=1&localuser=another&module=AccountRemoteRoot&size=73682944&transfer_session_id=x&user=another
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Authorization:
+      - WHM root:iscool
+      Accept-Encoding:
+      - deflate
+      User-Agent:
+      - Faraday v0.9.0
+      Accept:
+      - "*/*"
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Server:
+      - cpsrvd/11.44.1.23
+      X-Keep-Alive-Count:
+      - '1'
+      Connection:
+      - Keep-Alive
+      Keep-Alive:
+      - timeout=70, max=200
+      Transfer-Encoding:
+      - chunked
+      Date:
+      - Tue, 06 Jan 2015 19:32:42 GMT
+      Cache-Control:
+      - no-cache
+      Content-Type:
+      - text/plain; charset="utf-8"
+    body:
+      encoding: UTF-8
+      string: '{"metadata":{"reason":"OK","result":"1","version":1,"command":"enqueue_transfer_item"}}'
+    http_version: 
+  recorded_at: Tue, 06 Jan 2015 19:32:42 GMT
+recorded_with: VCR 2.9.2

data/spec/vcr_cassettes/whm/transfer_tool/pause.yml

@@ -0,0 +1,44 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://myhost.com:2087/json-api/pause_transfer_session?api.version=1&transfer_session_id=x
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Authorization:
+      - WHM root:iscool
+      Accept-Encoding:
+      - deflate
+      User-Agent:
+      - Faraday v0.9.0
+      Accept:
+      - "*/*"
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Server:
+      - cpsrvd/11.44.1.23
+      X-Keep-Alive-Count:
+      - '1'
+      Connection:
+      - Keep-Alive
+      Keep-Alive:
+      - timeout=70, max=200
+      Transfer-Encoding:
+      - chunked
+      Date:
+      - Wed, 07 Jan 2015 13:36:27 GMT
+      Cache-Control:
+      - no-cache
+      Content-Type:
+      - text/plain; charset="utf-8"
+    body:
+      encoding: UTF-8
+      string: '{"metadata":{"command":"pause_transfer_session","result":"1","version":1,"reason":"OK"}}'
+    http_version: 
+  recorded_at: Wed, 07 Jan 2015 13:36:27 GMT
+recorded_with: VCR 2.9.2

data/spec/vcr_cassettes/whm/transfer_tool/show_log.yml

@@ -0,0 +1,44 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://myhost.com:2087/json-api/fetch_transfer_session_log?api.version=1&logfile=master.log&transfer_session_id=x
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Authorization:
+      - WHM root:iscool
+      Accept-Encoding:
+      - deflate
+      User-Agent:
+      - Faraday v0.9.0
+      Accept:
+      - "*/*"
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Server:
+      - cpsrvd/11.44.1.23
+      X-Keep-Alive-Count:
+      - '1'
+      Connection:
+      - Keep-Alive
+      Keep-Alive:
+      - timeout=70, max=200
+      Transfer-Encoding:
+      - chunked
+      Date:
+      - Wed, 07 Jan 2015 13:18:00 GMT
+      Cache-Control:
+      - no-cache
+      Content-Type:
+      - text/plain; charset="utf-8"
+    body:
+      encoding: UTF-8
+      string: '{"metadata":{"reason":"OK","command":"fetch_transfer_session_log","version":1,"result":"1"},"data":{"log":"{\"type\":\"control\",\"contents\":{\"action\":\"start\",\"child_number\":0},\"pid\":\"30831\"}\n{\"type\":\"control\",\"contents\":{\"action\":\"initiator\",\"child_number\":0,\"msg\":\"copyacct\"},\"pid\":\"30831\"}\n{\"type\":\"control\",\"contents\":{\"action\":\"version\",\"child_number\":0,\"msg\":\"1.9\"},\"pid\":\"30831\"}\n{\"type\":\"control\",\"contents\":{\"action\":\"queue_count\",\"child_number\":0,\"msg\":\"1\",\"queue\":\"TRANSFER\"},\"pid\":\"30831\"}\n{\"type\":\"control\",\"contents\":{\"action\":\"queue_size\",\"child_number\":0,\"msg\":\"73682944\",\"queue\":\"TRANSFER\"},\"pid\":\"30831\"}\n{\"type\":\"control\",\"contents\":{\"action\":\"queue_count\",\"child_number\":0,\"msg\":\"1\",\"queue\":\"RESTORE\"},\"pid\":\"30831\"}\n{\"type\":\"control\",\"contents\":{\"action\":\"queue_size\",\"child_number\":0,\"msg\":\"73682944\",\"queue\":\"RESTORE\"},\"pid\":\"30831\"}\n{\"type\":\"control\",\"contents\":{\"action\":\"remotehost\",\"child_number\":0,\"msg\":\"192.168.1.100\"},\"pid\":\"30831\"}\n{\"type\":\"control\",\"contents\":{\"action\":\"start\",\"item\":\"another\",\"logfile\":\"item-TRANSFER_AccountRemoteRoot_another\",\"item_type\":\"AccountRemoteRoot\",\"local_item\":\"another\",\"item_name\":\"Account\",\"child_number\":1,\"queue\":\"TRANSFER\"},\"pid\":\"30833\"}\n{\"type\":\"control\",\"contents\":{\"action\":\"process-item\",\"item\":\"another\",\"logfile\":\"item-TRANSFER_AccountRemoteRoot_another\",\"item_type\":\"AccountRemoteRoot\",\"local_item\":\"another\",\"item_name\":\"Account\",\"child_number\":1,\"msg\":\"item-TRANSFER_AccountRemoteRoot_another\",\"queue\":\"TRANSFER\"},\"pid\":\"30833\"}\n{\"type\":\"control\",\"contents\":{\"action\":\"start-item\",\"item\":\"another\",\"logfile\":\"item-TRANSFER_AccountRemoteRoot_another\",\"item_type\":\"AccountRemoteRoot\",\"local_item\":\"another\",\"item_name\":\"Account\",\"child_number\":1,\"msg\":{\"size\":\"73682944\"},\"queue\":\"TRANSFER\"},\"pid\":\"30833\"}\n{\"type\":\"control\",\"contents\":{\"action\":\"success-item\",\"item\":\"another\",\"logfile\":\"item-TRANSFER_AccountRemoteRoot_another\",\"item_type\":\"AccountRemoteRoot\",\"local_item\":\"another\",\"item_name\":\"Account\",\"child_number\":1,\"msg\":{\"altered_items\":0,\"message\":null,\"dangerous_items\":0,\"contents\":{\"altered_items\":null,\"dangerous_items\":null,\"skipped_items\":null,\"warnings\":null},\"skipped_items\":0,\"warnings\":0,\"size\":\"73682944\"},\"queue\":\"TRANSFER\"},\"pid\":\"30833\"}\n{\"type\":\"control\",\"contents\":{\"action\":\"complete\",\"child_number\":1,\"queue\":\"TRANSFER\"},\"pid\":\"30833\"}\n{\"type\":\"control\",\"contents\":{\"action\":\"start\",\"item\":\"another\",\"logfile\":\"item-RESTORE_AccountRemoteRoot_another\",\"item_type\":\"AccountRemoteRoot\",\"local_item\":\"another\",\"item_name\":\"Account\",\"child_number\":1,\"queue\":\"RESTORE\"},\"pid\":\"30835\"}\n{\"type\":\"control\",\"contents\":{\"action\":\"process-item\",\"item\":\"another\",\"logfile\":\"item-RESTORE_AccountRemoteRoot_another\",\"item_type\":\"AccountRemoteRoot\",\"local_item\":\"another\",\"item_name\":\"Account\",\"child_number\":1,\"msg\":\"item-RESTORE_AccountRemoteRoot_another\",\"queue\":\"RESTORE\"},\"pid\":\"30835\"}\n{\"type\":\"control\",\"contents\":{\"action\":\"start-item\",\"item\":\"another\",\"logfile\":\"item-RESTORE_AccountRemoteRoot_another\",\"item_type\":\"AccountRemoteRoot\",\"local_item\":\"another\",\"item_name\":\"Account\",\"child_number\":1,\"msg\":{\"size\":\"73682944\"},\"queue\":\"RESTORE\"},\"pid\":\"30835\"}\n{\"type\":\"control\",\"contents\":{\"action\":\"success-item\",\"item\":\"another\",\"logfile\":\"item-RESTORE_AccountRemoteRoot_another\",\"item_type\":\"AccountRemoteRoot\",\"local_item\":\"another\",\"item_name\":\"Account\",\"child_number\":1,\"msg\":{\"altered_items\":0,\"message\":null,\"dangerous_items\":0,\"contents\":{\"altered_items\":[],\"dangerous_items\":[],\"skipped_items\":[],\"warnings\":[]},\"skipped_items\":0,\"warnings\":0,\"size\":\"73682944\"},\"queue\":\"RESTORE\"},\"pid\":\"30835\"}\n{\"type\":\"control\",\"contents\":{\"action\":\"complete\",\"child_number\":1,\"queue\":\"RESTORE\"},\"pid\":\"30835\"}\n{\"type\":\"control\",\"contents\":{\"action\":\"complete\",\"child_number\":0},\"pid\":\"30831\"}\n"}}'
+    http_version: 
+  recorded_at: Wed, 07 Jan 2015 13:18:00 GMT
+recorded_with: VCR 2.9.2

data/spec/vcr_cassettes/whm/transfer_tool/start.yml

@@ -0,0 +1,44 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://myhost.com:2087/json-api/start_transfer_session?api.version=1&transfer_session_id=x
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Authorization:
+      - WHM root:iscool
+      Accept-Encoding:
+      - deflate
+      User-Agent:
+      - Faraday v0.9.0
+      Accept:
+      - "*/*"
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Server:
+      - cpsrvd/11.44.1.23
+      X-Keep-Alive-Count:
+      - '1'
+      Connection:
+      - Keep-Alive
+      Keep-Alive:
+      - timeout=70, max=200
+      Transfer-Encoding:
+      - chunked
+      Date:
+      - Tue, 06 Jan 2015 19:36:46 GMT
+      Cache-Control:
+      - no-cache
+      Content-Type:
+      - text/plain; charset="utf-8"
+    body:
+      encoding: UTF-8
+      string: '{"data":{"pid":30831},"metadata":{"reason":"OK","result":"1","version":1,"command":"start_transfer_session"}}'
+    http_version: 
+  recorded_at: Tue, 06 Jan 2015 19:36:46 GMT
+recorded_with: VCR 2.9.2

data/spec/vcr_cassettes/whm/transfer_tool/status.yml

@@ -0,0 +1,44 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://myhost.com:2087/json-api/get_transfer_session_state?api.version=1&transfer_session_id=x
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Authorization:
+      - WHM root:iscool
+      Accept-Encoding:
+      - deflate
+      User-Agent:
+      - Faraday v0.9.0
+      Accept:
+      - "*/*"
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Server:
+      - cpsrvd/11.44.1.23
+      X-Keep-Alive-Count:
+      - '1'
+      Connection:
+      - Keep-Alive
+      Keep-Alive:
+      - timeout=70, max=200
+      Transfer-Encoding:
+      - chunked
+      Date:
+      - Wed, 07 Jan 2015 13:13:35 GMT
+      Cache-Control:
+      - no-cache
+      Content-Type:
+      - text/plain; charset="utf-8"
+    body:
+      encoding: UTF-8
+      string: '{"data":{"state_name":"COMPLETED"},"metadata":{"reason":"OK","version":1,"result":"1","command":"get_transfer_session_state"}}'
+    http_version: 
+  recorded_at: Wed, 07 Jan 2015 13:13:35 GMT
+recorded_with: VCR 2.9.2

data/spec/vcr_cassettes/whm/transfer_tool/validate_user.yml

@@ -0,0 +1,44 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://myhost.com:2087/json-api/validate_system_user?api.version=1&user=another
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Authorization:
+      - WHM root:iscool
+      Accept-Encoding:
+      - deflate
+      User-Agent:
+      - Faraday v0.9.0
+      Accept:
+      - "*/*"
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Server:
+      - cpsrvd/11.44.1.23
+      X-Keep-Alive-Count:
+      - '1'
+      Connection:
+      - Keep-Alive
+      Keep-Alive:
+      - timeout=70, max=200
+      Transfer-Encoding:
+      - chunked
+      Date:
+      - Tue, 06 Jan 2015 16:05:59 GMT
+      Cache-Control:
+      - no-cache
+      Content-Type:
+      - text/plain; charset="utf-8"
+    body:
+      encoding: UTF-8
+      string: '{"data":{"reserved":0,"valid_for_transfer":1,"exists":0,"valid_for_new":1},"metadata":{"version":1,"result":"1","command":"validate_system_user","reason":"OK"}}'
+    http_version: 
+  recorded_at: Tue, 06 Jan 2015 16:05:59 GMT
+recorded_with: VCR 2.9.2

data/spec/whm/server_spec.rb

@@ -382,5 +382,11 @@ module Lumberg
         result[:params][:ip].should =~ Resolv::IPv4::Regex
       end
     end
+
+    describe '#transfer_tool' do
+      subject { @whm.transfer_tool }
+
+      it { should be_a Whm::TransferTool }
+    end
   end
 end

data/spec/whm/transfer_tool_spec.rb

@@ -0,0 +1,172 @@
+require 'spec_helper'
+require 'lumberg/whm'
+
+module Lumberg
+  describe Whm::TransferTool do
+    let(:source_server) { '192.168.1.100' }
+    let(:username)      { 'mylogin' }
+    let(:password)      { 't00r' }
+    let(:xfer_id)       { 'x' }
+
+    before do
+      @server    = Whm::Server.new(host: @whm_host, hash: @whm_hash)
+      @xfer_tool = Whm::TransferTool.new(server: @server.dup)
+    end
+
+    describe '#create' do
+      use_vcr_cassette 'whm/transfer_tool/create'
+
+      subject { @xfer_tool.create host: source_server, user: username, password: password }
+
+      its([:success]) { should be_true }
+      its([:message]) { should eq 'OK' }
+      its([:params])  { should include :transfer_session_id }
+
+      it 'has a session ID' do
+        subject[:params][:transfer_session_id].should_not be_empty
+      end
+    end
+
+    describe '#check' do
+      use_vcr_cassette 'whm/transfer_tool/check'
+
+      subject { @xfer_tool.check xfer_id }
+
+      its([:success]) { should be_true }
+      its([:message]) { should eq 'OK' }
+      its([:params])  { should include :transfer_session_id }
+
+      it 'has local server data' do
+        subject[:params][:local].should_not be_empty
+      end
+
+      it 'has remote server data' do
+        subject[:params][:remote].should_not be_empty
+      end
+    end
+
+    describe '#validate_user' do
+      use_vcr_cassette 'whm/transfer_tool/validate_user'
+
+      subject { @xfer_tool.validate_user 'another' }
+
+      its([:success]) { should be_true }
+      its([:message]) { should eq 'OK' }
+
+      it 'checks if user does not exist on local server' do
+        subject[:params][:exists].should eq 0
+      end
+
+      it 'checks if account is not reserved' do
+        subject[:params][:reserved].should eq 0
+      end
+
+      it 'checks if it is possible to create an account with that given login' do
+        subject[:params][:valid_for_new].should eq 1
+      end
+
+      it 'checks if it is possible to migrate account to local server' do
+        subject[:params][:valid_for_transfer].should eq 1
+      end
+    end
+
+    describe '#enqueue' do
+      context 'enqueueing a migration' do
+        use_vcr_cassette 'whm/transfer_tool/enqueue'
+
+        subject do
+          @xfer_tool.enqueue(
+            transfer_session_id: xfer_id,
+            size: 73682944, user: 'another')
+        end
+
+        its([:success]) { should be_true }
+        its([:message]) { should eq 'OK' }
+        its([:params])  { should be_nil }
+      end
+
+      context 'copying package' do
+        let(:enqueue_transfer_options) do
+          { transfer_session_id: xfer_id,
+          package: 'some_package' }
+        end
+
+        let(:queue) { 'PackageRemoteRoot' }
+
+        before do
+          stub_request(
+            :get,
+            /enqueue_transfer_item\?api\.version=1&module=PackageRemoteRoot&package=some_package&transfer_session_id=x/
+          ).to_return(
+            status: 200,
+            body: '{"metadata":{"reason":"OK","result":"1","version":1,"command":"enqueue_transfer_item"}}'
+          )
+
+          enqueue_transfer_options.merge!(
+            "module"      => "PackageRemoteRoot",
+            "api.version" => "1"
+          )
+        end
+
+        it 'enqueues migration to PackageRemoteRoot queue and does not pass :localuser to cPanel/WHM' do
+          Lumberg::Whm::Server.any_instance.should_receive(:perform_request)
+            .with 'enqueue_transfer_item', enqueue_transfer_options
+
+          @xfer_tool.enqueue enqueue_transfer_options.merge(queue: queue)
+        end
+      end
+    end
+
+    describe '#start' do
+      use_vcr_cassette 'whm/transfer_tool/start'
+
+      subject { @xfer_tool.start xfer_id }
+
+      its([:success]) { should be_true }
+      its([:message]) { should eq 'OK' }
+      its([:params])  { should include :pid }
+
+      it 'sets PID for current migration' do
+        subject[:params][:pid].should be_an Integer
+      end
+    end
+
+    describe '#status' do
+      use_vcr_cassette 'whm/transfer_tool/status'
+
+      subject { @xfer_tool.status xfer_id }
+
+      its([:success]) { should be_true }
+      its([:message]) { should eq 'OK' }
+      its([:params])  { should include :state_name }
+
+      it 'returns current status' do
+        subject[:params][:state_name].should_not be_empty
+      end
+    end
+
+    describe '#show_log' do
+      use_vcr_cassette 'whm/transfer_tool/show_log'
+
+      subject { @xfer_tool.show_log xfer_id }
+
+      its([:success]) { should be_true }
+      its([:message]) { should eq 'OK' }
+      its([:params])  { should include :log }
+
+      it 'shows log for current transfer' do
+        subject[:params][:log].should_not be_empty
+      end
+    end
+
+    describe '#pause' do
+      use_vcr_cassette 'whm/transfer_tool/pause'
+
+      subject { @xfer_tool.pause xfer_id }
+
+      its([:success]) { should be_true }
+      its([:message]) { should eq 'OK' }
+      its([:params])  { should be_nil }
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lumberg
 version: !ruby/object:Gem::Version
-  version: 2.0.0.pre20
+  version: 2.0.0
 platform: ruby
 authors:
 - Justin Mazzi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-10 00:00:00.000000000 Z
+date: 2015-01-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.8'
+        version: 1.8.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.8'
+        version: 1.8.2
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
@@ -162,6 +162,7 @@ files:
 - lib/lumberg/whm/dns.rb
 - lib/lumberg/whm/reseller.rb
 - lib/lumberg/whm/server.rb
+- lib/lumberg/whm/transfer_tool.rb
 - lib/lumberg/whostmgr.rb
 - lib/lumberg/whostmgr/base.rb
 - lib/lumberg/whostmgr/ssl.rb
@@ -394,6 +395,14 @@ files:
 - spec/vcr_cassettes/whm/server/systemloadavg.yml
 - spec/vcr_cassettes/whm/server/themes.yml
 - spec/vcr_cassettes/whm/server/version.yml
+- spec/vcr_cassettes/whm/transfer_tool/check.yml
+- spec/vcr_cassettes/whm/transfer_tool/create.yml
+- spec/vcr_cassettes/whm/transfer_tool/enqueue.yml
+- spec/vcr_cassettes/whm/transfer_tool/pause.yml
+- spec/vcr_cassettes/whm/transfer_tool/show_log.yml
+- spec/vcr_cassettes/whm/transfer_tool/start.yml
+- spec/vcr_cassettes/whm/transfer_tool/status.yml
+- spec/vcr_cassettes/whm/transfer_tool/validate_user.yml
 - spec/vcr_cassettes/whostmgr/ssl/create.yml
 - spec/vcr_cassettes/whostmgr/ssl/remove.yml
 - spec/vcr_cassettes/whostmgr/ssl/remove_data.yml
@@ -403,6 +412,7 @@ files:
 - spec/whm/dns_spec.rb
 - spec/whm/reseller_spec.rb
 - spec/whm/server_spec.rb
+- spec/whm/transfer_tool_spec.rb
 - spec/whm/whm_spec.rb
 - spec/whostmgr/ssl_spec.rb
 homepage: ''
@@ -420,9 +430,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: lumberg
 rubygems_version: 2.2.2
@@ -659,6 +669,14 @@ test_files:
 - spec/vcr_cassettes/whm/server/systemloadavg.yml
 - spec/vcr_cassettes/whm/server/themes.yml
 - spec/vcr_cassettes/whm/server/version.yml
+- spec/vcr_cassettes/whm/transfer_tool/check.yml
+- spec/vcr_cassettes/whm/transfer_tool/create.yml
+- spec/vcr_cassettes/whm/transfer_tool/enqueue.yml
+- spec/vcr_cassettes/whm/transfer_tool/pause.yml
+- spec/vcr_cassettes/whm/transfer_tool/show_log.yml
+- spec/vcr_cassettes/whm/transfer_tool/start.yml
+- spec/vcr_cassettes/whm/transfer_tool/status.yml
+- spec/vcr_cassettes/whm/transfer_tool/validate_user.yml
 - spec/vcr_cassettes/whostmgr/ssl/create.yml
 - spec/vcr_cassettes/whostmgr/ssl/remove.yml
 - spec/vcr_cassettes/whostmgr/ssl/remove_data.yml
@@ -668,6 +686,7 @@ test_files:
 - spec/whm/dns_spec.rb
 - spec/whm/reseller_spec.rb
 - spec/whm/server_spec.rb
+- spec/whm/transfer_tool_spec.rb
 - spec/whm/whm_spec.rb
 - spec/whostmgr/ssl_spec.rb
 has_rdoc: