nv_python_libs::vimeo::vimeo_api::SimpleOAuthClient Class Reference

List of all members.

Public Member Functions
def	__init__
def	get_request_token
def	get_authorize_token_url
def	get_access_token
def	vimeo_oauth_checkAccessToken
Public Attributes
	curly
	key
	secret
	server
	port
	request_token_url
	access_token_url
	authorization_url
	consumer
	token
Private Member Functions
def	_fetch_token
def	_do_vimeo_authenticated_call
def	_do_vimeo_unauthenticated_call

---

Detailed Description

Class used for handling authenticated call to the API.

Definition at line 204 of file vimeo_api.py.

---

Member Function Documentation

def nv_python_libs::vimeo::vimeo_api::SimpleOAuthClient::__init__	(		self,
			key,
			secret,
			server = "vimeo.com",
			port = PORT,
			request_token_url = REQUEST_TOKEN_URL,
			access_token_url = ACCESS_TOKEN_URL,
			authorization_url = AUTHORIZATION_URL,
			token = None,
			token_secret = None
	)

You need to give both key (consumer key) and secret (consumer secret).
If you already have an access token (token+secret), you can use it
by giving it through token and token_secret parameters.
If not, then you need to call both get_request_token(), get_authorize_token_url() and
finally get_access_token().

Definition at line 209 of file vimeo_api.py.

def nv_python_libs::vimeo::vimeo_api::SimpleOAuthClient::get_request_token

(

self

)

Requests a request token and return it on success.

Definition at line 239 of file vimeo_api.py.

def nv_python_libs::vimeo::vimeo_api::SimpleOAuthClient::get_authorize_token_url

(

self

)

Returns a URL used to verify and authorize the application to access
user's account. The pointed page should contain a simple 'password' that
acts as the 'verifier' in oauth.

Definition at line 249 of file vimeo_api.py.

def nv_python_libs::vimeo::vimeo_api::SimpleOAuthClient::get_access_token	(		self,
			verifier
	)

Should be called after having received the 'verifier' from the authorization page.
See 'get_authorize_token_url()' method.

Definition at line 261 of file vimeo_api.py.

def nv_python_libs::vimeo::vimeo_api::SimpleOAuthClient::_fetch_token	(		self,
			oauth_request
	)			[private]

Sends a requests and interprets the result as a token string.

Definition at line 275 of file vimeo_api.py.

def nv_python_libs::vimeo::vimeo_api::SimpleOAuthClient::vimeo_oauth_checkAccessToken	(		self,
			auth_token
	)

Definition at line 282 of file vimeo_api.py.

def nv_python_libs::vimeo::vimeo_api::SimpleOAuthClient::_do_vimeo_authenticated_call	(		self,
			method,
			parameters = {}
	)			[private]

Wrapper to send an authenticated call to vimeo. You first need to have
an access token.

Definition at line 286 of file vimeo_api.py.

def nv_python_libs::vimeo::vimeo_api::SimpleOAuthClient::_do_vimeo_unauthenticated_call	(		self,
			method,
			parameters = {}
	)			[private]

Wrapper to send an unauthenticated call to vimeo. You don't need to have
an access token.

Definition at line 301 of file vimeo_api.py.

---

Member Data Documentation

nv_python_libs::vimeo::vimeo_api::SimpleOAuthClient::curly

Definition at line 218 of file vimeo_api.py.

nv_python_libs::vimeo::vimeo_api::SimpleOAuthClient::key

Definition at line 219 of file vimeo_api.py.

nv_python_libs::vimeo::vimeo_api::SimpleOAuthClient::secret

Definition at line 220 of file vimeo_api.py.

nv_python_libs::vimeo::vimeo_api::SimpleOAuthClient::server

Definition at line 221 of file vimeo_api.py.

nv_python_libs::vimeo::vimeo_api::SimpleOAuthClient::port

Definition at line 222 of file vimeo_api.py.

nv_python_libs::vimeo::vimeo_api::SimpleOAuthClient::request_token_url

Definition at line 223 of file vimeo_api.py.

nv_python_libs::vimeo::vimeo_api::SimpleOAuthClient::access_token_url

Definition at line 224 of file vimeo_api.py.

nv_python_libs::vimeo::vimeo_api::SimpleOAuthClient::authorization_url

Definition at line 225 of file vimeo_api.py.

nv_python_libs::vimeo::vimeo_api::SimpleOAuthClient::consumer

Definition at line 226 of file vimeo_api.py.

nv_python_libs::vimeo::vimeo_api::SimpleOAuthClient::token

Definition at line 229 of file vimeo_api.py.

---

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

• vimeo_api.py