python-terminusgps 1.5.2__py3-none-any.whl → 1.5.5__py3-none-any.whl

{python_terminusgps-1.5.2.dist-info → python_terminusgps-1.5.5.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-terminusgps
-Version: 1.5.2
+Version: 1.5.5
 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.5.2.dist-info → python_terminusgps-1.5.5.dist-info}/RECORD

@@ -1,13 +1,14 @@
 terminusgps/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+terminusgps/settings.py,sha256=CIWif9AJYXk5nE-9Mqmqkeoum6-ON5MTuh0WJilgv3E,185
 terminusgps/authorizenet/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 terminusgps/authorizenet/auth.py,sha256=zITSQMH8F-3vw-lDQRbuR2s9AVlGqbOyyFo0zqU00qU,870
 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=AFnu6RHPFlJ6x3zAC-iKn4x_8PyUgheY2IOSEv02Sp4,880
+terminusgps/wialon/errors.py,sha256=RbHwHuhW8P9L7i3jaPzcMO8ZHxX3Z3V970ypEtqnavw,1236
 terminusgps/wialon/flags.py,sha256=-OoH-eZM54yjRqxsAXL8VImdQu_7C0OAxCrFqaCEuko,13510
-terminusgps/wialon/session.py,sha256=d-ym6TVXqFOQK-G1EPHr8r9XUr0qg8vwx-m5KUIt9co,2570
+terminusgps/wialon/session.py,sha256=TqUI6k1BOUqDU-KhqAkVmEN3-E03tbHjLRIEtR44UOM,8795
 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
@@ -17,7 +18,7 @@ terminusgps/wialon/items/route.py,sha256=qOHPN_rejwiGqvwWzlwmUIAIyc3lKavCalf8ki6
 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.2.dist-info/METADATA,sha256=R8eIQov81lvkL9CsAVgsCy36IHKtsfCVcMyji65qA9U,882
-python_terminusgps-1.5.2.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-python_terminusgps-1.5.2.dist-info/licenses/COPYING,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
-python_terminusgps-1.5.2.dist-info/RECORD,,
+python_terminusgps-1.5.5.dist-info/METADATA,sha256=R7GHQv_EnEXS0U6emZXYn73-lpVfsRmZf7QyHKN-_CU,882
+python_terminusgps-1.5.5.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+python_terminusgps-1.5.5.dist-info/licenses/COPYING,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
+python_terminusgps-1.5.5.dist-info/RECORD,,

terminusgps/settings.py

@@ -0,0 +1,6 @@
+from os import getenv
+
+DEBUG = False
+SECRET_KEY = "xem*6no%8d9%^qzt2f3x3ar-uq4_+7h9myc$t0!+4%bj5us6f)"
+WIALON_ADMIN_ID = getenv("WIALON_ADMIN_ID")
+WIALON_TOKEN = getenv("WIALON_TOKEN")

terminusgps/wialon/errors.py

@@ -11,7 +11,17 @@ class WialonLoginError(WialonBaseError):
     def __init__(
         self, token: str | None, wialon_err: WialonError | None = None
     ) -> None:
-        message = f"Failed to login to the Wialon API using token: '{token}'"
+        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)
+
+
+class WialonSessionDuplicationError(WialonBaseError):
+    def __init__(
+        self, session_id: str | None, wialon_err: WialonError | 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)
@@ -19,7 +29,7 @@ class WialonLoginError(WialonBaseError):
 
 class WialonLogoutError(WialonBaseError):
     def __init__(self, session_id: str, wialon_err: WialonError | None = None) -> None:
-        message = f"Failed to logout of the Wialon API session: '{session_id}'"
+        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)

terminusgps/wialon/session.py

@@ -1,69 +1,301 @@
 from wialon.api import Wialon, WialonError
+from pprint import pprint
 from django.conf import settings
 from django.core.exceptions import ImproperlyConfigured
 
-from .errors import WialonLogoutError, WialonLoginError
+from .errors import WialonLogoutError, WialonLoginError, WialonSessionDuplicationError
 
 
 class WialonSession:
-    def __init__(self, token: str | None = None, sid: str | None = None) -> None:
+    def __init__(
+        self,
+        token: str | None = None,
+        sid: str | None = None,
+        scheme: str = "https",
+        host: str = "hst-api.wialon.com",
+        port: int = 443,
+    ) -> None:
+        """
+        Starts or continues a Wialon API session.
+
+        :param token: An optional Wialon API token. Default is :confval:`WIALON_TOKEN`.
+        :type token: :py:obj:`str` | :py:obj:`None`
+        :param sid: An optional Wialon API session id. If provided, the session is continued.
+        :type sid: :py:obj:`str` | :py:obj:`None`
+        :raises ImproperlyConfigured: If either :confval:`WIALON_TOKEN` or :confval:`WIALON_ADMIN_ID` is not set.
+        :returns: Nothing.
+        :rtype: :py:obj:`None`
+
+        """
         if not hasattr(settings, "WIALON_TOKEN"):
             raise ImproperlyConfigured("'WIALON_TOKEN' setting is required.")
