InvenTree/InvenTree/generic/states/api.py

"""Generic implementation of status api functions for InvenTree models."""

import inspect

from rest_framework import permissions
from rest_framework.response import Response
from rest_framework.serializers import ValidationError
from rest_framework.views import APIView

from .states import StatusCode


class StatusView(APIView):
    """Generic API endpoint for discovering information on 'status codes' for a particular model.

    This class should be implemented as a subclass for each type of status.
    For example, the API endpoint /stock/status/ will have information about
    all available 'StockStatus' codes
    """

    permission_classes = [
        permissions.IsAuthenticated,
    ]

    # Override status_class for implementing subclass
    MODEL_REF = 'statusmodel'

    def get_status_model(self, *args, **kwargs):
        """Return the StatusCode moedl based on extra parameters passed to the view"""

        status_model = self.kwargs.get(self.MODEL_REF, None)

        if status_model is None:
            raise ValidationError(f"StatusView view called without '{self.MODEL_REF}' parameter")

        return status_model

    def get(self, request, *args, **kwargs):
        """Perform a GET request to learn information about status codes"""

        status_class = self.get_status_model()

        if not inspect.isclass(status_class):
            raise NotImplementedError("`status_class` not a class")

        if not issubclass(status_class, StatusCode):
            raise NotImplementedError("`status_class` not a valid StatusCode class")

        data = {
            'class': status_class.__name__,
            'values': status_class.dict(),
        }

        return Response(data)