OAuth Client¶

class typepad.oauthclient.OAuthAuthentication(credentials, host, request_uri, headers, response, content, http)¶

An httplib2.Authentication module that provides OAuth authentication.

The OAuth authentication will be tried automatically, but to use OAuth authentication with a particular user agent (Http instance), it must have the OAuth consumer and access token set as one of its sets of credentials. For instance:

>>> csr = oauth.OAuthConsumer(key='blah', secret='moo')
>>> token = get_access_token_for(user)
>>> http.add_credentials(csr, token)

request(method, request_uri, headers, content)¶

Add the HTTP Authorization header to the headers for this request.

In this implementation, the Authorization header contains the OAuth signing information and signature.

signed_request(uri, method)¶

Returns an OAuthRequest for the given URL and HTTP method, signed with this OAuthAuthentication instance’s credentials.

class typepad.oauthclient.OAuthClient(oauth_consumer, oauth_token)¶

An OAuthClient for interacting with the TypePad API.

authorize_token(params)¶

Returns the URL at which an interactive user can authorize this instance’s request token.

get_file_upload_url(upload_url)¶

Returns the given upload URL, signed for performing an HTTP POST against it, with this instance’s OAuth credentials.

Such a signed URL can be used for uploading asset files to TypePad.

class typepad.oauthclient.OAuthHttp(cache=None, timeout=None, proxy_info=None)¶

An HTTP user agent for an OAuth web service.

add_credentials(name, password, domain='')¶

Adds a name (or OAuthConsumer instance) and password (or OAuthToken instance) to this user agent’s available credentials.

If name is an OAuthConsumer instance and the domain parameter is provided, the OAuthHttp instance will be configured to provide the given OAuth credentials, even upon the first request to that domain. (Normally the user agent will make the request unauthenticated first, receive a challenge from the server, then make the request again with the credentials.)

signed_request(uri, method=None, headers=None, body=None)¶

Performs a request on the given URL with the given parameters, after signing the URL with any OAuth credentials available for that URL.

If no such credentials are available, a ValueError is raised.