edx-enterprise-data 4.11.1__tar.gz → 5.0.0__tar.gz

{edx-enterprise-data-4.11.1 → edx-enterprise-data-5.0.0}/CHANGELOG.rst

@@ -15,6 +15,16 @@ Unreleased
 ----------
 
 =========================
+[5.0.0] - 2023-08-22
+---------------------
+  * Rename `summary` to `learner_engagement` in `EnterpriseLearnerEnrollmentViewSet` response
+
+
+[4.11.2] - 2023-08-18
+---------------------
+  * Fix offer id filtering in `EnterpriseLearnerEnrollmentViewSet`
+
+
 [4.11.1] - 2023-08-17
 ---------------------
   * Add api filtering for `EnterpriseLearnerEnrollmentViewSet` for course_title or user_email

{edx-enterprise-data-4.11.1/edx_enterprise_data.egg-info → edx-enterprise-data-5.0.0}/PKG-INFO

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

{edx-enterprise-data-4.11.1 → edx-enterprise-data-5.0.0/edx_enterprise_data.egg-info}/PKG-INFO

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

{edx-enterprise-data-4.11.1 → edx-enterprise-data-5.0.0}/enterprise_data/__init__.py

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

{edx-enterprise-data-4.11.1 → edx-enterprise-data-5.0.0}/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
@@ -181,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:
@@ -197,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
@@ -471,7 +492,7 @@ class EnterpriseAdminInsightsView(APIView):
         """
         response_data = {}
         learner_progress = {}
-        summary = {}
+        learner_engagement = {}
 
         try:
             learner_progress = EnterpriseAdminLearnerProgress.objects.get(enterprise_customer_uuid=enterprise_id)
@@ -481,14 +502,14 @@ class EnterpriseAdminInsightsView(APIView):
             pass
 
         try:
-            summary = EnterpriseAdminSummarizeInsights.objects.get(enterprise_customer_uuid=enterprise_id)
-            summary = serializers.EnterpriseAdminSummarizeInsightsSerializer(summary).data
-            response_data['summary'] = summary
+            learner_engagement = EnterpriseAdminSummarizeInsights.objects.get(enterprise_customer_uuid=enterprise_id)
+            learner_engagement = serializers.EnterpriseAdminSummarizeInsightsSerializer(learner_engagement).data
+            response_data['learner_engagement'] = learner_engagement
         except EnterpriseAdminSummarizeInsights.DoesNotExist:
             pass
 
         status = HTTP_200_OK
-        if learner_progress == {} and summary == {}:
+        if learner_progress == {} and learner_engagement == {}:
             status = HTTP_404_NOT_FOUND
 
         return Response(data=response_data, status=status)

{edx-enterprise-data-4.11.1 → edx-enterprise-data-5.0.0}/enterprise_data/tests/api/v1/test_views.py

@@ -338,7 +338,7 @@ class TestEnterpriseAdminInsightsView(JWTTestMixin, APITransactionTestCase):
         learner_progress_obj = EnterpriseAdminLearnerProgressFactory.create(
             enterprise_customer_uuid=enterprise_customer_uuid
         )
-        summary_obj = EnterpriseAdminSummarizeInsightsFactory.create(
+        learner_engagement_obj = EnterpriseAdminSummarizeInsightsFactory.create(
             enterprise_customer_uuid=enterprise_customer_uuid
         )
 
@@ -350,8 +350,8 @@ class TestEnterpriseAdminInsightsView(JWTTestMixin, APITransactionTestCase):
 
         learner_progress = response_json['learner_progress']
         self.verify_data(learner_progress, learner_progress_obj)
-        summary = response_json['summary']
-        self.verify_data(summary, summary_obj)
+        learner_engagement = response_json['learner_engagement']
+        self.verify_data(learner_engagement, learner_engagement_obj)
 
     def test_retrieve_enterprise_admin_insights_no_data(self):
         """

{edx-enterprise-data-4.11.1 → edx-enterprise-data-5.0.0}/requirements/base.txt

@@ -12,22 +12,22 @@ asn1crypto==1.5.1
     # via
     #   oscrypto
     #   snowflake-connector-python
-awscli==1.28.0
+awscli==1.29.10
     # via -r requirements/reporting.in
 bcrypt==4.0.1
     # via paramiko
 billiard==3.6.4.0
     # via celery
-boto3==1.27.0
+boto3==1.28.10
     # via -r requirements/reporting.in
-botocore==1.30.0
+botocore==1.31.10
     # via
     #   awscli
     #   boto3
     #   s3transfer
 celery==4.4.7
     # via -r requirements/reporting.in
-certifi==2023.5.7
+certifi==2023.7.22
     # via
     #   py2neo
     #   requests
@@ -37,11 +37,11 @@ cffi==1.15.1
     #   cryptography
     #   pynacl
     #   snowflake-connector-python
-charset-normalizer==3.1.0
+charset-normalizer==3.2.0
     # via
     #   requests
     #   snowflake-connector-python
-click==8.1.3
+click==8.1.6
     # via edx-django-utils
 colorama==0.4.4
     # via awscli
