Sith/api/views/user.py

#
# Copyright 2023 © AE UTBM
# ae@utbm.fr / ae.info@utbm.fr
#
# This file is part of the website of the UTBM Student Association (AE UTBM),
# https://ae.utbm.fr.
#
# You can find the source code of the website at https://github.com/ae-utbm/sith3
#
# LICENSED UNDER THE GNU GENERAL PUBLIC LICENSE VERSION 3 (GPLv3)
# SEE : https://raw.githubusercontent.com/ae-utbm/sith3/master/LICENSE
# OR WITHIN THE LOCAL FILE "LICENSE"
#
#

import datetime

from rest_framework import serializers
from rest_framework.decorators import action
from rest_framework.response import Response

from api.views import RightModelViewSet
from core.models import User


class UserSerializer(serializers.ModelSerializer):
    class Meta:
        model = User
        fields = (
            "id",
            "first_name",
            "last_name",
            "email",
            "date_of_birth",
            "nick_name",
            "is_active",
            "date_joined",
        )


class UserViewSet(RightModelViewSet):
    """Manage Users (api/v1/user/).

    Only show active users.
    """

    serializer_class = UserSerializer
    queryset = User.objects.filter(is_active=True)

    @action(detail=False)
    def birthday(self, request):
        """Return all users born today (api/v1/user/birstdays)."""
        date = datetime.datetime.today()
        self.queryset = self.queryset.filter(date_of_birth=date)
        serializer = self.get_serializer(self.queryset, many=True)
        return Response(serializer.data)