python-terminusgps 1.5.10__tar.gz → 1.7.0__tar.gz

{python_terminusgps-1.5.10 → python_terminusgps-1.7.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-terminusgps
-Version: 1.5.10
+Version: 1.7.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.5.10 → python_terminusgps-1.7.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "python-terminusgps"
-version = "1.5.10"
+version = "1.7.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.7.0/terminusgps/test.py

@@ -0,0 +1,55 @@
+from django.utils import timezone
+from terminusgps.wialon.session import WialonSession
+from terminusgps.wialon.utils import get_hw_type_id, gen_wialon_password
+from terminusgps.wialon.items import WialonUser, WialonResource, WialonUnit
+from terminusgps.wialon import constants
+
+
+def registration_test() -> None:
+    timestamp = f"{timezone.now():%y-%m-%d-%H:%M:%S}"
+
+    with WialonSession() as session:
+        print(f"Running test '{registration_test.__name__}' as '{session.username}'...")
+        hw_type_id = get_hw_type_id(name="Test HW", session=session)
+
+        super_user = WialonUser(
+            creator_id=session.uid,
+            name=f"super_user_{timestamp}",
+            password=gen_wialon_password(length=32),
+            session=session,
+        )
+        resource = WialonResource(
+            creator_id=super_user.id, name=f"resource_{timestamp}", session=session
+        )
+        unit = WialonUnit(
+            creator_id=session.uid,
+            name=f"test_unit_{timestamp}",
+            hw_type_id=hw_type_id,
+            session=session,
+        )
+        super_user.grant_access(unit, access_mask=constants.ACCESSMASK_UNIT_MIGRATION)
+        resource.create_account("terminusgps_ext_hist")
+        resource.migrate_unit(unit)
+        end_user = WialonUser(
+            creator_id=super_user.id,
+            name=f"end_user_{timestamp}",
+            password=gen_wialon_password(length=32),
+            session=session,
+        )
+        end_user.grant_access(unit, access_mask=constants.ACCESSMASK_UNIT_BASIC)
+
+
+def account_days_test() -> None:
+    timestamp = f"{timezone.now():%y-%m-%d-%H:%M:%S}"
+
+    with WialonSession() as session:
+        print(f"Running test '{account_days_test.__name__}' as '{session.username}'...")
+        account = WialonResource(id="28990259", session=session)
+        account.set_settings_flags(0x20)
+        account.set_minimum_days(0)
+        account.add_days(30)
+
+
+if __name__ == "__main__":
+    registration_test()
+    account_days_test()

{python_terminusgps-1.5.10 → python_terminusgps-1.7.0}/terminusgps/wialon/constants.py

@@ -74,3 +74,13 @@ ACCESSMASK_UNIT_SUPER: int = sum(
 )
 
 ACCESSMASK_UNIT_FULL: int = sum([flags.ACCESSFLAG_FULL_ACCESS])
+
+ACCESSMASK_UNIT_MIGRATION: int = sum(
+    [
+        flags.ACCESSFLAG_DELETE_ITEM,
+        flags.ACCESSFLAG_MANAGE_ITEM_ACCESS,
+        flags.ACCESSFLAG_UNIT_DELETE_MESSAGES,
+        flags.ACCESSFLAG_UNIT_MANAGE_CONNECTIVITY,
+        flags.ACCESSFLAG_VIEW_ITEM_BASIC,
+    ]
+)

{python_terminusgps-1.5.10 → python_terminusgps-1.7.0}/terminusgps/wialon/items/base.py

@@ -12,6 +12,7 @@ class WialonBase:
             self._id = self.create(**kwargs)
         else:
             self._id = id
+        self.populate()
 
     def __str__(self) -> str:
         return str(self.id)

python_terminusgps-1.7.0/terminusgps/wialon/items/resource.py

@@ -0,0 +1,174 @@
+from terminusgps.wialon import flags
+from terminusgps.wialon.items.base import WialonBase
+
+
+class WialonResource(WialonBase):
+    def create(self, **kwargs) -> int | None:
+        if not kwargs.get("creator_id"):
+            raise ValueError("'creator_id' is required for creation.")
+        if not kwargs.get("name"):
+            raise ValueError("'name' is required for creation.")
+        if not kwargs.get("flags"):
+            kwargs["flags"] = flags.DATAFLAG_UNIT_BASE
+
+        response = self.session.wialon_api.core_create_resource(
+            **{
+                "creatorId": kwargs["creator_id"],
+                "name": kwargs["name"],
+                "dataFlags": kwargs["flags"],
+            }
+        )
+        return response.get("item", {}).get("id")
+
+    @property
+    def is_account(self) -> 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 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`
+        :returns: Nothing.
+        :rtype: :py:obj:`None`
+
+        """
+        assert self.is_account, "The resource is not an account"
+        self.session.wialon_api.account_change_account(
+            **{"itemId": unit.id, "resourceId": self.id}
+        )
+
+    def update_plan(self, new_plan: str) -> None:
+        """
+        Updates the account billing plan.
+
+        :param new_plan: The name of a billing plan.
+        :type new_plan: :py:obj:`str`
+        :returns: Nothing.
+        :rtype: :py:obj:`None`
+
+        """
+        assert self.is_account, "The resource is not an account"
+        self.session.wialon_api.account_update_plan(
+            **{"itemId": self.id, "plan": new_plan}
+        )
+
+    def create_account(self, billing_plan: str) -> None:
+        """
+        Transforms the resource into an account.
+
+        :param billing_plan: The name of a billing plan.
+        :type billing_plan: :py:obj:`str`
+        :returns: Nothing.
+        :rtype: :py:obj:`None`
+
+        """
+        assert self.is_account, "The resource is already an account"
+        self.session.wialon_api.account_create_account(
+            **{"itemId": self.id, "plan": billing_plan}
+        )
+
+    def delete_account(self) -> None:
+        """
+        Deletes the account if it exists, as well as any micro-objects and macro-objects it contains.
+
+        :returns: Nothing.
+        :rtype: :py:obj:`None`
+
+        """
+        assert self.is_account, "The resource is not an account"
+        self.session.wialon_api.account_delete_account(**{"itemId": self.id})
+
+    def enable_account(self) -> None:
+        """
+        Enables the Wialon account.
+
+        :returns: Nothing.
+        :rtype: :py:obj:`None`
+
+        """
+        assert self.is_account, "The resource is not an account"
+        self.session.wialon_api.account_enable_account(
+            **{"itemId": self.id, "enable": int(True)}
+        )
+
+    def disable_account(self) -> None:
+        """
+        Disables the Wialon account.
+
+        :returns: Nothing.
+        :rtype: :py:obj:`None`
+
+        """
+        assert self.is_account, "The resource is not an account"
+        self.session.wialon_api.account_enable_account(
+            **{"itemId": self.id, "enable": int(False)}
+        )
+
+    def set_minimum_days(self, days: int = 0) -> None:
+        """
+        Sets the minimum days counter value to ``days``.
+
+        :param days: Number of days to set the counter to. Default is ``0``.
+        :type days: :py:obj:`int`
+        :returns: Nothing.
+        :rtype: :py:obj:`None`
+
+        """
+        assert self.is_account, "The resource is not an account"
+        self.session.wialon_api.account_update_min_days(
+            **{"itemId": self.id, "minDays": days}
+        )
+
+    def add_days(self, days: int = 30) -> None:
+        """
+        Adds days to the account.
+
+        :param days: Number of days to add to the account. Default is ``30``.
+        :type days: :py:obj:`int`
+        :returns: Nothing.
+        :rtype: :py:obj:`None`
+
+        """
+        assert self.is_account, "The resource is not an account"
+        self.session.wialon_api.account_do_payment(
+            **{
+                "itemId": self.id,
+                "balanceUpdate": "0.00",
+                "daysUpdate": days,
+                "description": f"{self.session.id} - Added {days} days.",
+            }
+        )
+
+    def set_settings_flags(
+        self,
+        flags: int = 0x20,
+        block_balance_val: float = 0.00,
+        deny_balance_val: float = 0.00,
+    ) -> None:
+        """
+        Sets account settings flags.
+
+        :param flags: A flag integer to set on the account.
+        :type flags: :py:obj:`int`
+        :param block_balance_val: Minimum amount on the account's balance before blocking the account.
+        :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`
+        :returns: Nothing.
+        :rtype: :py:obj:`None`
+
+        """
+        assert self.is_account, "The resource is not an account"
+        self.session.wialon_api.account_update_flags(
+            **{
+                "itemId": self.id,
+                "flags": flags,
+                "blockBalance": block_balance_val,
+                "denyBalance": deny_balance_val,
+            }
+        )

{python_terminusgps-1.5.10 → python_terminusgps-1.7.0}/terminusgps/wialon/items/unit.py

@@ -13,8 +13,8 @@ class WialonUnit(WialonBase):
         :type creator_id: :py:obj:`int`
         :param name: A new name for the unit.
         :type name: :py:obj:`str`
-        :param hw_type: A Wialon hardware type.
-        :type hw_type: :py:obj:`str`
+        :param hw_type_id: A Wialon hardware type ID.
+        :type hw_type_id: :py:obj:`str`
         :returns: The Wialon id for the new unit.
         :rtype: :py:obj:`int` | :py:obj:`None`
 
@@ -23,14 +23,14 @@ class WialonUnit(WialonBase):
             raise ValueError("'creator_id' is required on creation.")
         if not kwargs.get("name"):
             raise ValueError("'name' is required on creation.")
-        if not kwargs.get("hw_type"):
-            raise ValueError("'hw_type' is required on creation.")
+        if not kwargs.get("hw_type_id"):
+            raise ValueError("'hw_type_id' is required on creation.")
 
         response = self.session.wialon_api.core_create_unit(
             **{
                 "creatorId": kwargs["creator_id"],
                 "name": kwargs["name"],
-                "hwTypeId": kwargs["hw_type"],
+                "hwTypeId": kwargs["hw_type_id"],
                 "dataFlags": flags.DATAFLAG_UNIT_BASE,
             }
         )

{python_terminusgps-1.5.10 → python_terminusgps-1.7.0}/terminusgps/wialon/session.py

@@ -1,3 +1,5 @@
+import threading
+
 from wialon.api import Wialon, WialonError
 from django.conf import settings
 from django.core.exceptions import ImproperlyConfigured
@@ -15,6 +17,7 @@ class WialonSession:
         self,
         token: str | None = None,
         sid: str | None = None,
+        uid: str | None = None,
         scheme: str = "https",
         host: str = "hst-api.wialon.com",
         port: int = 443,
@@ -38,6 +41,7 @@ class WialonSession:
 
         self.wialon_api = Wialon(scheme=scheme, host=host, port=port, sid=sid)
         self.token = token
+        self.login_id = uid
         self._username = None
         self._gis_sid = None
         self._hw_gp_ip = None
@@ -46,7 +50,7 @@ class WialonSession:
 
     def __enter__(self) -> "WialonSession":
         assert self.token, "Wialon API token was not set"
-        self.login(self.token)
+        self.login(self.token, self.login_id)
         return self
 
     def __exit__(self, *args, **kwargs) -> None:
@@ -250,8 +254,6 @@ class WialonSession:
 
         :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.
@@ -307,13 +309,24 @@ class WialonSession:
         self._wsdk_version = login_response.get("wsdk_version")
 
 
-def main() -> None:
-    session = WialonSession()
-    session.login(token=settings.WIALON_TOKEN)
-    session.duplicate(username="chrissyron@gmail.com", continued=False)
-    session.logout()
-    return
+class WialonSessionManager:
+    _instance = None
+    _lock = threading.Lock()
+    _session = None
+
+    def __new__(cls) -> "WialonSessionManager":
+        with cls._lock:
+            if not cls._instance:
+                cls._instance = super().__new__(cls)
+        return cls._instance
 
+    def get_session(self, sid: str | None = None) -> WialonSession:
+        if not hasattr(settings, "WIALON_TOKEN"):
+            raise ImproperlyConfigured("'WIALON_TOKEN' setting is required.")
 
-if __name__ == "__main__":
-    main()
+        with self._lock:
+            if not self._session or not self._session.active:
+                self._session = WialonSession(sid=sid)
+                if not self._session.active:
+                    self._session.login(settings.WIALON_TOKEN)
+        return self._session

{python_terminusgps-1.5.10 → python_terminusgps-1.7.0}/terminusgps/wialon/utils.py

@@ -13,6 +13,19 @@ from terminusgps.wialon.items import (
 )
 
 
+def get_hw_type_id(name: str, session: WialonSession) -> int | None:
+    response = session.wialon_api.core_get_hw_types(
+        **{
+            "filterType": "id",
+            "filterValue": "name,id",
+            "includeType": "true",
+            "ignoreRename": "true",
+        }
+    )
+    hw_types = {item.get("name"): item.get("id") for item in response}
+    return int(hw_types.get(name)) if name in hw_types.keys() else None
+
+
 def get_wialon_cls(items_type: str) -> Any:
     """Returns a Wialon object class based on items_type."""
     match items_type:

{python_terminusgps-1.5.10 → python_terminusgps-1.7.0}/uv.lock

@@ -50,30 +50,30 @@ wheels = [
 
 [[package]]
 name = "boto3"
-version = "1.36.2"
+version = "1.36.9"
 source = { registry = "https://pypi.org/simple" }
 dependencies = [
     { name = "botocore" },
     { name = "jmespath" },
     { name = "s3transfer" },
 ]
-sdist = { url = "https://files.pythonhosted.org/packages/3a/e9/c0b2fa75efc4007ea1af21bc2fcbedf6e545c517fb90904d7f59850e02bf/boto3-1.36.2.tar.gz", hash = "sha256:fde1c29996b77274a60b7bc9f741525afa6267bb1716eb644a764fb7c124a0d2", size = 110998 }
+sdist = { url = "https://files.pythonhosted.org/packages/01/36/2e445688adf538259f469bd1f415619959df2aa9ac2972df8a5728791898/boto3-1.36.9.tar.gz", hash = "sha256:035ed3868ff3b9afe05a49d0bde35582315bc438e60b5e76727a00b107567bfb", size = 111028 }
 wheels = [
-    { url = "https://files.pythonhosted.org/packages/17/c2/72a92794237b43f64141e156bc3a58bc36d18631f1a614e1e97a48b56447/boto3-1.36.2-py3-none-any.whl", hash = "sha256:76cfc9a705be46e8d22607efacc8d688c064f923d785a01c00b28e9a96425d1a", size = 139166 },
+    { url = "https://files.pythonhosted.org/packages/16/27/d5a257251bd046409505034d76c7a76a692dd8d4aa31bdc1ebef7881ef1e/boto3-1.36.9-py3-none-any.whl", hash = "sha256:440d0b70990efb732f63b40fa16c663c86fee80347eb4bf3bcc08b593e8ac77f", size = 139166 },
 ]
 
 [[package]]
 name = "botocore"
-version = "1.36.2"
+version = "1.36.9"
 source = { registry = "https://pypi.org/simple" }
 dependencies = [
     { name = "jmespath" },
     { name = "python-dateutil" },
     { name = "urllib3" },
 ]
-sdist = { url = "https://files.pythonhosted.org/packages/c6/93/353b70cea6447e37789fc2d6f761fc12ae36fb4adb6f558055de8cdf655f/botocore-1.36.2.tar.gz", hash = "sha256:a1fe6610983f0214b0c7655fe6990b6a731746baf305b182976fc7b568fc3cb0", size = 13505440 }
+sdist = { url = "https://files.pythonhosted.org/packages/e9/1e/976c79eeac461ddbf64b27ce42788c1f26e111c138bb931d14b4062127e5/botocore-1.36.9.tar.gz", hash = "sha256:cb3baefdb8326fdfae0750015e5868330e18d3a088a31da658df2cc8cba7ac73", size = 13493557 }
 wheels = [
-    { url = "https://files.pythonhosted.org/packages/0c/fe/c066e8cb069027c12dbcf9066a7a4f3e9d2a31b10c7b174a8455ef1d0f46/botocore-1.36.2-py3-none-any.whl", hash = "sha256:bc3b7e3b573a48af2bd7116b80fe24f9a335b0b67314dcb2697a327d009abf29", size = 13302324 },
+    { url = "https://files.pythonhosted.org/packages/52/e9/fc6e02d198d52818e6658c727a250e89c7570323fc983468f76d761563f1/botocore-1.36.9-py3-none-any.whl", hash = "sha256:e31d206c7708300c541d0799df73b576bbe7d8bed011687d96323ed48763ffd2", size = 13321702 },
 ]
 
 [[package]]
@@ -285,7 +285,7 @@ wheels = [
 
 [[package]]
 name = "python-terminusgps"
-version = "1.5.7"
+version = "1.6.0"
 source = { editable = "." }
 dependencies = [
     { name = "argparse" },
@@ -355,14 +355,14 @@ wheels = [
 
 [[package]]
 name = "s3transfer"
-version = "0.11.1"
+version = "0.11.2"
 source = { registry = "https://pypi.org/simple" }
 dependencies = [
     { name = "botocore" },
 ]
-sdist = { url = "https://files.pythonhosted.org/packages/1a/aa/fdd958c626b00e3f046d4004363e7f1a2aba4354f78d65ceb3b217fa5eb8/s3transfer-0.11.1.tar.gz", hash = "sha256:3f25c900a367c8b7f7d8f9c34edc87e300bde424f779dc9f0a8ae4f9df9264f6", size = 146952 }
+sdist = { url = "https://files.pythonhosted.org/packages/62/45/2323b5928f86fd29f9afdcef4659f68fa73eaa5356912b774227f5cf46b5/s3transfer-0.11.2.tar.gz", hash = "sha256:3b39185cb72f5acc77db1a58b6e25b977f28d20496b6e58d6813d75f464d632f", size = 147885 }
 wheels = [
-    { url = "https://files.pythonhosted.org/packages/5f/ce/22673f4a85ccc640735b4f8d12178a0f41b5d3c6eda7f33756d10ce56901/s3transfer-0.11.1-py3-none-any.whl", hash = "sha256:8fa0aa48177be1f3425176dfe1ab85dcd3d962df603c3dbfc585e6bf857ef0ff", size = 84111 },
+    { url = "https://files.pythonhosted.org/packages/1b/ac/e7dc469e49048dc57f62e0c555d2ee3117fa30813d2a1a2962cce3a2a82a/s3transfer-0.11.2-py3-none-any.whl", hash = "sha256:be6ecb39fadd986ef1701097771f87e4d2f821f27f6071c872143884d2950fbc", size = 84151 },
 ]
 
 [[package]]
@@ -536,11 +536,11 @@ wheels = [
 
 [[package]]
 name = "tzdata"
-version = "2024.2"
+version = "2025.1"
 source = { registry = "https://pypi.org/simple" }
-sdist = { url = "https://files.pythonhosted.org/packages/e1/34/943888654477a574a86a98e9896bae89c7aa15078ec29f490fef2f1e5384/tzdata-2024.2.tar.gz", hash = "sha256:7d85cc416e9382e69095b7bdf4afd9e3880418a2413feec7069d533d6b4e31cc", size = 193282 }
+sdist = { url = "https://files.pythonhosted.org/packages/43/0f/fa4723f22942480be4ca9527bbde8d43f6c3f2fe8412f00e7f5f6746bc8b/tzdata-2025.1.tar.gz", hash = "sha256:24894909e88cdb28bd1636c6887801df64cb485bd593f2fd83ef29075a81d694", size = 194950 }
 wheels = [
-    { url = "https://files.pythonhosted.org/packages/a6/ab/7e5f53c3b9d14972843a647d8d7a853969a58aecc7559cb3267302c94774/tzdata-2024.2-py2.py3-none-any.whl", hash = "sha256:a48093786cdcde33cad18c2555e8532f34422074448fbc874186f0abd79565cd", size = 346586 },
+    { url = "https://files.pythonhosted.org/packages/0f/dd/84f10e23edd882c6f968c21c2434fe67bd4a528967067515feca9e611e5e/tzdata-2025.1-py2.py3-none-any.whl", hash = "sha256:7e127113816800496f027041c570f50bcd464a020098a3b6b199517772303639", size = 346762 },
 ]
 
 [[package]]

python_terminusgps-1.5.10/terminusgps/wialon/items/resource.py

@@ -1,22 +0,0 @@
-from terminusgps.wialon import flags
-from terminusgps.wialon.items.base import WialonBase
-
-
-class WialonResource(WialonBase):
-    def create(self, **kwargs) -> int | None:
-        if not kwargs.get("creator_id"):
-            raise ValueError("'creator_id' is required for creation.")
-        if not kwargs.get("name"):
-            raise ValueError("'name' is required for creation.")
-        if not kwargs.get("flags"):
-            kwargs["flags"] = flags.DATAFLAG_UNIT_BASE
-
-        response = self.session.wialon_api.core_create_resource(
-            **{
-                "creatorId": kwargs["creator_id"],
-                "name": kwargs["name"],
-                "dataFlags": kwargs["flags"],
-                "skipCreatorCheck": int(True),
-            }
-        )
-        return response.get("item", {}).get("id")