Public Member Functions | Static Public Attributes | Private Member Functions | Static Private Attributes
7digital-python.lib.oauth.OAuthRequest Class Reference
Inheritance diagram for 7digital-python.lib.oauth.OAuthRequest:
Inheritance graph
Collaboration diagram for 7digital-python.lib.oauth.OAuthRequest:
Collaboration graph

Public Member Functions

def __init__ (self, http_method=HTTP_METHOD, http_url=None, parameters=None)
 
def set_parameter (self, parameter, value)
 
def get_parameter (self, parameter)
 
def get_nonoauth_parameters (self)
 
def to_header (self, realm='')
 
def to_postdata (self)
 
def to_url (self)
 
def get_normalized_parameters (self)
 
def get_normalized_http_method (self)
 
def get_normalized_http_url (self)
 
def sign_request (self, signature_method, consumer, token)
 
def build_signature (self, signature_method, consumer, token)
 
def from_request (http_method, http_url, headers=None, parameters=None, query_string=None)
 
def from_consumer_and_token (oauth_consumer, token=None, callback=None, verifier=None, http_method=HTTP_METHOD, http_url=None, parameters=None)
 
def from_token_and_callback (token, callback=None, http_method=HTTP_METHOD, http_url=None, parameters=None)
 
def __init__ (self, http_method=HTTP_METHOD, http_url=None, parameters=None)
 
def set_parameter (self, parameter, value)
 
def get_parameter (self, parameter)
 
def get_nonoauth_parameters (self)
 
def to_header (self, realm='')
 
def to_postdata (self)
 
def to_url (self)
 
def get_normalized_parameters (self)
 
def get_normalized_http_method (self)
 
def get_normalized_http_url (self)
 
def sign_request (self, signature_method, consumer, token)
 
def build_signature (self, signature_method, consumer, token)
 
def from_request (http_method, http_url, headers=None, parameters=None, query_string=None)
 
def from_consumer_and_token (oauth_consumer, token=None, callback=None, verifier=None, http_method=HTTP_METHOD, http_url=None, parameters=None)
 
def from_token_and_callback (token, callback=None, http_method=HTTP_METHOD, http_url=None, parameters=None)
 

Static Public Attributes

 parameters = None
 
 http_method = HTTP_METHOD
 
 http_url = None
 
 version = VERSION
 
 from_request = staticmethod(from_request)
 
 from_consumer_and_token = staticmethod(from_consumer_and_token)
 
 from_token_and_callback = staticmethod(from_token_and_callback)
 

Private Member Functions

def _get_timestamp_nonce (self)
 
def _split_header (header)
 
def _split_url_string (param_str)
 
def _get_timestamp_nonce (self)
 
def _split_header (header)
 
def _split_url_string (param_str)
 

Static Private Attributes

 _split_header = staticmethod(_split_header)
 
 _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 158 of file musixmatch-master/7digital-python/lib/oauth.py.

Constructor & Destructor Documentation

def 7digital-python.lib.oauth.OAuthRequest.__init__ (   self,
  http_method = HTTP_METHOD,
  http_url = None,
  parameters = None 
)

Definition at line 177 of file musixmatch-master/7digital-python/lib/oauth.py.

Referenced by 7digital-python.lib.oauth.OAuthRequest.__init__().

def 7digital-python.lib.oauth.OAuthRequest.__init__ (   self,
  http_method = HTTP_METHOD,
  http_url = None,
  parameters = None 
)

Definition at line 177 of file Yading/7digital-python/lib/oauth.py.

Member Function Documentation

def 7digital-python.lib.oauth.OAuthRequest._get_timestamp_nonce (   self)
private

Definition at line 191 of file musixmatch-master/7digital-python/lib/oauth.py.

Referenced by 7digital-python.lib.oauth.OAuthRequest._get_timestamp_nonce().

def 7digital-python.lib.oauth.OAuthRequest._get_timestamp_nonce (   self)
private

Definition at line 191 of file Yading/7digital-python/lib/oauth.py.

def 7digital-python.lib.oauth.OAuthRequest._split_header (   header)
private 
Turn Authorization: header into parameters.

Definition at line 346 of file Yading/7digital-python/lib/oauth.py.

def 7digital-python.lib.oauth.OAuthRequest._split_header (   header)
private 
Turn Authorization: header into parameters.

Definition at line 346 of file musixmatch-master/7digital-python/lib/oauth.py.

def 7digital-python.lib.oauth.OAuthRequest._split_url_string (   param_str)
private 
Turn URL string into parameters.

Definition at line 363 of file musixmatch-master/7digital-python/lib/oauth.py.

def 7digital-python.lib.oauth.OAuthRequest._split_url_string (   param_str)
private 
Turn URL string into parameters.

Definition at line 363 of file Yading/7digital-python/lib/oauth.py.

def 7digital-python.lib.oauth.OAuthRequest.build_signature (   self,
  signature_method,
  consumer,
  token 
) 
Calls the build signature method within the signature method.

Definition at line 263 of file musixmatch-master/7digital-python/lib/oauth.py.

