diaspora-event-sdk 0.1.1__py3-none-any.whl → 0.1.2__py3-none-any.whl

diaspora_event_sdk/sdk/kafka_client.py

@@ -10,7 +10,7 @@ kafka_available = True
 try:
     from kafka import KafkaProducer as KProd  # type: ignore[import,import-not-found]
     from kafka import KafkaConsumer as KCons  # type: ignore[import,import-not-found]
-    from aws_msk_iam_sasl_signer import MSKAuthTokenProvider
+    from aws_msk_iam_sasl_signer import MSKAuthTokenProvider  # type: ignore[import,import-not-found]
     import os
 
     class MSKTokenProvider:
@@ -56,6 +56,7 @@ if kafka_available:
     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]

diaspora_event_sdk/sdk/login_manager/manager.py

@@ -22,7 +22,7 @@ log = logging.getLogger(__name__)
 def _get_diaspora_all_scope() -> str:
     return os.getenv(
         "DIASPORA_SCOPE",
-        f"https://auth.globus.org/scopes/{DIASPORA_RESOURCE_SERVER}/action_all"
+        f"https://auth.globus.org/scopes/{DIASPORA_RESOURCE_SERVER}/action_all",
     )
 
 
@@ -57,8 +57,7 @@ class LoginManager:
     }
 
     def __init__(self, *, environment: str | None = None) -> None:
-        self._token_storage = get_token_storage_adapter(
-            environment=environment)
+        self._token_storage = get_token_storage_adapter(environment=environment)
         self._access_lock = threading.Lock()
 
     @property

diaspora_event_sdk/sdk/web_client.py

@@ -7,7 +7,6 @@ from ._environments import TOKEN_EXCHANGE
 
 
 class WebClient(globus_sdk.BaseClient):
