diaspora-event-sdk 0.2.0__py3-none-any.whl → 0.2.2__py3-none-any.whl

diaspora_event_sdk/sdk/client.py

@@ -37,7 +37,7 @@ class Client:
     @requires_login
     def create_key(self):
         """
-        Invalidate previous keys (if any) and generate a new one
+        Revokes existing keys, generates a new key, and updates the token storage with the newly created key and the Diaspora endpoint.
         """
         resp = self.web_client.create_key(self.subject_openid)
         if resp["status"] == "error":
@@ -70,7 +70,7 @@ class Client:
     @requires_login
     def retrieve_key(self):
         """
-        Attempt to retrieve the key from local token storage, and call create_key if local key is not found
+        Retrieves the key from local token storage, and calls create_key() if the local key is not found.
         """
         tokens = self.login_manager._token_storage.get_token_data(
             DIASPORA_RESOURCE_SERVER
@@ -114,83 +114,85 @@ class Client:
     @requires_login
     def list_topics(self):
         """
-        Retrieves the list of topics associated with the user's OpenID.
+        Returns a list of topics currently registered under the user's account.
         """
         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 the user's account with permissions to read, write, and describe the topic.
         """
         return self.web_client.register_topic(self.subject_openid, topic, "register")
 
     @requires_login
     def unregister_topic(self, topic):
         """
-        Unregisters a topic from the user's OpenID.
+        Unregisters a topic from a user's account, but all existing events within the topic are unaffected.
         """
         return self.web_client.register_topic(self.subject_openid, topic, "unregister")
 
     @requires_login
     def get_topic_configs(self, topic):
         """
-        Get topic configurations.
+        Retrieves the current configurations for a registered topic.
         """
         return self.web_client.get_topic_configs(self.subject_openid, topic)
 
     @requires_login
     def update_topic_configs(self, topic, configs):
         """
-        Set topic configurations.
+        Updates the configurations for a registered topic.
         """
         return self.web_client.update_topic_configs(self.subject_openid, topic, configs)
 
     @requires_login
     def update_topic_partitions(self, topic, new_partitions):
         """
-        Adjust topic number of partitions
+        Increases the number of partitions for a given topic to the specified new partition count.
         """
         return self.web_client.update_topic_partitions(self.subject_openid, topic, new_partitions)
 
     @requires_login
     def grant_user_access(self, topic, user):
         """
-        Registers a new topic under the user's OpenID.
+        Authorizes another user to access a registered topic under the invoker's account.
         """
         return self.web_client.grant_user_access(self.subject_openid, topic, user, "grant")
 
     @requires_login
     def revoke_user_access(self, topic, user):
         """
-        Unregisters a topic from the user's OpenID.
+        Removes access permissions for another user from a registered topic under the invoker's account.
         """
         return self.web_client.grant_user_access(self.subject_openid, topic, user, "revoke")
 
     @requires_login
     def list_triggers(self):
         """
-        Retrieves the list of functions associated with the user's OpenID.
+        Retrieves a list of triggers associated created under the user's account, showing each trigger's configurations and UUID.
         """
         return self.web_client.list_triggers(self.subject_openid)
 
     @requires_login
-    def create_trigger(self, topic, function, function_configs):
+    def create_trigger(self, topic, function, function_configs, trigger_configs):
         """
-        Registers a new functions under the user's OpenID.
+        Creates a new trigger under the user's account with specific function and invocation configurations. 
         """
-        return self.web_client.create_trigger(self.subject_openid, topic, function, "create", function_configs)
+        return self.web_client.create_trigger(
+            self.subject_openid, topic, function, "create", function_configs, trigger_configs)
 
     @requires_login
     def delete_trigger(self, topic, function):
         """
-        Unregisters a functions from the user's OpenID.
+        Deletes a trigger and related AWS resources, while the associated topic remains unaffected.
         """
-        return self.web_client.create_trigger(self.subject_openid, topic, function, "delete", {})
+        return self.web_client.create_trigger(
+            self.subject_openid, topic, function, "delete", {}, {})
 
     @requires_login
     def update_trigger(self, trigger_uuid, trigger_configs):
         """
-        Update a functions's trigger'.
+        Updates invocation configurations of an existing trigger, identified by its unique trigger UUID.
         """
         return self.web_client.update_trigger(self.subject_openid, trigger_uuid, trigger_configs)

diaspora_event_sdk/sdk/login_manager/client_login.py

@@ -1,7 +1,7 @@
 """
-Logic for using client identities with the Diaspora Event SDK
+Logic for using client identities with the Diaspora SDK
 
-This is based on the Globus CLI client login:
+The design is based on the Globus CLI client login:
 https://github.com/globus/globus-cli/blob/main/src/globus_cli/login_manager/client_login.py
 """
 from __future__ import annotations
@@ -9,13 +9,14 @@ from __future__ import annotations
 import logging
 import os
 import uuid
+from typing import Union
 
 import globus_sdk
 
 log = logging.getLogger(__name__)
 
 
-def _get_client_creds_from_env() -> tuple[str | None, str | None]:
+def _get_client_creds_from_env() -> tuple[Union[str, None], Union[str, None]]:
     client_id = os.getenv("DIASPORA_SDK_CLIENT_ID")
     client_secret = os.getenv("DIASPORA_SDK_CLIENT_SECRET")
     return client_id, client_secret

diaspora_event_sdk/sdk/login_manager/globus_auth.py

@@ -3,14 +3,14 @@ import os
 import globus_sdk
 
 
-def internal_auth_client():
+def internal_auth_client() -> globus_sdk.NativeAppAuthClient:
     """
-    This is the client that represents the Diaspora Event Fabric application itself
+    This is the client that represents the Diaspora Event Fabric application itself.
     """
 
-    client_id = os.environ.get(
+    client_id: str = os.environ.get(
         "DIASPORA_SDK_CLIENT_ID", "c5d4fab4-7f0d-422e-b0c8-5c74329b52fe"
     )
     return globus_sdk.NativeAppAuthClient(
         client_id, app_name="Diaspora Event Fabric (internal client)"
-    )
+    )

diaspora_event_sdk/sdk/login_manager/login_flow.py

@@ -1,11 +1,12 @@
 from __future__ import annotations
 
 import platform
+from typing import List
 
 from .globus_auth import internal_auth_client
 
 
-def do_link_auth_flow(scopes: list[str]):
+def do_link_auth_flow(scopes: List[str]):
     auth_client = internal_auth_client()
 
     # start the Confidential App Grant flow
@@ -31,4 +32,4 @@ def do_link_auth_flow(scopes: list[str]):
     auth_code = input("Enter the resulting Authorization Code here: ").strip()
 
     # finish auth flow
-    return auth_client.oauth2_exchange_code_for_tokens(auth_code)
+    return auth_client.oauth2_exchange_code_for_tokens(auth_code)

diaspora_event_sdk/sdk/web_client.py

@@ -33,7 +33,8 @@ class WebClient(globus_sdk.BaseClient):
         self, subject: UUID_LIKE_T, topic: str, action: str
     ) -> globus_sdk.GlobusHTTPResponse:
         return self.put(
-            f"/api/v2/topic/{topic}", headers={"Subject": str(subject), "Action": action}
+            f"/api/v2/topic/{topic}",
+            headers={"Subject": str(subject), "Action": action}
         )
 
     def get_topic_configs(
@@ -41,8 +42,7 @@ class WebClient(globus_sdk.BaseClient):
     ) -> globus_sdk.GlobusHTTPResponse:
         return self.get(
             f"/api/v2/topic/{topic}",
-            headers={"Subject": str(subject), "Topic": topic},
-            # data=json.dumps(configs).encode("utf-8")
+            headers={"Subject": str(subject), "Topic": topic}
         )
 
     def update_topic_configs(
@@ -61,7 +61,7 @@ class WebClient(globus_sdk.BaseClient):
         return self.post(
             f"/api/v2/topic/{topic}/partitions",
             headers={"Subject": str(subject), "Topic": topic,
-                     "NewPartitions": str(new_partitions)},
+                     "NewPartitions": str(new_partitions)}
         )
 
     def grant_user_access(
@@ -78,14 +78,15 @@ class WebClient(globus_sdk.BaseClient):
 
     def create_trigger(
         self, subject: UUID_LIKE_T, topic: str, function: str, action: str,
-        function_configs: dict
+        function_configs: dict, trigger_configs: dict
     ) -> globus_sdk.GlobusHTTPResponse:
         return self.put(
             "/api/v2/trigger",
             headers={"Subject": str(subject), "Topic": topic,
                      "Trigger": function, "Action": action,
                      "Content-Type": "text/plain"},
-            data=json.dumps(function_configs).encode("utf-8")
+            data=json.dumps({"function": function_configs,
+                             "trigger": trigger_configs}).encode("utf-8")
         )
 
     def update_trigger(

diaspora_event_sdk/version.py

@@ -1 +1 @@
-__version__ = "0.2.0"
+__version__ = "0.2.2"

{diaspora_event_sdk-0.2.0.dist-info → diaspora_event_sdk-0.2.2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: diaspora-event-sdk
-Version: 0.2.0
+Version: 0.2.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

{diaspora_event_sdk-0.2.0.dist-info → diaspora_event_sdk-0.2.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=Zn1KFblwuFHiDRdRAiRnDBRkbPttWh44jKa5zG2ov0E,22
+diaspora_event_sdk/version.py,sha256=m6kyaNpwBcP1XYcqrelX2oS3PJuOnElOcRdBa9pEb8c,22
 diaspora_event_sdk/sdk/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 diaspora_event_sdk/sdk/_environments.py,sha256=QyQA7dV4goUKUoxAoaes8OGv0xKxz2qiFBHNGr-vQNA,204
-diaspora_event_sdk/sdk/client.py,sha256=kEgcxdi2bwHXD1sVFZUZflPf9RD6FRhXteoe5A20n9s,6834
+diaspora_event_sdk/sdk/client.py,sha256=hsnlG8dheTSLhWgfrsvnw3xw8QQKQXuqnBoTEXOm218,7503
 diaspora_event_sdk/sdk/decorators.py,sha256=Gel8AyhIjbf4-FNintTNcOqvC9hHH_YwbOH257Nfmf0,884
 diaspora_event_sdk/sdk/kafka_client.py,sha256=G1kQQz2TWlahdd2TDdpvaQW7HD7gsuQCnr0tks54ISw,4361
-diaspora_event_sdk/sdk/web_client.py,sha256=6hijsiTF23miM3u2n6MRS4mQANi09M-5IKtlaTZjDqA,3630
+diaspora_event_sdk/sdk/web_client.py,sha256=5GWp9vjM79MJdfeP-JnMGgIJfQEalDN2J4qEK4LIkJg,3679
 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/client_login.py,sha256=8ild28_cgPSrLtg3Jhmzpg3EymAvH2UdAhKY52oOB_c,1835
 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/globus_auth.py,sha256=pbDy67Mdf4SKFf0IlXD3ZFGj4lG-xpzFTD1ygW-0H1k,430
+diaspora_event_sdk/sdk/login_manager/login_flow.py,sha256=6Vi_e3rACYdv4TRXPAvUv5xivCRkCo4DS841Ixu_r24,977
 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=alUC-XTRQn_Oz0RvmzXTal-ciSVtCpx5jm3NuStkt1E,2995
-diaspora_event_sdk-0.2.0.dist-info/LICENSE,sha256=WNHhf_5RCaeuKWyq_K39vmp9F28LxKsB4SpomwSZ2L0,11357
-diaspora_event_sdk-0.2.0.dist-info/METADATA,sha256=FeRpsTvBPF-kkWAXLGiHj8PeWNKLEE8PV_nbotQPXzg,2505
-diaspora_event_sdk-0.2.0.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
-diaspora_event_sdk-0.2.0.dist-info/top_level.txt,sha256=OVun-67t3fkLFEIwvJuNINgFFvAc--bClYhXjLhMmvs,25
-diaspora_event_sdk-0.2.0.dist-info/RECORD,,
+tests/unit/test_client.py,sha256=sJUtPmnNGnohnP38RQrwcJ4D5j3-g1WFQ6gaKf520AQ,3019
+diaspora_event_sdk-0.2.2.dist-info/LICENSE,sha256=WNHhf_5RCaeuKWyq_K39vmp9F28LxKsB4SpomwSZ2L0,11357
+diaspora_event_sdk-0.2.2.dist-info/METADATA,sha256=OkO4eq9tmvIM_0W0sqG7zrL-lpRlrrkON6brr2D4LCc,2505
+diaspora_event_sdk-0.2.2.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
+diaspora_event_sdk-0.2.2.dist-info/top_level.txt,sha256=OVun-67t3fkLFEIwvJuNINgFFvAc--bClYhXjLhMmvs,25
+diaspora_event_sdk-0.2.2.dist-info/RECORD,,

tests/unit/test_client.py

@@ -91,10 +91,10 @@ def test_list_topics(client):
 def test_register_topic(client):
     topic = "test_topic"
     client.register_topic(topic)
-    client.web_client.register_topic.assert_called_with("test_sub", topic)
+    client.web_client.register_topic.assert_called_with("test_sub", topic, "register")
 
 
 def test_unregister_topic(client):
     topic = "test_topic"
     client.unregister_topic(topic)
-    client.web_client.unregister_topic.assert_called_with("test_sub", topic)
+    client.web_client.register_topic.assert_called_with("test_sub", topic, "unregister")