Chilkat Examples

ChilkatHOMEAndroid™Classic ASPCC++C#Mono C#.NET Core C#C# UWP/WinRTDataFlexDelphi ActiveXDelphi DLLVisual FoxProJavaLianjaMFCObjective-CPerlPHP ActiveXPHP ExtensionPowerBuilderPowerShellPureBasicPythonRubySQL ServerSwiftTclUnicode CUnicode C++Visual Basic 6.0VB.NETVB.NET UWP/WinRTVBScriptXojo PluginNode.jsExcel

Ruby Examples


ASN.1
Amazon S3
Amazon S3 (new)
Amazon SES
Amazon SNS
Amazon SQS
Async
Azure Cloud Storage
Azure Service Bus
Bounced Email
Box
CSR
CSV
Certificates
Compression
DKIM / DomainKey
DSA
Diffie-Hellman
Digital Signatures
Dropbox
ECC
Email Object
Encryption
FTP
Facebook
Firebase
GeoOp
Google APIs
Google Calendar
Google Cloud Storage
Google Drive
Gzip
HTML-to-XML/Text
HTTP
HTTP Misc
IMAP
JSON
JSON Web Encryption (JWE)
JSON Web Signatures (JWS)
JSON Web Token (JWT)

Java KeyStore (JKS)
MHT / HTML Email
MIME
Microsoft Graph
NTLM
OAuth1
OAuth2
OneDrive
OpenSSL
Outlook
PEM
PFX/P12
POP3
PRNG
PayPal
Peoplevox
QuickBooks
REST
RSA Encryption
SCP
SFTP
SMTP
SSH
SSH Key
SSH Tunnel
SharePoint
Shopify
Socket/SSL/TLS
Spider
Stream
Stripe
SugarCRM
Tar Archive
Twitter
VoiceBase
Walmart
WebSocket
XML
XML Digital Signatures
XMP
Xero
Zip
curl
eBay

 

 

 

(Ruby) Xero Get Attachment (Download a Xero Attachment)

Demonstrates how to get the content of an attachment in Xero.

Note: This example requires Chilkat v9.5.0.64 or greater.

Chilkat Ruby Downloads

Ruby Library for Linux and MAC OS X

require 'chilkat'

#  Note: Requires Chilkat v9.5.0.64 or greater.

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

rest = Chilkat::CkRest.new()

#  Before sending REST API calls, the REST object needs to be
#  initialized for OAuth1.
#  See Xero 2-Legged OAuth1 Setup for sample code.

#  Assuming the REST object's OAuth1 authenticator is setup, and the initial
#  connection was made, we may now send REST HTTP requests..

#  --------------------------------------------------------------
#  First get a list of attachments for a given document (in this case a Receipt).

endPoint = "Receipts"
receiptID = "c4f40e59-c390-0001-caff-ce731c707d00"

sbPath = Chilkat::CkStringBuilder.new()
sbPath.Append("/api.xro/2.0/{Endpoint}/{Guid}/Attachments/")
numReplaced = sbPath.Replace("{Endpoint}",endPoint)
numReplaced = sbPath.Replace("{Guid}",receiptID)

responseXml = rest.fullRequestNoBody("GET",sbPath.getAsString())
if (rest.get_LastMethodSuccess() != true)
    print rest.lastErrorText() + "\n";
    exit
end

#  A 200 response is expected for actual success.
if (rest.get_ResponseStatusCode() != 200)
    print responseXml + "\n";
    exit
end

#  Examine the response.
print responseXml + "\n";

#  A sample response looks like this:

