python-terminusgps 41.0.1__py3-none-any.whl → 41.2.0__py3-none-any.whl

{python_terminusgps-41.0.1.dist-info → python_terminusgps-41.2.0.dist-info}/METADATA

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

@@ -22,6 +22,7 @@ terminusgps/django/forms/renderer.py,sha256=QSLQ94Ff7ZaV1jD6wAL-ltvdKIblED8Wsv5E
 terminusgps/django/forms/widgets.py,sha256=No4hPQ-BK5rrotaQ5iJEjWo8quYIPNf_1C2y4OAIxro,2037
 terminusgps/wialon/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 terminusgps/wialon/constants.py,sha256=p2BhopeE6lXzjzdzb4ZKOz0rhJQIMUbXLrBy1Yzf57s,13730
+terminusgps/wialon/factory.py,sha256=owo2vak98XvMDhKevDE20pld2-IXZk2VtTkaHmth-6k,2013
 terminusgps/wialon/flags.py,sha256=M50EdhxQ8IMnJnU0mrHK7-h8Asc6tvNiTOOfd1dBW6A,12815
 terminusgps/wialon/session.py,sha256=jQbPmQy6z7ghhgflRemybn8_uoCnCJzuTcbovLHFpI4,5795
 terminusgps/wialon/utils.py,sha256=GH1l9IgO2cAp2_lI3K3R6MDy3BlFUiOQF4YFzqMx8l4,8891
@@ -35,7 +36,7 @@ terminusgps/wialon/items/route.py,sha256=xixlex6bUeFHXucVQdbfQUSLxI1Rhwk6slhoFP2
 terminusgps/wialon/items/unit.py,sha256=kfiqysdPxiU_8fHomKZEz3Ypbkaoc5HevOzpqr7R7rI,5189
 terminusgps/wialon/items/unit_group.py,sha256=L7-PAVCj8Bf50fa04Ials4VHg8LOWkw6hwNhtSyMksE,2133
 terminusgps/wialon/items/user.py,sha256=hZlFeXCgOAdivl_Anjp_We6Cy5U8IxWNDAgm5MFZfp0,5194
-python_terminusgps-41.0.1.dist-info/METADATA,sha256=PAD08KI7bPW2nNpxQL59gR3Gd6iVmwgR7Ev6lzd9H6M,976
-python_terminusgps-41.0.1.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-python_terminusgps-41.0.1.dist-info/licenses/COPYING,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
-python_terminusgps-41.0.1.dist-info/RECORD,,
+python_terminusgps-41.2.0.dist-info/METADATA,sha256=xhBTSSSzCvaeC0HHM-S9Pbg-H95jRJQL1_8gbajdg9c,976
+python_terminusgps-41.2.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+python_terminusgps-41.2.0.dist-info/licenses/COPYING,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
+python_terminusgps-41.2.0.dist-info/RECORD,,

terminusgps/wialon/factory.py

@@ -0,0 +1,60 @@
+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