edx-enterprise-data 4.11.0__py3-none-any.whl → 4.11.2__py3-none-any.whl

{edx_enterprise_data-4.11.0.dist-info → edx_enterprise_data-4.11.2.dist-info}/METADATA

@@ -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.dist-info → edx_enterprise_data-4.11.2.dist-info}/RECORD

@@ -1,4 +1,4 @@
-enterprise_data/__init__.py,sha256=XMnYGYr99mjy4phtEjdvNGwWnbj1RGK7THtFf9jKmXk,225
+enterprise_data/__init__.py,sha256=J1F3IYlsZp1T2MWENx0TWqIMpbl86OmjO6nUtuZqyWs,225
 enterprise_data/apps.py,sha256=aF6hZwDfI2oWj95tUTm_2ikHueQj-jLj-u0GrgzpsQI,414
 enterprise_data/clients.py,sha256=GvQupy5TVYfO_IKC3yzXSAgNP54r-PtIjidM5ws9Iks,3947
 enterprise_data/constants.py,sha256=pS65L4mimz7hd_cLml_mXdU0GJ7hs0X8UQ8MNjC5hCU,234
@@ -17,7 +17,7 @@ enterprise_data/api/v0/views.py,sha256=4RslZ4NZOU-844bnebEQ71ji2utRY7jEijqC45oQQ
 enterprise_data/api/v1/__init__.py,sha256=4MKmD0y8ANRoaNzSYTwPFVCSfeid_bdzHCHnhR37MIs,144
 enterprise_data/api/v1/serializers.py,sha256=iLkuaXLRaRkfVyXch__IKXA3OIUH63QUNNGpXOjWPTk,6674
 enterprise_data/api/v1/urls.py,sha256=Vev34sBjvDSqGUuQQGTu-1ft-ISYUPO_GTOpx0RTiEA,1106
-enterprise_data/api/v1/views.py,sha256=pUk3xBWzjhgKzIO7VNL2XkDScghjNRKEUXgwH2MmnY4,20302
+enterprise_data/api/v1/views.py,sha256=a5aIoIXoEExHX91440TUqzI-7EO-S0_-I5ZIU7GjH0c,21398
 enterprise_data/fixtures/enterprise_enrollment.json,sha256=6onPXXR29pMdTdbl_mn81sDi3Re5jkLUZz2TPMB_1IY,5786
 enterprise_data/fixtures/enterprise_user.json,sha256=6g8GvNY9j_fh1dvAU80bTAMI2F5vXCkb8a4UjsftMvQ,1970
 enterprise_data/management/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
@@ -85,7 +85,7 @@ enterprise_data/tests/api/v0/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NM
 enterprise_data/tests/api/v0/test_serializers.py,sha256=Gfty6gy6OQLN318uL1OCPhAZOqSUL50FWc0nC23VMnc,6257
 enterprise_data/tests/api/v1/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 enterprise_data/tests/api/v1/test_serializers.py,sha256=DwgEHcyOP3oqNUPB2O-NkJGeO_cYs9XJiq7791vJLZE,3682
-enterprise_data/tests/api/v1/test_views.py,sha256=sGuCyPEHkUWEumXHJrLzVKIynZqzIZ-xdOPnAIUab7g,12795
+enterprise_data/tests/api/v1/test_views.py,sha256=_ex_Cn_aXN3UA3QboHCUnrwPNd3ZSF6nt_lnHPuYrH0,15158
 enterprise_data_roles/__init__.py,sha256=toCpbypm2uDoWVw29_em9gPFNly8vNUS__C0b4TCqEg,112
 enterprise_data_roles/admin.py,sha256=QNP0VeWE092vZzpyxOA5UJK1nNGl5e71B1J0RCwo_nU,998
 enterprise_data_roles/apps.py,sha256=nKi8TyuQ5Q6WGtKs5QeXvUTc3N-YQjKhyBnm2EM3Bng,260
@@ -126,8 +126,8 @@ enterprise_reporting/tests/test_send_enterprise_reports.py,sha256=WtL-RqGgu2x5PP
 enterprise_reporting/tests/test_utils.py,sha256=7Y5GmeibiC8Q5kIpYuIAkFpeyIDRs2U3ItxsabhR1zM,9493
 enterprise_reporting/tests/test_vertica_client.py,sha256=-R2yNCGUjRtoXwLMBloVFQkFYrJoo613VCr61gwI3kQ,140
 enterprise_reporting/tests/utils.py,sha256=xms2LM7DV3wczXEfctOK1ddel1EE0J_YSr17UzbCDy4,1401
-edx_enterprise_data-4.11.0.dist-info/LICENSE,sha256=dql8h4yceoMhuzlcK0TT_i-NgTFNIZsgE47Q4t3dUYI,34520
-edx_enterprise_data-4.11.0.dist-info/METADATA,sha256=qCLFr5Ej1f1jVH5U9QNerZYYUCwNe8kx7Hyv884kScY,1490
-edx_enterprise_data-4.11.0.dist-info/WHEEL,sha256=pkctZYzUS4AYVn6dJ-7367OJZivF2e8RA9b_ZBjif18,92
-edx_enterprise_data-4.11.0.dist-info/top_level.txt,sha256=f5F2kU-dob6MqiHJpgZkFzoCD5VMhsdpkTV5n9Tvq3I,59
-edx_enterprise_data-4.11.0.dist-info/RECORD,,
+edx_enterprise_data-4.11.2.dist-info/LICENSE,sha256=dql8h4yceoMhuzlcK0TT_i-NgTFNIZsgE47Q4t3dUYI,34520
+edx_enterprise_data-4.11.2.dist-info/METADATA,sha256=mRAQGn1w8rYH-R8ZvH1dN1W5YJtksGkB5qen-w2ZD04,1490
+edx_enterprise_data-4.11.2.dist-info/WHEEL,sha256=pkctZYzUS4AYVn6dJ-7367OJZivF2e8RA9b_ZBjif18,92
+edx_enterprise_data-4.11.2.dist-info/top_level.txt,sha256=f5F2kU-dob6MqiHJpgZkFzoCD5VMhsdpkTV5n9Tvq3I,59
+edx_enterprise_data-4.11.2.dist-info/RECORD,,

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

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

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