(Ruby) Download File from Dropbox (Streaming)

See more Dropbox Examples

Downloads a file from Dropbox, streaming it directly to a file in the filesystem.

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

require 'chilkat'

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

# A Dropbox access token should have been previously obtained.
# Dropbox access tokens do not expire.
# See Dropbox Access Token.

rest = Chilkat::CkRest.new()

# Connect to Dropbox
success = rest.Connect("content.dropboxapi.com",443,true,true)
if (success != true)
    print rest.lastErrorText() + "\n";
    exit
end

# Add request headers.
rest.AddHeader("Authorization","Bearer DROPBOX_ACCESS_TOKEN")

# The download "parameters" are contained in JSON passed in an HTTP request header.
# This is the JSON indicating the file to be downloaded:
# { 
#    "path": "/Homework/lit/hamlet.xml",
# }

json = Chilkat::CkJsonObject.new()
json.AppendString("path","/Homework/lit/hamlet.xml")
rest.AddHeader("Dropbox-API-Arg",json.emit())

# Setup a file stream for the download
fileStream = Chilkat::CkStream.new()
fileStream.put_SinkFile("qa_output/hamletFromDropbox.xml")

# Indicate that the call to FullRequestNoBody should send the response body
# to fileStream if the response status code is 200.
# If a non-success response status code is received, then nothing
# is streamed to the output file and the error response is returned by FullRequestNoBody.
expectedStatus = 200
rest.SetResponseBodyStream(expectedStatus,true,fileStream)

responseStr = rest.fullRequestNoBody("POST","/2/files/download")
if (rest.get_LastMethodSuccess() != true)
    print rest.lastErrorText() + "\n";
    exit
end

# When successful, Dropbox responds with a 200 response code.
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): " + responseStr + "\n";
    print "---" + "\n";
    print "LastRequestStartLine: " + rest.lastRequestStartLine() + "\n";
    print "LastRequestHeader: " + rest.lastRequestHeader() + "\n";
    exit
end

# Information about the downloaded file is also available as JSON in a response header.
# The "dropbox-api-result" response header contains the information.  For example:
apiResult = rest.responseHdrByName("dropbox-api-result")
print apiResult + "\n";

# In this case, the pretty-formatted dropbox-api-result JSON looks like this:
# { 
#   "name": "hamlet.xml",
#   "path_lower": "/homework/lit/hamlet.xml",
#   "path_display": "/Homework/lit/hamlet.xml",
#   "id": "id:74FkdeNuyKAAAAAAAAAAAQ",
#   "client_modified": "2016-06-02T23:19:00Z",
#   "server_modified": "2016-06-02T23:19:00Z",
#   "rev": "9482db15f",
#   "size": 279658
# }

# Load the JSON, pretty-print it, and demonstrate how to get some values...
jsonResult = Chilkat::CkJsonObject.new()
jsonResult.put_EmitCompact(false)
jsonResult.Load(apiResult)
# Show the JSON pretty-printed...
print jsonResult.emit() + "\n";

# Sample code to get data from the JSON response:
size = jsonResult.IntOf("size")
print "size = " + size.to_s() + "\n";

rev = jsonResult.stringOf("rev")
print "rev = " + rev + "\n";

clientModified = jsonResult.stringOf("client_modified")
ckdt = Chilkat::CkDateTime.new()
ckdt.SetFromTimestamp(clientModified)
bLocalTime = true
# dt is a CkDtObj
dt = ckdt.GetDtObj(bLocalTime)
print dt.get_Day().to_s() + "/" + dt.get_Month().to_s() + "/" + dt.get_Year().to_s() + " " + dt.get_Hour().to_s() + 
    ":" + dt.get_Minute().to_s() + "\n";