python-terminusgps 31.4.0__py3-none-any.whl → 31.5.0__py3-none-any.whl

{python_terminusgps-31.4.0.dist-info → python_terminusgps-31.5.0.dist-info}/METADATA

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

@@ -21,22 +21,24 @@ terminusgps/twilio/__init__.py,sha256=dYo41F2jft_eHDWSUtSpKGSRG1bewq_qClqilUJZkY
 terminusgps/twilio/caller.py,sha256=Q0wcJ5aaNDGvKfht7ARwPTFdqpFoB81DmZ_K2oZixyA,5077
 terminusgps/twilio/validators.py,sha256=HWCpzgDXTedofty4Zhrm2OenbgtkzrDUC08B1l15gqc,1112
 terminusgps/wialon/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-terminusgps/wialon/constants.py,sha256=l67mdjTpnU9uA9zb3jKCdPaKEPGCcrN_iN_lm5mK_Pg,5697
+terminusgps/wialon/constants.py,sha256=pMWqXkZK7bbA_KOdBdJ8hs9MnUUEk-MMygJ3fLNA4pQ,5783
 terminusgps/wialon/flags.py,sha256=M50EdhxQ8IMnJnU0mrHK7-h8Asc6tvNiTOOfd1dBW6A,12815
 terminusgps/wialon/logger.py,sha256=nUBsaLMaffSaAHGHAM6mFXDzix9hbNecVtA3INVtii8,968
-terminusgps/wialon/session.py,sha256=21ZRBUnsuK5zhkUHeccQW1lR39A4kQ_0qkLlRT1hsS8,10044
+terminusgps/wialon/session.py,sha256=SGiHH58h8d3n4dQqKrLjWKlZvNHjBqpWqK6GKofMCBo,10079
 terminusgps/wialon/utils.py,sha256=JWHZ7VEeo8VNBH67gjOAQk5ITKuPllWDlJ4dVSQ5blA,11002
 terminusgps/wialon/validators.py,sha256=CVEpFsxqplEcpv4U2ipA6v9y5cSrMKFUXLvze-3vs4U,4223
 terminusgps/wialon/items/__init__.py,sha256=3BVthghekMvhMQSzQgBMlD_phxmKSmp3Zvmo-z0O8Bs,211
 terminusgps/wialon/items/base.py,sha256=7J5B-EPj997GJV7TbZP7pAfjl2G4nTcKmP-RMxmuzoY,10959
-terminusgps/wialon/items/resource.py,sha256=FmuY0thel8aIThSWKJXur72Sptful3MuwBfIn9bdeaY,14616
+terminusgps/wialon/items/resource.py,sha256=DDnyL_Y5P3DxiirUkQb9y4cokMXZVq3xnfn16Vx8sxk,16992
 terminusgps/wialon/items/retranslator.py,sha256=sVEWrp8q1I-tO_rMTCH7TeQDDbZryIq8d9KVnhYyhH0,3795
 terminusgps/wialon/items/route.py,sha256=amNPKZqgl8pEzKA_XJudnvBPzEsfHTmrC7uF15sZVI4,1216
-terminusgps/wialon/items/unit.py,sha256=jq4S8EV_yukRTTE8rr2oXpu_9AdXDFYA6-GCjkR6shw,12282
+terminusgps/wialon/items/unit.py,sha256=iwHM4AfUED2blKkP940RbUxFFPD_4pTDe4Dut853cfA,12302
 terminusgps/wialon/items/unit_group.py,sha256=QV2ZZgICaN3n6W1pFIyMLyNKB6KYBsLyKG64i-qXoOg,4113
 terminusgps/wialon/items/user.py,sha256=5LgwalGO8KS_7psmAVmAlnC0S6SPBDZMOuT5ZqPKRmo,7758
-terminusgps/wialon/tests/test_session.py,sha256=Dnm4ZZr31jTg2WHyRrYwiU7_1dQHokThyuO_OYiXpEg,642
-python_terminusgps-31.4.0.dist-info/METADATA,sha256=XF4L6nr7eF8K2zbaD8l8LP1Ue37jhvVw0_zhS2VDINM,1648
-python_terminusgps-31.4.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-python_terminusgps-31.4.0.dist-info/licenses/COPYING,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
-python_terminusgps-31.4.0.dist-info/RECORD,,
+terminusgps/wialon/tests/test_items.py,sha256=P2LmBYx_63-bfSmsrIdVegLUcet-OBIjjJo0kJAJ-lE,1300
+terminusgps/wialon/tests/test_session.py,sha256=4H_TeIMrC4dyaDAy11a0o1GMn6PIZaRF8soPaoaowQg,1318
+terminusgps/wialon/tests/test_utils.py,sha256=vYnOKCPPYqUWcQ2nTJTOu7NhNKMiTGNBkvX9H2APxL0,1670
+python_terminusgps-31.5.0.dist-info/METADATA,sha256=Dcha0-mD7REBsNgTK-DTBoXBOTGZGUyfkjzicxVQ4ec,1648
+python_terminusgps-31.5.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+python_terminusgps-31.5.0.dist-info/licenses/COPYING,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
+python_terminusgps-31.5.0.dist-info/RECORD,,

