Adds before and after login view call hooks, which are useful for sys…

…tems using velruse as a plugin. It allows the plugin user to modify any information before or after the login view is called. For example, before or after the login view is hit, one could capture the referrer location so that they can send the authenticated user back to where they came from.

velruse/events.py

@@ -0,0 +1,28 @@
+# -*- coding: utf-8 -*-
+"""Custom events for identity provider login."""
+import functools
+from pyramid.events import NewRequest
+
+def with_events(before=None, after=None):
+    """Decorator to create event book ends on a method."""
+    def decorator(method):
+        @functools.wraps(method)
+        def new_method(obj, request):
+            request.registry.notify(before(request))
+            response = method(obj, request)
+            request.registry.notify(after(request))
+            return response
+        return new_method
+    return decorator
+
+
+class BeforeLogin(NewRequest):
+    """Used to tap into the request before
+    the identity provider logic is run.
+    """
+
+
+class AfterLogin(NewRequest):
+    """Used to tap into the request after
+    the identity provider logic has run.
+    """

velruse/providers/openid.py

@@ -17,6 +17,7 @@
     AuthenticationDenied,
     register_provider,
 )
+from velruse.events import with_events, AfterLogin, BeforeLogin
 from velruse.exceptions import MissingParameter
 from velruse.exceptions import ThirdPartyFailure
 
@@ -180,6 +181,7 @@ def _get_access_token(self, request_token):
 
         """
 
+    @with_events(before=BeforeLogin, after=AfterLogin)
     def login(self, request):
         log.debug('Handling OpenID login')