Merge pull request #132 from maykinmedia/feature/127-selectielijstklasse-endpoint

[#127] Selectielijstklasse choices endpoint

Author: SilviaAmAm

Diff for: backend/src/openarchiefbeheer/api/urls.py

@@ -14,7 +14,11 @@
     DestructionListReviewViewSet,
     DestructionListViewSet,
 )
-from openarchiefbeheer.zaken.api.views import CacheZakenView, ZaaktypenChoicesView
+from openarchiefbeheer.zaken.api.views import (
+    CacheZakenView,
+    SelectielijstklasseChoicesView,
+    ZaaktypenChoicesView,
+)
 from openarchiefbeheer.zaken.api.viewsets import ZakenViewSet
 
 app_name = "api"
@@ -81,6 +85,11 @@
                     ZaaktypenChoicesView.as_view(),
                     name="retrieve-zaaktypen-choices",
                 ),
+                path(
+                    "_selectielijstklasse-choices",
+                    SelectielijstklasseChoicesView.as_view(),
+                    name="retrieve-selectielijstklasse-choices",
+                ),
                 path("", include(router.urls)),
             ]
         ),

Diff for: backend/src/openarchiefbeheer/destruction/migrations/0007_destructionlistreview_destructionlistitemreview.py

@@ -84,7 +84,7 @@ class Migration(migrations.Migration):
                     "feedback",
                     models.TextField(
                         blank=False,
-                        help_text="If 'other' was selected in the field 'requested change', feedback about what should be done with the case can be provided here.",
+                        help_text="What needs to be changed about the case.",
                         max_length=2000,
                         verbose_name="feedback",
                     ),

Diff for: backend/src/openarchiefbeheer/destruction/models.py

@@ -289,10 +289,7 @@ class DestructionListItemReview(models.Model):
         _("feedback"),
         max_length=2000,
         blank=False,
-        help_text=_(
-            "If 'other' was selected in the field 'requested change', "
-            "feedback about what should be done with the case can be provided here."
-        ),
+        help_text=_("What needs to be changed about the case."),
     )
 
     class Meta:

Diff for: backend/src/openarchiefbeheer/zaken/api/serializers.py

@@ -66,3 +66,22 @@ class ZaaktypeChoiceSerializer(serializers.Serializer):
             "the zaaktype will no longer be valid (if present)."
         )
     )
+
+
+class SelectielijstklasseChoicesSerializer(serializers.Serializer):
+    label = serializers.CharField(
+        help_text=_(
+            "The description field of the resultaat from the selectielijst API."
+        )
+    )
+    value = serializers.CharField(
+        help_text=_("The URL field of the resultaat from the selectielijst API.")
+    )
+
+
+class SelectielijstklasseChoicesQueryParamSerializer(serializers.Serializer):
+    zaak = serializers.URLField(
+        help_text=_(
+            "The URL of the zaak for which the selectielijstklasse choices are needed."
+        )
+    )

Diff for: backend/src/openarchiefbeheer/zaken/api/views.py

@@ -10,9 +10,14 @@
 
 from openarchiefbeheer.destruction.api.permissions import CanStartDestructionPermission
 
+from ..models import Zaak
 from ..tasks import retrieve_and_cache_zaken_from_openzaak
-from ..utils import retrieve_zaaktypen_choices
-from .serializers import ZaaktypeChoiceSerializer
+from ..utils import retrieve_selectielijstklasse_choices, retrieve_zaaktypen_choices
+from .serializers import (
+    SelectielijstklasseChoicesQueryParamSerializer,
+    SelectielijstklasseChoicesSerializer,
+    ZaaktypeChoiceSerializer,
+)
 
 
 class CacheZakenView(APIView):
@@ -49,3 +54,35 @@ def get(self, request, *args, **kwargs):
         serializer = ZaaktypeChoiceSerializer(data=zaaktypen_choices, many=True)
         serializer.is_valid(raise_exception=True)
         return Response(serializer.data, status=status.HTTP_200_OK)
+
+
+class SelectielijstklasseChoicesView(APIView):
+    permission_classes = [IsAuthenticated & CanStartDestructionPermission]
+
+    @extend_schema(
+        summary=_("Retrieve selectielijstklasse choices"),
+        description=_(
+            "This takes the 'selectielijstprocestype' from the 'zaaktype', "
+            "then retrieves all the 'resultaten' possible for this 'procestype' from the selectielijst API."
+        ),
+        tags=["private"],
+        responses={
+            200: SelectielijstklasseChoicesSerializer,
+        },
+        parameters=[SelectielijstklasseChoicesQueryParamSerializer],
+    )
+    def get(self, request, *args, **kwargs):
+        seralizer = SelectielijstklasseChoicesQueryParamSerializer(
+            data=request.query_params
+        )
+        seralizer.is_valid(raise_exception=True)
+
+        zaak = Zaak.objects.get(url=seralizer.validated_data["zaak"])
+
+        processtype = zaak._expand["zaaktype"].get("selectielijst_procestype")
+
+        if not processtype:
+            return Response(data=[])
+
+        choices = retrieve_selectielijstklasse_choices(processtype["url"])
+        return Response(data=choices)

