instant messenger written in pure python

all communication with the socket should send JSON, and should always include a type key that corresponds to the desired endpoint.

• Arguments:

• • username | string | username of desired user
• • pin | int | pin of user

• Expected response:

• • {'type': 'resp', 'id': user id }

• Error response:

• • {'type': 'error', 'error': 'acc not found'}

• Arguments:

• • username | string | desired username
• • pin | string | desired pin

• Expected response:

• • {'type': 'create_acc_resp', 'id': user id }

• Error response:

• • {'type': 'error', 'error': 'username is taken'}
• • {'type': 'error', 'error': 'failed to create account'}

• Arguments:

• • recipient | id (int) | user to send a message too
• • content | string | message content to send

• Expected response:

• • {'type': 'send_resp', 'status' 'success'}

• Error response:

• • {'type': 'error', 'error': ' recipient is not connected to the network'}

• Arguments:

• • none

• Expected response:

• • {'type': 'friends_resp', 'friends': [{'username': Username , 'id': id }]}

• Error response:

• • {'type': 'error', 'error': 'failed to get friends'}

• Arguments:

• • user | id (int) | user to send a friend request to

• Expected response:

• • {'type': 'request_resp', 'status': 'sent'}

• Error response:

• • {'type': 'error', 'error': 'failed to send friend request to user '}

• Arguments:

• • user | id (int) | id of the user to accept a request from

• Expected response:

• • {'type': 'add_resp', 'status': 'added'}

• Arguments:

• • user | id (int) | id of the user to deny a request from

• Expected response:

• • {'type': 'deny_resp', 'status': 'success'}

all socket events send JSON, they always include a type key, all expected data is included in the json.

• Expected data:
• • user | id (int) | id of user who sent a request

• Expected data:
• • sender | id (int) | id of user who sent a message
• • content | string | content of the message

-> is data you send to the socket

<- is data you recieve from the socket

| means a possible alternative of the previous line (usually an error type)

• Authorization:

• • Login:

• • • -> {'type': 'login', 'username': 'EpicUserName', 'pin': 'password123'}
• • • <- {'type': 'resp', 'id': '12345678'}

• • Creating an account:

• • • -> {'type': 'create_acc', 'username': 'EpicUserName2', 'pin': 'password1234'}
• • • <- {'type': 'create_acc_resp', 'id': '12345678'}
• • • | {'type': 'error', 'error': 'username is taken'}
• • • | {'type': 'error', 'error': 'failed to create account'}

all rest endpoints expect arguments in query strings

• Arguments:

• • id | id (int) | id of user to get

• Expected response:

• • {'user': {'username': 'EpicUserName'}}