POST API Endpoints for Sending and Accepting Friend invitations between two Users; GET request endpoint for listview for Friend Invites

requirements/base.txt

@@ -8,3 +8,5 @@ django-allauth==0.57.0  # https://github.com/pennersr/django-allauth
 django-crispy-forms==2.0  # https://github.com/django-crispy-forms/django-crispy-forms
 crispy-bootstrap5==0.7  # https://github.com/django-crispy-forms/crispy-bootstrap5
 django-machina==1.3.1 # https://github.com/ellmetha/django-machina
+djangorestframework-simplejwt==5.2.0
+dj-rest-auth==1.0.0

src/chigame/api/permissions.py

@@ -0,0 +1,6 @@
+from rest_framework.permissions import BasePermission
+
+
+class IsUnauthenticated(BasePermission):
+    def has_permission(self, request, view):
+        return not request.user or not request.user.is_authenticated

src/chigame/api/serializers.py

@@ -1,6 +1,7 @@
 from rest_framework import serializers
 
 from chigame.games.models import Chat, Game, Lobby, Message, Tournament, User
+from chigame.users.models import FriendInvitation, UserProfile
 
 
 class GameSerializer(serializers.ModelSerializer):
@@ -9,6 +10,36 @@ class Meta:
         fields = "__all__"
 
 
+class TournamentSerializer(serializers.ModelSerializer):
+    class Meta:
+        model = Tournament
+        fields = (
+            "game",
+            "start_date",
+            "end_date",
+            "max_players",
+            "description",
+            "rules",
+            "draw_rules",
+            "matches",
+            "winners",
+            "players",
+        )
+
+
+class UserSerializer(serializers.ModelSerializer):
+    class Meta:
+        model = User
+        fields = ("id", "email", "password", "name", "is_staff")
+        extra_kwargs = {"password": {"write_only": True}, "id": {"read_only": True}}
+
+
+class UserProfileSerializer(serializers.ModelSerializer):
+    class Meta:
+        model = UserProfile
+        fields = "__all__"
+
+
 class LobbySerializer(serializers.ModelSerializer):
     class Meta:
         model = Lobby
@@ -26,12 +57,6 @@ class Meta:
         )
 
 
-class UserSerializer(serializers.ModelSerializer):
-    class Meta:
-        model = User
-        fields = ("id", "name", "email")
-
-
 class MessageSerializer(serializers.ModelSerializer):
     sender = serializers.EmailField(write_only=True)
 
@@ -54,3 +79,9 @@ def create(self, validated_data):
 
         message = Message.objects.create(**validated_data)
         return message
+
+
+class FriendInvitationSerializer(serializers.ModelSerializer):
+    class Meta:
+        model = FriendInvitation
+        fields = "__all__"

src/chigame/api/urls.py

@@ -3,16 +3,36 @@
 from . import views
 
 urlpatterns = [
-    # GAME API URLS
     path("games/", views.GameListView.as_view(), name="api-game-list"),
     path("games/<int:pk>/", views.GameDetailView.as_view(), name="api-game-detail"),
-    # LOBBY API URLS
+    path("tournaments/create/", views.TournamentCreateView.as_view(), name="create-tournament"),
+    path("tournaments/", views.TournamentListView.as_view(), name="tournament-list"),
+    path("register/", views.UserRegistrationView.as_view(), name="user-registration"),
     path("lobbies/", views.LobbyListView.as_view(), name="api-lobby-list"),
     path("lobbies/<int:pk>/", views.LobbyDetailView.as_view(), name="api-lobby-detail"),
-    # USER API URLS
     path("users/", views.UserListView.as_view(), name="api-user-list"),
     path("users/<int:pk>/", views.UserDetailView.as_view(), name="api-user-detail"),
+    path("token/", views.CustomTokenObtainPairView.as_view(), name="token_obtain_pair"),
+    path("token/refresh/", views.CustomTokenRefreshView.as_view(), name="token_refresh"),
+    path("token/verify/", views.CustomTokenVerifyView.as_view(), name="token_verify"),
     path("users/<int:pk>/friends/", views.UserFriendsAPIView.as_view(), name="api-user-friends"),
-    # CHAT API URLS
     path("tournaments/chat/", views.MessageView.as_view(), name="api-chat-list"),
+    path(
+        "friend-invitations/send/<int:sender_pk>/<int:receiver_pk>/",
+        views.SendFriendInvitationView.as_view(),
+        name="send-friend-invitation",
+    ),
+    path(
+        "friend-invitations/accept/<int:invitation_pk>/",
+        views.AcceptFriendInvitationView.as_view(),
+        name="accept-friend-invitation",
+    ),
+    path("friend-invitations/", views.FriendInvitationList.as_view(), name="friend-invitation-list"),
+    path("user-profiles/create/<int:user_pk>/", views.UserProfileCreateView.as_view(), name="create-user-profile"),
+    path("user-profiles/", views.UserProfileListView.as_view(), name="user-profile-list"),
+    path(
+        "user-profiles/update/<int:user_profile_pk>/",
+        views.UserProfileUpdateView.as_view(),
+        name="update-user-profile",
+    ),
 ]

