DB connection class

class db.dbConnection.DbConnectionClass(dbi, config)

Class containing methods for DB management

Methods

verify(email, password)	Verifies the credentials.
identity(payload)	Returns an object with user_id field.
is_admin(identity)	Returns 1 if the user with given id has administrative rights.
check_if_email_exists(email)	Returns true if email already exists in DB.
create_user(email, uses, is_admin)	Creates a new user.
authenticate(email, password)	Returns User object if proper credentials.
get_users_available_uses(id)	Returns amount of available POST requests for given user’s id.
reduce_uses(id)	Reduces available user’s uses by 1.
save_request(request_type, request_url, …)	Saves request details in DB.

authenticate(email, password)

Returns User object if proper credentials. Otherwise returns None.

Parameters:

email: str

Users email.

password: str

Users password.

check_if_email_exists(email)

Returns true if email already exists in DB.

Parameters:

email: str

Email to check.

Returns:

bool

create_user(email, uses, is_admin)

Creates a new user.

Parameters:

email: str

Users email.

uses: int

Users uses.

is_admin: int

Bool cast. 1 if the user has to be admin.

get_users_available_uses(id)

Returns amount of available POST requests for given user’s id.

Parameters:

id: int

Users ID.

Returns:

int

identity(payload)

Returns an object with user_id field.

Parameters:

payload: list

Returns:

dict

is_admin(identity)

Returns 1 if the user with given id has administrative rights.

Parameters:

identity: int

Users ID.

Returns:

bool

reduce_uses(id)

Reduces available user’s uses by 1.

Parameters:

id: int

Users ID.

Returns:

int

save_request(request_type, request_url, response, user_id, headers, is_xhr, data_type, data)

Saves request details in DB.

Parameters:

request_type: str

Request type (POST, PUT etc.)

request_url: str

Requests URL e.g http://localhost:8000/v2/test1

response: str

Models response to the request

user_id: int

ID of user that sent request

headers: str

Headers sent with the request

is_xhr: bool

Was the request a XHR request.

data_type: char

Type of data sent ‘I’ - image etc.

data: str

Path to saved image or text.

verify(email, password)

Verifies the credentials.

Parameters:

email: str

Users email.

password: str

Users password.

Returns:

db.dbModels.User or None