Merge pull request #988 from weni-ai/feat/internal-projects-api

Feat/internal projects api

Author: AlisoSouza

connect/api/v2/internals/paginations.py

@@ -0,0 +1,13 @@
+from rest_framework.pagination import PageNumberPagination
+from django.conf import settings
+
+
+class ProjectsPageNumberPagination(PageNumberPagination):
+    """
+    Pagination class for internal projects API.
+    Returns paginated results in the format: {count, next, previous, results}
+    """
+    page_size = getattr(settings, 'PROJECTS_PAGE_SIZE', 100)
+    page_size_query_param = 'page_size'
+    max_page_size = 1000
+    page_query_param = 'page'

connect/api/v2/internals/permissions.py

@@ -0,0 +1,19 @@
+from rest_framework.permissions import BasePermission
+from django.conf import settings
+
+
+class ProjectsAPITokenPermission(BasePermission):
+    """
+    Permission class for internal projects API.
+    Validates Bearer token from Authorization header against PROJECTS_API_TOKEN setting.
+    """
+    def has_permission(self, request, view):
+        token = request.META.get("HTTP_AUTHORIZATION")
+        if token is None or not token.startswith("Bearer "):
+            return False
+
+        expected_token = f"Bearer {getattr(settings, 'PROJECTS_API_TOKEN', '')}"
+        return token == expected_token
+
+    def has_object_permission(self, request, view, obj):
+        return self.has_permission(request, view)

connect/api/v2/internals/serializers.py

@@ -231,3 +231,22 @@ def get_projects(self, obj):
         """Get all organization projects"""
         projects = obj.project.all()
         return CRMProjectSerializer(projects, many=True).data
+
+
+class InternalProjectsListSerializer(serializers.ModelSerializer):
+    """
+    Simplified serializer for internal projects list API.
+    Returns only uuid and timezone fields.
+    """
+    class Meta:
+        model = Project
+        fields = ["uuid", "timezone"]
+
+    uuid = serializers.UUIDField(read_only=True)
+    timezone = serializers.SerializerMethodField()
+
+    def get_timezone(self, obj):
+        """Return timezone as string or None"""
+        if obj.timezone:
+            return str(obj.timezone)
+        return None

connect/api/v2/internals/views.py

@@ -12,8 +12,11 @@
     CustomParameterSerializer,
     InternalProjectSerializer,
     CRMOrganizationSerializer,
+    InternalProjectsListSerializer,
 )
 from connect.api.v2.internals.filters import CRMOrganizationFilter
+from connect.api.v2.internals.permissions import ProjectsAPITokenPermission
+from connect.api.v2.internals.paginations import ProjectsPageNumberPagination
 from connect.api.v1.internal.permissions import ModuleHasPermission
 from connect.api.v1.organization.permissions import IsCRMUser
 from connect.api.v2.paginations import CustomCursorPagination
@@ -134,3 +137,31 @@ def list(self, request, *args, **kwargs):
     def retrieve(self, request, *args, **kwargs):
         """Retrieve a specific organization by UUID"""
         return super().retrieve(request, *args, **kwargs)
+
+
+class InternalProjectsListView(views.APIView):
+    """
+    Internal API endpoint to list all projects with pagination.
+    Returns projects in format: {count, next, previous, results: [{uuid, timezone}]}
+    Authentication: Bearer token via PROJECTS_API_TOKEN setting
+    """
+    authentication_classes = []
+    permission_classes = [ProjectsAPITokenPermission]
+    pagination_class = ProjectsPageNumberPagination
+
+    def get(self, request, **kwargs):
+        """
+        List all projects with pagination.
+        Query params: page, page_size
+        """
+        queryset = Project.objects.all().order_by('uuid')
+
+        paginator = self.pagination_class()
+        page = paginator.paginate_queryset(queryset, request)
+
+        if page is not None:
+            serializer = InternalProjectsListSerializer(page, many=True)
+            return paginator.get_paginated_response(serializer.data)
+
+        serializer = InternalProjectsListSerializer(queryset, many=True)
+        return Response(serializer.data)

connect/api/v2/routers.py

@@ -166,4 +166,8 @@
             {"patch": "partial_update"}
         ),
     ),
+    path(
+        "internals/connect/projects",
+        connect_internal_views.InternalProjectsListView.as_view(),
+    ),
 ]

connect/settings.py

@@ -586,3 +586,6 @@
 RATE_LIMIT_REQUESTS = env.int("RATE_LIMIT_REQUESTS")
 RATE_LIMIT_WINDOW = env.int("RATE_LIMIT_WINDOW")
 RATE_LIMIT_BLOCK_TIME = env.int("RATE_LIMIT_BLOCK_TIME")
+
+PROJECTS_API_TOKEN = env.str("PROJECTS_API_TOKEN", default="")
+PROJECTS_PAGE_SIZE = env.int("PROJECTS_PAGE_SIZE", default=100)