Diff for: backend/src/openarchiefbeheer/zaken/tests/factories.py

@@ -26,7 +26,10 @@ class Params:
             _expand={
                 "zaaktype": {
                     "url": "http://catalogue-api.nl/zaaktypen/111-111-111",
-                    "selectielijst_procestype": {"nummer": 1},
+                    "selectielijst_procestype": {
+                        "nummer": 1,
+                        "url": "https://selectielijst.nl/api/v1/procestypen/7ff2b005-4d84-47fe-983a-732bfa958ff5",
+                    },
                     "omschrijving": "Aangifte behandelen",
                 },
                 "resultaat": {

Diff for: backend/src/openarchiefbeheer/zaken/tests/test_views.py

@@ -3,6 +3,7 @@
 from django.core.cache import cache
 from django.utils.translation import gettext_lazy as _
 
+from furl import furl
 from requests_mock import Mocker
 from rest_framework import status
 from rest_framework.reverse import reverse
@@ -13,6 +14,7 @@
 from openarchiefbeheer.accounts.tests.factories import UserFactory
 
 from ..tasks import retrieve_and_cache_zaken_from_openzaak
+from .factories import ZaakFactory
 
 
 class ZakenViewsTestCase(APITestCase):
@@ -158,3 +160,143 @@ def test_response_cached(self, m):
 
         history = m.request_history
         self.assertEqual(len(history), 1)
+
+
+class SelectielijstklasseChoicesViewTests(APITestCase):
+    def setUp(self):
+        super().setUp()
+
+        self.addCleanup(cache.clear)
+
+    def test_not_authenticated(self):
+        endpoint = reverse("api:retrieve-selectielijstklasse-choices")
+
+        response = self.client.get(endpoint)
+
+        self.assertEqual(response.status_code, status.HTTP_403_FORBIDDEN)
+
+    def test_authenticated_without_permission(self):
+        user = UserFactory.create(role__can_start_destruction=False)
+
+        self.client.force_authenticate(user=user)
+        endpoint = reverse("api:retrieve-selectielijstklasse-choices")
+
+        response = self.client.get(endpoint)
+
+        self.assertEqual(response.status_code, status.HTTP_403_FORBIDDEN)
+
+    @Mocker()
+    def test_retrieve_choices(self, m):
+        ServiceFactory.create(
+            api_type=APITypes.orc,
+            api_root="http://selectielijst.nl/api/v1",
+        )
+        user = UserFactory.create(role__can_start_destruction=True)
+        zaak = ZaakFactory.create(with_expand=True)
+        process_type_url = zaak._expand["zaaktype"]["selectielijst_procestype"]["url"]
+
+        m.get(
+            f"http://selectielijst.nl/api/v1/resultaten?procesType={process_type_url}",
+            json={
+                "count": 3,
+                "results": [
+                    {
+                        "url": "http://selectielijst.nl/api/v1/resultaten/2e86a8ca-0269-446c-8da2-6f4d08be422d",
+                        "nummer": 1,
+                        "volledigNummer": "11.1",
+                        "naam": "Verleend",
+                        "waardering": "vernietigen",
+                        "bewaartermijn": "P1Y",
+                    },
+                    {
+                        "url": "http://selectielijst.nl/api/v1/resultaten/5038528b-0eb7-4502-a415-a3093987d69b",
+                        "nummer": 1,
+                        "naam": "Verleend",
+                        "waardering": "vernietigen",
+                        "bewaartermijn": "P2Y",
+                    },
+                    {
+                        "url": "http://selectielijst.nl/api/v1/resultaten/5d102cc6-4a74-4262-a14a-538bbfe3f2da",
+                        "nummer": 2,
+                        "volledigNummer": "11.1.2",
+                        "naam": "Verleend",
+                        "waardering": "vernietigen",
+                    },
+                ],
+            },
+        )
+
+        self.client.force_authenticate(user=user)
+        endpoint = furl(reverse("api:retrieve-selectielijstklasse-choices"))
+        endpoint.args["zaak"] = zaak.url
+
+        response = self.client.get(endpoint.url)
+
+        self.assertEqual(response.status_code, status.HTTP_200_OK)
+        self.assertEqual(
+            response.json(),
+            [
+                {
+                    "value": "http://selectielijst.nl/api/v1/resultaten/2e86a8ca-0269-446c-8da2-6f4d08be422d",
+                    "label": "11.1 - Verleend - vernietigen - P1Y",
+                },
+                {
+                    "value": "http://selectielijst.nl/api/v1/resultaten/5038528b-0eb7-4502-a415-a3093987d69b",
+                    "label": "1 - Verleend - vernietigen - P2Y",
+                },
+                {
+                    "value": "http://selectielijst.nl/api/v1/resultaten/5d102cc6-4a74-4262-a14a-538bbfe3f2da",
+                    "label": "11.1.2 - Verleend - vernietigen",
+                },
+            ],
+        )
+
+    @Mocker()
+    def test_response_cached(self, m):
+        ServiceFactory.create(
+            api_type=APITypes.orc,
+            api_root="http://selectielijst.nl/api/v1",
+        )
+        user = UserFactory.create(role__can_start_destruction=True)
+        zaak = ZaakFactory.create(with_expand=True)
+        process_type_url = zaak._expand["zaaktype"]["selectielijst_procestype"]["url"]
+
+        m.get(
+            f"http://selectielijst.nl/api/v1/resultaten?procesType={process_type_url}",
+            json={
+                "count": 3,
+                "results": [
+                    {
+                        "url": "http://selectielijst.nl/api/v1/resultaten/2e86a8ca-0269-446c-8da2-6f4d08be422d",
+                        "nummer": 1,
+                        "volledigNummer": "11.1",
+                        "naam": "Verleend",
+                        "waardering": "vernietigen",
+                        "bewaartermijn": "P1Y",
+                    },
+                    {
+                        "url": "http://selectielijst.nl/api/v1/resultaten/5038528b-0eb7-4502-a415-a3093987d69b",
+                        "nummer": 1,
+                        "naam": "Verleend",
+                        "waardering": "vernietigen",
+                        "bewaartermijn": "P2Y",
+                    },
+                    {
+                        "url": "http://selectielijst.nl/api/v1/resultaten/5d102cc6-4a74-4262-a14a-538bbfe3f2da",
+                        "nummer": 2,
+                        "volledigNummer": "11.1.2",
+                        "naam": "Verleend",
+                        "waardering": "vernietigen",
+                    },
+                ],
+            },
+        )
+
+        self.client.force_authenticate(user=user)
+        endpoint = furl(reverse("api:retrieve-selectielijstklasse-choices"))
+        endpoint.args["zaak"] = zaak.url
+
+        self.client.get(endpoint.url)
+        self.client.get(endpoint.url)
+
+        self.assertEqual(len(m.request_history), 1)

Diff for: backend/src/openarchiefbeheer/zaken/types.py

@@ -0,0 +1,9 @@
+from dataclasses import dataclass
+from typing import Optional
+
+
+@dataclass
+class DropDownChoice:
+    label: str
+    value: str
+    extra_data: Optional[int] = None

Diff for: backend/src/openarchiefbeheer/zaken/utils.py

@@ -6,12 +6,15 @@
 from ape_pie import APIClient
 from djangorestframework_camel_case.parser import CamelCaseJSONParser
 from djangorestframework_camel_case.util import underscoreize
+from zgw_consumers.api_models.selectielijst import Resultaat
 from zgw_consumers.client import build_client
 from zgw_consumers.concurrent import parallel
 from zgw_consumers.constants import APITypes
 from zgw_consumers.models import Service
 from zgw_consumers.utils import PaginatedResponseData
 
+from .types import DropDownChoice
+
 
 def pagination_helper(
     client: APIClient, paginated_response: PaginatedResponseData, **kwargs
@@ -75,7 +78,7 @@ def get_zaaktype_extra_info(zaaktype: dict) -> str:
     return zaaktype["identificatie"]
 
 
-def retrieve_zaaktypen_choices() -> list[dict]:
+def retrieve_zaaktypen_choices() -> list[DropDownChoice]:
     ztc_service = Service.objects.filter(api_type=APITypes.ztc).first()
     if not ztc_service:
         return []
@@ -101,3 +104,35 @@ def retrieve_zaaktypen_choices() -> list[dict]:
         ]
 
     return zaaktypen
+
+
+def format_selectielijstklasse_choice(resultaat: Resultaat) -> DropDownChoice:
+    description = f"{resultaat.get('volledig_nummer', resultaat["nummer"])} - {resultaat['naam']} - {resultaat['waardering']}"
+    if resultaat.get("bewaartermijn"):
+        description = description + f" - {resultaat['bewaartermijn']}"
+
+    return {
+        "label": description,
+        "value": resultaat["url"],
+    }
+
+
+@lru_cache
+def retrieve_selectielijstklasse_choices(process_type_url: str) -> list:
+    selectielijst_service = Service.objects.filter(api_type=APITypes.orc).first()
+    if not selectielijst_service:
+        return []
+
+    client = build_client(selectielijst_service)
+    with client:
+        response = client.get("resultaten", params={"procesType": process_type_url})
+        response.raise_for_status()
+        data_iterator = pagination_helper(client, response.json())
+
+    results = []
+    for page in data_iterator:
+        results += [
+            format_selectielijstklasse_choice(result) for result in page["results"]
+        ]
+
+    return results