python-terminusgps 1.5.6__py3-none-any.whl → 1.5.7__py3-none-any.whl

{python_terminusgps-1.5.6.dist-info → python_terminusgps-1.5.7.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-terminusgps
-Version: 1.5.6
+Version: 1.5.7
 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
@@ -15,5 +15,5 @@ Requires-Python: >=3.12
 Requires-Dist: argparse>=1.4.0
 Requires-Dist: authorizenet>=1.1.5
 Requires-Dist: boto3>=1.34.144
-Requires-Dist: django>=5.1.4
+Requires-Dist: django>=5.1.5
 Requires-Dist: python-wialon>=1.2.4

{python_terminusgps-1.5.6.dist-info → python_terminusgps-1.5.7.dist-info}/RECORD

@@ -6,19 +6,19 @@ terminusgps/aws/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 terminusgps/aws/secrets.py,sha256=kgRA77rs0mD4berWRLkPtJLOe4Grf--o5f8NzwQqXCk,360
 terminusgps/wialon/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 terminusgps/wialon/constants.py,sha256=dsQaNt3TIjIZbr_m94KmBGFdrqe6HER2r6lol3X8QpU,2802
-terminusgps/wialon/errors.py,sha256=RbHwHuhW8P9L7i3jaPzcMO8ZHxX3Z3V970ypEtqnavw,1236
+terminusgps/wialon/errors.py,sha256=SV9pVwU6FZ_zGlGP6zJN6aLE2auF4TfHFISQLiPMKrI,1758
 terminusgps/wialon/flags.py,sha256=-OoH-eZM54yjRqxsAXL8VImdQu_7C0OAxCrFqaCEuko,13510
-terminusgps/wialon/session.py,sha256=yEoOxRqL3dLIAAFAAgYu9K866QZzFiCDApZBQ8f0LTI,8740
+terminusgps/wialon/session.py,sha256=x5aXxqLcBe4e0Zj3enUvWd1_Ufmd_MxXInC_d_GMn3E,9446
 terminusgps/wialon/utils.py,sha256=J8V2F-QDMsLD5x2OhCYI2lnZZdgqKboMve5XJD7Qt30,1877
 terminusgps/wialon/items/__init__.py,sha256=3BVthghekMvhMQSzQgBMlD_phxmKSmp3Zvmo-z0O8Bs,211
 terminusgps/wialon/items/base.py,sha256=MN4FG6U1nWkYAjNfXQJRVrWJoiW4Y64tyqxUO0mhv_w,6593
 terminusgps/wialon/items/resource.py,sha256=ADjGsQaCqD6Y3_AaD8vLgYzGaMK69MpxCZojnylS4GE,815
-terminusgps/wialon/items/retranslator.py,sha256=HkL_asa_4VTRDvl7e6I9rtUhF0PBV3HRmecgesneHUM,839
+terminusgps/wialon/items/retranslator.py,sha256=zsQXqOhH1zFe5_e8DROPu60z3v6xPWOEPyMCi2IqJAo,3861
 terminusgps/wialon/items/route.py,sha256=qOHPN_rejwiGqvwWzlwmUIAIyc3lKavCalf8ki66rx0,760
 terminusgps/wialon/items/unit.py,sha256=tLAWPfHUUS6_Feh1aYBMFPgyuGlSiAnfumJJmGt3bKw,4662
 terminusgps/wialon/items/unit_group.py,sha256=1yc7ldPIgGbtiTj0djRDWmt6Q9K_VT9sxOaioasbbLY,5212
 terminusgps/wialon/items/user.py,sha256=bkcMw_YiocaMuhP_pBfB7apjAZwnsOzGScnGkn8Ybbw,6107
-python_terminusgps-1.5.6.dist-info/METADATA,sha256=-ydcnkpNZo3XBwK4pe9MCouyUryZqstT0lJa76zuuvY,882
-python_terminusgps-1.5.6.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-python_terminusgps-1.5.6.dist-info/licenses/COPYING,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
-python_terminusgps-1.5.6.dist-info/RECORD,,
+python_terminusgps-1.5.7.dist-info/METADATA,sha256=nY0ZeyVuZ4mUV82NrlzNEXNbLQ-kpDUJW8Y1vvFAAOM,882
+python_terminusgps-1.5.7.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+python_terminusgps-1.5.7.dist-info/licenses/COPYING,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
+python_terminusgps-1.5.7.dist-info/RECORD,,

terminusgps/wialon/errors.py

@@ -2,34 +2,52 @@ from wialon.api import WialonError
 
 
 class WialonBaseError(Exception):
-    def __init__(self, message: str, wialon_err: WialonError | None = None) -> None:
+    def __init__(
+        self, message: str, wialon_err: WialonError | AssertionError | None = None
+    ) -> None:
         self.wialon_err = wialon_err
-        super().__init__(message)
+        return super().__init__(message)
 
 
 class WialonLoginError(WialonBaseError):
     def __init__(
-        self, token: str | None, wialon_err: WialonError | None = None
+        self, token: str | None, wialon_err: WialonError | AssertionError | None = None
     ) -> None:
         message = f"Failed to login to the Wialon API using token: '{token}'\n"
         if wialon_err:
             message += str(wialon_err)
-        super().__init__(message, wialon_err)
+        return super().__init__(message, wialon_err)
 
 
 class WialonSessionDuplicationError(WialonBaseError):
     def __init__(
-        self, session_id: str | None, wialon_err: WialonError | None = None
+        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)
-        super().__init__(message, wialon_err)
+        return super().__init__(message, wialon_err)
 
 
 class WialonLogoutError(WialonBaseError):
-    def __init__(self, session_id: str, wialon_err: WialonError | None = None) -> None:
+    def __init__(
+        self, session_id: str, wialon_err: WialonError | AssertionError | None = None
+    ) -> None:
         message = f"Failed to logout of the Wialon API session: '{session_id}'\n"
         if wialon_err:
             message += str(wialon_err)
-        super().__init__(message, 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)

terminusgps/wialon/items/retranslator.py

@@ -4,6 +4,21 @@ from terminusgps.wialon.items.base import WialonBase
 
 class WialonRetranslator(WialonBase):
     def create(self, **kwargs) -> int | None:
+        """
+        Creates a Wialon retranslator.
+
+        :param creator_id: A Wialon user that will create the retranslator.
+        :type creator_id: :py:obj:`str`
+        :param name: A name for the new retranslator.
+        :type name: :py:obj:`str`
+        :param config: A Wialon retranslator configuration object.
+        :type config: :py:obj:`dict`
+        :raises ValueError: If a required parameter was not provided.
+        :raises WialonError: If something went wrong with Wialon.
+        :returns: Nothing.
+        :rtype: :py:obj:`None`
+
+        """
         if not kwargs.get("creator_id"):
             raise ValueError("'creator_id' is required on creation.")
         if not kwargs.get("name"):
@@ -20,3 +35,83 @@ class WialonRetranslator(WialonBase):
             }
         )
         return response.get("item", {}).get("id")
