python-terminusgps 31.1.0__py3-none-any.whl → 31.3.0__py3-none-any.whl

{python_terminusgps-31.1.0.dist-info → python_terminusgps-31.3.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-terminusgps
-Version: 31.1.0
+Version: 31.3.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
@@ -26,7 +26,9 @@ Description-Content-Type: text/markdown
 
 # python-terminusgps
 
-[python-terminusgps](https://docs.terminusgps.com/) is a collection of Python libraries intended for use by Terminus GPS developers. 
+*python-terminusgps* is a collection of Python libraries intended for use by Terminus GPS developers. 
+
+[Documentation](https://docs.terminusgps.com/)
 
 Currently, the following services are streamlined for web development:
 
@@ -34,3 +36,4 @@ Currently, the following services are streamlined for web development:
   * [Authorizenet API](https://developer.authorize.net/api/reference/index.html)
   * [Twilio API](https://www.twilio.com/docs)
   * [Wialon Remote API](https://sdk.wialon.com/wiki/en/sidebar/remoteapi/apiref/apiref)
+

{python_terminusgps-31.1.0.dist-info → python_terminusgps-31.3.0.dist-info}/RECORD

@@ -14,27 +14,27 @@ terminusgps/aws/connect.py,sha256=TWf2bVz6LqSNQfVD7FKRn3K71VuLOwBj05Gs-9BsROg,69
 terminusgps/aws/secrets.py,sha256=MxQEmmBLpMUQ2tYAsHdCYf-7RZ84LiogdKcTsACX5dw,361
 terminusgps/django/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 terminusgps/django/mixins.py,sha256=Q9ZJuzpk3d9lDnlVA8ZTVvnZWxB13p08EQ8yVJcztn4,1034
-terminusgps/django/settings.py,sha256=vY5yNjyMu-7Ya0bIPWUvrrSLERtxHGdkfeoY4Ul6cP0,613
+terminusgps/django/settings.py,sha256=cKUpFXH-uYWStvT6vzclczJAKwCGNx_2wY9-fqsbmIs,624
 terminusgps/django/utils.py,sha256=SYDQyHA5tTuVwdpZGsCtf0LpTTD0ilRKoxa8StfSTpQ,156
 terminusgps/twilio/__init__.py,sha256=dYo41F2jft_eHDWSUtSpKGSRG1bewq_qClqilUJZkYM,33
 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=-fRrvtQuSAJ6hpBJzp_Xa4GDI4LuQbqZ1z1L_QFzZiE,5609
+terminusgps/wialon/constants.py,sha256=l67mdjTpnU9uA9zb3jKCdPaKEPGCcrN_iN_lm5mK_Pg,5697
 terminusgps/wialon/flags.py,sha256=M50EdhxQ8IMnJnU0mrHK7-h8Asc6tvNiTOOfd1dBW6A,12815
 terminusgps/wialon/logger.py,sha256=nUBsaLMaffSaAHGHAM6mFXDzix9hbNecVtA3INVtii8,968
-terminusgps/wialon/session.py,sha256=emB0XHJjFObtb6WbttsXZXTeRaPztcbjAV212B_Ssek,9781
-terminusgps/wialon/utils.py,sha256=eRo-NHWEi8zq8mMWFnCs8__iDbkpPvSkCqcsdr13ltI,9953
+terminusgps/wialon/session.py,sha256=21ZRBUnsuK5zhkUHeccQW1lR39A4kQ_0qkLlRT1hsS8,10044
+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=y0z3eW_Gz7dlusKHj3T3TH3_nPsx5yGUKuImEJSK10M,10215
+terminusgps/wialon/items/base.py,sha256=7J5B-EPj997GJV7TbZP7pAfjl2G4nTcKmP-RMxmuzoY,10959
 terminusgps/wialon/items/resource.py,sha256=FmuY0thel8aIThSWKJXur72Sptful3MuwBfIn9bdeaY,14616
 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_group.py,sha256=QV2ZZgICaN3n6W1pFIyMLyNKB6KYBsLyKG64i-qXoOg,4113
-terminusgps/wialon/items/user.py,sha256=N30wdejdG7LXrgafdKZH74YArGkX3xpZfTucn3m3aqM,7155
-python_terminusgps-31.1.0.dist-info/METADATA,sha256=MIfipx-9aKDFbozGWwy-i6MXtywcZMOk8O968CjS2TQ,1630
-python_terminusgps-31.1.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-python_terminusgps-31.1.0.dist-info/licenses/COPYING,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
-python_terminusgps-31.1.0.dist-info/RECORD,,
+terminusgps/wialon/items/user.py,sha256=5LgwalGO8KS_7psmAVmAlnC0S6SPBDZMOuT5ZqPKRmo,7758
+python_terminusgps-31.3.0.dist-info/METADATA,sha256=n-d09k232ROHl_dbQ-Ky0SyWY-_ajnFxhPVSo9Ta2LY,1648
+python_terminusgps-31.3.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+python_terminusgps-31.3.0.dist-info/licenses/COPYING,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
+python_terminusgps-31.3.0.dist-info/RECORD,,

terminusgps/django/settings.py

@@ -1,15 +1,17 @@
 import os
 import pathlib
 
-DEBUG = True
 BASE_DIR = pathlib.Path(__file__).resolve().parent
+DEBUG = True
+SECRET_KEY = "xem*6no%8d9%^qzt2f3x3ar-uq4_+7h9myc$t0!+4%bj5us6f)"
+
+# Secrets
+CONNECT_SECRET = os.getenv("CONNECT_SECRET")
 MERCHANT_AUTH_LOGIN_ID = os.getenv("MERCHANT_AUTH_LOGIN_ID")
 MERCHANT_AUTH_TRANSACTION_KEY = os.getenv("MERCHANT_AUTH_TRANSACTION_KEY")
-SECRET_KEY = "xem*6no%8d9%^qzt2f3x3ar-uq4_+7h9myc$t0!+4%bj5us6f)"
 TWILIO_FROM_NUMBER = os.getenv("TWILIO_FROM_NUMBER")
 TWILIO_MESSAGING_SID = os.getenv("TWILIO_MESSAGING_SID")
 TWILIO_SID = os.getenv("TWILIO_SID")
 TWILIO_TOKEN = os.getenv("TWILIO_TOKEN")
 WIALON_ADMIN_ID = os.getenv("WIALON_ADMIN_ID")
 WIALON_TOKEN = os.getenv("WIALON_TOKEN")
-CONNECT_SECRET = os.getenv("CONNECT_SECRET")

terminusgps/wialon/constants.py

@@ -4,6 +4,12 @@ from typing import override
 from . import flags
 
 
+class WialonMeasurementUnit(enum.IntEnum):
+    METRIC = 0
+    US = 1
+    IMPERIAL = 2
+
+
 class WialonItemsType(enum.StrEnum):
     """
     Wialon item types for Wialon API calls.

terminusgps/wialon/items/base.py

@@ -1,7 +1,7 @@
 from abc import abstractmethod
 from typing import Type
 
-from terminusgps.wialon import flags
+from terminusgps.wialon import constants, flags
 from terminusgps.wialon.session import WialonSession
 
 
@@ -119,6 +119,26 @@ class WialonBase:
         """Creates a Wialon object and returns its id."""
         raise NotImplementedError("Subclasses must implement this method.")
 
+    def set_measurement_unit(
+        self,
+        unit: constants.WialonMeasurementUnit = constants.WialonMeasurementUnit.US,
+        convert: bool = False,
+    ) -> None:
+        """
+        Sets the Wialon object's measurement unit to ``unit``.
+
+        :param unit: A Wialon measurement unit.
+        :type unit: :py:obj:`~terminusgps.constants.WialonMeasurementUnit`
+        :param convert: Whether or not to convert the object's measurements before setting the new unit.
+        :type convert: :py:obj:`bool`
+        :returns: Nothing.
+        :rtype: :py:obj:`None`
+
+        """
+        self.session.wialon_api.item_update_measure_units(
+            **{"itemId": str(self.id), "type": unit, "flags": int(convert)}
+        )
+
     def rename(self, new_name: str) -> None:
         """
         Renames the Wialon object to the new name.

terminusgps/wialon/items/user.py

@@ -161,6 +161,24 @@ class WialonUser(WialonBase):
             **{"userId": self.id, "flags": flags, "flagsMask": flags_mask}
         )
 
+    def reset_password(self, username: str, email: str, url: str) -> None:
+        """
+        Sends a password reset email for a user to ``email``.
+
+        :param username: A Wialon user name.
+        :type username: :py:obj:`str`
+        :param email: A Wialon user email.
+        :type email: :py:obj:`str`
+        :param url: A password reset URL for the user.
+        :type url: :py:obj:`str`
+        :returns: Nothing.
+        :rtype: :py:obj:`None`
+
+        """
+        self.session.wialon_api.core_reset_password_request(
+            **{"user": username, "url": url, "email": email}
+        )
+
     def update_password(self, old_password: str, new_password: str) -> None:
         """
         Updates the password of the user.

terminusgps/wialon/session.py

@@ -105,13 +105,26 @@ class WialonSession:
         return f"{self.__class__}(sid={self.id})"
 
     def __enter__(self) -> "WialonSession":
-        """Logs into the Wialon API using a token set in :py:meth:`__init__`."""
+        """
+        Logs into the Wialon API using :py:meth:`login`.
+
+        :raises AssertionError: If the Wialon API token was not set.
+        :returns: A valid Wialon API session.
+        :rtype: :py:obj:`~terminusgps.wialon.session.WialonSession`
+
+        """
         assert self.token, "Wialon API token was not set"
         self.login(self.token)
         return self
 
     def __exit__(self, exc_type, exc_value, exc_traceback) -> None:
-        """Logs out of the session by calling :py:meth:`logout`."""
+        """
+        Logs out of the session by calling :py:meth:`logout`.
+
+        :returns: Nothing.
+        :rtype: :py:obj:`None`
+
+        """
         self.logout()
 
     @property

terminusgps/wialon/utils.py

@@ -7,6 +7,36 @@ from .items import WialonResource, WialonUnit
 from .session import WialonSession
 
 
+def get_user_by_name(name: str, session: WialonSession) -> WialonUnit | None:
+    """
+    Returns a Wialon user by name, if it exists.
+
+    :param name: A Wialon user name.
+    :type name: :py:obj:`str`
+    :param session: A valid Wialon API session.
+    :type session: :py:obj:`~terminusgps.wialon.session.WialonSession`
+    :returns: A Wialon unit, if any.
+    :rtype: :py:obj:`~terminusgps.wialon.items.unit.WialonUnit` | :py:obj:`None`
+
+    """
+    results: dict = session.wialon_api.core_search_items(
+        **{
+            "spec": {
+                "itemsType": constants.WialonItemsType.USER,
+                "propName": constants.WialonItemProperty.NAME,
+                "propValueMask": name,
+                "sortType": constants.WialonItemProperty.NAME,
+            },
+            "force": 0,
+            "flags": flags.DataFlag.USER_BASE,
+            "from": 0,
+            "to": 0,
+        }
+    )
+    if results and results.get("items", [{}]):
+        return WialonUnit(id=results.get("items", [{}])[0].get("id"), session=session)
+
+
 def get_carrier_names(session: WialonSession) -> list[str]:
     """
     Returns a list of all telecommunication carrier company names present in Wialon.