add: BaseApiViewMixin created, TODO: switch external endpoints to GenericAPIView and BaseApiViewMixin

This commit is contained in:
2025-08-06 15:13:30 +05:00
parent 153bbefaab
commit 0935cfcb1f
8 changed files with 237 additions and 134 deletions

View File

@@ -1,7 +1,7 @@
from django_core.mixins import BaseViewSetMixin
from django_core.mixins import BaseViewSetMixin # type: ignore
from drf_spectacular.utils import extend_schema
from rest_framework.permissions import IsAdminUser, AllowAny
from rest_framework.viewsets import ModelViewSet
from rest_framework.permissions import IsAdminUser, AllowAny # type: ignore
from rest_framework.viewsets import ModelViewSet # type: ignore
from core.apps.companies.models import CompanyAccountModel
from core.apps.companies.serializers.accounts import (
@@ -12,9 +12,11 @@ from core.apps.companies.serializers.accounts import (
DestroyCompanyAccountSerializer,
)
######################################################################
# Crud
######################################################################
@extend_schema(tags=["CompanyAccount"])
class CompanyAccountView(BaseViewSetMixin, ModelViewSet):
class CompanyAccountCrudViewSet(BaseViewSetMixin, ModelViewSet):
queryset = CompanyAccountModel.objects.all()
serializer_class = ListCompanyAccountSerializer
permission_classes = [AllowAny]
@@ -26,7 +28,7 @@ class CompanyAccountView(BaseViewSetMixin, ModelViewSet):
"update": [IsAdminUser],
"destroy": [IsAdminUser],
}
action_serializer_class = {
action_serializer_class = { # type: ignore
"list": ListCompanyAccountSerializer,
"retrieve": RetrieveCompanyAccountSerializer,
"create": CreateCompanyAccountSerializer,

View File

@@ -1,5 +1,4 @@
import uuid
from typing import Any
from django_core.mixins import BaseViewSetMixin # type: ignore
from django.contrib.auth import get_user_model
@@ -8,10 +7,13 @@ from drf_spectacular.utils import extend_schema
from rest_framework.decorators import action # type: ignore
from rest_framework.permissions import AllowAny, IsAdminUser # type: ignore
from rest_framework.viewsets import ModelViewSet, GenericViewSet # type: ignore
from rest_framework.generics import GenericAPIView # type: ignore
from rest_framework.request import HttpRequest # type: ignore
from rest_framework.response import Response # type: ignore
from rest_framework import status # type: ignore
from rest_framework.generics import get_object_or_404 # type: ignore
from core.utils.views import BaseApiViewMixin
from core.apps.companies.permissions import IsCompanyAccount
from core.apps.companies.models import (
CompanyModel,
@@ -26,7 +28,6 @@ from core.apps.companies.serializers import (
DestroyCompanySerializer,
RetrieveCompanyAccountSerializer,
BaseCompanyAccountSerializer,
RetrieveCompanyFolderSerializer,
CreateFolderForCompanySerializer,
@@ -44,10 +45,10 @@ UserModel = get_user_model()
######################################################################
# View Only For Company CRUD That Belongs To Admin.
# Crud
######################################################################
@extend_schema(tags=["Company"])
class CompanyView(BaseViewSetMixin, ModelViewSet):
class CompanyCrudViewSet(BaseViewSetMixin, ModelViewSet):
queryset = CompanyModel.objects.all()
serializer_class = ListCompanySerializer
permission_classes = [AllowAny]
@@ -71,16 +72,16 @@ class CompanyView(BaseViewSetMixin, ModelViewSet):
######################################################################
# company/<uuid:pk>/contract Views
######################################################################
class CompanyContractViewSet(BaseViewSetMixin, GenericViewSet):
class CompanyContractApiView(BaseApiViewMixin, GenericAPIView): # type: ignore
queryset = CompanyModel.objects.all()
permission_classes = [AllowAny]
permission_classes = [IsCompanyAccount]
serializer_class = BaseContractSerializer
action_permission_classes = {
"list_contract": [IsCompanyAccount]
method_permission_classes = {
"get": [IsCompanyAccount],
}
action_serializer_class = {
"list_contract": RetrieveContractSerializer
method_serializer_class = {
"get": RetrieveContractSerializer,
}
#! TODO: status should be added.
@@ -88,8 +89,7 @@ class CompanyContractViewSet(BaseViewSetMixin, GenericViewSet):
summary="Company Contracts",
description="Get List Company Contracts"
)
@action(methods=["GET"], detail=True, url_path="contracts")
def list_contract(
def get(
self,
request: HttpRequest,
*args: object,
@@ -112,18 +112,20 @@ class CompanyContractViewSet(BaseViewSetMixin, GenericViewSet):
######################################################################
# company/<uuid:pk>/accounts Views
######################################################################
class CompanyAccountViewSet(BaseViewSetMixin, GenericViewSet):
class CompanyAccountView(GenericAPIView):
queryset = CompanyModel.objects.all()
serializer_class = BaseCompanyAccountSerializer
permission_classes = [AllowAny]
serializer_class = None
permission_classes = [IsCompanyAccount]
action_permission_classes = {
"list_account": [IsCompanyAccount]
}
action_serializer_class = {
"list_account": RetrieveCompanyAccountSerializer
}
def get_serializer_class(self):
if self.request.method == "GET":
return RetrieveCompanyAccountSerializer
return RetrieveCompanyFolderSerializer
@extend_schema(
summary="List company accounts",
description="List Company Accounts"
@@ -144,36 +146,26 @@ class CompanyAccountViewSet(BaseViewSetMixin, GenericViewSet):
######################################################################
# company/<uuid:pk>/folders Views
######################################################################
class CompanyFolderViewSet(BaseViewSetMixin, GenericViewSet):
class CompanyFolderApiView(GenericAPIView):
queryset = CompanyModel.objects.all()
permission_classes = [AllowAny]
permission_classes = [IsCompanyAccount]
action_permission_classes = {
"list_folder": [IsCompanyAccount],
"create_folder": [IsCompanyAccount],
}
action_serializer_class = { # type: ignore
"list_folder": RetrieveCompanyFolderSerializer,
"create_folder": CreateFolderForCompanySerializer,
}
def get_serializer_class(self): # type: ignore
if self.request.method == "POST":
return CreateFolderForCompanySerializer
return RetrieveCompanyFolderSerializer
@extend_schema(
summary="List Company Folders",
description="List Company Folders"
)
@action(methods=["GET"], detail=True, url_path="folders")
def list_folder(self, pk: uuid.UUID, *args: object, **kwargs: object) -> Response:
folders = CompanyFolderModel.objects.filter(company__id=pk)
ser = self.get_serializer(instance=folders, many=True) # type: ignore
return Response(data=ser.data, status=status.HTTP_200_OK)
@extend_schema(
summary="Create Folder for company",
description="Create Folder for company",
)
@action(url_path="folders", detail=True, methods=["POST"])
def create_folder(self, request: HttpRequest, *args: object, **kwargs: object) -> Response:
@extend_schema(summary="List Company Folders")
def get(self, request: HttpRequest, *args: object, **kwargs: object) -> Response:
company = self.get_object()
ser = self.get_serializer(data=data, context={"company": company}) # type: ignore
ser.is_valid(raise_exception=True)
return Response(data=ser.data, status=status.HTTP_201_CREATED)
folders = CompanyFolderModel.objects.filter(company=company)
serializer = self.get_serializer(instance=folders, many=True)
return Response(serializer.data, status=status.HTTP_200_OK)
@extend_schema(summary="Create Folder for Company")
def post(self, request: HttpRequest, *args: object, **kwargs: object):
company = self.get_object()
serializer = self.get_serializer(data=request.data, context={"company_id": company.pk})
serializer.is_valid(raise_exception=True)
serializer.save()
return Response(serializer.data, status=status.HTTP_201_CREATED)

View File

@@ -1,10 +1,12 @@
from typing import cast
from django_core.mixins import BaseViewSetMixin # type: ignore
from django.db import transaction
from drf_spectacular.utils import extend_schema
from rest_framework.decorators import action # type: ignore
from rest_framework.permissions import AllowAny, IsAdminUser # type: ignore
from rest_framework.viewsets import ModelViewSet # type: ignore
from rest_framework.viewsets import ModelViewSet, GenericViewSet # type: ignore
from rest_framework.generics import GenericAPIView # type: ignore
from rest_framework.request import HttpRequest # type: ignore
from rest_framework.response import Response # type: ignore
from rest_framework import status # type: ignore
@@ -21,10 +23,12 @@ from core.apps.companies.serializers.folders import (
)
######################################################################
# Crud
######################################################################
@extend_schema(tags=["CompanyFolder"])
class CompanyFolderView(BaseViewSetMixin, ModelViewSet):
class CompanyFolderCrudViewSet(BaseViewSetMixin, ModelViewSet):
queryset = CompanyFolderModel.objects.all()
serializer_class = ListCompanyFolderSerializer
permission_classes = [AllowAny]
action_permission_classes = { # type: ignore
@@ -33,7 +37,6 @@ class CompanyFolderView(BaseViewSetMixin, ModelViewSet):
"create": [IsAdminUser],
"update": [IsAdminUser],
"destroy": [IsAdminUser],
"create_contract": [IsFolderOwner]
}
action_serializer_class = { # type: ignore
"list": ListCompanyFolderSerializer,
@@ -41,24 +44,33 @@ class CompanyFolderView(BaseViewSetMixin, ModelViewSet):
"create": CreateCompanyFolderSerializer,
"update": UpdateCompanyFolderSerializer,
"destroy": DestroyCompanyFolderSerializer,
"create_contract": CreateContractSerializer,
}
######################################################################
# /contract-folders/<uuid:pk>/contracts
######################################################################
class ContractFolderApiView(GenericAPIView):
queryset = CompanyFolderModel.objects.all()
permission_classes = [AllowAny]
serializer_class = None
def get_serializer_class(self): # type: ignore
if self.request.method == "POST":
return CreateContractSerializer
return self.serializer_class
@extend_schema(
summary="Create Contract For Folder",
description="Create Contract For Folder",
)
@action(methods=["POST"], detail=True, url_path="contracts")
def create_contract(
self,
request: HttpRequest,
*args: object,
**kwargs: object
) -> Response:
ser = cast(
CreateContractSerializer,
self.get_serializer(data=request.data) # type: ignore
)
ser.is_valid(raise_exception=True)
ser.save()
def create_contract(self, request: HttpRequest, *args: object, **kwargs: object) -> Response:
with transaction.atomic():
folder = cast(CompanyFolderModel, self.get_object())
ser = cast(CreateContractSerializer, self.get_serializer(data=request.data)) # type: ignore
ser.is_valid(raise_exception=True)
contract = ser.save()
folder.contracts.add(contract)
return Response(ser.data, status.HTTP_201_CREATED)