(Ruby) eBay -- Download Data using FileTransferService

Demonstrates how to download a data file using the eBay File Transfer API.

Note: This example requires Chilkat v9.5.0.67 or later.

Chilkat Ruby Downloads install from rubygems.org gem install chilkat or download... Ruby Library for Windows, MacOS, Linux, Alpine Linux

require 'chilkat'

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

# Use a previously obtained access token.  The token should look something like this:
# "AgAAAA**AQA ..."
accessToken = "EBAY_ACCESS_TOKEN"

http = Chilkat::CkHttp.new()

req = Chilkat::CkHttpRequest.new()

req.put_HttpVerb("POST")
req.put_Path("/FileTransferService")
req.put_ContentType("application/xml")

# Build the XML body for the request.
xml = Chilkat::CkXml.new()
xml.put_Tag("downloadFileRequest")
xml.AddAttribute("xmlns","http://www.ebay.com/marketplace/services")
xml.UpdateChildContent("taskReferenceId","50013004806")
xml.UpdateChildContent("fileReferenceId","50015579016")

req.LoadBodyFromString(xml.getXml(),"utf-8")

# The XML body looks like this:

# 	<?xml version="1.0" encoding="UTF-8"?>
# 	<downloadFileRequest xmlns="http://www.ebay.com/marketplace/services">
# 	<taskReferenceId>50013004806</taskReferenceId>
# 	<fileReferenceId>50015579016</fileReferenceId>
# 	</downloadFileRequest>

req.AddHeader("X-EBAY-SOA-OPERATION-NAME","downloadFile")
req.AddHeader("X-EBAY-SOA-SECURITY-TOKEN",accessToken)

# resp is a CkHttpResponse
resp = http.SynchronousRequest("storage.sandbox.ebay.com",443,true,req)
if (http.get_LastMethodSuccess() != true)
    print http.lastErrorText() + "\n";
    exit
end

statusCode = resp.get_StatusCode()
print "Response status code = " + statusCode.to_s() + "\n";

responseBody = Chilkat::CkBinData.new()
resp.GetBodyBd(responseBody)

# We can save the response body to a file for examination if we get an unanticipated response.  
# (It's binary, so it won't open well in a text editor.)
responseBody.WriteFile("qa_output/response.mime")

if (statusCode != 200)
    print "Failed." + "\n";
    exit
end

# The response body looks like this:

# 	--MIMEBoundaryurn_uuid_2B668636C1E17A4D4114925305818684241
# 	Content-Type: application/xop+xml; charset=utf-8; type="text/xml"
# 	Content-Transfer-Encoding: binary
# 	Content-ID: <0.urn:uuid:2B668636C1E17A4D4114925305818684242>
# 
# 	<?xml version='1.0' encoding='UTF-8'?>
# 	<downloadFileResponse xmlns="http://www.ebay.com/marketplace/services">
# 	<ack>Success</ack>
# 	<version>1.1.0</version>
# 	<timestamp>2017-04-18T15:49:41.868Z</timestamp>
# 	<fileAttachment>
# 	    <Size>587</Size>
# 	    <Data>
#                 <xop:Include xmlns:xop="http://www.w3.org/2004/08/xop/include" href="cid:urn:uuid:A37C3C73E994C267F11492530585522"/>
# 	    </Data>
# 	</fileAttachment>
# 	</downloadFileResponse>
# 	--MIMEBoundaryurn_uuid_2B668636C1E17A4D4114925305818684241
# 	Content-Type: application/zip
# 	Content-Transfer-Encoding: binary
# 	Content-ID: <urn:uuid:A37C3C73E994C267F11492530585522>
# 
# 	<the binary bytes of the zip start here...>
# 

# Load the binary response into a MIME object.
mime = Chilkat::CkMime.new()
success = mime.LoadMimeBd(responseBody)
if (success != true)
    print mime.lastErrorText() + "\n";
    exit
end

# Make sure we have 2 sub-parts.  The 1st sub-part is the XML response, the 2nd sub-part
# is the zip containing the data.

# Note: The 2nd sub-part can be a "zip" or "gzip".  These are two different file formats.
# A zip is indicated with a Content-Type header equal to "application/zip",
# whereas a gzip is indicated with a Content-Type header equal to "application/x-gzip"
if (mime.get_NumParts() != 2)
    print "Expected the MIME to have 2 parts." + "\n";
    print "NumParts = " + mime.get_NumParts().to_s() + "\n";
    print "Failed." + "\n";
    exit
end

# Get the XML from the 1st MIME sub-part.
# part0 is a CkMime
part0 = mime.GetPart(0)
downloadResponseXml = part0.getBodyDecoded()
xmlResp = Chilkat::CkXml.new()
xmlResp.LoadXml(downloadResponseXml)
print "Download Response XML:" + "\n";
print xmlResp.getXml() + "\n";

print "----" + "\n";

# Now get the zip from the second part (index=1), unzip, and examine..
# part1 is a CkMime
part1 = mime.GetPart(1)
zipData = Chilkat::CkBinData.new()
# This example requires Chilkat v9.5.0.67 or later.
# The GetBodyBd method was added in v9.5.0.67.
part1.GetBodyBd(zipData)

# Check to see if we have a zip or gzip.
sbContentType = Chilkat::CkStringBuilder.new()
sbContentType.Append(part1.contentType())

xmlFromZip = Chilkat::CkXml.new()

if (sbContentType.Contains("gzip",false) == true)
    # This is a gzip compressed file.
    gzip = Chilkat::CkGzip.new()

    # in-place uncompress the data.
    # Note: The UncompressBd method was added in Chilkat v9.5.0.67
    success = gzip.UncompressBd(zipData)
    if (success != true)
        print gzip.lastErrorText() + "\n";
        exit
    end

    xmlFromZip.LoadXml(zipData.getString("utf-8"))

else
    # This is a zip archive.

    # Load the body into a Zip object.
    zip = Chilkat::CkZip.new()
    success = zip.OpenBd(zipData)
    if (success != true)
        print zip.lastErrorText() + "\n";
        exit
    end

    # Save the .zip to a file (so we can examine it for debugging if something is not as expected)
    zipData.WriteFile("qa_output/ebay_data.zip")

    # The zip should contain a single XML file.
    if (zip.get_NumEntries() != 1)
        print "Expected the .zip to have 1 entry." + "\n";
        print "NumEntries = " + zip.get_NumEntries().to_s() + "\n";
        print "Failed." + "\n";
        exit
    end

    # entry is a CkZipEntry
    entry = zip.GetEntryByIndex(0)

    xmlFromZip.LoadXml(entry.unzipToString(0,"utf-8"))

end

print "XML contained in the zip:" + "\n";
print xmlFromZip.getXml() + "\n";
print "----" + "\n";

print "Success." + "\n";