Add API key for B2B data (#2660)

Author: jkachel

b2b/management/commands/b2b_list.py

@@ -2,7 +2,7 @@
 
 import logging
 
-from django.core.management import BaseCommand
+from django.core.management import BaseCommand, CommandError
 from rich.console import Console
 from rich.table import Table
 
@@ -68,6 +68,24 @@ def add_arguments(self, parser):
             dest="contract_id",
         )
 
+        learners_parser = subparsers.add_parser(
+            "learners",
+            help="List learners associated with an org or contract.",
+        )
+        learners_parser.add_argument(
+            "--org",
+            "--organization",
+            type=int,
+            help="Filter by organization ID.",
+            dest="organization_id",
+        )
+        learners_parser.add_argument(
+            "--contract",
+            type=int,
+            help="Filter by contract ID.",
+            dest="contract_id",
+        )
+
         return super().add_arguments(parser)
 
     def handle_list_orgs(self, *args, **kwargs):  # noqa: ARG002
@@ -180,6 +198,33 @@ def handle_list_courseware(self, *args, **kwargs):  # noqa: ARG002
 
         self.console.print(courseware_table)
 
+    def handle_list_learners(self, *args, **kwargs):  # noqa: ARG002
+        """List learners associated with an org or contract."""
+
+        org_id = kwargs.pop("organization_id")
+        contract_id = kwargs.pop("contract_id")
+
+        if org_id:
+            obj = OrganizationPage.objects.get(id=org_id)
+        elif contract_id:
+            obj = ContractPage.objects.get(id=contract_id)
+        else:
+            msg = "Must provide either org or contract ID."
+            raise CommandError(msg)
+
+        learners = obj.get_learners()
+
+        learners_table = Table(title=f"Learners for {obj}")
+        learners_table.add_column("Email", justify="right")
+        learners_table.add_column("Name", justify="left")
+
+        for learner in learners:
+            learners_table.add_row(
+                learner.email,
+                f"{learner.first_name} {learner.last_name}",
+            )
+        self.console.print(learners_table)
+
     def handle(self, *args, **kwargs):  # noqa: ARG002
         """Handle the command."""
         self.console = Console()
@@ -190,7 +235,10 @@ def handle(self, *args, **kwargs):  # noqa: ARG002
             self.handle_list_contracts(**kwargs)
         elif subcommand == "courseware":
             self.handle_list_courseware(**kwargs)
+        elif subcommand == "learners":
+            self.handle_list_learners(**kwargs)
         else:
-            log.error("Unknown subcommand: %s", subcommand)
-            return 1
+            msg = f"Unknown subcommand: {subcommand}"
+            raise CommandError(msg)
+
         return 0

b2b/models.py

@@ -1,5 +1,6 @@
 """Models for B2B data."""
 
+from django.contrib.auth import get_user_model
 from django.db import models
 from django.http import Http404
 from django.utils.text import slugify
@@ -79,6 +80,17 @@ def save(self, clean=True, user=None, log_action=False, **kwargs):  # noqa: FBT0
         self.slug = slugify(f"org-{self.name}")
         Page.save(self, clean=clean, user=user, log_action=log_action, **kwargs)
 
+    def get_learners(self):
+        """Get the learners associated with this organization."""
+
+        return (
+            get_user_model()
+            .objects.filter(
+                b2b_contracts__organization=self,
+            )
+            .distinct()
+        )
+
 
 class ContractPage(Page):
     """Stores information about a contract with an organization."""
@@ -150,3 +162,14 @@ def save(self, clean=True, user=None, log_action=False, **kwargs):  # noqa: FBT0
 
         self.slug = slugify(f"contract-{self.organization.id}-{self.id}")
         Page.save(self, clean=clean, user=user, log_action=log_action, **kwargs)
+
+    def get_learners(self):
+        """Get the learners associated with this organization."""
+
+        return (
+            get_user_model()
+            .objects.filter(
+                b2b_contracts=self,
+            )
+            .distinct()
+        )

b2b/views/v0/__init__.py

@@ -2,6 +2,7 @@
 
 from rest_framework import viewsets
 from rest_framework.permissions import IsAdminUser
+from rest_framework_api_key.permissions import HasAPIKey
 
 from b2b.models import ContractPage, OrganizationPage
 from b2b.serializers.v0 import ContractPageSerializer, OrganizationPageSerializer
@@ -14,7 +15,7 @@ class OrganizationPageViewSet(viewsets.ReadOnlyModelViewSet):
 
     queryset = OrganizationPage.objects.all()
     serializer_class = OrganizationPageSerializer
-    permission_classes = [IsAdminUser]
+    permission_classes = [IsAdminUser | HasAPIKey]
     lookup_field = "slug"
     lookup_url_kwarg = "organization_slug"
 
@@ -26,6 +27,6 @@ class ContractPageViewSet(viewsets.ReadOnlyModelViewSet):
 
     queryset = ContractPage.objects.all()
     serializer_class = ContractPageSerializer
-    permission_classes = [IsAdminUser]
+    permission_classes = [IsAdminUser | HasAPIKey]
     lookup_field = "slug"
     lookup_url_kwarg = "contract_slug"

main/settings.py

@@ -228,6 +228,7 @@
     "health_check.contrib.celery_ping",
     "health_check.contrib.redis",
     "health_check.contrib.db_heartbeat",
+    "rest_framework_api_key",
 )
 # Only include the seed data app if this isn't running in prod
 # if ENVIRONMENT not in ("production", "prod"):

poetry.lock

@@ -83,6 +83,7 @@ uwsgi = "^2.0.19"
 uwsgitop = "^0.12"
 wagtail = "6.3"
 wagtail-metadata = "^5.0.0"
+djangorestframework-api-key = "^3.1.0"
 
 
 [tool.poetry.group.dev.dependencies]

pyproject.toml

@@ -18,6 +18,7 @@
 
 from b2b.models import OrganizationPage
 from cms.constants import CMS_EDITORS_GROUP_NAME
+from openedx.constants import OPENEDX_USERNAME_MAX_LEN
 from openedx.models import OpenEdxUser
 
 MALE = "m"
@@ -171,7 +172,9 @@ def _post_create_user(user, username):
     """
     LegalAddress.objects.create(user=user)
     UserProfile.objects.create(user=user)
-    OpenEdxUser.objects.create(user=user, edx_username=username)
+    OpenEdxUser.objects.create(
+        user=user, edx_username=username[:OPENEDX_USERNAME_MAX_LEN]
+    )
 
 
 class UserManager(BaseUserManager):