python-terminusgps 45.2.0__py3-none-any.whl → 45.4.0__py3-none-any.whl

{python_terminusgps-45.2.0.dist-info → python_terminusgps-45.4.0.dist-info}/METADATA

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

@@ -3,14 +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=ZWb9ebJp22o-ImiMLQIzSMENICnbPZOlbX5RO0IEyRU,2199
+terminusgps/authorizenet/auth.py,sha256=T4lPm6eq2ZRoPffLg6GrLZn7wUZ-RTBNi0epyw6ph_w,1035
 terminusgps/authorizenet/constants.py,sha256=eukAZQVuv3XHL-Kd1gqxf8IYUqNC67ClTz4ZU7JPNYE,1459
-terminusgps/authorizenet/controllers.py,sha256=ohRm4tTrGcZGxU9YmELDMdRgOM57w43fPrXZCKhrQF8,1994
-terminusgps/authorizenet/validators.py,sha256=Wq4rqEuqG3JzOO7O1wM6oQ0FciNxxOK0HnJqTuLa8CY,3916
+terminusgps/authorizenet/controllers.py,sha256=wuyKDLTpBmnfyPsHnN9uVnWlrMDUF059ctW-OiZQL-I,2055
+terminusgps/authorizenet/services.py,sha256=IGW1xuc7uZBAZ4KHJGEp7dFlMb-u7Q3SmSpNmAmrkTY,2344
 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=vSMCEJNm75ZjBex4S9wLuHn9omj_nMpQ4JtU8rj_zQc,6498
+terminusgps/authorizenet/api/payment_profiles.py,sha256=r9qAPWRsUbFx0aG_ODOHz9FPVe_TlfGcliSMnx_ezhM,6082
 terminusgps/authorizenet/api/subscriptions.py,sha256=VAXKjOHLOfifrixObK6XbiJCmPobkYBzXJQrjtos9LE,4542
 terminusgps/authorizenet/api/transactions.py,sha256=drymc7uplWHOoaMmatz8nP1gDN_GDef0QVJBqB9oIfE,20
 terminusgps/wialon/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
@@ -29,7 +29,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.2.0.dist-info/METADATA,sha256=gE5fkjeU-YUxEa_MYu7QnUF4J2brjvYRf8X_yDvmYFg,938
-python_terminusgps-45.2.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-python_terminusgps-45.2.0.dist-info/licenses/COPYING,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
-python_terminusgps-45.2.0.dist-info/RECORD,,
+python_terminusgps-45.4.0.dist-info/METADATA,sha256=K_79eu9aAP0TtWncKoZl54hH4kocEN3iqOVSklWzQBI,938
+python_terminusgps-45.4.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+python_terminusgps-45.4.0.dist-info/licenses/COPYING,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
+python_terminusgps-45.4.0.dist-info/RECORD,,

terminusgps/authorizenet/api/payment_profiles.py

@@ -2,8 +2,6 @@ from authorizenet import apicontractsv1, apicontrollers
 from authorizenet.apicontrollersbase import APIOperationBase
 from lxml.objectify import ObjectifiedElement
 
