Inheritance diagram for upload.AbstractRpcServer:

Public Member Functions
def	__init__ (self, host, auth_function, host_override=None, extra_headers={}, save_cookies=False)

def	__init__ (self, host, auth_function, host_override=None, extra_headers={}, save_cookies=False)

def	Send (self, request_path, payload=None, content_type="application/octet-stream", timeout=None, **kwargs)

def	Send (self, request_path, payload=None, content_type="application/octet-stream", timeout=None, **kwargs)

Public Attributes
	auth_function

	authenticated

	extra_headers

	host

	host_override

	opener

	save_cookies

Private Member Functions
def	_Authenticate (self)

def	_Authenticate (self)

def	_CreateRequest (self, url, data=None)

def	_CreateRequest (self, url, data=None)

def	_GetAuthCookie (self, auth_token)

def	_GetAuthCookie (self, auth_token)

def	_GetAuthToken (self, email, password)

def	_GetAuthToken (self, email, password)

def	_GetOpener (self)

def	_GetOpener (self)

Detailed Description

Provides a common interface for a simple RPC server.

Definition at line 124 of file googlemock/scripts/upload.py.

Constructor & Destructor Documentation

◆ init() [1/2]

def upload.AbstractRpcServer.__init__	(	self,
		host,
		auth_function,
		host_override = `None`,
		extra_headers = `{}`,
		save_cookies = `False`
	)

Creates a new HttpRpcServer.

Args:
  host: The host to send requests to.
  auth_function: A function that takes no arguments and returns an
(email, password) tuple when called. Will be called if authentication
is required.
  host_override: The host header to send to the server (defaults to host).
  extra_headers: A dict of extra headers to append to every request.
  save_cookies: If True, save the authentication cookies to local disk.
If False, use an in-memory cookiejar instead.  Subclasses must
implement this functionality.  Defaults to False.

Definition at line 127 of file googlemock/scripts/upload.py.

◆ init() [2/2]

def upload.AbstractRpcServer.__init__	(	self,
		host,
		auth_function,
		host_override = `None`,
		extra_headers = `{}`,
		save_cookies = `False`
	)

Creates a new HttpRpcServer.

Args:
  host: The host to send requests to.
  auth_function: A function that takes no arguments and returns an
(email, password) tuple when called. Will be called if authentication
is required.
  host_override: The host header to send to the server (defaults to host).
  extra_headers: A dict of extra headers to append to every request.
  save_cookies: If True, save the authentication cookies to local disk.
If False, use an in-memory cookiejar instead.  Subclasses must
implement this functionality.  Defaults to False.

Definition at line 127 of file googletest/scripts/upload.py.

Member Function Documentation

◆ _Authenticate() [1/2]

def upload.AbstractRpcServer._Authenticate ( self )

private

Authenticates the user.

The authentication process works as follows:
 1) We get a username and password from the user
 2) We use ClientLogin to obtain an AUTH token for the user
(see https://developers.google.com/identity/protocols/AuthForInstalledApps).
 3) We pass the auth token to /_ah/login on the server to obtain an
authentication cookie. If login was successful, it tries to redirect
us to the URL we provided.

If we attempt to access the upload API without first obtaining an
authentication cookie, it returns a 401 response and directs us to
authenticate ourselves with ClientLogin.

Reimplemented in upload.HttpRpcServer, and upload.HttpRpcServer.

Definition at line 239 of file googlemock/scripts/upload.py.

◆ _Authenticate() [2/2]

def upload.AbstractRpcServer._Authenticate ( self )

private

Authenticates the user.

The authentication process works as follows:
 1) We get a username and password from the user
 2) We use ClientLogin to obtain an AUTH token for the user
(see https://developers.google.com/identity/protocols/AuthForInstalledApps).
 3) We pass the auth token to /_ah/login on the server to obtain an
authentication cookie. If login was successful, it tries to redirect
us to the URL we provided.

If we attempt to access the upload API without first obtaining an
authentication cookie, it returns a 401 response and directs us to
authenticate ourselves with ClientLogin.

Reimplemented in upload.HttpRpcServer, and upload.HttpRpcServer.

Definition at line 239 of file googletest/scripts/upload.py.

◆ _CreateRequest() [1/2]

def upload.AbstractRpcServer._CreateRequest	(	self,
		url,
		data = `None`
	)

