GOATS-743: Extend API to support fetching observations from GPP. (#332)

Author: davner

docs/changes/332.new.rst

@@ -0,0 +1 @@
+Extended API to fetch observations from GPP.

src/goats_tom/api_views/__init__.py

@@ -9,7 +9,7 @@
 from .dragons_recipes import DRAGONSRecipesViewSet
 from .dragons_reduce import DRAGONSReduceViewSet
 from .dragons_runs import DRAGONSRunsViewSet
-from .gpp import GPPProgramViewSet
+from .gpp import GPPObservationViewSet, GPPProgramViewSet
 from .recipes_module import RecipesModuleViewSet
 from .reduceddatum import ReducedDatumViewSet
 from .run_processor import RunProcessorViewSet
@@ -30,4 +30,5 @@
     "ReducedDatumViewSet",
     "AstroDatalabViewSet",
     "GPPProgramViewSet",
+    "GPPObservationViewSet",
 ]

src/goats_tom/api_views/gpp/__init__.py

@@ -1,3 +1,4 @@
+from .observations import GPPObservationViewSet
 from .programs import GPPProgramViewSet
 
-__all__ = ["GPPProgramViewSet"]
+__all__ = ["GPPProgramViewSet", "GPPObservationViewSet"]

src/goats_tom/api_views/gpp/observations.py

@@ -0,0 +1,86 @@
+"""Handles grabbing observations and observation details from GPP."""
+
+__all__ = ["GPPObservationViewSet"]
+
+from asgiref.sync import async_to_sync
+from django.conf import settings
+from gpp_client import GPPClient
+from rest_framework import permissions
+from rest_framework.exceptions import PermissionDenied
+from rest_framework.request import Request
+from rest_framework.response import Response
+from rest_framework.viewsets import GenericViewSet, mixins
+
+
+class GPPObservationViewSet(
+    GenericViewSet, mixins.ListModelMixin, mixins.RetrieveModelMixin
+):
+    serializer_class = None
+    permission_classes = [permissions.IsAuthenticated]
+    queryset = None
+
+    def list(self, request: Request, *args, **kwargs) -> Response:
+        """Return a list of GPP observations associated with the authenticated user.
+
+        Parameters
+        ----------
+        request : Request
+            The HTTP request object, including user context.
+
+        Returns
+        -------
+        Response
+            A DRF Response object containing a list of GPP observations.
+
+        Raises
+        ------
+        PermissionDenied
+            If the authenticated user has not configured GPP login credentials.
+        """
+        if not hasattr(request.user, "gpplogin"):
+            raise PermissionDenied(
+                "GPP login credentials are not configured for this user."
+            )
+        credentials = request.user.gpplogin
+
+        # Setup client to communicate with GPP.
+        client = GPPClient(url=settings.GPP_URL, token=credentials.token)
+        observations = async_to_sync(client.observation.get_all)()
+
+        return Response(observations)
+
+    def retrieve(self, request: Request, *args, **kwargs) -> Response:
+        """Return details for a specific GPP observation by observation ID.
+
+        Parameters
+        ----------
+        request : Request
+            The HTTP request object, including user context.
+
+        Returns
+        -------
+        Response
+            A DRF Response object containing the details of the requested observation.
+
+        Raises
+        ------
+        PermissionDenied
+            If the authenticated user has not configured GPP login credentials.
+        KeyError
+            If 'pk' (the observation ID) is not present in kwargs.
+        """
+        observation_id = kwargs["pk"]
+
+        if not hasattr(request.user, "gpplogin"):
+            raise PermissionDenied(
+                "GPP login credentials are not configured for this user."
+            )
+        credentials = request.user.gpplogin
+
+        # Setup client to communicate with GPP.
+        client = GPPClient(url=settings.GPP_URL, token=credentials.token)
+        observation = async_to_sync(client.observation.get_by_id)(
+            observation_id=observation_id
+        )
+
+        return Response(observation)

src/goats_tom/api_views/gpp/programs.py

