feat: Pass client instead of Seam instance to subclasses, update project structure (#63)

* Bump generator to 1.10.1

* ci: Generate code

* Fix tests

* Bump generator to 1.10.2

* ci: Generate code

* Remove unnecessary import

* Bump generator to 1.10.3 to fix circular imports with a separate file options.py

* ci: Generate code

* Add SeamMultiWorkspace

* Add constants.py

* Add get_endpoint helper fn

* Add RequestMixin to define common make_request method

* ci: Format code

* Disable generate workflow

* Add abstract classes, add helper for getting PAT, fix create ws test

* Enforce keyword only args in WorkspacesProxy methods

* Define WorkspacesProxy outside SeamMultiWorkspace

* Fix proxy class usage

* Add SeamHttpClient class

* Adjust the routest to test new requests.Session

* Remove .yalc files

* Remove yalc.lock

* Update seam http client to inherit from requests.Session with custom response handling

* Remove endpoint rfom route clients as it's baked in the http client

* Mark certain files as not generated

* Fix client_options default value to fix linting

* Remove AbstractRequestMixin

* Swap requests for niquests

* Uncomment innit imports

* Remove duplicat SeamApiException definition

* Add docstring for client and client_options

* Revert generate-routes script

* Revert package.json

* Add AbstractSeamHttpClient

* Update client_options docstring

* Add seam/exceptions.py

* Bump generator to 1.11.1 to update imports and structure

* Update generator's tarball link

* ci: Generate code

* Add deep_attr_dict to /seam/utils

* Renam types.py to models.py

* Update top level imports

* Remove seam/types.py, use seam/models.py

* Update test/events/test_events.py import

* Update response type on SeamApiException

* Move SeamApiException to exceptions.py and update imports

* Update imports in tests

* More relative imports

* Pass client and defaults to subclasses instead of seam instance

* ci: Format code

* Define routes on seam instance, update some imports

* Update resolve_action_attempt import

* Rename lib to modules

* Update readme

* Update imports

* Remove client and client_options

* Remove request.py

* Bump generator, enable generation

* ci: Generate code

* Remove duplicate import

---------

Co-authored-by: Seam Bot <devops@getseam.com>

Author: andrii-balitskyi

README.rst

@@ -66,7 +66,7 @@ Unlock a door
 
   seam = Seam()
   lock = seam.locks.get(name="Front Door")
-  seam.locks.unlock_door(device_id="lock.device_id")
+  seam.locks.unlock_door(device_id=lock.device_id)
 
 Authentication Method
 ~~~~~~~~~~~~~~~~~~~~~

package-lock.json

@@ -8,7 +8,7 @@
     "format": "prettier --write --ignore-path .gitignore ."
   },
   "devDependencies": {
-    "@seamapi/nextlove-sdk-generator": "^1.11.3",
+    "@seamapi/nextlove-sdk-generator": "1.12.0",
     "@seamapi/types": "1.172.0",
     "del": "^7.1.0",
     "prettier": "^3.2.5"

package.json

@@ -2,11 +2,11 @@
 # type: ignore
 
 from .seam import Seam
-from .types import SeamHttpApiError
 from .seam_multi_workspace import SeamMultiWorkspace
 from .options import SeamHttpInvalidOptionsError
 from .auth import SeamHttpInvalidTokenError
-from .routes.action_attempts import (
+from .exceptions import (
+    SeamHttpApiError,
     SeamActionAttemptError,
     SeamActionAttemptFailedError,
     SeamActionAttemptTimeoutError,

seam/__init__.py

@@ -1,10 +1,10 @@
 from typing import Optional
-from seam.options import (
+from .options import (
     SeamHttpInvalidOptionsError,
     is_seam_http_options_with_api_key,
     is_seam_http_options_with_personal_access_token,
 )
-from seam.token import (
+from .token import (
     is_jwt,
     is_access_token,
     is_client_session_token,

seam/auth.py

@@ -3,8 +3,9 @@
 import niquests as requests
 from importlib.metadata import version
 
-from seam.constants import LTS_VERSION
-from seam.types import AbstractSeamHttpClient, SeamHttpApiError
+from .constants import LTS_VERSION
+from .exceptions import SeamHttpApiError
+from .models import AbstractSeamHttpClient
 
 SDK_HEADERS = {
     "seam-sdk-name": "seamapi/python",

seam/client.py

@@ -0,0 +1,43 @@
+from niquests import Response
+from .routes.models import ActionAttempt
+
+
+# HTTP
+class SeamHttpApiError(Exception):
+    def __init__(
+        self,
+        response: Response,
+    ):
+        self.status_code = response.status_code
+        self.request_id = response.headers.get("seam-request-id", None)
+
+        self.metadata = None
+        if "application/json" in response.headers["content-type"]:
+            parsed_response = response.json()
+            self.metadata = parsed_response.get("error", None)
+
+        super().__init__(
+            f"SeamApiException: status={self.status_code}, request_id={self.request_id}, metadata={self.metadata}"
+        )
+
+
+# Action Attempt
+class SeamActionAttemptError(Exception):
+    def __init__(self, message: str, action_attempt: ActionAttempt):
+        super().__init__(message)
+        self.name = self.__class__.__name__
+        self.action_attempt = action_attempt
+
+
+class SeamActionAttemptFailedError(SeamActionAttemptError):
+    def __init__(self, action_attempt: ActionAttempt):
+        super().__init__(action_attempt.error.message, action_attempt)
+        self.name = self.__class__.__name__
+        self.code = action_attempt.error.type
+
+
+class SeamActionAttemptTimeoutError(SeamActionAttemptError):
+    def __init__(self, action_attempt: ActionAttempt, timeout: str):
+        message = f"Timed out waiting for action attempt after {timeout}s"
+        super().__init__(message, action_attempt)
+        self.name = self.__class__.__name__

seam/exceptions.py

@@ -3,25 +3,7 @@
 from typing_extensions import Self
 import abc
 
-from seam.routes.types import AbstractRoutes, Workspace
-
-
-class SeamHttpApiError(Exception):
-    def __init__(
-        self,
-        response,
-    ):
-        self.status_code = response.status_code
-        self.request_id = response.headers.get("seam-request-id", None)
-
-        self.metadata = None
-        if "application/json" in response.headers["content-type"]:
-            parsed_response = response.json()
-            self.metadata = parsed_response.get("error", None)
-
-        super().__init__(
-            f"SeamHttpApiError: status={self.status_code}, request_id={self.request_id}, metadata={self.metadata}"
-        )
+from .routes.models import AbstractRoutes, Workspace
 
 
 class AbstractSeamHttpClient(abc.ABC):
@@ -40,7 +22,7 @@ def _handle_response(self, response: requests.Response):
 
 class AbstractSeam(AbstractRoutes):
     lts_version: str
-    wait_for_action_attempt: Optional[Union[bool, Dict[str, float]]]
+    defaults: Dict[str, Any]
 
     @abc.abstractmethod
     def __init__(

seam/types.py seam/models.pyseam/types.py renamed to seam/models.py

@@ -0,0 +1,67 @@
+from typing import Dict, Optional, Union
+import time
+
+from ..client import SeamHttpClient
+from ..exceptions import SeamActionAttemptFailedError, SeamActionAttemptTimeoutError
+from ..routes.models import ActionAttempt
+
+TIMEOUT = 5.0
+POLLING_INTERVAL = 0.5
+
+
+def get_action_attempt(client: SeamHttpClient, action_attempt_id: str) -> ActionAttempt:
+    res = client.post(
+        "/action_attempts/get", json={"action_attempt_id": action_attempt_id}
+    )
+
+    return ActionAttempt.from_dict(res["action_attempt"])
+
+
+def poll_until_ready(
+    client: SeamHttpClient,
+    *,
+    action_attempt_id: str,
+    timeout: Optional[float] = TIMEOUT,
+    polling_interval: Optional[float] = POLLING_INTERVAL
+) -> ActionAttempt:
+    time_waiting = 0.0
+
+    action_attempt = get_action_attempt(client, action_attempt_id)
+
+    while action_attempt.status == "pending":
+        time.sleep(polling_interval)
+        time_waiting += polling_interval
+
+        if time_waiting > timeout:
+            raise SeamActionAttemptTimeoutError(action_attempt, timeout)
+
+        action_attempt = get_action_attempt(client, action_attempt_id)
+
+    if action_attempt.status == "failed":
+        raise SeamActionAttemptFailedError(action_attempt)
+
+    return action_attempt
+
+
+def resolve_action_attempt(
+    client: SeamHttpClient,
+    *,
+    action_attempt: ActionAttempt,
+    wait_for_action_attempt: Optional[Union[bool, Dict[str, float]]] = None
+) -> ActionAttempt:
+    if wait_for_action_attempt is True:
+        return poll_until_ready(
+            client=client, action_attempt_id=action_attempt.action_attempt_id
+        )
+
+    if isinstance(wait_for_action_attempt, dict):
+        return poll_until_ready(
+            client=client,
+            action_attempt_id=action_attempt.action_attempt_id,
+            timeout=wait_for_action_attempt.get("timeout", TIMEOUT),
+            polling_interval=wait_for_action_attempt.get(
+                "polling_interval", POLLING_INTERVAL
+            ),
+        )
+
+    return action_attempt

seam/modules/action_attempts.py

@@ -1,7 +1,7 @@
 import os
 from typing import Optional
 
-from seam.constants import DEFAULT_ENDPOINT
+from .constants import DEFAULT_ENDPOINT
 
 
 def get_endpoint(endpoint: Optional[str] = None):