python-terminusgps 50.0.0__tar.gz → 50.1.0__tar.gz

{python_terminusgps-50.0.0 → python_terminusgps-50.1.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-terminusgps
-Version: 50.0.0
+Version: 50.1.0
 Summary: Provides abstractions/utilities for working with Wialon API, Authorize.NET API, AWS API, and more.
 Project-URL: Documentation, https://terminusgps.github.io/python-terminusgps
 Project-URL: Repository, https://github.com/terminusgps/python-terminusgps

{python_terminusgps-50.0.0 → python_terminusgps-50.1.0}/docs/source/conf.py

@@ -12,7 +12,7 @@ sys.path.insert(0, os.path.abspath("../../"))
 project = "python-terminusgps"
 copyright = "2025, Terminus GPS, LLC"
 author = "Terminus GPS, LLC"
-release = "50.0.0"
+release = "50.1.0"
 
 # -- General configuration ---------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration

{python_terminusgps-50.0.0 → python_terminusgps-50.1.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "python-terminusgps"
-version = "50.0.0"
+version = "50.1.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-50.0.0 → python_terminusgps-50.1.0}/terminusgps/authorizenet/service.py

@@ -1,4 +1,3 @@
-from abc import ABC
 from functools import cached_property
 
 from authorizenet.apicontractsv1 import merchantAuthenticationType
@@ -35,8 +34,8 @@ class AuthorizenetControllerExecutionError(Exception):
         return self._code
 
 
-class AuthorizenetService(ABC):
-    """Base service for safely interacting with the Authorizenet API."""
+class AuthorizenetService:
+    """Service for safely interacting with the Authorizenet API."""
 
     REQUIRED_SETTINGS = (
         "MERCHANT_AUTH_ENVIRONMENT",

{python_terminusgps-50.0.0 → python_terminusgps-50.1.0}/terminusgps/wialon/utils.py

@@ -1,31 +1,89 @@
 import secrets
 import string
+import typing
 
 from terminusgps.wialon.session import WialonSession
 
+__all__ = [
+    "generate_wialon_password",
+    "get_unit_from_iccid",
+    "get_unit_from_imei",
+    "get_units_from_carrier",
+]
 
-def get_id_from_iccid(
+
+def generate_wialon_password(length: int = 32) -> str:
+    """
+    Generates a Wialon compliant password between ``8`` and ``64`` characters.
+
+    The generated password will contain:
+
+        - At least one uppercase letter.
+        - At least one lowercase letter.
+        - At least one special symbol.
+        - At least three digits.
+
+    :param length: Length of the generated password. Default is ``32``.
+    :type length: int
+    :raises ValueError: If ``length`` was less than ``8`` or greater than ``64``.
+    :returns: A Wialon compliant password.
+    :rtype: str
+
+    """
+    if length > 64:
+        raise ValueError(
+            f"Password cannot be greater than 64 characters in length, got {length}."
+        )
+    elif length < 8:
+        raise ValueError(
+            f"Password cannot be less than 8 characters in length, got {length}."
+        )
+
+    s0 = list(string.ascii_uppercase)
+    s1 = list(string.ascii_lowercase)
+    s2 = list(string.digits)
+    s3 = list("!@#$%^*()[]-_+")
+
+    while True:
+        password = "".join(
+            [secrets.choice(s0 + s1 + s2 + s3) for _ in range(length)]
+        )
+        if (
+            any(c.islower() for c in password)
+            and any(c.isupper() for c in password)
+            and sum(c.isdigit() for c in password) >= 3
+            and any(c in s3 for c in password)
+        ):
+            break
+    return password
+
+
+def get_unit_from_iccid(
     iccid: str,
     session: WialonSession,
     *,
+    flags: int = 1,
     use_cache: bool = True,
     afield_key: str = "iccid",
-) -> int | None:
+) -> dict[str, typing.Any]:
     """
-    Returns a Wialon unit ID from a telecom iccid.
+    Returns a Wialon unit from a telecom iccid.
 
     :param iccid: A telecom iccid number.
     :type iccid: str
     :param session: A valid Wialon API session.
     :type session: ~terminusgps.wialon.session.WialonSession
+    :param flags: Wialon API response format flags. Default is ``1``.
+    :type flags: int
     :param use_cache: Whether to use a cached Wialon API response or force a Wialon API call. Default is :py:obj:`True`.
     :type use_cache: bool
     :param afield_key: Admin field key to search against. Default is ``"iccid"``.
     :type afield_key: str
     :raises ValueError: If multiple units were found with the provided iccid.
     :raises ValueError: If zero units were found with the provided iccid.
-    :returns: A Wialon unit ID, if found.
-    :rtype: int | None
+    :raises WialonAPIError: If something went wrong calling the Wialon API.
+    :returns: A Wialon unit dictionary.
+    :rtype: dict[str, ~typing.Any]
 
     """
     response = session.wialon_api.core_search_items(
@@ -38,7 +96,7 @@ def get_id_from_iccid(
                 "propType": "admin_fields,admin_fields",
             },
             "force": int(not use_cache),
-            "flags": 1,
+            "flags": flags,
             "from": 0,
             "to": 0,
         }
@@ -47,12 +105,16 @@ def get_id_from_iccid(
         raise ValueError(f"Multiple units found for iccid #{iccid}.")
     elif int(response["totalItemsCount"]) == 0:
         raise ValueError(f"No units found for iccid #{iccid}.")
-    return int(response["items"][0]["id"])
+    return response["items"][0]
 
 
-def get_id_from_imei(
-    imei: str, session: WialonSession, *, use_cache: bool = True
-) -> int | None:
+def get_unit_from_imei(
+    imei: str,
+    session: WialonSession,
+    *,
+    flags: int = 1,
+    use_cache: bool = True,
+) -> dict[str, typing.Any]:
     """
     Returns a Wialon unit ID from an IMEI (sys_unique_id) number.
 
@@ -60,12 +122,15 @@ def get_id_from_imei(
     :type imei: str
     :param session: A valid Wialon API session.
     :type session: ~terminusgps.wialon.session.WialonSession
+    :param flags: Wialon API response format flags. Default is ``1``.
+    :type flags: int
     :param use_cache: Whether to use a cached Wialon API response or force a Wialon API call. Default is :py:obj:`True`.
     :type use_cache: bool
     :raises ValueError: If multiple units were found with the provided IMEI number.
     :raises ValueError: If zero units were found with the provided IMEI number.
-    :returns: A Wialon unit ID, if found.
-    :rtype: int | None
+    :raises WialonAPIError: If something went wrong calling the Wialon API.
+    :returns: A Wialon unit dictionary.
+    :rtype: dict[str, ~typing.Any]
 
     """
     response = session.wialon_api.core_search_items(
@@ -78,7 +143,7 @@ def get_id_from_imei(
                 "propType": "property",
             },
             "force": int(not use_cache),
-            "flags": 1,
+            "flags": flags,
             "from": 0,
             "to": 0,
         }
@@ -87,16 +152,19 @@ def get_id_from_imei(
         raise ValueError(f"Multiple units found for IMEI #{imei}.")
     elif int(response["totalItemsCount"]) == 0:
         raise ValueError(f"No units found for IMEI #{imei}.")
-    return int(response["items"][0]["id"])
+    return response["items"][0]
 
 
-def get_ids_from_carrier(
+def get_units_from_carrier(
     carrier: str,
     session: WialonSession,
     *,
     use_cache: bool = True,
     afield_key: str = "carrier",
-) -> list[int]:
+    flags: int = 1,
+    start: int = 0,
+    end: int = 0,
+) -> list[dict[str, typing.Any]]:
     """
     Returns a list of Wialon unit IDs by telecom carrier name.
 
@@ -110,8 +178,15 @@ def get_ids_from_carrier(
     :type use_cache: bool
     :param afield_key: Admin field key to search against. Default is ``"carrier"``.
     :type afield_key: str
-    :returns: A list of Wialon unit IDs, if any were found.
-    :rtype: list[int]
+    :param flags: Wialon API response flags. Default is ``1``.
+    :type flags: int
+    :param start: Start index. Default is ``0``.
+    :type start: int
+    :param end: End index. Default is ``0``.
+    :type end: int
+    :raises WialonAPIError: If something went wrong calling the Wialon API.
+    :returns: A list of Wialon unit dictionaries.
+    :rtype: list[dict[str, ~typing.Any]]
 
     """
     response = session.wialon_api.core_search_items(
@@ -124,57 +199,11 @@ def get_ids_from_carrier(
                 "propType": "admin_fields,admin_fields",
             },
             "force": int(not use_cache),
-            "flags": 1,
-            "from": 0,
-            "to": 0,
+            "flags": flags,
+            "from": start,
+            "to": end,
         }
     )
     if int(response["totalItemsCount"]) == 0:
         return []
-    return [int(unit["id"]) for unit in response["items"]]
-
-
-def generate_wialon_password(length: int = 32) -> str:
-    """
-    Generates a Wialon compliant password between ``8`` and ``64`` characters.
-
-    The generated password will contain:
-
-        - At least one uppercase letter.
-        - At least one lowercase letter.
-        - At least one special symbol.
-        - At least three digits.
-
-    :param length: Length of the generated password. Default is ``32``.
-    :type length: int
-    :raises ValueError: If ``length`` was less than ``8`` or greater than ``64``.
-    :returns: A Wialon compliant password.
-    :rtype: str
-
-    """
-    if length > 64:
-        raise ValueError(
-            f"Password cannot be greater than 64 characters in length, got {length}."
-        )
-    elif length < 8:
-        raise ValueError(
-            f"Password cannot be less than 8 characters in length, got {length}."
-        )
-
-    s0 = list(string.ascii_uppercase)
-    s1 = list(string.ascii_lowercase)
-    s2 = list(string.digits)
-    s3 = list("!@#$%^*()[]-_+")
-
-    while True:
-        password = "".join(
-            [secrets.choice(s0 + s1 + s2 + s3) for _ in range(length)]
-        )
-        if (
-            any(c.islower() for c in password)
-            and any(c.isupper() for c in password)
-            and sum(c.isdigit() for c in password) >= 3
-            and any(c in s3 for c in password)
-        ):
-            break
-    return password
+    return response["items"]

{python_terminusgps-50.0.0 → python_terminusgps-50.1.0}/uv.lock

@@ -748,7 +748,7 @@ wheels = [
 
 [[package]]
 name = "python-terminusgps"
-version = "50.0.0"
+version = "50.1.0"
 source = { editable = "." }
 dependencies = [
     { name = "authorizenet" },
@@ -820,13 +820,25 @@ wheels = [
     { url = "https://files.pythonhosted.org/packages/1e/db/4254e3eabe8020b458f1a747140d32277ec7a271daf1d235b70dc0b4e6e3/requests-2.32.5-py3-none-any.whl", hash = "sha256:2462f94637a34fd532264295e186976db0f5d453d1cdd31473c85a6a161affb6", size = 64738 },
 ]
 
+[[package]]
+name = "roman-numerals"
+version = "4.0.0"
+source = { registry = "https://pypi.org/simple" }
+sdist = { url = "https://files.pythonhosted.org/packages/6b/20/a6b20239f54814de5c34bf3f504e553b11780c2aad3677ad2daf989f1fb3/roman_numerals-4.0.0.tar.gz", hash = "sha256:231287018a8788bf8c0718482a08c15b90458523ea1d840a18a791a86d4583b3", size = 9027 }
+wheels = [
+    { url = "https://files.pythonhosted.org/packages/ad/9d/ad950fd3b65cf0974c633862320829f3d461aef125b981504277c8409a93/roman_numerals-4.0.0-py3-none-any.whl", hash = "sha256:4131feb23ba1a542494873e4cee7844ec8d226a750134efc65ceb20939ed33c9", size = 7668 },
+]
+
 [[package]]
 name = "roman-numerals-py"
-version = "3.1.0"
+version = "4.0.0"
 source = { registry = "https://pypi.org/simple" }
-sdist = { url = "https://files.pythonhosted.org/packages/30/76/48fd56d17c5bdbdf65609abbc67288728a98ed4c02919428d4f52d23b24b/roman_numerals_py-3.1.0.tar.gz", hash = "sha256:be4bf804f083a4ce001b5eb7e3c0862479d10f94c936f6c4e5f250aa5ff5bd2d", size = 9017 }
+dependencies = [
+    { name = "roman-numerals" },
+]
+sdist = { url = "https://files.pythonhosted.org/packages/7e/02/6cb667fc1872c5fe814971be2973317f0747d86f1c0aac37d0e1a1df1ecc/roman_numerals_py-4.0.0.tar.gz", hash = "sha256:f7fa8dff5b7b7251d3a7586b97c57a0698e2e28898fa42c23bcc0cf51b02aee9", size = 1119 }
 wheels = [
-    { url = "https://files.pythonhosted.org/packages/53/97/d2cbbaa10c9b826af0e10fdf836e1bf344d9f0abb873ebc34d1f49642d3f/roman_numerals_py-3.1.0-py3-none-any.whl", hash = "sha256:9da2ad2fb670bcf24e81070ceb3be72f6c11c440d73bd579fbeca1e9f330954c", size = 7742 },
+    { url = "https://files.pythonhosted.org/packages/d2/b7/c0aa3b0154e022faa8e8b4eadda0c49f53b09b6b8d55ed3b7cd311abfd92/roman_numerals_py-4.0.0-py3-none-any.whl", hash = "sha256:dfcecf6e0cddbf2ee1112e7e2ebf58ba771984f075cb57a30e1811cee4f06332", size = 1244 },
 ]
 
 [[package]]