Merge pull request #360 from SamR1/add-social-features

Add social features [1st part]
SamR1 · Dec 14, 2024 · 3065f10 · 3065f10
2 parents 1707aa7 + a2d0d1e
commit 3065f10
Show file tree

Hide file tree

Showing 749 changed files with 92,263 additions and 13,224 deletions.
diff --git a/.github/workflows/.tests-python.yml b/.github/workflows/.tests-python.yml
@@ -13,6 +13,7 @@ env:
   EMAIL_URL: "smtp://none:[email protected]:1025"
   FLASK_APP: fittrackee/__main__.py
   SENDER_EMAIL: [email protected]
+  UI_URL: https://0.0.0.0:5000
 
 jobs:
   python:

diff --git a/Makefile b/Makefile
@@ -92,8 +92,12 @@ docker-serve-client:
 	docker compose -f docker-compose-dev.yml exec fittrackee_client $(NPM) dev
 
 docker-set-admin:
+	# deprecated command
 	docker compose -f docker-compose-dev.yml exec fittrackee ftcli users update $(USERNAME) --set-admin true
 
+docker-set-role:
+	docker compose -f docker-compose-dev.yml exec fittrackee ftcli users update $(USERNAME) --set-role $(ROLE)
+
 docker-shell:
 	docker compose -f docker-compose-dev.yml exec fittrackee docker/shell.sh
 
@@ -239,10 +243,6 @@ serve-python-dev:
 	echo 'Running on https://$(HOST):$(PORT)'
 	$(FLASK) run --with-threads -h $(HOST) -p $(PORT) --cert=adhoc
 
-set-admin:
-	echo "Deprecated command, will be removed in a next version. Use 'user-set-admin' instead."
-	$(FTCLI) users update $(USERNAME) --set-admin true
-
 test-all: test-client test-python
 
 test-e2e:
@@ -252,6 +252,11 @@ test-e2e-client:
 	E2E_ARGS=client $(PYTEST) e2e --driver firefox $(PYTEST_ARGS)
 
 test-python:
+	# for tests parallelization: 4 workers max.
+	# make test-python PYTEST_ARGS="-p no:warnings -n auto --maxprocesses=4"
+	$(PYTEST) fittrackee $(PYTEST_ARGS)
+
+test-python-cov:
 	# for tests parallelization: 4 workers max.
 	# make test-python PYTEST_ARGS="-p no:warnings -n auto --maxprocesses=4"
 	$(PYTEST) fittrackee --cov-config .coveragerc --cov=fittrackee --cov-report term-missing $(PYTEST_ARGS)
@@ -282,7 +287,11 @@ user-reset-password:
 
 ADMIN := true
 user-set-admin:
+	# deprecated command
 	$(FTCLI) users update $(USERNAME) --set-admin $(ADMIN)
 
+user-set-role:
+	$(FTCLI) users update $(USERNAME) --set-role $(ROLE)
+
 user-update-email:
 	$(FTCLI) users update $(USERNAME) --update-email $(EMAIL)
