edx-enterprise-data 10.7.0__py3-none-any.whl → 10.7.2__py3-none-any.whl

{edx_enterprise_data-10.7.0.dist-info → edx_enterprise_data-10.7.2.dist-info}/METADATA

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.2
 Name: edx-enterprise-data
-Version: 10.7.0
+Version: 10.7.2
 Summary: Enterprise Reporting
 Home-page: https://github.com/openedx/edx-enterprise-data
 Author: edX
@@ -39,5 +39,14 @@ Requires-Dist: pyminizip; extra == "reporting"
 Requires-Dist: snowflake-connector-python; extra == "reporting"
 Requires-Dist: unicodecsv==0.14.1; extra == "reporting"
 Requires-Dist: vertica-python; extra == "reporting"
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: home-page
+Dynamic: license
+Dynamic: provides-extra
+Dynamic: requires-dist
+Dynamic: summary
 
 Tools and products related to providing access to Enterprise data.

{edx_enterprise_data-10.7.0.dist-info → edx_enterprise_data-10.7.2.dist-info}/RECORD

@@ -1,9 +1,9 @@
-enterprise_data/__init__.py,sha256=iTpn78n71dvVScgFYyIsXHgae3gI4WEYNwYvxi4vjDc,124
+enterprise_data/__init__.py,sha256=5Chxgpl3yRbGK8Ic5AaVBAEemUuIfFMUOYE6f5jkNjY,124
 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
 enterprise_data/filters.py,sha256=D2EiK12MMpBoz6eOUmTpoJEhj_sH7bA93NRRAdvkDVo,6163
-enterprise_data/models.py,sha256=7j8b8lgORZTQC9frG4CpfHTRvTgUvBTThemz6JPGCb0,24559
+enterprise_data/models.py,sha256=INIETN4B6G1EtxVzgBQr6-JMy3ZsHj9K_FCyrS5OFAk,26312
 enterprise_data/paginators.py,sha256=YPrC5TeXFt-ymenT2H8H2nCbDCnAzJQlH9kFPElRxWE,269
 enterprise_data/renderers.py,sha256=qggCLZklL9ohVcLHLO1pSecPJSDCCR7e_-PVobl9Lj8,3063
 enterprise_data/signals.py,sha256=8eqNPnlvmfsKf19lGWv5xTIuBgQIqR8EZSp9UYzC8Rc,1024
@@ -30,16 +30,16 @@ 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=C7X_f2J2RmqdGPmy9KFQQyGOli98kGeSsPDBG9kDk3A,10939
-enterprise_data/api/v1/urls.py,sha256=IpOyS9UWuyip6fw6gtrxBw9SZLOdxh3sQ2j0Gdk4eOw,4180
+enterprise_data/api/v1/serializers.py,sha256=mya_ZvP7CTvUTF_ccYkMJZFuzOKIU-aM3eSCQmFazWY,11274
+enterprise_data/api/v1/urls.py,sha256=Wl1xLboPg-Lq1ZvjAWf51JKYkHlmx02Kpq1nwfDyS8s,4372
 enterprise_data/api/v1/views/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 enterprise_data/api/v1/views/analytics_completions.py,sha256=esFbJ5q8ssnm2Mfbc3rZXtiGHF-MeM4KQ4Ft3N7wwHU,6260
 enterprise_data/api/v1/views/analytics_engagements.py,sha256=Yo-bpA-0xOQHUPTFF0jHWxjm6KpSC-l2nGxhYX0ajBk,6298
 enterprise_data/api/v1/views/analytics_enrollments.py,sha256=hw87VZ0hFWpwf3QEHFn9cUgDy2s7SzsXt6Rf9TaNsS0,6282
 enterprise_data/api/v1/views/analytics_leaderboard.py,sha256=3dyo7_OhyGEEeibemBrRsUOo0jbM4LbDgV5gw3YnVig,4186
 enterprise_data/api/v1/views/base.py,sha256=Kkmd5zgEBAhvwS_GoGXSK6lgbDNwSPioYn-QbnizI3w,3416
-enterprise_data/api/v1/views/enterprise_admin.py,sha256=DyN6RS4qY8sgKNIvcx1nRmSGuPm2pLYHZeh5YHXlH2w,8209
-enterprise_data/api/v1/views/enterprise_learner.py,sha256=XYoNQ9Ir12B9seGcs2LadWgeee3j5UTTAztZROcSy4U,18201
+enterprise_data/api/v1/views/enterprise_admin.py,sha256=AN-wxfc0jYNvoZjHRq-FsExzYthELuK4SJQ20Sp1okY,9037
+enterprise_data/api/v1/views/enterprise_learner.py,sha256=lCB2guZeIDf-CbcdDzT2K5K-OW1Vt5i4R8K9aT1ZzuM,18627
 enterprise_data/api/v1/views/enterprise_offers.py,sha256=VifxgqTLFLVw4extYPlHcN1N_yjXcsYsAlYEnAbpb10,1266
 enterprise_data/cache/__init__.py,sha256=fiBUploll1kmDy2vCmnNpeZVTD4ewsgtRF14vVs0Rb4,1850
 enterprise_data/cache/decorators.py,sha256=vLbXK9VSv-HzVkkXS1-TkuSMxudwyxz04WFsAXqmjuM,1273
