Add get_destroy_other_sessions_url() method.

Author: josiah-wolf-oberholtzer

cas_client/cas_client.py

@@ -58,6 +58,26 @@ def acquire_auth_token_ticket(self):
             auth_token_ticket))
         return auth_token_ticket
 
+    def create_session(self, ticket, payload=None, expires=None):
+        '''
+        Create a session record from a service ticket.
+        '''
+        assert isinstance(self.session_storage_adapter, CASSessionAdapter)
+        logging.debug('[CAS] Creating session for ticket {}'.format(ticket))
+        self.session_storage_adapter.create(
+            ticket,
+            payload=payload,
+            expires=expires,
+            )
+
+    def delete_session(self, ticket):
+        '''
+        Delete a session record associated with a service ticket.
+        '''
+        assert isinstance(self.session_storage_adapter, CASSessionAdapter)
+        logging.debug('[CAS] Deleting session for ticket {}'.format(ticket))
+        self.session_storage_adapter.delete(ticket)
+
     def get_auth_token_login_url(
         self,
         auth_token_ticket,
@@ -94,6 +114,28 @@ def get_auth_token_login_url(
         logging.debug('[CAS] AuthToken Login URL: {}'.format(url))
         return url
 
+    def get_destroy_other_sessions_url(self, service_url=None):
+        '''
+        Get the URL for a remote CAS `destroy-other-sessions` endpoint.
+
+        ::
+
+            >>> from cas_client import CASClient
+            >>> client = CASClient('https://logmein.com')
+            >>> service_url = 'http://myservice.net'
+            >>> client.get_destroy_other_sessions_url(service_url)
+            'https://logmein.com/cas/destroy-other-sessions?service=http://myservice.net'
+
+        '''
+        template = '{server_url}{auth_prefix}/destroy-other-sessions?service={service_url}'
+        url = template.format(
+            server_url=self.server_url,
+            auth_prefix=self.auth_prefix,
+            service_url=service_url or self.service_url,
+            )
+        logging.debug('[CAS] Login URL: {}'.format(url))
+        return url
+
     def get_login_url(self, service_url=None):
         '''
         Get the URL for a remote CAS `login` endpoint.
@@ -209,26 +251,6 @@ def parse_logout_request(self, message_text):
             ))
         return result
 
-    def create_session(self, ticket, payload=None, expires=None):
-        '''
-        Create a session record from a service ticket.
-        '''
-        assert isinstance(self.session_storage_adapter, CASSessionAdapter)
-        logging.debug('[CAS] Creating session for ticket {}'.format(ticket))
-        self.session_storage_adapter.create(
-            ticket,
-            payload=payload,
-            expires=expires,
-            )
-
-    def delete_session(self, ticket):
-        '''
-        Delete a session record associated with a service ticket.
-        '''
-        assert isinstance(self.session_storage_adapter, CASSessionAdapter)
-        logging.debug('[CAS] Deleting session for ticket {}'.format(ticket))
-        self.session_storage_adapter.delete(ticket)
-
     def session_exists(self, ticket):
         '''
         Test if a session records exists for a service ticket.

test.py

@@ -83,6 +83,12 @@ def test_perform_service_validate(self):
         self.assertEqual(response.response_type, 'authenticationSuccess')
         self.assertEqual(response.user, 'jott')
 
+    def test_get_destroy_other_sessions_url(self):
+        cas_client = CASClient('dummy.url')
+        service_url = 'app.url'
+        url = cas_client.get_destroy_other_sessions_url(service_url=service_url)
+        self.assertEqual(url, 'dummy.url/cas/destroy-other-sessions?service=app.url')
+
     def test_get_login_url(self):
         cas_client = CASClient('dummy.url')
         service_url = 'app.url'