rudi-node-write 1.1.0__tar.gz → 1.2.0__tar.gz

{rudi_node_write-1.1.0/src/rudi_node_write.egg-info → rudi_node_write-1.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: rudi-node-write
-Version: 1.1.0
+Version: 1.2.0
 Summary: Use the internal API of a RUDI Producer node
 Author-email: Olivier Martineau <olivier.martineau@irisa.fr>
 Maintainer-email: Olivier Martineau <olivier.martineau@irisa.fr>
@@ -17,11 +17,6 @@ Classifier: License :: OSI Approved :: European Union Public Licence 1.2 (EUPL 1
 Requires-Python: >=3.11
 Description-Content-Type: text/markdown
 License-File: LICENCE.md
-Requires-Dist: beautifulsoup4==4.12.3
-Requires-Dist: chardet==5.2.0
-Requires-Dist: deepdiff==7.0.1
-Requires-Dist: defusedxml==0.7.1
-Requires-Dist: puremagic==1.24
 
 [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
 [![Checked with pyright](https://microsoft.github.io/pyright/img/pyright_badge.svg)](https://microsoft.github.io/pyright/)
@@ -47,7 +42,7 @@ The Jupyter notebook [`README.ipynb`](https://github.com/OlivierMartineau/rudi-n
 
 ## Testing
 
-The [tests](https://github.com/OlivierMartineau/rudi-node-write/tree/release/tests) can be analyzed for further
+The [tests](https://github.com/OlivierMartineau/rudi-node-write/tree/main/tests) can be analyzed for further
 information about how to call the API
 
 ```bash

{rudi_node_write-1.1.0 → rudi_node_write-1.2.0}/README.md

@@ -22,7 +22,7 @@ The Jupyter notebook [`README.ipynb`](https://github.com/OlivierMartineau/rudi-n
 
 ## Testing
 
-The [tests](https://github.com/OlivierMartineau/rudi-node-write/tree/release/tests) can be analyzed for further
+The [tests](https://github.com/OlivierMartineau/rudi-node-write/tree/main/tests) can be analyzed for further
 information about how to call the API
 
 ```bash

{rudi_node_write-1.1.0 → rudi_node_write-1.2.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "rudi-node-write"
-version = "1.1.0"
+version = "1.2.0"
 authors = [{ name = "Olivier Martineau", email = "olivier.martineau@irisa.fr" }]
 maintainers = [{ name = "Olivier Martineau", email = "olivier.martineau@irisa.fr" }]
 description = "Use the internal API of a RUDI Producer node"
@@ -34,13 +34,13 @@ target-version = ['py311']
 # ----- Tool: commitizen
 [tool.commitizen]
 name = "cz_conventional_commits"
-version = "1.1.0"
+version = "1.2.0"
 version_files = ["pyproject.toml:version"]
 
 # ----- Tool: pytest
 [tool.pytest.ini_options]
 pythonpath = ["src"]
-norecursedirs = ["*.egg", ".eggs", "dist", "build"]
+norecursedirs = ["*.egg", ".eggs", "dist", "build", "wip"]
 filterwarnings = ["ignore:.*pkg_resources.*:DeprecationWarning"]
 addopts = ["--cov=rudi_node_write", "--cov-report=term-missing", "--cov-report=html:reports/html_dir", "--cov-report=xml:reports/coverage.xml" ]
 

{rudi_node_write-1.1.0 → rudi_node_write-1.2.0}/src/rudi_node_write/connectors/io_connector.py

@@ -44,12 +44,13 @@ def https_download(resource_url: str, headers=None, should_show_debug_line: bool
 class Connector:
     _default_connector = None
 
-    def __init__(self, server_url: str):
+    def __init__(self, server_url: str, keep_connection: bool = False):
         self.scheme = None
         self.host = None
         self.path = None
         self.base_url = None
         self.connection = None
+        self.keep_connection = keep_connection
 
         self._set_url(server_url)
         self._cookies = None
@@ -63,7 +64,7 @@ class Connector:
         self.host = netloc
         self.path = path
         self.base_url = slash_join(f"{self.scheme}://{self.host}", self.path)
-        log_d(here, "base_url", self.base_url)
+        # log_d(here, "base_url", self.base_url)
 
     @property
     def class_name(self):
@@ -119,7 +120,7 @@ class Connector:
         else:
             log_d_if(should_log_response, here, f"OK {response.status}", path_url)
             res_data = response.read()
-            if not keep_alive:
+            if not keep_alive and not self.keep_connection:
                 self.connection.close()
             if not res_data:
                 log_e(here, "empty data?")
@@ -214,7 +215,7 @@ class Connector:
         except (TypeError, JSONDecodeError):
             response_data = repr(rdata)
             log_d_if(should_log_response, here, "Response is not a JSON", response_data)
-        if not keep_alive:
+        if not keep_alive and not self.keep_connection:
             self.close_connection()
 
         if type(response_data) is str:

{rudi_node_write-1.1.0 → rudi_node_write-1.2.0}/src/rudi_node_write/connectors/io_rudi_api_write.py

@@ -30,6 +30,8 @@ from rudi_node_write.utils.list_utils import get_first_list_elt_or_none
 from rudi_node_write.utils.log import log_d, log_e, log_w
 from rudi_node_write.utils.str_utils import slash_join, uuid4_str, is_uuid_v4
 from rudi_node_write.utils.typing_utils import get_type_name, check_type
+from rudi_node_write.utils.url_utils import ensure_url_startswith
+
 
 REQ_LIMIT = 500
 _DELAY_REFRESH_S = 60  # seconds
@@ -39,11 +41,13 @@ _STATUS_SKIPPED = "skipped"
 _STATUS_MISSING = "missing"
 _STATUS_DOWNLOADED = "downloaded"
 
-_API_ADMIN_PATH = "api/admin"
-
 here = "RudiNodeApiConnector"
 
 
+def ensure_url_startswith_api_admin(url):
+    return ensure_url_startswith(url, "api/admin")
+
+
 class RudiNodeApiConnector(Connector):
     def __init__(
         self,
@@ -76,7 +80,6 @@ class RudiNodeApiConnector(Connector):
         else:
             raise AttributeError("Either a RudiNodeJwtFactory object or a valid JWT is required")
         self.test_connection()
-
         self._data_cache = {}
 
     def test_connection(self):
@@ -85,7 +88,7 @@ class RudiNodeApiConnector(Connector):
             log_e(here, f"!! Node '{self.host}'", "no connection!")
             raise ConnectionError(f"An error occurred while connecting to RUDI node JWT server {self.base_url}")
 
-        log_d(here, f"Node '{self.host}'", "connection OK")
+        # log_d(here, f"Node '{self.host}'", "connection OK")
         return test
 
     def set_jwt_factory(self, jwt_factory: RudiNodeJwtFactory) -> None:
@@ -113,7 +116,9 @@ class RudiNodeApiConnector(Connector):
     def _headers(self):
         return self._initial_headers | {"Authorization": f"Bearer {self._jwt}"}
 
-    def get_admin_api(self, url: str, keep_alive: bool = False) -> str | int | list | dict:
+    def get_admin_api(
+        self, url: str, keep_alive: bool = False, should_log_request=False, should_log_response=False
+    ) -> str | int | list | dict:
         """
         Performs an identified GET request through /api/admin path
         :param url: part of the URL that comes after /api/admin
@@ -123,9 +128,11 @@ class RudiNodeApiConnector(Connector):
         """
         return self.request(
             req_method="GET",
-            relative_url=slash_join(_API_ADMIN_PATH, url),
+            relative_url=ensure_url_startswith_api_admin(url),
             headers=self._headers,
             keep_alive=keep_alive,
+            should_log_request=should_log_request,
+            should_log_response=should_log_response,
         )  # type: ignore
 
     def put_admin_api(
@@ -139,7 +146,7 @@ class RudiNodeApiConnector(Connector):
         """
         return self.request(
             req_method="PUT",
-            relative_url=slash_join(_API_ADMIN_PATH, url),
+            relative_url=ensure_url_startswith_api_admin(url),
             headers=headers if headers else self._headers,
             body=payload,
             keep_alive=keep_alive,
@@ -156,7 +163,7 @@ class RudiNodeApiConnector(Connector):
         """
         return self.request(
             req_method="POST",
-            relative_url=slash_join(_API_ADMIN_PATH, url),
+            relative_url=ensure_url_startswith_api_admin(url),
             headers=headers if headers else self._headers,
             body=payload,
             keep_alive=keep_alive,
@@ -171,7 +178,7 @@ class RudiNodeApiConnector(Connector):
         """
         return self.request(
             req_method="DELETE",
-            relative_url=slash_join(_API_ADMIN_PATH, url),
+            relative_url=ensure_url_startswith_api_admin(url),
             headers=headers if headers else self._headers,
             keep_alive=keep_alive,
         )
@@ -766,7 +773,7 @@ if __name__ == "__main__":  # pragma: no cover
     # ----------- INIT -----------
     tests = "RudiNodeApiConnector tests"
     begin = time()
-    creds_file = "../../../creds/creds.json"
+    creds_file = "../creds/creds_bas.json"
     rudi_node_creds = read_json_file(creds_file)
     url = rudi_node_creds["url"]
 
@@ -774,7 +781,7 @@ if __name__ == "__main__":  # pragma: no cover
     rudi_node_api = RudiNodeApiConnector(server_url=url, jwt_factory=node_jwt_factory)
 
     # ----------- TESTS -----------
-    test_dir = "../../../dwnld"
+    test_dir = "../dwnld"
     log_d(tests, "producers", len(rudi_node_api.organization_list))
     log_d(tests, "producer names", rudi_node_api.producer_names)
     log_d(tests, "metadata_contacts", len(rudi_node_api.contact_list))
@@ -793,13 +800,13 @@ if __name__ == "__main__":  # pragma: no cover
     log_d(
         tests,
         "download_files_for_metadata",
-        rudi_node_api.download_files_for_metadata("c4c8e77b-d0a2-4875-ab88-9ef77e829926", test_dir),
+        rudi_node_api.download_files_for_metadata("65d99589-7a7a-46a3-afe8-c5a47b964310", test_dir),
     )
 
     log_d(
         tests,
         "download_file_with_media_uuid '782bab2d-7ee8-4633-9c0a-173649b4d879'",
-        rudi_node_api.download_file_with_media_uuid("782bab2d-7ee8-4633-9c0a-173649b4d879", test_dir),
+        rudi_node_api.download_file_with_media_uuid("fef11852-0756-4cbe-bdfb-3722a1751de9", test_dir),
     )
 
     log_d(

{rudi_node_write-1.1.0 → rudi_node_write-1.2.0}/src/rudi_node_write/connectors/io_rudi_jwt_factory.py

@@ -22,10 +22,14 @@ class RudiNodeJwtFactory(Connector):
         headers_user_agent: str = "RudiNodeJwtFactory",
     ):
         super().__init__(server_url)
+        self.sub = "rudi_prod_token"
         if has_key(auth, B64_AUTH_KEY):
             self._b64_auth = f"Basic {auth[B64_AUTH_KEY]}"
         elif has_key(auth, USR_AUTH_KEY) and has_key(auth, PWD_AUTH_KEY):
             self._b64_auth = get_basic_auth(auth[USR_AUTH_KEY], auth[PWD_AUTH_KEY])
+        elif has_key(auth, "sub"):
+            self.sub = auth["sub"]
+            self._b64_auth = ""
         else:
             err_msg = f"{B64_AUTH_KEY}', or both '{USR_AUTH_KEY}' and '{PWD_AUTH_KEY}"
             raise UnexpectedValueException("auth", err_msg, auth)
@@ -45,7 +49,7 @@ class RudiNodeJwtFactory(Connector):
         if not isinstance(test, dict) or test["RUDI"] != "JWT":
             log_e("RudiNodeJwtFactory", f"!! Node '{self.host}'", "no connection!")
             raise ConnectionError(f"An error occurred while connecting to RUDI node JWT server {self.base_url}")
-        log_d("RudiNodeJwtFactory", f"Node '{self.host}'", "connection OK")
+        # log_d("RudiNodeJwtFactory", f"Node '{self.host}'", "connection OK")
         return True
 
     def _renew_jwt(self, delay_s: int) -> str:
@@ -53,7 +57,7 @@ class RudiNodeJwtFactory(Connector):
             delay_s = self._default_exp_s
         jwt_body = {
             "exp": Date.time_epoch_s(delay_s),
-            "sub": "rudi_prod_token",
+            "sub": self.sub,
             "req_mtd": "all",
             "req_url": "all",
         }
@@ -77,7 +81,7 @@ class RudiNodeJwtFactory(Connector):
 
 if __name__ == "__main__":  # pragma: no cover
     tests = "JwtFactory tests"
-    creds_file = "../../../creds/creds.json"
+    creds_file = "../creds/creds_bas.json"
     rudi_node_creds = read_json_file(creds_file)
     # log_d(tests, "rudi_node_creds", rudi_node_creds)
     rudi_jwt_connector = RudiNodeJwtFactory(rudi_node_creds["url"], rudi_node_creds)