edx-enterprise-data 9.7.7__tar.gz → 9.7.9__tar.gz

{edx_enterprise_data-9.7.7 → edx_enterprise_data-9.7.9}/CHANGELOG.rst

@@ -16,6 +16,15 @@ Unreleased
 
 =========================
 
+[10.7.2] - 2025-01-16
+---------------------
+  * Fixed duplicate entries for groups in enterprise groups API
+
+[10.7.1] - 2025-01-07
+---------------------
+  * feat: add group_membership table
+  * feat: add APIs to support LPR filtering for enterprise groups
+
 [10.7.0] - 2024-12-24
 ---------------------
   * feat: Added user's first and last name in the enterprise enrollments API and related DB table.

{edx_enterprise_data-9.7.7/edx_enterprise_data.egg-info → edx_enterprise_data-9.7.9}/PKG-INFO

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

{edx_enterprise_data-9.7.7 → edx_enterprise_data-9.7.9/edx_enterprise_data.egg-info}/PKG-INFO

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

{edx_enterprise_data-9.7.7 → edx_enterprise_data-9.7.9}/edx_enterprise_data.egg-info/SOURCES.txt

@@ -116,6 +116,7 @@ enterprise_data/migrations/0039_auto_20240212_1403.py
 enterprise_data/migrations/0040_auto_20240718_0536_squashed_0043_alter_enterpriselearnerenrollment_enterprise_enrollment_id.py
 enterprise_data/migrations/0044_enterpriseexecedlcmoduleperformance.py
 enterprise_data/migrations/0045_alter_enterpriseexecedlcmoduleperformance_options_and_more.py
+enterprise_data/migrations/0046_enterprisegroupmembership.py
 enterprise_data/migrations/__init__.py
 enterprise_data/settings/__init__.py
 enterprise_data/settings/test.py

{edx_enterprise_data-9.7.7 → edx_enterprise_data-9.7.9}/enterprise_data/__init__.py

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

{edx_enterprise_data-9.7.7 → edx_enterprise_data-9.7.9}/enterprise_data/api/v1/serializers.py

@@ -10,6 +10,7 @@ from enterprise_data.models import (
     EnterpriseAdminLearnerProgress,
     EnterpriseAdminSummarizeInsights,
     EnterpriseExecEdLCModulePerformance,
+    EnterpriseGroupMembership,
     EnterpriseLearner,
     EnterpriseLearnerEnrollment,
     EnterpriseOffer,
@@ -253,6 +254,19 @@ class EnterpriseBudgetSerializer(serializers.ModelSerializer):
         )
 
 
+class EnterpriseGroupMembershipSerializer(serializers.ModelSerializer):
+    """
+    Serializer for EnterpriseGroupMembership model.
+    """
+
+    class Meta:
+        model = EnterpriseGroupMembership
+        fields = (
+            'enterprise_group_uuid',
+            'enterprise_group_name',
+        )
+
+
 class AdvanceAnalyticsQueryParamSerializer(serializers.Serializer):  # pylint: disable=abstract-method
     """Serializer for validating query params"""
     RESPONSE_TYPES = [

{edx_enterprise_data-9.7.7 → edx_enterprise_data-9.7.9}/enterprise_data/api/v1/urls.py

@@ -101,6 +101,11 @@ urlpatterns = [
         enterprise_admin_views.EnterpriseBudgetView.as_view(),
         name='enterprise-budgets'
     ),
+    re_path(
+        fr'^enterprise/(?P<enterprise_uuid>{UUID4_REGEX})/groups',
+        enterprise_admin_views.EnterpriseGroupMembershipView.as_view(),
+        name='enterprise-groups'
+    ),
 ]
 
 urlpatterns += router.urls

{edx_enterprise_data-9.7.7 → edx_enterprise_data-9.7.9}/enterprise_data/api/v1/views/enterprise_admin.py

@@ -21,6 +21,7 @@ from enterprise_data.models import (
     EnterpriseAdminLearnerProgress,
     EnterpriseAdminSummarizeInsights,
     EnterpriseExecEdLCModulePerformance,
+    EnterpriseGroupMembership,
     EnterpriseSubsidyBudget,
 )
 from enterprise_data.utils import timer
@@ -230,3 +231,24 @@ class EnterpriseBudgetView(APIView):
 
         serializer = serializers.EnterpriseBudgetSerializer(budgets, many=True)
         return Response(serializer.data)
+
+
+class EnterpriseGroupMembershipView(APIView):
+    """
+    View for getting Group Memberships information for an enterprise.
+    """
+    authentication_classes = (JwtAuthentication,)
+    http_method_names = ["get"]
+
+    @permission_required("can_access_enterprise", fn=lambda request, enterprise_uuid: enterprise_uuid)
+    def get(self, request, enterprise_uuid):
+        """
+        Returns the groups and budgets for an enterprise.
+        """
+        groups = EnterpriseGroupMembership.objects.filter(
+            enterprise_customer_id=enterprise_uuid,
+            group_type='flex',
+        ).values('enterprise_group_uuid', 'enterprise_group_name').distinct()
+
+        serializer = serializers.EnterpriseGroupMembershipSerializer(groups, many=True)
+        return Response(serializer.data)

{edx_enterprise_data-9.7.7 → edx_enterprise_data-9.7.9}/enterprise_data/api/v1/views/enterprise_learner.py

@@ -12,7 +12,7 @@ from rest_framework.response import Response
 
 from django.conf import settings
 from django.core.paginator import Paginator
-from django.db.models import Count, Max, OuterRef, Prefetch, Q, Subquery, Value
+from django.db.models import Count, Exists, Max, OuterRef, Prefetch, Q, Subquery, Value
 from django.db.models.fields import IntegerField
 from django.db.models.functions import Coalesce
 from django.http import StreamingHttpResponse
@@ -20,7 +20,7 @@ from django.utils import timezone
 
 from enterprise_data.admin_analytics.database.utils import LOGGER
 from enterprise_data.api.v1 import serializers
-from enterprise_data.models import EnterpriseLearner, EnterpriseLearnerEnrollment
+from enterprise_data.models import EnterpriseGroupMembership, EnterpriseLearner, EnterpriseLearnerEnrollment
 from enterprise_data.paginators import EnterpriseEnrollmentsPagination
 from enterprise_data.renderers import EnrollmentsCSVRenderer
 from enterprise_data.utils import subtract_one_month
@@ -174,6 +174,15 @@ class EnterpriseLearnerEnrollmentViewSet(EnterpriseViewSetMixin, viewsets.ReadOn
         if is_subsidy:
             queryset = queryset.filter(is_subsidy=is_subsidy)
 
+        group_uuid = query_filters.get('group_uuid')
+        if group_uuid:
+            flex_group_exists = EnterpriseGroupMembership.objects.filter(
+                enterprise_customer_user_id=OuterRef('enterprise_user_id'),
+                enterprise_group_uuid=group_uuid,
+                group_type='flex'
+            )
+            queryset = queryset.filter(Exists(flex_group_exists))
+
         return queryset
 
     def filter_by_offer_id(self, queryset, offer_id):

edx_enterprise_data-9.7.9/enterprise_data/migrations/0046_enterprisegroupmembership.py

@@ -0,0 +1,36 @@
+# Generated by Django 4.2.16 on 2025-01-08 07:31
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('enterprise_data', '0045_alter_enterpriseexecedlcmoduleperformance_options_and_more'),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name='EnterpriseGroupMembership',
+            fields=[
+                ('group_membership_unique_id', models.CharField(max_length=64, primary_key=True, serialize=False)),
+                ('is_applies_to_all_contexts', models.BooleanField(default=False)),
+                ('enterprise_customer_id', models.UUIDField(db_index=True, null=True)),
+                ('enterprise_group_name', models.CharField(max_length=255, null=True)),
+                ('enterprise_group_uuid', models.UUIDField(null=True)),
+                ('group_is_removed', models.BooleanField(default=False)),
+                ('group_type', models.CharField(max_length=128, null=True)),
+                ('activated_at', models.DateTimeField(null=True)),
+                ('enterprise_customer_user_id', models.PositiveIntegerField(null=True)),
+                ('membership_is_removed', models.BooleanField(default=False)),
+                ('membership_status', models.CharField(max_length=128, null=True)),
+                ('enterprise_group_membership_uuid', models.UUIDField(null=True)),
+            ],
+            options={
+                'verbose_name': 'Group Membership',
+                'verbose_name_plural': 'Group Memberships',
+                'db_table': 'group_membership',
+                'indexes': [models.Index(fields=['enterprise_group_uuid', 'group_type', 'enterprise_customer_user_id'], name='group_membe_enterpr_796f48_idx')],
+            },
+        ),
+    ]

{edx_enterprise_data-9.7.7 → edx_enterprise_data-9.7.9}/enterprise_data/models.py

@@ -398,6 +398,50 @@ class EnterpriseSubsidyBudget(models.Model):
         return self.__str__()
 
 
