nv_python_libs.vimeo.oauth.oauth_api.OAuthRequest Class Reference

List of all members.

Public Member Functions
def	__init__
def	set_parameter
def	get_parameter
def	get_nonoauth_parameters
def	to_header
def	to_postdata
def	to_url
def	get_normalized_parameters
def	get_normalized_http_method
def	get_normalized_http_url
def	sign_request
def	build_signature
def	from_request
def	from_consumer_and_token
def	from_token_and_callback
Static Public Attributes
	parameters = None
	http_method = HTTP_METHOD
	http_url = None
	version = VERSION
tuple	from_request = staticmethod(from_request)
tuple	from_consumer_and_token = staticmethod(from_consumer_and_token)
tuple	from_token_and_callback = staticmethod(from_token_and_callback)
Private Member Functions
def	_get_timestamp_nonce
def	_split_header
def	_split_url_string
Static Private Attributes
tuple	_split_header = staticmethod(_split_header)
tuple	_split_url_string = staticmethod(_split_url_string)

---

Detailed Description

OAuthRequest represents the request and can be serialized.

OAuth parameters:
    - oauth_consumer_key
    - oauth_token
    - oauth_signature_method
    - oauth_signature
    - oauth_timestamp
    - oauth_nonce
    - oauth_version
    - oauth_verifier
    ... any additional parameters, as defined by the Service Provider.

Definition at line 156 of file oauth_api.py.

---

Constructor & Destructor Documentation

def nv_python_libs.vimeo.oauth.oauth_api.OAuthRequest.__init__	(		self,
			http_method = HTTP_METHOD,
			http_url = None,
			parameters = None
	)

Definition at line 175 of file oauth_api.py.

---

Member Function Documentation

def nv_python_libs.vimeo.oauth.oauth_api.OAuthRequest.set_parameter	(		self,
			parameter,
			value
	)

Definition at line 180 of file oauth_api.py.

Referenced by nv_python_libs.vimeo.oauth.oauth_api.OAuthRequest.sign_request().

def nv_python_libs.vimeo.oauth.oauth_api.OAuthRequest.get_parameter	(		self,
			parameter
	)

Definition at line 183 of file oauth_api.py.

Referenced by nv_python_libs.vimeo.oauth.oauth_api.OAuthRequest._get_timestamp_nonce().

def nv_python_libs.vimeo.oauth.oauth_api.OAuthRequest._get_timestamp_nonce

(

self

)

[private]

Definition at line 189 of file oauth_api.py.

def nv_python_libs.vimeo.oauth.oauth_api.OAuthRequest.get_nonoauth_parameters

(

self

)

Get any non-OAuth parameters.

Definition at line 193 of file oauth_api.py.

def nv_python_libs.vimeo.oauth.oauth_api.OAuthRequest.to_header	(		self,
			realm = ''
	)

Serialize as a header for an HTTPAuth request.

Definition at line 202 of file oauth_api.py.

def nv_python_libs.vimeo.oauth.oauth_api.OAuthRequest.to_postdata

(

self

)

Serialize as post data for a POST request.

Definition at line 212 of file oauth_api.py.

Referenced by nv_python_libs.vimeo.oauth.oauth_api.OAuthRequest.to_url().

def nv_python_libs.vimeo.oauth.oauth_api.OAuthRequest.to_url

(

self

)

Serialize as a URL for a GET request.

Definition at line 217 of file oauth_api.py.

def nv_python_libs.vimeo.oauth.oauth_api.OAuthRequest.get_normalized_parameters

(

self

)

Return a string that contains the parameters that must be signed.

Definition at line 221 of file oauth_api.py.

def nv_python_libs.vimeo.oauth.oauth_api.OAuthRequest.get_normalized_http_method

(

self

)

Uppercases the http method.

Definition at line 237 of file oauth_api.py.

def nv_python_libs.vimeo.oauth.oauth_api.OAuthRequest.get_normalized_http_url

(

self

)

Parses the URL and rebuilds it to be scheme://host/path.

Definition at line 241 of file oauth_api.py.

Referenced by nv_python_libs.vimeo.oauth.oauth_api.OAuthRequest.to_url().

def nv_python_libs.vimeo.oauth.oauth_api.OAuthRequest.sign_request	(		self,
			signature_method,
			consumer,
			token
	)

Set the signature parameter to the result of build_signature.

Definition at line 252 of file oauth_api.py.

def nv_python_libs.vimeo.oauth.oauth_api.OAuthRequest.build_signature	(		self,
			signature_method,
			consumer,
			token
	)

Calls the build signature method within the signature method.

Definition at line 261 of file oauth_api.py.