diff --git a/README.md b/README.md
@@ -37,7 +37,7 @@ Map data from [OpenStreetMap](https://www.openstreetmap.org).
 **Under heavy development (some features may be unstable).**  
 (see [issues](https://github.com/SamR1/FitTrackee/issues) and [documentation](https://samr1.github.io/FitTrackee) for more info.)  
 
-![FitTrackee Dashboard Screenshot](https://samr1.github.io/FitTrackee/en/_images/fittrackee_screenshot-01.png)
+![FitTrackee Dashboard Screenshot](https://samr1.github.io/FitTrackee/en/_images/dashboard.png)
 
 ## Translations
 

diff --git a/docs/en/_images/administration-menu.png b/docs/en/_images/administration-menu.png
diff --git a/docs/en/_images/dashboard.png b/docs/en/_images/dashboard.png
diff --git a/docs/en/_images/equipment-detail.png b/docs/en/_images/equipment-detail.png
diff --git a/docs/en/_images/equipments-list.png b/docs/en/_images/equipments-list.png
diff --git a/docs/en/_images/fittrackee_screenshot-01.png b/docs/en/_images/fittrackee_screenshot-01.png
diff --git a/docs/en/_images/fittrackee_screenshot-02.png b/docs/en/_images/fittrackee_screenshot-02.png
diff --git a/docs/en/_images/fittrackee_screenshot-03.png b/docs/en/_images/fittrackee_screenshot-03.png
diff --git a/docs/en/_images/fittrackee_screenshot-04.png b/docs/en/_images/fittrackee_screenshot-04.png
diff --git a/docs/en/_images/fittrackee_screenshot-05.png b/docs/en/_images/fittrackee_screenshot-05.png
diff --git a/docs/en/_images/fittrackee_screenshot-06.png b/docs/en/_images/fittrackee_screenshot-06.png
diff --git a/docs/en/_images/fittrackee_screenshot-07.png b/docs/en/_images/fittrackee_screenshot-07.png
diff --git a/docs/en/_images/fittrackee_screenshot-08.png b/docs/en/_images/fittrackee_screenshot-08.png
diff --git a/docs/en/_images/fittrackee_screenshot-09.png b/docs/en/_images/fittrackee_screenshot-09.png
diff --git a/docs/en/_images/fittrackee_screenshot-10.png b/docs/en/_images/fittrackee_screenshot-10.png
diff --git a/docs/en/_images/fittrackee_screenshot-11.png b/docs/en/_images/fittrackee_screenshot-11.png
diff --git a/docs/en/_images/notifications.png b/docs/en/_images/notifications.png
diff --git a/docs/en/_images/oauth2-app-authorization.png b/docs/en/_images/oauth2-app-authorization.png
diff --git a/docs/en/_images/oauth2-client-creation.png b/docs/en/_images/oauth2-client-creation.png
diff --git a/docs/en/_images/sports-administration.png b/docs/en/_images/sports-administration.png
diff --git a/docs/en/_images/statistics-by-sport.png b/docs/en/_images/statistics-by-sport.png
diff --git a/docs/en/_images/statistics-by-time-period.png b/docs/en/_images/statistics-by-time-period.png
diff --git a/docs/en/_images/users-directory.png b/docs/en/_images/users-directory.png
diff --git a/docs/en/_images/workout-detail.png b/docs/en/_images/workout-detail.png
diff --git a/docs/en/_images/workouts-list.png b/docs/en/_images/workouts-list.png
diff --git a/docs/en/_sources/api/auth.rst.txt b/docs/en/_sources/api/auth.rst.txt
@@ -22,4 +22,9 @@ Authentication and account
     auth.accept_privacy_policy,
     auth.get_user_data_export,
     auth.request_user_data_export,
-    auth.download_data_export
+    auth.download_data_export,
+    auth.get_blocked_users,
+    auth.get_user_suspension,
+    auth.appeal_user_suspension,
+    auth.get_user_sanction,
+    auth.appeal_user_sanction
diff --git a/docs/en/_sources/api/comments.rst.txt b/docs/en/_sources/api/comments.rst.txt
@@ -0,0 +1,14 @@
+Comments
+########
+
+.. autoflask:: fittrackee:create_app()
+   :endpoints:
+    comments.get_workout_comments,
+    comments.get_workout_comment,
+    comments.post_workout_comment,
+    comments.update_workout_comment,
+    comments.like_comment,
+    comments.undo_comment_like,
+    comments.appeal_comment_suspension,
+    comments.delete_workout_comment
+
diff --git a/docs/en/_sources/api/follow_requests.rst.txt b/docs/en/_sources/api/follow_requests.rst.txt
@@ -0,0 +1,8 @@
+Follow requests
+###############
+
+.. autoflask:: fittrackee:create_app()
+   :endpoints:
+    follow_requests.get_follow_requests,
+    follow_requests.accept_follow_request,
+    follow_requests.reject_follow_request
diff --git a/docs/en/_sources/api/index.rst.txt b/docs/en/_sources/api/index.rst.txt
@@ -7,11 +7,16 @@ API documentation
 
    auth
    configuration
+   comments
    equipments
    equipment_types
+   follow_requests
    oauth2
+   notifications
    records
+   reports
    sports
    stats
+   timeline
    users
    workouts
diff --git a/docs/en/_sources/api/notifications.rst.txt b/docs/en/_sources/api/notifications.rst.txt
@@ -0,0 +1,10 @@
+Notifications
+#############
+
+.. autoflask:: fittrackee:create_app()
+   :endpoints:
+    notifications.get_auth_user_notifications,
+    notifications.update_user_notifications,
+    notifications.get_status,
+    notifications.mark_all_as_read,
+    notifications.get_notification_types
diff --git a/docs/en/_sources/api/reports.rst.txt b/docs/en/_sources/api/reports.rst.txt
@@ -0,0 +1,14 @@
+Reports
+########
+
+.. autoflask:: fittrackee:create_app()
+   :endpoints:
+    reports.get_reports,
+    reports.get_report,
+    reports.get_unresolved_reports_status,
+    reports.create_report,
+    reports.update_report,
+    reports.create_action,
+    reports.process_appeal
+
+
diff --git a/docs/en/_sources/api/timeline.rst.txt b/docs/en/_sources/api/timeline.rst.txt
@@ -0,0 +1,6 @@
+Timeline
+########
+
+.. autoflask:: fittrackee:create_app()
+   :endpoints:
+    timeline.get_user_timeline
diff --git a/docs/en/_sources/api/users.rst.txt b/docs/en/_sources/api/users.rst.txt
@@ -7,4 +7,11 @@ Users
     users.get_single_user,
     users.get_picture,
     users.update_user,
-    users.delete_user
+    users.delete_user,
+    users.follow_user,
+    users.unfollow_user,
+    users.get_followers,
+    users.get_following,
+    users.block_user,
+    users.unblock_user,
+    users.get_user_sanctions
diff --git a/docs/en/_sources/api/workouts.rst.txt b/docs/en/_sources/api/workouts.rst.txt
@@ -15,4 +15,7 @@ Workouts
     workouts.post_workout,
     workouts.post_workout_no_gpx,
     workouts.update_workout,
-    workouts.delete_workout
+    workouts.delete_workout,
+    workouts.like_workout,
+    workouts.undo_workout_like,
+    workouts.appeal_workout_suspension
diff --git a/docs/en/_sources/cli.rst.txt b/docs/en/_sources/cli.rst.txt
@@ -97,16 +97,14 @@ Remove blacklisted tokens expired for more than provided number of days.
 ``ftcli users create``
 """"""""""""""""""""""
 .. versionadded:: 0.7.15
+.. versionchanged:: 0.8.4  User preference for interface language is added.
 
 Create a user account.
 
 .. note::
   - the newly created account is already active.
   - the CLI allows to create users when registration is disabled.
 
-.. versionchanged:: 0.8.4
-
-User preference for interface language is added.
 
 .. cssclass:: table-bordered
 .. list-table::
@@ -147,8 +145,9 @@ Can be used if redis is not set (no dramatiq workers running).
 ``ftcli users update``
 """"""""""""""""""""""
 .. versionadded:: 0.6.5
+.. versionchanged:: 0.9.0  Add ``--set-role`` option. ``--set-admin`` is now deprecated.
 
-Modify a user account (admin rights, active status, email and password).
+Modify a user account (role, active status, email and password).
 
 .. cssclass:: table-bordered
 .. list-table::
@@ -160,7 +159,9 @@ Modify a user account (admin rights, active status, email and password).
    * - ``USERNAME``
      - Username.
    * - ``--set-admin BOOLEAN``
-     - Add/remove admin rights (when adding admin rights, it also activates user account if not active).
+     - [DEPRECATED] Add/remove admin rights (when adding admin rights, it also activates user account if not active).
+   * - ``--set-role ROLE``
+     - Set user role (when setting 'moderator', 'admin' and 'owner' role, it also activates user account if not active).
    * - ``--activate``
      - Activate user account.
    * - ``--reset-password``