+class EnterpriseGroupMembership(models.Model):
+    """
+    Details of group memberships in enterprise reports.
+    """
+
+    objects = EnterpriseReportingModelManager()
+
+    class Meta:
+        app_label = 'enterprise_data'
+        db_table = 'group_membership'
+        verbose_name = _("Group Membership")
+        verbose_name_plural = _("Group Memberships")
+        indexes = [
+            models.Index(fields=['enterprise_group_uuid', 'group_type', 'enterprise_customer_user_id']),
+        ]
+
+    group_membership_unique_id = models.CharField(max_length=64, primary_key=True)
+    is_applies_to_all_contexts = models.BooleanField(default=False)
+    enterprise_customer_id = models.UUIDField(db_index=True, null=True)
+    enterprise_group_name = models.CharField(max_length=255, null=True)
+    enterprise_group_uuid = models.UUIDField(null=True)
+    group_is_removed = models.BooleanField(default=False)
+    group_type = models.CharField(max_length=128, null=True)
+    activated_at = models.DateTimeField(null=True)
+    enterprise_customer_user_id = models.PositiveIntegerField(null=True)
+    membership_is_removed = models.BooleanField(default=False)
+    membership_status = models.CharField(max_length=128, null=True)
+    enterprise_group_membership_uuid = models.UUIDField(null=True)
+
+    def __str__(self):
+        """
+        Return a human-readable string representation of the object.
+        """
+        return (f'<Enterprise Group Membership: {self.enterprise_group_name} '
+                f'(Group UUID: {self.enterprise_group_uuid}) '
+                f'for Customer ID {self.enterprise_customer_id}>')
+
+    def __repr__(self):
+        """
+        Return uniquely identifying string representation.
+        """
+        return self.__str__()
+
+
 class EnterpriseUser(models.Model):
     """Information includes a mix of the user's meta data.
 

{edx_enterprise_data-9.7.7 → edx_enterprise_data-9.7.9}/enterprise_data/tests/test_models.py

@@ -10,6 +10,7 @@ from pytest import mark
 
 from enterprise_data.tests.test_utils import (
     EnterpriseEnrollmentFactory,
+    EnterpriseGroupMembershipFactory,
     EnterpriseOfferFactory,
     EnterpriseSubsidyBudgetFactory,
     EnterpriseUserFactory,
@@ -91,6 +92,32 @@ class TestEnterpriseSubsidyBudget(unittest.TestCase):
         assert expected_str == method(self.enterprise_subsidy_budget)
 
 
+@mark.django_db
+@ddt.ddt
+class TestEnterpriseGroupMembership(unittest.TestCase):
+    """
+    Tests for Enterprise Group Membership model
+    """
+
+    def setUp(self):
+        self.enterprise_group_membership = EnterpriseGroupMembershipFactory(
+            enterprise_customer_id='ee5e6b3a-069a-4947-bb8d-d2dbc323396c',
+            enterprise_group_name='Test Group',
+            enterprise_group_uuid='ee5e6b3a-069a-4947-bb8d-d2dbc323396d',
+        )
+        super().setUp()
+
+    @ddt.data(str, repr)
+    def test_string_conversion(self, method):
+        """
+        Test conversion to string.
+        """
+        expected_str = ('<Enterprise Group Membership: Test Group '
+                        '(Group UUID: ee5e6b3a-069a-4947-bb8d-d2dbc323396d) '
+                        'for Customer ID ee5e6b3a-069a-4947-bb8d-d2dbc323396c>')
+        assert expected_str == method(self.enterprise_group_membership)
+
+
 @mark.django_db
 @ddt.ddt
 class TestEnterpriseUser(unittest.TestCase):

{edx_enterprise_data-9.7.7 → edx_enterprise_data-9.7.9}/enterprise_data/tests/test_utils.py

@@ -14,6 +14,7 @@ from django.contrib.auth import get_user_model
 
 from enterprise_data.models import (
     EnterpriseEnrollment,
+    EnterpriseGroupMembership,
     EnterpriseLearner,
     EnterpriseLearnerEnrollment,
     EnterpriseOffer,
@@ -288,6 +289,27 @@ class EnterpriseSubsidyBudgetFactory(factory.django.DjangoModelFactory):
     )
 
 
+class EnterpriseGroupMembershipFactory(factory.django.DjangoModelFactory):
+    """
+    EnterpriseGroupMembership model Factory.
+    """
+    class Meta:
+        model = EnterpriseGroupMembership
+
+    enterprise_customer_id = factory.LazyAttribute(lambda _: FAKER.uuid4())
+    enterprise_group_name = factory.LazyAttribute(lambda _: ' '.join(FAKER.words(nb=2)).title())
+    enterprise_group_uuid = factory.LazyAttribute(lambda _: FAKER.uuid4())
+    group_is_removed = factory.LazyAttribute(lambda _: FAKER.boolean())
+    group_type = factory.LazyAttribute(lambda _: 'budget')
+    activated_at = factory.LazyAttribute(lambda _: FAKER.date_time_this_decade(tzinfo=pytz.UTC))
+    enterprise_customer_user_id = factory.LazyAttribute(lambda _: FAKER.random_int(min=1, max=10000))
+    membership_is_removed = factory.LazyAttribute(lambda _: FAKER.boolean())
+    membership_status = factory.LazyAttribute(lambda _: FAKER.word())
+    enterprise_group_membership_uuid = factory.LazyAttribute(lambda _: FAKER.uuid4())
+
+    is_applies_to_all_contexts = factory.LazyAttribute(lambda _: FAKER.boolean())
+
+
 class EnterpriseOfferFactory(factory.django.DjangoModelFactory):
     """
     EnterpriseLearner model Factory.