Filters for OpsLearning API endpoint

Author: szabozoltan69

main/urls.py

@@ -59,15 +59,15 @@
 from databank.views import CountryOverviewViewSet
 from local_units.views import (
     LocalUnitListAPIView, LocalUnitDetailAPIView,
-    DelegationOfficeListAPIView, DelegationOfficeDetailAPIView
-    )
+    DelegationOfficeListAPIView, DelegationOfficeDetailAPIView)
 
 # DRF routes
 from rest_framework import routers
 from drf_spectacular.views import SpectacularAPIView, SpectacularRedocView, SpectacularSwaggerView
 from api import drf_views as api_views
 from flash_update import views as flash_views
 from per import drf_views as per_views
+from per.views import LearningTypes
 from deployments import drf_views as deployment_views
 from notifications import drf_views as notification_views
 from registrations import drf_views as registration_views
@@ -189,6 +189,7 @@
     url(r"^api/v2/primarysector", ProjectPrimarySectors.as_view()),
     url(r"^api/v2/secondarysector", ProjectSecondarySectors.as_view()),
     url(r"^api/v2/projectstatus", ProjectStatuses.as_view()),
+    url(r"^api/v2/learningtype", LearningTypes.as_view()),
     # url(r"^api/v2/create_field_report/", api_views.CreateFieldReport.as_view()),
     # url(r"^api/v2/update_field_report/(?P<pk>\d+)/", api_views.UpdateFieldReport.as_view()),
     url(r"^get_auth_token", GetAuthToken.as_view()),

notifications/tests.py

@@ -1,4 +1,3 @@
-import typing
 from datetime import datetime, timezone
 from django.conf import settings
 from modeltranslation.utils import build_localized_fieldname

per/drf_views.py

@@ -19,12 +19,14 @@
 
 from .admin_classes import RegionRestrictedAdmin
 from api.models import Country
+from deployments.models import SectorTag
 from .models import (
     FormData,
     FormArea,
     FormComponent,
     FormQuestion,
     FormAnswer,
+    OrganizationTypes,
     OpsLearning,
     Overview,
     NiceDocument,
@@ -67,6 +69,7 @@
     PerPrioritizationFilter,
     PerWorkPlanFilter,
 )
+from django_filters.widgets import CSVWidget
 from .custom_renderers import NarrowCSVRenderer
 
 
@@ -370,12 +373,64 @@ def get_queryset(self):
         return self.get_filtered_queryset(self.request, queryset, dispatch=0)
 
 
+class OpsLearningFilter(filters.FilterSet):
+    type_validated = filters.NumberFilter(field_name='type_validated', lookup_expr='exact')
+    appeal_document_id = filters.NumberFilter(field_name='appeal_document_id', lookup_expr='exact')
+    organization_validated__in = filters.ModelMultipleChoiceFilter(
+        label='validated_organizations',
+        field_name='organization_validated',
+        help_text='Organization GO identifiers, comma separated',
+        widget=CSVWidget,
+        queryset=OrganizationTypes.objects.all(),
+    )
+    sector_validated__in = filters.ModelMultipleChoiceFilter(
+        label='validated_sectors',
+        field_name='sector_validated',
+        help_text='Sector identifiers, comma separated',
+        widget=CSVWidget,
+        queryset=SectorTag.objects.all(),
+    )
+    per_component_validated__in = filters.ModelMultipleChoiceFilter(
+        label='validated_per_components',
+        field_name='per_component_validated',
+        help_text='PER Component identifiers, comma separated',
+        widget=CSVWidget,
+        queryset=FormComponent.objects.all(),
+    )
+
+    class Meta:
+        model = OpsLearning
+        fields = {
+            'id': ('exact', 'in'),
+            'created_at': ('exact', 'gt', 'gte', 'lt', 'lte'),
+            'modified_at': ('exact', 'gt', 'gte', 'lt', 'lte'),
+            'is_validated': ('exact',),
+            'learning': ('exact', 'icontains'),
+            'learning_validated': ('exact', 'icontains'),
+            'organization_validated': ('exact',),
+            'sector_validated': ('exact',),
+            'per_component_validated': ('exact',),
+            'appeal_code': ('exact', 'in'),
+            'appeal_code__code': ('exact', 'icontains', 'in'),
+            'appeal_code__num_beneficiaries': ('exact', 'gt', 'gte', 'lt', 'lte'),
+            'appeal_code__start_date': ('exact', 'gt', 'gte', 'lt', 'lte'),
+            'appeal_code__dtype': ('exact', 'in'),
+            'appeal_code__country': ('exact', 'in'),
+            'appeal_code__country__name': ('exact', 'in'),
+            'appeal_code__country__iso': ('exact', 'in'),
+            'appeal_code__country__iso3': ('exact', 'in'),
+            'appeal_code__region': ('exact', 'in'),
+        }
+
+
 class OpsLearningViewset(viewsets.ModelViewSet):
     """
     A simple ViewSet for viewing and editing OpsLearning records.
     """
     queryset = OpsLearning.objects.all()
     permission_classes = [OpsLearningPermission]