terminusgps/wialon/constants.py

@@ -4,6 +4,12 @@ from typing import override
 from . import flags
 
 
+class WialonGeofenceType(enum.IntEnum):
+    LINE = 1
+    POLYGON = 2
+    CIRCLE = 3
+
+
 class WialonMeasurementUnit(enum.IntEnum):
     METRIC = 0
     US = 1

terminusgps/wialon/items/resource.py

@@ -1,6 +1,6 @@
 from urllib.parse import quote_plus
 
-from terminusgps.wialon import flags
+from terminusgps.wialon import constants, flags
 from terminusgps.wialon.items.base import WialonBase
 
 
@@ -85,6 +85,73 @@ class WialonResource(WialonBase):
         )
         return int(response.get("item", {}).get("bact")) == self.id
 
+    def create_geofence(
+        self,
+        name: str,
+        x: float,
+        y: float,
+        _type: constants.WialonGeofenceType = constants.WialonGeofenceType.CIRCLE,
+        desc: str = "",
+        flags: int = 0x10,
+        color: int = int("6d0204", 16),
+        text_color: int = int("21130d", 16),
+        text_size: int = 12,
+        width: int = 100,
+        min_zoom: int = 4,
+        max_zoom: int = 19,
+    ) -> None:
+        """
+        Creates a geofence in Wialon for the resource.
+
+        :param name: Name of the geofence.
+        :type name: :py:obj:`str`
+        :param x: X-coordinate for the geofence.
+        :type x: :py:obj:`float`
+        :param y: Y-coordinate for the geofence.
+        :type y: :py:obj:`float`
+        :param _type: *Optional.* Type of Wialon geofence.
+        :type _type: :py:obj:`int`
+        :param desc: *Optional.* Description of the geofence.
+        :type desc: :py:obj:`str`
+        :param flags: *Optional.* Flags to use on the creation API call.
+        :type flags: :py:obj:`int`
+        :param color: *Optional.* Color of the geofence.
+        :type color: :py:obj:`int`
+        :param text_color: *Optional.* Text color of the geofence.
+        :type text_color: :py:obj:`int`
+        :param text_size: *Optional.* Text size of the geofence.
+        :type text_size: :py:obj:`int`
+        :param width: *Optional.* Width of the geofence.
+        :type width: :py:obj:`int`
+        :param min_zoom: *Optional.* Minimum zoom level the geofence will be visible at.
+        :type min_zoom: :py:obj:`int`
+        :param max_zoom: *Optional* Maximum zoom level the geofence will be visible at.
+        :type max_zoom: :py:obj:`int`
+        :returns: Nothing.
+        :rtype: :py:obj:`None`
+
+        """
+        self.session.wialon_api.resource_update_zone(
+            **{
+                "itemId": self.id,
+                "id": 0,
+                "callMode": "create",
+                "n": name,
+                "d": desc,
+                "t": _type,
+                "w": width,
+                "f": flags,
+                "c": color,
+                "tc": text_color,
+                "ts": text_size,
+                "min": min_zoom,
+                "max": max_zoom,
+                "path": "",
+                "libId": 0,
+                "p": [{"x": x, "y": y, "r": width}],
+            }
+        )
+
     def is_migrated(self, unit: WialonBase) -> bool:
         """
         Checks if a unit is migrated into the account.

terminusgps/wialon/items/unit.py

@@ -38,10 +38,10 @@ class WialonUnit(WialonBase):
 
         response = self.session.wialon_api.core_create_unit(
             **{
-                "creatorId": creator_id,
-                "name": name,
-                "hwTypeId": hw_type_id,
-                "dataFlags": flags.DataFlag.UNIT_BASE,
+                "creatorId": str(creator_id),
+                "name": str(name),
+                "hwTypeId": str(hw_type_id),
+                "dataFlags": str(flags.DataFlag.UNIT_BASE),
             }
         )
         return (

terminusgps/wialon/session.py

@@ -307,6 +307,7 @@ class WialonSession:
         """
         self.logger.debug("Logging out of Wialon API session...")
         response: dict = self.wialon_api.core_logout({})
