/src/googlecl/contacts/client.py

# Copyright (C) 2010 Google Inc.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#      http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.


"""Service details and instances for the Contacts service.

Some use cases:
Add contacts:
  contacts add "Bob Smith, bob@smith.com" "Jim Raynor, jimmy@noreaster.com"

List contacts:
  contacts list title,email

"""
from __future__ import with_statement

__author__ = 'tom.h.miller@gmail.com (Tom Miller)'
import atom
import logging
import gdata.contacts.client
import googlecl.client
import googlecl.base
import googlecl.contacts.base
from googlecl.contacts import SECTION_HEADER


LOG = logging.getLogger(googlecl.contacts.LOGGER_NAME + '.client')


class ContactsClientCL(gdata.contacts.client.ContactsClient,
                       googlecl.contacts.base.ContactsBaseCL,
                       googlecl.client.BaseClientCL):

  """Extends gdata.contacts.service.ContactsService for the command line.

  This class adds some features focused on using Contacts via an installed
  app with a command line interface.

  """

  def __init__(self, config):
    """Constructor."""
    gdata.contacts.client.ContactsClient.__init__(self)
    googlecl.client.BaseClientCL.__init__(self, SECTION_HEADER, config)

  def _add_email(self, email, contact_entry):
    contact_entry.email.append(gdata.data.Email(address=email, label='Home'))

  def _add_name(self, name, contact_entry):
    contact_entry.name = gdata.data.Name()
    contact_entry.name.full_name = gdata.data.FullName(text=name)

  def _get_contact_entry(self):
    return gdata.contacts.data.ContactEntry() 

  def get_contacts(self, name):
    """Get all contacts that match a name."""
    uri = self.GetFeedUri()
    return self.GetEntries(uri, name,
                           desired_class=gdata.contacts.data.ContactsFeed)

  GetContacts = get_contacts

  def add_group(self, name):
    """Add group."""
    new_group = gdata.contacts.data.GroupEntry()
    new_group.title = atom.data.Title(text=name)
    return self.CreateGroup(new_group)

  AddGroup = add_group

  def get_groups(self, name):
    """Get all groups that match a name."""
    uri = self.GetFeedUri(kind='groups')
    return self.GetEntries(uri, name,
                           desired_class=gdata.contacts.data.GroupsFeed)

  GetGroups = get_groups

  def is_token_valid(self, test_uri=None):
    """Check that the token being used is valid."""
    if not test_uri:
      test_uri = self.GetFeedUri()
    return googlecl.client.BaseClientCL.is_token_valid(self, test_uri)

  IsTokenValid = is_token_valid


SERVICE_CLASS = ContactsClientCL