+
+    def update_config(self, new_config: dict) -> None:
+        """
+        Updates the retranslator config to the new config.
+
+        :param new_config: A Wialon retranslator configuration.
+        :type units: :py:obj:`dict`
+        :raises WialonError: If something went wrong with Wialon.
+        :returns: Nothing.
+        :rtype: :py:obj:`None`
+
+        """
+        self.session.wialon_api.retranslator_update_config(
+            **{"itemId": self.id, "config": new_config}
+        )
+
+    def add_units(self, units: list[WialonBase]) -> None:
+        """
+        Adds a list of units to the Wialon retranslator.
+
+        :param units: A list of Wialon unit objects.
+        :type units: :py:obj:`list`
+        :raises WialonError: If something went wrong with Wialon.
+        :returns: Nothing.
+        :rtype: :py:obj:`None`
+
+        """
+        self.session.wialon_api.retranslator_update_units(
+            **{
+                "itemId": self.id,
+                "units": [{"a": unit.id, "i": unit.hw_type} for unit in units],
+                "callMode": "add",
+            }
+        )
+
+    def rm_units(self, units: list[WialonBase]) -> None:
+        """
+
+        Naively removes a list of units from the Wialon retranslator.
+
+        :param units: A list of Wialon unit objects.
+        :type units: :py:obj:`list`
+        :raises WialonError: If something went wrong with Wialon.
+        :returns: Nothing.
+        :rtype: :py:obj:`None`
+
+        """
+        self.session.wialon_api.retranslator_update_units(
+            **{
+                "itemId": self.id,
+                "units": [{"a": unit.id, "i": unit.hw_type} for unit in units],
+                "callMode": "remove",
+            }
+        )
+
+    def start(self, stop: int | None = None) -> None:
+        """
+        Starts the Wialon retranslator.
+
+        :raises WialonError: If something went wrong with Wialon.
+        :returns: Nothing.
+        :rtype: :py:obj:`None`
+
+        """
+        self.session.wialon_api.retranslator_update_operating(
+            **{"itemId": self.id, "operate": int(True), "stopTime": stop}
+        )
+
+    def stop(self) -> None:
+        """
+        Stops the Wialon retranslator.
+
+        :raises WialonError: If something went wrong with Wialon.
+        :returns: Nothing.
+        :rtype: :py:obj:`None`
+
+        """
+        self.session.wialon_api.retranslator_update_operating(
+            **{"itemId": self.id, "operate": int(False)}
+        )

