python-terminusgps 45.6.1__py3-none-any.whl → 45.7.0__py3-none-any.whl

{python_terminusgps-45.6.1.dist-info → python_terminusgps-45.7.0.dist-info}/METADATA

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

@@ -3,16 +3,14 @@ terminusgps/default_settings.py,sha256=7GLW3RlkuTbpj82KSWjcbgf-unEmrPvKCyLci14LG
 terminusgps/mixins.py,sha256=Q9ZJuzpk3d9lDnlVA8ZTVvnZWxB13p08EQ8yVJcztn4,1034
 terminusgps/validators.py,sha256=Mf0c7ku_wTQ7uv4hcLRyz0r2eRjvznIL77LLTE5uJ6E,9152
 terminusgps/authorizenet/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-terminusgps/authorizenet/auth.py,sha256=T4lPm6eq2ZRoPffLg6GrLZn7wUZ-RTBNi0epyw6ph_w,1035
 terminusgps/authorizenet/constants.py,sha256=--3DNOw3_gjh2BIEqP3Jel5TvZsdoptYV17B4sg9bK0,2131
-terminusgps/authorizenet/controllers.py,sha256=gmsvCVzGglmhIu3_TJpzOlel19cNuLiN7CCnaNM-Lm0,2072
-terminusgps/authorizenet/services.py,sha256=oNnY9Sk4k7IbASnggavPUqlCj98OfBa-uuUE2xlKtXg,2496
+terminusgps/authorizenet/service.py,sha256=MKtudM2vwmBytCneZsQ9PDAX-RO4Ma2sPL6ZwEcHDms,4198
 terminusgps/authorizenet/api/__init__.py,sha256=VXR4Yco1yz5R-R7vgaH2zTP9VFqzfvvGy_XJVjyb3i0,154
 terminusgps/authorizenet/api/address_profiles.py,sha256=VouUN6dIxlnuE3qEiacFqqDBi_VtwvSbsELqTqFZ0BE,4746
 terminusgps/authorizenet/api/customer_profiles.py,sha256=oya9KMRE10nKLjECTIdanfV_P8-gnNZLE0sYmRYVkgM,4505
 terminusgps/authorizenet/api/payment_profiles.py,sha256=s-telQZXdq6bu5TxWVYv5xBNHWq81ve_hQVrRlqoBb0,8089
 terminusgps/authorizenet/api/subscriptions.py,sha256=VAXKjOHLOfifrixObK6XbiJCmPobkYBzXJQrjtos9LE,4542
-terminusgps/authorizenet/api/transactions.py,sha256=drymc7uplWHOoaMmatz8nP1gDN_GDef0QVJBqB9oIfE,20
+terminusgps/authorizenet/api/transactions.py,sha256=YS674zn_oumWlK5zZrF8Isu0On_MAL8xBU9zUVEGx8E,3686
 terminusgps/wialon/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 terminusgps/wialon/constants.py,sha256=p2BhopeE6lXzjzdzb4ZKOz0rhJQIMUbXLrBy1Yzf57s,13730
 terminusgps/wialon/flags.py,sha256=M50EdhxQ8IMnJnU0mrHK7-h8Asc6tvNiTOOfd1dBW6A,12815
@@ -29,7 +27,7 @@ terminusgps/wialon/items/route.py,sha256=9hmRBEFRJF3lKukv_y3blZxqxv75YgFCcRALrU6
 terminusgps/wialon/items/unit.py,sha256=B5iuGEghu89SL8KzYLUytYNRa8cogsVtf-bJ_RybPTA,5522
 terminusgps/wialon/items/unit_group.py,sha256=MIR0x5IlTjcnwx8Y9wXLNTql-wwVVj7NCe7dL2vOw4c,2131
 terminusgps/wialon/items/user.py,sha256=CRSICiJ-qzybEO_gXuKyzW5oa2RQeIp0SzX9ARcdME4,5151
-python_terminusgps-45.6.1.dist-info/METADATA,sha256=BBwcaIviUs-BQVicJ4DQiWMo7OO32HOVdzUoim0ryhk,938
-python_terminusgps-45.6.1.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-python_terminusgps-45.6.1.dist-info/licenses/COPYING,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
-python_terminusgps-45.6.1.dist-info/RECORD,,
+python_terminusgps-45.7.0.dist-info/METADATA,sha256=Algwc2rwWNixwYnpupTI7AaSXiVT9S86s8GGOlqTb5o,938
+python_terminusgps-45.7.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+python_terminusgps-45.7.0.dist-info/licenses/COPYING,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
+python_terminusgps-45.7.0.dist-info/RECORD,,

terminusgps/authorizenet/api/transactions.py

@@ -1,2 +1,100 @@
-# TODO
+from decimal import Decimal
+
+from authorizenet import apicontractsv1, apicontrollers
+from authorizenet.apicontrollersbase import APIOperationBase
+from lxml.objectify import ObjectifiedElement
+
 __all__ = []
+
+
+def build_transaction_request(
+    transaction_type: str,
+    amount: Decimal,
+    payment: apicontractsv1.paymentType | None = None,
+    order: apicontractsv1.orderType | None = None,
+    address: apicontractsv1.customerAddressType | None = None,
+    customer_data: apicontractsv1.customerDataType | None = None,
+    settings: apicontractsv1.settingType | None = None,
+    line_items: apicontractsv1.ArrayOfLineItem | None = None,
+) -> apicontractsv1.transactionRequestType:
+    request = apicontractsv1.transactionRequestType()
+    request.transactionType = transaction_type
+    request.amount = amount
+
+    if payment is not None:
+        request.payment = payment
+    if order is not None:
+        request.order = order
+    if address is not None:
+        request.billTo = address
+    if customer_data is not None:
+        request.customer = customer_data
+    if settings is not None:
+        request.transactionSettings = settings
+    if line_items is not None:
+        request.lineItems = line_items
+    return request
+
+
+def charge_credit_card(
+    amount: Decimal,
+    credit_card: apicontractsv1.creditCardType,
+    address: apicontractsv1.customerAddressType,
+    order: apicontractsv1.orderType | None = None,
+    customer_data: apicontractsv1.customerDataType | None = None,
+    settings: apicontractsv1.settingType | None = None,
+) -> tuple[ObjectifiedElement, type[APIOperationBase]]:
+    request = apicontractsv1.createTransactionRequest()
+    request.transactionRequest = build_transaction_request(
+        transaction_type="authCaptureTransaction",
+        amount=amount,
+        payment=apicontractsv1.paymentType(creditCard=credit_card),
+        address=address,
+        order=order,
+        customer_data=customer_data,
+        settings=settings,
+    )
+    return request, apicontrollers.createTransactionController
+
+
+def authorize_credit_card(
+    amount: Decimal,
+    credit_card: apicontractsv1.creditCardType,
+    address: apicontractsv1.customerAddressType,
+    order: apicontractsv1.orderType | None = None,
+    customer_data: apicontractsv1.customerDataType | None = None,
+    settings: apicontractsv1.settingType | None = None,
+) -> tuple[ObjectifiedElement, type[APIOperationBase]]:
+    request = apicontractsv1.createTransactionRequest()
+    request.transactionRequest = build_transaction_request(
+        transaction_type="authOnlyTransaction",
+        amount=amount,
+        payment=apicontractsv1.paymentType(creditCard=credit_card),
+        address=address,
+        order=order,
+        customer_data=customer_data,
+        settings=settings,
+    )
+    return request, apicontrollers.createTransactionController
+
+
+def capture_authorized_amount(
+    amount: Decimal,
+) -> tuple[ObjectifiedElement, type[APIOperationBase]]:
+    request = apicontractsv1.createTransactionRequest()
+    request.transactionRequest = build_transaction_request(
+        transaction_type="priorAuthCaptureTransaction", amount=amount
+    )
+    return request, apicontrollers.createTransactionController
+
+
+def refund_credit_card(
+    amount: Decimal, credit_card: apicontractsv1.creditCardType
+) -> tuple[ObjectifiedElement, type[APIOperationBase]]:
+    request = apicontractsv1.createTransactionRequest()
+    request.transactionRequest = build_transaction_request(
+        transaction_type="refundTransaction",
+        amount=amount,
+        payment=apicontractsv1.paymentType(creditCard=credit_card),
+    )
+    return request, apicontrollers.createTransactionController

terminusgps/authorizenet/service.py

@@ -0,0 +1,112 @@
+from functools import cached_property
+
+from authorizenet.apicontractsv1 import merchantAuthenticationType
+from authorizenet.apicontrollersbase import APIOperationBase
+from django.conf import settings
+from django.core.exceptions import ImproperlyConfigured
+from lxml.objectify import ObjectifiedElement
+
+if not settings.configured:
+    from terminusgps import default_settings
+
+    settings.configure(default_settings)
+
+
+class AuthorizenetControllerExecutionError(Exception):
+    """Raised when an Authorizenet API controller fails to execute."""
+
+    def __init__(self, message: str, code: str, *args, **kwargs) -> None:
+        super().__init__(message, *args, **kwargs)
+        self._message: str = message
+        self._code: str = code
+
+    def __str__(self) -> str:
+        return f"{self.code}: {self.message}"
+
+    @property
+    def message(self) -> str:
+        """An Authorizenet API error message."""
+        return self._message
+
+    @property
+    def code(self) -> str:
+        """An Authorizenet API error code."""
+        return self._code
+
+
+class AuthorizenetService:
+    """A service for safely interacting with the Authorizenet API."""
+
+    REQUIRED_SETTINGS = (
+        "MERCHANT_AUTH_ENVIRONMENT",
+        "MERCHANT_AUTH_LOGIN_ID",
+        "MERCHANT_AUTH_TRANSACTION_KEY",
+        "MERCHANT_AUTH_VALIDATION_MODE",
+    )
+
+    def __init__(self) -> None:
+        """Raises :py:exc:`~django.core.exceptions.ImproperlyConfigured` if required settings weren't set."""
+        for setting in self.REQUIRED_SETTINGS:
+            if not hasattr(settings, setting):
+                raise ImproperlyConfigured(f"'{setting}' setting is required.")
+
+    def call_api(
+        self,
+        request: ObjectifiedElement,
+        controller_cls: type[APIOperationBase],
+        reference_id: str | None = None,
+    ) -> ObjectifiedElement:
+        """
+        Adds required authentication data to the request before executing it and returning its response.
+
+        If ``reference_id`` was provided, it is added to the request before execution.
+
+        :param request: An Authorizenet API request element.
+        :type request: ~lxml.objectify.ObjectifiedElement
+        :param controller_cls: An Authorizenet controller class.
+        :type controller_cls: type[~authorizenet.apicontrollersbase.APIOperationBase]
+        :param reference_id: An optional reference id string for the API call. Default is :py:obj:`None`.
+        :type reference_id: str | None
+        :raises AuthorizenetControllerExecutionError: If the API call failed.
+        :returns: An Authorizenet API response.
+        :rtype: ~lxml.objectify.ObjectifiedElement
+
+        """
+        request.merchantAuthentication = self.merchantAuthentication
+        if reference_id is not None:
+            request.refId = reference_id
+
+        controller = controller_cls(request)
+        controller.setenvironment(self.environment)
+        controller.execute()
+
+        response: ObjectifiedElement | None = controller.getresponse()
+        if response is None:
+            raise AuthorizenetControllerExecutionError(
+                message="No response from the Authorizenet API controller.",
+                code="1",
+            )
+        elif response is not None and response.messages.resultCode != "Ok":
+            raise AuthorizenetControllerExecutionError(
+                message=response.messages.message[0]["text"].text,
+                code=response.messages.message[0]["code"].text,
+            )
+        return response
+
+    @cached_property
+    def merchantAuthentication(self) -> merchantAuthenticationType:
+        """Merchant authentication element for Authorizenet API requests."""
+        return merchantAuthenticationType(
+            name=str(settings.MERCHANT_AUTH_LOGIN_ID),
+            transactionKey=str(settings.MERCHANT_AUTH_TRANSACTION_KEY),
+        )
+
+    @cached_property
+    def environment(self) -> str:
+        """Environment for Authorizenet API requests."""
+        return str(settings.MERCHANT_AUTH_ENVIRONMENT)
+
+    @cached_property
+    def validationMode(self) -> str:
+        """Validation mode for Authorizenet API requests."""
+        return str(settings.MERCHANT_AUTH_VALIDATION_MODE)

terminusgps/authorizenet/auth.py

@@ -1,38 +0,0 @@
-from authorizenet.apicontractsv1 import merchantAuthenticationType
-from django.conf import settings
-
-
-def get_merchant_auth() -> merchantAuthenticationType:
-    """
-    Returns the merchant authentication information for Authorizenet API controller execution.
-
-    :returns: A merchant authentication object.
-    :rtype: ~authorizenet.apicontractsv1.merchantAuthenticationType
-
-    """
-    return merchantAuthenticationType(
-        name=str(settings.MERCHANT_AUTH_LOGIN_ID),
-        transactionKey=str(settings.MERCHANT_AUTH_TRANSACTION_KEY),
-    )
-
-
-def get_environment() -> str:
-    """
-    Returns the environment for Authorizenet API controller execution.
-
-    :returns: An Authorizenet API environment string.
-    :rtype: str
-
-    """
-    return settings.MERCHANT_AUTH_ENVIRONMENT
-
-
-def get_validation_mode() -> str:
-    """
-    Returns the validation mode for Authorizenet API controller execution.
-
-    :returns: An Authorizenet API validation string.
-    :rtype: str
-
-    """
-    return settings.MERCHANT_AUTH_VALIDATION_MODE

terminusgps/authorizenet/controllers.py

