(Ruby) REST Read Response with Stream API

Demonstrates how to make a REST call that returns a binary body, and to receive the body through a stream API.

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)
    errResponse = rest.readRespBodyString()
    if (rest.get_LastMethodSuccess() != true)
        print rest.lastErrorText() + "\n";
    else
        print errResponse + "\n";
    end

    exit
end

bodyStream = Chilkat::CkStream.new()
# Set a 10 second read timeout for the stream. 
# (Give up if no data arrives within 10 seconds after calling a read method.)
bodyStream.put_ReadTimeoutMs(10000)

# Create a background thread task to read the response body (which feeds
# it to the bodyStream object.)
# readResponseBodyTask is a CkTask
readResponseBodyTask = rest.ReadRespBodyStreamAsync(bodyStream,true)

# Start the task. 
success = readResponseBodyTask.Run()

# The application can now read the bodyStream...
nextChunk = Chilkat::CkByteData.new()
while (bodyStream.get_EndOfStream() != true)

    # Read the next chunk of bytes (whatever is immediately available,
    # or wait for more data (up to 10 seconds because we set the stream's ReadTimeoutMs property)
    success = bodyStream.ReadBytes(nextChunk)
    if (success != true)
        print "Failed to receive more response data." + "\n";
        # Make sure the background task is aborted/cancelled.
        success = readResponseBodyTask.Cancel()

        exit
    end

    # OK.. the app has the next chunk of the body, and may do whatever it wishes with it...
    # See the CkByteData online reference documentation for 
    # information about accessing and manipulating the byte data.

end

print "Successfully received the entire response body." + "\n";