+        if not hasattr(settings, "WIALON_ADMIN_ID"):
+            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.wialon_api = Wialon(
-            scheme="https", host="hst-api.wialon.com", port=443, sid=sid
-        )
+        self._username = None
+        self._gis_sid = None
+        self._hw_gp_ip = None
+        self._wsdk_version = None
+        self._uid = None
+
+    def __enter__(self) -> "WialonSession":
+        assert self.token, "Wialon API token was not set"
+        self.login(self.token)
+        return self
+
+    def __exit__(self, *args, **kwargs) -> None:
+        self.logout()
+
+    @property
+    def gis_geocode(self) -> str | None:
+        """
+        Gis geocode URL.
+
+        :type: :py:obj:`str` | :py:obj:`None`
+        :value: :py:obj:`None`
+
+        """
+        return self._gis_geocode
+
+    @property
+    def gis_render(self) -> str | None:
+        """
+        Gis rendering URL.
+
+        :type: :py:obj:`str` | :py:obj:`None`
+        :value: :py:obj:`None`
+
+        """
+        return self._gis_render
+
+    @property
+    def gis_routing(self) -> str | None:
+        """
+        Gis routing URL.
+
+        :type: :py:obj:`str` | :py:obj:`None`
+        :value: :py:obj:`None`
+
+        """
+        return self._gis_routing
+
+    @property
+    def gis_search(self) -> str | None:
+        """
+        Gis search URL.
+
+        :type: :py:obj:`str` | :py:obj:`None`
+        :value: :py:obj:`None`
+
+        """
+        return self._gis_search
+
+    @property
+    def gis_sid(self) -> str | None:
+        """
+        Gis session id.
+
+        :type: :py:obj:`str` | :py:obj:`None`
+        :value: :py:obj:`None`
+
+        """
+        return self._gis_sid
+
+    @property
+    def host(self) -> str | None:
+        """
+        IP of the client hosting the Wialon session.
+
+        :type: :py:obj:`str` | :py:obj:`None`
+        :value: :py:obj:`None`
+
+        """
+        return self._host
+
+    @property
+    def hw_gw_ip(self) -> str | None:
+        """
+        Hardware gateway IP.
+
+        :type: :py:obj:`str` | :py:obj:`None`
+        :value: :py:obj:`None`
+
+        """
+        return self._hw_gw_ip
+
+    @property
+    def hw_gw_dns(self) -> str | None:
+        """
+        Hardware gateway domain name, should evaluate to :py:attr:`hw_gw_ip` if present.
+
+        :type: :py:obj:`str` | :py:obj:`None`
+        :value: :py:obj:`None`
+
+        """
+        return self._hw_gw_dns
+
+    @property
+    def wsdk_version(self) -> str | None:
+        """
+        The Wialon Source Developer Kit (WSDK) version number of the session.
+
+        :type: :py:obj:`str` | :py:obj:`None`
+        :value: :py:obj:`None`
+
+        """
+        return self._wsdk_version
+
+    @property
+    def uid(self) -> str | None:
+        """
+        A Wialon user ID this session is operating as.
+
+        :type: :py:obj:`str` | :py:obj:`None`
+        :value: :py:obj:`None`
+        """
+        return self._uid
+
+    @property
+    def username(self) -> str | None:
+        """
+        A Wialon username the session is operating as.
+
+        :type: :py:obj:`str` | :py:obj:`None`
+        :value: :py:obj:`None`
+
+        """
+        return self._username
 
     @property
     def id(self) -> str | None:
+        """
+        Shortcut property for :py:attr:`WialonSession.wialon_api.sid`.
+
+        Returns :py:obj:`None` if the session wasn't logged in.
+
+        :type: :py:obj:`str` | :py:obj:`None`
+        :value: :py:obj:`None`
+
+        """
         return self.wialon_api.sid
 
     @property
-    def token(self) -> str | None:
+    def token(self) -> str:
+        """
+        A Wialon API token set during :py:meth:`WialonSession.__init__`.
+
+        Default token value is :confval:`WIALON_TOKEN`.
+
+        :type: :py:obj:`str`
+        :value: :confval:`WIALON_TOKEN`
+
+        """
         return self._token
 
     @token.setter
     def token(self, value: str | None = None) -> None:
         self._token = value if value else settings.WIALON_TOKEN
 
