edx-enterprise-data 8.0.0__py3-none-any.whl → 8.2.0__py3-none-any.whl

{edx_enterprise_data-8.0.0.dist-info → edx_enterprise_data-8.2.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: edx-enterprise-data
-Version: 8.0.0
+Version: 8.2.0
 Summary: Enterprise Reporting
 Home-page: https://github.com/openedx/edx-enterprise-data
 Author: edX
@@ -23,6 +23,9 @@ Requires-Dist: edx-opaque-keys
 Requires-Dist: edx-rbac
 Requires-Dist: edx-rest-api-client
 Requires-Dist: factory-boy
+Requires-Dist: mysql-connector-python
+Requires-Dist: numpy <=1.24.4
+Requires-Dist: pandas <=2.0.3
 Requires-Dist: requests
 Requires-Dist: rules
 Provides-Extra: reporting

{edx_enterprise_data-8.0.0.dist-info → edx_enterprise_data-8.2.0.dist-info}/RECORD

@@ -1,4 +1,4 @@
-enterprise_data/__init__.py,sha256=IAJ4_2bZu0JD8iXQoT4zzRiMRCLh1m5dwDvWkFW6KVA,123
+enterprise_data/__init__.py,sha256=m1B80oppzBzILf9k9JMTLdt0jtuzOm21d91sVIZvtmM,123
 enterprise_data/apps.py,sha256=aF6hZwDfI2oWj95tUTm_2ikHueQj-jLj-u0GrgzpsQI,414
 enterprise_data/clients.py,sha256=GvQupy5TVYfO_IKC3yzXSAgNP54r-PtIjidM5ws9Iks,3947
 enterprise_data/constants.py,sha256=uCKjfpdlMYFZJsAj3n9RMw4Cmg5_6s3NuwocO-fch3s,238
@@ -8,7 +8,12 @@ enterprise_data/paginators.py,sha256=YPrC5TeXFt-ymenT2H8H2nCbDCnAzJQlH9kFPElRxWE
 enterprise_data/renderers.py,sha256=WVt0qy9Ippdnl404Zsq-MruB9oQfY6h87ZzpScYBeaw,1770
 enterprise_data/signals.py,sha256=8eqNPnlvmfsKf19lGWv5xTIuBgQIqR8EZSp9UYzC8Rc,1024
 enterprise_data/urls.py,sha256=bqtKF5OEWEwrNmHG3os-pZNuNsmjlhxEqp7yM4TbPf4,243
-enterprise_data/utils.py,sha256=JdJDCzpbaQgdOrdMR8RqwveIUlB3bN5uZTn1ez9dcqs,952
+enterprise_data/utils.py,sha256=UruTQLJcEl-q5UWGPnJZrnBnV1OvzBvhuoB_JkRY4Is,2328
+enterprise_data/admin_analytics/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+enterprise_data/admin_analytics/constants.py,sha256=m7mK2PxkwnuzRAWlcPfMRdjY1r8D3dpA_i6PD0_aqBM,587
+enterprise_data/admin_analytics/data_loaders.py,sha256=jP9CgUt_93Bl_ak1_6dBPN4PAEdDT1da3sEMjJ45NLg,4281
+enterprise_data/admin_analytics/database.py,sha256=PZRJ-URmZKo7ib88iEZbN61Nhp6uwc5NpzYrrff-gTg,857
+enterprise_data/admin_analytics/utils.py,sha256=Cock_rTtHkBEKcG3cq7VcYRPEuxC_SyJBlZn9KdVeCA,2465
 enterprise_data/api/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 enterprise_data/api/urls.py,sha256=POqc_KATHdnpMf9zHtpO46pKD5KAlAExtx7G6iylLcU,273
 enterprise_data/api/v0/__init__.py,sha256=1aAzAYU5hk-RW6cKUxa1645cbZMxn7GIZ7OMjWc9MKI,46
@@ -16,9 +21,13 @@ enterprise_data/api/v0/serializers.py,sha256=dngZTk6DhRxApchQKCMp1B_c8aVnQtH0NCq
 enterprise_data/api/v0/urls.py,sha256=vzJjqIo_S3AXWs9Us8XTaJc3FnxLbYzAkmLyuDQqum0,699
 enterprise_data/api/v0/views.py,sha256=4RslZ4NZOU-844bnebEQ71ji2utRY7jEijqC45oQQD0,14380
 enterprise_data/api/v1/__init__.py,sha256=1aAzAYU5hk-RW6cKUxa1645cbZMxn7GIZ7OMjWc9MKI,46
-enterprise_data/api/v1/serializers.py,sha256=iRPdUnkAVcoJQVWdxQDtIFQJdLftnpjGNJlavMExWmg,7535
-enterprise_data/api/v1/urls.py,sha256=Vev34sBjvDSqGUuQQGTu-1ft-ISYUPO_GTOpx0RTiEA,1106
-enterprise_data/api/v1/views.py,sha256=gEPEkWFmS8n_nN5gk_MBRO9pkc2QwhS3OxPAVKxt08Q,22434
+enterprise_data/api/v1/serializers.py,sha256=AOHumabnzwK59nytoOZEWhA3f9EL_CV-bXPsYSH3LI8,8263
+enterprise_data/api/v1/urls.py,sha256=IQMAD9sZp0QeJa2cUd-WxwugWaW4hHZetQGulTjnrGc,1633
+enterprise_data/api/v1/views/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+enterprise_data/api/v1/views/base.py,sha256=FTAxlz5EzvAY657wzVgzhJPFSCHHzct7IDcvm71Smt8,866
+enterprise_data/api/v1/views/enterprise_admin.py,sha256=mvpufYoqyaGbHuclRpFj-cQxeME1j4L6S6qQ72Rxem0,4727
+enterprise_data/api/v1/views/enterprise_learner.py,sha256=yABjJje3CT8I8YOhWr1_tTkdKtnGJom8eu3EFz_-0BU,18517
+enterprise_data/api/v1/views/enterprise_offers.py,sha256=VifxgqTLFLVw4extYPlHcN1N_yjXcsYsAlYEnAbpb10,1266
 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
@@ -84,16 +93,21 @@ enterprise_data/tests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3h
 enterprise_data/tests/factories.py,sha256=EqiB8xDVN9n6ZrFV0d4h6hEiRF57dpbmOjHezU7GHME,1964
 enterprise_data/tests/mixins.py,sha256=YifptI9mtOhAWnBGyPUy4kX5OJNSDP3DvW2vb1E2tvw,805
 enterprise_data/tests/test_clients.py,sha256=xBPHF9cgEFqNJoL4klOoYh_sVS3scZGcX0Ltc9Ghp7A,6336
-enterprise_data/tests/test_filters.py,sha256=luCgJd-gnVCWLCBWG1Cd0zN3WutiYm8IvqduP0nL5oM,7244
+enterprise_data/tests/test_filters.py,sha256=ZBbLl9Sgj5mJ7lTWoaFcEPwuxPDpIbMo2n_Fhurc0T8,7263
 enterprise_data/tests/test_models.py,sha256=MWBY-LY5TPBjZ4GlvpM-h4W-BvRKr2Rml8Bzg1NPZ9M,3234
-enterprise_data/tests/test_utils.py,sha256=BTXrxtX5zW7r1c9gXZEFFX2rxHt-bh1HDxJ-0y05KtE,14586
+enterprise_data/tests/test_utils.py,sha256=itT-LvZwgJbLCSpqVCYA2TpCV9uKGi4TeVoelRfx-48,17327
 enterprise_data/tests/test_views.py,sha256=UvDRNTxruy5zBK_KgUy2cBMbwlaTW_vkM0-TCXbQZiY,69667
+enterprise_data/tests/admin_analytics/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+enterprise_data/tests/admin_analytics/test_data_loaders.py,sha256=b4BjN88FX9WjE6XJjkJZnoEvWVB_DovBGJ_wh-HgT9I,3514
+enterprise_data/tests/admin_analytics/test_utils.py,sha256=4qL_ZK-sGzbMMqiOrBrPmzdIPno7KohiaIfd7FMehic,5260
 enterprise_data/tests/api/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 enterprise_data/tests/api/v0/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 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=rLqUHfar0HdBNtz33hQxd_0qUUgr7Ku3KwQSQ1B4Ypg,15213
+enterprise_data/tests/api/v1/views/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+enterprise_data/tests/api/v1/views/test_enterprise_admin.py,sha256=A7QY4RR6BwzxSsC9equXau8_PER25-KbufCNZyGdYBI,3025
 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
@@ -113,11 +127,11 @@ enterprise_data_roles/tests/factories.py,sha256=VOm0NyOhiKkxl1MRIriRkKSpKypr9-4l
 enterprise_data_roles/tests/test_models.py,sha256=wJv7ywk0BSbjlW_U142h0aFxZleAHyT92nIiPy_ECW4,1476
 enterprise_reporting/__init__.py,sha256=yQO9ureIxFnl-1a_34H53elDwuAzXrSmhLlzqqD2SJ0,112
 enterprise_reporting/delivery_method.py,sha256=bG-JCGhrK3nuC3P6D88zBRSwDJCbaDxN35nNlXzvoRM,4813
-enterprise_reporting/external_resource_link_report.py,sha256=-KEB8jLkx4KFTTcoB1eznKte38XoAkya_VoFGUORz6o,8066
+enterprise_reporting/external_resource_link_report.py,sha256=jQ6RS0yec0IhAz4wErQ3q8Yn206R7aQbgcR2c803BLA,8066
 enterprise_reporting/reporter.py,sha256=3wI46qH-CNCUC5r9-Eme1mQdMjwEsFk9myRb-ajzJkM,13807
 enterprise_reporting/send_enterprise_reports.py,sha256=usseqP7tG0oyG7goaBA-kz2nQnU6wGLOIv0jlfq_4Lg,4753
-enterprise_reporting/utils.py,sha256=7t0IUeaLVxHmunLhYU6EVKrmizY_fquwUf3xdHWlkAE,13860
-enterprise_reporting/clients/__init__.py,sha256=Y2XqHWyEfgHBWnfwdO1P-MWLVqCivzWIJFm_lQFUMyI,5122
+enterprise_reporting/utils.py,sha256=5T2G04Re8tMQ8fAjyy_TdDlq9ZZjm7Yrq_dRQjgTAn4,13860
+enterprise_reporting/clients/__init__.py,sha256=9xW-Nj1A3JWb9rOWVFdFaDzcyremAS-whVB8DRW_wCY,5121
 enterprise_reporting/clients/enterprise.py,sha256=-ZKoQTyDLYPLDfC7hWKhJZxVOorWt0kYmFAiOUJkyNM,9853
 enterprise_reporting/clients/s3.py,sha256=CZ9FgwOGKo-lQmZ4cw8oIqoVmhEtwBb6jfhFqoNHgh4,559
 enterprise_reporting/clients/snowflake.py,sha256=h6lezl8bpWDwV35TktyUn3YFbBOhPQZOoxKEt3JQhKg,1792
@@ -125,17 +139,17 @@ enterprise_reporting/clients/vertica.py,sha256=bSxL4NqFPrpWGTQdhzBM3jkxwVQoKOgTd
 enterprise_reporting/fixtures/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 enterprise_reporting/fixtures/enterprise_customer_reporting.json,sha256=nS6E9KHW0Iqk7ZHtTyyVyrztIXxjn9OtBvMJkn7owxc,3959
 enterprise_reporting/tests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-enterprise_reporting/tests/test_clients.py,sha256=RTG9SFnScupe83Mm4_i6X1Kfvufbx_ofVnVcm08-a10,8474
+enterprise_reporting/tests/test_clients.py,sha256=h-h7xBJ6wIBKP-QqRxcJJGiQxLfTOLYByCuWfcCeCy0,8474
 enterprise_reporting/tests/test_delivery_method.py,sha256=Zy169SrKz5zWjysI_RhGujuPZWivDR3arm3kxAUBPF8,2598
-enterprise_reporting/tests/test_enterprise_client.py,sha256=nFgQ9Qo7TJQMBzKM-rTvCdOdoBp_UGrzA-vq0uy7R4s,1068
-enterprise_reporting/tests/test_external_link_report.py,sha256=yDCWCcVfKNjLMncCU0cEW78snDmI7Vc0lHIpcmTiMBA,7029
+enterprise_reporting/tests/test_enterprise_client.py,sha256=lpWm0muvA3alRjmlRAezE5901C9DU3WiySH4D5-U3qE,1058
+enterprise_reporting/tests/test_external_link_report.py,sha256=zdnVOD1qtAp9c5EbIPnD9jcoLtW4iKs7gSVklgBK328,7029
 enterprise_reporting/tests/test_reporter.py,sha256=PTmkGvPjGEjxiyizL88LAKnaWdvZDgOBjL4QStfOdyw,4057
 enterprise_reporting/tests/test_send_enterprise_reports.py,sha256=WtL-RqGgu2x5PPqmD8ot8Uiqhlu9w8frat7CbW9RnFk,1034
-enterprise_reporting/tests/test_utils.py,sha256=7Y5GmeibiC8Q5kIpYuIAkFpeyIDRs2U3ItxsabhR1zM,9493
+enterprise_reporting/tests/test_utils.py,sha256=Zt_TA0LVb-B6fQGkUkAKKVlUKKnQh8jnw1US1jKe7g8,9493
 enterprise_reporting/tests/test_vertica_client.py,sha256=-R2yNCGUjRtoXwLMBloVFQkFYrJoo613VCr61gwI3kQ,140
 enterprise_reporting/tests/utils.py,sha256=xms2LM7DV3wczXEfctOK1ddel1EE0J_YSr17UzbCDy4,1401
-edx_enterprise_data-8.0.0.dist-info/LICENSE,sha256=dql8h4yceoMhuzlcK0TT_i-NgTFNIZsgE47Q4t3dUYI,34520
-edx_enterprise_data-8.0.0.dist-info/METADATA,sha256=o5PAAEvr5HfEqPaIUI8FjVeNEaafrnrCXSfw7gh_fKo,1486
-edx_enterprise_data-8.0.0.dist-info/WHEEL,sha256=mguMlWGMX-VHnMpKOjjQidIo1ssRlCFu4a4mBpz1s2M,91
-edx_enterprise_data-8.0.0.dist-info/top_level.txt,sha256=f5F2kU-dob6MqiHJpgZkFzoCD5VMhsdpkTV5n9Tvq3I,59
-edx_enterprise_data-8.0.0.dist-info/RECORD,,
+edx_enterprise_data-8.2.0.dist-info/LICENSE,sha256=dql8h4yceoMhuzlcK0TT_i-NgTFNIZsgE47Q4t3dUYI,34520
+edx_enterprise_data-8.2.0.dist-info/METADATA,sha256=81erBLhfqTyzo75DfCtXfMt-qYPFnfrBSITELJCJCDw,1584
+edx_enterprise_data-8.2.0.dist-info/WHEEL,sha256=R0nc6qTxuoLk7ShA2_Y-UWkN8ZdfDBG2B6Eqpz2WXbs,91
+edx_enterprise_data-8.2.0.dist-info/top_level.txt,sha256=f5F2kU-dob6MqiHJpgZkFzoCD5VMhsdpkTV5n9Tvq3I,59
+edx_enterprise_data-8.2.0.dist-info/RECORD,,

{edx_enterprise_data-8.0.0.dist-info → edx_enterprise_data-8.2.0.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (70.1.1)
+Generator: setuptools (72.1.0)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

enterprise_data/__init__.py

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

enterprise_data/admin_analytics/constants.py

@@ -0,0 +1,15 @@
+"""
+Constants for admin analytics.
+"""
+import mysql.connector
+
+from django.conf import settings
+
+DATABASE_CONNECTION_CONFIG = {
+    'host': settings.DATABASES[settings.ENTERPRISE_REPORTING_DB_ALIAS]['HOST'],
+    'port': settings.DATABASES[settings.ENTERPRISE_REPORTING_DB_ALIAS]['PORT'],
+    'database': settings.DATABASES[settings.ENTERPRISE_REPORTING_DB_ALIAS]['NAME'],
+    'user': settings.DATABASES[settings.ENTERPRISE_REPORTING_DB_ALIAS]['USER'],
+    'password': settings.DATABASES[settings.ENTERPRISE_REPORTING_DB_ALIAS]['PASSWORD'],
+}
+DATABASE_CONNECTOR = mysql.connector.connect

enterprise_data/admin_analytics/data_loaders.py

@@ -0,0 +1,137 @@
+"""
+Utility functions for fetching data from the database.
+"""
+import numpy
+import pandas
+
+from django.http import Http404
+
+from enterprise_data.admin_analytics.database import run_query
+
+
+def get_select_query(table: str, columns: list, enterprise_uuid: str) -> str:
+    """
+    Generate a SELECT query for the given table and columns.
+
+    Arguments:
+        table (str): The table to query.
+        columns (list): The columns to select.
+        enterprise_uuid (str): The UUID of the enterprise customer.
+
+    Returns:
+        (str): The SELECT query.
+    """
+    return f'SELECT {", ".join(columns)} FROM {table} WHERE enterprise_customer_uuid = "{enterprise_uuid}"'
+
+
+def fetch_enrollment_data(enterprise_uuid: str):
+    """
+    Fetch enrollment data from the database for the given enterprise customer.
+
+    Arguments:
+        enterprise_uuid (str): The UUID of the enterprise customer.
+
+    Returns:
+        (pandas.DataFrame): The enrollment data.
+    """
+    enterprise_uuid = enterprise_uuid.replace('-', '')
+
+    columns = [
+        'enterprise_customer_name',
+        'enterprise_customer_uuid',
+        'lms_enrollment_id',
+        'user_id',
+        'email',
+        'course_key',
+        'courserun_key',
+        'course_id',
+        'course_subject',
+        'course_title',
+        'enterprise_enrollment_date',
+        'lms_enrollment_mode',
+        'enroll_type',
+        'program_title',
+        'date_certificate_awarded',
+        'grade_percent',
+        'cert_awarded',
+        'date_certificate_created_raw',
+        'passed_date_raw',
+        'passed_date',
+        'has_passed',
+    ]
+    query = get_select_query(
+        table='fact_enrollment_admin_dash',
+        columns=columns,
+        enterprise_uuid=enterprise_uuid,
+    )
+
+    results = run_query(query=query)
+    if not results:
+        raise Http404(f'No enrollment data found for enterprise {enterprise_uuid}')
+
+    enrollments = pandas.DataFrame(numpy.array(results), columns=columns)
+
+    # Convert date columns to datetime.
+    enrollments['enterprise_enrollment_date'] = enrollments['enterprise_enrollment_date'].astype('datetime64[ns]')
+    enrollments['date_certificate_awarded'] = enrollments['date_certificate_awarded'].astype('datetime64[ns]')
+    enrollments['date_certificate_created_raw'] = enrollments['date_certificate_created_raw'].astype('datetime64[ns]')
+    enrollments['passed_date_raw'] = enrollments['passed_date_raw'].astype('datetime64[ns]')
+    enrollments['passed_date'] = enrollments['passed_date'].astype('datetime64[ns]')
+
+    return enrollments
+
+
+def fetch_engagement_data(enterprise_uuid: str):
+    """
+    Fetch engagement data from the database for the given enterprise customer.
+
+    Arguments:
+        enterprise_uuid (str): The UUID of the enterprise customer.
+
+    Returns:
+        (pandas.DataFrame): The engagement data.
+    """
+    enterprise_uuid = enterprise_uuid.replace('-', '')
+
+    columns = [
+        'user_id',
+        'email',
+        'enterprise_customer_uuid',
+        'course_key',
+        'enroll_type',
+        'activity_date',
+        'course_title',
+        'course_subject',
+        'is_engaged',
+        'is_engaged_video',
+        'is_engaged_forum',
+        'is_engaged_problem',
+        'is_active',
+        'learning_time_seconds',
+    ]
+    query = get_select_query(
+        table='fact_enrollment_engagement_day_admin_dash', columns=columns, enterprise_uuid=enterprise_uuid
+    )
+
+    results = run_query(query=query)
+    if not results:
+        raise Http404(f'No engagement data found for enterprise {enterprise_uuid}')
+
+    engagement = pandas.DataFrame(numpy.array(results), columns=columns)
+    engagement['activity_date'] = engagement['activity_date'].astype('datetime64[ns]')
+
+    return engagement
+
+
+def fetch_max_enrollment_datetime():
+    """
+    Fetch the latest created date from the enterprise_learner_enrollment table.
+
+    created will be same for all records as this is added at the time of data load. Which is when the async process
+    populates the data in the table. We can use this to get the latest data load time.
+    """
+    query = "SELECT MAX(created) FROM enterprise_learner_enrollment"
+    results = run_query(query)
+    if not results:
+        return None
+    return pandas.to_datetime(results[0][0])

enterprise_data/admin_analytics/database.py

@@ -0,0 +1,31 @@
+"""
+Utility functions for interacting with the database.
+"""
+from contextlib import closing
+from logging import getLogger
+
+from enterprise_data.admin_analytics.constants import DATABASE_CONNECTION_CONFIG, DATABASE_CONNECTOR
+from enterprise_data.utils import timeit
+
+LOGGER = getLogger(__name__)
+
+
+@timeit
+def run_query(query):
+    """
+    Run a query on the database and return the results.
+
+    Arguments:
+        query (str): The query to run.
+
+    Returns:
+        (list): The results of the query.
+    """
+    try:
+        with closing(DATABASE_CONNECTOR(**DATABASE_CONNECTION_CONFIG)) as connection:
+            with closing(connection.cursor()) as cursor:
+                cursor.execute(query)
+                return cursor.fetchall()
+    except Exception:
+        LOGGER.exception(f'[run_query]: run_query failed for query "{query}".')
+        raise

enterprise_data/admin_analytics/utils.py

@@ -0,0 +1,81 @@
+"""
+Utility functions for fetching data from the database.
+"""
+from datetime import datetime
+
+from edx_django_utils.cache import TieredCache, get_cache_key
+
+from enterprise_data.admin_analytics.data_loaders import fetch_engagement_data, fetch_enrollment_data
+
+
+def get_cache_timeout(cache_expiry):
+    """
+    Helper method to calculate cache timeout in seconds.
+
+    Arguments:
+        cache_expiry (datetime): Datetime object denoting the cache expiry.
+
+    Returns:
+        (int): Cache timeout in seconds.
+    """
+    now = datetime.now()
+    cache_timeout = 0
+    if cache_expiry > now:
+        # Calculate cache expiry in seconds from now.
+        cache_timeout = (cache_expiry - now).seconds
+
+    return cache_timeout
+
+
+def fetch_and_cache_enrollments_data(enterprise_id, cache_expiry):
+    """
+    Helper method to fetch and cache enrollments data.
+
+    Arguments:
+        enterprise_id (str): UUID of the enterprise customer in string format.
+        cache_expiry (datetime): Datetime object denoting the cache expiry.
+
+    Returns:
+        (pandas.DataFrame): The enrollments data.
+    """
+    cache_key = get_cache_key(
+        resource='enterprise-admin-analytics-aggregates-enrollments',
+        enterprise_customer=enterprise_id,
+    )
+    cached_response = TieredCache.get_cached_response(cache_key)
+
+    if cached_response.is_found:
+        return cached_response.value
+    else:
+        enrollments = fetch_enrollment_data(enterprise_id)
+        TieredCache.set_all_tiers(
+            cache_key, enrollments, get_cache_timeout(cache_expiry)
+        )
+        return enrollments
+
+
+def fetch_and_cache_engagements_data(enterprise_id, cache_expiry):
+    """
+    Helper method to fetch and cache engagements data.
+
+    Arguments:
+        enterprise_id (str): UUID of the enterprise customer in string format.
+        cache_expiry (datetime): Datetime object denoting the cache expiry.
+
+    Returns:
+        (pandas.DataFrame): The engagements data.
+    """
+    cache_key = get_cache_key(
+        resource='enterprise-admin-analytics-aggregates-engagements',
+        enterprise_customer=enterprise_id,
+    )
+    cached_response = TieredCache.get_cached_response(cache_key)
+
+    if cached_response.is_found:
+        return cached_response.value
+    else:
+        engagements = fetch_engagement_data(enterprise_id)
+        TieredCache.set_all_tiers(
+            cache_key, engagements, get_cache_timeout(cache_expiry)
+        )
+        return engagements

enterprise_data/api/v1/serializers.py

@@ -196,3 +196,23 @@ class EnterpriseAdminSummarizeInsightsSerializer(serializers.ModelSerializer):
     class Meta:
         model = EnterpriseAdminSummarizeInsights
         fields = '__all__'
+
+
+class AdminAnalyticsAggregatesQueryParamsSerializer(serializers.Serializer):  # pylint: disable=abstract-method
+    """
+    Serializer for validating admin analytics query params.
+    """
+    start_date = serializers.DateField(required=False)
+    end_date = serializers.DateField(required=False)
+
+    def validate(self, attrs):
+        """
+        Validate the query params.
+
+        Raises:
+            serializers.ValidationError: If start_date is greater than end_date.
+        """
+        if 'start_date' in attrs and 'end_date' in attrs:
+            if attrs['start_date'] > attrs['end_date']:
+                raise serializers.ValidationError("start_date should be less than or equal to end_date.")
+        return attrs

enterprise_data/api/v1/urls.py

@@ -7,7 +7,9 @@ from rest_framework.routers import DefaultRouter
 
 from django.urls import re_path
 
-from enterprise_data.api.v1 import views
+from enterprise_data.api.v1.views import enterprise_admin as enterprise_admin_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.constants import UUID4_REGEX
 
 app_name = 'enterprise_data_api_v1'
@@ -15,31 +17,36 @@ app_name = 'enterprise_data_api_v1'
 router = DefaultRouter()
 router.register(
     r'enterprise/(?P<enterprise_id>.+)/enrollments',
-    views.EnterpriseLearnerEnrollmentViewSet,
+    enterprise_learner_views.EnterpriseLearnerEnrollmentViewSet,
     'enterprise-learner-enrollment',
 )
 router.register(
     r'enterprise/(?P<enterprise_id>.+)/offers',
-    views.EnterpriseOfferViewSet,
+    enterprise_offers_views.EnterpriseOfferViewSet,
     'enterprise-offers',
 )
 router.register(
     r'enterprise/(?P<enterprise_id>.+)/users',
-    views.EnterpriseLearnerViewSet,
+    enterprise_learner_views.EnterpriseLearnerViewSet,
     'enterprise-learner',
 )
 router.register(
     r'enterprise/(?P<enterprise_id>.+)/learner_completed_courses',
-    views.EnterpriseLearnerCompletedCoursesViewSet,
+    enterprise_learner_views.EnterpriseLearnerCompletedCoursesViewSet,
     'enterprise-learner-completed-courses',
 )
 
 urlpatterns = [
     re_path(
         fr'^admin/insights/(?P<enterprise_id>{UUID4_REGEX})$',
-        views.EnterpriseAdminInsightsView.as_view(),
+        enterprise_admin_views.EnterpriseAdminInsightsView.as_view(),
         name='enterprise-admin-insights'
     ),
+    re_path(
+        fr'^admin/anlaytics/(?P<enterprise_id>{UUID4_REGEX})$',
+        enterprise_admin_views.EnterpriseAdminAnalyticsAggregatesView.as_view(),
+        name='enterprise-admin-analytics-aggregates'
+    ),
 ]
 
 urlpatterns += router.urls

enterprise_data/api/v1/views/base.py

@@ -0,0 +1,26 @@
+"""
+Base views for enterprise data api v1.
+"""
+from edx_rbac.mixins import PermissionRequiredMixin
+from edx_rest_framework_extensions.auth.jwt.authentication import JwtAuthentication
+from edx_rest_framework_extensions.paginators import DefaultPagination
+
+from enterprise_data.constants import ANALYTICS_API_VERSION_1
+
+
+class EnterpriseViewSetMixin(PermissionRequiredMixin):
+    """
+    Base class for all Enterprise view sets.
+    """
+    authentication_classes = (JwtAuthentication,)
+    pagination_class = DefaultPagination
+    permission_required = 'can_access_enterprise'
+    API_VERSION = ANALYTICS_API_VERSION_1
+
+    def paginate_queryset(self, queryset):
+        """
+        Allows no_page query param to skip pagination
+        """
+        if 'no_page' in self.request.query_params:
+            return None
+        return super().paginate_queryset(queryset)

enterprise_data/api/v1/views/enterprise_admin.py

@@ -0,0 +1,109 @@
+"""
+Views for enterprise admin api v1.
+"""
+from datetime import datetime, timedelta
+
+from edx_rbac.decorators import permission_required
+from edx_rest_framework_extensions.auth.jwt.authentication import JwtAuthentication
+from rest_framework.response import Response
+from rest_framework.status import HTTP_200_OK, HTTP_404_NOT_FOUND
+from rest_framework.views import APIView
+
+from enterprise_data.admin_analytics.data_loaders import fetch_max_enrollment_datetime
+from enterprise_data.admin_analytics.utils import fetch_and_cache_engagements_data, fetch_and_cache_enrollments_data
+from enterprise_data.api.v1 import serializers
+from enterprise_data.models import EnterpriseAdminLearnerProgress, EnterpriseAdminSummarizeInsights
+from enterprise_data.utils import date_filter
+
+
+class EnterpriseAdminInsightsView(APIView):
+    """
+    API for getting the enterprise admin insights.
+    """
+    authentication_classes = (JwtAuthentication,)
+    http_method_names = ['get']
+
+    @permission_required('can_access_enterprise', fn=lambda request, enterprise_id: enterprise_id)
+    def get(self, request, enterprise_id):
+        """
+        HTTP GET endpoint to retrieve the enterprise admin insights
+        """
+        response_data = {}
+        learner_progress = {}
+        learner_engagement = {}
+
+        try:
+            learner_progress = EnterpriseAdminLearnerProgress.objects.get(enterprise_customer_uuid=enterprise_id)
+            learner_progress = serializers.EnterpriseAdminLearnerProgressSerializer(learner_progress).data
+            response_data['learner_progress'] = learner_progress
+        except EnterpriseAdminLearnerProgress.DoesNotExist:
+            pass
+
+        try:
+            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 learner_engagement == {}:
+            status = HTTP_404_NOT_FOUND
+
+        return Response(data=response_data, status=status)
+
+
+class EnterpriseAdminAnalyticsAggregatesView(APIView):
+    """
+    API for getting the enterprise admin analytics aggregates.
+    """
+    authentication_classes = (JwtAuthentication,)
+    http_method_names = ['get']
+
+    @permission_required('can_access_enterprise', fn=lambda request, enterprise_id: enterprise_id)
+    def get(self, request, enterprise_id):
+        """
+        HTTP GET endpoint to retrieve the enterprise admin aggregate data.
+        """
+        serializer = serializers.AdminAnalyticsAggregatesQueryParamsSerializer(data=request.GET)
+        serializer.is_valid(raise_exception=True)
+
+        last_updated_at = fetch_max_enrollment_datetime()
+        cache_expiry = last_updated_at + timedelta(days=1) if last_updated_at else datetime.now()
+
+        enrollment = fetch_and_cache_enrollments_data(enterprise_id, cache_expiry).copy()
+        engagement = fetch_and_cache_engagements_data(enterprise_id, cache_expiry).copy()
+        # Use start and end date if provided by the client, if client has not provided then use
+        # 1. minimum enrollment date from the data as the start_date
+        # 2. today's date as the end_date
+        start_date = serializer.data.get('start_date', enrollment.enterprise_enrollment_date.min())
+        end_date = serializer.data.get('end_date', datetime.now())
+
+        # Date filtering.
+        dff = date_filter(
+            start=start_date, end=end_date, data_frame=enrollment.copy(), date_column='enterprise_enrollment_date'
+        )
+
+        enrolls = len(dff)
+        courses = len(dff.course_key.unique())
+
+        dff = date_filter(start=start_date, end=end_date, data_frame=enrollment.copy(), date_column='passed_date')
+
+        completions = dff.has_passed.sum()
+
+        # Date filtering.
+        dff = date_filter(start=start_date, end=end_date, data_frame=engagement.copy(), date_column='activity_date')
+
+        hours = round(dff.learning_time_seconds.sum() / 60 / 60, 1)
+        sessions = dff.is_engaged.sum()
+
+        return Response(data={
+            'enrolls': enrolls,
+            'courses': courses,
+            'completions': completions,
+            'hours': hours,
+            'sessions': sessions,
+            'last_updated_at': last_updated_at.date() if last_updated_at else None,
+            'min_enrollment_date': enrollment.enterprise_enrollment_date.min().date(),
+            'max_enrollment_date': enrollment.enterprise_enrollment_date.max().date(),
+        }, status=HTTP_200_OK)