Alexander/FitTrackee
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Docs - add 'fr' translation + fixes

Browse Source
This commit is contained in:
Sam
2023-06-18 20:45:39 +02:00
parent bf1e12f35d
commit 4491b8f8de
69 changed files with 3783 additions and 3385 deletions
Download Patch File Download Diff File Expand all files Collapse all files

250
fittrackee/users/auth.py
View File

@ -91,7 +91,7 @@ def register_user() -> Union[Tuple[Dict, int], HttpResponse]:
**Example responses**:
- success
- success:
.. sourcecode:: http
@ -102,7 +102,7 @@ def register_user() -> Union[Tuple[Dict, int], HttpResponse]:
"status": "success"
}
- error on registration
- error on registration:
.. sourcecode:: http
@ -121,21 +121,18 @@ def register_user() -> Union[Tuple[Dict, int], HttpResponse]:
fallback to 'en' (english))
:<json boolean accepted_policy: ``true`` if user accepted privacy policy
:statuscode 200: success
:statuscode 200: ``success``
:statuscode 400:
- invalid payload
- sorry, that username is already taken
- Errors:
- username: 3 to 30 characters required
- username:
only alphanumeric characters and the underscore
character "_" allowed
- email: valid email must be provided
- password: 8 characters required
:statuscode 403:
error, registration is disabled
:statuscode 500:
error, please try again or contact the administrator
- ``invalid payload``
- ``sorry, that username is already taken``
- ``sorry, you must agree privacy policy to register``
- ``username: 3 to 30 characters required``
- ``username: only alphanumeric characters and the underscore
character "_" allowed``
- ``email: valid email must be provided``
- ``password: 8 characters required``
:statuscode 403: ``error, registration is disabled``
:statuscode 500: ``error, please try again or contact the administrator``
"""
if not current_app.config.get('is_registration_enabled'):
return ForbiddenErrorResponse('error, registration is disabled')
@ -204,7 +201,7 @@ def login_user() -> Union[Dict, HttpResponse]:
**Example responses**:
- successful login
- successful login:
.. sourcecode:: http
@ -232,10 +229,10 @@ def login_user() -> Union[Dict, HttpResponse]:
:<json string email: user email
:<json string password: password
:statuscode 200: successfully logged in
:statuscode 400: invalid payload
:statuscode 401: invalid credentials
:statuscode 500: error, please try again or contact the administrator
:statuscode 200: ``successfully logged in``
:statuscode 400: ``invalid payload``
:statuscode 401: ``invalid credentials``
:statuscode 500: ``error, please try again or contact the administrator``
"""
# get post data
@ -373,11 +370,11 @@ def get_authenticated_user_profile(
:reqheader Authorization: OAuth 2.0 Bearer Token
:statuscode 200: success.
:statuscode 200: ``success``
:statuscode 401:
- provide a valid auth token
- signature expired, please log in again
- invalid token, please log in again
- ``provide a valid auth token``
- ``signature expired, please log in again``
- ``invalid token, please log in again``
"""
return {'status': 'success', 'data': auth_user.serialize(auth_user)}
@ -497,14 +494,13 @@ def edit_user(auth_user: User) -> Union[Dict, HttpResponse]:
:reqheader Authorization: OAuth 2.0 Bearer Token
:statuscode 200: user profile updated
:statuscode 400:
- invalid payload
:statuscode 200: ``user profile updated``
:statuscode 400: ``invalid payload``
:statuscode 401:
- provide a valid auth token
- signature expired, please log in again
- invalid token, please log in again
:statuscode 500: error, please try again or contact the administrator
- ``provide a valid auth token``
- ``signature expired, please log in again``
- ``invalid token, please log in again``
:statuscode 500: ``error, please try again or contact the administrator``
"""
# get post data
post_data = request.get_json()
@ -668,19 +664,19 @@ def update_user_account(auth_user: User) -> Union[Dict, HttpResponse]:
:reqheader Authorization: OAuth 2.0 Bearer Token
:statuscode 200: user account updated
:statuscode 200: ``user account updated``
:statuscode 400:
- invalid payload
- email is missing
- current password is missing
- email: valid email must be provided
- password: 8 characters required
- ``invalid payload``
- ``email is missing``
- ``current password is missing``
- ``email: valid email must be provided``
- ``password: 8 characters required``
:statuscode 401:
- provide a valid auth token
- signature expired, please log in again
- invalid token, please log in again
- invalid credentials
:statuscode 500: error, please try again or contact the administrator
- ``provide a valid auth token``
- ``signature expired, please log in again``
- ``invalid token, please log in again``
- ``invalid credentials``
:statuscode 500: ``error, please try again or contact the administrator``
"""
data = request.get_json()
if not data:
@ -901,15 +897,15 @@ def edit_user_preferences(auth_user: User) -> Union[Dict, HttpResponse]:
:reqheader Authorization: OAuth 2.0 Bearer Token
:statuscode 200: user preferences updated
:statuscode 200: ``user preferences updated``
:statuscode 400:
- invalid payload
- password: password and password confirmation don't match
- ``invalid payload``
- ``password: password and password confirmation don't match``
:statuscode 401:
- provide a valid auth token
- signature expired, please log in again
- invalid token, please log in again
:statuscode 500: error, please try again or contact the administrator
- ``provide a valid auth token``
- ``signature expired, please log in again``
- ``invalid token, please log in again``
:statuscode 500: ``error, please try again or contact the administrator``
"""
# get post data
post_data = request.get_json()
@ -999,17 +995,16 @@ def edit_user_sport_preferences(
:reqheader Authorization: OAuth 2.0 Bearer Token
:statuscode 200: user preferences updated
:statuscode 200: ``user sport preferences updated``
:statuscode 400:
- invalid payload
- invalid hexadecimal color
- ``invalid payload``
- ``invalid hexadecimal color``
:statuscode 401:
- provide a valid auth token
- signature expired, please log in again
- invalid token, please log in again
:statuscode 404:
- sport does not exist
:statuscode 500: error, please try again or contact the administrator
- ``provide a valid auth token``
- ``signature expired, please log in again``
- ``invalid token, please log in again``
:statuscode 404: ``sport does not exist``
:statuscode 500: ``error, please try again or contact the administrator``
"""
post_data = request.get_json()
if (
@ -1094,12 +1089,11 @@ def reset_user_sport_preferences(
:statuscode 204: user preferences deleted
:statuscode 401:
- provide a valid auth token
- signature expired, please log in again
- invalid token, please log in again
:statuscode 404:
- sport does not exist
:statuscode 500: error, please try again or contact the administrator
- ``provide a valid auth token``
- ``signature expired, please log in again``
- ``invalid token, please log in again``
:statuscode 404: ``sport does not exist``
:statuscode 500: ``error, please try again or contact the administrator``
"""
sport = Sport.query.filter_by(id=sport_id).first()
if not sport:
@ -1151,18 +1145,18 @@ def edit_picture(auth_user: User) -> Union[Dict, HttpResponse]:
:reqheader Authorization: OAuth 2.0 Bearer Token
:statuscode 200: user picture updated
:statuscode 200: ``user picture updated``
:statuscode 400:
- invalid payload
- no file part
- no selected file
- file extension not allowed
- ``invalid payload``
- ``no file part``
- ``no selected file``
- ``file extension not allowed``
:statuscode 401:
- provide a valid auth token
- signature expired, please log in again
- invalid token, please log in again
:statuscode 413: error during picture update: file size exceeds 1.0MB
:statuscode 500: error during picture update
- ``provide a valid auth token``
- ``signature expired, please log in again``
- ``invalid token, please log in again``
:statuscode 413: ``error during picture update: file size exceeds 1.0MB``
:statuscode 500: ``error during picture update``
"""
try:
response_object = get_error_response_if_file_is_invalid(
@ -1235,10 +1229,10 @@ def del_picture(auth_user: User) -> Union[Tuple[Dict, int], HttpResponse]:
:statuscode 204: picture deleted
:statuscode 401:
- provide a valid auth token
- signature expired, please log in again
- invalid token, please log in again
:statuscode 500: error during picture deletion
- ``provide a valid auth token``
- ``signature expired, please log in again``
- ``invalid token, please log in again``
:statuscode 500: ``error during picture deletion``
"""
try:
@ -1282,9 +1276,9 @@ def request_password_reset() -> Union[Dict, HttpResponse]:
:<json string email: user email
:statuscode 200: password reset request processed
:statuscode 400: invalid payload
:statuscode 404: the requested URL was not found on the server
:statuscode 200: ``password reset request processed``
:statuscode 400: ``invalid payload``
:statuscode 404: ``the requested URL was not found on the server``
"""
if not current_app.config['CAN_SEND_EMAILS']:
@ -1353,10 +1347,10 @@ def update_password() -> Union[Dict, HttpResponse]:
:<json string password: password (8 characters required)
:<json string token: password reset token
:statuscode 200: password updated
:statuscode 400: invalid payload
:statuscode 401: invalid token, please request a new token
:statuscode 500: error, please try again or contact the administrator
:statuscode 200: ``password updated``
:statuscode 400: ``invalid payload``
:statuscode 401: ``invalid token, please request a new token``
:statuscode 500: ``error, please try again or contact the administrator``
"""
post_data = request.get_json()
@ -1433,9 +1427,9 @@ def update_email() -> Union[Dict, HttpResponse]:
:<json string token: password reset token
:statuscode 200: email updated
:statuscode 400: invalid payload
:statuscode 500: error, please try again or contact the administrator
:statuscode 200: ``email updated``
:statuscode 400: ``invalid payload``
:statuscode 500: ``error, please try again or contact the administrator``
"""
post_data = request.get_json()
@ -1493,9 +1487,9 @@ def confirm_account() -> Union[Dict, HttpResponse]:
:<json string token: confirmation token
:statuscode 200: account confirmation successful
:statuscode 400: invalid payload
:statuscode 500: error, please try again or contact the administrator
:statuscode 200: ``account confirmation successful``
:statuscode 400: ``invalid payload``
:statuscode 500: ``error, please try again or contact the administrator``
"""
post_data = request.get_json()
@ -1556,10 +1550,10 @@ def resend_account_confirmation_email() -> Union[Dict, HttpResponse]:
:<json string email: user email
:statuscode 200: confirmation email resent
:statuscode 400: invalid payload
:statuscode 404: the requested URL was not found on the server
:statuscode 500: error, please try again or contact the administrator
:statuscode 200: ``confirmation email resent``
:statuscode 400: ``invalid payload``
:statuscode 404: ``the requested URL was not found on the server``
:statuscode 500: ``error, please try again or contact the administrator``
"""
if not current_app.config['CAN_SEND_EMAILS']:
@ -1603,7 +1597,7 @@ def logout_user(auth_user: User) -> Union[Tuple[Dict, int], HttpResponse]:
**Example responses**:
- successful logout
- successful logout:
.. sourcecode:: http
@ -1615,7 +1609,7 @@ def logout_user(auth_user: User) -> Union[Tuple[Dict, int], HttpResponse]:
"status": "success"
}
- error on logout
- error on logout:
.. sourcecode:: http
@ -1629,13 +1623,12 @@ def logout_user(auth_user: User) -> Union[Tuple[Dict, int], HttpResponse]:
:reqheader Authorization: OAuth 2.0 Bearer Token
:statuscode 200: successfully logged out
:statuscode 200: ``successfully logged out``
:statuscode 401:
- provide a valid auth token
- The access token provided is expired, revoked, malformed, or invalid
for other reasons.
:statuscode 500:
- error on token blacklist
- ``provide a valid auth token``
- ``The access token provided is expired, revoked, malformed, or invalid
for other reasons.``
:statuscode 500: ``error on token blacklist``
"""
auth_token = request.headers.get('Authorization', '').split(' ')[1]
@ -1682,14 +1675,13 @@ def accept_privacy_policy(auth_user: User) -> Union[Dict, HttpResponse]:
:reqheader Authorization: OAuth 2.0 Bearer Token
:statuscode 200: success
:statuscode 400:
- invalid payload
:statuscode 200: ``success``
:statuscode 400: ``invalid payload``
:statuscode 401:
- provide a valid auth token
- signature expired, please log in again
- invalid token, please log in again
:statuscode 500: internal server error
- ``provide a valid auth token``
- ``signature expired, please log in again``
- ``invalid token, please log in again``
:statuscode 500: ``error, please try again or contact the administrator``
"""
post_data = request.get_json()
if not post_data or not post_data.get('accepted_policy'):
@ -1738,15 +1730,15 @@ def request_user_data_export(auth_user: User) -> Union[Dict, HttpResponse]:
:reqheader Authorization: OAuth 2.0 Bearer Token
:statuscode 200: success
:statuscode 200: ``success``
:statuscode 400:
- ongoing request exists
- completed request already exists
- ``ongoing request exists``
- ``completed request already exists``
:statuscode 401:
- provide a valid auth token
- signature expired, please log in again
- invalid token, please log in again
:statuscode 500: internal server error
- ``provide a valid auth token``
- ``signature expired, please log in again``
- ``invalid token, please log in again``
:statuscode 500: ``error, please try again or contact the administrator``
"""
existing_export_request = UserDataExport.query.filter_by(
user_id=auth_user.id
@ -1800,7 +1792,7 @@ def get_user_data_export(auth_user: User) -> Union[Dict, HttpResponse]:
**Example response**:
- if a request exists
- if a request exists:
.. sourcecode:: http
@ -1817,7 +1809,7 @@ def get_user_data_export(auth_user: User) -> Union[Dict, HttpResponse]:
}
}
- if no request
- if no request:
.. sourcecode:: http
@ -1831,11 +1823,11 @@ def get_user_data_export(auth_user: User) -> Union[Dict, HttpResponse]:
:reqheader Authorization: OAuth 2.0 Bearer Token
:statuscode 200: success
:statuscode 200: ``success``
:statuscode 401:
- provide a valid auth token
- signature expired, please log in again
- invalid token, please log in again
- ``provide a valid auth token``
- ``signature expired, please log in again``
- ``invalid token, please log in again``
"""
export_request = UserDataExport.query.filter_by(
user_id=auth_user.id
@ -1874,12 +1866,12 @@ def download_data_export(
:reqheader Authorization: OAuth 2.0 Bearer Token
:statuscode 200: success
:statuscode 200: ``success``
:statuscode 401:
- provide a valid auth token
- signature expired, please log in again
- invalid token, please log in again
:statuscode 404: file not found
- ``provide a valid auth token``
- ``signature expired, please log in again``
- ``invalid token, please log in again``
:statuscode 404: ``file not found``
"""
export_request = UserDataExport.query.filter_by(
user_id=auth_user.id

64
fittrackee/users/users.py
View File

@ -47,14 +47,14 @@ def get_users(auth_user: User) -> Dict:
**Example request**:
- without parameters
- without parameters:
.. sourcecode:: http
GET /api/users HTTP/1.1
Content-Type: application/json
- with some query parameters
- with some query parameters:
.. sourcecode:: http
@ -180,11 +180,11 @@ def get_users(auth_user: User) -> Dict:
:reqheader Authorization: OAuth 2.0 Bearer Token
:statuscode 200: success
:statuscode 200: ``success``
:statuscode 401:
- provide a valid auth token
- signature expired, please log in again
- invalid token, please log in again
- ``provide a valid auth token``
- ``signature expired, please log in again``
- ``invalid token, please log in again``
"""
params = request.args.copy()
@ -325,13 +325,13 @@ def get_single_user(
:reqheader Authorization: OAuth 2.0 Bearer Token
:statuscode 200: success
:statuscode 200: ``success``
:statuscode 401:
- provide a valid auth token
- signature expired, please log in again
- invalid token, please log in again
- ``provide a valid auth token``
- ``signature expired, please log in again``
- ``invalid token, please log in again``
:statuscode 404:
- user does not exist
- ``user does not exist``
"""
if user_name != auth_user.username and not auth_user.admin:
return ForbiddenErrorResponse()
@ -369,10 +369,10 @@ def get_picture(user_name: str) -> Any:
:param integer user_name: user name
:statuscode 200: success
:statuscode 200: ``success``
:statuscode 404:
- user does not exist
- No picture.
- ``user does not exist``
- ``No picture.``
"""
try:
@ -504,19 +504,18 @@ def update_user(auth_user: User, user_name: str) -> Union[Dict, HttpResponse]:
:reqheader Authorization: OAuth 2.0 Bearer Token
:statuscode 200: success
:statuscode 200: ``success``
:statuscode 400:
- invalid payload
- valid email must be provided
- new email must be different than curent email
- ``invalid payload``
- ``valid email must be provided``
- ``new email must be different than curent email``
:statuscode 401:
- provide a valid auth token
- signature expired, please log in again
- invalid token, please log in again
:statuscode 403: you do not have permissions
:statuscode 404:
- user does not exist
:statuscode 500:
- ``provide a valid auth token``
- ``signature expired, please log in again``
- ``invalid token, please log in again``
:statuscode 403: ``you do not have permissions``
:statuscode 404: ``user does not exist``
:statuscode 500: ``error, please try again or contact the administrator``
"""
user_data = request.get_json()
if not user_data:
@ -632,15 +631,14 @@ def delete_user(
:statuscode 204: user account deleted
:statuscode 401:
- provide a valid auth token
- signature expired, please log in again
- invalid token, please log in again
- ``provide a valid auth token``
- ``signature expired, please log in again``
- ``invalid token, please log in again``
:statuscode 403:
- you do not have permissions
- you can not delete your account, no other user has admin rights
:statuscode 404:
- user does not exist
:statuscode 500: error, please try again or contact the administrator
- ``you do not have permissions``
- ``you can not delete your account, no other user has admin rights``
:statuscode 404: ``user does not exist``
:statuscode 500: ``error, please try again or contact the administrator``
"""
try: