(Ruby) REST Download Binary to Memory (CkByteData) (Amazon S3)

Demonstrates how to make a REST call that returns a binary response body. This example is valid for reasonably small files that fit in memory. The example shows how to download a small JPG from the Amazon S3 service. For larger files, Chilkat provides streaming functionality to stream directly to a file, or to make an asynchronous call where the foreground thread can read the response body stream.

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.

rest = Chilkat::CkRest.new()

# Connect to the Amazon AWS REST server.
bTls = true
port = 443
bAutoReconnect = true
success = rest.Connect("s3.amazonaws.com",port,bTls,bAutoReconnect)

# ----------------------------------------------------------------------------
# Important: For buckets created in regions outside us-east-1,
# there are three important changes that need to be made.
# See Working with S3 Buckets in Non-us-east-1 Regions for the details.
# ----------------------------------------------------------------------------

# Provide AWS credentials for the REST call.
authAws = Chilkat::CkAuthAws.new()
authAws.put_AccessKey("AWS_ACCESS_KEY")
authAws.put_SecretKey("AWS_SECRET_KEY")
authAws.put_ServiceName("s3")
success = rest.SetAuthAws(authAws)

# Set the bucket name via the HOST header.
# In this case, the bucket name is "chilkat100".
rest.put_Host("chilkat100.s3.amazonaws.com")

# Send the request to download the JPG.
success = rest.SendReqNoBody("GET","/starfish.jpg")
if (success != true)
    print rest.lastErrorText() + "\n";
    exit
end

# Read the response header.
responseStatusCode = rest.ReadResponseHeader()
if (responseStatusCode < 0)
    print rest.lastErrorText() + "\n";
    exit
end

print "Response status code = " + responseStatusCode.to_s() + "\n";

# We expect a 200 response status if the JPG data is coming.
# Otherwise, we'll get a string response body with an error message(or no response body).
if (responseStatusCode == 200)
    jpgData = Chilkat::CkByteData.new()
    success = rest.ReadRespBodyBinary(jpgData)
    if (rest.get_LastMethodSuccess() != true)
        print rest.lastErrorText() + "\n";
    else
        print "Successfully received the JPG bytes.." + "\n";
        # See the CkByteData online reference documentation for 
        # information about accessing and manipulating the byte data.
    end

else
    errResponse = rest.readRespBodyString()
    if (rest.get_LastMethodSuccess() != true)
        print rest.lastErrorText() + "\n";
    else
        print errResponse + "\n";
    end

end