Referenced by nv_python_libs.vimeo.oauth.oauth_api.OAuthSignatureMethod.check_signature(), and nv_python_libs.vimeo.oauth.oauth_api.OAuthRequest.sign_request().

def nv_python_libs.vimeo.oauth.oauth_api.OAuthRequest.from_request	(		http_method,
			http_url,
			headers = None,
			parameters = None,
			query_string = None
	)

Combines multiple parameter sources.

Definition at line 265 of file oauth_api.py.

def nv_python_libs.vimeo.oauth.oauth_api.OAuthRequest.from_consumer_and_token	(		oauth_consumer,
			token = None,
			callback = None,
			verifier = None,
			http_method = HTTP_METHOD,
			http_url = None,
			parameters = None
	)

Definition at line 301 of file oauth_api.py.

def nv_python_libs.vimeo.oauth.oauth_api.OAuthRequest.from_token_and_callback	(		token,
			callback = None,
			http_method = HTTP_METHOD,
			http_url = None,
			parameters = None
	)

Definition at line 330 of file oauth_api.py.

def nv_python_libs.vimeo.oauth.oauth_api.OAuthRequest._split_header

(

header

)

[private]

Turn Authorization: header into parameters.

Definition at line 343 of file oauth_api.py.

def nv_python_libs.vimeo.oauth.oauth_api.OAuthRequest._split_url_string

(

param_str

)

[private]

Turn URL string into parameters.

Definition at line 360 of file oauth_api.py.

---

Member Data Documentation

nv_python_libs::vimeo::oauth::oauth_api.OAuthRequest::parameters = None [static]

Definition at line 170 of file oauth_api.py.

Referenced by nv_python_libs.vimeo.oauth.oauth_api.OAuthRequest::__init__(), nv_python_libs.vimeo.oauth.oauth_api.OAuthRequest::get_normalized_parameters(), nv_python_libs.vimeo.oauth.oauth_api.OAuthRequest::get_parameter(), nv_python_libs.vimeo.oauth.oauth_api.OAuthRequest::set_parameter(), and nv_python_libs.vimeo.oauth.oauth_api.OAuthRequest::to_header().

nv_python_libs::vimeo::oauth::oauth_api.OAuthRequest::http_method = HTTP_METHOD [static]

Definition at line 171 of file oauth_api.py.

Referenced by nv_python_libs.vimeo.oauth.oauth_api.OAuthRequest.__init__().

nv_python_libs::vimeo::oauth::oauth_api.OAuthRequest::http_url = None [static]

Definition at line 172 of file oauth_api.py.

Referenced by nv_python_libs.vimeo.oauth.oauth_api.OAuthRequest.__init__(), and nv_python_libs.vimeo.oauth.oauth_api.OAuthRequest.get_normalized_http_url().

nv_python_libs::vimeo::oauth::oauth_api.OAuthRequest::version = VERSION [static]

Definition at line 173 of file oauth_api.py.

Referenced by nv_python_libs.vimeo.oauth.oauth_api.OAuthServer._get_version().

tuple nv_python_libs::vimeo::oauth::oauth_api.OAuthRequest::from_request = staticmethod(from_request) [static]

Definition at line 299 of file oauth_api.py.

Referenced by nv_python_libs.vimeo.oauth.oauth_api.OAuthRequest.from_request().

tuple nv_python_libs::vimeo::oauth::oauth_api.OAuthRequest::from_consumer_and_token = staticmethod(from_consumer_and_token) [static]

Definition at line 328 of file oauth_api.py.

Referenced by nv_python_libs.vimeo.oauth.oauth_api.OAuthRequest.from_consumer_and_token().

tuple nv_python_libs::vimeo::oauth::oauth_api.OAuthRequest::from_token_and_callback = staticmethod(from_token_and_callback) [static]

Definition at line 341 of file oauth_api.py.

Referenced by nv_python_libs.vimeo.oauth.oauth_api.OAuthRequest.from_token_and_callback().

tuple nv_python_libs::vimeo::oauth::oauth_api.OAuthRequest::_split_header = staticmethod(_split_header) [static, private]

Definition at line 358 of file oauth_api.py.

Referenced by nv_python_libs.vimeo.oauth.oauth_api.OAuthRequest._split_header().

tuple nv_python_libs::vimeo::oauth::oauth_api.OAuthRequest::_split_url_string = staticmethod(_split_url_string) [static, private]

Definition at line 366 of file oauth_api.py.

Referenced by nv_python_libs.vimeo.oauth.oauth_api.OAuthRequest._split_url_string().

---

The documentation for this class was generated from the following file:

• oauth_api.py