Feat #21 - 고객의 반려견 목록과 소유한 티켓 목록 조회 API 구현 (#22)

DongwookKim0823 · web-flow · commit 245a914cc0cd · 2024-07-01T01:09:23.000+09:00
- 해당 유치원에서 고객에게 등록된 반려동물 목록 조회 기능 구현 - 해당 유치원에서 고객이 소유하고 있는 티켓 목록 조회 기능 구현 Close #21
diff --git a/.github/dependabot.yml b/.github/dependabot.yml
@@ -22,3 +22,5 @@ updates:
     schedule:
       interval: "weekly"
     target-branch: "dependencies"
+    ignore:
+      - "djangorestframework-simplejwt"
diff --git a/config/root_urls.py b/config/root_urls.py
@@ -23,6 +23,15 @@
             )
         ),
     ),
+    path(
+        "guest/api/v1/reservations",
+        include(
+            (
+                "mung_manager.reservations.apis.urls",
+                "api-reservations",
+            )
+        ),
+    ),
 ]
 
 from config.settings.debug_toolbar.setup import DebugToolbarSetup  # noqa
diff --git a/mung_manager/commons/constants.py b/mung_manager/commons/constants.py
@@ -97,6 +97,7 @@ class SYSTEM_CODE:
     # Customer code
     UNIQUE_PET_NAME = ("unique_pet_name", "Customer pet names must be unique.")
     NOT_FOUND_CUSTOMER = ("not_found_customer", "Customer does not exist.")
+    INACTIVE_CUSTOMER = ("inactive_customer", "Customer is inactive.")
     NOT_FOUND_CUSTOMER_PET = (
         "not_found_customer_pet",
         "Customer pet does not exist.",
diff --git a/mung_manager/commons/selectors.py b/mung_manager/commons/selectors.py
@@ -1,4 +1,15 @@
-from mung_manager.errors.exceptions import AlreadyExistsException, NotFoundException
+from mung_manager.errors.exceptions import (
+    AlreadyExistsException,
+    NotFoundException,
+    PermissionDeniedException,
+)
+
+
+def get_object_or_permission_denied(objects, msg, code):
+    if objects is None:
+        if msg:
+            raise PermissionDeniedException(msg, code)
+    return objects
 
 
 def get_object_or_not_found(objects, msg, code):
diff --git a/mung_manager/customers/containers.py b/mung_manager/customers/containers.py
@@ -1,5 +1,7 @@
 from dependency_injector import containers, providers
 
+from mung_manager.customers.selectors.customer_pets import CustomerPetSelector
+from mung_manager.customers.selectors.customer_tickets import CustomerTicketSelector
 from mung_manager.customers.selectors.customers import CustomerSelector
 from mung_manager.customers.services.customers import CustomerService
 
@@ -18,3 +20,5 @@ class CustomerContainer(containers.DeclarativeContainer):
         CustomerService,
         customer_selector=customer_selector,
     )
+    customer_pet_selector = providers.Factory(CustomerPetSelector)
+    customer_ticket_selector = providers.Factory(CustomerTicketSelector)
diff --git a/mung_manager/customers/selectors/abstracts.py b/mung_manager/customers/selectors/abstracts.py
@@ -3,7 +3,7 @@
 
 from django.db.models.query import QuerySet
 
-from mung_manager.customers.models import Customer
+from mung_manager.customers.models import Customer, CustomerPet
 from mung_manager.errors.exceptions import NotImplementedException
 
 
