Adding support for Content API Users Feed. (Issue 6295071)

dhermes@google.com · dhermes@google.com · commit b8f1e1fdc81f · 2012-06-13T09:01:07.000-07:00
diff --git a/src/gdata/contentforshopping/client.py b/src/gdata/contentforshopping/client.py
@@ -1,3 +1,4 @@
+
 #!/usr/bin/python
 #
 # Copyright (C) 2010-2011 Google Inc.
@@ -15,26 +16,23 @@
 # limitations under the License.
 
 
-"""Extend the gdata client for the Content API for Shopping.
-
-TODO:
-
-1. Proper MCA Support.
-2. Add classes for datafeed functions instead of asking for raw XML.
-"""
+"""Extend the gdata client for the Content API for Shopping."""
 
 
 __author__ = 'afshar (Ali Afshar), dhermes (Daniel Hermes)'
 
 
-import atom.data
+import urllib
+
 import gdata.client
 from gdata.contentforshopping.data import ClientAccount
 from gdata.contentforshopping.data import ClientAccountFeed
 from gdata.contentforshopping.data import DatafeedEntry
 from gdata.contentforshopping.data import DatafeedFeed
 from gdata.contentforshopping.data import ProductEntry
 from gdata.contentforshopping.data import ProductFeed
+from gdata.contentforshopping.data import UsersEntry
+from gdata.contentforshopping.data import UsersFeed
 
 
 CFS_VERSION = 'v1'
