feat: Added blackboard channel integration

channel_integrations/blackboard/__init__.py

@@ -0,0 +1,5 @@
+"""
+The Blackboard Integrated Channel package.
+"""
+
+__version__ = "0.0.1"

channel_integrations/blackboard/admin/__init__.py

@@ -0,0 +1,146 @@
+"""
+Admin integration for configuring Blackboard app to communicate with Blackboard systems.
+"""
+from config_models.admin import ConfigurationModelAdmin
+from django_object_actions import DjangoObjectActions
+
+from django.contrib import admin, messages
+from django.core.exceptions import ValidationError
+from django.http import HttpResponseRedirect
+from django.utils.html import format_html
+
+from channel_integrations.blackboard.models import (
+    BlackboardEnterpriseCustomerConfiguration,
+    BlackboardGlobalConfiguration,
+    BlackboardLearnerDataTransmissionAudit,
+)
+from channel_integrations.integrated_channel.admin import BaseLearnerDataTransmissionAuditAdmin
+
+
+@admin.register(BlackboardGlobalConfiguration)
+class BlackboardGlobalConfigurationAdmin(ConfigurationModelAdmin):
+    """
+    Django admin model for BlackboardGlobalConfiguration.
+    """
+    list_display = (
+        "app_key",
+        "app_secret",
+    )
+
+    class Meta:
+        model = BlackboardGlobalConfiguration
+
+
+@admin.register(BlackboardEnterpriseCustomerConfiguration)
+class BlackboardEnterpriseCustomerConfigurationAdmin(DjangoObjectActions, admin.ModelAdmin):
+    """
+    Django admin model for BlackEnterpriseCustomerConfiguration.
+    """
+    list_display = (
+        "enterprise_customer_name",
+        "blackboard_base_url",
+    )
+
+    readonly_fields = (
+        "enterprise_customer_name",
+        "refresh_token",
+        "customer_oauth_authorization_url",
+        "uuid",
+        "transmission_chunk_size",
+    )
+
+    raw_id_fields = (
+        "enterprise_customer",
+    )
+
+    search_fields = ("enterprise_customer_name",)
+    change_actions = ("force_content_metadata_transmission",)
+
+    class Meta:
+        model = BlackboardEnterpriseCustomerConfiguration
+
+    def enterprise_customer_name(self, obj):
+        """
+        Returns: the name for the attached EnterpriseCustomer.
+
+        Args:
+            obj: The instance of BlackboardEnterpriseCustomerConfiguration
+                being rendered with this admin form.
+        """
+        return obj.enterprise_customer.name
+
+    def customer_oauth_authorization_url(self, obj):
+        """
+        Returns: an html formatted oauth authorization link when the blackboard_base_url and client_id are available.
+
+        Args:
+            obj: The instance of BlackboardEnterpriseCustomerConfiguration
+                being rendered with this admin form.
+        """
+        if obj.oauth_authorization_url:
+            return format_html((f'<a href="{obj.oauth_authorization_url}">Authorize Link</a>'))
+        else:
+            return None
+
+    @admin.action(
+        description="Force content metadata transmission for this Enterprise Customer"
+    )
+    def force_content_metadata_transmission(self, request, obj):
+        """
+        Updates the modified time of the customer record to retransmit courses metadata
+        and redirects to configuration view with success or error message.
+        """
+        try:
+            obj.enterprise_customer.save()
+            messages.success(
+                request,
+                f'''The blackboard enterprise customer content metadata
+                “<BlackboardEnterpriseCustomerConfiguration for Enterprise
+                {obj.enterprise_customer.name}>” was updated successfully.''',
+            )
+        except ValidationError:
+            messages.error(
+                request,
+                f'''The blackboard enterprise customer content metadata
+                “<BlackboardEnterpriseCustomerConfiguration for Enterprise
+                {obj.enterprise_customer.name}>” was not updated successfully.''',
+            )
+        return HttpResponseRedirect(
+            "/admin/blackboard/blackboardenterprisecustomerconfiguration"
+        )
+    force_content_metadata_transmission.label = "Force content metadata transmission"
+
+
+@admin.register(BlackboardLearnerDataTransmissionAudit)
+class BlackboardLearnerDataTransmissionAuditAdmin(BaseLearnerDataTransmissionAuditAdmin):
+    """
+    Django admin model for BlackboardLearnerDataTransmissionAudit.
+    """
+    list_display = (
+        "enterprise_course_enrollment_id",
+        "course_id",
+        "status",
+        "modified",
+    )
+
+    readonly_fields = (
+        "blackboard_user_email",
+        "progress_status",
+        "content_title",
+        "enterprise_customer_name",
+        "friendly_status_message",
+        "api_record",
+    )
+
+    search_fields = (
+        "blackboard_user_email",
+        "enterprise_course_enrollment_id",
+        "course_id",
+        "content_title",
+        "friendly_status_message"
+    )
+
+    list_per_page = 1000
+
+    class Meta:
+        model = BlackboardLearnerDataTransmissionAudit

channel_integrations/blackboard/apps.py

@@ -0,0 +1,20 @@
+"""
+Enterprise Integrated Channel Blackboard Django application initialization.
+"""
+
+from django.apps import AppConfig
+
+CHANNEL_NAME = 'channel_integrations.blackboard'
+VERBOSE_NAME = 'Enterprise Blackboard Integration'
+BRIEF_CHANNEL_NAME = 'blackboard'
+
+
+class BlackboardConfig(AppConfig):
+    """
+    Configuration for the Enterprise Integrated Channel Blackboard Django application.
+    """
+    name = CHANNEL_NAME
+    verbose_name = VERBOSE_NAME
+    oauth_token_auth_path = "learn/api/public/v1/oauth2/token"
+    brief_channel_name = BRIEF_CHANNEL_NAME
+    label = 'blackboard_channel'