@@ -91,7 +91,7 @@ docutils==0.16
     # via awscli
 drf-jwt==1.19.2
     # via edx-drf-extensions
-edx-django-utils==5.5.0
+edx-django-utils==5.6.0
     # via
     #   -r requirements/base.in
     #   edx-drf-extensions
@@ -108,9 +108,9 @@ edx-rbac==1.7.0
     # via -r requirements/base.in
 edx-rest-api-client==5.5.2
     # via -r requirements/base.in
-factory-boy==3.2.1
+factory-boy==3.3.0
     # via -r requirements/base.in
-faker==18.11.2
+faker==19.2.0
     # via factory-boy
 filelock==3.12.2
     # via snowflake-connector-python
@@ -158,7 +158,7 @@ pycryptodomex==3.18.0
     # via snowflake-connector-python
 pygments==2.15.1
     # via py2neo
-pyjwt[crypto]==2.7.0
+pyjwt[crypto]==2.8.0
     # via
     #   drf-jwt
     #   edx-drf-extensions
@@ -187,7 +187,7 @@ pytz==2023.3
     #   djangorestframework
     #   interchange
     #   snowflake-connector-python
-pyyaml==5.4.1
+pyyaml==6.0.1
     # via awscli
 requests==2.31.0
     # via
@@ -230,6 +230,7 @@ stevedore==5.1.0
 typing-extensions==4.7.1
     # via
     #   asgiref
+    #   faker
     #   snowflake-connector-python
 unicodecsv==0.14.1
     # via -r requirements/reporting.in

{edx-enterprise-data-4.11.1 → edx-enterprise-data-5.0.0}/requirements/ci.txt

@@ -6,7 +6,7 @@
 #
 coverage==7.2.7
     # via -r requirements/ci.in
-distlib==0.3.6
+distlib==0.3.7
     # via virtualenv
 filelock==3.12.2
     # via
@@ -14,7 +14,7 @@ filelock==3.12.2
     #   virtualenv
 packaging==23.1
     # via tox
-platformdirs==3.8.0
+platformdirs==3.9.1
     # via virtualenv
 pluggy==1.2.0
     # via tox
@@ -31,5 +31,5 @@ tox==3.28.0
     #   tox-battery
 tox-battery==0.6.1
     # via -r requirements/ci.in
-virtualenv==20.23.1
+virtualenv==20.24.2
     # via tox

{edx-enterprise-data-4.11.1 → edx-enterprise-data-5.0.0}/requirements/dev.txt

@@ -12,11 +12,11 @@ asn1crypto==1.5.1
     # via
     #   oscrypto
     #   snowflake-connector-python
-astroid==2.15.5
+astroid==2.15.6
     # via
     #   pylint
     #   pylint-celery
-awscli==1.28.0
+awscli==1.29.10
     # via -r requirements/reporting.in
 bcrypt==4.0.1
     # via paramiko
@@ -24,9 +24,9 @@ billiard==3.6.4.0
     # via celery
 bleach==6.0.0
     # via readme-renderer
-boto3==1.27.0
+boto3==1.28.10
     # via -r requirements/reporting.in
-botocore==1.30.0
+botocore==1.31.10
     # via
     #   awscli
     #   boto3
@@ -35,7 +35,7 @@ build==0.10.0
     # via pip-tools
 celery==4.4.7
     # via -r requirements/reporting.in
-certifi==2023.5.7
+certifi==2023.7.22
     # via
     #   py2neo
     #   requests
@@ -47,11 +47,11 @@ cffi==1.15.1
     #   snowflake-connector-python
 chardet==5.1.0
     # via diff-cover
-charset-normalizer==3.1.0
+charset-normalizer==3.2.0
     # via
     #   requests
     #   snowflake-connector-python
-click==8.1.3
+click==8.1.6
     # via
     #   click-log
     #   code-annotations
@@ -60,7 +60,7 @@ click==8.1.3
     #   pip-tools
 click-log==0.4.0
     # via edx-lint
-code-annotations==1.3.0
+code-annotations==1.5.0
     # via edx-lint
 colorama==0.4.4
     # via awscli
@@ -72,12 +72,13 @@ cryptography==40.0.2
     #   pgpy
     #   pyjwt
     #   pyopenssl
+    #   secretstorage
     #   snowflake-connector-python
-diff-cover==7.6.0
+diff-cover==7.7.0
     # via -r requirements/dev-enterprise_data.in
-dill==0.3.6
+dill==0.3.7
     # via pylint
-distlib==0.3.6
+distlib==0.3.7
     # via virtualenv
 django==3.2.20
     # via
@@ -119,7 +120,7 @@ docutils==0.16
     #   readme-renderer
 drf-jwt==1.19.2
     # via edx-drf-extensions
-edx-django-utils==5.5.0
+edx-django-utils==5.6.0
     # via
     #   -r requirements/base.in
     #   edx-drf-extensions
@@ -128,7 +129,7 @@ edx-drf-extensions==8.8.0
     # via
     #   -r requirements/base.in
     #   edx-rbac
