From f95e4947aff6f63a4240a135fb0f82446bf9291f Mon Sep 17 00:00:00 2001 From: Juan David Buitrago Date: Wed, 16 Nov 2022 07:08:17 -0500 Subject: [PATCH] feat: filter user's course enrollment by microsite request --- eox_tenant/filters/pipeline.py | 29 +++++++++++++++++++++++++++++ 1 file changed, 29 insertions(+) create mode 100644 eox_tenant/filters/pipeline.py diff --git a/eox_tenant/filters/pipeline.py b/eox_tenant/filters/pipeline.py new file mode 100644 index 00000000..34f5c315 --- /dev/null +++ b/eox_tenant/filters/pipeline.py @@ -0,0 +1,29 @@ +""" +The pipeline module defines custom Filters functions that are used in openedx-filters. +""" +from openedx_filters import PipelineStep + +from eox_tenant.tenant_aware_functions.enrollments import filter_enrollments + + +class FilterUserCourseEnrollmentsByTenant(PipelineStep): + """ + Filter enrollments list by a tenant. + """ + + def run_filter(self, context): # pylint: disable=arguments-differ + """ + Filter especific user course enrollments by tenant request. + Example Usage: + Add the following configurations to you configuration file + "OPEN_EDX_FILTERS_CONFIG": { + "org.openedx.learning.course_enrollments_site.filter.requested.v1": { + "fail_silently": false, + "pipeline": [ + "eox_tenant.filters.pipeline.FilterUserCourseEnrollmentsByTenant" + ] + } + } + """ + tenant_enrollments = filter_enrollments(context) + return {"context": tenant_enrollments}