terminusgps/wialon/session.py

@@ -2,7 +2,12 @@ from wialon.api import Wialon, WialonError
 from django.conf import settings
 from django.core.exceptions import ImproperlyConfigured
 
-from .errors import WialonLogoutError, WialonLoginError, WialonSessionDuplicationError
+from .errors import (
+    WialonLogoutError,
+    WialonLoginError,
+    WialonSessionDuplicationError,
+    WialonSessionInvalidError,
+)
 
 
 class WialonSession:
@@ -32,7 +37,6 @@ class WialonSession:
             raise ImproperlyConfigured("'WIALON_ADMIN_ID' setting is required.")
 
         self.wialon_api = Wialon(scheme=scheme, host=host, port=port, sid=sid)
-        self.active = bool(sid)
         self.token = token
         self._username = None
         self._gis_sid = None
@@ -48,6 +52,24 @@ 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:
         """
@@ -198,32 +220,31 @@ class WialonSession:
     def token(self, value: str | None = None) -> None:
         self._token = value if value else settings.WIALON_TOKEN
 
-    def duplicate(
-        self, user_id: str | None = None, continue_session: bool = False
-    ) -> None:
+    def duplicate(self, username: str | None = None, continued: bool = False) -> str:
         """
         Duplicates the active Wialon API session.
 
-        :param user_id: A Wialon user to operate as in the session.
-        :type user_id: :py:obj:`str` | :py:obj:`None`
+        :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.
-        :returns: Nothing.
-        :rtype: :py:obj:`None`
+        :raises AssertionError: If the session was already active.
+        :returns: The new session id.
+        :rtype: :py:obj:`str`
 
         """
         try:
-            login_response = self.wialon_api.core_duplicate(
-                **{"operateAs": user_id, "continueCurrentSession": continue_session}
+            assert self.active, "Cannot duplicate an inactive session."
+            response = self.wialon_api.core_duplicate(
+                **{"operateAs": username, "continueCurrentSession": continued}
             )
-        except WialonError as e:
+            self._set_login_response(response)
+            return response.get("eid")
+        except (WialonError, AssertionError) as e:
             raise WialonSessionDuplicationError(self.id, e)
-        else:
-            self._set_login_response(login_response)
-            self.active = True
 
-    def login(self, token: str, flags: int = sum([0x1, 0x2, 0x20])) -> None:
+    def login(self, token: str, flags: int = sum([0x1, 0x2, 0x20])) -> str:
         """
         Logs into the Wialon API and starts a new session.
 
@@ -235,18 +256,17 @@ class WialonSession:
         :type flags: :py:obj:`int`
         :raises WialonLoginError: If the login fails.
         :raises AssertionError: If the session was already active.
-        :returns: Nothing.
-        :rtype: :py:obj:`None`
+        :returns: The new session id.
+        :rtype: :py:obj:`str`
 
         """
-        assert not self.active, "Cannot login to an active session."
         try:
+            assert not self.active, "Cannot login to an active session."
             response = self.wialon_api.token_login(**{"token": token, "fl": flags})
-        except WialonError as e:
-            raise WialonLoginError(token, e)
-        else:
             self._set_login_response(response)
-            self.active = True
+            return response.get("eid")
+        except (WialonError, AssertionError) as e:
+            raise WialonLoginError(token, e)
 
     def logout(self) -> None:
         """
@@ -265,7 +285,7 @@ class WialonSession:
         """
         Sets the Wialon API session's attributes based on a login response.
 
-        :param login_response: A Wialon API response to :py:meth:`login`.
+        :param login_response: A response returned from :py:meth:`login` or :py:meth:`duplicate`.
         :type login_response: :py:obj:`dict`
         :returns: Nothing.
         :rtype: :py:obj:`None`
@@ -289,8 +309,8 @@ class WialonSession:
 
 def main() -> None:
     session = WialonSession()
-    session.login(settings.WIALON_TOKEN)
-    session.duplicate(user_id="28944309")
+    session.login(token=settings.WIALON_TOKEN)
+    session.duplicate(username="chrissyron@gmail.com", continued=False)
     session.logout()
     return