feat(project_management): Add import_project permission and add api serializer

ref: #295 #301

app/api/serializers/project_management/projects.py

@@ -41,6 +41,44 @@ class ProjectSerializer(
             )
         )
 
+    class Meta:
+
+        model = Project
+
+        fields =  [
+            'id',
+            'organization',
+            'state',
+            'project_type',
+            'priority',
+            'name',
+            'description',
+            'code',
+            'planned_start_date',
+            'planned_finish_date',
+            'real_start_date',
+            'real_finish_date',
+            'manager_user',
+            'manager_team',
+            'team_members',
+            'project_tasks_url',
+            'percent_completed',
+            'created',
+            'modified',
+            'url',
+        ]
+
+        read_only_fields = [
+            'id',
+            'url',
+            'created',
+            'modified',
+        ]
+
+
+
+class ProjectImportSerializer(ProjectSerializer):
+
     class Meta:
 
         model = Project

app/api/views/project_management/projects.py

@@ -1,18 +1,20 @@
 from django.db.models import Q
 from django.shortcuts import get_object_or_404
 
-from drf_spectacular.utils import extend_schema, OpenApiResponse
+from drf_spectacular.utils import extend_schema, OpenApiResponse, OpenApiRequest, PolymorphicProxySerializer
 
 from rest_framework import generics, viewsets
 from rest_framework.response import Response
 
 from access.mixin import OrganizationMixin
 
-from api.serializers.project_management.projects import ProjectSerializer
+from api.serializers.project_management.projects import ProjectSerializer, ProjectImportSerializer
 from api.views.mixin import OrganizationPermissionAPI
 
 from project_management.models.projects import Project
 
+from settings.models.user_settings import UserSettings
+
 
 
 class View(OrganizationMixin, viewsets.ModelViewSet):
@@ -23,13 +25,29 @@ class View(OrganizationMixin, viewsets.ModelViewSet):
 
     queryset = Project.objects.all()
 
-    serializer_class = ProjectSerializer
+    # serializer_class = ProjectSerializer
+
+    def get_serializer_class(self):
+
+        if self.has_organization_permission(
+            organization = UserSettings.objects.get(user = self.request.user).default_organization,
+            permissions_required = ['project_management.import_project']
+        ) or self.request.user.is_superuser:
+
+            return ProjectImportSerializer
+
+        return ProjectSerializer
 
     @extend_schema(
         summary = 'Create a project',
+        description = """**Note:** Users whom lack permssion `import_project`,
+        will be unable to add, edit and view fields: `created`, `external_ref`, `external_system`,
+        and `is_deleted`.
+        """,
         methods=["POST"],
+        request = ProjectImportSerializer,
         responses = {
-            201: OpenApiResponse(description='project created', response=ProjectSerializer),
+            201: OpenApiResponse(description='project created', response=ProjectImportSerializer),
             403: OpenApiResponse(description='User is missing create permissions'),
         }
     )
@@ -38,13 +56,33 @@ class View(OrganizationMixin, viewsets.ModelViewSet):
         return super().create(request, *args, **kwargs)
 
 
-    @extend_schema( summary='Fetch projects', methods=["GET"])
+    @extend_schema(
+        summary='Fetch projects',
+        description = """**Note:** Users whom lack permssion `import_project`,
+        will be unable to add, edit and view fields: `created`, `external_ref`, `external_system`,
+        and `is_deleted`.
+        """,
+        methods=["GET"],
+        responses = {
+            200: OpenApiResponse(description='projects', response=ProjectImportSerializer)
+        }
+    )
     def list(self, request):
 
         return super().list(request)
 
 
-    @extend_schema( summary='Fetch the selected project', methods=["GET"])
+    @extend_schema(
+        summary='Fetch the selected project',
+        description = """**Note:** Users whom lack permssion `import_project`,
+        will be unable to add, edit and view fields: `created`, `external_ref`, `external_system`,
+        and `is_deleted`.
+        """,
+        methods=["GET"],
+        responses = {
+            200: OpenApiResponse(description='projects', response=ProjectImportSerializer)
+        }
+    )
     def retrieve(self, request, *args, **kwargs):
 
         return super().retrieve(request, *args, **kwargs)

app/project_management/migrations/0012_alter_project_options.py

@@ -0,0 +1,17 @@
+# Generated by Django 5.0.8 on 2024-09-18 03:22
+
+from django.db import migrations
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('project_management', '0011_alter_project_is_deleted'),
+    ]
+
+    operations = [
+        migrations.AlterModelOptions(
+            name='project',
+            options={'ordering': ['code', 'name'], 'permissions': [('import_project', 'Can import a project')], 'verbose_name': 'Project', 'verbose_name_plural': 'Projects'},
+        ),
+    ]

app/project_management/models/projects.py

@@ -21,6 +21,10 @@ class Project(ProjectCommonFieldsName):
             'name',
         ]
 
+        permissions = [
+            ('import_project', 'Can import a project'),
+        ]
+
         verbose_name = 'Project'
 
         verbose_name_plural = 'Projects'
@@ -178,6 +182,13 @@ class Project(ProjectCommonFieldsName):
     )
 
 
+
+    fields_all: list = []
+
+    fields_import: list = []
+
+
+
     def __str__(self):
 
         return self.name