edx-enterprise-data 9.0.0__py3-none-any.whl → 9.1.0__py3-none-any.whl

enterprise_data/api/v1/serializers.py

@@ -5,13 +5,7 @@ from uuid import UUID
 
 from rest_framework import serializers
 
-from enterprise_data.admin_analytics.constants import (
-    Calculation,
-    EngagementChart,
-    EnrollmentChart,
-    Granularity,
-    ResponseType,
-)
+from enterprise_data.admin_analytics.constants import Calculation, Granularity, ResponseType
 from enterprise_data.models import (
     EnterpriseAdminLearnerProgress,
     EnterpriseAdminSummarizeInsights,
@@ -315,51 +309,3 @@ class AdvanceAnalyticsQueryParamSerializer(serializers.Serializer):  # pylint: d
         if value not in self.CALCULATION_CHOICES:
             raise serializers.ValidationError(f"Calculation must be one of {self.CALCULATION_CHOICES}")
         return value
-
-
-class AdvanceAnalyticsEnrollmentStatsSerializer(
-    AdvanceAnalyticsQueryParamSerializer
-):  # pylint: disable=abstract-method
-    """Serializer for validating Advance Analytics Enrollments Stats API"""
-    CHART_TYPES = [
-        EnrollmentChart.ENROLLMENTS_OVER_TIME.value,
-        EnrollmentChart.TOP_COURSES_BY_ENROLLMENTS.value,
-        EnrollmentChart.TOP_SUBJECTS_BY_ENROLLMENTS.value
-    ]
-
-    chart_type = serializers.CharField(required=False)
-
-    def validate_chart_type(self, value):
-        """
-        Validate the chart_type value.
-
-        Raises:
-            serializers.ValidationError: If chart_type is not one of the valid choices
-        """
-        if value not in self.CHART_TYPES:
-            raise serializers.ValidationError(f"chart_type must be one of {self.CHART_TYPES}")
-        return value
-
-
-class AdvanceAnalyticsEngagementStatsSerializer(
-    AdvanceAnalyticsQueryParamSerializer
-):  # pylint: disable=abstract-method
-    """Serializer for validating Advance Analytics Engagements Stats API"""
-    CHART_TYPES = [
-        EngagementChart.ENGAGEMENTS_OVER_TIME.value,
-        EngagementChart.TOP_COURSES_BY_ENGAGEMENTS.value,
-        EngagementChart.TOP_SUBJECTS_BY_ENGAGEMENTS.value
-    ]
-
-    chart_type = serializers.CharField(required=False)
-
-    def validate_chart_type(self, value):
-        """
-        Validate the chart_type value.
-
-        Raises:
-            serializers.ValidationError: If chart_type is not one of the valid choices
-        """
-        if value not in self.CHART_TYPES:
-            raise serializers.ValidationError(f"chart_type must be one of {self.CHART_TYPES}")
-        return value

enterprise_data/api/v1/urls.py

@@ -8,13 +8,10 @@ from rest_framework.routers import DefaultRouter
 from django.urls import re_path
 
 from enterprise_data.api.v1.views import enterprise_admin as enterprise_admin_views
-from enterprise_data.api.v1.views import enterprise_completions as enterprise_completions_views
 from enterprise_data.api.v1.views import enterprise_learner as enterprise_learner_views
 from enterprise_data.api.v1.views import enterprise_offers as enterprise_offers_views
-from enterprise_data.api.v1.views.analytics_engagements import (
-    AdvanceAnalyticsEngagementStatsView,
-    AdvanceAnalyticsIndividualEngagementsView,
-)
+from enterprise_data.api.v1.views.analytics_completions import AdvanceAnalyticsCompletionsView
+from enterprise_data.api.v1.views.analytics_engagements import AdvanceAnalyticsEngagementView
 from enterprise_data.api.v1.views.analytics_enrollments import AdvanceAnalyticsEnrollmentsView
 from enterprise_data.api.v1.views.analytics_leaderboard import AdvanceAnalyticsLeaderboardView
 from enterprise_data.constants import UUID4_REGEX
@@ -74,14 +71,24 @@ urlpatterns = [
         AdvanceAnalyticsEnrollmentsView.as_view({'get': 'list'}),
         name='enterprise-admin-analytics-enrollments'
     ),
+    re_path(
+        fr'^admin/analytics/(?P<enterprise_uuid>{UUID4_REGEX})/completions/stats$',
+        AdvanceAnalyticsCompletionsView.as_view({'get': 'stats'}),
+        name='enterprise-admin-analytics-completions-stats'
+    ),
+    re_path(
+        fr'^admin/analytics/(?P<enterprise_uuid>{UUID4_REGEX})/completions$',
+        AdvanceAnalyticsCompletionsView.as_view({'get': 'list'}),
+        name='enterprise-admin-analytics-completions'
+    ),
     re_path(
         fr'^admin/analytics/(?P<enterprise_uuid>{UUID4_REGEX})/engagements/stats$',
-        AdvanceAnalyticsEngagementStatsView.as_view(),
+        AdvanceAnalyticsEngagementView.as_view({'get': 'stats'}),
         name='enterprise-admin-analytics-engagements-stats'
     ),
     re_path(
         fr'^admin/analytics/(?P<enterprise_uuid>{UUID4_REGEX})/engagements$',
-        AdvanceAnalyticsIndividualEngagementsView.as_view(),
+        AdvanceAnalyticsEngagementView.as_view({'get': 'list'}),
         name='enterprise-admin-analytics-engagements'
     ),
     re_path(
@@ -89,16 +96,6 @@ urlpatterns = [
         enterprise_admin_views.EnterpriseAdminAnalyticsSkillsView.as_view(),
         name='enterprise-admin-analytics-skills'
     ),
-    re_path(
-        fr'^admin/analytics/(?P<enterprise_id>{UUID4_REGEX})/completions/stats$',
-        enterprise_completions_views.EnterrpiseAdminCompletionsStatsView.as_view(),
-        name='enterprise-admin-analytics-completions-stats'
-    ),
-    re_path(
-        fr'^admin/analytics/(?P<enterprise_id>{UUID4_REGEX})/completions$',
-        enterprise_completions_views.EnterrpiseAdminCompletionsView.as_view(),
-        name='enterprise-admin-analytics-completions'
-    ),
 ]
 
 urlpatterns += router.urls

enterprise_data/api/v1/views/analytics_completions.py

@@ -0,0 +1,150 @@
+"""
+Views for enterprise admin completions analytics.
+"""
+
+from datetime import datetime
+from logging import getLogger
+
+from edx_rbac.decorators import permission_required
+from edx_rest_framework_extensions.auth.jwt.authentication import JwtAuthentication
+from rest_framework.decorators import action
+from rest_framework.response import Response
+from rest_framework.viewsets import ViewSet
+
+from django.http import StreamingHttpResponse
+
+from enterprise_data.admin_analytics.constants import ResponseType
+from enterprise_data.admin_analytics.database.tables import FactEnrollmentAdminDashTable
+from enterprise_data.api.v1.paginators import AdvanceAnalyticsPagination
+from enterprise_data.api.v1.serializers import AdvanceAnalyticsQueryParamSerializer
+from enterprise_data.api.v1.views.base import AnalyticsPaginationMixin
+from enterprise_data.renderers import IndividualCompletionsCSVRenderer
+from enterprise_data.utils import timer
+
+LOGGER = getLogger(__name__)
+
+
+class AdvanceAnalyticsCompletionsView(AnalyticsPaginationMixin, ViewSet):
+    """
+    View to handle requests for enterprise completion data.
+
+    Here is the list of URLs that are handled by this view:
+    1. `enterprise_data_api_v1.enterprise-learner-completion-list`: Get individual completion data.
+    2. `enterprise_data_api_v1.enterprise-learner-completion-stats`: Get completion stats data.
+    """
+    authentication_classes = (JwtAuthentication,)
+    pagination_class = AdvanceAnalyticsPagination
+    http_method_names = ('get', )
+
+    @permission_required('can_access_enterprise', fn=lambda request, enterprise_uuid: enterprise_uuid)
+    def list(self, request, enterprise_uuid):
+        """
+        Get individual completions data for the enterprise.
+        """
+        # Remove hyphens from the UUID
+        enterprise_uuid = enterprise_uuid.replace('-', '')
+
+        serializer = AdvanceAnalyticsQueryParamSerializer(data=request.GET)
+        serializer.is_valid(raise_exception=True)
+        min_enrollment_date, _ = FactEnrollmentAdminDashTable().get_enrollment_date_range(
+            enterprise_uuid,
+        )
+
+        # get values from query params or use default values
+        start_date = serializer.data.get('start_date', min_enrollment_date)
+        end_date = serializer.data.get('end_date', datetime.now())
+        page = serializer.data.get('page', 1)
+        page_size = serializer.data.get('page_size', 100)
+        completions = FactEnrollmentAdminDashTable().get_all_completions(
+            enterprise_customer_uuid=enterprise_uuid,
+            start_date=start_date,
+            end_date=end_date,
+            limit=page_size,
+            offset=(page - 1) * page_size,
+        )
+        total_count = FactEnrollmentAdminDashTable().get_completion_count(
+            enterprise_customer_uuid=enterprise_uuid,
+            start_date=start_date,
+            end_date=end_date,
+        )
+        response_type = request.query_params.get('response_type', ResponseType.JSON.value)
+
+        LOGGER.info(
+            "Individual completions data requested for enterprise [%s] from [%s] to [%s]",
+            enterprise_uuid,
+            start_date,
+            end_date,
+        )
+
+        if response_type == ResponseType.CSV.value:
+            filename = f"""individual_completions, {start_date} - {end_date}.csv"""
+
+            return StreamingHttpResponse(
+                IndividualCompletionsCSVRenderer().render(self._stream_serialized_data(
+                    enterprise_uuid, start_date, end_date, total_count
+                )),
+                content_type="text/csv",
+                headers={"Content-Disposition": f'attachment; filename="{filename}"'},
+            )
+
+        return self.get_paginated_response(
+            request=request,
+            records=completions,
+            page=page,
+            page_size=page_size,
+            total_count=total_count,
+        )
+
+    @staticmethod
+    def _stream_serialized_data(enterprise_uuid, start_date, end_date, total_count, page_size=50000):
+        """
+        Stream the serialized data.
+        """
+        offset = 0
+        while offset < total_count:
+            completions = FactEnrollmentAdminDashTable().get_all_completions(
+                enterprise_customer_uuid=enterprise_uuid,
+                start_date=start_date,
+                end_date=end_date,
+                limit=page_size,
+                offset=offset,
+            )
+            yield from completions
+            offset += page_size
+
+    @permission_required('can_access_enterprise', fn=lambda request, enterprise_uuid: enterprise_uuid)
+    @action(detail=False, methods=['get'], name='Enterprise completions data for charts', url_path='stats')
+    def stats(self, request, enterprise_uuid):
+        """
+        Get data to populate enterprise completion charts.
+
+        Here is the list of the charts and their corresponding data:
+        1. `completions_over_time`: This will show time series data of completions over time.
+        2. `top_courses_by_completions`: This will show the top courses by completions.
+        3. `top_subjects_by_completions`: This will show the top subjects by completions.
+        """
+        # Remove hyphens from the UUID
+        enterprise_uuid = enterprise_uuid.replace('-', '')
+
+        serializer = AdvanceAnalyticsQueryParamSerializer(data=request.GET)
+        serializer.is_valid(raise_exception=True)
+
+        min_enrollment_date, _ = FactEnrollmentAdminDashTable().get_enrollment_date_range(
+            enterprise_uuid,
+        )
+        # get values from query params or use default
+        start_date = serializer.data.get('start_date', min_enrollment_date)
+        end_date = serializer.data.get('end_date', datetime.now())
+        with timer('construct_completion_all_stats'):
+            data = {
+                'completions_over_time': FactEnrollmentAdminDashTable().get_completions_time_series_data(
+                    enterprise_uuid, start_date, end_date
+                ),
+                'top_courses_by_completions': FactEnrollmentAdminDashTable().get_top_courses_by_completions(
+                    enterprise_uuid, start_date, end_date,
+                ),
+                'top_subjects_by_completions': FactEnrollmentAdminDashTable().get_top_subjects_by_completions(
+                    enterprise_uuid, start_date, end_date,
+                ),
+            }
+        return Response(data)