Merge lp:~mterry/ubuntuone-couch/extra-headers into lp:ubuntuone-couch

[Michael Terry]

Allow extra headers in auth.request()

[Eric Casteleijn (thisfred)]

Looks good, except this is a bad idea:

+ token_secret=None, headers={}):

As default values in Python should as a rule not be mutable types. Default values are evaluated at import time, making this empty dictionary a 'global' variable, so that in this case the oauth headers for one call to request() will pollute the dictionary for any subsequent calls.

Please change it to:

+ token_secret=None, headers=None):

and then at the beginning of the function implementation do:

headers = headers or {}

Also a test case would be awesome, but if you cannot think of one, I can look at that.

review: Needs Fixing

[lp:~mterry/ubuntuone-couch/extra-headers]

9. By Michael Terry on 2011-05-19

use None instead of {} in signature

[Michael Terry (mterry)]

OK, updated to use your None method.

Could you please look at a test? I looked briefly and would copy the test_request_plaintext method and just add a test header like "Foo": "Bar", but I wasn't sure how to test whether the outgoing request was what I expected.

[Eric Casteleijn (thisfred)]

Looks great now, I'll think of a test and add it in a separate branch.

review: Approve

[dobey (dobey)]

review: Approve

=== modified file 'ubuntuone/couch/auth.py'
--- ubuntuone/couch/auth.py	2011-03-11 16:38:11 +0000
+++ ubuntuone/couch/auth.py	2011-05-19 19:53:27 +0000
@@ -90,7 +90,7 @@
 
 def request(url, sigmeth='HMAC_SHA1', http_method='GET', request_body=None,
             consumer_key=None, consumer_secret=None, access_token=None,
-            token_secret=None):
+            token_secret=None, headers=None):
     """Make an OAuth signed request."""
     # Set the signature method. This should be HMAC unless you have a jolly
     # good reason for it to not be.
@@ -109,6 +109,8 @@
 
     oauth_header = get_oauth_request_header(
         consumer, token, url, http_method, signature_method)
+    headers = headers or {}
+    headers.update(oauth_header)
     http = httplib2.Http()
     return http.request(
-        url, method=http_method, headers=oauth_header, body=request_body)
+        url, method=http_method, headers=headers, body=request_body)