Merge pull request #51 from Xpirix/api_for_orgs_and_courses

Xpirix · web-flow · commit 00dd4066bc35 · 2025-06-27T12:25:05.000+03:00
Api for orgs and courses
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -0,0 +1,37 @@
+# See https://pre-commit.com for more information
+# See https://pre-commit.com/hooks.html for more hooks
+
+exclude: 'static/'
+repos:
+  # Fix end of files
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v5.0.0
+    hooks:
+      - id: trailing-whitespace
+      - id: end-of-file-fixer
+      - id: mixed-line-ending
+        args:
+          - '--fix=lf'
+
+  # Remove unused imports/variables
+  - repo: https://github.com/myint/autoflake
+    rev: v2.3.1
+    hooks:
+      - id: autoflake
+        args:
+          - "--in-place"
+          - "--remove-unused-variables"
+          - "--remove-all-unused-imports"
+
+  # Sort imports
+  - repo: https://github.com/pycqa/isort
+    rev: "6.0.1"
+    hooks:
+      - id: isort
+        args: ["--profile", "black"]
+
+  # Black formatting
+  - repo: https://github.com/psf/black
+    rev: 25.1.0
+    hooks:
+      - id: black
diff --git a/django_project/certification/api_views/certifying_organisations.py b/django_project/certification/api_views/certifying_organisations.py
@@ -0,0 +1,76 @@
+from base.models.project import Project
+from certification.models import CertifyingOrganisation
+from rest_framework import status
+from rest_framework.pagination import PageNumberPagination
+from rest_framework.response import Response
+from rest_framework.views import APIView
+
+from ..serializers.organisation_serializer import CertifyingOrganisationSerializer
+
+
+class CustomPagination(PageNumberPagination):
+    page_size = 10  # Default page size
+    page_size_query_param = (
+        "page_size"  # Allow client to override the page size via query parameter
+    )
+    max_page_size = 100  # Maximum limit allowed
+
+    def get_paginated_response(self, data):
+        return Response(
+            {
+                "count": self.page.paginator.count,
+                "page_size": self.get_page_size(self.request),
+                "next": self.get_next_link(),
+                "previous": self.get_previous_link(),
+                "results": data,
+            }
+        )
+
+
+class CertifyingOrganisationApiListView(APIView):
+    """
+    API view to list all certifying organisations with pagination and optional filtering.
+
+    Available query parameters:
+    - country: Filter organisations by one or more country codes (comma-separated, e.g., ZA or ZA,MG,NL) (optional)
+    - page: Page number to retrieve (default: 1)
+    - page_size: Number of items per page (default: 10, max: 100)
+    """
+
+    # Apply pagination class
+    pagination_class = CustomPagination
+
+    def get(self, request):
+        """
+        Handle GET requests to list certifying organisations.
+
+        Returns paginated response with:
+        - count: Total number of items
+        - page_size: Number of items per page
+        - next: URL to next page (if exists)
+        - previous: URL to previous page (if exists)
+        - results: List of organisations for current page
+        """
+        country_param = request.query_params.get("country")
+        project = Project.objects.get(slug="qgis")
+        organisations = CertifyingOrganisation.approved_objects.filter(
+            project=project, is_archived=False
+        )
+
+        if country_param:
+            country_codes = [
+                c.strip().upper() for c in country_param.split(",") if c.strip()
+            ]
+            organisations = organisations.filter(country__in=country_codes)
+
+        # Paginate the queryset
+        paginator = self.pagination_class()
+        page = paginator.paginate_queryset(organisations, request)
+
+        if page is not None:
+            serializer = CertifyingOrganisationSerializer(page, many=True)
+            return paginator.get_paginated_response(serializer.data)
+
+        # Fallback for non-paginated response if needed
+        serializer = CertifyingOrganisationSerializer(organisations, many=True)
+        return Response(serializer.data, status=status.HTTP_200_OK)
diff --git a/django_project/certification/api_views/course.py b/django_project/certification/api_views/course.py
@@ -1,9 +1,11 @@
 # coding=utf-8
 from datetime import datetime
+
+from base.models.project import Project
 from django.http import HttpResponse
-from rest_framework.views import APIView, Response
 from rest_framework import status
-from base.models.project import Project
+from rest_framework.views import APIView, Response
+
 from ..models.certifying_organisation import CertifyingOrganisation
 from ..models.course import Course
 from ..serializers.course_serializer import CourseSerializer
@@ -14,23 +16,35 @@ class GetUpcomingCourseProject(APIView):
     The location is the location of the training center where this course
     will be held.
 
+    Optional query parameter:
+        - country: Filter courses by the organisation's country (ISO 3166-1 alpha-2 code).
+          Supports single or multiple comma-separated codes.
+          Example: /feed/upcoming-course/?country=ZA or /feed/upcoming-course/?country=ZA,MG,NL
+
     """
 
     def get(self, request):
+        country_param = request.GET.get("country", None)
         try:
             today = datetime.today()
-            project = Project.objects.get(slug='qgis')
+            project = Project.objects.get(slug="qgis")
             courses = Course.objects.filter(
                 certifying_organisation__project=project, start_date__gte=today
-            ).order_by(
-                'certifying_organisation__name', 'start_date'
             )
+            if country_param:
+                country_list = [
+                    c.strip().upper() for c in country_param.split(",") if c.strip()
+                ]
+                if country_list:
+                    courses = courses.filter(
+                        certifying_organisation__country__in=country_list
+                    )
+            courses = courses.order_by("certifying_organisation__name", "start_date")
             serializer = CourseSerializer(courses, many=True)
             return Response(serializer.data)
         except Project.DoesNotExist:
             return HttpResponse(
-                'Project does not exist.',
-                status=status.HTTP_400_BAD_REQUEST
+                "Project does not exist.", status=status.HTTP_400_BAD_REQUEST
             )
 
 
@@ -44,34 +58,30 @@ class GetUpcomingCourseOrganisation(APIView):
     def get(self, request, organisation_slug):
         today = datetime.today()
         try:
-            project = Project.objects.get(slug='qgis')
+            project = Project.objects.get(slug="qgis")
         except Project.DoesNotExist:
             return HttpResponse(
-                'Project does not exist.',
-                status=status.HTTP_400_BAD_REQUEST
+                "Project does not exist.", status=status.HTTP_400_BAD_REQUEST
             )
 
         try:
             organisation = CertifyingOrganisation.objects.get(
-                slug=organisation_slug,
-                project=project
+                slug=organisation_slug, project=project
             )
         except Project.DoesNotExist:
             return HttpResponse(
-                'Organisation does not exist.',
-                status=status.HTTP_400_BAD_REQUEST
+                "Organisation does not exist.", status=status.HTTP_400_BAD_REQUEST
             )
 
         try:
             courses = Course.objects.filter(
                 certifying_organisation=organisation, start_date__gte=today
-            ).order_by('start_date')
+            ).order_by("start_date")
             serializer = CourseSerializer(courses, many=True)
             return Response(serializer.data)
         except Course.DoesNotExist:
             return HttpResponse(
-                'Course does not exist.',
-                status=status.HTTP_400_BAD_REQUEST
+                "Course does not exist.", status=status.HTTP_400_BAD_REQUEST
             )
 
 
@@ -85,18 +95,15 @@ class GetPastCourseProject(APIView):
     def get(self, request):
         try:
             today = datetime.today()
-            project = Project.objects.get(slug='qgis')
+            project = Project.objects.get(slug="qgis")
             courses = Course.objects.filter(
                 certifying_organisation__project=project, end_date__lte=today
-            ).order_by(
-                'certifying_organisation__name', 'start_date'
-            )
+            ).order_by("certifying_organisation__name", "start_date")
             serializer = CourseSerializer(courses, many=True)
             return Response(serializer.data)
         except Project.DoesNotExist:
             return HttpResponse(
-                'Project does not exist.',
-                status=status.HTTP_400_BAD_REQUEST
+                "Project does not exist.", status=status.HTTP_400_BAD_REQUEST
             )
 
 
@@ -110,32 +117,28 @@ class GetPastCourseOrganisation(APIView):
     def get(self, request, organisation_slug):
         today = datetime.today()
         try:
-            project = Project.objects.get(slug='qgis')
+            project = Project.objects.get(slug="qgis")
         except Project.DoesNotExist:
             return HttpResponse(
-                'Project does not exist.',
-                status=status.HTTP_400_BAD_REQUEST
+                "Project does not exist.", status=status.HTTP_400_BAD_REQUEST
             )
 
         try:
             organisation = CertifyingOrganisation.objects.get(
-                slug=organisation_slug,
-                project=project
+                slug=organisation_slug, project=project
             )
         except Project.DoesNotExist:
             return HttpResponse(
-                'Organisation does not exist.',
-                status=status.HTTP_400_BAD_REQUEST
+                "Organisation does not exist.", status=status.HTTP_400_BAD_REQUEST
             )
 
         try:
             courses = Course.objects.filter(
                 certifying_organisation=organisation, end_date__lte=today
-            ).order_by('start_date')
+            ).order_by("start_date")
             serializer = CourseSerializer(courses, many=True)
             return Response(serializer.data)
         except Course.DoesNotExist:
             return HttpResponse(
-                'Course does not exist.',
-                status=status.HTTP_400_BAD_REQUEST
+                "Course does not exist.", status=status.HTTP_400_BAD_REQUEST
             )
diff --git a/django_project/certification/serializers/organisation_serializer.py b/django_project/certification/serializers/organisation_serializer.py
@@ -0,0 +1,29 @@
+from certification.models import CertifyingOrganisation
+from rest_framework import serializers
+
+
+class CertifyingOrganisationSerializer(serializers.ModelSerializer):
+    """Serializer for Certifying Organisation model."""
+
+    country_name = serializers.SerializerMethodField()
+    country_code = serializers.SerializerMethodField()
+
+    class Meta:
+        model = CertifyingOrganisation
+        fields = [
+            "name",
+            "country_name",
+            "country_code",
+            "organisation_email",
+            "url",
+            "address",
+            "organisation_phone",
+        ]
+
+    def get_country_name(self, obj):
+        """Get the name of the country."""
+        return obj.country.name if obj.country else None
+
+    def get_country_code(self, obj):
+        """Get the ISO 3166-1 alpha-2 code of the country."""
+        return obj.country.code if obj.country else None
diff --git a/django_project/certification/tests/api_views/test_courses_list.py b/django_project/certification/tests/api_views/test_courses_list.py
@@ -0,0 +1,96 @@
+# coding=utf-8
+import logging
+
+from certification.tests.model_factories import (
+    CertificateTypeF,
+    CertifyingOrganisationF,
+    CourseConvenerF,
+    CourseF,
+    CourseTypeF,
+    ProjectCertificateTypeF,
+    ProjectF,
+    TrainingCenterF,
+    UserF,
+)
+from django.test import TestCase, override_settings
+from django.test.client import Client
+from django.urls import reverse
+
+
+class TestCourseApiView(TestCase):
+    """Test that Course API View works."""
+
+    @override_settings(
+        VALID_DOMAIN=[
+            "testserver",
+        ]
+    )
+    def setUp(self):
+        """
+        Setup before each test
+        We force the locale to en otherwise it will use
+        the locale of the host running the tests and we
+        will get unpredictable results / 404s
+        """
+
+        self.client = Client()
+        self.client.post("/set_language/", data={"language": "en"})
+        logging.disable(logging.CRITICAL)
+        self.user = UserF.create(
+            **{"username": "anita", "password": "password", "is_staff": True}
+        )
+        self.user.set_password("password")
+        self.user.save()
+        self.project = ProjectF.create()
+        self.certifying_organisation = CertifyingOrganisationF.create(
+            project=self.project
+        )
+        self.training_center = TrainingCenterF.create(
+            certifying_organisation=self.certifying_organisation
+        )
+        self.course_convener = CourseConvenerF.create(
+            certifying_organisation=self.certifying_organisation
+        )
+        self.course_type = CourseTypeF.create(
+            certifying_organisation=self.certifying_organisation
+        )
+        self.course = CourseF.create(
+            certifying_organisation=self.certifying_organisation,
+            training_center=self.training_center,
+            course_convener=self.course_convener,
+            course_type=self.course_type,
+        )
+        self.certificate_type = CertificateTypeF.create()
+        self.project_cert_type = ProjectCertificateTypeF.create(
+            project=self.project, certificate_type=self.certificate_type
+        )
+
+    @override_settings(
+        VALID_DOMAIN=[
+            "testserver",
+        ]
+    )
+    def tearDown(self):
+        """
+        Teardown after each test.
+
+        :return:
+        """
+
+        self.course.delete()
+        self.certifying_organisation.delete()
+        self.project.delete()
+        self.user.delete()
+
+    @override_settings(
+        VALID_DOMAIN=[
+            "testserver",
+        ]
+    )
+    def test_upcoming_courses_api(self):
+        """
+        Test the upcoming courses API endpoint.
+        """
+        response = self.client.get(reverse("feed-upcoming-project-course"))
+        self.assertEqual(response.status_code, 200)
+        self.assertContains(response, self.course.name)
diff --git a/django_project/certification/tests/api_views/test_orgs_list.py b/django_project/certification/tests/api_views/test_orgs_list.py
diff --git a/django_project/certification/urls.py b/django_project/certification/urls.py