@@ -1,57 +0,0 @@
-from authorizenet.apicontrollersbase import APIOperationBase
-from lxml.objectify import ObjectifiedElement
-
-
-def execute_controller(
-    controller: APIOperationBase, environment: str
-) -> ObjectifiedElement:
-    """
-    Executes an Authorizenet API controller and returns its response.
-
-    :param controller: An Authorizenet API controller.
-    :type controller: ~authorizenet.apicontrollersbase.APIOperationBase
-    :param environment: Authorizenet environment to execute the controller in.
-    :type environment: :py:obj:`str`
-    :param merchant_auth: Authorizenet merchant authentication element.
-    :type merchant_auth: ~authorizenet.apicontractsv1.merchantAuthenticationType
-    :raises AuthorizenetControllerExecutionError: If the API call fails.
-    :returns: An Authorizenet API response.
-    :rtype: ~lxml.objectify.ObjectifiedElement
-
-    """
-    controller.setenvironment(environment)
-    controller.execute()
-    response: ObjectifiedElement | None = controller.getresponse()
-
-    if response is None:
-        raise AuthorizenetControllerExecutionError(
-            message="Authorizenet controller response didn't exist.", code="1"
-        )
-    elif response is not None and response.messages.resultCode != "Ok":
-        raise AuthorizenetControllerExecutionError(
-            message=response.messages.message[0]["text"].text,
-            code=response.messages.message[0]["code"].text,
-        )
-    return response
-
-
-class AuthorizenetControllerExecutionError(Exception):
-    """Raised when an Authorizenet API controller fails to execute."""
-
-    def __init__(self, message: str, code: str, *args, **kwargs) -> None:
-        super().__init__(message, *args, **kwargs)
-        self._message: str = message
-        self._code: str = code
-
-    def __str__(self) -> str:
-        return f"{self.code}: {self.message}"
-
-    @property
-    def message(self) -> str:
-        """An Authorizenet API error message."""
-        return self._message
-
-    @property
-    def code(self) -> str:
-        """An Authorizenet API error code."""
-        return self._code

terminusgps/authorizenet/services.py

@@ -1,66 +0,0 @@
-from functools import cached_property
-from typing import Callable
-
-from authorizenet.apicontractsv1 import merchantAuthenticationType
-from django.conf import settings
-from django.core.exceptions import ImproperlyConfigured
-from lxml.objectify import ObjectifiedElement
-
-from .auth import get_environment, get_merchant_auth, get_validation_mode
-from .controllers import (
-    AuthorizenetControllerExecutionError,
-    execute_controller,
-)
-
-
-class AuthorizenetService:
-    """A service for safely interacting with the Authorizenet API."""
-
-    REQUIRED_SETTINGS = (
-        "MERCHANT_AUTH_ENVIRONMENT",
-        "MERCHANT_AUTH_LOGIN_ID",
-        "MERCHANT_AUTH_TRANSACTION_KEY",
-        "MERCHANT_AUTH_VALIDATION_MODE",
-    )
-
-    def __init__(self) -> None:
-        """Raises :py:exc:`~django.core.exceptions.ImproperlyConfigured` if required settings weren't set."""
-        for setting in self.REQUIRED_SETTINGS:
-            if not hasattr(settings, setting):
-                raise ImproperlyConfigured(f"'{setting}' setting is required.")
-
-    def request(self, func: Callable, *args, **kwargs) -> ObjectifiedElement:
-        """
-        Calls the Authorizenet API function with arguments and returns the result.
-
-        :param func: An Authorizenet API function.
-        :type func: ~typing.Callable
-        :param args: Positional arguments for the API call.
-        :param kwargs: Keyword arguments for the API call.
-        :raises ~terminusgps.authorizenet.controllers.AuthorizenetControllerExecutionError: If the API call failed.
-        :returns: The Authorizenet API call response.
-        :rtype: ~lxml.objectify.ObjectifiedElement
-
-        """
-        try:
-            request, controller_cls = func(*args, **kwargs)
-            request.merchantAuthentication = self.merchantAuthentication
-            controller = controller_cls(request)
-            return execute_controller(controller, self.environment)
-        except AuthorizenetControllerExecutionError:
-            raise
-
-    @cached_property
-    def merchantAuthentication(self) -> merchantAuthenticationType:
-        """Merchant authentication element for Authorizenet API requests."""
-        return get_merchant_auth()
-
-    @cached_property
-    def environment(self) -> str:
-        """Environment for Authorizenet API requests."""
-        return get_environment()
-
-    @cached_property
-    def validationMode(self) -> str:
-        """Validation mode for Authorizenet API requests."""
-        return get_validation_mode()