Prep for 1.0 release.
diff --git a/docs/epy/oauth2client.client-module.html b/docs/epy/oauth2client.client-module.html
index 94e6275..e0510fd 100644
--- a/docs/epy/oauth2client.client-module.html
+++ b/docs/epy/oauth2client.client-module.html
@@ -235,6 +235,26 @@
</td>
</tr>
+<tr>
+ <td width="15%" align="right" valign="top" class="summary">
+ <span class="summary-type"> </span>
+ </td><td class="summary">
+ <table width="100%" cellpadding="0" cellspacing="0" border="0">
+ <tr>
+ <td><span class="summary-sig"><a href="oauth2client.client-module.html#verify_id_token" class="summary-sig-name">verify_id_token</a>(<span class="summary-sig-arg">id_token</span>,
+ <span class="summary-sig-arg">audience</span>,
+ <span class="summary-sig-arg">http</span>=<span class="summary-sig-default">None</span>,
+ <span class="summary-sig-arg">cert_uri</span>=<span class="summary-sig-default">ID_TOKEN_VERIFICATON_CERTS</span>)</span><br />
+ Verifies a signed JWT id_token.</td>
+ <td align="right" valign="top">
+ <span class="codelink"><a href="oauth2client.client-pysrc.html#verify_id_token">source code</a></span>
+
+ </td>
+ </tr>
+ </table>
+
+ </td>
+ </tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
@@ -285,6 +305,74 @@
</td>
</tr>
+<tr>
+ <td width="15%" align="right" valign="top" class="summary">
+ <span class="summary-type"> </span>
+ </td><td class="summary">
+ <table width="100%" cellpadding="0" cellspacing="0" border="0">
+ <tr>
+ <td><span class="summary-sig"><a href="oauth2client.client-module.html#credentials_from_code" class="summary-sig-name">credentials_from_code</a>(<span class="summary-sig-arg">client_id</span>,
+ <span class="summary-sig-arg">client_secret</span>,
+ <span class="summary-sig-arg">scope</span>,
+ <span class="summary-sig-arg">code</span>,
+ <span class="summary-sig-arg">redirect_uri</span>=<span class="summary-sig-default">'postmessage'</span>,
+ <span class="summary-sig-arg">http</span>=<span class="summary-sig-default">None</span>,
+ <span class="summary-sig-arg">user_agent</span>=<span class="summary-sig-default">None</span>,
+ <span class="summary-sig-arg">token_uri</span>=<span class="summary-sig-default">'https://accounts.google.com/o/oauth2/token'</span>)</span><br />
+ Exchanges an authorization code for an OAuth2Credentials object.</td>
+ <td align="right" valign="top">
+ <span class="codelink"><a href="oauth2client.client-pysrc.html#credentials_from_code">source code</a></span>
+
+ </td>
+ </tr>
+ </table>
+
+ </td>
+ </tr>
+<tr>
+ <td width="15%" align="right" valign="top" class="summary">
+ <span class="summary-type"> </span>
+ </td><td class="summary">
+ <table width="100%" cellpadding="0" cellspacing="0" border="0">
+ <tr>
+ <td><span class="summary-sig"><a href="oauth2client.client-module.html#credentials_from_clientsecrets_and_code" class="summary-sig-name">credentials_from_clientsecrets_and_code</a>(<span class="summary-sig-arg">filename</span>,
+ <span class="summary-sig-arg">scope</span>,
+ <span class="summary-sig-arg">code</span>,
+ <span class="summary-sig-arg">message</span>=<span class="summary-sig-default">None</span>,
+ <span class="summary-sig-arg">redirect_uri</span>=<span class="summary-sig-default">'postmessage'</span>,
+ <span class="summary-sig-arg">http</span>=<span class="summary-sig-default">None</span>,
+ <span class="summary-sig-arg">cache</span>=<span class="summary-sig-default">None</span>)</span><br />
+ Returns OAuth2Credentials from a clientsecrets file and an auth code.</td>
+ <td align="right" valign="top">
+ <span class="codelink"><a href="oauth2client.client-pysrc.html#credentials_from_clientsecrets_and_code">source code</a></span>
+
+ </td>
+ </tr>
+ </table>
+
+ </td>
+ </tr>
+<tr>
+ <td width="15%" align="right" valign="top" class="summary">
+ <span class="summary-type"> </span>
+ </td><td class="summary">
+ <table width="100%" cellpadding="0" cellspacing="0" border="0">
+ <tr>
+ <td><span class="summary-sig"><a href="oauth2client.client-module.html#flow_from_clientsecrets" class="summary-sig-name">flow_from_clientsecrets</a>(<span class="summary-sig-arg">filename</span>,
+ <span class="summary-sig-arg">scope</span>,
+ <span class="summary-sig-arg">redirect_uri</span>=<span class="summary-sig-default">None</span>,
+ <span class="summary-sig-arg">message</span>=<span class="summary-sig-default">None</span>,
+ <span class="summary-sig-arg">cache</span>=<span class="summary-sig-default">None</span>)</span><br />
+ Create a Flow from a clientsecrets file.</td>
+ <td align="right" valign="top">
+ <span class="codelink"><a href="oauth2client.client-pysrc.html#flow_from_clientsecrets">source code</a></span>
+
+ </td>
+ </tr>
+ </table>
+
+ </td>
+ </tr>
</table>
<!-- ==================== VARIABLES ==================== -->
<a name="section-Variables"></a>
@@ -321,21 +409,21 @@
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
- <a name="EXPIRY_FORMAT"></a><span class="summary-name">EXPIRY_FORMAT</span> = <code title="'%Y-%m-%dT%H:%M:%SZ'"><code class="variable-quote">'</code><code class="variable-string">%Y-%m-%dT%H:%M:%SZ</code><code class="variable-quote">'</code></code>
+ <a name="EXPIRY_FORMAT"></a><span class="summary-name">EXPIRY_FORMAT</span> = <code title="'%Y-%m-%dT%H:%M:%SZ'">'%Y-%m-%dT%H:%M:%SZ'</code>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
- <a href="oauth2client.client-module.html#ID_TOKEN_VERIFICATON_CERTS" class="summary-name">ID_TOKEN_VERIFICATON_CERTS</a> = <code title="'https://www.googleapis.com/oauth2/v1/certs'"><code class="variable-quote">'</code><code class="variable-string">https://www.googleapis.com/oauth</code><code class="variable-ellipsis">...</code></code>
+ <a href="oauth2client.client-module.html#ID_TOKEN_VERIFICATON_CERTS" class="summary-name">ID_TOKEN_VERIFICATON_CERTS</a> = <code title="'https://www.googleapis.com/oauth2/v1/certs'">'https://www.googleapis.com/oauth<code class="variable-ellipsis">...</code></code>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
- <a name="OOB_CALLBACK_URN"></a><span class="summary-name">OOB_CALLBACK_URN</span> = <code title="'urn:ietf:wg:oauth:2.0:oob'"><code class="variable-quote">'</code><code class="variable-string">urn:ietf:wg:oauth:2.0:oob</code><code class="variable-quote">'</code></code>
+ <a name="OOB_CALLBACK_URN"></a><span class="summary-name">OOB_CALLBACK_URN</span> = <code title="'urn:ietf:wg:oauth:2.0:oob'">'urn:ietf:wg:oauth:2.0:oob'</code>
</td>
</tr>
<tr class="private">
@@ -345,13 +433,6 @@
<a name="_cached_http"></a><span class="summary-name">_cached_http</span> = <code title="httplib2.Http(MemoryCache())">httplib2.Http(MemoryCache())</code>
</td>
</tr>
-<tr>
- <td width="15%" align="right" valign="top" class="summary">
- <span class="summary-type"> </span>
- </td><td class="summary">
- <a name="__package__"></a><span class="summary-name">__package__</span> = <code title="'oauth2client'"><code class="variable-quote">'</code><code class="variable-string">oauth2client</code><code class="variable-quote">'</code></code>
- </td>
- </tr>
</table>
<!-- ==================== FUNCTION DETAILS ==================== -->
<a name="section-FunctionDetails"></a>
@@ -371,6 +452,52 @@
</td>
</tr>
</table>
+<a name="verify_id_token"></a>
+<div>
+<table class="details" border="1" cellpadding="3"
+ cellspacing="0" width="100%" bgcolor="white">
+<tr><td>
+ <table width="100%" cellpadding="0" cellspacing="0" border="0">
+ <tr valign="top"><td>
+ <h3 class="epydoc"><span class="sig"><span class="sig-name">verify_id_token</span>(<span class="sig-arg">id_token</span>,
+ <span class="sig-arg">audience</span>,
+ <span class="sig-arg">http</span>=<span class="sig-default">None</span>,
+ <span class="sig-arg">cert_uri</span>=<span class="sig-default">ID_TOKEN_VERIFICATON_CERTS</span>)</span>
+ </h3>
+ </td><td align="right" valign="top"
+ ><span class="codelink"><a href="oauth2client.client-pysrc.html#verify_id_token">source code</a></span>
+ </td>
+ </tr></table>
+
+ <pre class="literalblock">
+Verifies a signed JWT id_token.
+
+This function requires PyOpenSSL and because of that it does not work on
+App Engine. For App Engine you may consider using AppAssertionCredentials.
+
+Args:
+ id_token: string, A Signed JWT.
+ audience: string, The audience 'aud' that the token should be for.
+ http: httplib2.Http, instance to use to make the HTTP request. Callers
+ should supply an instance that has caching enabled.
+ cert_uri: string, URI of the certificates in JSON format to
+ verify the JWT against.
+
+Returns:
+ The deserialized JSON in the JWT.
+
+Raises:
+ oauth2client.crypt.AppIdentityError if the JWT fails to verify.
+
+</pre>
+ <dl class="fields">
+ <dt>Decorators:</dt>
+ <dd><ul class="nomargin-top">
+ <li><code>@util.positional(2)</code></li>
+ </ul></dd>
+ </dl>
+</td></tr></table>
+</div>
<a name="_extract_id_token"></a>
<div class="private">
<table class="details" border="1" cellpadding="3"
@@ -433,6 +560,171 @@
</dl>
</td></tr></table>
</div>
+<a name="credentials_from_code"></a>
+<div>
+<table class="details" border="1" cellpadding="3"
+ cellspacing="0" width="100%" bgcolor="white">
+<tr><td>
+ <table width="100%" cellpadding="0" cellspacing="0" border="0">
+ <tr valign="top"><td>
+ <h3 class="epydoc"><span class="sig"><span class="sig-name">credentials_from_code</span>(<span class="sig-arg">client_id</span>,
+ <span class="sig-arg">client_secret</span>,
+ <span class="sig-arg">scope</span>,
+ <span class="sig-arg">code</span>,
+ <span class="sig-arg">redirect_uri</span>=<span class="sig-default">'postmessage'</span>,
+ <span class="sig-arg">http</span>=<span class="sig-default">None</span>,
+ <span class="sig-arg">user_agent</span>=<span class="sig-default">None</span>,
+ <span class="sig-arg">token_uri</span>=<span class="sig-default">'https://accounts.google.com/o/oauth2/token'</span>)</span>
+ </h3>
+ </td><td align="right" valign="top"
+ ><span class="codelink"><a href="oauth2client.client-pysrc.html#credentials_from_code">source code</a></span>
+ </td>
+ </tr></table>
+
+ <pre class="literalblock">
+Exchanges an authorization code for an OAuth2Credentials object.
+
+Args:
+ client_id: string, client identifier.
+ client_secret: string, client secret.
+ scope: string or list of strings, scope(s) to request.
+ code: string, An authroization code, most likely passed down from
+ the client
+ redirect_uri: string, this is generally set to 'postmessage' to match the
+ redirect_uri that the client specified
+ http: httplib2.Http, optional http instance to use to do the fetch
+ token_uri: string, URI for token endpoint. For convenience
+ defaults to Google's endpoints but any OAuth 2.0 provider can be used.
+Returns:
+ An OAuth2Credentials object.
+
+Raises:
+ FlowExchangeError if the authorization code cannot be exchanged for an
+ access token
+
+</pre>
+ <dl class="fields">
+ <dt>Decorators:</dt>
+ <dd><ul class="nomargin-top">
+ <li><code>@util.positional(4)</code></li>
+ </ul></dd>
+ </dl>
+</td></tr></table>
+</div>
+<a name="credentials_from_clientsecrets_and_code"></a>
+<div>
+<table class="details" border="1" cellpadding="3"
+ cellspacing="0" width="100%" bgcolor="white">
+<tr><td>
+ <table width="100%" cellpadding="0" cellspacing="0" border="0">
+ <tr valign="top"><td>
+ <h3 class="epydoc"><span class="sig"><span class="sig-name">credentials_from_clientsecrets_and_code</span>(<span class="sig-arg">filename</span>,
+ <span class="sig-arg">scope</span>,
+ <span class="sig-arg">code</span>,
+ <span class="sig-arg">message</span>=<span class="sig-default">None</span>,
+ <span class="sig-arg">redirect_uri</span>=<span class="sig-default">'postmessage'</span>,
+ <span class="sig-arg">http</span>=<span class="sig-default">None</span>,
+ <span class="sig-arg">cache</span>=<span class="sig-default">None</span>)</span>
+ </h3>
+ </td><td align="right" valign="top"
+ ><span class="codelink"><a href="oauth2client.client-pysrc.html#credentials_from_clientsecrets_and_code">source code</a></span>
+ </td>
+ </tr></table>
+
+ <pre class="literalblock">
+Returns OAuth2Credentials from a clientsecrets file and an auth code.
+
+Will create the right kind of Flow based on the contents of the clientsecrets
+file or will raise InvalidClientSecretsError for unknown types of Flows.
+
+Args:
+ filename: string, File name of clientsecrets.
+ scope: string or list of strings, scope(s) to request.
+ code: string, An authorization code, most likely passed down from
+ the client
+ message: string, A friendly string to display to the user if the
+ clientsecrets file is missing or invalid. If message is provided then
+ sys.exit will be called in the case of an error. If message in not
+ provided then clientsecrets.InvalidClientSecretsError will be raised.
+ redirect_uri: string, this is generally set to 'postmessage' to match the
+ redirect_uri that the client specified
+ http: httplib2.Http, optional http instance to use to do the fetch
+ cache: An optional cache service client that implements get() and set()
+ methods. See clientsecrets.loadfile() for details.
+
+Returns:
+ An OAuth2Credentials object.
+
+Raises:
+ FlowExchangeError if the authorization code cannot be exchanged for an
+ access token
+ UnknownClientSecretsFlowError if the file describes an unknown kind of Flow.
+ clientsecrets.InvalidClientSecretsError if the clientsecrets file is
+ invalid.
+
+</pre>
+ <dl class="fields">
+ <dt>Decorators:</dt>
+ <dd><ul class="nomargin-top">
+ <li><code>@util.positional(3)</code></li>
+ </ul></dd>
+ </dl>
+</td></tr></table>
+</div>
+<a name="flow_from_clientsecrets"></a>
+<div>
+<table class="details" border="1" cellpadding="3"
+ cellspacing="0" width="100%" bgcolor="white">
+<tr><td>
+ <table width="100%" cellpadding="0" cellspacing="0" border="0">
+ <tr valign="top"><td>
+ <h3 class="epydoc"><span class="sig"><span class="sig-name">flow_from_clientsecrets</span>(<span class="sig-arg">filename</span>,
+ <span class="sig-arg">scope</span>,
+ <span class="sig-arg">redirect_uri</span>=<span class="sig-default">None</span>,
+ <span class="sig-arg">message</span>=<span class="sig-default">None</span>,
+ <span class="sig-arg">cache</span>=<span class="sig-default">None</span>)</span>
+ </h3>
+ </td><td align="right" valign="top"
+ ><span class="codelink"><a href="oauth2client.client-pysrc.html#flow_from_clientsecrets">source code</a></span>
+ </td>
+ </tr></table>
+
+ <pre class="literalblock">
+Create a Flow from a clientsecrets file.
+
+Will create the right kind of Flow based on the contents of the clientsecrets
+file or will raise InvalidClientSecretsError for unknown types of Flows.
+
+Args:
+ filename: string, File name of client secrets.
+ scope: string or list of strings, scope(s) to request.
+ redirect_uri: string, Either the string 'urn:ietf:wg:oauth:2.0:oob' for
+ a non-web-based application, or a URI that handles the callback from
+ the authorization server.
+ message: string, A friendly string to display to the user if the
+ clientsecrets file is missing or invalid. If message is provided then
+ sys.exit will be called in the case of an error. If message in not
+ provided then clientsecrets.InvalidClientSecretsError will be raised.
+ cache: An optional cache service client that implements get() and set()
+ methods. See clientsecrets.loadfile() for details.
+
+Returns:
+ A Flow object.
+
+Raises:
+ UnknownClientSecretsFlowError if the file describes an unknown kind of Flow.
+ clientsecrets.InvalidClientSecretsError if the clientsecrets file is
+ invalid.
+
+</pre>
+ <dl class="fields">
+ <dt>Decorators:</dt>
+ <dd><ul class="nomargin-top">
+ <li><code>@util.positional(2)</code></li>
+ </ul></dd>
+ </dl>
+</td></tr></table>
+</div>
<br />
<!-- ==================== VARIABLES DETAILS ==================== -->
<a name="section-VariablesDetails"></a>
@@ -464,7 +756,7 @@
<dl class="fields">
<dt>Value:</dt>
<dd><table><tr><td><pre class="variable">
-<code class="variable-quote">'</code><code class="variable-string">https://www.googleapis.com/oauth2/v1/certs</code><code class="variable-quote">'</code>
+'https://www.googleapis.com/oauth2/v1/certs'
</pre></td></tr></table>
</dd>
</dl>
@@ -494,7 +786,7 @@
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
- Generated by Epydoc 3.0.1 on Thu Aug 30 07:12:42 2012
+ Generated by Epydoc 3.0.1 on Thu Sep 6 13:36:11 2012
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"