Referenced by 7digital-python.lib.oauth.OAuthRequest.build_signature(), 7digital-python.lib.oauth.OAuthSignatureMethod.check_signature(), and 7digital-python.lib.oauth.OAuthRequest.sign_request().

def 7digital-python.lib.oauth.OAuthRequest.build_signature (   self,
  signature_method,
  consumer,
  token 
) 
Calls the build signature method within the signature method.

Definition at line 263 of file Yading/7digital-python/lib/oauth.py.

def 7digital-python.lib.oauth.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 305 of file musixmatch-master/7digital-python/lib/oauth.py.

def 7digital-python.lib.oauth.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 305 of file Yading/7digital-python/lib/oauth.py.

def 7digital-python.lib.oauth.OAuthRequest.from_request (   http_method,
  http_url,
  headers = None,
  parameters = None,
  query_string = None 
) 
Combines multiple parameter sources.

Definition at line 268 of file Yading/7digital-python/lib/oauth.py.

def 7digital-python.lib.oauth.OAuthRequest.from_request (   http_method,
  http_url,
  headers = None,
  parameters = None,
  query_string = None 
) 
Combines multiple parameter sources.

Definition at line 268 of file musixmatch-master/7digital-python/lib/oauth.py.

def 7digital-python.lib.oauth.OAuthRequest.from_token_and_callback (   token,
  callback = None,
  http_method = HTTP_METHOD,
  http_url = None,
  parameters = None 
)

Definition at line 334 of file musixmatch-master/7digital-python/lib/oauth.py.

def 7digital-python.lib.oauth.OAuthRequest.from_token_and_callback (   token,
  callback = None,
  http_method = HTTP_METHOD,
  http_url = None,
  parameters = None 
)

Definition at line 334 of file Yading/7digital-python/lib/oauth.py.

def 7digital-python.lib.oauth.OAuthRequest.get_nonoauth_parameters (   self) 
Get any non-OAuth parameters.

Definition at line 195 of file musixmatch-master/7digital-python/lib/oauth.py.

Referenced by 7digital-python.lib.oauth.OAuthRequest.get_nonoauth_parameters().

def 7digital-python.lib.oauth.OAuthRequest.get_nonoauth_parameters (   self) 
Get any non-OAuth parameters.

Definition at line 195 of file Yading/7digital-python/lib/oauth.py.

def 7digital-python.lib.oauth.OAuthRequest.get_normalized_http_method (   self) 
Uppercases the http method.

Definition at line 239 of file musixmatch-master/7digital-python/lib/oauth.py.

Referenced by 7digital-python.lib.oauth.OAuthRequest.get_normalized_http_method().

def 7digital-python.lib.oauth.OAuthRequest.get_normalized_http_method (   self) 
Uppercases the http method.

Definition at line 239 of file Yading/7digital-python/lib/oauth.py.

def 7digital-python.lib.oauth.OAuthRequest.get_normalized_http_url (   self) 
Parses the URL and rebuilds it to be scheme://host/path.

Definition at line 243 of file musixmatch-master/7digital-python/lib/oauth.py.

Referenced by 7digital-python.lib.oauth.OAuthRequest.get_normalized_http_url(), and 7digital-python.lib.oauth.OAuthRequest.to_url().

def 7digital-python.lib.oauth.OAuthRequest.get_normalized_http_url (   self) 
Parses the URL and rebuilds it to be scheme://host/path.

Definition at line 243 of file Yading/7digital-python/lib/oauth.py.

def 7digital-python.lib.oauth.OAuthRequest.get_normalized_parameters (   self) 
Return a string that contains the parameters that must be signed.

Definition at line 223 of file musixmatch-master/7digital-python/lib/oauth.py.

Referenced by 7digital-python.lib.oauth.OAuthRequest.get_normalized_parameters().

def 7digital-python.lib.oauth.OAuthRequest.get_normalized_parameters (   self) 
Return a string that contains the parameters that must be signed.

Definition at line 223 of file Yading/7digital-python/lib/oauth.py.

def 7digital-python.lib.oauth.OAuthRequest.get_parameter (   self,
  parameter 
)

Definition at line 185 of file Yading/7digital-python/lib/oauth.py.

def 7digital-python.lib.oauth.OAuthRequest.get_parameter (   self,
  parameter 
)

Definition at line 185 of file musixmatch-master/7digital-python/lib/oauth.py.

Referenced by 7digital-python.lib.oauth.OAuthRequest._get_timestamp_nonce(), and 7digital-python.lib.oauth.OAuthRequest.get_parameter().

def 7digital-python.lib.oauth.OAuthRequest.set_parameter (   self,
  parameter,
  value 
)

Definition at line 182 of file musixmatch-master/7digital-python/lib/oauth.py.

Referenced by 7digital-python.lib.oauth.OAuthRequest.set_parameter(), and 7digital-python.lib.oauth.OAuthRequest.sign_request().

def 7digital-python.lib.oauth.OAuthRequest.set_parameter (   self,
  parameter,
  value 
)

Definition at line 182 of file Yading/7digital-python/lib/oauth.py.