@@ -23,3 +23,21 @@ def get_queryset_by_phone_number_and_user_id_is_null(
     @abstractmethod
     def exists_by_user_and_pet_kindergarden_id(self, user, pet_kindergarden_id: int) -> bool:
         raise NotImplementedException()
+
+    @abstractmethod
+    def get_by_user_and_pet_kindergarden_id_for_active_customer(
+        self, user, pet_kindergarden_id: int
+    ) -> Optional[Customer]:
+        raise NotImplementedException()
+
+
+class AbstractCustomerPetSelector(ABC):
+    @abstractmethod
+    def get_queryset_by_customer(self, customer: Customer) -> QuerySet[CustomerPet]:
+        raise NotImplementedException()
+
+
+class AbstractCustomerTicketSelector(ABC):
+    @abstractmethod
+    def get_queryset_by_customer(self, customer: Customer) -> dict[str, list]:
+        raise NotImplementedException()
diff --git a/mung_manager/customers/selectors/customer_pets.py b/mung_manager/customers/selectors/customer_pets.py
@@ -0,0 +1,22 @@
+from django.db.models.query import QuerySet
+
+from mung_manager.customers.models import Customer, CustomerPet
+from mung_manager.customers.selectors.abstracts import AbstractCustomerPetSelector
+
+
+class CustomerPetSelector(AbstractCustomerPetSelector):
+    """
+    이 클래스는 고객 반려동물을 DB에서 PULL하는 비즈니스 로직을 담당합니다.
+    """
+
+    def get_queryset_by_customer(self, customer: Customer) -> QuerySet[CustomerPet]:
+        """
+        이 함수는 고객 객체로 해당 반려동물 유치원에 속한 고객의 반려동물 목록을 조회합니다.
+
+        Args:
+            customer (Customer): 고객 객체
+
+        Returns:
+            QuerySet[CustomerPet]: 등록된 반려동물 목록이 존재하지 않으면 빈 쿼리셋을 반환합니다.
+        """
+        return CustomerPet.objects.filter(customer=customer, is_deleted=False)
diff --git a/mung_manager/customers/selectors/customer_tickets.py b/mung_manager/customers/selectors/customer_tickets.py
@@ -0,0 +1,45 @@
+from django.utils import timezone
+
+from mung_manager.customers.models import Customer, CustomerTicket
+from mung_manager.customers.selectors.abstracts import AbstractCustomerTicketSelector
+from mung_manager.tickets.enums import TicketType
+
+
+class CustomerTicketSelector(AbstractCustomerTicketSelector):
+    """
+    이 클래스는 고객 티켓을 DB에서 PULL하는 비즈니스 로직을 담당합니다.
+    """
+
+    def get_queryset_by_customer(self, customer: Customer) -> dict[str, list]:
+        """
+        고객 객체로 해당 고객이 소유하고 있는 만료되지 않은 티켓의 목록을 조회합니다.
+
+        Args:
+            customer (Customer): 고객 객체
+
+        Returns:
+            QuerySet: 소유하고 있는 티켓이 존재하지 않으면 빈 쿼리셋을 반환합니다.
+        """
+        customer_tickets = CustomerTicket.objects.filter(
+            customer=customer,
+            expired_at__gte=timezone.now(),
+            unused_count__gt=0,
+        ).select_related("ticket")
+
+        time_customer_tickets = []
+        all_day_customer_tickets = []
+        hotel_customer_tickets = []
+        for customer_ticket in customer_tickets:
+            ticket_type = customer_ticket.ticket.ticket_type
+            if ticket_type == TicketType.TIME.value:
+                time_customer_tickets.append(customer_ticket)
+            elif ticket_type == TicketType.ALL_DAY.value:
+                all_day_customer_tickets.append(customer_ticket)
+            elif ticket_type == TicketType.HOTEL.value:
+                hotel_customer_tickets.append(customer_ticket)
+
+        return {
+            "time": time_customer_tickets,
+            "all_day": all_day_customer_tickets,
+            "hotel": hotel_customer_tickets,
+        }
diff --git a/mung_manager/customers/selectors/customers.py b/mung_manager/customers/selectors/customers.py
@@ -52,3 +52,21 @@ def exists_by_user_and_pet_kindergarden_id(self, user, pet_kindergarden_id: int)
             bool: 사용자가 해당 유치원에 등록되어 있으면 True, 그렇지 않으면 False.
         """
         return Customer.objects.filter(user=user, pet_kindergarden=pet_kindergarden_id).exists()
+
+    def get_by_user_and_pet_kindergarden_id_for_active_customer(
+        self, user, pet_kindergarden_id: int
+    ) -> Optional[Customer]:
+        """
+        사용자 객체와 반려동물 유치원 아이디로 등록된 활성화 고객을 조회합니다.
+
+        Args:
+            user (User): 확인할 사용자 객체
+            pet_kindergarden_id (int): 반려동물 유치원 아이디
+
+        Returns:
+            Optional[Customer]: 등록된 활성화 고객이 존재하지 않으면 None을 반환
+        """
+        try:
+            return Customer.objects.filter(user=user, pet_kindergarden_id=pet_kindergarden_id, is_active=True).get()
+        except Customer.DoesNotExist:
+            return None
diff --git a/mung_manager/reservations/apis/api_managers.py b/mung_manager/reservations/apis/api_managers.py
@@ -0,0 +1,113 @@
+from drf_spectacular.types import OpenApiTypes
+from drf_spectacular.utils import OpenApiResponse, extend_schema
+from rest_framework import status
+
+from mung_manager.commons.base.api_managers import BaseAPIManager
+from mung_manager.reservations.apis.apis import (
+    ReservationCustomerPetListAPI,
+    ReservationCustomerTicketListAPI,
+)
+from mung_manager.schemas.errors.authentications import (
+    ErrorAuthenticationPasswordChangedSchema,
+    ErrorAuthenticationUserDeletedSchema,
+    ErrorAuthenticationUserInactiveSchema,
+    ErrorAuthenticationUserNotFoundSchema,
+    ErrorAuthorizationHeaderSchema,
+    ErrorTokenIdentificationSchema,
+)
+from mung_manager.schemas.errors.commons import (
+    ErrorAuthenticationFailedSchema,
+    ErrorInvalidTokenSchema,
+    ErrorNotAuthenticatedSchema,
+    ErrorPermissionDeniedSchema,
+    ErrorUnknownServerSchema,
+)
+from mung_manager.schemas.errors.customers import ErrorCustomerPermissionDeniedSchema
+
+
+class ReservationCustomerPetListAPIManager(BaseAPIManager):
+    VIEWS_BY_METHOD = {
+        "GET": ReservationCustomerPetListAPI.as_view,
+    }
+
+    @extend_schema(
+        tags=["예약"],
+        summary="고객의 반려견 목록 조회",
+        description="""
+        Rogic
+            - 반려동물 유치원에 등록된 고객의 반려견 목록을 조회합니다.
+        """,
+        responses={
+            status.HTTP_200_OK: VIEWS_BY_METHOD["GET"]().cls.OutputSerializer,
+            status.HTTP_401_UNAUTHORIZED: OpenApiResponse(
+                response=OpenApiTypes.OBJECT,
+                examples=[
+                    ErrorAuthenticationFailedSchema,
+                    ErrorNotAuthenticatedSchema,
+                    ErrorInvalidTokenSchema,
+                    ErrorAuthorizationHeaderSchema,
+                    ErrorAuthenticationPasswordChangedSchema,
+                    ErrorAuthenticationUserDeletedSchema,
+                    ErrorAuthenticationUserInactiveSchema,
+                    ErrorAuthenticationUserNotFoundSchema,
+                    ErrorTokenIdentificationSchema,
+                ],
+            ),
+            status.HTTP_403_FORBIDDEN: OpenApiResponse(
+                response=OpenApiTypes.OBJECT,
+                examples=[
+                    ErrorPermissionDeniedSchema,
+                    ErrorCustomerPermissionDeniedSchema,
+                ],
+            ),
+            status.HTTP_500_INTERNAL_SERVER_ERROR: OpenApiResponse(
+                response=OpenApiTypes.OBJECT, examples=[ErrorUnknownServerSchema]
+            ),
+        },
+    )
+    def get(self, request, *args, **kwargs):
+        return self.VIEWS_BY_METHOD["GET"]()(request, *args, **kwargs)
+
+
+class ReservationCustomerTicketListAPIManager(BaseAPIManager):
+    VIEWS_BY_METHOD = {
+        "GET": ReservationCustomerTicketListAPI.as_view,
+    }
+
+    @extend_schema(
+        tags=["예약"],
+        summary="고객의 잔여 티켓 목록 조회",
+        description="""
+        Rogic
+            - 반려동물 유치원에 등록된 고객의 잔여 티켓 목록을 조회합니다.
+        """,
+        responses={
+            status.HTTP_200_OK: VIEWS_BY_METHOD["GET"]().cls.OutputSerializer,
+            status.HTTP_401_UNAUTHORIZED: OpenApiResponse(
+                response=OpenApiTypes.OBJECT,
+                examples=[
+                    ErrorAuthenticationFailedSchema,
+                    ErrorNotAuthenticatedSchema,
+                    ErrorInvalidTokenSchema,
+                    ErrorAuthorizationHeaderSchema,
+                    ErrorAuthenticationPasswordChangedSchema,
+                    ErrorAuthenticationUserDeletedSchema,
+                    ErrorAuthenticationUserInactiveSchema,
+                    ErrorAuthenticationUserNotFoundSchema,
+                    ErrorTokenIdentificationSchema,
+                ],
+            ),
+            status.HTTP_403_FORBIDDEN: OpenApiResponse(
+                response=OpenApiTypes.OBJECT,
+                examples=[
+                    ErrorPermissionDeniedSchema,
+                    ErrorCustomerPermissionDeniedSchema,
+                ],
+            ),
+            status.HTTP_500_INTERNAL_SERVER_ERROR: OpenApiResponse(
+                response=OpenApiTypes.OBJECT, examples=[ErrorUnknownServerSchema]
+            ),
+        },
+    )
+    def get(self, request, *args, **kwargs):
+        return self.VIEWS_BY_METHOD["GET"]()(request, *args, **kwargs)
diff --git a/mung_manager/reservations/apis/apis.py b/mung_manager/reservations/apis/apis.py
@@ -0,0 +1,83 @@
+from rest_framework import serializers, status
+from rest_framework.request import Request
+from rest_framework.response import Response
+from rest_framework.views import APIView
+
+from mung_manager.apis.mixins import APIAuthWithPetKindergardenAccessMixin
+from mung_manager.commons.base.serializers import BaseSerializer
+from mung_manager.commons.constants import SYSTEM_CODE
+from mung_manager.commons.selectors import get_object_or_permission_denied
+from mung_manager.commons.utils import inline_serializer
+from mung_manager.customers.containers import CustomerContainer
+
+
+class ReservationCustomerPetListAPI(APIAuthWithPetKindergardenAccessMixin, APIView):
+    class OutputSerializer(BaseSerializer):
+        id = serializers.IntegerField(label="반려동물 아이디")
+        name = serializers.CharField(label="반려동물 이름")
+
+    def __init__(self, *args, **kwargs):
+        super().__init__(*args, **kwargs)
+        self._customer_selector = CustomerContainer.customer_selector()
+        self._customer_pet_selector = CustomerContainer.customer_pet_selector()
+
+    def get(self, request: Request) -> Response:
+        user = request.user
+        pet_kindergarden_id = request.pet_kindergarden_id
+        customer = get_object_or_permission_denied(
+            self._customer_selector.get_by_user_and_pet_kindergarden_id_for_active_customer(user, pet_kindergarden_id),
+            msg=SYSTEM_CODE.message("INACTIVE_CUSTOMER"),
+            code=SYSTEM_CODE.code("INACTIVE_CUSTOMER"),
+        )
+        pets = self._customer_pet_selector.get_queryset_by_customer(customer)
+        customer_pets_data = self.OutputSerializer(pets, many=True).data
+        return Response(data=customer_pets_data, status=status.HTTP_200_OK)
+
+
+class ReservationCustomerTicketListAPI(APIAuthWithPetKindergardenAccessMixin, APIView):
+    class OutputSerializer(BaseSerializer):
+        time = inline_serializer(
+            label="시간권 예약",
+            many=True,
+            fields={
+                "id": serializers.IntegerField(label="고객 티켓 아이디"),
+                "expired_at": serializers.DateTimeField(label="만료 시간"),
+                "unused_count": serializers.IntegerField(label="잔여 횟수"),
+                "usage_time": serializers.IntegerField(label="사용 가능한 시간", source="ticket.usage_time"),
+            },
+        )
+        all_day = inline_serializer(
+            label="종일권 예약",
+            many=True,
+            fields={
+                "id": serializers.IntegerField(label="고객 티켓 아이디"),
+                "expired_at": serializers.DateTimeField(label="만료 시간"),
+                "unused_count": serializers.IntegerField(label="잔여 횟수"),
+            },
+        )
+        hotel = inline_serializer(
+            label="호텔권 예약",
+            many=True,
+            fields={
+                "id": serializers.IntegerField(label="고객 티켓 아이디"),
+                "expired_at": serializers.DateTimeField(label="만료 시간"),
+                "unused_count": serializers.IntegerField(label="잔여 횟수"),
+            },
+        )
+
+    def __init__(self, *args, **kwargs):
+        super().__init__(*args, **kwargs)
+        self._customer_selector = CustomerContainer.customer_selector()
+        self._customer_ticket_selector = CustomerContainer.customer_ticket_selector()
+
+    def get(self, request: Request) -> Response:
+        user = request.user
+        pet_kindergarden_id = request.pet_kindergarden_id
+        customer = get_object_or_permission_denied(
+            self._customer_selector.get_by_user_and_pet_kindergarden_id_for_active_customer(user, pet_kindergarden_id),
+            msg=SYSTEM_CODE.message("INACTIVE_CUSTOMER"),
+            code=SYSTEM_CODE.code("INACTIVE_CUSTOMER"),
+        )
+        tickets = self._customer_ticket_selector.get_queryset_by_customer(customer)
+        customer_tickets_data = self.OutputSerializer(tickets).data
+        return Response(data=customer_tickets_data, status=status.HTTP_200_OK)
diff --git a/mung_manager/reservations/apis/urls.py b/mung_manager/reservations/apis/urls.py
diff --git a/mung_manager/schemas/errors/customers.py b/mung_manager/schemas/errors/customers.py
diff --git a/poetry.lock b/poetry.lock
diff --git a/pyproject.toml b/pyproject.toml
