edx-enterprise-data 9.6.0__tar.gz → 9.7.0__tar.gz

{edx_enterprise_data-9.6.0 → edx_enterprise_data-9.7.0}/CHANGELOG.rst

@@ -16,6 +16,10 @@ Unreleased
 
 =========================
 
+[9.7.0] - 2024-10-23
+---------------------
+  * feat: Add API to fetch enterprise budgets information
+
 [9.6.0] - 2024-10-14
 ---------------------
   * feat: Added caching for API endpoints related to advanced analytics.

{edx_enterprise_data-9.6.0/edx_enterprise_data.egg-info → edx_enterprise_data-9.7.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: edx-enterprise-data
-Version: 9.6.0
+Version: 9.7.0
 Summary: Enterprise Reporting
 Home-page: https://github.com/openedx/edx-enterprise-data
 Author: edX

{edx_enterprise_data-9.6.0 → edx_enterprise_data-9.7.0/edx_enterprise_data.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: edx-enterprise-data
-Version: 9.6.0
+Version: 9.7.0
 Summary: Enterprise Reporting
 Home-page: https://github.com/openedx/edx-enterprise-data
 Author: edX

{edx_enterprise_data-9.6.0 → edx_enterprise_data-9.7.0}/enterprise_data/__init__.py

@@ -2,4 +2,4 @@
 Enterprise data api application. This Django app exposes API endpoints used by enterprises.
 """
 
-__version__ = "9.6.0"
+__version__ = "9.7.0"

{edx_enterprise_data-9.6.0 → edx_enterprise_data-9.7.0}/enterprise_data/api/v1/serializers.py

@@ -240,6 +240,19 @@ class EnterpriseExecEdLCModulePerformanceSerializer(serializers.ModelSerializer)
         return obj.extensions_requested if obj.extensions_requested is not None else 0
 
 
+class EnterpriseBudgetSerializer(serializers.ModelSerializer):
+    """
+    Serializer for EnterpriseSubsidyBudget model.
+    """
+
+    class Meta:
+        model = EnterpriseSubsidyBudget
+        fields = (
+            'subsidy_access_policy_uuid',
+            'subsidy_access_policy_display_name',
+        )
+
+
 class AdvanceAnalyticsQueryParamSerializer(serializers.Serializer):  # pylint: disable=abstract-method
     """Serializer for validating query params"""
     RESPONSE_TYPES = [

{edx_enterprise_data-9.6.0 → edx_enterprise_data-9.7.0}/enterprise_data/api/v1/urls.py

@@ -96,6 +96,11 @@ urlpatterns = [
         enterprise_admin_views.EnterpriseAdminAnalyticsSkillsView.as_view(),
         name='enterprise-admin-analytics-skills'
     ),
+    re_path(
+        fr'^enterprise/(?P<enterprise_uuid>{UUID4_REGEX})/budgets',
+        enterprise_admin_views.EnterpriseBudgetView.as_view(),
+        name='enterprise-budgets'
+    ),
 ]
 
 urlpatterns += router.urls

{edx_enterprise_data-9.6.0 → edx_enterprise_data-9.7.0}/enterprise_data/api/v1/views/enterprise_admin.py

@@ -21,6 +21,7 @@ from enterprise_data.models import (
     EnterpriseAdminLearnerProgress,
     EnterpriseAdminSummarizeInsights,
     EnterpriseExecEdLCModulePerformance,
+    EnterpriseSubsidyBudget,
 )
 from enterprise_data.utils import timer
 
@@ -206,3 +207,26 @@ class EnterpriseExecEdLCModulePerformanceViewSet(EnterpriseViewSetMixin, viewset
         return EnterpriseExecEdLCModulePerformance.objects.filter(
             enterprise_customer_uuid=self.kwargs['enterprise_id'],
         )
+
+
+class EnterpriseBudgetView(APIView):
+    """
+    View for getting budgets information for an enterprise.
+    """
+    authentication_classes = (JwtAuthentication,)
+    http_method_names = ["get"]
+
+    @permission_required("can_access_enterprise", fn=lambda request, enterprise_uuid: enterprise_uuid)
+    def get(self, request, enterprise_uuid):
+        """
+        Return the queryset of EnterpriseSubsidyBudget objects.
+        """
+        budgets = EnterpriseSubsidyBudget.objects.filter(
+            enterprise_customer_uuid=enterprise_uuid,
+        ).values(
+            'subsidy_access_policy_uuid',
+            'subsidy_access_policy_display_name',
+        )
+
+        serializer = serializers.EnterpriseBudgetSerializer(budgets, many=True)
+        return Response(serializer.data)

{edx_enterprise_data-9.6.0 → edx_enterprise_data-9.7.0}/enterprise_data/api/v1/views/enterprise_learner.py

@@ -150,6 +150,10 @@ class EnterpriseLearnerEnrollmentViewSet(EnterpriseViewSetMixin, viewsets.ReadOn
         if search_start_date:
             queryset = queryset.filter(course_start_date=search_start_date)
 
+        budget_uuid = query_filters.get('budget_uuid')
+        if budget_uuid:
+            queryset = queryset.filter(budget_id=budget_uuid)
+
         offer_id = query_filters.get('offer_id')
         if offer_id:
             queryset = self.filter_by_offer_id(queryset, offer_id)

{edx_enterprise_data-9.6.0 → edx_enterprise_data-9.7.0}/enterprise_data/tests/api/v1/views/test_enterprise_admin.py

@@ -21,7 +21,7 @@ from enterprise_data.tests.admin_analytics.mock_analytics_data import (
     TOP_SKILLS_BY_ENROLLMENTS,
 )
 from enterprise_data.tests.mixins import JWTTestMixin
-from enterprise_data.tests.test_utils import UserFactory, get_dummy_enterprise_api_data
+from enterprise_data.tests.test_utils import EnterpriseSubsidyBudgetFactory, UserFactory, get_dummy_enterprise_api_data
 from enterprise_data_roles.constants import ENTERPRISE_DATA_ADMIN_ROLE
 from enterprise_data_roles.models import EnterpriseDataFeatureRole, EnterpriseDataRoleAssignment
 
@@ -245,3 +245,49 @@ class TestSkillsStatsAPI(JWTTestMixin, APITransactionTestCase):
         response = self.client.get(self.url, params)
         assert response.status_code == status.HTTP_400_BAD_REQUEST
         assert response.json() == error
+
+
+@ddt.ddt
+class TestEnterpriseBudgetAPI(JWTTestMixin, APITransactionTestCase):
+    """Tests for EnterpriseBudgetView."""
+
+    def setUp(self):
+        """
+        Setup method.
+        """
+        super().setUp()
+        self.user = UserFactory(is_staff=True)
+        role, __ = EnterpriseDataFeatureRole.objects.get_or_create(
+            name=ENTERPRISE_DATA_ADMIN_ROLE
+        )
+        self.role_assignment = EnterpriseDataRoleAssignment.objects.create(
+            role=role, user=self.user
+        )
+        self.client.force_authenticate(user=self.user)
+
+        self.enterprise_uuid = "ee5e6b3a069a4947bb8dd2dbc323396c"
+        self.set_jwt_cookie()
+
+        self.url = reverse(
+            "v1:enterprise-budgets",
+            kwargs={"enterprise_uuid": self.enterprise_uuid},
+        )
+
+        self.enterprise_subsidy_budget = EnterpriseSubsidyBudgetFactory(
+            enterprise_customer_uuid=self.enterprise_uuid,
+            subsidy_access_policy_uuid='8d6503dd-e40d-42b8-442b-37dd4c5450e3',
+            subsidy_access_policy_display_name='test-budget'
+        )
+
+    def test_get(self):
+        """
+        Test the GET method for the EnterpriseBudgetView works.
+        """
+        response = self.client.get(self.url)
+        assert response.status_code == status.HTTP_200_OK
+        assert response.json() == [
+            {
+                'subsidy_access_policy_uuid': '8d6503dd-e40d-42b8-442b-37dd4c5450e3',
+                'subsidy_access_policy_display_name': 'test-budget',
+            }
+        ]