openedx-webhooks 22.0.0__py3-none-any.whl

openedx_webhooks/migrations/0001_initial.py

@@ -0,0 +1,30 @@
+# Generated by Django 3.2.19 on 2023-06-01 14:16
+
+from django.db import migrations, models
+import django.utils.timezone
+import model_utils.fields
+
+
+class Migration(migrations.Migration):
+
+    initial = True
+
+    dependencies = [
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name='Webhook',
+            fields=[
+                ('id', models.AutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
+                ('created', model_utils.fields.AutoCreatedField(default=django.utils.timezone.now, editable=False, verbose_name='created')),
+                ('modified', model_utils.fields.AutoLastModifiedField(default=django.utils.timezone.now, editable=False, verbose_name='modified')),
+                ('event', models.CharField(choices=[('STUDENT_REGISTRATION_COMPLETED', 'Student registration completed'), ('SESSION_LOGIN_COMPLETED', 'Session login completed'), ('COURSE_ENROLLMENT_CREATED', 'Course enrollment created'), ('COURSE_ENROLLMENT_CHANGED', 'Course enrollment changed'), ('COURSE_UNENROLLMENT_COMPLETED', 'Course unenrollment completed'), ('CERTIFICATE_CREATED', 'Certificate created'), ('CERTIFICATE_CHANGED', 'Certificate changed'), ('CERTIFICATE_REVOKED', 'Certificate revoked'), ('COHORT_MEMBERSHIP_CHANGED', 'Cohort membership changed'), ('COURSE_DISCUSSIONS_CHANGED', 'Course discussions changed')], default='', help_text='Event type', max_length=50)),
+                ('webhook_url', models.URLField(help_text='URL to call when the event is triggered', max_length=255)),
+                ('enabled', models.BooleanField(default=True, verbose_name='Enabled')),
+            ],
+            options={
+                'abstract': False,
+            },
+        ),
+    ]

openedx_webhooks/migrations/0002_webfilter.py

@@ -0,0 +1,37 @@
+# Generated by Django 3.2.19 on 2023-06-07 10:39
+
+from django.db import migrations, models
+import django.utils.timezone
+import model_utils.fields
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('openedx_webhooks', '0001_initial'),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name='Webfilter',
+            fields=[
+                ('id', models.AutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
+                ('created', model_utils.fields.AutoCreatedField(default=django.utils.timezone.now, editable=False, verbose_name='created')),
+                ('modified', model_utils.fields.AutoLastModifiedField(default=django.utils.timezone.now, editable=False, verbose_name='modified')),
+                ('description', models.TextField(blank=True, default='', help_text='Description')),
+                ('event', models.CharField(choices=[('StudentRegistrationRequested', 'Student Registration Requested'), ('StudentLoginRequested', 'Student Login Requested'), ('CourseEnrollmentStarted', 'Course Enrollment Started'), ('CourseUnenrollmentStarted', 'Course Unenrollment Started'), ('CertificateCreationRequested', 'Certificate Creation Requested'), ('CertificateRenderStarted', 'Certificate Render Started'), ('CohortChangeRequested', 'Cohort Change Requested'), ('CohortAssignmentRequested', 'Cohort Assignment Requested'), ('Course_aboutRenderStarted', 'Course_about Render Started'), ('DashboardRenderStarted', 'Dashboard Render Started'), ('Veritical_block_childRenderStarted', 'Veritical_block_child Render Started'), ('Veritical_blockRenderCompleted', 'Veritical_block Render Completed')], default='', help_text='Event type', max_length=50)),
+                ('webhook_url', models.URLField(help_text='URL to call when the event is triggered', max_length=255)),
+                ('enabled', models.BooleanField(default=True, verbose_name='Enabled')),
+                ('disable_halt', models.BooleanField(default=False, help_text="Don't stop the process.", verbose_name='Disable halting')),
+                ('halt_on_4xx', models.BooleanField(default=False, help_text='Halt the process if the server returns a status response of 4xx (client error).', verbose_name='Halt on 4xx')),
+                ('redirect_on_4xx', models.URLField(blank=True, help_text='URL to redirect on result code 4xx (client error)', max_length=255)),
+                ('halt_on_5xx', models.BooleanField(default=False, help_text='Halt the process if the server returns a status response of 5xx (server error).', verbose_name='Halt on 4xx')),
+                ('redirect_on_5xx', models.URLField(blank=True, help_text='URL to redirect on result code 5XX (server error)', max_length=255)),
+                ('halt_on_request_exception', models.BooleanField(default=False, help_text="Halt the process if the server doesn't response or there is an exception sending the request.", verbose_name='Halt on request exception')),
+                ('redirect_on_request_exception', models.URLField(blank=True, help_text='URL to redirect on request exception', max_length=255)),
+            ],
+            options={
+                'abstract': False,
+            },
+        ),
+    ]

