Changed the token_store to use an object for the token which is responsible for attaching auth headers to requests as they are made.

api.jscudder · api.jscudder · commit 8fe1d0ed6533 · 2008-08-28T01:04:37.000Z
diff --git a/src/atom/http_interface.py b/src/atom/http_interface.py
@@ -28,6 +28,9 @@
 import StringIO
 
 
+USER_AGENT = '%s GData-Python/1.2.0'
+
+
 class Error(Exception):
   pass
 
@@ -84,3 +87,54 @@ def read(self, amt=None):
       return self._body.read()
     else:
       return self._body.read(amt)
+
+
+class GenericHttpClient(object):
+  def __init__(self, http_client, headers=None):
+    """
+    
+    Args:
+      http_client: An object which provides a request method to make an HTTP 
+          request. The request method in GenericHttpClient performs a 
+          call-through to the contained HTTP client object.
+      headers: A dictionary containing HTTP headers which should be included
+          in every HTTP request. Common persistent headers include 
+          'User-Agent'.
+    """
+    self.http_client = http_client
+    self.headers = headers or {}
+
+  def request(self, operation, url, data=None, headers=None):
+    all_headers = self.headers.copy()
+    if headers:
+      all_headers.update(headers)
+    return self.http_client.request(operation, url, data=data, 
+        headers=all_headers)
+
+  def get(self, url, headers=None):
+    return self.request('GET', url, headers=headers)
+
+  def post(self, url, data, headers=None):
+    return self.request('POST', url, data=data, headers=headers)
+
+  def put(self, url, data, headers=None):
+    return self.request('PUT', url, data=data, headers=headers)
+
+  def delete(self, url, headers=None):
+    return self.request('DELETE', url, headers=headers)
+
+
+class GenericToken(object):
+  """Represents an Authorization token to be added to HTTP requests.
+  
+  Some Authorization headers included calculated fields (digital
+  signatures for example) which are based on the parameters of the HTTP
+  request. Therefore the token is responsible for signing the request
+  and adding the Authorization header. 
+  """
+  def perform_request(self, http_client, operation, url, data=None, 
+                      headers=None):
+    """For the GenericToken, no Authorization token is set."""
+    return http_client.request(operation, url, data=data, headers=headers)
+
+
diff --git a/src/atom/token_store.py b/src/atom/token_store.py
@@ -28,6 +28,9 @@
 __author__ = 'api.jscudder (Jeff Scudder)'
 
 
+import http_interface
+
+
 SCOPE_ALL = 'http://'
 
 
@@ -40,8 +43,8 @@ def add_token(self, token, scopes):
     """Adds a new token to the store (replaces tokens with the same scope).
 
     Args:
-      token: str The token value to be sent as the value for the 
-          Authorization header in an HTTP request.
+      token: A subclass of http_interface.GenericToken. The token object is 
+          responsible for adding the Authorization header to the HTTP request.
       scopes: list of atom.url.Url objects, or strings which specify the
           URLs for which this token can be used. These do not need to be
           full URLs, any URL that begins with the scope will be considered
@@ -67,8 +70,11 @@ def find_token(self, url):
           of the URL. The first match found is returned.
 
     Returns:
-      The token string to be used in the Authorization headers, or None, if 
-      the url did not begin with any of the token scopes available. 
+      The token object which should execute the HTTP request. If there was
+      no token for the url (the url did not begin with any of the token
+      scopes available), then the http_interface.GenericToken will be 
+      returned because the GenericToken calls through to the http client
+      without adding an Authorization header.
     """
     url = str(url)
     if url in self._tokens:
@@ -77,7 +83,7 @@ def find_token(self, url):
       for scope, token in self._tokens.iteritems():
         if url.startswith(scope):
           return token
-    return None
+    return http_interface.GenericToken()
 
   def remove_token(self, url):
     """Removes the first token which is considered valid for the URL.
