edx-enterprise-data 10.10.1__tar.gz → 10.11.1__tar.gz

{edx_enterprise_data-10.10.1 → edx_enterprise_data-10.11.1}/CHANGELOG.rst

@@ -15,6 +15,15 @@ Unreleased
 ----------
 
 =========================
+[10.11.1] - 2025-04-08
+---------------------
+  * fix: Fixed a bug in group_uuid based filtering.
+
+
+[10.11.0] - 2025-03-25
+---------------------
+  * feat: Added the ability to filter enrollments by group_uuid in the enterprise enrollments API.
+
 [10.10.1] - 2025-03-18
 ---------------------
   * fix: Updated FROM email address to a provisioned email address.

{edx_enterprise_data-10.10.1/edx_enterprise_data.egg-info → edx_enterprise_data-10.11.1}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.2
+Metadata-Version: 2.4
 Name: edx-enterprise-data
-Version: 10.10.1
+Version: 10.11.1
 Summary: Enterprise Reporting
 Home-page: https://github.com/openedx/edx-enterprise-data
 Author: edX
@@ -45,6 +45,7 @@ Dynamic: classifier
 Dynamic: description
 Dynamic: home-page
 Dynamic: license
+Dynamic: license-file
 Dynamic: provides-extra
 Dynamic: requires-dist
 Dynamic: summary

