Ruby

Box.com Streaming Upload File

See more Box Examples

Demonstrates how to upload a file to box.com, streaming the file directly from the filesystem.

Note: This example requires a fix that is included in Chilkat v9.5.0.70 and above.

Ruby

require 'chilkat'

success = false

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

rest = Chilkat::CkRest.new()

#   Provide a previously obtained OAuth2 access token.
oauth2 = Chilkat::CkOAuth2.new()
oauth2.put_AccessToken("BOX_ACCESS_TOKEN")
rest.SetAuthOAuth2(oauth2)

# First, make the initial connection.
# A single REST object, once connected, can be used for many Box REST API calls.
# The auto-reconnect indicates that if the already-established HTTPS connection is closed,
# then it will be automatically re-established as needed.
bAutoReconnect = true

# ----------------------------------------------------------------------
# IMPORTANT: Note that the domain is "upload.box.com", not "api.box.com"
# ----------------------------------------------------------------------
success = rest.Connect("upload.box.com",443,true,bAutoReconnect)
if (success != true)
    print rest.lastErrorText() + "\n";
    exit
end

# The request body uses the "multipart/form-data" format to transmit two "parts". 
# The first part is called "attributes" and contains a JSON object with information about the file, including the name of the file 
# and the ID of the parent folder. The second part contains the contents of the file. 
# (Note that the name of the second "part" is ignored.)

rest.AddHeader("Content-Type","multipart/form-data")

# Provide the content for each part of the request...

# First the JSON attributes.  Use "0" for the root folder.
#   {"name":"hedgehogs.jpg", "parent":{"id":"0"}}
jsonAttr = Chilkat::CkJsonObject.new()
jsonAttr.UpdateString("name","hedgehogs.jpg")
jsonAttr.UpdateString("parent.id","0")

rest.put_PartSelector("1")
rest.AddHeader("Content-Disposition","form-data; name=\"attributes\"; ")
rest.SetMultipartBodyString(jsonAttr.emit())

# The upload will stream directly from a file.
rest.put_PartSelector("2")
rest.AddHeader("Content-Disposition","form-data; name=\"file\"; filename=\"hedgehogs.jpg\"")
# "application/octet-stream" can be safely used for any type file..
rest.AddHeader("Content-Type","application/octet-stream")

# IMPORTANT: This example requires Chilkat v9.5.0.70 or later, for a fix that was made in
# multipart/streaming uploads. 
fileStream = Chilkat::CkStream.new()
fileStream.put_SourceFile("qa_data/jpg/hedgehogs.jpg")
rest.SetMultipartBodyStream(fileStream)

# Restore the PartSelector to "0" (for safety, in case something else sends another request on this object)
rest.put_PartSelector("0")

# Send the multipart/form-data request, which uploads the file by streaming directly from the filesystem.
responseBody = rest.fullRequestMultipart("POST","/api/2.0/files/content")
if (rest.get_LastMethodSuccess() != true)
    print rest.lastErrorText() + "\n";
    exit
end

# A 201 is received for a successful upload
if (rest.get_ResponseStatusCode() != 201)
    print "Box.com upload failed." + "\n";
    print "Request header:" + "\n";
    print rest.lastRequestHeader() + "\n";
    print "---" + "\n";
    print "Response status code = " + rest.get_ResponseStatusCode().to_s() + "\n";
    print "Response body:" + "\n";
    print responseBody + "\n";
    exit
end

print "File uploaded." + "\n";