Riki-Usermanager 1.0

User Manager utilities for the Riki

Riki UserManager

Classes for handling user CRUD and login/logout for CSC485 project.

riki_usermanager

riki_usermanager.User

AuthMethodEnum Objects

class AuthMethodEnum(Enum)

Enum that stores supported authentication methods

User Objects

@dataclass
class User()

Represents User entry in the sqlite3 database

Variables: * username (str): The user's name. Used as the primary key in the database. * password (str): The user's password. Stored as text in sqlite. * roles (str): The roles a user has. It's a list of string, but will be stored as a single text value in sqlite. * authentication_method (int): Used to reference an authentication method by number. * authenticated (bool): Flag for whether a user has been authenticated. Stored in sqlite as an int. * hash (str): Stored result if password has been hashed. * anonymous (bool): Flag for anonymous users. Since a registered user is not anonymous, this is not stored in sqlite.

is_authenticated

 | is_authenticated()

Returns whether the User is authenticated.

Arguments:

• self int - The current instance of User

Returns:

bool:authentication state

is_active

 | is_active()

Returns whether the User is active. Required by flask-login.

Arguments:

• self int - The current instance of User

Returns:

bool:active state

is_anonymous

 | is_anonymous()

Returns whether the User is anonymous. In this case, all users are not.

Arguments:

• self int - The current instance of User

Returns:

bool:anonymous state

get_id

 | get_id()

Returns the username of a user. Required by flask-login.

Arguments:

• self int - The current instance of User

Returns:

str:username

from_dict

 | @staticmethod
 | from_dict(user: Dict[str, Any]) -> 'User'

converts array of sql data into dictionary

Arguments:

• data List[str] - sql array of data

Returns:

Dict[str, Any]: Dictionary of values

riki_usermanager.UserManager

UserManager Objects

class UserManager()

A very simple User Manager, that manages User objects and writes them to database

__init__

 | __init__(db: sqlite3.Connection)

Create UserManager object

Args:

• db (sqlite3.Connection): preexisting sqlite3 connection object

login

 | login(username: str, password: str) -> Union[User, Literal[False]]

Logins in a user after username and password have been validated

Arguments:

• username String - username

Returns:

• bool - True on success, else False

logout

 | logout(user: User) -> bool

Logs out the current user

Returns:

• bool - True on success, else False

register

 | register(user: 'User') -> Union['User', Literal[False]]

Creates a new user and authenticates a new user after username and password are validated

Arguments:

• user User - User object

Returns:

• bool - True on success, else False

unregister

 | unregister(user: User) -> bool

Deletes current user's profile

Returns:

• bool - True on success, else False

add_user

 | add_user(user: 'User') -> Union[User, Literal[False]]

Creates new user in the database

Arguments:

• user User - User object

Raises:

• NotImplementedError - if authentication method is not implemented

Returns:

• bool - True on success, else False

get_user

 | get_user(username: str) -> Union['User', None]

Get User from the database

Args:

• name (str): users name

Returns:

• User | None: User object if user with the given username is found, otherwise nothing is returned.

delete_user

 | delete_user(username: str) -> bool

Deletes user from the database

Arguments:

• name str - users username

Returns:

• bool - True if delete was successful, otherwise False

update

 | update(user: 'User') -> bool

Update user from userdata dictionary

Arguments:

• name str - users username
• userdata Dict[str, Any] - dictionary of user data

Returns:

• bool - True if delete was successful, otherwise False

check_password

 | @staticmethod
 | check_password(user: User, password: str) -> bool

Check if user password matches the password in the database

Arguments:

• password str - user password

Returns:

• bool - did password match