python-terminusgps 41.2.0__tar.gz → 41.3.0__tar.gz

{python_terminusgps-41.2.0 → python_terminusgps-41.3.0}/PKG-INFO

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

{python_terminusgps-41.2.0 → python_terminusgps-41.3.0}/docs/source/conf.py

@@ -18,7 +18,7 @@ django.setup()
 project = "python-terminusgps"
 copyright = "2025, Terminus GPS, LLC"
 author = "Terminus GPS, LLC"
-release = "41.2.0"
+release = "41.3.0"
 
 # -- General configuration ---------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration

{python_terminusgps-41.2.0 → python_terminusgps-41.3.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "python-terminusgps"
-version = "41.2.0"
+version = "41.3.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-41.3.0/terminusgps/wialon/items/__init__.py

@@ -0,0 +1 @@
+from .factory import WialonObjectFactory

{python_terminusgps-41.2.0 → python_terminusgps-41.3.0}/terminusgps/wialon/items/base.py

@@ -1,4 +1,4 @@
-from abc import abstractmethod
+from abc import ABC, abstractmethod
 from functools import wraps
 
 from terminusgps.wialon import constants, flags
@@ -16,7 +16,7 @@ def requires_id(meth):
     return wrapper
 
 
-class WialonObject:
+class WialonObject(ABC):
     """Base class for Wialon objects in a Wialon session."""
 
     def __init__(self, session: WialonSession, id: int | str | None = None) -> None:

python_terminusgps-41.3.0/terminusgps/wialon/items/factory.py

@@ -0,0 +1,50 @@
+from terminusgps.wialon.items.account import WialonAccount
+from terminusgps.wialon.items.base import WialonObject
+from terminusgps.wialon.items.resource import WialonResource
+from terminusgps.wialon.items.retranslator import WialonRetranslator
+from terminusgps.wialon.items.route import WialonRoute
+from terminusgps.wialon.items.unit import WialonUnit
+from terminusgps.wialon.items.unit_group import WialonUnitGroup
+from terminusgps.wialon.items.user import WialonUser
+from terminusgps.wialon.session import WialonSession
+
+WIALON_ITEMSTYPE_MAP = {
+    "account": WialonAccount,
+    "avl_hw": None,
+    "avl_resource": WialonResource,
+    "avl_retranslator": WialonRetranslator,
+    "avl_route": WialonRoute,
+    "avl_unit": WialonUnit,
+    "avl_unit_group": WialonUnitGroup,
+    "user": WialonUser,
+}
+
+
+class WialonObjectFactory:
+    """Creates and retrieves Wialon objects from Wialon."""
+
+    def __init__(self, session: WialonSession) -> None:
+        # TODO: Add session refreshing
+        self.session = session
+
+    def get(self, id: int | str, items_type: str) -> WialonObject:
+        """Returns a Wialon object that already exists in Wialon by id."""
+        if isinstance(id, str) and not id.isdigit():
+            raise ValueError(f"'id' can only be digits, got '{id}'.")
+        if items_type not in WIALON_ITEMSTYPE_MAP:
+            raise ValueError(f"Invalid Wialon items type: '{items_type}'.")
+        cls = WIALON_ITEMSTYPE_MAP.get(items_type)
+        if cls is None:
+            raise ValueError(f"Wialon items type '{items_type}' is not implemented.")
+        return cls(session=self.session, id=int(id))
+
+    def create(self, items_type: str, *args, **kwargs) -> WialonObject:
+        """Returns a Wialon object after creating it in Wialon."""
+        if items_type not in WIALON_ITEMSTYPE_MAP:
+            raise ValueError(f"Invalid Wialon items type: '{items_type}'.")
+        cls = WIALON_ITEMSTYPE_MAP.get(items_type)
+        if cls is None:
+            raise ValueError(f"Wialon items type '{items_type}' is not implemented.")
+        obj = cls(session=self.session, id=None)
+        obj.create(*args, **kwargs)
+        return obj

{python_terminusgps-41.2.0 → python_terminusgps-41.3.0}/terminusgps/wialon/utils.py

@@ -2,9 +2,10 @@ import secrets
 import string
 import typing
 
-from . import flags
-from .items import WialonUnit
-from .session import WialonSession
+from terminusgps.wialon import flags
+from terminusgps.wialon.items.unit import WialonUnit
+from terminusgps.wialon.items.user import WialonUser
+from terminusgps.wialon.session import WialonSession
 
 
 def get_hw_types(session: WialonSession) -> list[dict[str, str | int]]:
@@ -30,7 +31,7 @@ def get_hw_types(session: WialonSession) -> list[dict[str, str | int]]:
     return session.wialon_api.core_get_hw_types()
 
 
-def get_user_by_name(name: str, session: WialonSession) -> WialonUnit | None:
+def get_user_by_name(name: str, session: WialonSession) -> WialonUser | None:
     """
     Returns a Wialon user by name, if it exists.
 
@@ -58,8 +59,8 @@ def get_user_by_name(name: str, session: WialonSession) -> WialonUnit | None:
         }
     )
     if int(response.get("totalItemsCount")) == 1:
-        if unit_id := int(response.get("items")[0].get("id")):
-            return WialonUnit(session, unit_id)
+        if user_id := int(response.get("items")[0].get("id")):
+            return WialonUser(session, user_id)
 
 
 def get_carrier_names(session: WialonSession) -> list[str]:

{python_terminusgps-41.2.0 → python_terminusgps-41.3.0}/uv.lock

@@ -298,7 +298,7 @@ wheels = [
 
 [[package]]
 name = "python-terminusgps"
-version = "41.2.0"
+version = "41.3.0"
 source = { editable = "." }
 dependencies = [
     { name = "authorizenet" },

python_terminusgps-41.2.0/terminusgps/wialon/factory.py

@@ -1,60 +0,0 @@
-from terminusgps.wialon.items import (
-    WialonAccount,
-    WialonResource,
-    WialonRetranslator,
-    WialonRoute,
-    WialonUnit,
-    WialonUnitGroup,
-    WialonUser,
-)
-from terminusgps.wialon.items.base import WialonObject
-from terminusgps.wialon.session import WialonSession
-
-WIALON_ITEM_MAP = {
-    "account": WialonAccount,
-    "avl_hw": None,
-    "avl_resource": WialonResource,
-    "avl_retranslator": WialonRetranslator,
-    "avl_route": WialonRoute,
-    "avl_unit": WialonUnit,
-    "avl_unit_group": WialonUnitGroup,
-    "user": WialonUser,
-}
-
-
-class WialonObjectCreationError(Exception):
-    """Raised when a factory fails to create a Wialon object."""
-
-
-def create_wialon_object(
-    session: WialonSession, items_type: str, *args, **kwargs
-) -> WialonObject:
-    """
-    Creates an ``items_type`` object in Wialon and returns it as a Python object.
-
-    :param session: A valid Wialon API session.
-    :type session: :py:obj:`~terminusgps.wialon.session.WialonSession`
-    :param items_type: A Wialon items type string.
-    :type items_type: :py:obj:`str`
-    :param args: Positional arguments to pass to the Wialon object's :py:meth:`create` method.
-    :param kwargs: Keyword arguments to pass to the Wialon object's :py:meth:`create` method.
-    :raises WialonAPIError: If something went wrong calling the Wialon API.
-    :raises WialonObjectCreationError: If something went wrong creating the object in Wialon.
-    :returns: A Wialon object.
-    :rtype: :py:obj:`~terminusgps.wialon.items.base.WialonObject`
-
-    """
-    if items_type not in WIALON_ITEM_MAP:
-        raise ValueError(f"Unknown Wialon items type: '{items_type}'.")
-
-    cls = WIALON_ITEM_MAP.get(items_type)
-    if cls is None:
-        raise ValueError(f"Wialon items type '{items_type}' is not implemented.")
-
-    obj = cls(session)
-    obj.create(*args, **kwargs)
-    if not obj.id:
-        raise WialonObjectCreationError(
-            f"Failed to execute create({args = }, {kwargs = }) on '{obj}'."
-        )
-    return obj

python_terminusgps-41.2.0/terminusgps/wialon/items/__init__.py

@@ -1,7 +0,0 @@
-from .account import WialonAccount
-from .resource import WialonResource
-from .retranslator import WialonRetranslator
-from .route import WialonRoute
-from .unit import WialonUnit
-from .unit_group import WialonUnitGroup
-from .user import WialonUser