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

API - add uuid to activity and return it instead of id to client - #57

Browse Source
This commit is contained in:
Sam
2020-12-30 19:37:59 +01:00
parent 6f627ef6c9
commit 3af845f18c
18 changed files with 601 additions and 595 deletions
Download Patch File Download Diff File Expand all files Collapse all files

124
fittrackee/activities/activities.py
View File

@ -76,7 +76,7 @@ def get_activities(auth_user_id):
"descent": null,
"distance": 10.0,
"duration": "0:17:04",
"id": 1,
"id": "f03265f69fe0489b812fc7dc4deff55e",
"map": null,
"max_alt": null,
"max_speed": 10.0,
@ -90,7 +90,7 @@ def get_activities(auth_user_id):
"records": [
{
"activity_date": "Mon, 01 Jan 2018 00:00:00 GMT",
"activity_id": 1,
"activity_id": "f03265f69fe0489b812fc7dc4deff55e",
"id": 4,
"record_type": "MS",
"sport_id": 1,
@ -99,7 +99,7 @@ def get_activities(auth_user_id):
},
{
"activity_date": "Mon, 01 Jan 2018 00:00:00 GMT",
"activity_id": 1,
"activity_id": "f03265f69fe0489b812fc7dc4deff55e",
"id": 3,
"record_type": "LD",
"sport_id": 1,
@ -108,7 +108,7 @@ def get_activities(auth_user_id):
},
{
"activity_date": "Mon, 01 Jan 2018 00:00:00 GMT",
"activity_id": 1,
"activity_id": "f03265f69fe0489b812fc7dc4deff55e",
"id": 2,
"record_type": "FD",
"sport_id": 1,
@ -117,7 +117,7 @@ def get_activities(auth_user_id):
},
{
"activity_date": "Mon, 01 Jan 2018 00:00:00 GMT",
"activity_id": 1,
"activity_id": "f03265f69fe0489b812fc7dc4deff55e",
"id": 1,
"record_type": "AS",
"sport_id": 1,
@ -269,9 +269,11 @@ def get_activities(auth_user_id):
return jsonify(response_object), code
@activities_blueprint.route('/activities/<int:activity_id>', methods=['GET'])
@activities_blueprint.route(
'/activities/<string:activity_uuid>', methods=['GET']
)
@authenticate
def get_activity(auth_user_id, activity_id):
def get_activity(auth_user_id, activity_uuid):
"""
Get an activity
@ -279,7 +281,7 @@ def get_activity(auth_user_id, activity_id):
.. sourcecode:: http
GET /api/activities/3 HTTP/1.1
GET /api/activities/f03265f69fe0489b812fc7dc4deff55e HTTP/1.1
**Example responses**:
@ -302,7 +304,7 @@ def get_activity(auth_user_id, activity_id):
"descent": null,
"distance": 12,
"duration": "0:45:00",
"id": 3,
"id": "f03265f69fe0489b812fc7dc4deff55e",
"map": null,
"max_alt": null,
"max_speed": 16,
@ -342,7 +344,7 @@ def get_activity(auth_user_id, activity_id):
}
:param integer auth_user_id: authenticate user id (from JSON Web Token)
:param integer activity_id: activity id
:param integer activity_uuid: activity uuid
:reqheader Authorization: OAuth 2.0 Bearer Token
@ -355,7 +357,7 @@ def get_activity(auth_user_id, activity_id):
:statuscode 404: activity not found
"""
activity = Activity.query.filter_by(id=activity_id).first()
activity = Activity.query.filter_by(uuid=activity_uuid).first()
activities_list = []
if activity:
@ -379,9 +381,9 @@ def get_activity(auth_user_id, activity_id):
return jsonify(response_object), code
def get_activity_data(auth_user_id, activity_id, data_type, segment_id=None):
def get_activity_data(auth_user_id, activity_uuid, data_type, segment_id=None):
"""Get data from an activity gpx file"""
activity = Activity.query.filter_by(id=activity_id).first()
activity = Activity.query.filter_by(uuid=activity_uuid).first()
content = ''
if activity:
response_object, code = can_view_activity(
@ -390,7 +392,7 @@ def get_activity_data(auth_user_id, activity_id, data_type, segment_id=None):
if response_object:
return jsonify(response_object), code
if not activity.gpx or activity.gpx == '':
message = f'No gpx file for this activity (id: {activity_id})'
message = f'No gpx file for this activity (id: {activity_uuid})'
response_object = {'status': 'error', 'message': message}
return jsonify(response_object), 404
@ -420,7 +422,7 @@ def get_activity_data(auth_user_id, activity_id, data_type, segment_id=None):
code = 200
else:
status = 'not found'
message = f'Activity not found (id: {activity_id})'
message = f'Activity not found (id: {activity_uuid})'
code = 404
response_object = {
@ -436,10 +438,10 @@ def get_activity_data(auth_user_id, activity_id, data_type, segment_id=None):
@activities_blueprint.route(
'/activities/<int:activity_id>/gpx', methods=['GET']
'/activities/<string:activity_uuid>/gpx', methods=['GET']
)
@authenticate
def get_activity_gpx(auth_user_id, activity_id):
def get_activity_gpx(auth_user_id, activity_uuid):
"""
Get gpx file for an activity displayed on map with Leaflet
@ -447,7 +449,7 @@ def get_activity_gpx(auth_user_id, activity_id):
.. sourcecode:: http
GET /api/activities/3/gpx HTTP/1.1
GET /api/activities/f03265f69fe0489b812fc7dc4deff55e/gpx HTTP/1.1
Content-Type: application/json
**Example response**:
@ -466,7 +468,7 @@ def get_activity_gpx(auth_user_id, activity_id):
}
:param integer auth_user_id: authenticate user id (from JSON Web Token)
:param integer activity_id: activity id
:param integer activity_uuid: activity uuid
:reqheader Authorization: OAuth 2.0 Bearer Token
@ -481,14 +483,14 @@ def get_activity_gpx(auth_user_id, activity_id):
:statuscode 500:
"""
return get_activity_data(auth_user_id, activity_id, 'gpx')
return get_activity_data(auth_user_id, activity_uuid, 'gpx')
@activities_blueprint.route(
'/activities/<int:activity_id>/chart_data', methods=['GET']
'/activities/<string:activity_uuid>/chart_data', methods=['GET']
)
@authenticate
def get_activity_chart_data(auth_user_id, activity_id):
def get_activity_chart_data(auth_user_id, activity_uuid):
"""
Get chart data from an activity gpx file, to display it with Recharts
@ -496,7 +498,7 @@ def get_activity_chart_data(auth_user_id, activity_id):
.. sourcecode:: http
GET /api/activities/3/chart HTTP/1.1
GET /api/activities/f03265f69fe0489b812fc7dc4deff55e/chart HTTP/1.1
Content-Type: application/json
**Example response**:
@ -534,7 +536,7 @@ def get_activity_chart_data(auth_user_id, activity_id):
}
:param integer auth_user_id: authenticate user id (from JSON Web Token)
:param integer activity_id: activity id
:param integer activity_uuid: activity uuid
:reqheader Authorization: OAuth 2.0 Bearer Token
@ -549,15 +551,15 @@ def get_activity_chart_data(auth_user_id, activity_id):
:statuscode 500:
"""
return get_activity_data(auth_user_id, activity_id, 'chart')
return get_activity_data(auth_user_id, activity_uuid, 'chart')
@activities_blueprint.route(
'/activities/<int:activity_id>/gpx/segment/<int:segment_id>',
'/activities/<string:activity_uuid>/gpx/segment/<int:segment_id>',
methods=['GET'],
)
@authenticate
def get_segment_gpx(auth_user_id, activity_id, segment_id):
def get_segment_gpx(auth_user_id, activity_uuid, segment_id):
"""
Get gpx file for an activity segment displayed on map with Leaflet
@ -565,7 +567,8 @@ def get_segment_gpx(auth_user_id, activity_id, segment_id):
.. sourcecode:: http
GET /api/activities/3/gpx/segment/0 HTTP/1.1
GET /api/activities/f03265f69fe0489b812fc7dc4deff55e/gpx/segment/0
HTTP/1.1
Content-Type: application/json
**Example response**:
@ -584,7 +587,7 @@ def get_segment_gpx(auth_user_id, activity_id, segment_id):
}
:param integer auth_user_id: authenticate user id (from JSON Web Token)
:param integer activity_id: activity id
:param integer activity_uuid: activity uuid
:param integer segment_id: segment id
:reqheader Authorization: OAuth 2.0 Bearer Token
@ -599,15 +602,15 @@ def get_segment_gpx(auth_user_id, activity_id, segment_id):
:statuscode 500:
"""
return get_activity_data(auth_user_id, activity_id, 'gpx', segment_id)
return get_activity_data(auth_user_id, activity_uuid, 'gpx', segment_id)
@activities_blueprint.route(
'/activities/<int:activity_id>/chart_data/segment/<int:segment_id>',
'/activities/<string:activity_uuid>/chart_data/segment/<int:segment_id>',
methods=['GET'],
)
@authenticate
def get_segment_chart_data(auth_user_id, activity_id, segment_id):
def get_segment_chart_data(auth_user_id, activity_uuid, segment_id):
"""
Get chart data from an activity gpx file, to display it with Recharts
@ -615,7 +618,8 @@ def get_segment_chart_data(auth_user_id, activity_id, segment_id):
.. sourcecode:: http
GET /api/activities/3/chart/segment/0 HTTP/1.1
GET /api/activities/f03265f69fe0489b812fc7dc4deff55e/chart/segment/0
HTTP/1.1
Content-Type: application/json
**Example response**:
@ -653,7 +657,7 @@ def get_segment_chart_data(auth_user_id, activity_id, segment_id):
}
:param integer auth_user_id: authenticate user id (from JSON Web Token)
:param integer activity_id: activity id
:param integer activity_uuid: activity uuid
:param integer segment_id: segment id
:reqheader Authorization: OAuth 2.0 Bearer Token
@ -668,7 +672,7 @@ def get_segment_chart_data(auth_user_id, activity_id, segment_id):
:statuscode 500:
"""
return get_activity_data(auth_user_id, activity_id, 'chart', segment_id)
return get_activity_data(auth_user_id, activity_uuid, 'chart', segment_id)
@activities_blueprint.route('/activities/map/<map_id>', methods=['GET'])
@ -790,7 +794,7 @@ def post_activity(auth_user_id):
"descent": null,
"distance": 10.0,
"duration": "0:17:04",
"id": 1,
"id": "f03265f69fe0489b812fc7dc4deff55e",
"map": null,
"max_alt": null,
"max_speed": 10.0,
@ -804,7 +808,7 @@ def post_activity(auth_user_id):
"records": [
{
"activity_date": "Mon, 01 Jan 2018 00:00:00 GMT",
"activity_id": 1,
"activity_id": "f03265f69fe0489b812fc7dc4deff55e",
"id": 4,
"record_type": "MS",
"sport_id": 1,
@ -813,7 +817,7 @@ def post_activity(auth_user_id):
},
{
"activity_date": "Mon, 01 Jan 2018 00:00:00 GMT",
"activity_id": 1,
"activity_id": "f03265f69fe0489b812fc7dc4deff55e",
"id": 3,
"record_type": "LD",
"sport_id": 1,
@ -822,7 +826,7 @@ def post_activity(auth_user_id):
},
{
"activity_date": "Mon, 01 Jan 2018 00:00:00 GMT",
"activity_id": 1,
"activity_id": "f03265f69fe0489b812fc7dc4deff55e",
"id": 2,
"record_type": "FD",
"sport_id": 1,
@ -831,7 +835,7 @@ def post_activity(auth_user_id):
},
{
"activity_date": "Mon, 01 Jan 2018 00:00:00 GMT",
"activity_id": 1,
"activity_id": "f03265f69fe0489b812fc7dc4deff55e",
"id": 1,
"record_type": "AS",
"sport_id": 1,
@ -955,7 +959,6 @@ def post_activity_no_gpx(auth_user_id):
"descent": null,
"distance": 10.0,
"duration": "0:17:04",
"id": 1,
"map": null,
"max_alt": null,
"max_speed": 10.0,
@ -969,7 +972,7 @@ def post_activity_no_gpx(auth_user_id):
"records": [
{
"activity_date": "Mon, 01 Jan 2018 00:00:00 GMT",
"activity_id": 1,
"activity_id": "f03265f69fe0489b812fc7dc4deff55e",
"id": 4,
"record_type": "MS",
"sport_id": 1,
@ -978,7 +981,7 @@ def post_activity_no_gpx(auth_user_id):
},
{
"activity_date": "Mon, 01 Jan 2018 00:00:00 GMT",
"activity_id": 1,
"activity_id": "f03265f69fe0489b812fc7dc4deff55e",
"id": 3,
"record_type": "LD",
"sport_id": 1,
@ -987,7 +990,7 @@ def post_activity_no_gpx(auth_user_id):
},
{
"activity_date": "Mon, 01 Jan 2018 00:00:00 GMT",
"activity_id": 1,
"activity_id": "f03265f69fe0489b812fc7dc4deff55e",
"id": 2,
"record_type": "FD",
"sport_id": 1,
@ -996,7 +999,7 @@ def post_activity_no_gpx(auth_user_id):
},
{
"activity_date": "Mon, 01 Jan 2018 00:00:00 GMT",
"activity_id": 1,
"activity_id": "f03265f69fe0489b812fc7dc4deff55e",
"id": 1,
"record_type": "AS",
"sport_id": 1,
@ -1008,6 +1011,7 @@ def post_activity_no_gpx(auth_user_id):
"sport_id": 1,
"title": null,
"user": "admin",
"uuid": "f03265f69fe0489b812fc7dc4deff55e"
"weather_end": null,
"weather_start": null,
"with_gpx": false
@ -1070,9 +1074,11 @@ def post_activity_no_gpx(auth_user_id):
return jsonify(response_object), 500
@activities_blueprint.route('/activities/<int:activity_id>', methods=['PATCH'])
@activities_blueprint.route(
'/activities/<string:activity_uuid>', methods=['PATCH']
)
@authenticate
def update_activity(auth_user_id, activity_id):
def update_activity(auth_user_id, activity_uuid):
"""
Update an activity
@ -1102,7 +1108,6 @@ def update_activity(auth_user_id, activity_id):
"descent": null,
"distance": 10.0,
"duration": "0:17:04",
"id": 1,
"map": null,
"max_alt": null,
"max_speed": 10.0,
@ -1116,7 +1121,7 @@ def update_activity(auth_user_id, activity_id):
"records": [
{
"activity_date": "Mon, 01 Jan 2018 00:00:00 GMT",
"activity_id": 1,
"activity_id": "f03265f69fe0489b812fc7dc4deff55e",
"id": 4,
"record_type": "MS",
"sport_id": 1,
@ -1125,7 +1130,7 @@ def update_activity(auth_user_id, activity_id):
},
{
"activity_date": "Mon, 01 Jan 2018 00:00:00 GMT",
"activity_id": 1,
"activity_id": "f03265f69fe0489b812fc7dc4deff55e",
"id": 3,
"record_type": "LD",
"sport_id": 1,
@ -1134,7 +1139,7 @@ def update_activity(auth_user_id, activity_id):
},
{
"activity_date": "Mon, 01 Jan 2018 00:00:00 GMT",
"activity_id": 1,
"activity_id": "f03265f69fe0489b812fc7dc4deff55e",
"id": 2,
"record_type": "FD",
"sport_id": 1,
@ -1143,7 +1148,7 @@ def update_activity(auth_user_id, activity_id):
},
{
"activity_date": "Mon, 01 Jan 2018 00:00:00 GMT",
"activity_id": 1,
"activity_id": "f03265f69fe0489b812fc7dc4deff55e",
"id": 1,
"record_type": "AS",
"sport_id": 1,
@ -1155,6 +1160,7 @@ def update_activity(auth_user_id, activity_id):
"sport_id": 1,
"title": null,
"user": "admin",
"uuid": "f03265f69fe0489b812fc7dc4deff55e"
"weather_end": null,
"weather_start": null,
"with_gpx": false
@ -1165,7 +1171,7 @@ def update_activity(auth_user_id, activity_id):
}
:param integer auth_user_id: authenticate user id (from JSON Web Token)
:param integer activity_id: activity id
:param integer activity_uuid: activity uuid
:<json string activity_date: activity date (format: ``%Y-%m-%d %H:%M``)
(only for activity without gpx)
@ -1195,7 +1201,7 @@ def update_activity(auth_user_id, activity_id):
return jsonify(response_object), 400
try:
activity = Activity.query.filter_by(id=activity_id).first()
activity = Activity.query.filter_by(uuid=activity_uuid).first()
if activity:
response_object, code = can_view_activity(
auth_user_id, activity.user_id
@ -1228,10 +1234,10 @@ def update_activity(auth_user_id, activity_id):
@activities_blueprint.route(
'/activities/<int:activity_id>', methods=['DELETE']
'/activities/<string:activity_uuid>', methods=['DELETE']
)
@authenticate
def delete_activity(auth_user_id, activity_id):
def delete_activity(auth_user_id, activity_uuid):
"""
Delete an activity
@ -1239,7 +1245,7 @@ def delete_activity(auth_user_id, activity_id):
.. sourcecode:: http
DELETE /api/activities/1 HTTP/1.1
DELETE /api/activities/f03265f69fe0489b812fc7dc4deff55e HTTP/1.1
Content-Type: application/json
**Example response**:
@ -1250,7 +1256,7 @@ def delete_activity(auth_user_id, activity_id):
Content-Type: application/json
:param integer auth_user_id: authenticate user id (from JSON Web Token)
:param integer activity_id: activity id
:param integer activity_uuid: activity uuid
:reqheader Authorization: OAuth 2.0 Bearer Token
@ -1265,7 +1271,7 @@ def delete_activity(auth_user_id, activity_id):
"""
try:
activity = Activity.query.filter_by(id=activity_id).first()
activity = Activity.query.filter_by(uuid=activity_uuid).first()
if activity:
response_object, code = can_view_activity(
auth_user_id, activity.user_id

26
fittrackee/activities/models.py
View File

@ -1,5 +1,6 @@
import datetime
import os
from uuid import uuid4
from fittrackee import db
from sqlalchemy.dialects import postgresql
@ -37,6 +38,7 @@ def update_records(user_id, sport_id, connection, session):
.values(
value=value,
activity_id=record_data['activity'].id,
activity_uuid=record_data['activity'].uuid,
activity_date=record_data['activity'].activity_date,
)
)
@ -89,6 +91,12 @@ class Sport(db.Model):
class Activity(db.Model):
__tablename__ = "activities"
id = db.Column(db.Integer, primary_key=True, autoincrement=True)
uuid = db.Column(
postgresql.UUID(as_uuid=True),
default=uuid4,
unique=True,
nullable=False,
)
user_id = db.Column(db.Integer, db.ForeignKey('users.id'), nullable=False)
sport_id = db.Column(
db.Integer, db.ForeignKey('sports.id'), nullable=False
@ -226,7 +234,7 @@ class Activity(db.Model):
.first()
)
return {
"id": self.id,
"id": self.uuid.hex, # WARNING: client use uuid as id
"user": self.user.username,
"sport_id": self.sport_id,
"title": self.title,
@ -247,10 +255,10 @@ class Activity(db.Model):
"bounds": [float(bound) for bound in self.bounds]
if self.bounds
else [], # noqa
"previous_activity": previous_activity.id
"previous_activity": previous_activity.uuid.hex
if previous_activity
else None, # noqa
"next_activity": next_activity.id if next_activity else None,
"next_activity": next_activity.uuid.hex if next_activity else None,
"segments": [segment.serialize() for segment in self.segments],
"records": [record.serialize() for record in self.records],
"map": self.map_id if self.map else None,
@ -327,6 +335,7 @@ class ActivitySegment(db.Model):
activity_id = db.Column(
db.Integer, db.ForeignKey('activities.id'), primary_key=True
)
activity_uuid = db.Column(postgresql.UUID(as_uuid=True), nullable=False)
segment_id = db.Column(db.Integer, primary_key=True)
duration = db.Column(db.Interval, nullable=False)
pauses = db.Column(db.Interval, nullable=True)
@ -342,16 +351,17 @@ class ActivitySegment(db.Model):
def __str__(self):
return (
f'<Segment \'{self.segment_id}\' '
f'for activity \'{self.activity_id}\'>'
f'for activity \'{self.activity_uuid.hex}\'>'
)
def __init__(self, segment_id, activity_id):
def __init__(self, segment_id, activity_id, activity_uuid):
self.segment_id = segment_id
self.activity_id = activity_id
self.activity_uuid = activity_uuid
def serialize(self):
return {
"activity_id": self.activity_id,
"activity_id": self.activity_uuid.hex,
"segment_id": self.segment_id,
"duration": str(self.duration) if self.duration else None,
"pauses": str(self.pauses) if self.pauses else None,
@ -381,6 +391,7 @@ class Record(db.Model):
activity_id = db.Column(
db.Integer, db.ForeignKey('activities.id'), nullable=False
)
activity_uuid = db.Column(postgresql.UUID(as_uuid=True), nullable=False)
record_type = db.Column(Enum(*record_types, name="record_types"))
activity_date = db.Column(db.DateTime, nullable=False)
_value = db.Column("value", db.Integer, nullable=True)
@ -396,6 +407,7 @@ class Record(db.Model):
self.user_id = activity.user_id
self.sport_id = activity.sport_id
self.activity_id = activity.id
self.activity_uuid = activity.uuid
self.record_type = record_type
self.activity_date = activity.activity_date
@ -426,7 +438,7 @@ class Record(db.Model):
"id": self.id,
"user": self.user.username,
"sport_id": self.sport_id,
"activity_id": self.activity_id,
"activity_id": self.activity_uuid.hex,
"record_type": self.record_type,
"activity_date": self.activity_date,
"value": value,

8
fittrackee/activities/records.py
View File

@ -39,7 +39,7 @@ def get_records(auth_user_id):
"records": [
{
"activity_date": "Sun, 07 Jul 2019 08:00:00 GMT",
"activity_id": 4,
"activity_id": "e060bde05e3f4906a32913b102c814cb",
"id": 9,
"record_type": "AS",
"sport_id": 1,
@ -48,7 +48,7 @@ def get_records(auth_user_id):
},
{
"activity_date": "Sun, 07 Jul 2019 08:00:00 GMT",
"activity_id": 4,
"activity_id": "e060bde05e3f4906a32913b102c814cb",
"id": 10,
"record_type": "FD",
"sport_id": 1,
@ -57,7 +57,7 @@ def get_records(auth_user_id):
},
{
"activity_date": "Sun, 07 Jul 2019 08:00:00 GMT",
"activity_id": 7,
"activity_id": "e060bde05e3f4906a32913b102c814cb",
"id": 11,
"record_type": "LD",
"sport_id": 1,
@ -66,7 +66,7 @@ def get_records(auth_user_id):
},
{
"activity_date": "Sun, 07 Jul 2019 08:00:00 GMT",
"activity_id": 4,
"activity_id": "e060bde05e3f4906a32913b102c814cb",
"id": 12,
"record_type": "MS",
"sport_id": 1,

10
fittrackee/activities/utils.py
View File

@ -118,9 +118,11 @@ def create_activity(user, activity_data, gpx_data=None):
return new_activity
def create_segment(activity_id, segment_data):
def create_segment(activity_id, activity_uuid, segment_data):
new_segment = ActivitySegment(
activity_id=activity_id, segment_id=segment_data['idx']
activity_id=activity_id,
activity_uuid=activity_uuid,
segment_id=segment_data['idx'],
)
new_segment.duration = segment_data['duration']
new_segment.distance = segment_data['distance']
@ -272,7 +274,9 @@ def process_one_gpx_file(params, filename):
db.session.flush()
for segment_data in gpx_data['segments']:
new_segment = create_segment(new_activity.id, segment_data)
new_segment = create_segment(
new_activity.id, new_activity.uuid, segment_data
)
db.session.add(new_segment)
db.session.commit()
return new_activity