PureBasic

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.

PureBasic

IncludeFile "CkRest.pb"
IncludeFile "CkJsonObject.pb"
IncludeFile "CkStream.pb"
IncludeFile "CkOAuth2.pb"

Procedure ChilkatExample()

    success.i = 0

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

    rest.i = CkRest::ckCreate()
    If rest.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    ;   Provide a previously obtained OAuth2 access token.
    oauth2.i = CkOAuth2::ckCreate()
    If oauth2.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkOAuth2::setCkAccessToken(oauth2, "BOX_ACCESS_TOKEN")
    CkRest::ckSetAuthOAuth2(rest,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.i = 1

    ; ----------------------------------------------------------------------
    ; IMPORTANT: Note that the domain is "upload.box.com", not "api.box.com"
    ; ----------------------------------------------------------------------
    success = CkRest::ckConnect(rest,"upload.box.com",443,1,bAutoReconnect)
    If success <> 1
        Debug CkRest::ckLastErrorText(rest)
        CkRest::ckDispose(rest)
        CkOAuth2::ckDispose(oauth2)
        ProcedureReturn
    EndIf

    ; 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.)

    CkRest::ckAddHeader(rest,"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.i = CkJsonObject::ckCreate()
    If jsonAttr.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkJsonObject::ckUpdateString(jsonAttr,"name","hedgehogs.jpg")
    CkJsonObject::ckUpdateString(jsonAttr,"parent.id","0")

    CkRest::setCkPartSelector(rest, "1")
    CkRest::ckAddHeader(rest,"Content-Disposition","form-data; name=" + Chr(34) + "attributes" + Chr(34) + "; ")
    CkRest::ckSetMultipartBodyString(rest,CkJsonObject::ckEmit(jsonAttr))

    ; The upload will stream directly from a file.
    CkRest::setCkPartSelector(rest, "2")
    CkRest::ckAddHeader(rest,"Content-Disposition","form-data; name=" + Chr(34) + "file" + Chr(34) + "; filename=" + Chr(34) + "hedgehogs.jpg" + Chr(34))
    ; "application/octet-stream" can be safely used for any type file..
    CkRest::ckAddHeader(rest,"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.i = CkStream::ckCreate()
    If fileStream.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkStream::setCkSourceFile(fileStream, "qa_data/jpg/hedgehogs.jpg")
    CkRest::ckSetMultipartBodyStream(rest,fileStream)

    ; Restore the PartSelector to "0" (for safety, in case something else sends another request on this object)
    CkRest::setCkPartSelector(rest, "0")

    ; Send the multipart/form-data request, which uploads the file by streaming directly from the filesystem.
    responseBody.s = CkRest::ckFullRequestMultipart(rest,"POST","/api/2.0/files/content")
    If CkRest::ckLastMethodSuccess(rest) <> 1
        Debug CkRest::ckLastErrorText(rest)
        CkRest::ckDispose(rest)
        CkOAuth2::ckDispose(oauth2)
        CkJsonObject::ckDispose(jsonAttr)
        CkStream::ckDispose(fileStream)
        ProcedureReturn
    EndIf

    ; A 201 is received for a successful upload
    If CkRest::ckResponseStatusCode(rest) <> 201
        Debug "Box.com upload failed."
        Debug "Request header:"
        Debug CkRest::ckLastRequestHeader(rest)
        Debug "---"
        Debug "Response status code = " + Str(CkRest::ckResponseStatusCode(rest))
        Debug "Response body:"
        Debug responseBody
        CkRest::ckDispose(rest)
        CkOAuth2::ckDispose(oauth2)
        CkJsonObject::ckDispose(jsonAttr)
        CkStream::ckDispose(fileStream)
        ProcedureReturn
    EndIf

    Debug "File uploaded."


    CkRest::ckDispose(rest)
    CkOAuth2::ckDispose(oauth2)
    CkJsonObject::ckDispose(jsonAttr)
    CkStream::ckDispose(fileStream)


    ProcedureReturn
EndProcedure