python-terminusgps 1.6.0__py3-none-any.whl → 1.7.0__py3-none-any.whl

{python_terminusgps-1.6.0.dist-info → python_terminusgps-1.7.0.dist-info}/METADATA

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

@@ -1,24 +1,25 @@
 terminusgps/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 terminusgps/settings.py,sha256=CIWif9AJYXk5nE-9Mqmqkeoum6-ON5MTuh0WJilgv3E,185
+terminusgps/test.py,sha256=SmvDgRMqLnj_t29eWbckYjK7e9n-Yy-oWwlbN3IdhqE,2004
 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/constants.py,sha256=aybYcNcHyar2lz_6BlQbMWpbcHW6eyJeq05QwuiqZQ0,3078
 terminusgps/wialon/errors.py,sha256=SV9pVwU6FZ_zGlGP6zJN6aLE2auF4TfHFISQLiPMKrI,1758
 terminusgps/wialon/flags.py,sha256=-OoH-eZM54yjRqxsAXL8VImdQu_7C0OAxCrFqaCEuko,13510
-terminusgps/wialon/session.py,sha256=PNtEooiJln3yZ_hSZXglciyN-H1W6_X5NbLFP5Ju0Ns,9987
-terminusgps/wialon/utils.py,sha256=cDz00d5Jopdh-Al-554-yD5LrKQ37hq4YBXvPunnmIg,2715
+terminusgps/wialon/session.py,sha256=segEjyt-K9AAlMq_OYLVtxFBp_jE5c3KL-AJQhOVa9U,9936
+terminusgps/wialon/utils.py,sha256=yBB3clo_wGPoLyhll7hJ_2vChMdeJV_KffeGq2PhxUY,3151
 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/base.py,sha256=Z6aGEC2_m5CPHYCa1rgAvkGtSegbrvZ68mifCqo-07A,6617
+terminusgps/wialon/items/resource.py,sha256=xElMYSMyKA5y8rIP0EeF429MBV2hbLZcS6SokftvrOs,5641
 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.py,sha256=wzcLa0adMTKX6rtO4Vz6ntaxgY50rLk2KK_VBXlW_lQ,4680
 terminusgps/wialon/items/unit_group.py,sha256=1yc7ldPIgGbtiTj0djRDWmt6Q9K_VT9sxOaioasbbLY,5212
 terminusgps/wialon/items/user.py,sha256=bkcMw_YiocaMuhP_pBfB7apjAZwnsOzGScnGkn8Ybbw,6107
-python_terminusgps-1.6.0.dist-info/METADATA,sha256=VBNWqHqXEN2Ig3nLeZrGOPrt_0Hrja2YPYfpMPdfrhA,882
-python_terminusgps-1.6.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-python_terminusgps-1.6.0.dist-info/licenses/COPYING,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
-python_terminusgps-1.6.0.dist-info/RECORD,,
+python_terminusgps-1.7.0.dist-info/METADATA,sha256=D5bRJDHDFZTiXDsHWU8QOn6_Zk4TaExZ2afP7MTsN2A,882
+python_terminusgps-1.7.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+python_terminusgps-1.7.0.dist-info/licenses/COPYING,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
+python_terminusgps-1.7.0.dist-info/RECORD,,

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()

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,
+    ]
+)

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)

terminusgps/wialon/items/resource.py

@@ -16,7 +16,159 @@ class WialonResource(WialonBase):
                 "creatorId": kwargs["creator_id"],
                 "name": kwargs["name"],
                 "dataFlags": kwargs["flags"],
-                "skipCreatorCheck": int(True),
             }
         )
         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,
+            }
+        )

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,
             }
         )

terminusgps/wialon/session.py

@@ -17,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,
@@ -40,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
@@ -48,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:
@@ -252,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.

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: