Ruby

Send a Staged REST Request with a Binary Body

Demonstrates Rest.SendReqBd, which sends a request whose binary body is read from a BinData, then reads the response in separate steps.

The file paths are relative to the application's current working directory. Absolute paths may also be used. Supply the paths appropriate to your own environment.

Background. The staged request model separates sending from reading: a SendReq method transmits the request, ReadResponseHeader reads the status line and headers, and a ReadResp method reads the body. This gives fine control over large or streamed messages compared with the single-call full-request methods.

Chilkat Ruby Downloads

Download Chilkat for Ruby

Ruby

require 'chilkat'

success = false

rest = Chilkat::CkRest.new()
bTls = true
bAutoReconnect = true
success = rest.Connect("example.com",443,bTls,bAutoReconnect)
if (success == false)
    print rest.lastErrorText() + "\n";
    exit
end

#  The file paths are relative to the application's current working directory.  Absolute paths
#  may also be used.  Supply the paths appropriate to your own environment.

#  Send a request whose binary body is read from a BinData.
bdBody = Chilkat::CkBinData.new()
bLoaded = bdBody.LoadFile("qa_data/image.png")
if (bLoaded != true)
    print "Failed to load the request body file." + "\n";
    exit
end

rest.AddHeader("Content-Type","image/png")

success = rest.SendReqBd("PUT","/api/images/1",bdBody)
if (success == false)
    print rest.lastErrorText() + "\n";
    exit
end

#  After sending, read the response status line and header fields.  The return value is the HTTP
#  status code, or -1 if no response was received.
statusCode = rest.ReadResponseHeader()
if (statusCode < 0)
    print rest.lastErrorText() + "\n";
    exit
end

print "Response status code: " + statusCode.to_s() + "\n";

#  Read the response body as text.
responseBody = rest.readRespBodyString()
if (rest.get_LastMethodSuccess() == false)
    print rest.lastErrorText() + "\n";
    exit
end

print responseBody + "\n";