Update generated docs.
diff --git a/docs/oauth2client.client.html b/docs/oauth2client.client.html
index f0ddee6..e0f8012 100644
--- a/docs/oauth2client.client.html
+++ b/docs/oauth2client.client.html
@@ -8,7 +8,7 @@
<td valign=bottom> <br>
<font color="#ffffff" face="helvetica, arial"> <br><big><big><strong><a href="oauth2client.html"><font color="#ffffff">oauth2client</font></a>.client</strong></big></big></font></td
><td align=right valign=bottom
-><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/home/jcgregorio/projects/apiclient-release/oauth2client/client.py">/home/jcgregorio/projects/apiclient-release/oauth2client/client.py</a></font></td></tr></table>
+><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/usr/local/google/home/jcgregorio/projects/apiclient-release/oauth2client/client.py">/usr/local/google/home/jcgregorio/projects/apiclient-release/oauth2client/client.py</a></font></td></tr></table>
<p><tt>An OAuth 2.0 client.<br>
<br>
Tools for interacting with OAuth 2.0 protected resources.</tt></p>
@@ -26,7 +26,7 @@
<a href="httplib2.html">httplib2</a><br>
<a href="logging.html">logging</a><br>
</td><td width="25%" valign=top><a href="os.html">os</a><br>
-<a href="simplejson.html">simplejson</a><br>
+<a href="json.html">json</a><br>
<a href="sys.html">sys</a><br>
</td><td width="25%" valign=top><a href="time.html">time</a><br>
<a href="urllib.html">urllib</a><br>
@@ -65,7 +65,8 @@
<dt><font face="helvetica, arial"><a href="oauth2client.client.html#OAuth2WebServerFlow">OAuth2WebServerFlow</a>
</font></dt></dl>
</dd>
-<dt><font face="helvetica, arial"><a href="oauth2client.client.html#Storage">Storage</a>
+<dt><font face="helvetica, arial"><a href="oauth2client.client.html#MemoryCache">MemoryCache</a>
+</font></dt><dt><font face="helvetica, arial"><a href="oauth2client.client.html#Storage">Storage</a>
</font></dt></dl>
</dd>
<dt><font face="helvetica, arial"><a href="exceptions.html#Exception">exceptions.Exception</a>(<a href="exceptions.html#BaseException">exceptions.BaseException</a>)
@@ -145,8 +146,19 @@
<dl><dt><a name="AccessTokenCredentials-__setstate__"><strong>__setstate__</strong></a>(self, state)</dt><dd><tt>Reconstitute the state of the <a href="__builtin__.html#object">object</a> from being pickled.</tt></dd></dl>
+<dl><dt><a name="AccessTokenCredentials-apply"><strong>apply</strong></a>(self, headers)</dt><dd><tt>Add the authorization to the headers.<br>
+ <br>
+Args:<br>
+ headers: dict, the headers to add the Authorization header to.</tt></dd></dl>
+
<dl><dt><a name="AccessTokenCredentials-authorize"><strong>authorize</strong></a>(self, http)</dt><dd><tt>Authorize an httplib2.Http instance with these credentials.<br>
<br>
+The modified http.request method will add authentication headers to each<br>
+request and will refresh access_tokens when a 401 is received on a<br>
+request. In addition the http.request method has a credentials property,<br>
+http.request.credentials, which is the <a href="#Credentials">Credentials</a> <a href="__builtin__.html#object">object</a> that authorized<br>
+it.<br>
+ <br>
Args:<br>
http: An instance of httplib2.Http<br>
or something that acts like it.<br>
@@ -165,6 +177,12 @@
that adds in the Authorization header and then calls the original<br>
version of 'request()'.</tt></dd></dl>
+<dl><dt><a name="AccessTokenCredentials-refresh"><strong>refresh</strong></a>(self, http)</dt><dd><tt>Forces a refresh of the access_token.<br>
+ <br>
+Args:<br>
+ http: httplib2.Http, an http <a href="__builtin__.html#object">object</a> to be used to make the refresh<br>
+ request.</tt></dd></dl>
+
<dl><dt><a name="AccessTokenCredentials-set_store"><strong>set_store</strong></a>(self, store)</dt><dd><tt>Set the <a href="#Storage">Storage</a> for the credential.<br>
<br>
Args:<br>
@@ -368,8 +386,19 @@
<dl><dt><a name="AssertionCredentials-__setstate__"><strong>__setstate__</strong></a>(self, state)</dt><dd><tt>Reconstitute the state of the <a href="__builtin__.html#object">object</a> from being pickled.</tt></dd></dl>
+<dl><dt><a name="AssertionCredentials-apply"><strong>apply</strong></a>(self, headers)</dt><dd><tt>Add the authorization to the headers.<br>
+ <br>
+Args:<br>
+ headers: dict, the headers to add the Authorization header to.</tt></dd></dl>
+
<dl><dt><a name="AssertionCredentials-authorize"><strong>authorize</strong></a>(self, http)</dt><dd><tt>Authorize an httplib2.Http instance with these credentials.<br>
<br>
+The modified http.request method will add authentication headers to each<br>
+request and will refresh access_tokens when a 401 is received on a<br>
+request. In addition the http.request method has a credentials property,<br>
+http.request.credentials, which is the <a href="#Credentials">Credentials</a> <a href="__builtin__.html#object">object</a> that authorized<br>
+it.<br>
+ <br>
Args:<br>
http: An instance of httplib2.Http<br>
or something that acts like it.<br>
@@ -388,6 +417,12 @@
that adds in the Authorization header and then calls the original<br>
version of 'request()'.</tt></dd></dl>
+<dl><dt><a name="AssertionCredentials-refresh"><strong>refresh</strong></a>(self, http)</dt><dd><tt>Forces a refresh of the access_token.<br>
+ <br>
+Args:<br>
+ http: httplib2.Http, an http <a href="__builtin__.html#object">object</a> to be used to make the refresh<br>
+ request.</tt></dd></dl>
+
<dl><dt><a name="AssertionCredentials-set_store"><strong>set_store</strong></a>(self, store)</dt><dd><tt>Set the <a href="#Storage">Storage</a> for the credential.<br>
<br>
Args:<br>
@@ -457,12 +492,23 @@
string as input and returns an instaniated Crentials <a href="__builtin__.html#object">object</a>.<br> </tt></td></tr>
<tr><td> </td>
<td width="100%">Methods defined here:<br>
+<dl><dt><a name="Credentials-apply"><strong>apply</strong></a>(self, headers)</dt><dd><tt>Add the authorization to the headers.<br>
+ <br>
+Args:<br>
+ headers: dict, the headers to add the Authorization header to.</tt></dd></dl>
+
<dl><dt><a name="Credentials-authorize"><strong>authorize</strong></a>(self, http)</dt><dd><tt>Take an httplib2.Http instance (or equivalent) and<br>
authorizes it for the set of credentials, usually by<br>
replacing http.request() with a method that adds in<br>
the appropriate headers and then delegates to the original<br>
Http.request() method.</tt></dd></dl>
+<dl><dt><a name="Credentials-refresh"><strong>refresh</strong></a>(self, http)</dt><dd><tt>Forces a refresh of the access_token.<br>
+ <br>
+Args:<br>
+ http: httplib2.Http, an http <a href="__builtin__.html#object">object</a> to be used to make the refresh<br>
+ request.</tt></dd></dl>
+
<dl><dt><a name="Credentials-to_json"><strong>to_json</strong></a>(self)</dt><dd><tt>Creating a JSON representation of an instance of <a href="#Credentials">Credentials</a>.<br>
<br>
Returns:<br>
@@ -634,6 +680,32 @@
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#ffc8d8">
<td colspan=3 valign=bottom> <br>
+<font color="#000000" face="helvetica, arial"><a name="MemoryCache">class <strong>MemoryCache</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr>
+
+<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
+<td colspan=2><tt>httplib2 Cache implementation which only caches locally.<br> </tt></td></tr>
+<tr><td> </td>
+<td width="100%">Methods defined here:<br>
+<dl><dt><a name="MemoryCache-__init__"><strong>__init__</strong></a>(self)</dt></dl>
+
+<dl><dt><a name="MemoryCache-delete"><strong>delete</strong></a>(self, key)</dt></dl>
+
+<dl><dt><a name="MemoryCache-get"><strong>get</strong></a>(self, key)</dt></dl>
+
+<dl><dt><a name="MemoryCache-set"><strong>set</strong></a>(self, key, value)</dt></dl>
+
+<hr>
+Data descriptors defined here:<br>
+<dl><dt><strong>__dict__</strong></dt>
+<dd><tt>dictionary for instance variables (if defined)</tt></dd>
+</dl>
+<dl><dt><strong>__weakref__</strong></dt>
+<dd><tt>list of weak references to the object (if defined)</tt></dd>
+</dl>
+</td></tr></table> <p>
+<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
+<tr bgcolor="#ffc8d8">
+<td colspan=3 valign=bottom> <br>
<font color="#000000" face="helvetica, arial"><a name="OAuth2Credentials">class <strong>OAuth2Credentials</strong></a>(<a href="oauth2client.client.html#Credentials">Credentials</a>)</font></td></tr>
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
@@ -676,8 +748,19 @@
<dl><dt><a name="OAuth2Credentials-__setstate__"><strong>__setstate__</strong></a>(self, state)</dt><dd><tt>Reconstitute the state of the <a href="__builtin__.html#object">object</a> from being pickled.</tt></dd></dl>
+<dl><dt><a name="OAuth2Credentials-apply"><strong>apply</strong></a>(self, headers)</dt><dd><tt>Add the authorization to the headers.<br>
+ <br>
+Args:<br>
+ headers: dict, the headers to add the Authorization header to.</tt></dd></dl>
+
<dl><dt><a name="OAuth2Credentials-authorize"><strong>authorize</strong></a>(self, http)</dt><dd><tt>Authorize an httplib2.Http instance with these credentials.<br>
<br>
+The modified http.request method will add authentication headers to each<br>
+request and will refresh access_tokens when a 401 is received on a<br>
+request. In addition the http.request method has a credentials property,<br>
+http.request.credentials, which is the <a href="#Credentials">Credentials</a> <a href="__builtin__.html#object">object</a> that authorized<br>
+it.<br>
+ <br>
Args:<br>
http: An instance of httplib2.Http<br>
or something that acts like it.<br>
@@ -696,6 +779,12 @@
that adds in the Authorization header and then calls the original<br>
version of 'request()'.</tt></dd></dl>
+<dl><dt><a name="OAuth2Credentials-refresh"><strong>refresh</strong></a>(self, http)</dt><dd><tt>Forces a refresh of the access_token.<br>
+ <br>
+Args:<br>
+ http: httplib2.Http, an http <a href="__builtin__.html#object">object</a> to be used to make the refresh<br>
+ request.</tt></dd></dl>
+
<dl><dt><a name="OAuth2Credentials-set_store"><strong>set_store</strong></a>(self, store)</dt><dd><tt>Set the <a href="#Storage">Storage</a> for the credential.<br>
<br>
Args:<br>
@@ -782,14 +871,14 @@
**kwargs: dict, The keyword arguments are all optional and required<br>
parameters for the OAuth calls.</tt></dd></dl>
-<dl><dt><a name="OAuth2WebServerFlow-step1_get_authorize_url"><strong>step1_get_authorize_url</strong></a>(self, redirect_uri<font color="#909090">='oob'</font>)</dt><dd><tt>Returns a URI to redirect to the provider.<br>
+<dl><dt><a name="OAuth2WebServerFlow-step1_get_authorize_url"><strong>step1_get_authorize_url</strong></a>(self, redirect_uri<font color="#909090">='urn:ietf:wg:oauth:2.0:oob'</font>)</dt><dd><tt>Returns a URI to redirect to the provider.<br>
<br>
Args:<br>
- redirect_uri: string, Either the string 'oob' for a non-web-based<br>
- application, or a URI that handles the callback from<br>
- the authorization server.<br>
+ redirect_uri: string, Either the string 'urn:ietf:wg:oauth:2.0:oob' for<br>
+ a non-web-based application, or a URI that handles the callback from<br>
+ the authorization server.<br>
<br>
-If redirect_uri is 'oob' then pass in the<br>
+If redirect_uri is 'urn:ietf:wg:oauth:2.0:oob' then pass in the<br>
generated verification code to step2_exchange,<br>
otherwise pass in the query parameters received<br>
at the callback uri to step2_exchange.</tt></dd></dl>
@@ -860,8 +949,19 @@
<dl><dt><a name="SignedJwtAssertionCredentials-__setstate__"><strong>__setstate__</strong></a>(self, state)</dt><dd><tt>Reconstitute the state of the <a href="__builtin__.html#object">object</a> from being pickled.</tt></dd></dl>
+<dl><dt><a name="SignedJwtAssertionCredentials-apply"><strong>apply</strong></a>(self, headers)</dt><dd><tt>Add the authorization to the headers.<br>
+ <br>
+Args:<br>
+ headers: dict, the headers to add the Authorization header to.</tt></dd></dl>
+
<dl><dt><a name="SignedJwtAssertionCredentials-authorize"><strong>authorize</strong></a>(self, http)</dt><dd><tt>Authorize an httplib2.Http instance with these credentials.<br>
<br>
+The modified http.request method will add authentication headers to each<br>
+request and will refresh access_tokens when a 401 is received on a<br>
+request. In addition the http.request method has a credentials property,<br>
+http.request.credentials, which is the <a href="#Credentials">Credentials</a> <a href="__builtin__.html#object">object</a> that authorized<br>
+it.<br>
+ <br>
Args:<br>
http: An instance of httplib2.Http<br>
or something that acts like it.<br>
@@ -880,6 +980,12 @@
that adds in the Authorization header and then calls the original<br>
version of 'request()'.</tt></dd></dl>
+<dl><dt><a name="SignedJwtAssertionCredentials-refresh"><strong>refresh</strong></a>(self, http)</dt><dd><tt>Forces a refresh of the access_token.<br>
+ <br>
+Args:<br>
+ http: httplib2.Http, an http <a href="__builtin__.html#object">object</a> to be used to make the refresh<br>
+ request.</tt></dd></dl>
+
<dl><dt><a name="SignedJwtAssertionCredentials-set_store"><strong>set_store</strong></a>(self, store)</dt><dd><tt>Set the <a href="#Storage">Storage</a> for the credential.<br>
<br>
Args:<br>
@@ -940,6 +1046,14 @@
<br>
This lock is not reentrant.</tt></dd></dl>
+<dl><dt><a name="Storage-delete"><strong>delete</strong></a>(self)</dt><dd><tt>Delete credential.<br>
+ <br>
+Frees any resources associated with storing the credential.<br>
+The <a href="#Storage">Storage</a> lock must *not* be held when this is called.<br>
+ <br>
+Returns:<br>
+ None</tt></dd></dl>
+
<dl><dt><a name="Storage-get"><strong>get</strong></a>(self)</dt><dd><tt>Retrieve credential.<br>
<br>
The <a href="#Storage">Storage</a> lock must *not* be held when this is called.<br>
@@ -947,6 +1061,10 @@
Returns:<br>
oauth2client.client.<a href="#Credentials">Credentials</a></tt></dd></dl>
+<dl><dt><a name="Storage-locked_delete"><strong>locked_delete</strong></a>(self)</dt><dd><tt>Delete a credential.<br>
+ <br>
+The <a href="#Storage">Storage</a> lock must be held when this is called.</tt></dd></dl>
+
<dl><dt><a name="Storage-locked_get"><strong>locked_get</strong></a>(self)</dt><dd><tt>Retrieve credential.<br>
<br>
The <a href="#Storage">Storage</a> lock must be held when this is called.<br>
@@ -1152,10 +1270,10 @@
<font color="#ffffff" face="helvetica, arial"><big><strong>Data</strong></big></font></td></tr>
<tr><td bgcolor="#55aa55"><tt> </tt></td><td> </td>
-<td width="100%"><strong>CACHED_HTTP</strong> = <httplib2.Http object><br>
-<strong>EXPIRY_FORMAT</strong> = '%Y-%m-%dT%H:%M:%SZ'<br>
+<td width="100%"><strong>EXPIRY_FORMAT</strong> = '%Y-%m-%dT%H:%M:%SZ'<br>
<strong>HAS_OPENSSL</strong> = True<br>
<strong>ID_TOKEN_VERIFICATON_CERTS</strong> = 'https://www.googleapis.com/oauth2/v1/certs'<br>
+<strong>OOB_CALLBACK_URN</strong> = 'urn:ietf:wg:oauth:2.0:oob'<br>
<strong>__author__</strong> = 'jcgregorio@google.com (Joe Gregorio)'<br>
<strong>logger</strong> = <logging.Logger instance></td></tr></table><p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">