(PureBasic) REST File Streaming Upload

Demonstrates how to stream the REST body from a file. This example demonstrates a REST upload to the Azure Cloud Storage service.

Chilkat PureBasic Module Download Chilkat PureBasic Module

IncludeFile "CkRest.pb"
IncludeFile "CkAuthAzureStorage.pb"
IncludeFile "CkStream.pb"

Procedure ChilkatExample()

    ; This example 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

    ; Connect to the Azure Storage Blob Service
    bTls.i = 1
    port.i = 443
    bAutoReconnect.i = 1
    ; In this example, the storage account name is "chilkat".
    success.i = CkRest::ckConnect(rest,"chilkat.blob.core.windows.net",port,bTls,bAutoReconnect)
    If success <> 1
        Debug CkRest::ckLastErrorText(rest)
        CkRest::ckDispose(rest)
        ProcedureReturn
    EndIf

    ; Provide Azure Cloud credentials for the REST call.
    azAuth.i = CkAuthAzureStorage::ckCreate()
    If azAuth.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkAuthAzureStorage::setCkAccessKey(azAuth, "AZURE_ACCESS_KEY")
    ; The account name used here should match the 1st part of the domain passed in the call to Connect (above).
    CkAuthAzureStorage::setCkAccount(azAuth, "chilkat")
    CkAuthAzureStorage::setCkScheme(azAuth, "SharedKey")
    CkAuthAzureStorage::setCkService(azAuth, "Blob")
    ; This causes the "x-ms-version: 2021-08-06" header to be automatically added.
    CkAuthAzureStorage::setCkXMsVersion(azAuth, "2021-08-06")
    success = CkRest::ckSetAuthAzureStorage(rest,azAuth)

    ; Set some request headers.
    success = CkRest::ckAddHeader(rest,"x-ms-blob-content-disposition","attachment; filename=" + Chr(34) + "hamlet.xml" + Chr(34))
    success = CkRest::ckAddHeader(rest,"x-ms-blob-type","BlockBlob")
    success = CkRest::ckAddHeader(rest,"x-ms-meta-m1","v1")
    success = CkRest::ckAddHeader(rest,"x-ms-meta-m2","v2")

    ; Note: The application does not need to explicitly set the following
    ; headers: x-ms-date, Authorization, and Content-Length.  These headers
    ; are automatically set by Chilkat.

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

    CkStream::setCkSourceFile(fileStream, "qa_data/xml/hamlet.xml")

    ; Upload to the Azure Cloud Storage service.
    ; The file is streamed, so the full file never has to completely reside in memory.
    ; The file is uploaded to the container named "test".
    responseStr.s = CkRest::ckFullRequestStream(rest,"PUT","/test/hamlet.xml",fileStream)
    If CkRest::ckLastMethodSuccess(rest) <> 1
        Debug CkRest::ckLastErrorText(rest)
        CkRest::ckDispose(rest)
        CkAuthAzureStorage::ckDispose(azAuth)
        CkStream::ckDispose(fileStream)
        ProcedureReturn
    EndIf

    ; When successful, the Azure Storage service will respond with a 201 response code,
    ; with an empty body.  Therefore, in the success condition, the responseStr is empty.
    If CkRest::ckResponseStatusCode(rest) = 201
        Debug "File uploaded."
    Else
        ; Examine the request/response to see what happened.
        Debug "response status code = " + Str(CkRest::ckResponseStatusCode(rest))
        Debug "response status text = " + CkRest::ckResponseStatusText(rest)
        Debug "response header: " + CkRest::ckResponseHeader(rest)
        Debug "response body (if any): " + responseStr
        Debug "---"
        Debug "LastRequestStartLine: " + CkRest::ckLastRequestStartLine(rest)
        Debug "LastRequestHeader: " + CkRest::ckLastRequestHeader(rest)
    EndIf



    CkRest::ckDispose(rest)
    CkAuthAzureStorage::ckDispose(azAuth)
    CkStream::ckDispose(fileStream)


    ProcedureReturn
EndProcedure