Merge pull request #7 from MartinPaulo/bug/6

Add a method that gives the remaining lifetime of a valid gs-token. #6

Author: nuwang

genomespaceclient/client.py

@@ -632,3 +632,31 @@ def get_metadata(self, genomespace_url):
                      r'\g<2>v1.0/filemetadata', genomespace_url)
         json_data = self._api_get_request(url)
         return GSFileMetadata.from_json(json_data)
+
+    def get_remaining_token_time(self, genomespace_url):
+        """
+        Gets the time to live for the gs-token if you have one.
+        If you don't have one, will return 0, as the non existent token has
+        no time left to live. See:
+        http://www.genomespace.org/support/api/restful-access-to-identity-server#get_token_time
+          
+        E.g. 
+        
+        client.get_remaining_token_time('https://genomespace.genome.edu.au/')
+        
+        :type genomespace_url: :class:`str`
+        :param genomespace_url: GenomeSpace URL.
+        
+        :rtype: :class:`int`
+        :return: the time the token has left to live in milliseconds.
+        """
+        if not self.token:
+            return 0
+        url_components = urlparse(genomespace_url)
+        location = '{uri.scheme}://{uri.netloc}' \
+                   '/identityServer/usermanagement/utility/token/remainingTime'
+        url = location.format(uri=url_components)
+        result = requests.get(url, cookies={"gs-token": self.token})
+        if result.status_code == requests.codes.ok:
+            return int(result.text)
+        return 0

test/helpers.py

@@ -9,6 +9,10 @@
 from genomespaceclient import GenomeSpaceClient
 from genomespaceclient import main
 
+try:
+    from urllib.parse import urlparse
+except ImportError:
+    from urlparse import urlparse
 
 def get_test_username():
     return os.environ["GENOMESPACE_USERNAME"]
@@ -27,6 +31,16 @@ def get_remote_test_folder():
     return os.environ["GENOMESPACE_TEST_FOLDER"]
 
 
+def get_genomespace_url():
+    """
+    :return: the scheme and net location of the remote test folder in the form of
+             a url. E.g. https://genomespace.genome.edu.au
+    :rtype: :class:`str`
+    """
+    url_components = urlparse(get_remote_test_folder())
+    return '{uri.scheme}://{uri.netloc}'.format(uri=url_components)
+
+
 def run_python_script(command, args):
 
     @contextlib.contextmanager

test/test_genomespace_client.py

@@ -276,3 +276,18 @@ def test_get_metadata(self):
         self.assertTrue(
             access_control_entries[0].sid.name == owner,
             "Expected sid name to be the owner")
+
+    def test_get_token_expiry(self):
+        client = helpers.get_genomespace_client()
+        genomespace_url = helpers.get_genomespace_url()
+        # no gs-token, as have not yet performed any actions
+        milliseconds_left = client.get_remaining_token_time(genomespace_url)
+        self.assertTrue(
+            milliseconds_left == 0,
+            "Expected client not yet logged in to have no token expiry time")
+        # now force a login and hence the client to get a gs-token
+        client.list(helpers.get_remote_test_folder())
+        milliseconds_left = client.get_remaining_token_time(genomespace_url)
+        self.assertTrue(
+            milliseconds_left > 0,
+            "Expected a logged in client to have a token expiry time")