Merge pull request #239 from PROCOLLAB-github/feature/subscribes

add subscribe and subscribers routes

Author: VeryBigSad

projects/migrations/0021_project_subscribers.py

@@ -0,0 +1,24 @@
+# Generated by Django 4.2.3 on 2023-11-14 20:07
+
+from django.conf import settings
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        migrations.swappable_dependency(settings.AUTH_USER_MODEL),
+        ("projects", "0020_project_cover_defaultprojectcover"),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name="project",
+            name="subscribers",
+            field=models.ManyToManyField(
+                related_name="subscribed_projects",
+                to=settings.AUTH_USER_MODEL,
+                verbose_name="Подписчики",
+            ),
+        ),
+    ]

projects/models.py

@@ -107,6 +107,10 @@ class Project(models.Model):
         blank=True,
     )
 
+    subscribers = models.ManyToManyField(
+        User, verbose_name="Подписчики", related_name="subscribed_projects"
+    )
+
     datetime_created = models.DateTimeField(
         verbose_name="Дата создания", null=False, auto_now_add=True
     )

projects/serializers.py

@@ -1,8 +1,9 @@
 from django.contrib.auth import get_user_model
 from rest_framework import serializers
-
+from django.core.cache import cache
 from core.fields import CustomListField
 from core.services import get_views_count, get_likes_count, is_fan
+from core.utils import get_user_online_cache_key
 from files.serializers import UserFileSerializer
 from industries.models import Industry
 from projects.models import Project, Achievement, Collaborator, ProjectNews
@@ -275,3 +276,26 @@ class Meta:
             "is_user_liked",
             "files",
         ]
+
+
+class ProjectSubscribersListSerializer(serializers.ModelSerializer):
+    is_online = serializers.SerializerMethodField()
+
+    def get_is_online(self, user: User) -> bool:
+        request = self.context.get("request")
+        if request and request.user.is_authenticated and request.user.id == user.id:
+            return True
+
+        cache_key = get_user_online_cache_key(user)
+        is_online = cache.get(cache_key, False)
+        return is_online
+
+    class Meta:
+        model = User
+        fields = [
+            "id",
+            "first_name",
+            "last_name",
+            "avatar",
+            "is_online",
+        ]

projects/urls.py

@@ -12,6 +12,9 @@
     ProjectVacancyResponses,
     ProjectRecommendedUsers,
     SetLikeOnProject,
+    ProjectSubscribe,
+    ProjectUnsubscribe,
+    ProjectSubscribers,
 )
 
 app_name = "projects"
@@ -20,6 +23,9 @@
     path("", ProjectList.as_view()),
     path("<int:pk>/like/", SetLikeOnProject.as_view()),
     path("<int:project_pk>/news/", NewsList.as_view()),
+    path("<int:project_pk>/subscribe/", ProjectSubscribe.as_view()),
+    path("<int:project_pk>/unsubscribe/", ProjectUnsubscribe.as_view()),
+    path("<int:project_pk>/subscribers/", ProjectSubscribers.as_view()),
     path("<int:project_pk>/news/<int:pk>/", NewsDetail.as_view()),
     path("<int:project_pk>/news/<int:pk>/set_viewed/", NewsDetailSetViewed.as_view()),
     path("<int:project_pk>/news/<int:pk>/set_liked/", NewsDetailSetLiked.as_view()),

projects/views.py

@@ -1,7 +1,12 @@
+import logging
+
 from django.contrib.auth import get_user_model
 from django.db.models import Q
 from django_filters import rest_framework as filters
+from drf_yasg import openapi
+from drf_yasg.utils import swagger_auto_schema
 from rest_framework import generics, permissions, status
+from rest_framework.exceptions import NotFound
 from rest_framework.permissions import IsAuthenticated
 from rest_framework.response import Response
 from rest_framework.views import APIView
@@ -33,12 +38,15 @@
     ProjectCollaboratorSerializer,
     ProjectNewsListSerializer,
     ProjectNewsDetailSerializer,
+    ProjectSubscribersListSerializer,
 )
 from users.models import LikesOnProject
 from users.serializers import UserListSerializer
 from vacancy.models import VacancyResponse
 from vacancy.serializers import VacancyResponseListSerializer
 
+logger = logging.getLogger()
+
 User = get_user_model()
 
 
@@ -381,3 +389,75 @@ def post(self, request, *args, **kwargs):
             return Response(status=status.HTTP_200_OK)
         except ProjectNews.DoesNotExist:
             return Response(status=status.HTTP_404_NOT_FOUND)
+
+
+class ProjectSubscribers(APIView):
+    permission_classes = [IsAuthenticated]
+
+    @swagger_auto_schema(
+        responses={
+            200: openapi.Response(
+                "List of project subscribers", ProjectSubscribersListSerializer(many=True)
+            )
+        }
+    )
+    def get(self, request, *args, **kwargs):
+        try:
+            project = Project.objects.get(pk=self.kwargs["project_pk"])
+        except Project.DoesNotExist:
+            raise NotFound
+        subscribers = ProjectSubscribersListSerializer(
+            project.subscribers.all(), many=True
+        ).data
+        return Response(subscribers, status=status.HTTP_200_OK)
+
+
+class ProjectSubscribe(APIView):
+    permission_classes = [IsAuthenticated]
+
+    def post(self, request, project_pk):
+        try:
+            project = Project.objects.get(pk=project_pk)
+        except Project.DoesNotExist:
+            raise NotFound
+        try:
+            project.subscribers.add(request.user)
+        except Exception:
+            return Response(
+                {
+                    "detail": f"User {request.user.id} is not part of project {project.pk}."
+                },
+                status=status.HTTP_400_BAD_REQUEST,
+            )
+
+        logger.info(f"User {request.user.id} subscribed to project {project_pk}")
+
+        return Response(
+            {"detail": "Subscriber was successfully added"}, status=status.HTTP_200_OK
+        )
+
+
+class ProjectUnsubscribe(APIView):
+    permission_classes = [IsAuthenticated]
+
+    def post(self, request, project_pk):
+        try:
+            project = Project.objects.get(pk=project_pk)
+        except Project.DoesNotExist:
+            raise NotFound
+        try:
+            project.subscribers.remove(request.user)
+            # todo: add more specific error here
+        except Exception:
+            return Response(
+                {
+                    "detail": f"User {request.user.id} is not part of project {project.pk}."
+                },
+                status=status.HTTP_400_BAD_REQUEST,
+            )
+
+        logger.info(f"User {request.user.id} unsubscribed to project {project_pk}")
+
+        return Response(
+            {"detail": "Subscriber was successfully removed"}, status=status.HTTP_200_OK
+        )

users/models.py

@@ -96,12 +96,12 @@ class CustomUser(AbstractUser):
         verbose_name="Стадия онбординга",
         help_text="0, 1, 2 - номера стадий онбординга, null(пустое) - онбординг пройден",
     )
+
     verification_date = models.DateField(
         null=True,
         blank=True,
         verbose_name="Дата верификации",
     )
-
     datetime_updated = models.DateTimeField(auto_now=True)
     datetime_created = models.DateTimeField(auto_now_add=True)