-    def __enter__(self) -> "WialonSession":
-        if not self.wialon_api.sid:
-            self.login(self.token)
-        return self
+    def duplicate(
+        self, user_id: str | None = None, continue_session: bool = False
+    ) -> None:
+        """
+        Duplicates the active Wialon API session.
 
-    def __exit__(self, exc_type, exc_value, exc_tb) -> None:
-        self.logout()
-        return
-
-    def _deconstruct_login_response(self, login_response: dict) -> None:
-        self.wialon_api.sid = login_response.get("eid", "")
-        self.username = login_response.get("user", {}).get("nm")
-        self.uid = login_response.get("user", {}).get("id")
-        self.base_url = login_response.get("base_url", "")
-        self.gis_sid = login_response.get("gis_sid", "")
-        self.host = login_response.get("host", "")
-        self.hw_gp_ip = login_response.get("hw_gw_ip", "")
-        self.video_service_url = login_response.get("video_service_url", "")
-        self.wsdk_version = login_response.get("wsdk_version", "")
-        return
-
-    def login(self, token: str | None = None) -> None:
-        """Logs into the Wialon API and starts a new session."""
-        if not token:
-            raise ValueError("Must provide a Wialon API token to login with.")
+        :param user_id: A Wialon user to operate as in the session.
+        :type user_id: :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`
+
+        """
         try:
-            login_response = self.wialon_api.token_login(
-                **{"token": token, "fl": sum([0x1, 0x2, 0x20])}
+            login_response = self.wialon_api.core_duplicate(
+                **{"operateAs": user_id, "continueCurrentSession": continue_session}
             )
+        except WialonError 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:
+        """
+        Logs into the Wialon API and starts a new session.
+
+        :param token: An active Wialon API token.
+        :type token: :py:obj:`str`
+        :param user_id: A user to operate as in the Wialon API session.
+        :type user_id: :py:obj:`str` | :py:obj:`None`
+        :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: Nothing.
+        :rtype: :py:obj:`None`
+
+        """
+        assert not self.active, "Cannot login to an active session."
+        try:
+            response = self.wialon_api.token_login(**{"token": token, "fl": flags})
+            pprint(response)
         except WialonError as e:
             raise WialonLoginError(token, e)
         else:
-            self._deconstruct_login_response(login_response)
+            self._set_login_response(response)
+            self.active = True
 
     def logout(self) -> None:
-        """Logs out of the Wialon API and raises an error if the session was not destroyed."""
-        sid: str = str(self.id)
-        logout_response = self.wialon_api.core_logout({})
-        if logout_response.get("error") != 0:
-            raise WialonLogoutError(sid)
+        """
+        Logs out of the Wialon API session.
+
+        :raises WialonLogoutError: If the logout fails.
+        :returns: Nothing.
+        :rtype: :py:obj:`None`
+
+        """
+        response: dict = self.wialon_api.core_logout({})
+        if response.get("error") != 0:
+            raise WialonLogoutError(str(self.id))
+
+    def _set_login_response(self, login_response: dict) -> None:
+        """
+        Sets the Wialon API session's attributes based on a login response.
+
+        :param login_response: A Wialon API response to :py:meth:`login`.
+        :type login_response: :py:obj:`dict`
+        :returns: Nothing.
+        :rtype: :py:obj:`None`
+
+        """
+        self.wialon_api.sid = login_response.get("eid")
+        self._gis_geocode = login_response.get("gis_geocode")
+        self._gis_render = login_response.get("gis_render")
+        self._gis_routing = login_response.get("gis_routing")
+        self._gis_search = login_response.get("gis_search")
+        self._gis_sid = login_response.get("gis_sid")
+        self._host = login_response.get("host")
+        self._hw_gw_dns = login_response.get("hw_gw_dns")
+        self._hw_gw_ip = login_response.get("hw_gw_ip")
+        self._uid = login_response.get("user", {}).get("id")
+        self._nm = login_response.get("user", {}).get("nm")
+        self._username = login_response.get("au")
+        self._video_service_url = login_response.get("video_service_url")
+        self._wsdk_version = login_response.get("wsdk_version")
+
+
+def main() -> None:
+    session = WialonSession()
+    session.login(settings.WIALON_TOKEN)
+    session.duplicate(user_id="28944309")
+    session.logout()
+    return
+
+
+if __name__ == "__main__":
+    main()