@@ -105,6 +105,7 @@ enterprise_data/migrations/0039_auto_20240212_1403.py,sha256=rMiJcYx26ZGqPdQzgiW
 enterprise_data/migrations/0040_auto_20240718_0536_squashed_0043_alter_enterpriselearnerenrollment_enterprise_enrollment_id.py,sha256=Kq_ResqoAsJjtyIysHjs4VaDxNh6p4fPMMyh93GIJxA,1693
 enterprise_data/migrations/0044_enterpriseexecedlcmoduleperformance.py,sha256=1aJ0wIu9K2cT3AJdBIHuNCUpJysPWmq_37Ucp5ntEO8,6122
 enterprise_data/migrations/0045_alter_enterpriseexecedlcmoduleperformance_options_and_more.py,sha256=HJkY2OvuE39ciWgaEescd--ixQhTVrwzbL0_bvNofSo,876
+enterprise_data/migrations/0046_enterprisegroupmembership.py,sha256=38qfi3EySDLrpP3gDuO_oUl_7rphGPZIrPsCuBhQ_dk,1766
 enterprise_data/migrations/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 enterprise_data/settings/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 enterprise_data/settings/test.py,sha256=4-flfrlf81AthGx9wTaT5PscyoOWyhsDDqbzBl-z7Eg,4191
@@ -113,8 +114,8 @@ enterprise_data/tests/factories.py,sha256=EqiB8xDVN9n6ZrFV0d4h6hEiRF57dpbmOjHezU
 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=ZBbLl9Sgj5mJ7lTWoaFcEPwuxPDpIbMo2n_Fhurc0T8,7263
-enterprise_data/tests/test_models.py,sha256=MWBY-LY5TPBjZ4GlvpM-h4W-BvRKr2Rml8Bzg1NPZ9M,3234
-enterprise_data/tests/test_utils.py,sha256=k3ha4V9fM2jd98r0SIOWr5umMEG0YbVKJVbtq4zXXmw,18572
+enterprise_data/tests/test_models.py,sha256=rRFrzjMnnUh1YpVvQMyA1OhFmX6BOCRt28SNAiPq6Ac,4179
+enterprise_data/tests/test_utils.py,sha256=3sM3YWEoihHupgwhh0NiI66CbcQPLY4I_W0xjbLG0zg,19694
 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/mock_analytics_data.py,sha256=qN73YxoD1kAtKsQo94avR0DGMCsJClrpqFxxYC6reqE,15248
@@ -172,8 +173,8 @@ enterprise_reporting/tests/test_send_enterprise_reports.py,sha256=WtL-RqGgu2x5PP
 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-10.7.0.dist-info/LICENSE,sha256=dql8h4yceoMhuzlcK0TT_i-NgTFNIZsgE47Q4t3dUYI,34520
-edx_enterprise_data-10.7.0.dist-info/METADATA,sha256=0sUp6Oy7fhAJC087VKKO2jVz6UkbQZ__QUxvTacKdMk,1505
-edx_enterprise_data-10.7.0.dist-info/WHEEL,sha256=PZUExdf71Ui_so67QXpySuHtCi3-J3wvF4ORK6k_S8U,91
-edx_enterprise_data-10.7.0.dist-info/top_level.txt,sha256=f5F2kU-dob6MqiHJpgZkFzoCD5VMhsdpkTV5n9Tvq3I,59
-edx_enterprise_data-10.7.0.dist-info/RECORD,,
+edx_enterprise_data-10.7.2.dist-info/LICENSE,sha256=dql8h4yceoMhuzlcK0TT_i-NgTFNIZsgE47Q4t3dUYI,34520
+edx_enterprise_data-10.7.2.dist-info/METADATA,sha256=pggxqx9NgmLj-VfA4dpZzwjx618xhjepHck63jbyN3E,1684
+edx_enterprise_data-10.7.2.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
+edx_enterprise_data-10.7.2.dist-info/top_level.txt,sha256=f5F2kU-dob6MqiHJpgZkFzoCD5VMhsdpkTV5n9Tvq3I,59
+edx_enterprise_data-10.7.2.dist-info/RECORD,,

{edx_enterprise_data-10.7.0.dist-info → edx_enterprise_data-10.7.2.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (75.6.0)
+Generator: setuptools (75.8.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__ = "10.7.0"
+__version__ = "10.7.2"

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 = [

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

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)

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):

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')],
+            },
+        ),
+    ]

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.
 

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):

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.