FitTrackee/fittrackee/workouts/sports.py

347 lines
8.2 KiB
Python
Raw Normal View History

2021-01-02 19:28:03 +01:00
from typing import Dict, Union
2021-01-01 16:39:25 +01:00
from fittrackee import db
from fittrackee.responses import (
DataNotFoundErrorResponse,
2021-01-02 19:28:03 +01:00
HttpResponse,
2021-01-01 16:39:25 +01:00
InvalidPayloadErrorResponse,
handle_error_and_return_response,
)
from flask import Blueprint, request
2018-05-01 16:17:12 +02:00
from sqlalchemy import exc
from ..users.models import User
2018-05-09 16:50:30 +02:00
from ..users.utils import authenticate, authenticate_as_admin
2018-05-01 16:17:12 +02:00
from .models import Sport
sports_blueprint = Blueprint('sports', __name__)
@sports_blueprint.route('/sports', methods=['GET'])
@authenticate
2021-01-02 19:28:03 +01:00
def get_sports(auth_user_id: int) -> Dict:
"""
Get all sports
**Example request**:
.. sourcecode:: http
GET /api/sports HTTP/1.1
Content-Type: application/json
**Example response**:
- for non admin user :
.. sourcecode:: http
HTTP/1.1 200 OK
Content-Type: application/json
{
"data": {
"sports": [
{
"id": 1,
"img": "/img/sports/cycling-sport.png",
"is_active": true,
"label": "Cycling (Sport)"
},
{
"id": 2,
"img": "/img/sports/cycling-transport.png",
"is_active": true,
"label": "Cycling (Transport)"
},
{
"id": 3,
"img": "/img/sports/hiking.png",
"is_active": true,
"label": "Hiking"
},
{
"id": 4,
"img": "/img/sports/mountain-biking.png",
"is_active": true,
"label": "Mountain Biking"
},
{
"id": 5,
"img": "/img/sports/running.png",
"is_active": true,
"label": "Running"
},
{
"id": 6,
"img": "/img/sports/walking.png",
"is_active": true,
"label": "Walking"
}
]
},
"status": "success"
}
- for admin user :
.. sourcecode:: http
HTTP/1.1 200 OK
Content-Type: application/json
{
"data": {
"sports": [
{
"has_workouts": true,
"id": 1,
"img": "/img/sports/cycling-sport.png",
"is_active": true,
"label": "Cycling (Sport)"
},
{
"has_workouts": false,
"id": 2,
"img": "/img/sports/cycling-transport.png",
"is_active": true,
"label": "Cycling (Transport)"
},
{
"has_workouts": false,
"id": 3,
"img": "/img/sports/hiking.png",
"is_active": true,
"label": "Hiking"
},
{
"has_workouts": false,
"id": 4,
"img": "/img/sports/mountain-biking.png",
"is_active": true,
"label": "Mountain Biking"
},
{
"has_workouts": false,
"id": 5,
"img": "/img/sports/running.png",
"is_active": true,
"label": "Running"
},
{
"has_workouts": false,
"id": 6,
"img": "/img/sports/walking.png",
"is_active": true,
"label": "Walking"
}
]
},
"status": "success"
}
:param integer auth_user_id: authenticate user id (from JSON Web Token)
:reqheader Authorization: OAuth 2.0 Bearer Token
:statuscode 200: success
:statuscode 401:
- Provide a valid auth token.
- Signature expired. Please log in again.
- Invalid token. Please log in again.
"""
user = User.query.filter_by(id=int(auth_user_id)).first()
2018-05-01 16:17:12 +02:00
sports = Sport.query.order_by(Sport.id).all()
2021-01-01 16:39:25 +01:00
return {
2018-05-01 16:17:12 +02:00
'status': 'success',
'data': {'sports': [sport.serialize(user.admin) for sport in sports]},
2018-05-01 16:17:12 +02:00
}
@sports_blueprint.route('/sports/<int:sport_id>', methods=['GET'])
@authenticate
2021-01-02 19:28:03 +01:00
def get_sport(auth_user_id: int, sport_id: int) -> Union[Dict, HttpResponse]:
"""
Get a sport
**Example request**:
.. sourcecode:: http
GET /api/sports/1 HTTP/1.1
Content-Type: application/json
**Example response**:
- success for non admin user :
.. sourcecode:: http
HTTP/1.1 200 OK
Content-Type: application/json
{
"data": {
"sports": [
{
"id": 1,
"img": "/img/sports/cycling-sport.png",
"is_active": true,
"label": "Cycling (Sport)"
}
]
},
"status": "success"
}
- success for admin user :
.. sourcecode:: http
HTTP/1.1 200 OK
Content-Type: application/json
{
"data": {
"sports": [
{
"has_workouts": false,
"id": 1,
"img": "/img/sports/cycling-sport.png",
"is_active": true,
"label": "Cycling (Sport)"
}
]
},
"status": "success"
}
- sport not found
.. sourcecode:: http
HTTP/1.1 404 NOT FOUND
Content-Type: application/json
{
"data": {
"sports": []
},
"status": "not found"
}
:param integer auth_user_id: authenticate user id (from JSON Web Token)
:param integer sport_id: sport id
:reqheader Authorization: OAuth 2.0 Bearer Token
:statuscode 200: success
:statuscode 401:
- Provide a valid auth token.
- Signature expired. Please log in again.
- Invalid token. Please log in again.
:statuscode 404: sport not found
"""
user = User.query.filter_by(id=int(auth_user_id)).first()
2018-05-01 16:17:12 +02:00
sport = Sport.query.filter_by(id=sport_id).first()
if sport:
2021-01-01 16:39:25 +01:00
return {
2018-05-01 16:17:12 +02:00
'status': 'success',
'data': {'sports': [sport.serialize(user.admin)]},
2018-05-01 16:17:12 +02:00
}
2021-01-01 16:39:25 +01:00
return DataNotFoundErrorResponse('sports')
2018-05-01 16:17:12 +02:00
@sports_blueprint.route('/sports/<int:sport_id>', methods=['PATCH'])
@authenticate_as_admin
2021-01-02 19:28:03 +01:00
def update_sport(
auth_user_id: int, sport_id: int
) -> Union[Dict, HttpResponse]:
"""
Update a sport
Authenticated user must be an admin
**Example request**:
2019-08-28 13:25:39 +02:00
.. sourcecode:: http
2018-05-01 16:17:12 +02:00
PATCH /api/sports/1 HTTP/1.1
Content-Type: application/json
2018-05-01 16:17:12 +02:00
**Example response**:
2018-05-01 16:17:12 +02:00
- success
2018-05-01 16:17:12 +02:00
.. sourcecode:: http
HTTP/1.1 200 OK
Content-Type: application/json
{
"data": {
"sports": [
{
"has_workouts": false,
"id": 1,
"img": "/img/sports/cycling-sport.png",
"is_active": false,
"label": "Cycling (Sport)"
2018-05-01 16:17:12 +02:00
}
]
},
"status": "success"
}
2018-05-01 16:17:12 +02:00
- sport not found
.. sourcecode:: http
HTTP/1.1 404 NOT FOUND
Content-Type: application/json
{
"data": {
"sports": []
},
"status": "not found"
}
:param integer auth_user_id: authenticate user id (from JSON Web Token)
:param integer sport_id: sport id
:<json string is_active: sport active status
:reqheader Authorization: OAuth 2.0 Bearer Token
:statuscode 200: sport 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 403: You do not have permissions.
:statuscode 404: sport not found
:statuscode 500:
"""
sport_data = request.get_json()
if not sport_data or sport_data.get('is_active') is None:
2021-01-01 16:39:25 +01:00
return InvalidPayloadErrorResponse()
2018-05-01 16:17:12 +02:00
try:
sport = Sport.query.filter_by(id=sport_id).first()
2021-01-01 16:39:25 +01:00
if not sport:
return DataNotFoundErrorResponse('sports')
sport.is_active = sport_data.get('is_active')
db.session.commit()
return {
'status': 'success',
'data': {'sports': [sport.serialize(True)]},
2018-05-01 16:17:12 +02:00
}
2021-01-01 16:39:25 +01:00
except (exc.IntegrityError, exc.OperationalError, ValueError) as e:
return handle_error_and_return_response(e, db=db)