GOATS-739: Extend API to fetch program information from GPP. (#331)

Author: davner

docs/changes/331.new.rst

@@ -0,0 +1 @@
+Extended the API to allow fetching program information from GPP.

src/goats_tom/api_views/__init__.py

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

src/goats_tom/api_views/gpp/__init__.py

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

src/goats_tom/api_views/gpp/observations.py

@@ -0,0 +1,86 @@
+"""Handles grabbing programs and program details from GPP."""
+
+__all__ = ["GPPProgramViewSet"]
+
+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 GPPProgramViewSet(
+    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 programs 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 programs.
+
+        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)
+        programs = async_to_sync(client.program.get_all)()
+
+        return Response(programs)
+
+    def retrieve(self, request: Request, *args, **kwargs) -> Response:
+        """Return details for a specific GPP program by program ID.
+
+        Parameters
+        ----------
+        request : Request
+            The HTTP request object, including user context.
+
+        Returns
+        -------
+        Response
+            A DRF Response object containing the details of the requested program.
+
+        Raises
+        ------
+        PermissionDenied
+            If the authenticated user has not configured GPP login credentials.
+        KeyError
+            If 'pk' (the program ID) is not present in kwargs.
+        """
+        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."
+            )
+        credentials = request.user.gpplogin
+
+        # Setup client to communicate with GPP.
+        client = GPPClient(url=settings.GPP_URL, token=credentials.token)
+        program = async_to_sync(client.program.get_by_id)(program_id=program_id)
+
+        return Response(program)

src/goats_tom/api_views/gpp/programs.py

@@ -5,7 +5,7 @@
 from .dragons_recipe import DRAGONSRecipeFactory
 from .dragons_reduce import DRAGONSReduceFactory
 from .dragons_run import DRAGONSRunFactory
-from .logins import AstroDatalabLoginFactory, GOALoginFactory
+from .logins import AstroDatalabLoginFactory, GOALoginFactory, GPPLoginFactory
 from .recipes_module import RecipesModuleFactory
 from .reduceddatum import ReducedDatumFactory
 from .user import UserFactory
@@ -23,4 +23,5 @@
     "RecipesModuleFactory",
     "ReducedDatumFactory",
     "UserFactory",
+    "GPPLoginFactory",
 ]

src/goats_tom/tests/factories/__init__.py

@@ -1,4 +1,5 @@
 from .astro_datalab import AstroDatalabLoginFactory
 from .goa import GOALoginFactory
+from .gpp import GPPLoginFactory
 
-__all__ = ["GOALoginFactory", "AstroDatalabLoginFactory"]
+__all__ = ["GOALoginFactory", "AstroDatalabLoginFactory", "GPPLoginFactory"]

src/goats_tom/tests/factories/logins/__init__.py

@@ -22,3 +22,14 @@ class UsernamePasswordLoginFactory(BaseLoginFactory):
         upper_case=True,
         lower_case=True,
     )
+
+
+class TokenLoginFactory(BaseLoginFactory):
+    token = factory.Faker(
+        "password",
+        length=24,
+        special_chars=True,
+        digits=True,
+        upper_case=True,
+        lower_case=True,
+    )

src/goats_tom/tests/factories/logins/base.py

@@ -0,0 +1,11 @@
+from goats_tom.models import (
+    GPPLogin,
+)
+
+from .base import TokenLoginFactory
+
+
+class GPPLoginFactory(TokenLoginFactory):
+    """Factory for GPPLogin."""
+    class Meta:
+        model = GPPLogin

src/goats_tom/tests/factories/logins/gpp.py

@@ -360,6 +360,8 @@
 # 'plotly', 'plotly_white', 'plotly_dark', 'ggplot2', 'seaborn', 'simple_white', 'none'
 PLOTLY_THEME = "plotly_dark"
 
+GPP_URL = "test"
+
 try:
     from local_settings import *  # noqa
 except ImportError: