Ruby
Ruby
Update a Google Contact
See more Google APIs Examples
Demonstrates how to update a Google Contact.Chilkat Ruby Downloads
require 'chilkat'
success = false
# 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 = Chilkat::CkJsonObject.new()
success = jsonToken.LoadFile("qa_data/tokens/googleContacts.json")
if (success != true)
print "Failed to load googleContacts.json" + "\n";
exit
end
gAuth = Chilkat::CkAuthGoogle.new()
gAuth.put_AccessToken(jsonToken.stringOf("access_token"))
rest = Chilkat::CkRest.new()
# Connect using TLS.
bAutoReconnect = true
success = rest.Connect("www.google.com",443,true,bAutoReconnect)
# Provide the authentication credentials (i.e. the access token)
rest.SetAuthGoogle(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
rest.AddHeader("GData-Version","3.0")
sbPath = Chilkat::CkStringBuilder.new()
sbPath.Append("/m8/feeds/contacts/default/full/{contactId}")
# Get the contact having contactId = "5b6d64980b1ed462"
numReplacements = sbPath.Replace("{contactId}","5b6d64980b1ed462")
sbResponseBody = Chilkat::CkStringBuilder.new()
success = rest.FullRequestNoBodySb("GET",sbPath.getAsString(),sbResponseBody)
if (success != true)
print rest.lastErrorText() + "\n";
exit
end
# A successful response will have a status code equal to 200.
if (rest.get_ResponseStatusCode() != 200)
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: " + sbResponseBody.getAsString() + "\n";
exit
end
# If the 200 response was received, then the contacts XML is contained
# in the response body.
xml = Chilkat::CkXml.new()
xml.LoadSb(sbResponseBody,false)
# Get the etag:
lastKnownEtag = xml.getAttrValue("gd:etag")
print "lastKnownEtag = " + lastKnownEtag + "\n";
# 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"/>
xml.UpdateChildContent("gd:name|gd:givenName","Joe")
xml.UpdateChildContent("gd:name|gd:familyName","Sample")
xml.UpdateChildContent("gd:name|gd:fullName","Joe Sample")
xml.UpdateChildContent("content","RIP Joe Sample, a great musician...")
xml.UpdateAttrAt("content",true,"type","text")
xml.UpdateAttrAt("gd:extendedProperty",true,"name","pet")
xml.UpdateAttrAt("gd:extendedProperty",true,"value","hamster")
# Send the following:
# PUT /m8/feeds/contacts/default/full/{contactId}
# If-Match: {lastKnownEtag}
# GData-Version: 3.0
# Content-Type: application/atom+xml
rest.ClearAllHeaders()
rest.AddHeader("If-Match",lastKnownEtag)
rest.AddHeader("GData-Version","3.0")
rest.AddHeader("Content-Type","application/atom+xml")
sbRequestBody = Chilkat::CkStringBuilder.new()
xml.GetXmlSb(sbRequestBody)
# The sbPath already contains the correct path..
success = rest.FullRequestSb("PUT",sbPath.getAsString(),sbRequestBody,sbResponseBody)
if (success != true)
print rest.lastErrorText() + "\n";
exit
end
# A successful response will have a status code equal to 200.
if (rest.get_ResponseStatusCode() != 200)
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: " + sbResponseBody.getAsString() + "\n";
exit
end
# If the 200 response was received, then the updated contact XML is contained
# in the response body.
xml.LoadSb(sbResponseBody,false)
print "Response Body:" + "\n";
print xml.getXml() + "\n";
print "Success." + "\n";