openedx_webhooks/migrations/0003_auto_20230607_1246.py

@@ -0,0 +1,23 @@
+# Generated by Django 3.2.19 on 2023-06-07 12:46
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('openedx_webhooks', '0002_webfilter'),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name='webfilter',
+            name='disable_filtering',
+            field=models.BooleanField(default=False, help_text='Do not update the data with the response of the webhook call.', verbose_name='Disable Filtering'),
+        ),
+        migrations.AlterField(
+            model_name='webfilter',
+            name='halt_on_5xx',
+            field=models.BooleanField(default=False, help_text='Halt the process if the server returns a status response of 5xx (server error).', verbose_name='Halt on 5xx'),
+        ),
+    ]

openedx_webhooks/migrations/0004_auto_20230613_1033.py

@@ -0,0 +1,28 @@
+# Generated by Django 3.2.19 on 2023-06-13 10:33
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('openedx_webhooks', '0003_auto_20230607_1246'),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name='webfilter',
+            name='use_www_form_encoding',
+            field=models.BooleanField(default=False, help_text='When enabled, data will be sent in form format, instead of JSON', verbose_name='Use WWW form encoding'),
+        ),
+        migrations.AddField(
+            model_name='webhook',
+            name='use_www_form_encoding',
+            field=models.BooleanField(default=False, help_text='When enabled, data will be sent in form format, instead of JSON', verbose_name='Use WWW form encoding'),
+        ),
+        migrations.AlterField(
+            model_name='webfilter',
+            name='disable_halt',
+            field=models.BooleanField(default=False, help_text="Don't stop the process even if the response includes exception data.", verbose_name='Disable halting'),
+        ),
+    ]

openedx_webhooks/migrations/0005_alter_webfilter_event.py

@@ -0,0 +1,18 @@
+# Generated by Django 3.2.19 on 2023-08-07 06:52
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('openedx_webhooks', '0004_auto_20230613_1033'),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name='webfilter',
+            name='event',
+            field=models.CharField(choices=[], default='', help_text='Event type', max_length=50),
+        ),
+    ]

openedx_webhooks/migrations/0006_alter_webfilter_event.py

@@ -0,0 +1,18 @@
+# Generated by Django 3.2.19 on 2023-08-08 10:16
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('openedx_webhooks', '0005_alter_webfilter_event'),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name='webfilter',
+            name='event',
+            field=models.CharField(choices=[('StudentRegistrationRequested', 'Student Registration Requested'), ('StudentLoginRequested', 'Student Login Requested'), ('CourseEnrollmentStarted', 'Course Enrollment Started'), ('CourseUnenrollmentStarted', 'Course Unenrollment Started'), ('CertificateCreationRequested', 'Certificate Creation Requested'), ('CertificateRenderStarted', 'Certificate Render Started'), ('CohortChangeRequested', 'Cohort Change Requested'), ('CohortAssignmentRequested', 'Cohort Assignment Requested'), ('CourseAboutRenderStarted', 'Course About Render Started'), ('DashboardRenderStarted', 'Dashboard Render Started'), ('VeriticalBlockChildRenderStarted', 'Veritical Block Child Render Started'), ('VeriticalBlockRenderCompleted', 'Veritical Block Render Completed')], default='', help_text='Event type', max_length=50),
+        ),
+    ]