src/chigame/api/views.py

@@ -1,12 +1,28 @@
 # from django.shortcuts import render
+
+from dj_rest_auth.models import TokenModel
+from django.shortcuts import get_object_or_404
 from django_filters.rest_framework import DjangoFilterBackend
-from rest_framework import generics
+from rest_framework import generics, status
 from rest_framework.pagination import PageNumberPagination
+from rest_framework.permissions import IsAdminUser, IsAuthenticated
+from rest_framework.response import Response
+from rest_framework.views import APIView
+from rest_framework_simplejwt.authentication import JWTAuthentication
+from rest_framework_simplejwt.views import TokenObtainPairView, TokenRefreshView, TokenVerifyView
 
 from chigame.api.filters import GameFilter
-from chigame.api.serializers import GameSerializer, LobbySerializer, MessageSerializer, UserSerializer
-from chigame.games.models import Game, Lobby, Message, User
-from chigame.users.models import UserProfile
+from chigame.api.serializers import (
+    FriendInvitationSerializer,
+    GameSerializer,
+    LobbySerializer,
+    MessageSerializer,
+    TournamentSerializer,
+    UserProfileSerializer,
+    UserSerializer,
+)
+from chigame.games.models import Game, Lobby, Message, Tournament
+from chigame.users.models import FriendInvitation, User, UserProfile
 
 
 class GameListView(generics.ListCreateAPIView):
@@ -22,6 +38,39 @@ class GameDetailView(generics.RetrieveUpdateDestroyAPIView):
     serializer_class = GameSerializer
 
 
+class UserListView(generics.ListAPIView):
+    queryset = User.objects.all()
+    serializer_class = UserSerializer
+    permission_classes = [IsAuthenticated]
+    authentication_classes = [JWTAuthentication]
+
+
+class UserRegistrationView(APIView):
+    permission_classes = [IsAuthenticated]
+
+    def post(self, request, *args, **kwargs):
+        serializer_class = UserSerializer(data=request.data)
+        if serializer_class.is_valid():
+            user = serializer_class.save()
+            UserProfile.objects.create(user=user, display_name=user.name)
+            refresh = TokenModel.objects.create(user=user)
+            access_token = str(refresh.key)
+
+            return Response({"access_token": access_token}, status=status.HTTP_201_CREATED)
+        return Response(serializer_class.errors, status=status.HTTP_400_BAD_REQUEST)
+
+
+class TournamentCreateView(generics.CreateAPIView):
+    queryset = Tournament.objects.all()
+    serializer_class = TournamentSerializer
+    permission_classes = [IsAdminUser]
+
+
+class TournamentListView(generics.ListAPIView):
+    queryset = Tournament.objects.all()
+    serializer_class = TournamentSerializer
+
+
 class UserFriendsAPIView(generics.RetrieveAPIView):
     serializer_class = UserSerializer
 
