(Ruby) Upload Directory Tree using a Plan

Chilkat FTP provides two methods to make it easier to upload large directory trees to an FTP server. The CreatePlan/PutPlan methods can be used to upload and resume an upload if an external failure occurs while the upload is in progress. The CreatePlan method recursively descends the local filesystem directory tree and creates a "plan" of all the files and directories that will be uploaded by PutPlan. The PutPlan method accepts a "plan", and keeps a log file of its progress as it proceeds. If PutPlan fails, it can be called again with the same log file to resume the upload.

Chilkat Ruby Downloads install from rubygems.org gem install chilkat or download... Ruby Library for Windows, MacOS, Linux, Alpine Linux

require 'chilkat'

# This example requires the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.

ftp = Chilkat::CkFtp2.new()

ftp.put_Hostname("ftp.chilkatsoft.com")
ftp.put_Username("myLogin")
ftp.put_Password("myPassword")

# Connect and login to the FTP server.
success = ftp.Connect()
if (success != true)
    print ftp.lastErrorText() + "\n";
    exit
end

# Set the current remote directory to the root where the
# directory tree will be uploaded.
success = ftp.ChangeRemoteDir("/something")
if (success != true)
    print ftp.lastErrorText() + "\n";
    exit
end

# Create a plan for uploading the entire
# directory tree rooted at c:/temp/something
plan = ftp.createPlan("c:/temp/something")

print plan + "\n";

# The plan is essentially a CSV file.  Each line is an instruction to 
# either create a new remote directory, change to a remote directory, or
# upload a file.
# The format of each of the three possible lines is:
# 
# To create a new directory, the command is "d"
# d,<remote_file_path>
# 
# To change to a remote directory, the command is "c"
# c,<remote_file_path>
# 
# To upload a file, the command is "p"
# p,<local_file_path>,<remote_file_name>
# 

# Upload from the plan:
success = ftp.PutPlan(plan,"planLog.txt")
if (success != true)
    print ftp.lastErrorText() + "\n";
    exit
end

# If PutPlan fails while in progress, it may be called again
# to resume the upload.  Simply pass the same plan and plan log
# to PutPlan.  PutPlan will skip over the files/directories 
# already uploaded and resume where it left off.
# 
# The plan log file can be thought of as a record of what has
# already been done. When resuming, the plan log file is appended
# with the new uploads that occur, and if it does not complete,
# the plan can be resumed yet again.

success = ftp.Disconnect()