private

Creates a new urllib request.

Definition at line 162 of file googletest/scripts/upload.py.

◆ _CreateRequest() [2/2]

def upload.AbstractRpcServer._CreateRequest	(	self,
		url,
		data = `None`
	)

private

Creates a new urllib request.

Definition at line 162 of file googlemock/scripts/upload.py.

◆ _GetAuthCookie() [1/2]

def upload.AbstractRpcServer._GetAuthCookie	(	self,
		auth_token
	)

private

Fetches authentication cookies for an authentication token.

Args:
  auth_token: The authentication token returned by ClientLogin.

Raises:
  HTTPError: If there was an error fetching the authentication cookies.

Definition at line 215 of file googletest/scripts/upload.py.

◆ _GetAuthCookie() [2/2]

def upload.AbstractRpcServer._GetAuthCookie	(	self,
		auth_token
	)

private

Fetches authentication cookies for an authentication token.

Args:
  auth_token: The authentication token returned by ClientLogin.

Raises:
  HTTPError: If there was an error fetching the authentication cookies.

Definition at line 215 of file googlemock/scripts/upload.py.

◆ _GetAuthToken() [1/2]

def upload.AbstractRpcServer._GetAuthToken	(	self,
		email,
		password
	)

private

Uses ClientLogin to authenticate the user, returning an auth token.

Args:
  email:    The user's email address
  password: The user's password

Raises:
  ClientLoginError: If there was an error authenticating with ClientLogin.
  HTTPError: If there was some other form of HTTP error.

Returns:
  The authentication token returned by ClientLogin.

Definition at line 172 of file googletest/scripts/upload.py.

◆ _GetAuthToken() [2/2]

def upload.AbstractRpcServer._GetAuthToken	(	self,
		email,
		password
	)

private

Uses ClientLogin to authenticate the user, returning an auth token.

Args:
  email:    The user's email address
  password: The user's password

Raises:
  ClientLoginError: If there was an error authenticating with ClientLogin.
  HTTPError: If there was some other form of HTTP error.

Returns:
  The authentication token returned by ClientLogin.

Definition at line 172 of file googlemock/scripts/upload.py.

◆ _GetOpener() [1/2]

def upload.AbstractRpcServer._GetOpener ( self )

private

Returns an OpenerDirector for making HTTP requests.

Returns:
  A urllib2.OpenerDirector object.

Reimplemented in upload.HttpRpcServer, and upload.HttpRpcServer.

Definition at line 154 of file googletest/scripts/upload.py.

◆ _GetOpener() [2/2]

def upload.AbstractRpcServer._GetOpener ( self )

private

Returns an OpenerDirector for making HTTP requests.

Returns:
  A urllib2.OpenerDirector object.

Reimplemented in upload.HttpRpcServer, and upload.HttpRpcServer.

Definition at line 154 of file googlemock/scripts/upload.py.

◆ Send() [1/2]

def upload.AbstractRpcServer.Send	(		self,
			request_path,
			payload = `None`,
			content_type = `"application/octet-stream"`,
			timeout = `None`,
		**	kwargs
	)

Sends an RPC and returns the response.

Args:
  request_path: The path to send the request to, eg /api/appversion/create.
  payload: The body of the request, or None to send an empty request.
  content_type: The Content-Type header to use.
  timeout: timeout in seconds; default None i.e. no timeout.
(Note: for large requests on OS X, the timeout doesn't work right.)
  kwargs: Any keyword arguments are converted into query string parameters.

Returns:
  The response body, as a string.

Definition at line 291 of file googlemock/scripts/upload.py.

◆ Send() [2/2]

def upload.AbstractRpcServer.Send	(		self,
			request_path,
			payload = `None`,
			content_type = `"application/octet-stream"`,
			timeout = `None`,
		**	kwargs
	)

Sends an RPC and returns the response.

Args:
  request_path: The path to send the request to, eg /api/appversion/create.
  payload: The body of the request, or None to send an empty request.
  content_type: The Content-Type header to use.
  timeout: timeout in seconds; default None i.e. no timeout.
(Note: for large requests on OS X, the timeout doesn't work right.)
  kwargs: Any keyword arguments are converted into query string parameters.

Returns:
  The response body, as a string.

Definition at line 291 of file googletest/scripts/upload.py.