def 7digital-python.lib.oauth.OAuthRequest.sign_request (   self,
  signature_method,
  consumer,
  token 
) 
Set the signature parameter to the result of build_signature.

Definition at line 254 of file musixmatch-master/7digital-python/lib/oauth.py.

Referenced by 7digital-python.lib.oauth.OAuthRequest.sign_request().

def 7digital-python.lib.oauth.OAuthRequest.sign_request (   self,
  signature_method,
  consumer,
  token 
) 
Set the signature parameter to the result of build_signature.

Definition at line 254 of file Yading/7digital-python/lib/oauth.py.

def 7digital-python.lib.oauth.OAuthRequest.to_header (   self,
  realm = '' 
) 
Serialize as a header for an HTTPAuth request.

Definition at line 204 of file musixmatch-master/7digital-python/lib/oauth.py.

Referenced by 7digital-python.lib.oauth.OAuthRequest.to_header().

def 7digital-python.lib.oauth.OAuthRequest.to_header (   self,
  realm = '' 
) 
Serialize as a header for an HTTPAuth request.

Definition at line 204 of file Yading/7digital-python/lib/oauth.py.

def 7digital-python.lib.oauth.OAuthRequest.to_postdata (   self) 
Serialize as post data for a POST request.

Definition at line 214 of file musixmatch-master/7digital-python/lib/oauth.py.

Referenced by 7digital-python.lib.oauth.OAuthRequest.to_postdata(), and 7digital-python.lib.oauth.OAuthRequest.to_url().

def 7digital-python.lib.oauth.OAuthRequest.to_postdata (   self) 
Serialize as post data for a POST request.

Definition at line 214 of file Yading/7digital-python/lib/oauth.py.

def 7digital-python.lib.oauth.OAuthRequest.to_url (   self) 
Serialize as a URL for a GET request.

Definition at line 219 of file musixmatch-master/7digital-python/lib/oauth.py.

Referenced by 7digital-python.lib.oauth.OAuthRequest.to_url().

def 7digital-python.lib.oauth.OAuthRequest.to_url (   self) 
Serialize as a URL for a GET request.

Definition at line 219 of file Yading/7digital-python/lib/oauth.py.

Field Documentation

7digital-python.lib.oauth.OAuthRequest._split_header = staticmethod(_split_header)
staticprivate

Definition at line 361 of file musixmatch-master/7digital-python/lib/oauth.py.

Referenced by 7digital-python.lib.oauth.OAuthRequest._split_header().

7digital-python.lib.oauth.OAuthRequest._split_url_string = staticmethod(_split_url_string)
staticprivate

Definition at line 369 of file musixmatch-master/7digital-python/lib/oauth.py.

Referenced by 7digital-python.lib.oauth.OAuthRequest._split_url_string().

7digital-python.lib.oauth.OAuthRequest.from_consumer_and_token = staticmethod(from_consumer_and_token)
static

Definition at line 331 of file musixmatch-master/7digital-python/lib/oauth.py.

Referenced by 7digital-python.lib.oauth.OAuthRequest.from_request().

7digital-python.lib.oauth.OAuthRequest.from_request = staticmethod(from_request)
static

Definition at line 301 of file musixmatch-master/7digital-python/lib/oauth.py.

Referenced by 7digital-python.lib.oauth.OAuthRequest.build_signature().

7digital-python.lib.oauth.OAuthRequest.from_token_and_callback = staticmethod(from_token_and_callback)
static

Definition at line 344 of file musixmatch-master/7digital-python/lib/oauth.py.

Referenced by 7digital-python.lib.oauth.OAuthRequest.from_consumer_and_token().

7digital-python.lib.oauth.OAuthRequest.http_method = HTTP_METHOD
static

Definition at line 173 of file musixmatch-master/7digital-python/lib/oauth.py.

Referenced by 7digital-python.lib.oauth.OAuthRequest.__init__().

7digital-python.lib.oauth.OAuthRequest.http_url = None
static

Definition at line 174 of file musixmatch-master/7digital-python/lib/oauth.py.

Referenced by 7digital-python.lib.oauth.OAuthRequest.__init__(), and 7digital-python.lib.oauth.OAuthRequest.get_normalized_http_url().

7digital-python.lib.oauth.OAuthRequest.parameters = None
static

Definition at line 172 of file musixmatch-master/7digital-python/lib/oauth.py.

Referenced by 7digital-python.lib.oauth.OAuthRequest.__init__(), 7digital-python.lib.oauth.OAuthRequest.get_normalized_parameters(), 7digital-python.lib.oauth.OAuthRequest.get_parameter(), 7digital-python.lib.oauth.OAuthRequest.set_parameter(), and 7digital-python.lib.oauth.OAuthRequest.to_header().

7digital-python.lib.oauth.OAuthRequest.version = VERSION
static

Definition at line 175 of file musixmatch-master/7digital-python/lib/oauth.py.

Referenced by 7digital-python.lockerEndpoint.Track.__init__(), and 7digital-python.lib.oauth.OAuthServer._get_version().

The documentation for this class was generated from the following file:
Generated on Sat May 4 2024 06:51:51 for FFmpeg by   doxygen 1.8.11