diaspora-event-sdk 0.0.13__py3-none-any.whl → 0.0.16__py3-none-any.whl

diaspora_event_sdk/__init__.py

@@ -6,11 +6,6 @@ from diaspora_event_sdk.version import __version__ as _version
 __author__ = "The Diaspora Event Team"
 __version__ = _version
 
-from diaspora_event_sdk.sdk.client import Client  # Globus client
-from diaspora_event_sdk.sdk.kafka_client import kafka_available
-
-if kafka_available:
-    from diaspora_event_sdk.sdk.kafka_client import KafkaProducer, KafkaConsumer
-    __all__ = ("Client", "KafkaProducer", "KafkaConsumer")
-else:
-    __all__ = ("Client")
+from diaspora_event_sdk.sdk.client import Client
+from diaspora_event_sdk.sdk.kafka_client import KafkaProducer, KafkaConsumer
+__all__ = ("Client", "KafkaProducer", "KafkaConsumer")

diaspora_event_sdk/sdk/client.py

@@ -1,12 +1,16 @@
-from typing import Optional
 import json
+from typing import Optional
 
-from diaspora_event_sdk.sdk.login_manager import LoginManager, LoginManagerProtocol, requires_login
-from ._environments import TOKEN_EXCHANGE, DIASPORA_RESOURCE_SERVER
+from diaspora_event_sdk.sdk.login_manager import (
+    LoginManager,
+    LoginManagerProtocol,
+    requires_login,
+)
 
+from ._environments import DIASPORA_RESOURCE_SERVER, TOKEN_EXCHANGE
 
-class Client:
 
+class Client:
     def __init__(
         self,
         environment: Optional[str] = None,
@@ -21,9 +25,7 @@ class Client:
             self.login_manager = LoginManager(environment=environment)
             self.login_manager.ensure_logged_in()
 
-        self.web_client = self.login_manager.get_web_client(
-            base_url=TOKEN_EXCHANGE
-        )
+        self.web_client = self.login_manager.get_web_client(base_url=TOKEN_EXCHANGE)
         self.auth_client = self.login_manager.get_auth_client()
         self.subject_openid = self.auth_client.oauth2_userinfo()["sub"]
 
@@ -41,20 +43,26 @@ class Client:
             raise Exception("should not happen")
 
         tokens = self.login_manager._token_storage.get_token_data(
-            DIASPORA_RESOURCE_SERVER)
-        tokens['access_key'], tokens['secret_key'] = resp['access_key'], resp['secret_key']
+            DIASPORA_RESOURCE_SERVER
+        )
+        tokens["access_key"], tokens["secret_key"] = (
+            resp["access_key"],
+            resp["secret_key"],
+        )
         with self.login_manager._access_lock:
             self.login_manager._token_storage._connection.executemany(
                 "REPLACE INTO token_storage(namespace, resource_server, token_data_json) "
                 "VALUES(?, ?, ?)",
                 [
-                    (self.login_manager._token_storage.namespace,
-                     DIASPORA_RESOURCE_SERVER,
-                     json.dumps(tokens))
+                    (
+                        self.login_manager._token_storage.namespace,
+                        DIASPORA_RESOURCE_SERVER,
+                        json.dumps(tokens),
+                    )
                 ],
             )
             self.login_manager._token_storage._connection.commit()
-        return {"username": self.subject_openid, "password": tokens['secret_key']}
+        return {"username": self.subject_openid, "password": tokens["secret_key"]}
 
     @requires_login
     def retrieve_key(self):
@@ -62,29 +70,30 @@ class Client:
         Attempt to retrieve the key from local token storage, and call create_key if local key is not found
         """
         tokens = self.login_manager._token_storage.get_token_data(
-            DIASPORA_RESOURCE_SERVER)
+            DIASPORA_RESOURCE_SERVER
+        )
         if tokens is None or "access_key" not in tokens or "secret_key" not in tokens:
             return self.create_key()
         else:
-            return {"username": self.subject_openid, "password": tokens['secret_key']}
+            return {"username": self.subject_openid, "password": tokens["secret_key"]}
 
     @requires_login
     def list_topics(self):
         """
-        Retrieves the list of topics associated with the user's OpenID. 
+        Retrieves the list of topics associated with the user's OpenID.
         """
         return self.web_client.list_topics(self.subject_openid)
 
     @requires_login
     def register_topic(self, topic):
         """
