Ruby

Create an FTP Upload Plan

Demonstrates the Chilkat Ftp2.CreatePlan method, which creates and returns a textual upload plan for a local directory. The only argument is the local directory. The object must be connected, because the plan records the current absolute remote directory together with the local source paths.

Note: The local paths are relative to the application's current working directory. Absolute paths may also be used. Supply the paths appropriate to your own environment.

Background: A plan is a saved, resumable description of an upload — the list of local files and their absolute remote destinations — computed once and executed later (or on another run) with PutPlan. Separating planning from execution suits large or unreliable transfers: the plan can be reviewed, stored, and re-run, and because it records absolute remote paths it stays correct even if the working directory later changes.

Chilkat Ruby Downloads

Download Chilkat for Ruby

Ruby

require 'chilkat'

success = false

#  Demonstrates the Ftp2.CreatePlan method, which creates and returns a textual upload plan for a
#  local directory.  The only argument is the local directory.  The object must be connected,
#  because the plan records the current absolute remote directory.

ftp = Chilkat::CkFtp2.new()

ftp.put_Hostname("ftp.example.com")
ftp.put_Username("myFtpLogin")

#  Normally you would not hard-code the password in source.  You should instead obtain it
#  from an interactive prompt, environment variable, or a secrets vault.
ftp.put_Password("myPassword")

success = ftp.Connect()
if (success == false)
    print ftp.lastErrorText() + "\n";
    exit
end

success = ftp.ChangeRemoteDir("public_html")
if (success == false)
    print ftp.lastErrorText() + "\n";
    exit
end

#  The plan captures which local files to upload and the absolute remote destination.  Save it so
#  the upload can be run (or resumed) later with PutPlan.
plan = ftp.createPlan("qa_data/site")
if (ftp.get_LastMethodSuccess() == false)
    print ftp.lastErrorText() + "\n";
    exit
end

#  Persist the plan text for later use.
sbPlan = Chilkat::CkStringBuilder.new()
sbPlan.Append(plan)
success = sbPlan.WriteFile("qa_output/upload_plan.txt")
if (success == false)
    print sbPlan.lastErrorText() + "\n";
    exit
end

print "Upload plan created." + "\n";

success = ftp.Disconnect()
if (success == false)
    print ftp.lastErrorText() + "\n";
    exit
end