sparclclient 1.2.2b10__tar.gz → 1.2.3b1__tar.gz

sparclclient-1.2.3b1/.github/workflows/django.yml

@@ -0,0 +1,33 @@
+# This workflow will install Python dependencies and run unittests with 2 Python versions
+
+name: ci-django-unittests
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      max-parallel: 4
+      matrix:
+        python-version: [3.9, '3.10']
+
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v3
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install pip dependencies
+        run: |
+          python -m pip install --upgrade pip
+      - name: Install requirements dependencies
+        run: |
+          python -m pip install -r requirements-client.txt         
+      - name: Run unittests
+        run: |
+          python -m unittest tests.tests_api

{sparclclient-1.2.2b10 → sparclclient-1.2.3b1}/PKG-INFO

@@ -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 → sparclclient-1.2.3b1}/requirements-client.txt

@@ -1,3 +1,4 @@
 requests==2.31.0 # 2.26.0
-numpy
+numpy==1.26.1
 spectres
+PyJWT

{sparclclient-1.2.2b10 → sparclclient-1.2.3b1}/source/conf.py

@@ -14,14 +14,13 @@
 import os
 import re
 import sys
-from sparcl import __version__
-
 sys.path.insert(0, os.path.abspath(".."))
+from sparcl import __version__
 
 # -- Project information -----------------------------------------------------
 
 project = "SPARCL"
-copyright = "2022, S.Pothier, A.Jacques"
+copyright = "2024, S.Pothier, A.Jacques"
 author = "S.Pothier, A.Jacques"
 
 #!version = client_version

{sparclclient-1.2.2b10 → sparclclient-1.2.3b1}/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"

{sparclclient-1.2.2b10 → sparclclient-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 → sparclclient-1.2.3b1}/tests/expected_pat.py

@@ -40,11 +40,20 @@ retrieve_0b = ["_dr", "dec", "flux", "ra", "sparcl_id", "specid", "wavelength"]
 
 retrieve_5 = 2
 
+# OLD as of August 23, 2024
+#find_0 = [
+#    {
+#        "_dr": "BOSS-DR16",
+#        "data_release": "BOSS-DR16",
+#        "specid": -6444532452352045056,
+#    }
+#]
+
 find_0 = [
     {
-        "_dr": "BOSS-DR16",
-        "data_release": "BOSS-DR16",
-        "specid": -6444532452352045056,
+        '_dr': 'BOSS-DR16',
+        'data_release': 'BOSS-DR16',
+        'telescope': 'sloan25m'
     }
 ]
 
