Add logout functionalit

Annybell Villarroel · Annybell Villarroel · commit ce1779ace30c · 2017-06-05T17:35:13.000+02:00
diff --git a/auth0/v3/authentication/logout.py b/auth0/v3/authentication/logout.py
@@ -0,0 +1,37 @@
+from .base import AuthenticationBase
+
+
+class Logout(AuthenticationBase):
+
+    """Logout Endpoint
+
+    Args:
+        domain (str): Your auth0 domain (e.g: username.auth0.com)
+    """
+
+    def __init__(self, domain):
+        self.domain = domain
+
+    def logout(self, client_id, return_to, federated=False):
+        """Logout
+
+        Use this endpoint to logout a user. If you want to navigate the user to a
+        specific URL after the logout, set that URL at the returnTo parameter.
+        The URL should be included in any the appropriate Allowed Logout URLs list:
+
+        Args:
+            client_id (str): The client_id of your client.
+
+            returnTo (str): URL to redirect the user after the logout.
+
+            federated (bool): Querystring parameter to log the user out of the IdP
+        """
+        if federated is True:
+            return self.get(
+                'https://%s/v2/logout?federated&%s&%s' % (self.domain, client_id, return_to),
+                headers={'Content-Type': 'application/json'}
+            )
+        return self.get(
+            'https://%s/v2/logout?%s&%s' % (self.domain, client_id, return_to),
+            headers={'Content-Type': 'application/json'}
+        )
diff --git a/auth0/v3/test/authentication/test_logout.py b/auth0/v3/test/authentication/test_logout.py
@@ -0,0 +1,37 @@
+import unittest
+import mock
+from ...authentication.logout import Logout
+
+
+class TestLogout(unittest.TestCase):
+
+    @mock.patch('auth0.v3.authentication.logout.Logout.get')
+    def test_logout(self, mock_get):
+
+        g = Logout('my.domain.com')
+
+        g.logout(client_id='cid',
+                 return_to='rto')
+
+        args, kwargs = mock_get.call_args
+
+        self.assertEqual(args[0], 'https://my.domain.com/v2/logout&cid&rto')
+        self.assertEqual(kwargs['headers'], {
+            'Content-Type': 'application/json'
+        })
+
+    @mock.patch('auth0.v3.authentication.logout.Logout.get')
+    def test_logout_federated(self, mock_get):
+
+        g = Logout('my.domain.com')
+
+        g.logout(client_id='cid',
+                 return_to='rto',
+                 federated=True)
+
+        args, kwargs = mock_get.call_args
+
+        self.assertEqual(args[0], 'https://my.domain.com/v2/logout?federated&cid%rto')
+        self.assertEqual(kwargs['headers'], {
+            'Content-Type': 'application/json'
+        })
