(Ruby) SharePoint -- Download Newer Files

See more SharePoint Examples

Demonstrates how to download all files from a SharePoint folder that are newer than the local files.

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
# -------------------------------------------------------------------------

# First we'll download a list of all the files in the /Documents folder.
# This provides the names and last-modified date/times of the files located
# on the SharePoint server.
http.put_Accept("application/json;odata=verbose")
http.put_AcceptCharset("utf-8")

sbJson = Chilkat::CkStringBuilder.new()
success = http.QuickGetSb("https://SHAREPOINT_HTTPS_DOMAIN/_api/web/GetFolderByServerRelativeUrl('/Documents')/Files",sbJson)
if (success != true)
    print http.lastErrorText() + "\n";
    exit
end

# Before proceeding, make sure the local directory where we'll be downloading files exists.
fac = Chilkat::CkFileAccess.new()
fac.DirEnsureExists("qa_output/sharepoint/Documents")

# OK.. load the JSON and iterate over each file
json = Chilkat::CkJsonObject.new()
json.LoadSb(sbJson)

numFiles = json.SizeOfArray("d.results")
print "Number of Files in the SharePoint /Documents folder = " + numFiles.to_s() + "\n";

lastModRemote = Chilkat::CkDateTime.new()

localPath = Chilkat::CkStringBuilder.new()
fileUrl = Chilkat::CkStringBuilder.new()

i = 0
while i < numFiles
    json.put_I(i)

    filename = json.stringOf("d.results[i].Name")
    sLastModified = json.stringOf("d.results[i].TimeLastModified")

    print (i + 1).to_s() + ": " + filename + " (" + sLastModified + ")" + "\n";

    lastModRemote.SetFromTimestamp(sLastModified)

    bDownload = false
    # Check to see if the local file exists.  If not, then download.
    localPath.SetString("qa_output/sharepoint/Documents/")
    localPath.Append(filename)
    if (fac.FileExists(localPath.getAsString()) != true)
        print "This file does not exist locally." + "\n";
        bDownload = true
    else
        # Get the local file's date time and compare with the remote file date/time.
        # lastModLocal is a CkDateTime
        lastModLocal = fac.GetLastModified(localPath.getAsString())
        if (fac.get_LastMethodSuccess() == true)
            # Get the difference in seconds between the local and remote last-modified times.
            # if the return value is negative, then the caller's time is 
            # older than the argument.  (in this case, a negative return value means
            # the local file is older than the remote file.

            # Note: The DiffSeconds method was found to be missing in the Chilkat .NET build
            # (and possibly in other builds). It will be present in the v9.5.0.67 release and later.
            numSeconds = lastModLocal.DiffSeconds(lastModRemote)
            if (numSeconds < 0)
                print "The local file is older than the remote file." + "\n";
                bDownload = true
            end

        else
            print "Unable to get the local file's last-modified date/time." + "\n";
            print fac.lastErrorText() + "\n";
        end

    end

    if (bDownload == true)
        fileUrl.SetString("https://SHAREPOINT_HTTPS_DOMAIN/_api/web/GetFolderByServerRelativeUrl('/Documents')/Files('")
        fileUrl.Append(filename)
        fileUrl.Append("')/$value")

        print "Downloading " + filename + "\n";

        success = http.Download(fileUrl.getAsString(),localPath.getAsString())
        if (success != true)
            print http.lastErrorText() + "\n";
            exit
        end

        # Set the local file's last-modified date/time to that of the server's.
        fac.SetLastModified(localPath.getAsString(),lastModRemote)

    end

    i = i + 1
end

print "All finished." + "\n";