@@ -58,11 +67,12 @@ find_1 = [
 
 find_2 = 936894  # PAT
 
-find_3 = [
-    {"_dr": "BOSS-DR16", "data_release": "BOSS-DR16"},
-    {"_dr": "DESI-EDR", "data_release": "DESI-EDR"},
-    {"_dr": "SDSS-DR16", "data_release": "SDSS-DR16"},
-]
+# OLD as of August 23, 2024
+#find_3 = [
+#    {"_dr": "BOSS-DR16", "data_release": "BOSS-DR16"},
+#    {"_dr": "DESI-EDR", "data_release": "DESI-EDR"},
+#    {"_dr": "SDSS-DR16", "data_release": "SDSS-DR16"},
+#]
 
 find_4 = 36
 
@@ -77,6 +87,7 @@ authorized_1 = {
     "Loggedin_As": "test_user_1@noirlab.edu",
     "Authorized_Datasets": {
         "BOSS-DR16",
+        "DESI-DR1",
         "DESI-EDR",
         "SDSS-DR16",
         "SDSS-DR17-test",
@@ -96,15 +107,20 @@ authorized_3 = {
 # Private and Public
 pub_1 = ["BOSS-DR16"]
 pub_all = ["BOSS-DR16", "DESI-EDR", "SDSS-DR16"]
-priv = ["SDSS-DR17-test"]
+priv = ["DESI-DR1", "SDSS-DR17-test"]
+all_all = pub_all + priv
+all_all.sort()
 unauth = "test_user_2@noirlab.edu"
 #
-auth_find_1 = auth_find_2 = pub_all + priv
-auth_find_3 = f"[DSDENIED] {unauth} is declined access to datasets {priv}"
+auth_find_1 = auth_find_2 = all_all
+auth_find_3 = auth_retrieve_3 = (f"[DSDENIED] uname='{unauth}' is declined "
+                                 f"access to datasets={priv}; "
+                                 f"drs_requested={all_all} "
+                                 f"my_auth={pub_all}")
 auth_find_4 = auth_find_6 = pub_all
-auth_find_5 = f"[DSDENIED] ANONYMOUS is declined access to datasets {priv}"
-#
+auth_find_5 = auth_retrieve_6 = ("[DSDENIED] uname='ANONYMOUS' is declined "
+                                 f"access to datasets={priv}; "
+                                 f"drs_requested={all_all} "
+                                 f"my_auth={pub_all}")
 auth_retrieve_1 = auth_retrieve_2 = pub_1 + priv
-auth_retrieve_3 = f"[DSDENIED] {unauth} is declined access to datasets {priv}"
 auth_retrieve_4 = auth_retrieve_5 = auth_retrieve_7 = auth_retrieve_8 = pub_1
-auth_retrieve_6 = f"[DSDENIED] ANONYMOUS is declined access to datasets {priv}"

{sparclclient-1.2.2b10 → sparclclient-1.2.3b1}/tests/tests_api.py

@@ -372,14 +372,14 @@ class SparclClientTest(unittest.TestCase):
     def test_find_0(self):
         """Get metadata using search spec."""
 
-        outfields = ["data_release", "specid"]
+        outfields = ["data_release", "telescope"]
         # To get suitable constraints (in sparc-shell on Server):
         #    list(FitsRecord.objects.all().values('ra','dec'))
-        constraints = {"ra": [132.1, 132.2], "dec": [+28.0, +28.1]}
+        constraints = {"data_release": ['BOSS-DR16']}
         found = self.client.find(outfields, constraints=constraints, limit=3)
-        actual = found.records[:2]
+        actual = found.records[:1]
         if showact:
-            print(f"find_0: actual={pf(actual[:2])}")
+            print(f"find_0: actual={pf(actual[:1])}")
         self.assertEqual(actual, exp.find_0, msg="Actual to Expected")
 
     @skip("fiddly bit skipped until we use factoryboy")
@@ -421,10 +421,10 @@ class SparclClientTest(unittest.TestCase):
         found = self.client.find(outfields, limit=3, sort="data_release")
         actual = sorted(found.records, key=lambda rec: rec["data_release"])
         if showact:
-            print(f"find_3: actual={pf(actual)}")
+            print(f"find_3: actual={pf(actual)}, len(actual)={len(actual)}")
         self.assertEqual(
-            actual,
-            sorted(exp.find_3, key=lambda rec: rec["data_release"]),
+            len(actual),
+            3,
             msg="Actual to Expected",
         )
 
@@ -757,8 +757,9 @@ class AuthTest(unittest.TestCase):
 
         # Dataset lists
         cls.Pub = ["BOSS-DR16", "DESI-EDR", "SDSS-DR16"]
-        cls.Priv = ["SDSS-DR17-test"]
+        cls.Priv = ["DESI-DR1", "SDSS-DR17-test"]
         cls.PrivPub = cls.Priv + cls.Pub
+        cls.PrivPub.sort()
 
         # Sample list of sparcl_ids from each data set
         out = ["sparcl_id"]
@@ -843,15 +844,51 @@ class AuthTest(unittest.TestCase):
         if showact:
             print(f"test_get_token: {json=}")
 
-        expected = 281
+        expected = 279
         res = requests.post(f"{self.client.apiurl}/get_token/", json=json)
         self.assertEqual(res.status_code, 200, res.content.decode())
-        token = res.content.decode()
+        token = res.json()['access']
         actual = len(token)
         if showact:
             print(f"test_get_token: ({len(token)}) {token=!s}")
         self.assertEqual(actual, expected, msg="Actual to Expected")
 
+    def getToken(self):
+        json = {"email": self.auth_user, "password": usrpw}
+        res = requests.post(f"{self.client.apiurl}/get_token/", json=json)
+        token = res.json()
+        self.client.token = token['access']
+        self.client.renew_token = token['refresh']
+
+    def test_token_not_expired(self):
+        self.getToken()
+        expired = self.client.token_expired(renew=False)
+        self.assertEqual(expired, False, "Token not expired")
+
+    def test_token_expired(self):
+        self.getToken()
+        if showact:
+            print(f"Token: {self.client.token=!s}")
+
+        self.client.token_exp = datetime.datetime.now()
+        expired = self.client.token_expired(renew=False)
+        self.assertEqual(expired, True, "Token expired")
+
+    def test_token_expired_renew(self):
+        """
+            POST http://localhost:8050/sparc/renew_token/
+            Content-Type: application/json
+            {
+              "token": "..."
+            }
+
+        """
+        self.getToken()
+        self.client.token_exp = datetime.datetime.now()
+
+        expired = self.client.token_expired(renew=True)
+        self.assertEqual(expired, False, "Token expired, renewed")
+
     def test_authorized_1(self):
         """Test authorized method with authorized user signed in"""
         self.silent_login(self.auth_user, usrpw)

sparclclient-1.2.2b10/.github/workflows/django.yml

@@ -1,30 +0,0 @@
-name: Django CI
-
-on:
-  push:
-    branches: [ "main" ]
-  pull_request:
-    branches: [ "main" ]
-
-jobs:
-  build:
-
-    runs-on: ubuntu-latest
-    strategy:
-      max-parallel: 4
-      matrix:
-        python-version: [3.7, 3.8, 3.9]
-
-    steps:
-    - uses: actions/checkout@v3
-    - name: Set up Python ${{ matrix.python-version }}
-      uses: actions/setup-python@v3
-      with:
-        python-version: ${{ matrix.python-version }}
-    - name: Install Dependencies
-      run: |
-        python -m pip install --upgrade pip
-        pip install -r requirements.txt
-    - name: Run Tests
-      run: |
-        python manage.py test