(PureBasic) Update a Google Contact

Demonstrates how to update a Google Contact.

Chilkat PureBasic Module Download Chilkat PureBasic Module

IncludeFile "CkStringBuilder.pb"
IncludeFile "CkAuthGoogle.pb"
IncludeFile "CkRest.pb"
IncludeFile "CkJsonObject.pb"
IncludeFile "CkXml.pb"

Procedure ChilkatExample()

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

    ; --------------------------------------------------------------------------------------------------------
    ; Note: The code for setting up the Chilkat REST object and making the initial connection can be done once.
    ; Once connected, the REST object may be re-used for many REST API calls.
    ; (It's a good idea to put the connection setup code in a separate function/subroutine.)
    ; --------------------------------------------------------------------------------------------------------

    ; It is assumed we previously obtained an OAuth2 access token.
    ; This example loads the JSON access token file 
    ; saved by this example: Get Google Contacts OAuth2 Access Token

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

    success.i = CkJsonObject::ckLoadFile(jsonToken,"qa_data/tokens/googleContacts.json")
    If success <> 1
        Debug "Failed to load googleContacts.json"
        CkJsonObject::ckDispose(jsonToken)
        ProcedureReturn
    EndIf

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

    CkAuthGoogle::setCkAccessToken(gAuth, CkJsonObject::ckStringOf(jsonToken,"access_token"))

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

    ; Connect using TLS.
    bAutoReconnect.i = 1
    success = CkRest::ckConnect(rest,"www.google.com",443,1,bAutoReconnect)

    ; Provide the authentication credentials (i.e. the access token)
    CkRest::ckSetAuthGoogle(rest,gAuth)

    ; ----------------------------------------------
    ; OK, the REST connection setup is completed..
    ; ----------------------------------------------

    ; To update a contact, we'll first get the contact information,
    ; then we'll make changes to the XML and then PUT the update.

    ; To retrieve the contact, send the following:
    ; 	GET /m8/feeds/contacts/default/full/{contactId}
    ; 	GData-Version: 3.0

    CkRest::ckAddHeader(rest,"GData-Version","3.0")

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

    CkStringBuilder::ckAppend(sbPath,"/m8/feeds/contacts/default/full/{contactId}")
    ; Get the contact having contactId = "5b6d64980b1ed462"
    numReplacements.i = CkStringBuilder::ckReplace(sbPath,"{contactId}","5b6d64980b1ed462")

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

    success = CkRest::ckFullRequestNoBodySb(rest,"GET",CkStringBuilder::ckGetAsString(sbPath),sbResponseBody)
    If success <> 1
        Debug CkRest::ckLastErrorText(rest)
        CkJsonObject::ckDispose(jsonToken)
        CkAuthGoogle::ckDispose(gAuth)
        CkRest::ckDispose(rest)
        CkStringBuilder::ckDispose(sbPath)
        CkStringBuilder::ckDispose(sbResponseBody)
        ProcedureReturn
    EndIf

    ; A successful response will have a status code equal to 200.
    If CkRest::ckResponseStatusCode(rest) <> 200
        Debug "response status code = " + Str(CkRest::ckResponseStatusCode(rest))
        Debug "response status text = " + CkRest::ckResponseStatusText(rest)
        Debug "response header: " + CkRest::ckResponseHeader(rest)
        Debug "response body: " + CkStringBuilder::ckGetAsString(sbResponseBody)
        CkJsonObject::ckDispose(jsonToken)
        CkAuthGoogle::ckDispose(gAuth)
        CkRest::ckDispose(rest)
        CkStringBuilder::ckDispose(sbPath)
        CkStringBuilder::ckDispose(sbResponseBody)
        ProcedureReturn
    EndIf

    ; If the 200 response was received, then the contacts XML is contained
    ; in the response body.
    xml.i = CkXml::ckCreate()
    If xml.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkXml::ckLoadSb(xml,sbResponseBody,0)

    ; Get the etag:
    lastKnownEtag.s = CkXml::ckGetAttrValue(xml,"gd:etag")
    Debug "lastKnownEtag = " + lastKnownEtag

    ; Update the XML.
    ; We're going to add or update with the following information:

    ; 	  <gd:name>
    ; 	    <gd:givenName>Joe</gd:givenName>
    ; 	    <gd:familyName>Sample</gd:familyName>
    ; 	    <gd:fullName>Joe Sample</gd:fullName>
    ; 	  </gd:name>
    ; 	  <content type="text">RIP Joe Sample, a great musician...</content>
    ; 	  <gd:extendedProperty name="pet" value="hamster"/>

    CkXml::ckUpdateChildContent(xml,"gd:name|gd:givenName","Joe")
    CkXml::ckUpdateChildContent(xml,"gd:name|gd:familyName","Sample")
    CkXml::ckUpdateChildContent(xml,"gd:name|gd:fullName","Joe Sample")
    CkXml::ckUpdateChildContent(xml,"content","RIP Joe Sample, a great musician...")
    CkXml::ckUpdateAttrAt(xml,"content",1,"type","text")
    CkXml::ckUpdateAttrAt(xml,"gd:extendedProperty",1,"name","pet")
    CkXml::ckUpdateAttrAt(xml,"gd:extendedProperty",1,"value","hamster")

    ; Send the following:

    ; 	PUT /m8/feeds/contacts/default/full/{contactId}
    ; 	If-Match: {lastKnownEtag}
    ; 	GData-Version: 3.0
    ; 	Content-Type: application/atom+xml

    CkRest::ckClearAllHeaders(rest)
    CkRest::ckAddHeader(rest,"If-Match",lastKnownEtag)
    CkRest::ckAddHeader(rest,"GData-Version","3.0")
    CkRest::ckAddHeader(rest,"Content-Type","application/atom+xml")

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

    CkXml::ckGetXmlSb(xml,sbRequestBody)

    ; The sbPath already contains the correct path..
    success = CkRest::ckFullRequestSb(rest,"PUT",CkStringBuilder::ckGetAsString(sbPath),sbRequestBody,sbResponseBody)
    If success <> 1
        Debug CkRest::ckLastErrorText(rest)
        CkJsonObject::ckDispose(jsonToken)
        CkAuthGoogle::ckDispose(gAuth)
        CkRest::ckDispose(rest)
        CkStringBuilder::ckDispose(sbPath)
        CkStringBuilder::ckDispose(sbResponseBody)
        CkXml::ckDispose(xml)
        CkStringBuilder::ckDispose(sbRequestBody)
        ProcedureReturn
    EndIf

    ; A successful response will have a status code equal to 200.
    If CkRest::ckResponseStatusCode(rest) <> 200
        Debug "response status code = " + Str(CkRest::ckResponseStatusCode(rest))
        Debug "response status text = " + CkRest::ckResponseStatusText(rest)
        Debug "response header: " + CkRest::ckResponseHeader(rest)
        Debug "response body: " + CkStringBuilder::ckGetAsString(sbResponseBody)
        CkJsonObject::ckDispose(jsonToken)
        CkAuthGoogle::ckDispose(gAuth)
        CkRest::ckDispose(rest)
        CkStringBuilder::ckDispose(sbPath)
        CkStringBuilder::ckDispose(sbResponseBody)
        CkXml::ckDispose(xml)
        CkStringBuilder::ckDispose(sbRequestBody)
        ProcedureReturn
    EndIf

    ; If the 200 response was received, then the updated contact XML is contained
    ; in the response body.
    CkXml::ckLoadSb(xml,sbResponseBody,0)

    Debug "Response Body:"
    Debug CkXml::ckGetXml(xml)
    Debug "Success."


    CkJsonObject::ckDispose(jsonToken)
    CkAuthGoogle::ckDispose(gAuth)
    CkRest::ckDispose(rest)
    CkStringBuilder::ckDispose(sbPath)
    CkStringBuilder::ckDispose(sbResponseBody)
    CkXml::ckDispose(xml)
    CkStringBuilder::ckDispose(sbRequestBody)


    ProcedureReturn
EndProcedure