Ruby

HTTP POST and Stream Response to File

See more REST Examples

Demonstrates how to send an HTTP POST and stream the response body directly to a file. Ruby

require 'chilkat'

success = false

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

rest = Chilkat::CkRest.new()

url = Chilkat::CkUrl.new()
# This URL will emit a response that echos the query params (name and age)
url.ParseUrl("https://www.chilkatsoft.com/readPost.asp")

# Connect to the web server
bAutoReconnect = true
success = rest.Connect(url.host(),url.get_Port(),url.get_Ssl(),bAutoReconnect)
if (success != true)
    print rest.lastErrorText() + "\n";
    exit
end

rest.AddQueryParam("name","John")
rest.AddQueryParam("age","33")

#  Send the HTTP POST.
success = rest.SendReqFormUrlEncoded("POST",url.path())
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 file data is coming.
# Otherwise, we'll get a string response body with an error message(or no response body).
if (responseStatusCode == 200)

    bodyStream = Chilkat::CkStream.new()

    # The stream's sink will be a file.
    bodyStream.put_SinkFile("qa_output/out.txt")

    # Read the response body to the stream.  Given that we've
    # set the stream's sink to a file, it will stream directly
    # to the file.
    success = rest.ReadRespBodyStream(bodyStream,true)
    if (success != true)
        print rest.lastErrorText() + "\n";
        exit
    end

    print "Successfully streamed the response to a file." + "\n";

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

end