openedx_webhooks/migrations/0007_alter_webfilter_event.py

@@ -0,0 +1,18 @@
+# Generated by Django 3.2.19 on 2023-08-15 14:14
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('openedx_webhooks', '0006_alter_webfilter_event'),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name='webfilter',
+            name='event',
+            field=models.CharField(choices=[('StudentRegistrationRequested', 'Student Registration Requested'), ('StudentLoginRequested', 'Student Login Requested'), ('CourseEnrollmentStarted', 'Course Enrollment Started'), ('CourseUnenrollmentStarted', 'Course Unenrollment Started'), ('CertificateCreationRequested', 'Certificate Creation Requested'), ('CertificateRenderStarted', 'Certificate Render Started'), ('CohortChangeRequested', 'Cohort Change Requested'), ('CohortAssignmentRequested', 'Cohort Assignment Requested'), ('CourseAboutRenderStarted', 'Course About Render Started'), ('DashboardRenderStarted', 'Dashboard Render Started')], default='', help_text='Event type', max_length=50),
+        ),
+    ]

openedx_webhooks/migrations/0008_verawood.py

@@ -0,0 +1,51 @@
+# Generated by Django 5.2.13 on 2026-09-10 03:45
+
+from django.db import migrations, models
+
+
+# These values were derived from filter_type strings instead of handler names.
+# Canonical values already in use must remain unchanged.
+EVENT_ALIASES = {
+    'StudentSettingsRenderStarted': 'AccountSettingsRenderStarted',
+    'XblockRenderStarted': 'RenderXBlockStarted',
+    'CourseHomepageUrlCreationStarted': 'CourseHomeUrlCreationStarted',
+    'HomeEnrollmentApiRendered': 'CourseEnrollmentAPIRenderStarted',
+    'HomeCourserunApiRenderedStarted': 'CourseRunAPIRenderStarted',
+    'OraSubmissionViewRenderStarted': 'ORASubmissionViewRenderStarted',
+    'IdvPageUrlRequested': 'IDVPageURLRequested',
+    'CourseAboutPageUrlRequested': 'CourseAboutPageURLRequested',
+    'ScheduleQuerysetRequested': 'ScheduleQuerySetRequested',
+    'AuthoringLmsPageUrlRequested': 'LMSPageURLRequested',
+}
+
+
+def correct_event_names(apps, schema_editor):
+    """Retain existing endpoint configuration while making its event dispatchable."""
+    webfilters = apps.get_model('openedx_webhooks', 'Webfilter')
+    for old_name, new_name in EVENT_ALIASES.items():
+        webfilters.objects.using(schema_editor.connection.alias).filter(event=old_name).update(event=new_name)
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('openedx_webhooks', '0007_alter_webfilter_event'),
+    ]
+
+    operations = [
+        migrations.RunPython(correct_event_names, migrations.RunPython.noop),
+        migrations.AlterModelOptions(
+            name='webfilter',
+            options={'ordering': ['pk']},
+        ),
+        migrations.AlterField(
+            model_name='webfilter',
+            name='event',
+            field=models.CharField(choices=[('StudentLoginRequested', 'Student Login Requested'), ('StudentRegistrationRequested', 'Student Registration Requested'), ('AccountSettingsRenderStarted', 'Account Settings Render Started'), ('CourseEnrollmentStarted', 'Course Enrollment Started'), ('CourseUnenrollmentStarted', 'Course Unenrollment Started'), ('CertificateCreationRequested', 'Certificate Creation Requested'), ('CertificateRenderStarted', 'Certificate Render Started'), ('CohortChangeRequested', 'Cohort Change Requested'), ('CohortAssignmentRequested', 'Cohort Assignment Requested'), ('CourseAboutRenderStarted', 'Course About Render Started'), ('DashboardRenderStarted', 'Dashboard Render Started'), ('VerticalBlockChildRenderStarted', 'Vertical Block Child Render Started'), ('CourseEnrollmentQuerysetRequested', 'Course Enrollment Queryset Requested'), ('RenderXBlockStarted', 'Render X Block Started'), ('VerticalBlockRenderCompleted', 'Vertical Block Render Completed'), ('CourseHomeUrlCreationStarted', 'Course Home Url Creation Started'), ('CourseEnrollmentAPIRenderStarted', 'Course Enrollment API Render Started'), ('CourseRunAPIRenderStarted', 'Course Run API Render Started'), ('InstructorDashboardRenderStarted', 'Instructor Dashboard Render Started'), ('ORASubmissionViewRenderStarted', 'ORA Submission View Render Started'), ('IDVPageURLRequested', 'IDV Page URL Requested'), ('CourseAboutPageURLRequested', 'Course About Page URL Requested'), ('ScheduleQuerySetRequested', 'Schedule Query Set Requested'), ('LMSPageURLRequested', 'LMS Page URL Requested'), ('InstructorDashboardTabsRequested', 'Instructor Dashboard Tabs Requested'), ('AccountSettingsReadOnlyFieldsRequested', 'Account Settings Read Only Fields Requested'), ('GradeEventContextRequested', 'Grade Event Context Requested')], default='', help_text='Event type', max_length=50),
+        ),
+        migrations.AlterField(
+            model_name='webhook',
+            name='event',
+            field=models.CharField(choices=[('ROLE_ASSIGNMENT_CREATED', 'Role assignment created'), ('ROLE_ASSIGNMENT_DELETED', 'Role assignment deleted'), ('COURSE_CATALOG_INFO_CHANGED', 'Course catalog info changed'), ('XBLOCK_CREATED', 'Xblock created'), ('XBLOCK_UPDATED', 'Xblock updated'), ('XBLOCK_PUBLISHED', 'Xblock published'), ('XBLOCK_DELETED', 'Xblock deleted'), ('XBLOCK_DUPLICATED', 'Xblock duplicated'), ('COURSE_CERTIFICATE_CONFIG_CHANGED', 'Course certificate config changed'), ('COURSE_CERTIFICATE_CONFIG_DELETED', 'Course certificate config deleted'), ('COURSE_CREATED', 'Course created'), ('CONTENT_LIBRARY_CREATED', 'Content library created'), ('CONTENT_LIBRARY_UPDATED', 'Content library updated'), ('CONTENT_LIBRARY_DELETED', 'Content library deleted'), ('LIBRARY_BLOCK_CREATED', 'Library block created'), ('LIBRARY_BLOCK_UPDATED', 'Library block updated'), ('LIBRARY_BLOCK_DELETED', 'Library block deleted'), ('LIBRARY_BLOCK_PUBLISHED', 'Library block published'), ('CONTENT_OBJECT_TAGS_CHANGED', 'Content object tags changed'), ('CONTENT_OBJECT_ASSOCIATIONS_CHANGED', 'Content object associations changed'), ('LIBRARY_COLLECTION_CREATED', 'Library collection created'), ('LIBRARY_COLLECTION_UPDATED', 'Library collection updated'), ('LIBRARY_COLLECTION_DELETED', 'Library collection deleted'), ('LIBRARY_CONTAINER_CREATED', 'Library container created'), ('LIBRARY_CONTAINER_UPDATED', 'Library container updated'), ('LIBRARY_CONTAINER_DELETED', 'Library container deleted'), ('LIBRARY_CONTAINER_PUBLISHED', 'Library container published'), ('COURSE_IMPORT_COMPLETED', 'Course import completed'), ('COURSE_RERUN_COMPLETED', 'Course rerun completed'), ('STUDENT_REGISTRATION_COMPLETED', 'Student registration completed'), ('SESSION_LOGIN_COMPLETED', 'Session login completed'), ('COURSE_ENROLLMENT_CREATED', 'Course enrollment created'), ('COURSE_ENROLLMENT_CHANGED', 'Course enrollment changed'), ('COURSE_UNENROLLMENT_COMPLETED', 'Course unenrollment completed'), ('CERTIFICATE_CREATED', 'Certificate created'), ('CERTIFICATE_CHANGED', 'Certificate changed'), ('CERTIFICATE_REVOKED', 'Certificate revoked'), ('COHORT_MEMBERSHIP_CHANGED', 'Cohort membership changed'), ('COURSE_DISCUSSIONS_CHANGED', 'Course discussions changed'), ('PROGRAM_CERTIFICATE_REVOKED', 'Program certificate revoked'), ('PROGRAM_CERTIFICATE_AWARDED', 'Program certificate awarded'), ('PERSISTENT_GRADE_SUMMARY_CHANGED', 'Persistent grade summary changed'), ('XBLOCK_SKILL_VERIFIED', 'Xblock skill verified'), ('USER_NOTIFICATION_REQUESTED', 'User notification requested'), ('EXAM_ATTEMPT_SUBMITTED', 'Exam attempt submitted'), ('EXAM_ATTEMPT_REJECTED', 'Exam attempt rejected'), ('EXAM_ATTEMPT_VERIFIED', 'Exam attempt verified'), ('EXAM_ATTEMPT_ERRORED', 'Exam attempt errored'), ('EXAM_ATTEMPT_RESET', 'Exam attempt reset'), ('COURSE_ACCESS_ROLE_ADDED', 'Course access role added'), ('COURSE_ACCESS_ROLE_REMOVED', 'Course access role removed'), ('FORUM_THREAD_CREATED', 'Forum thread created'), ('FORUM_THREAD_RESPONSE_CREATED', 'Forum thread response created'), ('FORUM_RESPONSE_COMMENT_CREATED', 'Forum response comment created'), ('COURSE_NOTIFICATION_REQUESTED', 'Course notification requested'), ('ORA_SUBMISSION_CREATED', 'Ora submission created'), ('COURSE_PASSING_STATUS_UPDATED', 'Course passing status updated'), ('CCX_COURSE_PASSING_STATUS_UPDATED', 'Ccx course passing status updated'), ('BADGE_AWARDED', 'Badge awarded'), ('BADGE_REVOKED', 'Badge revoked'), ('IDV_ATTEMPT_CREATED', 'Idv attempt created'), ('IDV_ATTEMPT_PENDING', 'Idv attempt pending'), ('IDV_ATTEMPT_APPROVED', 'Idv attempt approved'), ('IDV_ATTEMPT_DENIED', 'Idv attempt denied'), ('EXTERNAL_GRADER_SCORE_SUBMITTED', 'External grader score submitted'), ('LTI_PROVIDER_LAUNCH_SUCCESS', 'Lti provider launch success')], default='', help_text='Event type', max_length=50),
+        ),
+    ]

