Ruby

REST Download Binary File to Memory

See more REST Examples

Download a binary file to a Chilkat BinData object. Ruby

require 'chilkat'

success = false

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

rest = Chilkat::CkRest.new()

# We're going to download a sample MS-Word doc file.
# The URLs of our MS-Word sample documents are:

# https://www.chilkatdownload.com/sample_data/sample.doc
# https://www.chilkatdownload.com/sample_data/sample.docx

pathPartOfUrl = "/sample_data/sample.doc"
domain = "chilkatdownload.com"

bTls = true
port = 443
bAutoReconnect = true
success = rest.Connect(domain,port,bTls,bAutoReconnect)
if (success != true)
    print rest.lastErrorText() + "\n";
    exit
end

bd = Chilkat::CkBinData.new()
success = rest.FullRequestNoBodyBd("GET",pathPartOfUrl,bd)
if (success != true)
    print rest.lastErrorText() + "\n";
    exit
end

# A 200 response is expected for actual success.
# If we don't get a 200 response, then the response body was not actually
# the file data, but it was text containing error information.
if (rest.get_ResponseStatusCode() != 200)
    sbErrorText = Chilkat::CkStringBuilder.new()
    sbErrorText.AppendBd(bd,"utf-8",0,0)
    print sbErrorText.getAsString() + "\n";
    print "-- Failed." + "\n";
    exit
end

# Save to a local file.
# Change the file path based on your operating system or needs...
success = bd.WriteFile("c:/temp/qa_output/sample.doc")
if (success != true)
    print "Failed to save to local file." + "\n";
    exit
end

print "REST Download of MS-Word File was successful." + "\n";