Ruby
Ruby
Retrieve a Single Contact
See more Google APIs Examples
Demonstrates how to retrieve a single contact (by contactId) for the Google Contacts API.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 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 = "7b1c7b6409e718a0"
numReplacements = sbPath.Replace("{contactId}","7b1c7b6409e718a0")
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)
# See below for a sample response body.
xml.SaveXml("qa_output/google_contact.xml")
# Now let's parse the XML...
print "title: " + xml.getChildContent("title") + "\n";
emailAddress = xml.chilkatPath("gd:email|(address)")
if (xml.get_LastMethodSuccess() == true)
print "email address: " + emailAddress + "\n";
end
# The response body XML looks something like this:
# <?xml version="1.0" encoding="UTF-8" ?>
# <entry gd:etag=""R3kzezVSLit7I2A9XRFaFE8DQAU."" xmlns="http://www.w3.org/2005/Atom" xmlns:batch="http://schemas.google.com/gdata/batch" xmlns:gContact="http://schemas.google.com/contact/2008" xmlns:gd="http://schemas.google.com/g/2005">
# <id>http://www.google.com/m8/feeds/contacts/support%40chilkatcloud.com/base/7b1c7b6409e718a0</id>
# <updated>2016-11-18T00:41:56.783Z</updated>
# <app:edited xmlns:app="http://www.w3.org/2007/app">2016-11-18T00:41:56.783Z</app:edited>
# <category scheme="http://schemas.google.com/g/2005#kind" term="http://schemas.google.com/contact/2008#contact" />
# <title>Chilkat Cloud</title>
# <link rel="http://schemas.google.com/contacts/2008/rel#photo" type="image/*" href="https://www.googleapis.com/m8/feeds/photos/media/support%40chilkatcloud.com/7b1c7b6409e718a0" gd:etag=""fgVhPls4Sit7I2BWHUlTWkQMKHUZKHkkaiw."" />
# <link rel="self" type="application/atom+xml" href="https://www.googleapis.com/m8/feeds/contacts/support%40chilkatcloud.com/full/7b1c7b6409e718a0" />
# <link rel="edit" type="application/atom+xml" href="https://www.googleapis.com/m8/feeds/contacts/support%40chilkatcloud.com/full/7b1c7b6409e718a0" />
# <gd:name>
# <gd:fullName>Chilkat Cloud</gd:fullName>
# <gd:givenName>Chilkat</gd:givenName>
# <gd:familyName>Cloud</gd:familyName>
# </gd:name>
# <gd:email rel="http://schemas.google.com/g/2005#other" address="support@chilkatcloud.com" primary="true" />
# <gContact:groupMembershipInfo deleted="false" href="http://www.google.com/m8/feeds/groups/support%40chilkatcloud.com/base/6" />
# </entry>