{edx_enterprise_data-10.10.1 → edx_enterprise_data-10.11.1/edx_enterprise_data.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.2
+Metadata-Version: 2.4
 Name: edx-enterprise-data
-Version: 10.10.1
+Version: 10.11.1
 Summary: Enterprise Reporting
 Home-page: https://github.com/openedx/edx-enterprise-data
 Author: edX
@@ -45,6 +45,7 @@ Dynamic: classifier
 Dynamic: description
 Dynamic: home-page
 Dynamic: license
+Dynamic: license-file
 Dynamic: provides-extra
 Dynamic: requires-dist
 Dynamic: summary

{edx_enterprise_data-10.10.1 → edx_enterprise_data-10.11.1}/edx_enterprise_data.egg-info/SOURCES.txt

@@ -13,6 +13,7 @@ enterprise_data/__init__.py
 enterprise_data/apps.py
 enterprise_data/clients.py
 enterprise_data/constants.py
+enterprise_data/exceptions.py
 enterprise_data/filters.py
 enterprise_data/models.py
 enterprise_data/paginators.py
@@ -25,10 +26,18 @@ enterprise_data/admin_analytics/constants.py
 enterprise_data/admin_analytics/data_loaders.py
 enterprise_data/admin_analytics/database/__init__.py
 enterprise_data/admin_analytics/database/utils.py
+enterprise_data/admin_analytics/database/filters/__init__.py
+enterprise_data/admin_analytics/database/filters/base.py
+enterprise_data/admin_analytics/database/filters/fact_enrollment_admin_dash.py
 enterprise_data/admin_analytics/database/queries/__init__.py
 enterprise_data/admin_analytics/database/queries/fact_engagement_admin_dash.py
 enterprise_data/admin_analytics/database/queries/fact_enrollment_admin_dash.py
 enterprise_data/admin_analytics/database/queries/skills_daily_rollup_admin_dash.py
+enterprise_data/admin_analytics/database/query_filters/__init__.py
+enterprise_data/admin_analytics/database/query_filters/base.py
+enterprise_data/admin_analytics/database/query_filters/between.py
+enterprise_data/admin_analytics/database/query_filters/equal.py
+enterprise_data/admin_analytics/database/query_filters/in_.py
 enterprise_data/admin_analytics/database/tables/__init__.py
 enterprise_data/admin_analytics/database/tables/base.py
 enterprise_data/admin_analytics/database/tables/fact_engagement_admin_dash.py

{edx_enterprise_data-10.10.1 → edx_enterprise_data-10.11.1}/enterprise_data/__init__.py

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

edx_enterprise_data-10.11.1/enterprise_data/admin_analytics/database/filters/__init__.py

@@ -0,0 +1,5 @@
+"""
+Query Filters for database tables.
+"""
+
+from .fact_enrollment_admin_dash import FactEnrollmentAdminDashFilters

edx_enterprise_data-10.11.1/enterprise_data/admin_analytics/database/filters/base.py

@@ -0,0 +1,7 @@
+"""
+Base filters for database tables.
+"""
+
+
+class BaseFilter:
+    pass

edx_enterprise_data-10.11.1/enterprise_data/admin_analytics/database/filters/fact_enrollment_admin_dash.py

@@ -0,0 +1,51 @@
+"""
+Query filters for enrollments table.
+"""
+from enterprise_data.admin_analytics.database.filters.base import BaseFilter
+from enterprise_data.admin_analytics.database.query_filters import BetweenQueryFilter, EqualQueryFilter, INQueryFilter
+
+
+class FactEnrollmentAdminDashFilters(BaseFilter):
+    """
+    Query filters for enrollments table.
+    """
+    @staticmethod
+    def enterprise_customer_uuid_filter(enterprise_customer_uuid_params_key: str) -> EqualQueryFilter:
+        """
+        Filter by enterprise customer uuid.
+
+        Arguments:
+            enterprise_customer_uuid_params_key: The key against which value will be passed in the query.
+        """
+        return EqualQueryFilter(
+            column='enterprise_customer_uuid',
+            value_placeholder=enterprise_customer_uuid_params_key,
+        )
+
+    @staticmethod
+    def enterprise_enrollment_date_range_filter(
+            start_date_params_key: str, end_date_params_key: str
+    ) -> BetweenQueryFilter:
+        """
+        Filter by enrollment date to be in the given range.
+
+        Arguments:
+            start_date_params_key (str): The start date key against which value will be passed in the query.
+            end_date_params_key (str): The end date key against which value will be passed in the query.
+        """
+        return BetweenQueryFilter(
+            column='enterprise_enrollment_date',
+            range_placeholders=(start_date_params_key, end_date_params_key),
+        )
+
+    @staticmethod
+    def enterprise_user_id_in_filter(
+            enterprise_user_id_param_keys: list,
+    ) -> INQueryFilter:
+        """
+        Filter by enterprise user id.
+        """
+        return INQueryFilter(
+            column='enterprise_user_id',
+            values_placeholders=enterprise_user_id_param_keys
+        )

{edx_enterprise_data-10.10.1 → edx_enterprise_data-10.11.1}/enterprise_data/admin_analytics/database/queries/fact_enrollment_admin_dash.py

@@ -1,6 +1,7 @@
 """
 Module containing queries for the fact_enrollment_admin_dash table.
 """
+from ..query_filters import QueryFilters
 
 
 class FactEnrollmentAdminDashQueries:
@@ -20,27 +21,25 @@ class FactEnrollmentAdminDashQueries:
         """
 
     @staticmethod
-    def get_enrollment_count_query():
+    def get_enrollment_count_query(query_filters: QueryFilters) -> str:
         """
         Get the query to fetch the total number of enrollments for an enterprise customer.
         """
-        return """
+        return f"""
             SELECT count(*)
             FROM fact_enrollment_admin_dash
-            WHERE enterprise_customer_uuid=%(enterprise_customer_uuid)s AND
-                enterprise_enrollment_date BETWEEN %(start_date)s AND %(end_date)s;
+            WHERE {query_filters.to_sql()};
         """
 
     @staticmethod
-    def get_all_enrollments_query():
+    def get_all_enrollments_query(query_filters: QueryFilters) -> str:
         """
         Get the query to fetch all enrollments.
         """
-        return """
+        return f"""
             SELECT email, course_title, course_subject, enroll_type, enterprise_enrollment_date
             FROM fact_enrollment_admin_dash
-            WHERE enterprise_customer_uuid=%(enterprise_customer_uuid)s AND
-                enterprise_enrollment_date BETWEEN %(start_date)s AND %(end_date)s
+            WHERE {query_filters.to_sql()}
             ORDER BY ENTERPRISE_ENROLLMENT_DATE DESC LIMIT %(limit)s OFFSET %(offset)s
         """
 
@@ -98,21 +97,21 @@ class FactEnrollmentAdminDashQueries:
         """
 
     @staticmethod
-    def get_top_courses_by_enrollments_query(record_count=10):
+    def get_top_courses_by_enrollments_query(query_filters: QueryFilters, record_count: int = 10) -> str:
         """
         Get the query to fetch the enrollment count by courses.
 
         Query will fetch the top N courses by enrollment count. Where N is the value of record_count.
 
         Arguments:
+            query_filters (QueryFilters): List of query filters.
             record_count (int): Number of records to fetch.
         """
         return f"""
             WITH filtered_data AS (
                 SELECT *
                 FROM fact_enrollment_admin_dash
-                WHERE enterprise_customer_uuid=%(enterprise_customer_uuid)s AND
-                enterprise_enrollment_date BETWEEN %(start_date)s AND %(end_date)s
+                WHERE {query_filters.to_sql()}
             ),
             top_10_courses AS (
                 SELECT course_key
@@ -134,7 +133,7 @@ class FactEnrollmentAdminDashQueries:
         """
 
     @staticmethod
-    def get_top_subjects_by_enrollments_query(record_count=10):
+    def get_top_subjects_by_enrollments_query(query_filters: QueryFilters, record_count: int = 10) -> str:
         """
         Get the query to fetch the enrollment count by subjects.
 
@@ -142,13 +141,13 @@ class FactEnrollmentAdminDashQueries:
 
         Arguments:
             record_count (int): Number of records to fetch.
+            query_filters (QueryFilters): List of query filters.
         """
         return f"""
             WITH filtered_data AS (
                 SELECT *
                 FROM fact_enrollment_admin_dash
-                WHERE enterprise_customer_uuid=%(enterprise_customer_uuid)s AND
-                enterprise_enrollment_date BETWEEN %(start_date)s AND %(end_date)s
+                WHERE {query_filters.to_sql()}
             ),
             top_10_subjects AS (
                 SELECT course_subject
@@ -168,15 +167,17 @@ class FactEnrollmentAdminDashQueries:
         """
 
     @staticmethod
-    def get_enrolment_time_series_data_query():
+    def get_enrolment_time_series_data_query(query_filters: QueryFilters) -> str:
         """
         Get the query to fetch the enrollment time series data with daily aggregation.
+
+        Arguments:
+            query_filters (QueryFilters): A list of filters for this query.
         """
-        return """
+        return f"""
             SELECT enterprise_enrollment_date, enroll_type, COUNT(*) as enrollment_count
             FROM fact_enrollment_admin_dash
-            WHERE enterprise_customer_uuid=%(enterprise_customer_uuid)s AND
-                enterprise_enrollment_date BETWEEN %(start_date)s AND %(end_date)s
+            WHERE {query_filters.to_sql()}
             GROUP BY enterprise_enrollment_date, enroll_type
             ORDER BY enterprise_enrollment_date;
         """

edx_enterprise_data-10.11.1/enterprise_data/admin_analytics/database/query_filters/__init__.py

@@ -0,0 +1,7 @@
+"""
+Query Filters to filter query data.
+"""
+from .base import QueryFilters
+from .between import BetweenQueryFilter
+from .equal import EqualQueryFilter
+from .in_ import INQueryFilter

edx_enterprise_data-10.11.1/enterprise_data/admin_analytics/database/query_filters/base.py

@@ -0,0 +1,68 @@
+"""
+Base Query Filter.
+"""
+from abc import ABC, abstractmethod
+
+
+class QueryFilter(ABC):
+    """
+    Base Query filter class for functionality common to all filters.
+    """
+    @abstractmethod
+    def to_sql(self) -> str:
+        """
+        Convert the filter to a SQL string.
+        """
+        raise NotImplementedError
+
+    @staticmethod
+    def validate_argument_exclusivity(value, value_placeholder):
+        """
+        Validate that that arguments are mutually exclusive.
+
+        This method will make sure that at-least one of the value or value_placeholder is provided. it will also
+        make sure that both value and value_placeholder are not provided at the same time.
+
+        Arguments:
+            value: The value of the filter.
+            value_placeholder: The placeholder for the value.
+        """
+        if value is not None and value_placeholder is not None:
+            raise ValueError('Both value and value_placeholder cannot be provided at the same time.')
+        if value is None and value_placeholder is None:
+            raise ValueError('Either value or value_placeholder must be provided.')
+        return True
+
+    def value_to_sql(self, value):
+        """
+        Convert the given value to a string in a way that it can be used inside WHERE clause of SQL query.
+
+        Note: This method is meant to evolve according to user needs. currently it handles the following data types.
+        More types can be added as needed.
+
+        1. str: Encloses the string in single quotes.
+        2. list<str>: Encloses the list of strings in a tuple after calling this method recursively on each item.
+
+        Arguments:
+            value (Any): The value to format.
+
+        Returns:
+            (Any): The formatted value.
+        """
+        if isinstance(value, str):
+            return f"'{value}'"
+        if isinstance(value, list):
+            return [self.value_to_sql(item) for item in value]
+
+        return value
+
+
+class QueryFilters(list):
+    """
+    A list of QueryFilter objects.
+    """
+    def to_sql(self) -> str:
+        """
+        Convert the filters to a SQL string.
+        """
+        return ' AND '.join([_filter.to_sql() for _filter in self])

edx_enterprise_data-10.11.1/enterprise_data/admin_analytics/database/query_filters/between.py

@@ -0,0 +1,30 @@
+"""
+Query filter for between operation.
+"""
+from .base import QueryFilter
+
+
+class BetweenQueryFilter(QueryFilter):
+    """
+    Query filter for between operation.
+    """
+
+    def __init__(self, column: str, _range: tuple = None, range_placeholders: tuple = None):
+        """
+        Initialize the filter.
+
+        This will also validate arguments.
+        """
+        self.validate_argument_exclusivity(_range, range_placeholders)
+
+        self.column = column
+        self.range = _range
+        self.range_placeholders = range_placeholders
+
+    def to_sql(self) -> str:
+        if self.range:
+            lower, upper = self.range
+            return f'{self.column} BETWEEN {self.value_to_sql(lower)} AND {self.value_to_sql(upper)}'
+        else:
+            lower_placeholder, upper_placeholder = self.range_placeholders
+            return f'{self.column} BETWEEN %({lower_placeholder})s AND %({upper_placeholder})s'

edx_enterprise_data-10.11.1/enterprise_data/admin_analytics/database/query_filters/equal.py

@@ -0,0 +1,27 @@
+"""
+Query filter for equal operation.
+"""
+from .base import QueryFilter
+
+
+class EqualQueryFilter(QueryFilter):
+    """
+    Query filter for equal operation.
+    """
+    def __init__(self, column: str, value: str = None, value_placeholder: str = None):
+        """
+        Initialize the filter.
+
+        This will also validate arguments.
+        """
+        self.validate_argument_exclusivity(value, value_placeholder)
+
+        self.column = column
+        self.value = value
+        self.value_placeholder = value_placeholder
+
+    def to_sql(self) -> str:
+        if self.value is not None:
+            return f'{self.column} = {self.value_to_sql(self.value)}'
+        else:
+            return f'{self.column} = %({self.value_placeholder})s'

edx_enterprise_data-10.11.1/enterprise_data/admin_analytics/database/query_filters/in_.py

@@ -0,0 +1,28 @@
+"""
+Query filter for between operation.
+"""
+from .base import QueryFilter
+
+
+class INQueryFilter(QueryFilter):
+    """
+    Query filter for IN operation.
+    """
+
+    def __init__(self, column: str, values: list = None, values_placeholders: list = None):
+        """
+        Initialize the filter.
+
+        This will also validate arguments.
+        """
+        self.validate_argument_exclusivity(values, values_placeholders)
+
+        self.column = column
+        self.values = values
+        self.values_placeholders = values_placeholders
+
+    def to_sql(self) -> str:
+        if self.values is not None:
+            return f'{self.column} IN {str(tuple(self.value_to_sql(self.values)))}'
+        else:
+            return f'{self.column} IN {tuple(f"%({item})s" for item in self.values_placeholders)}'