openedx_webhooks/models.py

@@ -0,0 +1,185 @@
+"""
+Models for Webhooks.
+
+written by:     Andrés González
+                https://aulasneo.com
+
+date:           May 2023
+
+usage:          Django models for Open edX signals webhooks
+"""
+
+import re
+from types import SimpleNamespace
+
+from django.db import models
+from django.utils.translation import gettext_lazy as _
+from model_utils.models import TimeStampedModel
+
+from .apps import signals
+from .settings.common import plugin_settings
+
+# From https://github.com/openedx/edx-platform/blob/master/docs/guides/hooks/filters.rst#index-of-filters
+fake_settings = SimpleNamespace(OPEN_EDX_FILTERS_CONFIG={})
+
+plugin_settings(fake_settings)
+
+filters = fake_settings.OPEN_EDX_FILTERS_CONFIG
+
+
+class Webhook(TimeStampedModel):
+    """
+    Configuration model to set the webhook url for each event.
+
+    .. no_pii:
+    """
+
+    signal_list = []
+    for signal_app, signal_app_list in signals.items():
+        signal_list += signal_app_list
+
+    # Create a set of pairs like ("COURSE_ENROLLMENT_CREATED", "Course enrollment created")...
+    event_list = [
+        (signal,
+         signal.capitalize().replace("_", " ")) for signal in signal_list
+    ]
+
+    event = models.CharField(
+        max_length=50,
+        blank=False,
+        primary_key=False,
+        choices=event_list,
+        default='',
+        unique=False,
+        help_text=_("Event type"),
+    )
+
+    webhook_url = models.URLField(
+        max_length=255,
+        blank=False,
+        help_text=_("URL to call when the event is triggered")
+    )
+
+    enabled = models.BooleanField(
+        default=True,
+        verbose_name=_("Enabled")
+    )
+
+    use_www_form_encoding = models.BooleanField(
+        default=False,
+        verbose_name=_("Use WWW form encoding"),
+        help_text=_("When enabled, data will be sent in form format, instead of JSON")
+    )
+
+    def __str__(self):
+        """
+        Get a string representation of this model instance.
+        """
+        return f'Webhook for {self.event} to {self.webhook_url}'
+
+
+class Webfilter(TimeStampedModel):
+    """
+    Configuration model to set the filter url for each event.
+
+    .. no_pii:
+    """
+
+    class Meta:
+        """Apply multiple configured filters in a deterministic order."""
+
+        ordering = ['pk']
+
+    # Persist the handler's exact event name, including acronyms and word order.
+    filter_list = [
+        (name, re.sub(r'(?<=[a-z])(?=[A-Z])|(?<=[A-Z])(?=[A-Z][a-z])', ' ', name))
+        for config in filters.values()
+        for name in [config['pipeline'][0].rsplit('.', 1)[1].removesuffix('WebFilter')]
+    ]
+
+    description = models.TextField(
+        help_text="Description",
+        blank=True,
+        default='',
+    )
+
+    event = models.CharField(
+        max_length=50,
+        blank=False,
+        primary_key=False,
+        choices=filter_list,
+        default='',
+        unique=False,
+        help_text=_("Event type"),
+    )
+
+    webhook_url = models.URLField(
+        max_length=255,
+        blank=False,
+        help_text=_("URL to call when the event is triggered")
+    )
+
+    enabled = models.BooleanField(
+        default=True,
+        verbose_name=_("Enabled")
+    )
+
+    disable_filtering = models.BooleanField(
+        default=False,
+        verbose_name=_("Disable Filtering"),
+        help_text=_("Do not update the data with the response of the webhook call.")
+    )
+
+    disable_halt = models.BooleanField(
+        default=False,
+        verbose_name=_("Disable halting"),
+        help_text=_("Don't stop the process even if the response includes exception data.")
+    )
+
+    halt_on_4xx = models.BooleanField(
+        default=False,
+        verbose_name=_("Halt on 4xx"),
+        help_text=_("Halt the process if the server returns a status response of 4xx (client error).")
+    )
+
+    redirect_on_4xx = models.URLField(
+        max_length=255,
+        blank=True,
+        help_text=_("URL to redirect on result code 4xx (client error)")
+    )
+
+    halt_on_5xx = models.BooleanField(
+        default=False,
+        verbose_name=_("Halt on 5xx"),
+        help_text=_("Halt the process if the server returns a status response of 5xx (server error).")
+    )
+
+    redirect_on_5xx = models.URLField(
+        max_length=255,
+        blank=True,
+        help_text=_("URL to redirect on result code 5XX (server error)")
+    )
+
+    halt_on_request_exception = models.BooleanField(
+        default=False,
+        verbose_name=_("Halt on request exception"),
+        help_text=_("Halt the process if the server doesn't response or there is an exception sending the request.")
+    )
+
+    redirect_on_request_exception = models.URLField(
+        max_length=255,
+        blank=True,
+        help_text=_("URL to redirect on request exception")
+    )
+
+    use_www_form_encoding = models.BooleanField(
+        default=False,
+        verbose_name=_("Use WWW form encoding"),
+        help_text=_("When enabled, data will be sent in form format, instead of JSON")
+    )
+
+    def __str__(self):
+        """
+        Get a string representation of this model instance.
+        """
+        return f'Webhook filter for {self.event} to {self.webhook_url}'