openedx-webhooks 22.0.0__py3-none-any.whl

openedx_webhooks/__init__.py

@@ -0,0 +1,7 @@
+"""
+Webhooks for Open edX.
+"""
+
+__version__ = '22.0.0'
+
+default_app_config = 'openedx_webhooks.apps.WebhooksConfig'  # pylint: disable=invalid-name

openedx_webhooks/admin.py

@@ -0,0 +1,40 @@
+# coding=utf-8
+"""
+Admin settings for webhooks.
+
+written by:     Andrés González
+                https://aulasneo.com
+
+date:           May 2023
+
+usage:          register the custom Django models in LMS Django Admin
+"""
+import logging
+
+from django.contrib import admin
+
+from .models import Webfilter, Webhook
+
+logger = logging.getLogger(__name__)
+
+
+class WebhooksAdmin(admin.ModelAdmin):
+    list_display = [f.name for f in Webhook._meta.get_fields()]
+
+
+class WebfilterAdmin(admin.ModelAdmin):
+    list_display = [
+        'event',
+        'webhook_url',
+        'enabled',
+        'disable_halt',
+        'disable_filtering',
+        'halt_on_4xx',
+        'halt_on_5xx',
+        'halt_on_request_exception',
+    ]
+
+
+logger.debug("Registering Webhook")
+admin.site.register(Webhook, WebhooksAdmin)
+admin.site.register(Webfilter, WebfilterAdmin)

openedx_webhooks/apps.py

@@ -0,0 +1,130 @@
+"""
+openedx_webhooks Django application initialization.
+"""
+import logging
+
+from django.apps import AppConfig
+
+# Declare all signals
+signals = {
+    "authz": [
+        "ROLE_ASSIGNMENT_CREATED",
+        "ROLE_ASSIGNMENT_DELETED",
+    ],
+    "content_authoring": [
+        "COURSE_CATALOG_INFO_CHANGED",
+        "XBLOCK_CREATED",
+        "XBLOCK_UPDATED",
+        "XBLOCK_PUBLISHED",
+        "XBLOCK_DELETED",
+        "XBLOCK_DUPLICATED",
+        "COURSE_CERTIFICATE_CONFIG_CHANGED",
+        "COURSE_CERTIFICATE_CONFIG_DELETED",
+        "COURSE_CREATED",
+        "CONTENT_LIBRARY_CREATED",
+        "CONTENT_LIBRARY_UPDATED",
+        "CONTENT_LIBRARY_DELETED",
+        "LIBRARY_BLOCK_CREATED",
+        "LIBRARY_BLOCK_UPDATED",
+        "LIBRARY_BLOCK_DELETED",
+        "LIBRARY_BLOCK_PUBLISHED",
+        "CONTENT_OBJECT_TAGS_CHANGED",
+        "CONTENT_OBJECT_ASSOCIATIONS_CHANGED",
+        "LIBRARY_COLLECTION_CREATED",
+        "LIBRARY_COLLECTION_UPDATED",
+        "LIBRARY_COLLECTION_DELETED",
+        "LIBRARY_CONTAINER_CREATED",
+        "LIBRARY_CONTAINER_UPDATED",
+        "LIBRARY_CONTAINER_DELETED",
+        "LIBRARY_CONTAINER_PUBLISHED",
+        "COURSE_IMPORT_COMPLETED",
+        "COURSE_RERUN_COMPLETED",
+    ],
+    "learning": [
+        "STUDENT_REGISTRATION_COMPLETED",
+        "SESSION_LOGIN_COMPLETED",
+        "COURSE_ENROLLMENT_CREATED",
+        "COURSE_ENROLLMENT_CHANGED",
+        "COURSE_UNENROLLMENT_COMPLETED",
+        "CERTIFICATE_CREATED",
+        "CERTIFICATE_CHANGED",
+        "CERTIFICATE_REVOKED",
+        "COHORT_MEMBERSHIP_CHANGED",
+        "COURSE_DISCUSSIONS_CHANGED",
+        "PROGRAM_CERTIFICATE_REVOKED",
+        "PROGRAM_CERTIFICATE_AWARDED",
+        "PERSISTENT_GRADE_SUMMARY_CHANGED",
+        "XBLOCK_SKILL_VERIFIED",
+        "USER_NOTIFICATION_REQUESTED",
+        "EXAM_ATTEMPT_SUBMITTED",
+        "EXAM_ATTEMPT_REJECTED",
+        "EXAM_ATTEMPT_VERIFIED",
+        "EXAM_ATTEMPT_ERRORED",
+        "EXAM_ATTEMPT_RESET",
+        "COURSE_ACCESS_ROLE_ADDED",
+        "COURSE_ACCESS_ROLE_REMOVED",
+        "FORUM_THREAD_CREATED",
+        "FORUM_THREAD_RESPONSE_CREATED",
+        "FORUM_RESPONSE_COMMENT_CREATED",
+        "COURSE_NOTIFICATION_REQUESTED",
+        "ORA_SUBMISSION_CREATED",
+        "COURSE_PASSING_STATUS_UPDATED",
+        "CCX_COURSE_PASSING_STATUS_UPDATED",
+        "BADGE_AWARDED",
+        "BADGE_REVOKED",
+        "IDV_ATTEMPT_CREATED",
+        "IDV_ATTEMPT_PENDING",
+        "IDV_ATTEMPT_APPROVED",
+        "IDV_ATTEMPT_DENIED",
+        "EXTERNAL_GRADER_SCORE_SUBMITTED",
+        "LTI_PROVIDER_LAUNCH_SUCCESS",
+    ]
+}
+
+logger = logging.getLogger(__name__)
+
+
+class WebhooksConfig(AppConfig):
+    """
+    Configuration for the webhooks Django application.
+    """
+
+    name = 'openedx_webhooks'
+
+    receivers = []
+    for signal_app, signal_list in signals.items():
+        for signal in signal_list:
+            receivers.append({
+                        "receiver_func_name": signal.lower() + "_receiver",
+                        "signal_path": f"openedx_events.{signal_app}.signals.{signal}",
+                    })
+
+    plugin_app = {
+        "settings_config": {
+            "lms.djangoapp": {
+                "common": {"relative_path": "settings.common"},
+                "test": {"relative_path": "settings.test"},
+            },
+            "cms.djangoapp": {
+                "common": {"relative_path": "settings.cms"},
+                "test": {"relative_path": "settings.cms"},
+            },
+        },
+        "signals_config": {
+            "lms.djangoapp": {
+                "relative_path": "receivers",
+                "receivers": receivers,
+            },
+            "cms.djangoapp": {
+                "relative_path": "receivers",
+                "receivers": [
+                    receiver for receiver in receivers
+                    if receiver["signal_path"].startswith((
+                        "openedx_events.content_authoring.", "openedx_events.authz.",
+                    ))
+                ],
+            },
+        },
+    }
+
+    logger.info("Open edX Webhooks: signals registered")