apiclient.oauth
index
/usr/local/google/home/jcgregorio/projects/apiclient/apiclient/oauth.py

Utilities for OAuth.
 
Utilities for making it easier to work with OAuth.

 
Modules
       
copy
httplib2
logging
oauth2
simplejson
urllib
urlparse

 
Classes
       
__builtin__.object
Credentials
OAuthCredentials
Flow
FlowThreeLegged
Storage
exceptions.Exception(exceptions.BaseException)
Error
CredentialsInvalidError
MissingParameter
RequestError

 
class Credentials(__builtin__.object)
    Base class for all Credentials objects.
 
Subclasses must define an authorize() method
that applies the credentials to an HTTP transport.
 
  Methods defined here:
authorize(self, http)
Take an httplib2.Http instance (or equivalent) and
authorizes it for the set of credentials, usually by
replacing http.request() with a method that adds in
the appropriate headers and then delegates to the original
Http.request() method.

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)

 
class CredentialsInvalidError(Error)
    
Method resolution order:
CredentialsInvalidError
Error
exceptions.Exception
exceptions.BaseException
__builtin__.object

Data descriptors inherited from Error:
__weakref__
list of weak references to the object (if defined)

Methods inherited from exceptions.Exception:
__init__(...)
x.__init__(...) initializes x; see x.__class__.__doc__ for signature

Data and other attributes inherited from exceptions.Exception:
__new__ = <built-in method __new__ of type object>
T.__new__(S, ...) -> a new object with type S, a subtype of T

Methods inherited from exceptions.BaseException:
__delattr__(...)
x.__delattr__('name') <==> del x.name
__getattribute__(...)
x.__getattribute__('name') <==> x.name
__getitem__(...)
x.__getitem__(y) <==> x[y]
__getslice__(...)
x.__getslice__(i, j) <==> x[i:j]
 
Use of negative indices is not supported.
__reduce__(...)
__repr__(...)
x.__repr__() <==> repr(x)
__setattr__(...)
x.__setattr__('name', value) <==> x.name = value
__setstate__(...)
__str__(...)
x.__str__() <==> str(x)
__unicode__(...)

Data descriptors inherited from exceptions.BaseException:
__dict__
args
message

 
class Error(exceptions.Exception)
    Base error for this module.
 
 
Method resolution order:
Error
exceptions.Exception
exceptions.BaseException
__builtin__.object

Data descriptors defined here:
__weakref__
list of weak references to the object (if defined)

Methods inherited from exceptions.Exception:
__init__(...)
x.__init__(...) initializes x; see x.__class__.__doc__ for signature

Data and other attributes inherited from exceptions.Exception:
__new__ = <built-in method __new__ of type object>
T.__new__(S, ...) -> a new object with type S, a subtype of T

Methods inherited from exceptions.BaseException:
__delattr__(...)
x.__delattr__('name') <==> del x.name
__getattribute__(...)
x.__getattribute__('name') <==> x.name
__getitem__(...)
x.__getitem__(y) <==> x[y]
__getslice__(...)
x.__getslice__(i, j) <==> x[i:j]
 
Use of negative indices is not supported.
__reduce__(...)
__repr__(...)
x.__repr__() <==> repr(x)
__setattr__(...)
x.__setattr__('name', value) <==> x.name = value
__setstate__(...)
__str__(...)
x.__str__() <==> str(x)
__unicode__(...)

Data descriptors inherited from exceptions.BaseException:
__dict__
args
message

 
class Flow(__builtin__.object)
    Base class for all Flow objects.
 
  Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)

 
class FlowThreeLegged(Flow)
    Does the Three Legged Dance for OAuth 1.0a.
 
 
Method resolution order:
FlowThreeLegged
Flow
__builtin__.object

Methods defined here:
__init__(self, discovery, consumer_key, consumer_secret, user_agent, **kwargs)
discovery       - Section of the API discovery document that describes
                  the OAuth endpoints.
consumer_key    - OAuth consumer key
consumer_secret - OAuth consumer secret
user_agent      - The HTTP User-Agent that identifies the application.
**kwargs        - The keyword arguments are all optional and required
                  parameters for the OAuth calls.
step1_get_authorize_url(self, oauth_callback='oob')
Returns a URI to redirect to the provider.
 
oauth_callback - Either the string 'oob' for a non-web-based application,
                 or a URI that handles the callback from the authorization
                 server.
 
If oauth_callback is 'oob' then pass in the
generated verification code to step2_exchange,
otherwise pass in the query parameters received
at the callback uri to step2_exchange.
step2_exchange(self, verifier)
Exhanges an authorized request token
for OAuthCredentials.
 