#  	<Response xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
#  	  <Id>b235646f-34ac-4b15-90ce-d63267f7cd33</Id>
#  	  <Status>OK</Status>
#  	  <ProviderName>ChilkatPrivate</ProviderName>
#  	  <DateTimeUTC>2016-11-11T14:32:17.0908971Z</DateTimeUTC>
#  	  <Attachments>
#  	    <Attachment>
#  	      <AttachmentID>0edcddc8-325f-40c7-b950-8c71f14afc7c</AttachmentID>
#  	      <FileName>penguins.jpg</FileName>
#  	      <Url>http://api.xero.com/api.xro/2.0/Receipts/c4f40e59-c390-0001-caff-ce731c707d00/Attachments/penguins.jpg</Url>
#  	      <MimeType>image/jpg</MimeType>
#  	      <ContentLength>777835</ContentLength>
#  	    </Attachment>
#  	    <Attachment>
#  	      <AttachmentID>0adffdc8-325f-65c7-b950-4391f14af908</AttachmentID>
#  	      <FileName>starfish.jpg</FileName>
#  	      <Url>http://api.xero.com/api.xro/2.0/Receipts/c4f40e59-c390-0001-caff-ce731c707d00/Attachments/starfish.jpg</Url>
#  	      <MimeType>image/jpg</MimeType>
#  	      <ContentLength>24537</ContentLength>
#  	    </Attachment>
#  	  </Attachments>
#  	</Response>

xml = Chilkat::CkXml.new()
xml.LoadXml(responseXml)

#  Iterate over the attachments and download each.
numRecords = xml.NumChildrenAt("Attachments")
print "Number of Attachments = " + numRecords.to_s() + "\n";

sbSaveFilePath = Chilkat::CkStringBuilder.new()
sbAttachmentPath = Chilkat::CkStringBuilder.new()
attachmentData = Chilkat::CkBinData.new()
i = 0
while i < numRecords
    xml.put_I(i)
    attachmentID = xml.getChildContent("Attachments|Attachment[i]|AttachmentID")
    filename = xml.getChildContent("Attachments|Attachment[i]|FileName")

    print "AttachmentID: " + attachmentID + "\n";
    print "Filename: " + filename + "\n";
    print "----" + "\n";

    #  Download this attachment.
    #  First build the path for this particular attachment by appending the FileName to the path used to get the list of attachments.
    sbAttachmentPath.Clear()
    sbAttachmentPath.AppendSb(sbPath)
    sbAttachmentPath.Append(filename)

    #  Send the GET request in one call, and then get the response in the next two.
    success = rest.SendReqNoBody("GET",sbAttachmentPath.getAsString())
    if (success != true)
        print rest.lastErrorText() + "\n";
        exit
    end

    #  Get the response header.  If it's not a 200 success status code, then the response body does NOT contain
    #  the attachment data.
    statusCode = rest.ReadResponseHeader()
    if (statusCode == -1)
        #  We didn't get any response..
        print rest.lastErrorText() + "\n";
        exit
    end

    if (statusCode != 200)
        print "Response Status: " + statusCode.to_s() + "\n";
        responseBody = rest.readRespBodyString()
        if (rest.get_LastMethodSuccess() != true)
            print "Failed to read the response body." + "\n";
        else
            print responseBody + "\n";
        end

        print "Failed." + "\n";
        exit
    end

    #  OK, the response header indicates the attachment content is forthcoming...
    #  There are a few ways to get the response body. If it is a very large attachment, it can be streamed directly
    #  to a file.  We'll assume it's not, so we'll get the response into a BinData object, and then save it to a file.
    attachmentData.Clear()
    success = rest.ReadRespBd(attachmentData)
    if (success != true)
        print rest.lastErrorText() + "\n";
        exit
    end

    #  Save the data to the file.
    sbSaveFilePath.SetString("qa_output/")
    sbSaveFilePath.Append(filename)
    success = attachmentData.WriteFile(sbSaveFilePath.getAsString())
    if (success != true)
        print "Failed to save to output file." + "\n";
    else
        print "Saved to " + sbSaveFilePath.getAsString() + "\n";
    end

    i = i + 1
end

 

© 2000-2016 Chilkat Software, Inc. All Rights Reserved.