feat: Implement IDV URL Filters

openedx_filters/learning/filters.py

@@ -779,3 +779,22 @@ def run_filter(cls, context: dict, template_name: str):
  """
  data = super().run_pipeline(context=context, template_name=template_name, )
  return data.get("context"), data.get("template_name")
+
+
+class IDVPageURLRequested(OpenEdxPublicFilter):
+ """
+ Custom class used to create filters to act on ID verification page URL requests.
+ """
+
+ filter_type = "org.openedx.learning.idv.page.url.requested.v1"
+
+ @classmethod
+ def run_filter(cls, url: str):
+ """
+ Execute a filter with the specified signature.
+
+ Arguments:
+ url (str): The url for the ID verification page to be modified.
+ """
+ data = super().run_pipeline(url=url)
+ return data.get("url")

openedx_filters/learning/tests/test_filters.py

@@ -20,6 +20,7 @@
  CourseRunAPIRenderStarted,
  CourseUnenrollmentStarted,
  DashboardRenderStarted,
+ IDVPageURLRequested,
  InstructorDashboardRenderStarted,
  ORASubmissionViewRenderStarted,
  RenderXBlockStarted,
@@ -728,3 +729,26 @@ def test_course_run_api_render_started(self):
  result = CourseRunAPIRenderStarted.run_filter(serialized_courserun)
 
  self.assertEqual(serialized_courserun, result)
+
+
+class TestIDVFilters(TestCase):
+ """
+ Test class to verify standard behavior of the ID verification filters.
+ You'll find test suites for:
+
+ - IDVPageURLRequested
+ """
+
+ def test_idv_page_url_requested(self):
+ """
+ Test IDVPageURLRequested filter behavior under normal conditions.
+
+ Expected behavior:
+ - The filter must have the signature specified.
+ - The filter should return the url.
+ """
+ url = Mock()
+
+ result = IDVPageURLRequested.run_filter(url)
+
+ self.assertEqual(url, result)