-edx-i18n-tools==0.9.2
+edx-i18n-tools==1.0.0
     # via -r requirements/dev-enterprise_data.in
 edx-lint==5.3.4
     # via
@@ -142,9 +143,9 @@ edx-rbac==1.7.0
     # via -r requirements/base.in
 edx-rest-api-client==5.5.2
     # via -r requirements/base.in
-factory-boy==3.2.1
+factory-boy==3.3.0
     # via -r requirements/base.in
-faker==18.11.2
+faker==19.2.0
     # via factory-boy
 filelock==3.12.2
     # via
@@ -155,11 +156,11 @@ idna==3.4
     # via
     #   requests
     #   snowflake-connector-python
-importlib-metadata==6.7.0
+importlib-metadata==6.8.0
     # via
     #   keyring
     #   twine
-importlib-resources==5.12.0
+importlib-resources==6.0.0
     # via keyring
 interchange==2021.0.4
     # via py2neo
@@ -167,8 +168,12 @@ isort==5.12.0
     # via
     #   -r requirements/quality.in
     #   pylint
-jaraco-classes==3.2.3
+jaraco-classes==3.3.0
     # via keyring
+jeepney==0.8.0
+    # via
+    #   keyring
+    #   secretstorage
 jinja2==3.1.2
     # via
     #   code-annotations
@@ -193,7 +198,7 @@ mdurl==0.1.2
     # via markdown-it-py
 monotonic==1.6
     # via py2neo
-more-itertools==9.1.0
+more-itertools==10.0.0
     # via jaraco-classes
 newrelic==8.8.1
     # via edx-django-utils
@@ -209,17 +214,17 @@ pansi==2020.7.3
     # via py2neo
 paramiko==3.2.0
     # via -r requirements/reporting.in
-path==16.6.0
+path==16.7.1
     # via edx-i18n-tools
 pbr==5.11.1
     # via stevedore
 pgpy==0.6.0
     # via -r requirements/reporting.in
-pip-tools==6.14.0
+pip-tools==7.1.0
     # via -r requirements/dev-enterprise_data.in
 pkginfo==1.9.6
     # via twine
-platformdirs==3.8.0
+platformdirs==3.9.1
     # via
     #   pylint
     #   virtualenv
@@ -253,7 +258,7 @@ pygments==2.15.1
     #   py2neo
     #   readme-renderer
     #   rich
-pyjwt[crypto]==2.7.0
+pyjwt[crypto]==2.8.0
     # via
     #   drf-jwt
     #   edx-drf-extensions
@@ -300,7 +305,7 @@ pytz==2023.3
     #   djangorestframework
     #   interchange
     #   snowflake-connector-python
-pyyaml==5.4.1
+pyyaml==6.0.1
     # via
     #   awscli
     #   code-annotations
@@ -330,6 +335,8 @@ s3transfer==0.6.1
     # via
     #   awscli
     #   boto3
+secretstorage==3.3.3
+    # via keyring
 semantic-version==2.10.0
     # via edx-drf-extensions
 six==1.16.0
@@ -385,6 +392,7 @@ typing-extensions==4.7.1
     # via
     #   asgiref
     #   astroid
+    #   faker
     #   pylint
     #   rich
     #   snowflake-connector-python
@@ -403,17 +411,17 @@ vine==1.3.0
     # via
     #   amqp
     #   celery
-virtualenv==20.23.1
+virtualenv==20.24.2
     # via tox
 webencodings==0.5.1
     # via bleach
-wheel==0.40.0
+wheel==0.41.0
     # via
     #   -r requirements/dev-enterprise_data.in
     #   pip-tools
 wrapt==1.15.0
     # via astroid
-zipp==3.15.0
+zipp==3.16.2
     # via
     #   importlib-metadata
     #   importlib-resources

{edx-enterprise-data-4.11.1 → edx-enterprise-data-5.0.0}/requirements/pip.txt

@@ -4,11 +4,11 @@
 #
 #    make upgrade
 #
-wheel==0.40.0
+wheel==0.41.0
     # via -r requirements/pip.in
 
 # The following packages are considered to be unsafe in a requirements file:
-pip==23.1.2
+pip==23.2.1
     # via -r requirements/pip.in
 setuptools==68.0.0
     # via -r requirements/pip.in

{edx-enterprise-data-4.11.1 → edx-enterprise-data-5.0.0}/requirements/pip_tools.txt

@@ -6,11 +6,11 @@
 #
 build==0.10.0
     # via pip-tools
-click==8.1.3
+click==8.1.6
     # via pip-tools
 packaging==23.1
     # via build
-pip-tools==6.14.0
+pip-tools==7.1.0
     # via -r requirements/pip_tools.in
 pyproject-hooks==1.0.0
     # via build
@@ -18,7 +18,7 @@ tomli==2.0.1
     # via
     #   build
     #   pip-tools
-wheel==0.40.0
+wheel==0.41.0
     # via pip-tools
 
 # The following packages are considered to be unsafe in a requirements file: