Added batch execution method to the calendar service so it can now perform batch operations.

api.jscudder · api.jscudder · commit 152e2a78219b · 2007-10-13T00:58:11.000Z
diff --git a/src/gdata/__init__.py b/src/gdata/__init__.py
@@ -680,6 +680,12 @@ def AddQuery(self, url_string=None, entry=None, batch_id_string=None):
     entry = self.AddBatchEntry(entry=entry, id_url_string=url_string,
                                batch_id_string=batch_id_string,
                                operation_string=BATCH_QUERY)
+
+  def GetBatchLink(self):
+    for link in self.link:
+      if link.rel == 'http://schemas.google.com/g/2005#batch':
+        return link
+    return None
  
 
 def BatchFeedFromString(xml_string):
diff --git a/src/gdata/calendar/service.py b/src/gdata/calendar/service.py
@@ -41,6 +41,10 @@
 import atom
 
 
+DEFAULT_BATCH_URL = ('http://www.google.com/calendar/feeds/default/private'
+                     '/full/batch')
+
+
 class Error(Exception):
   pass
 
@@ -424,6 +428,32 @@ def UpdateAclEntry(self, edit_uri, updated_rule, url_params=None,
     else:
       return response
 
+  def ExecuteBatch(self, batch_feed, url, 
+      converter=gdata.calendar.CalendarEventFeedFromString):
+    """Sends a batch request feed to the server.
+
+    The batch request needs to be sent to the batch URL for a particular 
+    calendar. You can find the URL by calling GetBatchLink().href on the 
+    CalendarEventFeed.
+
+    Args:
+      batch_feed: gdata.calendar.CalendarEventFeed A feed containing batch
+          request entries. Each entry contains the operation to be performed 
+          on the data contained in the entry. For example an entry with an 
+          operation type of insert will be used as if the individual entry 
+          had been inserted.
+      url: str The batch URL for the Calendar to which these operations should
+          be applied.
+      converter: Function (optional) The function used to convert the server's
+          response to an object. The default value is 
+          CalendarEventFeedFromString.
+     
+    Returns:
+      The results of the batch request's execution on the server. If the 
+      default converter is used, this is stored in a CalendarEventFeed.
+    """
+    return self.Post(batch_feed, url, converter=converter)
+
 
 class CalendarEventQuery(gdata.service.Query):
 
diff --git a/tests/gdata_tests/calendar/service_test.py b/tests/gdata_tests/calendar/service_test.py
@@ -279,6 +279,46 @@ def testPostQueryUpdateAndDeleteEvents(self):
     self.assertEquals(after_delete_query_result.entry[0].event_status.value,
         'CANCELED')
 
+  def testCreateAndDeleteEventUsingBatch(self):
+    # Get random data for creating event
+    r = random.Random()
+    r.seed()
+    random_event_number = str(r.randint(100000,1000000))
+    random_event_title = 'My Random Comments Test Event %s' % (
+        random_event_number)
+
+    # Set event data
+    event = gdata.calendar.CalendarEventEntry()
+    event.author.append(atom.Author(name=atom.Name(text='GData Test user')))
+    event.title = atom.Title(text=random_event_title)
+    event.content = atom.Content(text='Picnic with some lunch')
+
+    # Form a batch request
+    batch_request = gdata.calendar.CalendarEventFeed()
+    batch_request.AddInsert(entry=event)
+
+    # Execute the batch request to insert the event.
+    self.cal_client.ProgrammaticLogin()
+    batch_result = self.cal_client.ExecuteBatch(batch_request, 
+        gdata.calendar.service.DEFAULT_BATCH_URL)
+
+    self.assertEquals(len(batch_result.entry), 1)
+    self.assertEquals(batch_result.entry[0].title.text, random_event_title)
+    self.assertEquals(batch_result.entry[0].batch_operation.type, 
+                      gdata.BATCH_INSERT)
+    self.assertEquals(batch_result.GetBatchLink().href, 
+                      gdata.calendar.service.DEFAULT_BATCH_URL)
+
+    # Create a batch request to delete the newly created entry.
+    batch_delete_request = gdata.calendar.CalendarEventFeed()
+    batch_delete_request.AddDelete(entry=batch_result.entry[0])
+  
+    batch_delete_result = self.cal_client.ExecuteBatch(batch_delete_request, 
+        batch_result.GetBatchLink().href)
+    self.assertEquals(len(batch_delete_result.entry), 1)
+    self.assertEquals(batch_delete_result.entry[0].batch_operation.type, 
+                      gdata.BATCH_DELETE)
+
   def testCorrectReturnTypesForGetMethods(self):
     self.cal_client.ProgrammaticLogin()
 
