sparclclient 1.2.2b10__py2.py3-none-any.whl → 1.2.3b1__py2.py3-none-any.whl

sparcl/__init__.py

@@ -31,4 +31,5 @@ __all__ = ["client", "align_records"]
 # __version__ = "1.2.1b3"
 # __version__ = "1.2.1"
 # FIRST uncommented value will be used! (so only leave one uncommented)
-__version__ = "1.2.2b10"
+#__version__ = "1.2.2"
+__version__ = "1.2.3b1"

sparcl/client.py

@@ -24,6 +24,7 @@ from urllib.parse import urlencode, urlparse
 from warnings import warn
 import pickle
 import getpass
+import datetime
 
 #!from pathlib import Path
 import tempfile
@@ -31,6 +32,7 @@ import tempfile
 ############################################
 # External Packages
 import requests
+import jwt
 
 #!from requests.auth import HTTPBasicAuth
 from requests.auth import AuthBase
@@ -118,12 +120,15 @@ RESERVED = set([DEFAULT, ALL])
 class TokenAuth(AuthBase):
     """Attaches HTTP Token Authentication to the given Request object."""
 
-    def __init__(self, token):
+    def __init__(self, token, renew_check):
         # setup any auth-related data here
         self.token = token
+        self.renew_check = renew_check  # SparcClient Method
 
     def __call__(self, request):
         # modify and return the request
+        # check and renew token if needed
+        self.renew_check(renew=True)
         request.headers["Authorization"] = self.token
         return request
 
@@ -163,7 +168,7 @@ class SparclClient:  # was SparclApi()
 
     """
 
-    KNOWN_GOOD_API_VERSION = 11.0  # @@@ Change when Server version incremented
+    KNOWN_GOOD_API_VERSION = 12.0  # @@@ Change when Server version incremented
 
     def __init__(
         self,
@@ -182,6 +187,8 @@ class SparclClient:  # was SparclApi()
         self.apiurl = f"{self.rooturl}/sparc"
         self.apiversion = None
         self.token = None
+        self.refresh_token = None
+        self.token_exp = None
         self.verbose = verbose
         self.show_curl = show_curl  # Show CURL equivalent of client method
         #!self.internal_names = internal_names
@@ -243,6 +250,35 @@ class SparclClient:  # was SparclApi()
             f" read_timeout={self.r_timeout})"
         )
 
+    def token_expired(self, renew=False):
+        """
+            POST http://localhost:8050/sparc/renew_token/
+            Content-Type: application/json
+            {
+              "refresh_token": "..."
+            }
+
+            Returns an 'access' token
+        """
+        now = datetime.datetime.now()
+        expired = True
+        if self.token_exp is None or self.token_exp <= now:
+            expired = True
+        else:
+            expired = False
+
+        if expired and renew:
+            url = f"{self.apiurl}/renew_token/"
+            resp = requests.post(url, json={"refresh_token": self.renew_token})
+            resp.raise_for_status()
+            data = resp.json()
+            #@print(f"{data=}")
+            self.token = data['access']
+            self.set_token_exp()
+            expired = False
+
+        return expired
+
     def login(self, email, password=None):
         """Login to the SPARCL service.
 
@@ -284,20 +320,32 @@ class SparclClient:  # was SparclApi()
         try:
             res.raise_for_status()
             #!print(f"DBG: {res.content=}")
-            self.token = res.json()
+            self.token = res.json()['access']
+            self.renew_token = res.json()['refresh']
             self.session.auth = (email, password)
         except Exception:
             self.session.auth = None
             self.token = None
+            self.renew_token = None
+            self.token_exp = None
             msg = (
                 "Could not login with given credentials."
                 ' Reverted to "Anonymous" user.'
             )
             return msg
 
+        self.set_token_exp()
         print(f"Logged in successfully with {email=}")
         return None
 
+    def set_token_exp(self):
+        decoded = jwt.decode(
+            self.token,
+            algorithms=['HS256',],
+            options={'verify_signature': False}
+        )
+        self.token_exp = datetime.datetime.fromtimestamp(decoded['exp'])
+
     def logout(self):
         """Logout of the SPARCL service.
 
@@ -317,7 +365,7 @@ class SparclClient:  # was SparclApi()
 
     @property
     def authorized(self):
-        auth = TokenAuth(self.token) if self.token else None
+        auth = TokenAuth(self.token, self.token_expired) if self.token else None  # noqa: E501
         response = requests.get(
             f"{self.apiurl}/auth_status/", auth=auth, timeout=self.timeout
         )
@@ -468,7 +516,7 @@ class SparclClient:  # was SparclApi()
         Example:
             >>> client = SparclClient()
             >>> client.version
-            11.0
+            12.0
         """
 
         if self.apiversion is None:
@@ -567,7 +615,7 @@ class SparclClient:  # was SparclApi()
             cmd = ut.curl_find_str(sspec, self.rooturl, qstr=qstr)
             print(cmd)
 
-        auth = TokenAuth(self.token) if self.token else None
+        auth = TokenAuth(self.token, self.token_expired) if self.token else None  # noqa: E501
         res = requests.post(url, json=sspec, auth=auth, timeout=self.timeout)
 
         if res.status_code != 200:
@@ -833,7 +881,7 @@ class SparclClient:  # was SparclApi()
             print(cmd)
 
         try:
-            auth = TokenAuth(self.token) if self.token else None
+            auth = TokenAuth(self.token, self.token_expired) if self.token else None  # noqa: E501
             res = requests.post(url, json=ids, auth=auth, timeout=self.timeout)
         except requests.exceptions.ConnectTimeout as reCT:
             raise ex.UnknownSparcl(f"ConnectTimeout: {reCT}")

{sparclclient-1.2.2b10.dist-info → sparclclient-1.2.3b1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: sparclclient
-Version: 1.2.2b10
+Version: 1.2.3b1
 Summary: A client for getting spectra and meta-data from NOIRLab.
 Author-email: "S. Pothier" <datalab-spectro@noirlab.edu>
 Description-Content-Type: text/markdown

{sparclclient-1.2.2b10.dist-info → sparclclient-1.2.3b1.dist-info}/RECORD

@@ -1,6 +1,6 @@
 sparcl/Results.py,sha256=YFh7HmiAfjxQv1y55OHhXsJbpKBh7mn92zPJZ56gJxw,8477
-sparcl/__init__.py,sha256=faXU81TTMWX4deehOfYWi9N0SChnm7Kpbw91TuoIJsI,1033
-sparcl/client.py,sha256=GJR9eB9LqQ0zYw0ertjh5yh-dIGOP0svNm4R0MdhxfY,36169
+sparcl/__init__.py,sha256=SoVK228J3AOFNJdbvqekR6My_zZar8aXOCF08EiJb4I,1055
+sparcl/client.py,sha256=jQXbJGIxId2azVjzONrR3TiGEb1x1SEk5-sGgd-Bgdw,37772
 sparcl/conf.py,sha256=GFNDelaiVIAkjNjvFlG7HAlPpU39nqZmTPohQGmOcgI,928
 sparcl/exceptions.py,sha256=ODtoGCi1HI4xwXBbbLT-gQqd9Jjb_8TmVj-Jz_b1tg4,4040
 sparcl/fields.py,sha256=NZUBqDidpbXfeX5F4b306F323xZY2CRIx8eVv-HWTVU,5127
@@ -13,7 +13,7 @@ sparcl/utils.py,sha256=pDAk9roe7ezfVohnKcLMxFjjXHkp7EQLbgVNe5sSTrk,6259
 sparcl/benchmarks/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 sparcl/benchmarks/benchmarks.py,sha256=OmlSdnAPLmcvGXsr-HzGyfAAcnoqlO0JQ4EIA7JGhZc,9424
 sparcl/notebooks/sparcl-examples.ipynb,sha256=gEwMKI1x7A1YsVeCsQn1QoMO0ZuIhMUAu3qedTiQ7hM,169268
-sparclclient-1.2.2b10.dist-info/LICENSE,sha256=y10EluGMCzGs9X4oYCYyix3l6u-lawB_vlGR8qe442Q,1576
-sparclclient-1.2.2b10.dist-info/WHEEL,sha256=Sgu64hAMa6g5FdzHxXv9Xdse9yxpGGMeagVtPMWpJQY,99
-sparclclient-1.2.2b10.dist-info/METADATA,sha256=0LHoWuKG9Y-AimI-BI-tz7FZ_9PpUN-jHirsbCiBHbk,567
-sparclclient-1.2.2b10.dist-info/RECORD,,
+sparclclient-1.2.3b1.dist-info/LICENSE,sha256=y10EluGMCzGs9X4oYCYyix3l6u-lawB_vlGR8qe442Q,1576
+sparclclient-1.2.3b1.dist-info/WHEEL,sha256=Sgu64hAMa6g5FdzHxXv9Xdse9yxpGGMeagVtPMWpJQY,99
+sparclclient-1.2.3b1.dist-info/METADATA,sha256=AXPIvQVuOmLK5FDdXkr-cLFZUMtUc-uuJIkCFzdXMBY,566
+sparclclient-1.2.3b1.dist-info/RECORD,,