(Ruby) REST Upload Bandwidth Throttle

Demonstrates how to use upload bandwidth throttling with the REST API. This example will upload a file to Drobox using a file stream, with a limit on the bandwidth that can be used for the transfer.

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.

# To use bandwidth throttling, the connection should be made using the socket API.
# This provides numerous properties to customize the connection, such as
# BandwidthThrottleDown, BandwidthThrottleUp, ClientIpAddress, ClintPort, Http Proxy,
# KeepAlive, PreferIpv6, RequireSslCertVerify, SoRcvBuf, SoSndBuf, SoReuseAddr,
# SOCKS proxy, TcpNoSDelay, TlsPinSet, TlsCipherSuite, SslAllowedCiphers, etc.

socket = Chilkat::CkSocket.new()
maxWaitMs = 5000
success = socket.Connect("content.dropboxapi.com",443,true,maxWaitMs)
if (success != true)
    print socket.lastErrorText() + "\n";
    print "Connect Fail Reason: " + socket.get_ConnectFailReason().to_s() + "\n";
    exit
end

# Set the upload bandwidth throttle rate to 50000 bytes per second.
socket.put_BandwidthThrottleUp(50000)

rest = Chilkat::CkRest.new()

# Tell the REST object to use the connected socket.
rest.UseConnection(socket,true)

# The remainder of this example is identical to the example at:
# Dropbox File Stream Upload.

# Add request headers.
rest.AddHeader("Content-Type","application/octet-stream")
rest.AddHeader("Authorization","Bearer DROPBOX_ACCESS_TOKEN")

# The upload "parameters" contained in JSON passed in an HTTP request header.
# This is the JSON to be added in this example:
# { 
#    "path": "/Homework/lit/hamlet.xml",
#    "mode": "add",
#    "autorename": true,
#    "mute": false
# }

json = Chilkat::CkJsonObject.new()
json.AppendString("path","/Homework/lit/hamlet.xml")
json.AppendString("mode","add")
json.AppendBool("autorename",true)
json.AppendBool("mute",false)
rest.AddHeader("Dropbox-API-Arg",json.emit())

# Almost ready to go...
# Let's setup a file stream to point to a file.
fileStream = Chilkat::CkStream.new()
fileStream.put_SourceFile("qa_data/xml/hamlet.xml")

# Do the upload.  The URL is https://content.dropboxapi.com/2/files/upload.
# We already connected to content.dropboxapi.com using TLS (i.e. HTTPS),
# so now we only need to specify the path "/2/files/upload".

# Note: The file is streamed directly from disk.  (The entire
# file will not be loaded into memory.)
responseStr = rest.fullRequestStream("POST","/2/files/upload",fileStream)
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

# The response is JSON.
jsonResp = Chilkat::CkJsonObject.new()
jsonResp.put_EmitCompact(false)
jsonResp.Load(responseStr)

# Show the JSON response.
print jsonResp.emit() + "\n";

# Returns JSON that 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
# }

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

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

clientModified = jsonResp.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";