+    filterset_class = OpsLearningFilter
+    search_fields = ('learning', 'learning_validated', 'appeal_code__code', 'appeal_code__name', 'appeal_code__name_en', 'appeal_code__name_es', 'appeal_code__name_fr', 'appeal_code__name_ar')
 
     def get_renderers(self):
         serializer = self.get_serializer()

per/models.py

@@ -624,7 +624,7 @@ class LearningType(models.IntegerChoices):
     CHALLENGE = 2, _('Challenge')
 
 
-reversion.register(follow=('appeal_code', 'organization', 'sector', 'per_component', 'organization_validated', 'sector_validated', 'per_component_validated'))
+@reversion.register(follow=('appeal_code', 'organization', 'sector', 'per_component', 'organization_validated', 'sector_validated', 'per_component_validated'))
 class OpsLearning(models.Model):
     learning = models.TextField(verbose_name=_("learning"), null=True, blank=True)
     learning_validated = models.TextField(verbose_name=_("learning (validated)"), null=True, blank=True)

per/views.py

@@ -6,23 +6,14 @@
 
 from rest_framework import authentication, permissions
 from rest_framework.views import APIView
-from rest_framework import (
-    views,
-    viewsets,
-    response,
-    permissions,
-    status,
-    mixins,
-    serializers,
-)
-
 from .models import (
     Form,
     FormData,
     WorkPlan,
     Overview,
     FormArea,
     FormQuestion,
+    LearningType
 )
 from .admin_classes import RegionRestrictedAdmin
 from api.views import bad_request
@@ -40,48 +31,6 @@ def parse_date(date_string):
     return datetime.strptime(date_string[:10], dateformat).replace(tzinfo=timezone.utc)
 
 
-# class CreatePerForm(APIView):
-#     authentication_classes = (authentication.TokenAuthentication,)
-#     permissions_classes = (permissions.IsAuthenticated,)
-
-#     def post(self, request):
-#         area_id = request.data.get('area_id', None)
-#         comment = request.data.get('comment', None)
-#         overview_id = request.data.get('overview_id', None)
-#         questions = request.data.get('questions', None)
-#         user_id = request.data.get('user_id', None)
-
-#         if questions is None:
-#             return bad_request('Questions are missing from the request.')
-
-#         try:
-#             form = Form.objects.create(
-#                 area_id=area_id,
-#                 user_id=user_id,
-#                 comment=comment,
-#                 overview_id=overview_id
-#             )
-#         except Exception:
-#             logger.error('Could not insert PER form record.', exc_info=True)
-#             return bad_request('Could not insert PER form record.')
-
-#         # Create FormData of the Form
-#         try:
-#             with transaction.atomic():  # all or nothing
-#                 for qid in questions:
-#                     FormData.objects.create(
-#                         form=form,
-#                         question_id=qid,
-#                         selected_answer_id=questions[qid]['selected_answer'],
-#                         notes=questions[qid]['notes']
-#                     )
-#         except Exception:
-#             logger.error('Could not insert PER formdata record.', exc_info=True)
-#             return bad_request('Could not insert PER formdata record.')
-
-#         return JsonResponse({'status': 'ok'})
-
-
 class UpdatePerForm(APIView):
     authentication_classes = (authentication.TokenAuthentication,)
     permissions_classes = (permissions.IsAuthenticated,)
@@ -234,27 +183,6 @@ def post(self, request):
         return JsonResponse({"status": "ok"})
 
 
-# # For now, a Form can only be deleted if it's parent Overview is deleted
-# class DeletePerForm(APIView):
-#     authentication_classes = (authentication.TokenAuthentication,)
-#     permissions_classes = (permissions.IsAuthenticated,)
-
-#     def post(self, request):
-#         user = request.user
-#         form_id = request.data.get('id', None)
-#         if form_id is None:
-#             return bad_request('Need to provide Form ID.')
-
-#         try:
-#             # Also deletes FormData since CASCADE fk
-#             # TODO: check for is_finalized of Overview maybe?
-#             Form.objects.filter(id=form_id, user=user).delete()
-#         except Exception:
-#             return bad_request('Could not delete PER Form.')
-
-#         return JsonResponse({'status': 'ok'})
-
-
 class WorkPlanSent(APIView):
     authentication_classes = (authentication.TokenAuthentication,)
     permissions_classes = (permissions.IsAuthenticated,)
@@ -536,3 +464,10 @@ def post(self, request):
             return bad_request("Could not delete PER WorkPlan.")
 
         return JsonResponse({"status": "ok"})
+
+
+class LearningTypes(APIView):
+    @classmethod
+    def get(cls, request):
+        keys_labels = [{"key": i, "label": v} for i, v in LearningType.choices]
+        return JsonResponse(keys_labels, safe=False)