-
     def __init__(
         self,
         *,
@@ -25,13 +24,21 @@ 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("/v2/create_key", headers={"Subject": str(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("/v2/list_topics", headers={"Subject": str(subject)})
-
-    def register_topic(self, subject: UUID_LIKE_T, topic: str) -> globus_sdk.GlobusHTTPResponse:
-        return self.post("/v2/register_topic", headers={"Subject": str(subject), "Topic": topic})
-
-    def unregister_topic(self, subject: UUID_LIKE_T, topic: str) -> globus_sdk.GlobusHTTPResponse:
-        return self.post("/v2/unregister_topic", headers={"Subject": str(subject), "Topic": topic})
+        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": 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": str(subject), "Topic": topic}
+        )

diaspora_event_sdk/version.py

@@ -1 +1 @@
-__version__ = "0.1.1"
+__version__ = "0.1.2"

diaspora_event_sdk-0.1.2.dist-info/METADATA

@@ -0,0 +1,47 @@
+Metadata-Version: 2.1
+Name: diaspora-event-sdk
+Version: 0.1.2
+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
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: globus-sdk <4,>=3.20.1
+Provides-Extra: kafka-python
+Requires-Dist: kafka-python ; extra == 'kafka-python'
+Requires-Dist: aws-msk-iam-sasl-signer-python ; extra == 'kafka-python'
+Provides-Extra: test
+Requires-Dist: pytest ; extra == 'test'
+Requires-Dist: pytest-cov ; extra == 'test'
+Requires-Dist: coverage ; extra == 'test'
+Requires-Dist: mypy ; extra == 'test'
+Requires-Dist: tox ; extra == 'test'
+Requires-Dist: check-manifest ; extra == 'test'
+
+# Diaspora: Resilience-enabling services for science from HPC to edge
+
+## Event Fabric SDK Installation Guide
+### Recommended Method: Use with `kafka-python`
+For easy integration with Diaspora Event Fabric, use the `KafkaProducer` and `KafkaConsumer` classes from our SDK. This requires the `kafka-python` library.
+
+To install the Event Fabric SDK and `kafka-python,` with the following command:
+```bash
+pip install "diaspora-event-sdk[kafka-python]"
+```
+
+### Alternative Installation: Without Kafka Client Library
+To use alternative Kafka client libraries (e.g., `confluent-kafka-python`, `aiokafka`, and libraries for other programming laguages), you can install the SDK without the `kafka-python` dependency. This option still provides topic-level access control (authorization) and login credential management features.
+
+To install the SDK without `kafka-python`, use:
+```bash
+pip install diaspora-event-sdk
+```
+Note: This method does not include dependencies for `KafkaProducer` and `KafkaConsumer` classes mentioned in the QuickStart
+
+## Use Diaspora Event Fabric SDK
+
+**Getting Started**: Visit our [QuickStart Guide](docs/quickstart.md) for details on using the SDK with the kafka-python library and instructions for other Kafka clients.
+
+**Troubleshooting and Credential Management**: Consult our [TrobleShooting Guide](docs/troubleshooting.md) for solving common issues and tips on managing keys effectively.
+
+**Advanced Usage**: Explore the [Faust Streaming Guide](docs/faust_weather_app.md) for advanced event streaming with Faust.

{diaspora_event_sdk-0.1.1.dist-info → diaspora_event_sdk-0.1.2.dist-info}/RECORD

@@ -1,25 +1,25 @@
 diaspora_event_sdk/__init__.py,sha256=v8IN3-WFpliakQKru8TAcmQ4IRdvRe_m9-abSDnGIFM,457
-diaspora_event_sdk/version.py,sha256=rnObPjuBcEStqSO0S6gsdS_ot8ITOQjVj_-P1LUUYpg,22
+diaspora_event_sdk/version.py,sha256=YvuYzWnKtqBb-IqG8HAu-nhIYAsgj9Vmc_b9o7vO-js,22
 diaspora_event_sdk/sdk/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 diaspora_event_sdk/sdk/_environments.py,sha256=Xeuzqnx1aGou01vsXgGwQkWhgIe3-PRgbOr1o5mZ3Mk,203
 diaspora_event_sdk/sdk/client.py,sha256=ucv2C-bWzwTTORNJuWpVpki6pNvUYPA1IXKX2GAmh2M,4999
 diaspora_event_sdk/sdk/decorators.py,sha256=Gel8AyhIjbf4-FNintTNcOqvC9hHH_YwbOH257Nfmf0,884
-diaspora_event_sdk/sdk/kafka_client.py,sha256=k0tDxHKFm6r7TODCfb3XyJSa6jNPHPo1kVPF2luMyLc,4319
-diaspora_event_sdk/sdk/web_client.py,sha256=hPeqlq2XFL1sYZtN2qsi7d-dCRJ7jjSUBBguzGcrEyc,1325
+diaspora_event_sdk/sdk/kafka_client.py,sha256=G1kQQz2TWlahdd2TDdpvaQW7HD7gsuQCnr0tks54ISw,4361
+diaspora_event_sdk/sdk/web_client.py,sha256=ryvirr0sz0sF5YvQl50mWpw-1tnK-d5f8eAKvClEYSk,1396
 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
 diaspora_event_sdk/sdk/login_manager/globus_auth.py,sha256=9Hymp0tv91OI5dBMUgh4rGv_5xLVLhFEK7Hu0t8CJFQ,389
 diaspora_event_sdk/sdk/login_manager/login_flow.py,sha256=2TodgsvlEYPoZPQPkp6FHOC9IkSM07pS7MIVGS4MZNE,954
-diaspora_event_sdk/sdk/login_manager/manager.py,sha256=uJHosI7ipqGt5KiL-iv2IGB4bNyZ6jQZQi7g4ka0pts,7052
+diaspora_event_sdk/sdk/login_manager/manager.py,sha256=AD3f8rx154oesgkpqG0K-eZsEGjntr08Vgrxr1m6uao,7040
 diaspora_event_sdk/sdk/login_manager/protocol.py,sha256=RCuo2jy_XkpZvbxnKlDfTKs-L6b9_8_JR-Kq9wHwhoM,710
 diaspora_event_sdk/sdk/login_manager/tokenstore.py,sha256=Kq0IZGf9G9dE44yoyUZInod5xL_8caN9OugeTK6GBGg,2094
 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
-tests/unit/test_client.py,sha256=KjqXW7Mm3fm17lqhYdixL8s50z83F6g7MGKcOXJIyFc,2635
-diaspora_event_sdk-0.1.1.dist-info/LICENSE,sha256=WNHhf_5RCaeuKWyq_K39vmp9F28LxKsB4SpomwSZ2L0,11357
-diaspora_event_sdk-0.1.1.dist-info/METADATA,sha256=JOKh9Pc_eGy96RXmwELcttejLJ1m2zWBHVQkeu_QK-8,2180
-diaspora_event_sdk-0.1.1.dist-info/WHEEL,sha256=oiQVh_5PnQM0E3gPdiz09WCNmwiHDMaGer_elqB3coM,92
-diaspora_event_sdk-0.1.1.dist-info/top_level.txt,sha256=OVun-67t3fkLFEIwvJuNINgFFvAc--bClYhXjLhMmvs,25
-diaspora_event_sdk-0.1.1.dist-info/RECORD,,
+tests/unit/test_client.py,sha256=alUC-XTRQn_Oz0RvmzXTal-ciSVtCpx5jm3NuStkt1E,2995
+diaspora_event_sdk-0.1.2.dist-info/LICENSE,sha256=WNHhf_5RCaeuKWyq_K39vmp9F28LxKsB4SpomwSZ2L0,11357
+diaspora_event_sdk-0.1.2.dist-info/METADATA,sha256=TZwWZMDSreUPJGvBeh3_wt8Z5TO5_xmfvjredJPL-DM,2307
+diaspora_event_sdk-0.1.2.dist-info/WHEEL,sha256=oiQVh_5PnQM0E3gPdiz09WCNmwiHDMaGer_elqB3coM,92
+diaspora_event_sdk-0.1.2.dist-info/top_level.txt,sha256=OVun-67t3fkLFEIwvJuNINgFFvAc--bClYhXjLhMmvs,25
+diaspora_event_sdk-0.1.2.dist-info/RECORD,,

tests/unit/test_client.py

@@ -1,20 +1,31 @@
 import pytest
-from unittest.mock import Mock, patch
+from unittest.mock import Mock
 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
+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"})
+        oauth2_userinfo=lambda: {"sub": "test_sub"}
+    )
     login_manager._token_storage.get_token_data.return_value = {
-        'access_key': 'test_access', 'secret_key': 'test_secret'}
+        "username": "test_sub",
+        "access_key": "test_access",
+        "secret_key": "test_secret",
+        "endpoint": "test_endpoint",
+    }
     login_manager.get_web_client.return_value.create_key.return_value = {
-        "status": "success", "access_key": "new_access", "secret_key": "new_secret"}
+        "status": "success",
+        "username": "test_sub",
+        "access_key": "new_access",
+        "secret_key": "new_secret",
+        "endpoint": "new_endpoint",
+    }
 
     # Use MagicMock for _access_lock
     login_manager._access_lock = MagicMock()
@@ -40,12 +51,20 @@ def test_logout(client):
 
 def test_create_key(client):
     result = client.create_key()
-    assert result == {"username": "test_sub", "password": "new_secret"}
+    assert result == {
+        "access_key": "new_access",
+        "secret_key": "new_secret",
+        "endpoint": "new_endpoint",
+    }
 
 
 def test_retrieve_key_existing(client):
     result = client.retrieve_key()
-    assert result == {"username": "test_sub", "password": "test_secret"}
+    assert result == {
+        "access_key": "test_access",
+        "secret_key": "test_secret",
+        "endpoint": "test_endpoint",
+    }
 
 
 def test_retrieve_key_missing(client, mock_login_manager):
@@ -53,14 +72,15 @@ def test_retrieve_key_missing(client, mock_login_manager):
     # 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'}
+        {"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"
+    assert result["access_key"] == "new_access"
+    assert result["secret_key"] == "new_secret"
+    assert result["endpoint"] == "new_endpoint"
 
 
 def test_list_topics(client):

diaspora_event_sdk-0.1.1.dist-info/METADATA

@@ -1,47 +0,0 @@
-Metadata-Version: 2.1
-Name: diaspora-event-sdk
-Version: 0.1.1
-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
-Description-Content-Type: text/markdown
-License-File: LICENSE
-Requires-Dist: globus-sdk <4,>=3.20.1
-Provides-Extra: kafka-python
-Requires-Dist: kafka-python ; extra == 'kafka-python'
-Requires-Dist: aws-msk-iam-sasl-signer-python ; extra == 'kafka-python'
-Provides-Extra: test
-Requires-Dist: pytest ; extra == 'test'
-Requires-Dist: pytest-cov ; extra == 'test'
-Requires-Dist: coverage ; extra == 'test'
-Requires-Dist: mypy ; extra == 'test'
-Requires-Dist: tox ; extra == 'test'
-Requires-Dist: check-manifest ; extra == 'test'
-
-<h1>Diaspora Event Fabric: Resilience-enabling services for science from HPC to edge</h1>
-
-## Installation
-### Recommended Installation with Kafka Client Library
-The `KafkaProducer` and `KafkaConsumer` classes within the SDK are designed for seamless integration with Diaspora Event Fabric using pre-configured settings. For utilizing these classes, the `kafka-python` library is necessary.
-
-To install the Diaspora Event SDK along with `kafka-python,` execute:
-```bash
-pip install "diaspora-event-sdk[kafka-python]"
-```
-
-### Installation Without Kafka Client Library
-If you prefer using different client libraries for Kafka communication, you can install the SDK without the kafka-python dependency. The SDK still serves for topic-level access control (authorization) and login credential management (authentication).
-
-To install the SDK without client libraries, simply run:
-```bash
-pip install diaspora-event-sdk
-```
-Note: This does not install the necessary dependency for `KafkaProducer` and `KafkaConsumer` classes.
-
-## Use Diaspora Event Fabric SDK
-
-Please refer to our [QuickStart Guide](docs/quickstart.md) for recommended use with `kafka-python` library as well as steps to use your own Kafka client.
-
-Please refer to our [TrobleShooting Guide](docs/troubleshooting.md) for debugging common problems and effective key management strategies.
-
-[Topic: Use faust to Process Records](docs/faust_weather_app.md)