Ruby

Download a Text File into a String

See more Azure Cloud Storage Examples

Downloads a text file to a string variable. Ruby

require 'chilkat'

success = false

# Azure File Service Example: Download Text File into String
# See:  https://docs.microsoft.com/en-us/rest/api/storageservices/get-file

# 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 Azure Storage Blob Service
bTls = true
port = 443
bAutoReconnect = true
# In this example, the storage account name is "chilkat".
success = rest.Connect("chilkat.file.core.windows.net",port,bTls,bAutoReconnect)
if (success != true)
    print rest.lastErrorText() + "\n";
    exit
end

# Provide Azure Cloud credentials for the REST calls.
azAuth = Chilkat::CkAuthAzureStorage.new()
azAuth.put_AccessKey("AZURE_ACCESS_KEY")
# The account name used here should match the 1st part of the domain passed in the call to Connect (above).
azAuth.put_Account("chilkat")
azAuth.put_Scheme("SharedKey")
azAuth.put_Service("File")
# This causes the "x-ms-version: 2021-08-06" header to be automatically added.
azAuth.put_XMsVersion("2021-08-06")
success = rest.SetAuthAzureStorage(azAuth)

# Note: The application does not need to explicitly set the following
# headers: x-ms-date, Authorization.  These headers
# are automatically set by Chilkat.

# Send a GET request to download the file "hamlet.xml" to a StringBuilder object.
# (The share name is "pip")
sbFileContents = Chilkat::CkStringBuilder.new()
success = rest.FullRequestNoBodySb("GET","/pip/xmlFiles/hamlet.xml",sbFileContents)
if (success != true)
    print rest.lastErrorText() + "\n";
    exit
end

# When successful, the response status will be 200.
# If a non-success status code is returned, then the sbFileContents actually contains the XML error message.
if (rest.get_ResponseStatusCode() != 200)
    # Examine the request/response to see what happened.
    print "response status code = " + rest.get_ResponseStatusCode().to_s() + "\n";
    print "response status text = " + rest.responseStatusText() + "\n";
    print "response header: " + rest.responseHeader() + "\n";
    print "response body (if any): " + sbFileContents.getAsString() + "\n";
    print "---" + "\n";
    print "LastRequestStartLine: " + rest.lastRequestStartLine() + "\n";
    print "LastRequestHeader: " + rest.lastRequestHeader() + "\n";
    exit
end

print "Length of downloaded string = " + sbFileContents.get_Length().to_s() + "\n";

strFileContents = sbFileContents.getAsString()
print strFileContents + "\n";

sbFileContents.WriteFile("qa_output/hamlet.xml","utf-8",false)