(Ruby) SharePoint -- Download a Text File into a String Variable

See more SharePoint Examples

Demonstrates how to download a text file from SharePoint into a string variable.

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

require 'chilkat'

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

# -------------------------------------------------------------------------
# The following comments apply to SharePoint Windows classic authentication.
# -------------------------------------------------------------------------
# For example, imagine our SharePoint endpoint is https://xyzoffice.mycompany.com/
# The SHAREPOINT_NTLM_DOMAIN would be "mycompany.com"
# The SHAREPOINT_HTTPS_DOMAIN would be "xyzoffice.mycompany.com"
# Also, the SHAREPOINT_USERNAME would be just the name, not a full email address.
# for example, "chilkat" instead of "chilkat@mycompany.com"

http = Chilkat::CkHttp.new()

# If SharePoint Windows classic authentication is used, then set the 
# Login, Password, LoginDomain, and NtlmAuth properties.
http.put_Login("SHAREPOINT_USERNAME")
http.put_Password("SHAREPOINT_PASSWORD")
http.put_LoginDomain("SHAREPOINT_NTLM_DOMAIN")
http.put_NtlmAuth(true)

# -------------------------------------------------------------------------
# The more common case is to use SharePoint Online authentication (via the SPOIDCRL cookie).
# If so, do not set Login, Password, LoginDomain, and NtlmAuth, and instead
# establish the cookie as shown at SharePoint Online Authentication
# -------------------------------------------------------------------------

# This example downloads a CSV file that is utf-8 and contains Japanese characters.

url = "https://SHAREPOINT_HTTPS_DOMAIN/_api/web/GetFileByServerRelativeUrl('/Documents/ChilkatTest/japanese.csv')/$value"

http.put_AcceptCharset("utf-8")

strCsv = http.quickGetStr(url)
if (http.get_LastMethodSuccess() != true)
    print http.lastErrorText() + "\n";
    exit
end

# The CSV file is contained in strCsv.
print "CSV:" + "\n";
print strCsv + "\n";

# Note: The HTTP response hopefully indicates the charset of the response,
# and Chilkat should receive the string correctly.  If the response sent by
# SharePoint does not indicate a charset, or indicates an incorrect charset,
# then we can instead download the text file as binary data and interpret the
# bytes ourselves correctly.  For example:  

bd = Chilkat::CkBinData.new()
success = http.QuickGetBd(url,bd)
if (success != true)
    print http.lastErrorText() + "\n";
    exit
end

# Interpret the bytes correctly as utf-8
sb = Chilkat::CkStringBuilder.new()
sb.AppendBd(bd,"utf-8",0,0)
print "CSV:" + "\n";
print sb.getAsString() + "\n";