@@ -71,9 +71,7 @@ def retrieve(self, request: Request, *args, **kwargs) -> Response:
         """
         program_id = kwargs["pk"]
 
-        # Check if GPP credentials have been added.
         if not hasattr(request.user, "gpplogin"):
-            # Return with the proper error
             raise PermissionDenied(
                 "GPP login credentials are not configured for this user."
             )

src/goats_tom/urls.py

@@ -8,6 +8,9 @@
 router.register(
     r"gpp/programs", api_views.GPPProgramViewSet, basename="gppprograms"
 )
+router.register(
+    r"gpp/observations", api_views.GPPObservationViewSet, basename="gppobservations"
+)
 router.register(
     r"reduceddatums", api_views.ReducedDatumViewSet, basename="reduceddatums"
 )

tests/goats_tom/api_views/gpp/test_observations.py

@@ -0,0 +1,69 @@
+import pytest
+from rest_framework.test import APIRequestFactory, force_authenticate
+from rest_framework import status
+from unittest.mock import AsyncMock
+
+from goats_tom.tests.factories import UserFactory, GPPLoginFactory
+from goats_tom.api_views import GPPObservationViewSet
+
+
+@pytest.mark.django_db
+class TestGPPObservationViewSet:
+    def setup_method(self):
+        self.factory = APIRequestFactory()
+        self.list_view = GPPObservationViewSet.as_view({'get': 'list'})
+        self.retrieve_view = GPPObservationViewSet.as_view({'get': 'retrieve'})
+
+        self.observation_id = "o-23e1"
+        self.observation_data = {"observation_id": self.observation_id, "name": "m27"}
+        self.observations_url = "/api/gpp/observations/"
+        self.observation_detail_url = f"/api/gpp/observations/{self.observation_id}/"
+
+        # Setup users.
+        self.user_with_login = UserFactory()
+        GPPLoginFactory(user=self.user_with_login)
+        self.user_without_login = UserFactory()
+
+    def test_list_observations_success(self, mocker):
+        mock_client = mocker.patch("goats_tom.api_views.gpp.observations.GPPClient")
+        mock_client.return_value.observation.get_all = AsyncMock(return_value=[self.observation_data])
+
+        request = self.factory.get(self.observations_url)
+        force_authenticate(request, user=self.user_with_login)
+
+        response = self.list_view(request)
+
+        assert response.status_code == status.HTTP_200_OK
+        assert response.data == [self.observation_data]
+        mock_client.return_value.observation.get_all.assert_called_once()
+
+    def test_list_observations_missing_gpplogin(self):
+        request = self.factory.get(self.observations_url)
+        force_authenticate(request, user=self.user_without_login)
+
+        response = self.list_view(request)
+
+        assert response.status_code == status.HTTP_403_FORBIDDEN
+        assert response.data["detail"] == "GPP login credentials are not configured for this user."
+
+    def test_retrieve_observation_success(self, mocker):
+        mock_client = mocker.patch("goats_tom.api_views.gpp.observations.GPPClient")
+        mock_client.return_value.observation.get_by_id = AsyncMock(return_value=self.observation_data)
+
+        request = self.factory.get(self.observation_detail_url)
+        force_authenticate(request, user=self.user_with_login)
+
+        response = self.retrieve_view(request, pk=self.observation_id)
+
+        assert response.status_code == status.HTTP_200_OK
+        assert response.data == self.observation_data
+        mock_client.return_value.observation.get_by_id.assert_called_once_with(observation_id=self.observation_id)
+
+    def test_retrieve_observation_missing_gpplogin(self):
+        request = self.factory.get(self.observation_detail_url)
+        force_authenticate(request, user=self.user_without_login)
+
+        response = self.retrieve_view(request, pk=self.observation_id)
+
+        assert response.status_code == status.HTTP_403_FORBIDDEN
+        assert response.data["detail"] == "GPP login credentials are not configured for this user."

tests/goats_tom/api_views/gpp/test_programs.py

@@ -14,7 +14,7 @@ def setup_method(self):
         self.list_view = GPPProgramViewSet.as_view({'get': 'list'})
         self.retrieve_view = GPPProgramViewSet.as_view({'get': 'retrieve'})
 
-        self.program_id = "GN-2025A-Q-101"
+        self.program_id = "p-230e"
         self.program_data = {"program_id": self.program_id, "title": "Test Program"}
         self.programs_url = "/api/gpp/programs/"
         self.program_detail_url = f"/api/gpp/programs/{self.program_id}/"