@@ -42,17 +91,104 @@ class LobbyDetailView(generics.RetrieveUpdateDestroyAPIView):
     serializer_class = LobbySerializer
 
 
-class UserListView(generics.ListCreateAPIView):
+class UserDetailView(generics.RetrieveUpdateDestroyAPIView):
     queryset = User.objects.all()
     serializer_class = UserSerializer
     pagination_class = PageNumberPagination
 
 
-class UserDetailView(generics.RetrieveUpdateDestroyAPIView):
-    queryset = User.objects.all()
-    serializer_class = UserSerializer
+class CustomTokenObtainPairView(TokenObtainPairView):
+    # Add any custom behavior if needed
+    pass
+
+
+class CustomTokenRefreshView(TokenRefreshView):
+    # Add any custom behavior if needed
+    pass
+
+
+class CustomTokenVerifyView(TokenVerifyView):
+    # Add any custom behavior if needed
+    pass
 
 
 class MessageView(generics.CreateAPIView):
     queryset = Message.objects.all()
     serializer_class = MessageSerializer
+
+
+class SendFriendInvitationView(APIView):
+    def post(self, request, *args, **kwargs):
+        sender_pk = self.kwargs["sender_pk"]
+        receiver_pk = self.kwargs["receiver_pk"]
+
+        sender = get_object_or_404(User, pk=sender_pk)
+        receiver = get_object_or_404(User, pk=receiver_pk)
+
+        if sender == receiver:
+            return Response(
+                {"detail": "You cannot send an invitation to yourself."}, status=status.HTTP_400_BAD_REQUEST
+            )
+
+        invitation = FriendInvitation(sender=sender, receiver=receiver)
+        invitation.save()
+
+        serializer = FriendInvitationSerializer(invitation)
+        return Response(serializer.data, status=status.HTTP_201_CREATED)
+
+
+class AcceptFriendInvitationView(APIView):
+    def post(self, request, *args, **kwargs):
+        invitation_pk = self.kwargs["invitation_pk"]
+        invitation = get_object_or_404(FriendInvitation, pk=invitation_pk)
+
+        if invitation.accepted:
+            return Response(
+                {"detail": "This invitation has already been accepted."}, status=status.HTTP_400_BAD_REQUEST
+            )
+        invitation.accept_invitation()  # Error with this method in the users.models
+        serializer = FriendInvitationSerializer(invitation)
+        return Response(serializer.data, status=status.HTTP_200_OK)
+
+
+class FriendInvitationList(generics.ListAPIView):
+    queryset = FriendInvitation.objects.all()
+    serializer_class = FriendInvitationSerializer
+
+
+class UserProfileCreateView(APIView):
+    def post(self, request, *args, **kwargs):
+        user_pk = self.kwargs["user_pk"]
+        user = get_object_or_404(User, pk=user_pk)
+        existing_profile = UserProfile.objects.filter(user=user).first()
+        if existing_profile:
+            serializer = UserProfileSerializer(existing_profile)
+            return Response(serializer.data, status=status.HTTP_200_OK)
+
+        serializer = UserProfileSerializer(data=request.data)
+        if serializer.is_valid():
+            profile = serializer.save(user=user)
+            return Response(UserProfileSerializer(profile).data, status=status.HTTP_201_CREATED)
+        return Response(serializer.errors, status=status.HTTP_400_BAD_REQUEST)
+
+
+class UserProfileListView(generics.ListAPIView):
+    queryset = UserProfile.objects.all()
+    serializer_class = UserProfileSerializer
+    permission_classes = [IsAuthenticated]
+    authentication_classes = [JWTAuthentication]
+
+
+class UserProfileUpdateView(APIView):
+    permission_classes = [IsAuthenticated]
+    authentication_classes = [JWTAuthentication]
+
+    def patch(self, request, *args, **kwargs):
+        user_profile_pk = self.kwargs["user_profile_pk"]
+        user_profile = get_object_or_404(UserProfile, pk=user_profile_pk)
+
+        serializer = UserProfileSerializer(user_profile, data=request.data, partial=True)
+        if serializer.is_valid():
+            updated_profile = serializer.save()
+            return Response(UserProfileSerializer(updated_profile).data, status=status.HTTP_200_OK)
+        return Response(serializer.errors, status=status.HTTP_400_BAD_REQUEST)