-from terminusgps.authorizenet.auth import get_validation_mode
-
 __all__ = [
     "create_customer_payment_profile",
     "get_customer_payment_profile",
@@ -16,7 +14,6 @@ __all__ = [
 def create_customer_payment_profile(
     customer_profile_id: int,
     payment_profile: apicontractsv1.customerPaymentProfileType,
-    validate: bool = True,
 ) -> tuple[ObjectifiedElement, type[APIOperationBase]]:
     """
     `createCustomerPaymentProfileRequest <https://developer.authorize.net/api/reference/index.html#customer-profiles-create-customer-payment-profile>`_.
@@ -33,8 +30,6 @@ def create_customer_payment_profile(
     request = apicontractsv1.createCustomerPaymentProfileRequest()
     request.customerProfileId = str(customer_profile_id)
     request.paymentProfile = payment_profile
-    if validate:
-        request.validationMode = get_validation_mode()
     return request, apicontrollers.createCustomerPaymentProfileController
 
 
@@ -80,7 +75,6 @@ def validate_customer_payment_profile(
     request = apicontractsv1.validateCustomerPaymentProfileRequest()
     request.customerProfileId = str(customer_profile_id)
     request.customerPaymentProfileId = str(payment_profile_id)
-    request.validationMode = get_validation_mode()
     return request, apicontrollers.validateCustomerPaymentProfileController
 
 
@@ -88,7 +82,6 @@ def update_customer_payment_profile(
     customer_profile_id: int,
     payment_profile_id: int,
     payment_profile: apicontractsv1.customerPaymentProfileType,
-    validate: bool = True,
 ) -> tuple[ObjectifiedElement, type[APIOperationBase]]:
     """
     `updateCustomerPaymentProfileRequest <https://developer.authorize.net/api/reference/index.html#customer-profiles-update-customer-payment-profile>`_.
@@ -99,8 +92,6 @@ def update_customer_payment_profile(
     :type payment_profile_id: int
     :param payment_profile: An Authorizenet payment profile element.
     :type payment_profile: ~authorizenet.apicontractsv1.customerPaymentProfileType
-    :param validate: Whether to validate the payment profile. Default is True.
-    :type validate: bool
     :returns: A tuple containing an Authorizenet API request element and controller class.
     :rtype: tuple[~lxml.objectify.ObjectifiedElement, type[~authorizenet.apicontrollersbase.APIOperationBase]]
 
@@ -111,8 +102,6 @@ def update_customer_payment_profile(
     request = apicontractsv1.updateCustomerPaymentProfileRequest()
     request.customerProfileId = str(customer_profile_id)
     request.paymentProfile = payment_profile
-    if validate:
-        request.validationMode = get_validation_mode()
     return request, apicontrollers.updateCustomerPaymentProfileController
 
 

terminusgps/authorizenet/auth.py

@@ -1,25 +1,15 @@
 from authorizenet.apicontractsv1 import merchantAuthenticationType
 from django.conf import settings
-from django.core.exceptions import ImproperlyConfigured
 
 
 def get_merchant_auth() -> merchantAuthenticationType:
     """
     Returns the merchant authentication information for Authorizenet API controller execution.
 
-    :raises ~django.core.exceptions.ImproperlyConfigured: If the :py:data:`MERCHANT_AUTH_LOGIN_ID` or the :py:data:`MERCHANT_AUTH_TRANSACTION_KEY` settings weren't set.
     :returns: A merchant authentication object.
     :rtype: ~authorizenet.apicontractsv1.merchantAuthenticationType
 
     """
-    if not all(
-        [
-            hasattr(settings, "MERCHANT_AUTH_LOGIN_ID"),
-            hasattr(settings, "MERCHANT_AUTH_TRANSACTION_KEY"),
-        ]
-    ):
-        error_msg: str = "'MERCHANT_AUTH_LOGIN_ID' and 'MERCHANT_AUTH_TRANSACTION_KEY' settings are required."
-        raise ImproperlyConfigured(error_msg)
     return merchantAuthenticationType(
         name=str(settings.MERCHANT_AUTH_LOGIN_ID),
         transactionKey=str(settings.MERCHANT_AUTH_TRANSACTION_KEY),
@@ -30,14 +20,10 @@ def get_environment() -> str:
     """
     Returns the environment for Authorizenet API controller execution.
 
-    :raises ~django.core.exceptions.ImproperlyConfigured: If the :py:data:`MERCHANT_AUTH_ENVIRONMENT` setting wasn't set.
     :returns: An Authorizenet API environment string.
     :rtype: str
 
     """
-    if not hasattr(settings, "MERCHANT_AUTH_ENVIRONMENT"):
-        error_msg: str = "'MERCHANT_AUTH_ENVIRONMENT' setting is required."
-        raise ImproperlyConfigured(error_msg)
     return settings.MERCHANT_AUTH_ENVIRONMENT
 
 
@@ -45,12 +31,8 @@ def get_validation_mode() -> str:
     """
     Returns the validation mode for Authorizenet API controller execution.
 
-    :raises ~django.core.exceptions.ImproperlyConfigured: If the :py:data:`MERCHANT_AUTH_VALIDATION_MODE` setting wasn't set.
     :returns: An Authorizenet API validation string.
     :rtype: str
 
     """
-    if not hasattr(settings, "MERCHANT_AUTH_VALIDATION_MODE"):
-        error_msg: str = "'MERCHANT_AUTH_VALIDATION_MODE' setting is required."
-        raise ImproperlyConfigured(error_msg)
     return settings.MERCHANT_AUTH_VALIDATION_MODE

terminusgps/authorizenet/controllers.py

@@ -3,7 +3,7 @@ from lxml.objectify import ObjectifiedElement
 
 
 def execute_controller(
-    controller: APIOperationBase,
+    controller: APIOperationBase, environment: str
 ) -> ObjectifiedElement | None:
     """
     Executes an Authorizenet API controller and returns its response.
@@ -19,8 +19,10 @@ def execute_controller(
     :rtype: ~lxml.objectify.ObjectifiedElement | None
 
     """
+    controller.setenvironment(environment)
     controller.execute()
     response = controller.getresponse()
+
     if response is None:
         raise AuthorizenetControllerExecutionError(
             message="Authorizenet controller response didn't exist.", code="1"

terminusgps/authorizenet/services.py

@@ -0,0 +1,60 @@
+from abc import ABC
+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 execute_controller
+
+
+class AuthorizenetService(ABC):
+    """Base class for services that interact 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, 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
+
+        """
+        request, controller_cls = func(*args, **kwargs)
+        request.merchantAuthentication = self.merchantAuthentication
+        return execute_controller(controller_cls(request), self.environment)
+
+    @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()

terminusgps/authorizenet/validators.py

@@ -1,120 +0,0 @@
-import calendar
-import datetime
-
-from django.core.exceptions import ValidationError
-from django.utils.translation import gettext_lazy as _
-
-
-def validate_credit_card_number(value: str) -> None:
-    """
-    Raises :py:exc:`~django.core.exceptions.ValidationError` if the value is an invalid credit card number.
-
-    Uses the `Luhn algorithm <https://en.wikipedia.org/wiki/Luhn_algorithm>`_ to validate the credit card number.
-
-    :param value: A credit card number string.
-    :type value: :py:obj:`str`
-    :raises ValidationError: If the value contains non-digit characters.
-    :raises ValidationError: If the value fails the Luhn algorithm.
-    :returns: Nothing.
-    :rtype: :py:obj:`None`
-
-    """
-    if not value.isdigit():
-        raise ValidationError(
-            _("Credit card number can only contain digits. Got '%(value)s'."),
-            code="invalid",
-            params={"value": value},
-        )
-
-    card_number = [int(num) for num in reversed(value)]
-    even_digits = card_number[1::2]
-    odd_digits = card_number[0::2]
-
-    checksum = 0
-    checksum += sum(
-        [
-            digit * 2 if digit * 2 <= 9 else (digit * 2) % 9 or 9
-            for digit in even_digits
-        ]
-    )
-    checksum += sum([digit for digit in odd_digits])
-
-    if checksum % 10 != 0:
-        raise ValidationError(_("Invalid credit card number."), code="invalid")
-
-
-def validate_credit_card_expiry_month(value: str) -> None:
-    """
-    Raises :py:exc:`~django.core.exceptions.ValidationError` if the value is an invalid credit card expiration date month.
-
-    :param value: A credit card expiration year string.
-    :type value: :py:obj:`str`
-    :raises ValidationError: If the value contains non-digit characters.
-    :raises ValidationError: If the value is negative.
-    :raises ValidationError: If the value isn't between 1-12.
-    :returns: Nothing.
-    :rtype: :py:obj:`None`
-
-    """
-    if not value.isdigit():
-        raise ValidationError(
-            _("Expiration month can only contain digits, got '%(value)s'."),
-            code="invalid",
-            params={"value": value},
-        )
-    if not int(value) > 0:
-        raise ValidationError(
-            _(
-                "Expiration month can only be a positive value, got '%(value)s'."
-            ),
-            code="invalid",
-            params={"value": value},
-        )
-
-    try:
-        calendar.Month(int(value))
-    except ValueError:
-        raise ValidationError(
-            _("Expiration month must be between 1-12, got '%(value)s'."),
-            code="invalid",
-            params={"value": value},
-        )
-
-
-def validate_credit_card_expiry_year(value: str) -> None:
-    """
-    Raises :py:exc:`~django.core.exceptions.ValidationError` if the value is an invalid credit card expiration date year.
-
-    :param value: A credit card expiration year string.
-    :type value: :py:obj:`str`
-    :raises ValidationError: If the value contains non-digit characters.
-    :raises ValidationError: If the value is negative.
-    :raises ValidationError: If the value is a year in the past.
-    :returns: Nothing.
-    :rtype: :py:obj:`None`
-
-    """
-    if not value.isdigit():
-        raise ValidationError(
-            _("Expiration year can only contain digits, got '%(value)s'."),
-            code="invalid",
-            params={"value": value},
-        )
-    if not int(value) > 0:
-        raise ValidationError(
-            _(
-                "Expiration year can only be a positive value, got '%(value)s'."
-            ),
-            code="invalid",
-            params={"value": value},
-        )
-
-    input_year = datetime.datetime.strptime(value, "%y").year
-    this_year = datetime.datetime.now().year
-
-    if not input_year >= this_year:
-        raise ValidationError(
-            _("Expiration year cannot be in the past, got '%(value)s'."),
-            code="invalid",
-            params={"value": value},
-        )