+        self.wialon_api.sid = None
 
         if response.get("error") != 0:
             self.logger.warning(

terminusgps/wialon/tests/test_items.py

@@ -0,0 +1,37 @@
+import unittest
+from datetime import datetime
+
+from django.conf import settings
+
+from .. import items
+from ..session import WialonSession
+
+
+class WialonResourceTestCase(unittest.TestCase):
+    def setUp(self) -> None:
+        if not hasattr(settings, "WIALON_TOKEN"):
+            self.fail("'WIALON_TOKEN' setting is required.")
+        if not hasattr(settings, "WIALON_ADMIN_ID"):
+            self.fail("'WIALON_ADMIN_ID' setting is required.")
+
+        self.session = WialonSession()
+        self.session.login(settings.WIALON_TOKEN)
+        self.test_timestamp = f"{datetime.now():%Y-%m-%d-%H:%M:%S}"
+        self.test_resource = items.WialonResource(
+            id=None,
+            creator_id=str(settings.WIALON_ADMIN_ID),
+            name=f"test_resource_{self.test_timestamp}",
+            skip_creator_check=True,
+            session=self.session,
+        )
+
+    def tearDown(self) -> None:
+        self.test_resource.delete()
+
+    def test_resource_is_not_account(self) -> None:
+        """Tests whether or not a new resource is an account after creation."""
+        self.assertFalse(self.test_resource.is_account)
+
+    def test_resource_create_account(self) -> None:
+        self.test_resource.create_account("terminusgps_ext_hist")
+        self.assertTrue(self.test_resource.is_account)

terminusgps/wialon/tests/test_session.py

@@ -1,4 +1,3 @@
-import socket
 import unittest
 
 from django.conf import settings
@@ -8,15 +7,34 @@ from ..session import WialonSession
 
 class WialonSessionTestCase(unittest.TestCase):
     def setUp(self) -> None:
+        if not hasattr(settings, "WIALON_TOKEN"):
+            self.fail("'WIALON_TOKEN' setting is required.")
+
+        self.token = settings.WIALON_TOKEN
         self.session = WialonSession()
 
     def test_session_init(self) -> None:
-        self.assertEqual(self.session.token, settings.WIALON_TOKEN)
         self.assertIsNone(self.session.id)
         self.assertIsNone(self.session.username)
         self.assertIsNone(self.session.uid)
 
     def test_session_login(self) -> None:
-        mock_login_response = {"host": socket.gethostbyname(socket.gethostname())}
+        sid: str = self.session.login(self.token)
+        self.assertEqual(self.session.id, sid)
+
+    def test_session_logout(self) -> None:
+        self.session.login(self.token)
+        self.session.logout()
+        self.assertEqual(self.session.id, None)
+
+    def test_session_bad_call(self) -> None:
+        self.session.login(self.token)
+        response = self.session.wialon_api.core_bad_call({})
+        self.assertEqual(response, None)
+        self.session.logout()
 
-        self.session.login(settings.WIALON_TOKEN)
+    def test_session_valid_call_count(self) -> None:
+        self.session.login(self.token)  # Login/logout does not count
+        self.session.wialon_api.avl_evts()
+        self.assertEqual(self.session.wialon_api.total_calls, 1)
+        self.session.logout()

terminusgps/wialon/tests/test_utils.py

@@ -0,0 +1,41 @@
+import string
+import unittest
+
+
+from .. import utils
+
+
+class WialonUtilsTestCase(unittest.TestCase):
+    def test_generate_wialon_password_min_length(self) -> None:
+        with self.assertRaises(ValueError) as context:
+            utils.generate_wialon_password(length=7)
+        self.assertTrue(
+            "Password cannot be less than 8 characters in length, got 7."
+            in str(context.exception)
+        )
+
+    def test_generate_wialon_password_max_length(self) -> None:
+        with self.assertRaises(ValueError) as context:
+            utils.generate_wialon_password(length=65)
+        self.assertTrue(
+            "Password cannot be greater than 64 characters in length, got 65."
+            in str(context.exception)
+        )
+
+    def test_generate_wialon_password_valid(self) -> None:
+        password = utils.generate_wialon_password()
+        s0 = list(string.ascii_uppercase)
+        s1 = list(string.ascii_lowercase)
+        s2 = list(string.digits)
+        s3 = list("!@#$%^*()[]-_+")
+
+        if len(password) < 8 or len(password) > 64:
+            self.fail(f"Generated password was {len(password)} chars in length.")
+        if not any([c for c in password if c in s0]):
+            self.fail("Generated password did not contain an uppercase letter.")
+        if not any([c for c in password if c in s1]):
+            self.fail("Generated password did not contain a lowercase letter.")
+        if not any([c for c in password if c in s2]):
+            self.fail("Generated password did not contain a digit.")
+        if not any([c for c in password if c in s3]):
+            self.fail("Generated password did not contain a special symbol.")