src/config/settings/base.py

@@ -1,6 +1,7 @@
 """
 Base settings to build other settings files upon.
 """
+from datetime import timedelta
 from pathlib import Path
 
 import environ
@@ -77,6 +78,9 @@
     "rest_framework",
     "django_filters",
     "django_tables2",
+    "rest_framework_simplejwt",
+    "rest_framework.authtoken",
+    "dj_rest_auth",
 ]
 THIRD_PARTY_APPS = [
     "crispy_forms",
@@ -113,7 +117,41 @@
 # https://docs.djangoproject.com/en/dev/ref/settings/#installed-apps
 INSTALLED_APPS = DJANGO_APPS + THIRD_PARTY_APPS + LOCAL_APPS
 
+REST_FRAMEWORK = {"DEFAULT_AUTHENTICATION_CLASSES": ("rest_framework_simplejwt.authentication.JWTAuthentication",)}
 
+
+SIMPLE_JWT = {
+    "ACCESS_TOKEN_LIFETIME": timedelta(days=1),
+    "REFRESH_TOKEN_LIFETIME": timedelta(days=7),
+    "ROTATE_REFRESH_TOKENS": False,
+    "BLACKLIST_AFTER_ROTATION": False,
+    "UPDATE_LAST_LOGIN": False,
+    "ALGORITHM": "HS256",
+    "VERIFYING_KEY": "",
+    "AUDIENCE": None,
+    "ISSUER": None,
+    "JSON_ENCODER": None,
+    "JWK_URL": None,
+    "LEEWAY": 0,
+    "AUTH_HEADER_TYPES": ("Bearer",),
+    "AUTH_HEADER_NAME": "HTTP_AUTHORIZATION",
+    "USER_ID_FIELD": "id",
+    "USER_ID_CLAIM": "user_id",
+    "USER_AUTHENTICATION_RULE": "rest_framework_simplejwt.authentication.default_user_authentication_rule",
+    "AUTH_TOKEN_CLASSES": ("rest_framework_simplejwt.tokens.AccessToken",),
+    "TOKEN_TYPE_CLAIM": "token_type",
+    "TOKEN_USER_CLASS": "rest_framework_simplejwt.models.TokenUser",
+    "JTI_CLAIM": "jti",
+    "SLIDING_TOKEN_REFRESH_EXP_CLAIM": "refresh_exp",
+    "SLIDING_TOKEN_LIFETIME": timedelta(minutes=5),
+    "SLIDING_TOKEN_REFRESH_LIFETIME": timedelta(days=1),
+    "TOKEN_OBTAIN_SERIALIZER": "rest_framework_simplejwt.serializers.TokenObtainPairSerializer",
+    "TOKEN_REFRESH_SERIALIZER": "rest_framework_simplejwt.serializers.TokenRefreshSerializer",
+    "TOKEN_VERIFY_SERIALIZER": "rest_framework_simplejwt.serializers.TokenVerifySerializer",
+    "TOKEN_BLACKLIST_SERIALIZER": "rest_framework_simplejwt.serializers.TokenBlacklistSerializer",
+    "SLIDING_TOKEN_OBTAIN_SERIALIZER": "rest_framework_simplejwt.serializers.TokenObtainSlidingSerializer",
+    "SLIDING_TOKEN_REFRESH_SERIALIZER": "rest_framework_simplejwt.serializers.TokenRefreshSlidingSerializer",
+}
 # AUTHENTICATION
 # ------------------------------------------------------------------------------
 # https://docs.djangoproject.com/en/dev/ref/settings/#authentication-backends