Calls to gdata.service.Delete will now pass along URL parameters. Resolves issue 244.

j.s@google.com · j.s@google.com · commit 4436ea7ca30f · 2009-06-05T21:25:41.000Z
diff --git a/src/atom/mock_http_core.py b/src/atom/mock_http_core.py
@@ -246,7 +246,12 @@ class SettableHttpClient(object):
   """An HTTP Client which responds with the data given in set_response."""
 
   def __init__(self, status, reason, body, headers):
+    """Configures the response for the server.
+    
+    See set_response for details on the arguments to the constructor.
+    """
     self.set_response(status, reason, body, headers)
+    self.last_request = None
 
   def set_response(self, status, reason, body, headers):
     """Determines the response which will be sent for each request.
@@ -263,6 +268,7 @@ def set_response(self, status, reason, body, headers):
     self.response._headers = headers.copy()
 
   def request(self, http_request):
+    self.last_request = http_request
     return self.response
 
 
diff --git a/src/gdata/service.py b/src/gdata/service.py
@@ -282,6 +282,10 @@ def __init__(self, email=None, password=None, account_type='HOSTED_OR_GOOGLE',
     if http_request_handler.__name__ == 'gdata.urlfetch':
       import gdata.alt.appengine
       self.http_client = gdata.alt.appengine.AppEngineHttpClient()
+
+  def _SetSessionId(self, session_id):
+    """Used in unit tests to simulate a 302 which sets a gsessionid."""
+    self.__gsessionid = session_id
  
   # Define properties for GDataService
   def _SetAuthSubToken(self, auth_token, scopes=None):
@@ -1213,10 +1217,9 @@ def PostOrPut(self, verb, data, uri, extra_headers=None, url_params=None,
 
     if self.__gsessionid is not None:
       if uri.find('gsessionid=') < 0:
-        if uri.find('?') > -1:
-          uri += '&gsessionid=%s' % (self.__gsessionid,)
-        else:
-          uri += '?gsessionid=%s' % (self.__gsessionid,)
+        if url_params is None:
+          url_params = {}
+        url_params['gsessionid'] = self.__gsessionid
 
     if data and media_source:
       if ElementTree.iselement(data):
@@ -1239,7 +1242,7 @@ def PostOrPut(self, verb, data, uri, extra_headers=None, url_params=None,
       extra_headers['Content-Type'] = 'multipart/related; boundary=END_OF_PART'
       server_response = self.request(verb, uri, 
           data=[multipart[0], data_str, multipart[1], media_source.file_handle,
-              multipart[2]], headers=extra_headers)
+              multipart[2]], headers=extra_headers, url_params=url_params)
       result_body = server_response.read()
       
     elif media_source or isinstance(data, gdata.MediaSource):
@@ -1248,15 +1251,16 @@ def PostOrPut(self, verb, data, uri, extra_headers=None, url_params=None,
       extra_headers['Content-Length'] = str(media_source.content_length)
       extra_headers['Content-Type'] = media_source.content_type
       server_response = self.request(verb, uri, 
-          data=media_source.file_handle, headers=extra_headers)
+          data=media_source.file_handle, headers=extra_headers,
+          url_params=url_params)
       result_body = server_response.read()
 
     else:
       http_data = data
       content_type = 'application/atom+xml'
       extra_headers['Content-Type'] = content_type
       server_response = self.request(verb, uri, data=http_data,
-          headers=extra_headers)
+          headers=extra_headers, url_params=url_params)
       result_body = server_response.read()
 
     # Server returns 201 for most post requests, but when performing a batch
@@ -1358,13 +1362,12 @@ def Delete(self, uri, extra_headers=None, url_params=None,
 
     if self.__gsessionid is not None:
       if uri.find('gsessionid=') < 0:
-        if uri.find('?') > -1:
-          uri += '&gsessionid=%s' % (self.__gsessionid,)
-        else:
-          uri += '?gsessionid=%s' % (self.__gsessionid,)
+        if url_params is None:
+          url_params = {}
+        url_params['gsessionid'] = self.__gsessionid
  
     server_response = self.request('DELETE', uri, 
-        headers=extra_headers)
+        headers=extra_headers, url_params=url_params)
     result_body = server_response.read()
 
     if server_response.status == 200:
diff --git a/tests/gdata_tests/service_test.py b/tests/gdata_tests/service_test.py
@@ -32,6 +32,7 @@
 import os.path
 from gdata import test_data
 import atom.mock_http
+import atom.mock_http_core
 
 
 username = ''
@@ -387,6 +388,34 @@ def testCaptchaUrlGeneration(self):
       self.assertEquals(self.gd_client.captcha_url, 
           ('https://www.google.com/accounts/Captcha?ctoken=HiteT4b0Bk5Xg18_'
            'AcVoP6-yFkHPibe7O9EqxeiI7lUSN'))
+
+
+class DeleteWithUrlParamsTest(unittest.TestCase):
+
+  def setUp(self):
+    self.gd_client = gdata.service.GDataService()
+    # Set the client to echo the request back in the response.
+    self.gd_client.http_client.v2_http_client = (
+        atom.mock_http_core.SettableHttpClient(200, 'OK', '', {}))
+    
+  def testDeleteWithUrlParams(self):
+    self.assertTrue(self.gd_client.Delete('http://example.com/test', 
+        {'TestHeader': '123'}, {'urlParam1': 'a', 'urlParam2': 'test'}))
+    request = self.gd_client.http_client.v2_http_client.last_request
+    self.assertEqual(request.uri.host, 'example.com')
+    self.assertEqual(request.uri.path, '/test')
+    self.assertEqual(request.uri.query, 
+        {'urlParam1': 'a', 'urlParam2': 'test'})
+
+  def testDeleteWithSessionId(self):
+    self.gd_client._SetSessionId('test_session_id')
+    self.assertTrue(self.gd_client.Delete('http://example.com/test', 
+        {'TestHeader': '123'}, {'urlParam1': 'a', 'urlParam2': 'test'}))
+    request = self.gd_client.http_client.v2_http_client.last_request
+    self.assertEqual(request.uri.host, 'example.com')
+    self.assertEqual(request.uri.path, '/test')
+    self.assertEqual(request.uri.query, {'urlParam1': 'a', 
+        'urlParam2': 'test', 'gsessionid': 'test_session_id'})
       
 
 class QueryTest(unittest.TestCase):
