(Ruby) FTP Sync Download Tree w/ Must-Match Constraints

Demonstrates how synchronize a directory tree in the download direction, but only for files matching a set of wildcard filenames.

Note: This example requires Chilkat v9.5.0.76 or greater.

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.something.com")
ftp.put_Username("my_login")
ftp.put_Password("my_password")

# 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 of
# the tree to be downloaded.
success = ftp.ChangeRemoteDir("/subDir1")
if (success != true)
    print ftp.lastErrorText() + "\n";
    exit
end

# Possible synchronization modes are:
# mode=0: Download all files
# mode=1: Download all files that do not exist on the local filesystem.
# mode=2: Download newer or non-existant files.
# mode=3: Download only newer files. If a file does not already exist on the local filesystem, it is not downloaded from the server..
# mode=5: Download only missing files or files with size differences.
# mode=6: Same as mode 5, but also download newer files.

# This example will download all files, but only those files having filenames
# that match *.gif and *.eml

# Imagine our remote directory tree has these files and directories:

# 	accentedLatin1.txt
# 	accentedUtf8.txt
# 	alice.key
# 	anter_cert.pem
# 	chiliPepper.gif
# 	helloWorld.pdf
# 	abc/chiliPepper.gif
# 	abc/ghk/
# 	data/chiliPepper.gif
# 	data/xyz/dkimHtmlBody.txt
# 	data/xyz/dkimVerifyTest.eml
# 	data/xyz/emailForCreateDsn.eml
# 	text/frenchUtf8.txt
# 	text/helloWorld.txt
# 	text/PolishEmailBody.txt
# 	text/something/

# Indicate that we only want to create auto-create local directories (if needed)
# for the files that are actually downloaded.  If SyncCreateAllLocalDirs remains
# true, then the corresponding local directory is created for each remote directory
# traversed regardless of whether files within are downloaded.
ftp.put_SyncCreateAllLocalDirs(false)

ftp.put_SyncMustMatch("*.eml; *.gif")
mode = 0
success = ftp.SyncLocalTree("c:/temp/subDir1",mode)
if (success != true)
    print ftp.lastErrorText() + "\n";
    exit
end

success = ftp.Disconnect()

# Show the files downloaded.
print ftp.syncedFiles() + "\n";

# Output showing the files downloaded:

# chiliPepper.gif
# abc/chiliPepper.gif
# data/chiliPepper.gif
# data/xyz/dkimVerifyTest.eml
# data/xyz/emailForCreateDsn.eml