@@ -75,7 +73,7 @@ def _create_uri(self, account_id, resource, path=(), use_projection=True,
     segments = [CFS_URI, self.cfs_api_version, account_id, resource]
     if use_projection:
       segments.append(CFS_PROJECTION)
-    segments.extend(path)
+    segments.extend(urllib.quote(value) for value in path)
     result = '/'.join(segments)
 
     request_params = []
@@ -482,3 +480,85 @@ def delete_client_account(self, client_account_id, account_id=None,
     return self.delete(uri, auth_token=auth_token)
 
   DeleteClientAccount = delete_client_account
+
+  def get_users_feed(self, account_id=None, auth_token=None):
+    """Get the users feed for an account.
+
+    :param account_id: The Merchant Center Account ID. If ommitted the default
+                       Account ID will be used for this client
+    :param auth_token: An object which sets the Authorization HTTP header in its
+                       modify_request method.
+    """
+
+    uri = self._create_uri(account_id, 'users', use_projection=False)
+    return self.get_feed(uri, auth_token=auth_token, desired_class=UsersFeed)
+
+  GetUsersFeed = get_users_feed
+
+  def get_users_entry(self, user_email, account_id=None, auth_token=None):
+    """Get a users feed entry for an account.
+
+    :param user_email: Email of the user entry to be retrieved.
+    :param account_id: The Merchant Center Account ID. If ommitted the default
+                       Account ID will be used for this client
+    :param auth_token: An object which sets the Authorization HTTP header in its
+                       modify_request method.
+    """
+    uri = self._create_uri(
+        account_id, 'users', path=[user_email], use_projection=False)
+    return self.get_entry(uri, auth_token=auth_token, desired_class=UsersEntry)
+
+  GetUsersEntry = get_users_entry
+
+  def insert_users_entry(self, entry, account_id=None, auth_token=None):
+    """Insert a users feed entry for an account.
+
+    :param entry: A :class:`gdata.contentforshopping.data.UsersEntry` with
+                  the required user data.
+    :param account_id: The Merchant Center Account ID. If ommitted the default
+                       Account ID will be used for this client
+    :param auth_token: An object which sets the Authorization HTTP header in its
+                       modify_request method.
+    """
+    uri = self._create_uri(account_id, 'users', use_projection=False)
+    return self.post(entry, uri=uri, auth_token=auth_token)
+
+  InsertUsersEntry = insert_users_entry
+
+  def update_users_entry(self, entry, account_id=None, auth_token=None):
+    """Update a users feed entry for an account.
+
+    :param entry: A :class:`gdata.contentforshopping.data.UsersEntry` with
+                  the required user data.
+    :param account_id: The Merchant Center Account ID. If ommitted the default
+                       Account ID will be used for this client
+    :param auth_token: An object which sets the Authorization HTTP header in its
+                       modify_request method.
+    """
+    # Could also use entry.find_edit_link() but that is inconsistent
+    # with the rest of the module
+    user_email = entry.title.text
+    uri = self._create_uri(
+        account_id, 'users', path=[user_email], use_projection=False)
+    return self.update(entry, uri=uri, auth_token=auth_token)
+
+  UpdateUsersEntry = update_users_entry
+
+  def delete_users_entry(self, entry, account_id=None, auth_token=None):
+    """Delete a users feed entry for an account.
+
+    :param entry: A :class:`gdata.contentforshopping.data.UsersEntry` with
+                  the required user data.
+    :param account_id: The Merchant Center Account ID. If ommitted the default
+                       Account ID will be used for this client
+    :param auth_token: An object which sets the Authorization HTTP header in its
+                       modify_request method.
+    """
+    # Could also use entry.find_edit_link() but that is inconsistent
+    # with the rest of the module
+    user_email = entry.title.text
+    uri = self._create_uri(
+        account_id, 'users', path=[user_email], use_projection=False)
+    return self.delete(uri, auth_token=auth_token)
+
+  DeleteUsersEntry = delete_users_entry
diff --git a/src/gdata/contentforshopping/data.py b/src/gdata/contentforshopping/data.py
@@ -27,7 +27,6 @@
 import gdata.data
 
 
-ATOM_NAMESPACE = 'http://www.w3.org/2005/Atom'
 GD_NAMESPACE = 'http://schemas.google.com/g/2005'
 GD_NAMESPACE_TEMPLATE = '{http://schemas.google.com/g/2005}%s'
 SC_NAMESPACE_TEMPLATE = ('{http://schemas.google.com/'
@@ -170,19 +169,6 @@ class ExcludedDestination(atom.core.XmlElement):
   _qname = SC_NAMESPACE_TEMPLATE % 'excluded_destination'
   dest = 'dest'
 
-
-class Status(atom.core.XmlElement):
-  """sc:status element
-
-  This element defines the status of an element in a particular destination. It
-  has a destination and an actual status such as enlisted, review, or
-  disapproved.
-  """
-  _qname = SC_NAMESPACE_TEMPLATE % 'status'
-  dest = 'dest'
-  status = 'status'
-
-
 # Warning Attributes (to be used with app:control element)
 
 class Code(atom.core.XmlElement):
@@ -271,7 +257,6 @@ class ProductControl(atom.data.Control):
   required_destination = [RequiredDestination]
   validate_destination = [ValidateDestination]
   excluded_destination = [ExcludedDestination]
-  statuses = [Status]
   warnings = Warnings
 
 # Content API for Shopping, product (scp) attributes
@@ -1108,20 +1093,7 @@ class ContentForShoppingError(atom.core.XmlElement):
   code = ErrorCode
   location = ErrorLocation
   internal_reason = InternalReason
-
-  @property
-  def id(self):
-    """Id for error element.
-
-    The namespace for the id element is different in batch requests than in
-    individual requests, so we need to consider either case.
-    """
-    for element in self.GetElements():
-      if element.tag == 'id':
-        if element.namespace in (GD_NAMESPACE, ATOM_NAMESPACE):
-          return element.text
-
-    return None
+  id = atom.data.Id
 
 
 class ContentForShoppingErrors(atom.core.XmlElement):
@@ -1268,3 +1240,26 @@ class ClientAccountFeed(gdata.data.GDFeed):
   """A multiclient account feed
   """
   entry = [ClientAccount]
+
+
+# Users Feed Classes
+class Admin(atom.core.XmlElement):
+  """sc:admin element"""
+  _qname = SC_NAMESPACE_TEMPLATE % 'admin'
+
+
+class Permission(atom.core.XmlElement):
+  """sc:permission element"""
+  _qname = SC_NAMESPACE_TEMPLATE % 'permission'
+  scope = 'scope'
+
+
+class UsersEntry(gdata.data.GDEntry):
+  """A User Management Feed entry."""
+  admin = Admin
+  permission = [Permission]
+
+
+class UsersFeed(gdata.data.GDFeed):
+  """A User Management Feed."""
+  entry = [UsersEntry]
