(Ruby) Co:Z SFTP Binary File Download (from z/OS IBM Mainframe)

Demonstrates how to download a binary file, such as a .zip, from a Co:Z SFTP server on a z/OS IBM Mainframe.

Note: This example requires Chilkat v11.0.0 or greater.

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

require 'chilkat'

success = false

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

sftp = Chilkat::CkSFtp.new()

# Connect to the SSH server.  
hostname = "sftp.example.com"
port = 22
success = sftp.Connect(hostname,port)
if (success == false)
    print sftp.lastErrorText() + "\n";
    exit
end

success = sftp.AuthenticatePw("myLogin","myPassword")
if (success == false)
    print sftp.lastErrorText() + "\n";
    exit
end

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

# To download a binary file from the Co:Z SFTP server, 
# we must switch to binary mode in the following unconventional way.
# We pretend to fetch a directory listing for "/+mode=binary"
# This has the effect of putting the server in binary mode for transfers.
handle = sftp.openDir("/+mode=binary")
if (sftp.get_LastMethodSuccess() == false)
    print sftp.lastErrorText() + "\n";
    exit
end

# Download the "directory listing" (but it's not actually a directory listing, and we'll just discard it.)

dirListing = Chilkat::CkSFtpDir.new()
success = sftp.ReadDirListing(handle,dirListing)
if (success == false)
    print sftp.lastErrorText() + "\n";
    exit
end

# Close the directory handle:
success = sftp.CloseHandle(handle)
if (success == false)
    print sftp.lastErrorText() + "\n";
    exit
end

# Download the binary file:
localFilePath = "c:/temp/test.zip"
remoteFilePath = "test.zip"
success = sftp.DownloadFileByName(remoteFilePath,localFilePath)
if (success == false)
    print sftp.lastErrorText() + "\n";
    exit
end

print "Success." + "\n";