-        Registers a new topic under the user's OpenID. 
+        Registers a new topic under the user's OpenID.
         """
         return self.web_client.register_topic(self.subject_openid, topic)
 
     @requires_login
     def unregister_topic(self, topic):
         """
-        Unregisters a topic from the user's OpenID. 
+        Unregisters a topic from the user's OpenID.
         """
         return self.web_client.unregister_topic(self.subject_openid, topic)

diaspora_event_sdk/sdk/kafka_client.py

@@ -8,7 +8,9 @@ from .client import Client
 # If kafka-python is not installed, Kafka functionality is not available through diaspora-event-sdk.
 kafka_available = True
 try:
-    from kafka import KafkaProducer, KafkaConsumer
+    from kafka import KafkaProducer as KProd  # type: ignore[import-not-found]
+    from kafka import KafkaConsumer as KCons  # type: ignore[import-not-found]
+
 except ImportError:
     kafka_available = False
 
@@ -36,14 +38,24 @@ def get_diaspora_config(extra_configs: Dict[str, Any] = {}) -> Dict[str, Any]:
 
 
 if kafka_available:
-
-    class KafkaProducer(KafkaProducer):
+    class KafkaProducer(KProd):
         def __init__(self, **configs):
             configs.setdefault(
                 "value_serializer", lambda v: json.dumps(v).encode("utf-8")
             )
             super().__init__(**get_diaspora_config(configs))
 
-    class KafkaConsumer(KafkaConsumer):
+    class KafkaConsumer(KCons):
         def __init__(self, *topics, **configs):
             super().__init__(*topics, **get_diaspora_config(configs))
+else:
+    # Create dummy classes that issue a warning when instantiated
+    class KafkaProducer:  # type: ignore[no-redef]
+        def __init__(self, *args, **kwargs):
+            warnings.warn(
+                "KafkaProducer is not available. Initialization is a no-op.", RuntimeWarning)
+
+    class KafkaConsumer:  # type: ignore[no-redef]
+        def __init__(self, *args, **kwargs):
+            warnings.warn(
+                "KafkaConsumer is not available. Initialization is a no-op.", RuntimeWarning)

diaspora_event_sdk/sdk/web_client.py

@@ -25,13 +25,13 @@ class WebClient(globus_sdk.BaseClient):
         self.user_app_name = app_name
 
     def create_key(self, subject: UUID_LIKE_T) -> globus_sdk.GlobusHTTPResponse:
-        return self.post("/v1/create_key", headers={"Subject": subject})
+        return self.post("/v1/create_key", headers={"Subject": str(subject)})
 
     def list_topics(self, subject: UUID_LIKE_T) -> globus_sdk.GlobusHTTPResponse:
-        return self.get("/v1/list_topics", headers={"Subject": subject})
+        return self.get("/v1/list_topics", headers={"Subject": str(subject)})
 
     def register_topic(self, subject: UUID_LIKE_T, topic: str) -> globus_sdk.GlobusHTTPResponse:
-        return self.post("/v1/register_topic", headers={"Subject": subject, "Topic": topic})
+        return self.post("/v1/register_topic", headers={"Subject": str(subject), "Topic": topic})
 
     def unregister_topic(self, subject: UUID_LIKE_T, topic: str) -> globus_sdk.GlobusHTTPResponse:
-        return self.post("/v1/unregister_topic", headers={"Subject": subject, "Topic": topic})
+        return self.post("/v1/unregister_topic", headers={"Subject": str(subject), "Topic": topic})

diaspora_event_sdk/version.py

@@ -1 +1 @@
-__version__ = "0.0.13"
+__version__ = "0.0.16"

{diaspora_event_sdk-0.0.13.dist-info → diaspora_event_sdk-0.0.16.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: diaspora-event-sdk
-Version: 0.0.13
+Version: 0.0.16
 Summary: SDK of Diaspora Event Fabric: Resilience-enabling services for science from HPC to edge
 Home-page: https://github.com/globus-labs/diaspora-event-sdk
 License: LICENSE
@@ -138,3 +138,21 @@ It seems that you ran `pip install diaspora-event-sdk` to install the Diaspora E
 
 ### kafka.errors.NoBrokersAvailable and kafka.errors.NodeNotReadyError
 These messages might pop up if `create_key` is called shortly before instanciating a Kafka client. This is because there's a delay for AWS Secret Manager to associate the newly generated credential with MSK. Note that `create_key` is called internally by `kafka_client.py` the first time you create one of these clients. Please wait a while (around 1 minute) and retry.
+
+### kafka.errors.KafkaTimeoutError: KafkaTimeoutError: Failed to update metadata after 60.0 secs.
+**Step 1: Verify Topic Creation and Access:**
+Before interacting with the producer/consumer, ensure that the topic has been successfully created and access is granted to you. Execute the following command:
+
+```python
+from diaspora_event_sdk import Client as GlobusClient
+c = GlobusClient()
+# topic = <the topic you want to use>
+print(c.register_topic(topic)) 
+```
+This should return a `status: no-op` message, indicating that the topic is already registered and accessible.
+
+**Step 2: Wait Automatic Key Creation in KafkaProducer and KafkaConsumer**
+`KafkaProducer` and `KafkaConsumer` would internally call `create_key` if the keys are not found locally (e.g., when you first authenticated with Globus). Behind the sence, the middle service contacts AWS to initialize the asynchronous process of creating and associating the secret. Please wait a while (around 1 minute) and retry.
+
+### ssl.SSLCertVerificationError
+This is commmon on MacOS system, see [this StackOverflow answer](https://stackoverflow.com/a/53310545).

{diaspora_event_sdk-0.0.13.dist-info → diaspora_event_sdk-0.0.16.dist-info}/RECORD

@@ -1,11 +1,11 @@
-diaspora_event_sdk/__init__.py,sha256=HecfCu-giI3bBGXcysQHmzkrX9wbwcXoU4k_uHeJWh0,540
-diaspora_event_sdk/version.py,sha256=SxvRes_80c-42zwvn5BXPvpGVs_EZ69FUEtUBF1k9Ts,23
+diaspora_event_sdk/__init__.py,sha256=ZMeMHPNphLB61jBsOO6kCRUtCWYBtvvNvl1QhwHvrqI,399
+diaspora_event_sdk/version.py,sha256=8ss7zPyQ3YfaQJw9IIGX35NOL7ASZ7-LErAxKnQDN7c,23
 diaspora_event_sdk/sdk/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 diaspora_event_sdk/sdk/_environments.py,sha256=UwzEeBVRuP7ZyqTJagNVA24EiCLuOYiy395q608AwQ0,358
-diaspora_event_sdk/sdk/client.py,sha256=DhUDtdkPRmn8P0fTXWg3x-Gn3p2J3ir0Ki7qeOFyp9I,3396
+diaspora_event_sdk/sdk/client.py,sha256=2KMUdnOEtSe1uV3rpRZHd5tLOFgC_fztzny1XxL4rh8,3496
 diaspora_event_sdk/sdk/decorators.py,sha256=Gel8AyhIjbf4-FNintTNcOqvC9hHH_YwbOH257Nfmf0,884
-diaspora_event_sdk/sdk/kafka_client.py,sha256=bfYKAAbgzRdeMK_gmr84n5653KYboWjO6F4BjgmWExs,1524
-diaspora_event_sdk/sdk/web_client.py,sha256=BgRza0fJudvgRCZ_P9BugFp57oYRWekpBf2KlZYFqUY,1305
+diaspora_event_sdk/sdk/kafka_client.py,sha256=uibvx41bpHP4dv-A2trmJKb2oovzH4FQ6FUBLC9DLlg,2122
+diaspora_event_sdk/sdk/web_client.py,sha256=RCXZhMtPBe53c4-MmyBiFIdqsmcTOnV3ashaaQHKMew,1325
 diaspora_event_sdk/sdk/login_manager/__init__.py,sha256=yeqVgjeHLMX0WZJu2feJmq-fbeXvSxWghVV81ygfY-w,239
 diaspora_event_sdk/sdk/login_manager/client_login.py,sha256=gvR4PkIqQpIywNieJQ_u11PHUmdLxQ0Ho-QgPSfu8bw,1798
 diaspora_event_sdk/sdk/login_manager/decorators.py,sha256=EFEp71d0oJ7vo2H8W7DJ2gPrDfGzeNXUNxri1C0l8h0,1047
@@ -17,8 +17,9 @@ diaspora_event_sdk/sdk/login_manager/tokenstore.py,sha256=7jRm01rzsbvniaCfYtDDWE
 diaspora_event_sdk/sdk/utils/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 diaspora_event_sdk/sdk/utils/uuid_like.py,sha256=xbxf0YXpDhdii16lwPLWRN21qFekHrNrqODSToMPtCg,470
 tests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-diaspora_event_sdk-0.0.13.dist-info/LICENSE,sha256=WNHhf_5RCaeuKWyq_K39vmp9F28LxKsB4SpomwSZ2L0,11357
-diaspora_event_sdk-0.0.13.dist-info/METADATA,sha256=9t_Y0HDrVPAW9R-4BvxuLI-bgmbh768TeoHpuCXt4l4,7061
-diaspora_event_sdk-0.0.13.dist-info/WHEEL,sha256=oiQVh_5PnQM0E3gPdiz09WCNmwiHDMaGer_elqB3coM,92
-diaspora_event_sdk-0.0.13.dist-info/top_level.txt,sha256=OVun-67t3fkLFEIwvJuNINgFFvAc--bClYhXjLhMmvs,25
-diaspora_event_sdk-0.0.13.dist-info/RECORD,,
+tests/unit/test_client.py,sha256=KjqXW7Mm3fm17lqhYdixL8s50z83F6g7MGKcOXJIyFc,2635
+diaspora_event_sdk-0.0.16.dist-info/LICENSE,sha256=WNHhf_5RCaeuKWyq_K39vmp9F28LxKsB4SpomwSZ2L0,11357
+diaspora_event_sdk-0.0.16.dist-info/METADATA,sha256=Hf_rvVt37hJn-iunRpkYO0pxP_gtJl_GbWdmXvTposs,8181
+diaspora_event_sdk-0.0.16.dist-info/WHEEL,sha256=oiQVh_5PnQM0E3gPdiz09WCNmwiHDMaGer_elqB3coM,92
+diaspora_event_sdk-0.0.16.dist-info/top_level.txt,sha256=OVun-67t3fkLFEIwvJuNINgFFvAc--bClYhXjLhMmvs,25
+diaspora_event_sdk-0.0.16.dist-info/RECORD,,

tests/unit/test_client.py

@@ -0,0 +1,80 @@
+import pytest
+from unittest.mock import Mock, patch
+from unittest.mock import MagicMock
+from diaspora_event_sdk import Client
+from diaspora_event_sdk.sdk.web_client import WebClient
+from diaspora_event_sdk.sdk.login_manager import LoginManager
+
+@pytest.fixture
+def mock_login_manager(): # TODO
+    login_manager = Mock(spec=LoginManager())
+    login_manager.get_web_client.return_value = Mock(spec=WebClient)
+    login_manager.get_auth_client.return_value = Mock(
+        oauth2_userinfo=lambda: {"sub": "test_sub"})
+    login_manager._token_storage.get_token_data.return_value = {
+        'access_key': 'test_access', 'secret_key': 'test_secret'}
+    login_manager.get_web_client.return_value.create_key.return_value = {
+        "status": "success", "access_key": "new_access", "secret_key": "new_secret"}
+
+    # Use MagicMock for _access_lock
+    login_manager._access_lock = MagicMock()
+
+    return login_manager
+
+
+@pytest.fixture
+def client(mock_login_manager):
+    return Client(login_manager=mock_login_manager)
+
+
+def test_init(mock_login_manager):
+    client = Client(login_manager=mock_login_manager)
+    assert client.login_manager == mock_login_manager
+
+
+def test_logout(client):
+    assert not client.login_manager.logout.called, "Verify test setup"
+    client.logout()
+    assert client.login_manager.logout.called
+
+
+def test_create_key(client):
+    result = client.create_key()
+    assert result == {"username": "test_sub", "password": "new_secret"}
+
+
+def test_retrieve_key_existing(client):
+    result = client.retrieve_key()
+    assert result == {"username": "test_sub", "password": "test_secret"}
+
+
+def test_retrieve_key_missing(client, mock_login_manager):
+    # Set up side_effect for get_token_data: None on first call, token data on the next
+    # the second call returns scope, resource_server, access_token, refresh_token, etc.
+    mock_login_manager._token_storage.get_token_data.side_effect = [
+        None,
+        {'scope': 'scope', 'resource_server': 'resource_server'}
+    ]
+
+    # should internally call create_key
+    result = client.retrieve_key()
+
+    assert result["username"] == "test_sub"
+    assert result["password"] == "new_secret"
+
+
+def test_list_topics(client):
+    client.list_topics()
+    client.web_client.list_topics.assert_called_with("test_sub")
+
+
+def test_register_topic(client):
+    topic = "test_topic"
+    client.register_topic(topic)
+    client.web_client.register_topic.assert_called_with("test_sub", topic)
+
+
+def test_unregister_topic(client):
+    topic = "test_topic"
+    client.unregister_topic(topic)
+    client.web_client.unregister_topic.assert_called_with("test_sub", topic)