edx-enterprise-data 4.11.0__tar.gz → 4.11.2__tar.gz

{edx-enterprise-data-4.11.0 → edx-enterprise-data-4.11.2}/CHANGELOG.rst

@@ -15,6 +15,15 @@ Unreleased
 ----------
 
 =========================
+[4.11.2] - 2023-08-18
+---------------------
+  * Add api filtering for `EnterpriseLearnerEnrollmentViewSet` for course_title or user_email
+
+[4.11.1] - 2023-08-17
+---------------------
+  * Add api filtering for `EnterpriseLearnerEnrollmentViewSet` for course_title or user_email
+
+
 [4.11.0] - 2023-08-16
 ---------------------
   * Add api endpoint for `EnterpriseAdminLearnerProgress` and `EnterpriseAdminSummarizeInsights` models

{edx-enterprise-data-4.11.0/edx_enterprise_data.egg-info → edx-enterprise-data-4.11.2}/PKG-INFO

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

{edx-enterprise-data-4.11.0 → edx-enterprise-data-4.11.2/edx_enterprise_data.egg-info}/PKG-INFO

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

{edx-enterprise-data-4.11.0 → edx-enterprise-data-4.11.2}/enterprise_data/__init__.py

@@ -2,6 +2,6 @@
 Enterprise data api application. This Django app exposes API endpoints used by enterprises.
 """
 
-__version__ = "4.11.0"
+__version__ = "4.11.2"
 
 default_app_config = "enterprise_data.apps.EnterpriseDataAppConfig"  # pylint: disable=invalid-name

{edx-enterprise-data-4.11.0 → edx-enterprise-data-4.11.2}/enterprise_data/api/v1/views.py

@@ -2,9 +2,9 @@
 Views for enterprise api v1.
 """
 
-
 from datetime import date, timedelta
 from logging import getLogger
+from uuid import UUID
 
 from django_filters.rest_framework import DjangoFilterBackend
 from edx_django_utils.cache import TieredCache
@@ -166,7 +166,12 @@ class EnterpriseLearnerEnrollmentViewSet(EnterpriseViewSetMixin, viewsets.ReadOn
         search_email = query_filters.get('search')
         if search_email:
             queryset = queryset.filter(user_email__icontains=search_email)
-
+        search_all_param = query_filters.get('search_all')
+        if search_all_param:
+            queryset = queryset.filter(
+                Q(user_email__icontains=search_all_param)
+                | Q(course_title__icontains=search_all_param)
+            )
         search_course = query_filters.get('search_course')
         if search_course:
             queryset = queryset.filter(course_title__icontains=search_course)
@@ -176,7 +181,7 @@ class EnterpriseLearnerEnrollmentViewSet(EnterpriseViewSetMixin, viewsets.ReadOn
 
         offer_id = query_filters.get('offer_id')
         if offer_id:
-            queryset = queryset.filter(offer_id=offer_id)
+            queryset = self.filter_by_offer_id(queryset, offer_id)
 
         ignore_null_course_list_price = query_filters.get('ignore_null_course_list_price')
         if ignore_null_course_list_price:
@@ -192,6 +197,27 @@ class EnterpriseLearnerEnrollmentViewSet(EnterpriseViewSetMixin, viewsets.ReadOn
 
         return queryset
 
+    def filter_by_offer_id(self, queryset, offer_id):
+        """
+        Filter queryset by `offer_id`
+        """
+        # offer_id field in table contains two types of data
+        # 1. integer
+        # 2. uuid
+        # In table, uuids are stored without hyphen and in lower case
+        # but api clients are sending uuids with hyphen and that causes the issue
+        # we need to remove the hyphens from uuid, convert the uuid to lower case and then do a compare in DB
+
+        # if offer_id is a uuid only then do the transformation
+        try:
+            offer_id_uuid_obj = UUID(offer_id, version=4)
+            offer_id = str(offer_id_uuid_obj)
+            offer_id = offer_id.replace('-', '')
+        except ValueError:
+            pass
+
+        return queryset.filter(offer_id=offer_id)
+
     def filter_active_enrollments(self, queryset):
         """
         Filters queryset to include enrollments with course date in future

{edx-enterprise-data-4.11.0 → edx-enterprise-data-4.11.2}/enterprise_data/tests/api/v1/test_views.py

@@ -160,6 +160,56 @@ class TestEnterpriseLearnerEnrollmentViewSet(JWTTestMixin, APITransactionTestCas
         self.assertEqual(len(results), 1)
         self.assertEqual(results[0]['enrollment_id'], learner_enrollment_subsidized.enrollment_id)
 
+    def test_search_by_course_title(self):
+        """Test that the course title search works correctly"""
+        enterprise_learner = EnterpriseLearnerFactory(
+            enterprise_customer_uuid=self.enterprise_id
+        )
+        course_titles = ['Introduction to Python', 'Introduction to Java', 'Introduction to C++']
+
+        for title in course_titles:
+            EnterpriseLearnerEnrollmentFactory(
+                enterprise_customer_uuid=self.enterprise_id,
+                is_consent_granted=True,
+                enterprise_user_id=enterprise_learner.enterprise_user_id,
+                course_title=title,
+            )
+
+        url = reverse('v1:enterprise-learner-enrollment-list', kwargs={'enterprise_id': self.enterprise_id})
+        response = self.client.get(url, data={'search_all': 'Introduction to'})
+        results = response.json()['results']
+        self.assertEqual(len(results), 3)
+
+    def test_search_by_email(self):
+        """Test that the email search works correctly"""
+        enterprise_learner = EnterpriseLearnerFactory(
+            enterprise_customer_uuid=self.enterprise_id,
+            user_email="johndoe@example.com"
+        )
+        EnterpriseLearnerEnrollmentFactory(
+            enterprise_customer_uuid=self.enterprise_id,
+            is_consent_granted=True,
+            enterprise_user_id=enterprise_learner.enterprise_user_id,
+            course_title="Sample course",
+            user_email="johndoe@example.com"
+        )
+        url = reverse('v1:enterprise-learner-enrollment-list', kwargs={'enterprise_id': self.enterprise_id})
+        response = self.client.get(url, data={'search_all': 'john'})
+        results = response.json()['results']
+        self.assertEqual(len(results), 1)
+
+    def test_search_no_results(self):
+        """Test that the search returns no results if no matches are found"""
+        EnterpriseLearnerFactory(
+            enterprise_customer_uuid=self.enterprise_id,
+            user_email="test@example.com"
+        )
+        search_term = 'nonexistentemail@example.com'
+        url = reverse('v1:enterprise-learner-enrollment-list', kwargs={'enterprise_id': self.enterprise_id})
+        response = self.client.get(url, data={'search_all': search_term})
+        self.assertEqual(response.status_code, status.HTTP_200_OK)
+        self.assertEqual(response.json()['count'], 0)
+
 
 @ddt.ddt
 @mark.django_db