verifier - either the verifier token, or a dictionary
    of the query parameters to the callback, which contains
    the oauth_verifier.

Data descriptors inherited from Flow:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)

 
class MissingParameter(Error)
    
Method resolution order:
MissingParameter
Error
exceptions.Exception
exceptions.BaseException
__builtin__.object

Data descriptors inherited from Error:
__weakref__
list of weak references to the object (if defined)

Methods inherited from exceptions.Exception:
__init__(...)
x.__init__(...) initializes x; see x.__class__.__doc__ for signature

Data and other attributes inherited from exceptions.Exception:
__new__ = <built-in method __new__ of type object>
T.__new__(S, ...) -> a new object with type S, a subtype of T

Methods inherited from exceptions.BaseException:
__delattr__(...)
x.__delattr__('name') <==> del x.name
__getattribute__(...)
x.__getattribute__('name') <==> x.name
__getitem__(...)
x.__getitem__(y) <==> x[y]
__getslice__(...)
x.__getslice__(i, j) <==> x[i:j]
 
Use of negative indices is not supported.
__reduce__(...)
__repr__(...)
x.__repr__() <==> repr(x)
__setattr__(...)
x.__setattr__('name', value) <==> x.name = value
__setstate__(...)
__str__(...)
x.__str__() <==> str(x)
__unicode__(...)

Data descriptors inherited from exceptions.BaseException:
__dict__
args
message

 
class OAuthCredentials(Credentials)
    Credentials object for OAuth 1.0a
 
 
Method resolution order:
OAuthCredentials
Credentials
__builtin__.object

Methods defined here:
__getstate__(self)
Trim the state down to something that can be pickled.
__init__(self, consumer, token, user_agent)
consumer   - An instance of oauth.Consumer.
token      - An instance of oauth.Token constructed with
             the access token and secret.
user_agent - The HTTP User-Agent to provide for this application.
__setstate__(self, state)
Reconstitute the state of the object from being pickled.
authorize(self, http)
Args:
   http - An instance of httplib2.Http
       or something that acts like it.
 
Returns:
   A modified instance of http that was passed in.
 
Example:
 
  h = httplib2.Http()
  h = credentials.authorize(h)
 
You can't create a new OAuth
subclass of httplib2.Authenication because
it never gets passed the absolute URI, which is
needed for signing. So instead we have to overload
'request' with a closure that adds in the
Authorization header and then calls the original version
of 'request()'.
set_store(self, store)
Set the storage for the credential.
 
Args:
  store: callable, a callable that when passed a Credential
    will store the credential back to where it came from.
    This is needed to store the latest access_token if it
    has been revoked.

Data descriptors defined here:
invalid
True if the credentials are invalid, such as being revoked.

Data descriptors inherited from Credentials:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)

 
class RequestError(Error)
    Error occurred during request.
 
 
Method resolution order:
RequestError
Error
exceptions.Exception
exceptions.BaseException
__builtin__.object

Data descriptors inherited from Error:
__weakref__
list of weak references to the object (if defined)

Methods inherited from exceptions.Exception:
__init__(...)
x.__init__(...) initializes x; see x.__class__.__doc__ for signature

Data and other attributes inherited from exceptions.Exception:
__new__ = <built-in method __new__ of type object>
T.__new__(S, ...) -> a new object with type S, a subtype of T

Methods inherited from exceptions.BaseException:
__delattr__(...)
x.__delattr__('name') <==> del x.name
__getattribute__(...)
x.__getattribute__('name') <==> x.name
__getitem__(...)
x.__getitem__(y) <==> x[y]
__getslice__(...)
x.__getslice__(i, j) <==> x[i:j]
 
Use of negative indices is not supported.
__reduce__(...)
__repr__(...)
x.__repr__() <==> repr(x)
__setattr__(...)
x.__setattr__('name', value) <==> x.name = value
__setstate__(...)
__str__(...)
x.__str__() <==> str(x)
__unicode__(...)

Data descriptors inherited from exceptions.BaseException:
__dict__
args
message

 
class Storage(__builtin__.object)
    Base class for all Storage objects.
 
Store and retrieve a single credential.
 
  Methods defined here:
get(self)
Retrieve credential.
 
Returns:
  apiclient.oauth.Credentials
put(self, credentials)
Write a credential.
 
Args:
  credentials: Credentials, the credentials to store.

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)

 
Data
        __author__ = 'jcgregorio@google.com (Joe Gregorio)'

 
Author
        jcgregorio@google.com (Joe Gregorio)