python-terminusgps 1.11.0__tar.gz → 1.13.0__tar.gz

{python_terminusgps-1.11.0 → python_terminusgps-1.13.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-terminusgps
-Version: 1.11.0
+Version: 1.13.0
 Summary: Provides abstractions/utilities for working with Wialon API, Authorize.NET API, AWS API, and more.
 Project-URL: Documentation, https://app.terminusgps.com/docs/apps/python-terminusgps/index.html
 Project-URL: Repository, https://github.com/terminusgps/python-terminusgps

{python_terminusgps-1.11.0 → python_terminusgps-1.13.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "python-terminusgps"
-version = "1.11.0"
+version = "1.13.0"
 description = "Provides abstractions/utilities for working with Wialon API, Authorize.NET API, AWS API, and more."
 readme = "README.md"
 authors = [ {name = "Blake Nall", email = "blake@terminusgps.com" } ]

{python_terminusgps-1.11.0 → python_terminusgps-1.13.0}/terminusgps/wialon/errors.py

@@ -19,18 +19,6 @@ class WialonLoginError(WialonBaseError):
         return super().__init__(message, wialon_err)
 
 
-class WialonSessionDuplicationError(WialonBaseError):
-    def __init__(
-        self,
-        session_id: str | None,
-        wialon_err: WialonError | AssertionError | None = None,
-    ) -> None:
-        message = f"Failed to duplicate the Wialon session: '#{session_id}'\n"
-        if wialon_err:
-            message += str(wialon_err)
-        return super().__init__(message, wialon_err)
-
-
 class WialonLogoutError(WialonBaseError):
     def __init__(
         self, session_id: str, wialon_err: WialonError | AssertionError | None = None
@@ -39,15 +27,3 @@ class WialonLogoutError(WialonBaseError):
         if wialon_err:
             message += str(wialon_err)
         return super().__init__(message, wialon_err)
-
-
-class WialonSessionInvalidError(WialonBaseError):
-    def __init__(
-        self,
-        session_id: str | None,
-        wialon_err: WialonError | AssertionError | None = None,
-    ) -> None:
-        message = f"The session was invalid/expired: '{session_id}'\n"
-        if wialon_err:
-            message += str(wialon_err)
-        return super().__init__(message, wialon_err)

{python_terminusgps-1.11.0 → python_terminusgps-1.13.0}/terminusgps/wialon/items/resource.py

@@ -1,5 +1,6 @@
 from terminusgps.wialon import flags
 from terminusgps.wialon.items.base import WialonBase
+from terminusgps.wialon.session import WialonSession
 
 
 class WialonResource(WialonBase):
@@ -22,24 +23,59 @@ class WialonResource(WialonBase):
 
     @property
     def is_account(self) -> bool:
+        """
+        Whether or not the resource is an account.
+
+        :type: :py:obj:`bool`
+
+        """
         response = self.session.wialon_api.core_search_item(
             **{"id": self.id, "flags": flags.DATAFLAG_RESOURCE_BILLING_PROPERTIES}
         )
         return response.get("item", {}).get("bact") == self.id
 
     def is_migrated(self, unit: WialonBase) -> bool:
+        """
+        Checks if a unit is migrated into the account.
+
+        :param unit: A Wialon object.
+        :type unit: :py:obj:`~terminusgps.wialon.items.base.WialonBase`
+        :returns: Whether or not the unit is migrated into the account.
+        :rtype: :py:obj:`bool`
+
+        """
+        assert self.is_account, "The resource is not an acccount"
         response = self.session.wialon_api.account_list_change_accounts(
             **{"units": [unit.id]}
         )
-        results = [unit.id == int(item.get("id")) for item in response]
+        results = [self.id == int(item.get("id")) for item in response]
         return any(results)
 
+    def set_dealer_rights(self, enabled: bool = False) -> None:
+        """
+        Sets dealer rights on the account.
+
+        :param enabled: :py:obj:`True` to enable dealer rights, :py:obj:`False` to disable dealer rights. Default is :py:obj:`False`.
+        :type enabled: :py:obj:`bool`
+        :raises AssertionError: If the resource is not an account.
+        :raises WialonError: If something goes wrong with Wialon.
+        :returns: Nothing.
+        :rtype: :py:obj:`None`
+
+        """
+        assert self.is_account, "The resource is not an account"
+        self.session.wialon_api.account_update_dealer_rights(
+            **{"itemId": self.id, "enable": str(enabled).lower()}
+        )
+
     def migrate_unit(self, unit: WialonBase) -> None:
         """
         Migrates a :py:obj:`WialonUnit` into the account.
 
         :param unit: A Wialon object.
         :type unit: :py:obj:`~terminusgps.wialon.items.base.WialonBase`
+        :raises AssertionError: If the resource is not an account.
+        :raises WialonError: If something goes wrong with Wialon.
         :returns: Nothing.
         :rtype: :py:obj:`None`
 
@@ -55,6 +91,8 @@ class WialonResource(WialonBase):
 
         :param new_plan: The name of a billing plan.
         :type new_plan: :py:obj:`str`
+        :raises AssertionError: If the resource is not an account.
+        :raises WialonError: If something goes wrong with Wialon.
         :returns: Nothing.
         :rtype: :py:obj:`None`
 
@@ -70,11 +108,13 @@ class WialonResource(WialonBase):
 
         :param billing_plan: The name of a billing plan.
         :type billing_plan: :py:obj:`str`
+        :raises AssertionError: If the resource is already account.
+        :raises WialonError: If something goes wrong with Wialon.
         :returns: Nothing.
         :rtype: :py:obj:`None`
 
         """
-        assert self.is_account, "The resource is already an account"
+        assert not self.is_account, "The resource is already an account"
         self.session.wialon_api.account_create_account(
             **{"itemId": self.id, "plan": billing_plan}
         )
@@ -83,6 +123,8 @@ class WialonResource(WialonBase):
         """
         Deletes the account if it exists, as well as any micro-objects and macro-objects it contains.
 
+        :raises AssertionError: If the resource is not an account.
+        :raises WialonError: If something goes wrong with Wialon.
         :returns: Nothing.
         :rtype: :py:obj:`None`
 
@@ -94,6 +136,8 @@ class WialonResource(WialonBase):
         """
         Enables the Wialon account.
 
+        :raises AssertionError: If the resource is not an account.
+        :raises WialonError: If something goes wrong with Wialon.
         :returns: Nothing.
         :rtype: :py:obj:`None`
 
@@ -107,6 +151,8 @@ class WialonResource(WialonBase):
         """
         Disables the Wialon account.
 
+        :raises AssertionError: If the resource is not an account.
+        :raises WialonError: If something goes wrong with Wialon.
         :returns: Nothing.
         :rtype: :py:obj:`None`
 
@@ -122,6 +168,8 @@ class WialonResource(WialonBase):
 
         :param days: Number of days to set the counter to. Default is ``0``.
         :type days: :py:obj:`int`
+        :raises AssertionError: If the resource is not an account.
+        :raises WialonError: If something goes wrong with Wialon.
         :returns: Nothing.
         :rtype: :py:obj:`None`
 
@@ -137,6 +185,8 @@ class WialonResource(WialonBase):
 
         :param days: Number of days to add to the account. Default is ``30``.
         :type days: :py:obj:`int`
+        :raises AssertionError: If the resource is not an account.
+        :raises WialonError: If something goes wrong with Wialon.
         :returns: Nothing.
         :rtype: :py:obj:`None`
 
@@ -166,6 +216,8 @@ class WialonResource(WialonBase):
         :type block_balance_val: :py:obj:`float`
         :param deny_balance_val: Minimum amount on the account's balance before denying the account.
         :type deny_balance_val: :py:obj:`float`
+        :raises AssertionError: If the resource is not an account.
+        :raises WialonError: If something goes wrong with Wialon.
         :returns: Nothing.
         :rtype: :py:obj:`None`
 

{python_terminusgps-1.11.0 → python_terminusgps-1.13.0}/terminusgps/wialon/session.py

@@ -1,14 +1,40 @@
 import threading
+import logging
+from typing import Any
 
-from wialon.api import Wialon, WialonError
+from wialon.api import WialonError
+from wialon.api import Wialon as WialonAPI
 from django.conf import settings
 
-from .errors import (
-    WialonLogoutError,
-    WialonLoginError,
-    WialonSessionDuplicationError,
-    WialonSessionInvalidError,
-)
+from .errors import WialonLogoutError, WialonLoginError
+
+logger = logging.getLogger(__name__)
+
+
+class Wialon(WialonAPI):
+    def __init__(self, log_level: int = logging.INFO, *args, **kwargs) -> None:
+        super().__init__(*args, **kwargs)
+        self.logger = self.create_logger(log_level)
+
+    def call(self, action_name: str, *argc, **kwargs) -> Any:
+        self.logger.debug(f"Executing '{action_name}'...")
+        try:
+            return super().call(action_name, *argc, **kwargs)
+        except WialonError as e:
+            self.logger.critical(e)
+            raise
+
+    def create_logger(self, log_level: int) -> logging.Logger:
+        logger = logging.getLogger(self.__class__.__name__)
+        handler = logging.StreamHandler()
+        formatter = logging.Formatter(
+            "%(asctime)s - %(name)s - %(levelname)s - %(message)s"
+        )
+
+        logger.setLevel(log_level)
+        handler.setFormatter(formatter)
+        logger.addHandler(handler)
+        return logger
 
 
 class WialonSession:
@@ -20,6 +46,7 @@ class WialonSession:
         scheme: str = "https",
         host: str = "hst-api.wialon.com",
         port: int = 443,
+        log_level: int = logging.INFO,
     ) -> None:
         """
         Starts or continues a Wialon API session.
@@ -34,7 +61,9 @@ class WialonSession:
 
         """
 
-        self.wialon_api = Wialon(scheme=scheme, host=host, port=port, sid=sid)
+        self.wialon_api = Wialon(
+            scheme=scheme, host=host, port=port, sid=sid, log_level=log_level
+        )
         self.token = token
         self.login_id = uid
         self._username = None
@@ -42,6 +71,19 @@ class WialonSession:
         self._hw_gp_ip = None
         self._wsdk_version = None
         self._uid = None
+        self.logger = self.create_logger(log_level)
+
+    def create_logger(self, log_level: int) -> logging.Logger:
+        logger = logging.getLogger(self.__class__.__name__)
+        handler = logging.StreamHandler()
+        formatter = logging.Formatter(
+            "%(asctime)s - %(name)s - %(levelname)s - %(message)s"
+        )
+
+        logger.setLevel(log_level)
+        handler.setFormatter(formatter)
+        logger.addHandler(handler)
+        return logger
 
     def __enter__(self) -> "WialonSession":
         assert self.token, "Wialon API token was not set"
@@ -51,24 +93,6 @@ class WialonSession:
     def __exit__(self, *args, **kwargs) -> None:
         self.logout()
 
-    @property
-    def active(self) -> bool:
-        """
-        Whether or not the Wialon session is currently active.
-
-        :type: :py:obj:`bool`
-        :value: :py:obj:`False`
-        """
-        is_active = False
-
-        try:
-            response = self.wialon_api.core_duplicate(**{"restore": 1})
-            is_active = bool(response)
-        except WialonError as e:
-            raise WialonSessionInvalidError(self.id, e)
-        finally:
-            return is_active
-
     @property
     def gis_geocode(self) -> str | None:
         """
@@ -219,30 +243,6 @@ class WialonSession:
     def token(self, value: str | None = None) -> None:
         self._token = value if value else settings.WIALON_TOKEN
 
-    def duplicate(self, username: str | None = None, continued: bool = False) -> str:
-        """
-        Duplicates the active Wialon API session.
-
-        :param username: A Wialon user to operate as in the session.
-        :type username: :py:obj:`str` | :py:obj:`None`
-        :param continue_session: Whether or not the original session id should be valid after duplication.
-        :type continue_session: :py:obj:`bool`
-        :raises WialonSessionDuplicationError: If the Wialon session was not duplicated.
-        :raises AssertionError: If the session was already active.
-        :returns: The new session id.
-        :rtype: :py:obj:`str`
-
-        """
-        try:
-            assert self.active, "Cannot duplicate an inactive session."
-            response = self.wialon_api.core_duplicate(
-                **{"operateAs": username, "continueCurrentSession": continued}
-            )
-            self._set_login_response(response)
-            return response.get("eid")
-        except (WialonError, AssertionError) as e:
-            raise WialonSessionDuplicationError(self.id, e)
-
     def login(self, token: str, flags: int = sum([0x1, 0x2, 0x20])) -> str:
         """
         Logs into the Wialon API and starts a new session.
@@ -252,17 +252,17 @@ class WialonSession:
         :param flags: A login response flag integer.
         :type flags: :py:obj:`int`
         :raises WialonLoginError: If the login fails.
-        :raises AssertionError: If the session was already active.
         :returns: The new session id.
         :rtype: :py:obj:`str`
 
         """
+        self.logger.debug("Logging into Wialon API session...")
         try:
-            assert not self.active, "Cannot login to an active session."
             response = self.wialon_api.token_login(**{"token": token, "fl": flags})
             self._set_login_response(response)
             return response.get("eid")
         except (WialonError, AssertionError) as e:
+            self.logger.critical(e)
             raise WialonLoginError(token, e)
 
     def logout(self) -> None:
@@ -274,8 +274,10 @@ class WialonSession:
         :rtype: :py:obj:`None`
 
         """
+        self.logger.debug(f"Logging out of Wialon API session '{self.id}'...")
         response: dict = self.wialon_api.core_logout({})
         if response.get("error") != 0:
+            self.logger.critical(response.get("error"))
             raise WialonLogoutError(str(self.id))
 
     def _set_login_response(self, login_response: dict) -> None:
@@ -317,8 +319,19 @@ class WialonSessionManager:
 
     def get_session(self, sid: str | None = None) -> WialonSession:
         with self._lock:
-            if not self._session or not self._session.active:
+            if not self._session:
                 self._session = WialonSession(sid=sid)
-                if not self._session.active:
-                    self._session.login(settings.WIALON_TOKEN)
         return self._session
+
+
+def main() -> None:
+    from terminusgps.wialon.items import WialonUnit
+
+    with WialonSession(log_level=logging.DEBUG) as session:
+        unit = WialonUnit(id="28082258", session=session)
+        unit.add_cfield(("to_number", "+17133049421"))
+    return
+
+
+if __name__ == "__main__":
+    main()

{python_terminusgps-1.11.0 → python_terminusgps-1.13.0}/uv.lock

@@ -504,7 +504,7 @@ wheels = [
 
 [[package]]
 name = "python-terminusgps"
-version = "1.10.3"
+version = "1.13.0"
 source = { editable = "." }
 dependencies = [
     { name = "argparse" },