onlinepayments-sdk-python3 4.22.0__zip → 5.0.0__zip

{onlinepayments-sdk-python3-4.22.0 → onlinepayments_sdk_python3-5.0.0}/onlinepayments/sdk/proxy_configuration.py

@@ -1,14 +1,15 @@
+from typing import Optional
 from urllib.parse import urlparse
 
 
-class ProxyConfiguration:
+class ProxyConfiguration(object):
     """
     HTTP proxy configuration.
 
     Can be initialised directly from a host and port or can be constructed from a uri using fromuri
     """
 
-    def __init__(self, host, port, scheme="http", username=None, password=None):
+    def __init__(self, host: str, port: int, scheme: str = "http", username: Optional[str] = None, password: Optional[str] = None):
         if not host:
             raise ValueError("host is required")
         if not port:
@@ -22,7 +23,7 @@ class ProxyConfiguration:
         self.__password = password
 
     @staticmethod
-    def from_uri(uri, username=None, password=None):
+    def from_uri(uri: str, username: Optional[str] = None, password: Optional[str] = None) -> 'ProxyConfiguration':
         """
         Constructs a ProxyConfiguration from a URI; if username and/or password
         are given they will be used instead of corresponding data in the URI
@@ -42,46 +43,50 @@ class ProxyConfiguration:
                 port = 443
             else:
                 raise ValueError("unsupported scheme: " + scheme)
-        return ProxyConfiguration(scheme=scheme, host=host, port=port, username=username, password=password)
+        return ProxyConfiguration(scheme=scheme,
+                                  host=host,
+                                  port=port,
+                                  username=username,
+                                  password=password)
 
     @property
-    def scheme(self):
+    def scheme(self) -> str:
         return self.__scheme
 
     @scheme.setter
-    def scheme(self, scheme):
+    def scheme(self, scheme: str) -> None:
         self.__scheme = scheme
 
     @property
-    def host(self):
+    def host(self) -> str:
         return self.__host
 
     @host.setter
-    def host(self, host):
+    def host(self, host: str) -> None:
         self.__host = host
 
     @property
-    def port(self):
+    def port(self) -> int:
         return self.__port
 
     @port.setter
-    def port(self, port):
+    def port(self, port: int) -> None:
         self.__port = port
 
     @property
-    def username(self):
+    def username(self) -> Optional[str]:
         return self.__username
 
     @username.setter
-    def username(self, username):
+    def username(self, username: Optional[str]) -> None:
         self.__username = username
 
     @property
-    def password(self):
+    def password(self) -> Optional[str]:
         return self.__password
 
     @password.setter
-    def password(self, password):
+    def password(self, password: Optional[str]) -> None:
         self.__password = password
 
     def __str__(self):

onlinepayments_sdk_python3-5.0.0/onlinepayments/sdk/reference_exception.py

@@ -0,0 +1,19 @@
+# -*- coding: utf-8 -*-
+#
+# This file was automatically generated.
+#
+from typing import List, Optional
+
+from .api_exception import ApiException
+
+from onlinepayments.sdk.domain.api_error import APIError
+
+
+class ReferenceException(ApiException):
+    """
+    Represents an error response from the payment platform when a non-existing or removed object is trying to be accessed.
+    """
+
+    def __init__(self, status_code: int, response_body: str, error_id: Optional[str], errors: Optional[List[APIError]],
+                 message: str = "the payment platform returned a reference error response"):
+        super(ReferenceException, self).__init__(status_code, response_body, error_id, errors, message)

onlinepayments_sdk_python3-5.0.0/onlinepayments/sdk/validation_exception.py

@@ -0,0 +1,19 @@
+# -*- coding: utf-8 -*-
+#
+# This file was automatically generated.
+#
+from typing import List, Optional
+
+from .api_exception import ApiException
+
+from onlinepayments.sdk.domain.api_error import APIError
+
+
+class ValidationException(ApiException):
+    """
+    Represents an error response from the payment platform when validation of requests failed.
+    """
+
+    def __init__(self, status_code: int, response_body: str, error_id: Optional[str], errors: Optional[List[APIError]],
+                 message: str = "the payment platform returned an incorrect request error response"):
+        super(ValidationException, self).__init__(status_code, response_body, error_id, errors, message)

{onlinepayments-sdk-python3-4.22.0 → onlinepayments_sdk_python3-5.0.0}/onlinepayments/sdk/webhooks/api_version_mismatch_exception.py

@@ -3,22 +3,21 @@ class ApiVersionMismatchException(RuntimeError):
     Represents an error because a webhooks event has an API version that this version of the SDK does not support.
     """
 
-    def __init__(self, event_api_version, sdk_api_version):
+    def __init__(self, event_api_version: str, sdk_api_version: str):
         super(ApiVersionMismatchException, self).__init__(
-            "event API version" + event_api_version +
-            " is not compatible with SDK API version" + sdk_api_version)
+            "event API version" + event_api_version + " is not compatible with SDK API version" + sdk_api_version)
         self.__event_api_version = event_api_version
         self.__sdk_api_version = sdk_api_version
 
     @property
-    def event_api_version(self):
+    def event_api_version(self) -> str:
         """
         :return: The API version from the webhooks event.
         """
         return self.__event_api_version
 
     @property
-    def sdk_api_version(self):
+    def sdk_api_version(self) -> str:
         """
         :return: The API version that this version of the SDK supports.
         """

{onlinepayments-sdk-python3-4.22.0 → onlinepayments_sdk_python3-5.0.0}/onlinepayments/sdk/webhooks/in_memory_secret_key_store.py

@@ -1,5 +1,5 @@
-from onlinepayments.sdk.webhooks.secret_key_not_available_exception import SecretKeyNotAvailableException
-from onlinepayments.sdk.webhooks.secret_key_store import SecretKeyStore
+from .secret_key_not_available_exception import SecretKeyNotAvailableException
+from .secret_key_store import SecretKeyStore
 
 
 class InMemorySecretKeyStore(SecretKeyStore):
@@ -10,20 +10,19 @@ class InMemorySecretKeyStore(SecretKeyStore):
     """
 
     @staticmethod
-    def INSTANCE():
+    def instance() -> 'InMemorySecretKeyStore':
         return _IN_MEMORY_SECRET_KEY_CACHE_INSTANCE
 
     __store = {}
 
-    def get_secret_key(self, key_id: str):
+    def get_secret_key(self, key_id: str) -> str:
         try:
             secret_key = self.__store[key_id]
         except KeyError:
-            raise SecretKeyNotAvailableException(
-                "could not find secret key for key id " + key_id, key_id)
+            raise SecretKeyNotAvailableException("could not find secret key for key id " + key_id, key_id)
         return secret_key
 
-    def store_secret_key(self, key_id, secret_key):
+    def store_secret_key(self, key_id: str, secret_key: str) -> None:
         """
         Stores the given secret key for the given key ID.
         """
@@ -33,13 +32,13 @@ class InMemorySecretKeyStore(SecretKeyStore):
             raise ValueError("secret_key is required")
         self.__store[key_id] = secret_key
 
-    def remove_secret_key(self, key_id):
+    def remove_secret_key(self, key_id: str) -> None:
         """
         Removes the secret key for the given key ID.
         """
         self.__store.pop(key_id)
 
-    def clear(self):
+    def clear(self) -> None:
         """
         Removes all stored secret keys.
         """

onlinepayments_sdk_python3-5.0.0/onlinepayments/sdk/webhooks/secret_key_not_available_exception.py

@@ -0,0 +1,18 @@
+from typing import Optional
+
+from .signature_validation_exception import SignatureValidationException
+
+
+class SecretKeyNotAvailableException(SignatureValidationException):
+    """
+    Represents an error that causes a secret key to not be available.
+    """
+
+    def __init__(self, key_id: str, message: Optional[str] = None, cause: Optional[Exception] = None):
+        super(SecretKeyNotAvailableException, self).__init__(message=message,
+                                                             cause=cause)
+        self.__key_id = key_id
+
+    @property
+    def key_id(self) -> str:
+        return self.__key_id

{onlinepayments-sdk-python3-4.22.0 → onlinepayments_sdk_python3-5.0.0}/onlinepayments/sdk/webhooks/secret_key_store.py

@@ -7,9 +7,9 @@ class SecretKeyStore(ABC):
     """
 
     @abstractmethod
-    def get_secret_key(self, key_id: str):
+    def get_secret_key(self, key_id: str) -> str:
         """
         :return: The secret key for the given key ID. Never None.
-        :raise: SecretKeyNotAvailableException: If the secret key for the given
-         key ID is not available.
+        :raise SecretKeyNotAvailableException: If the secret key for the given key ID is not available.
         """
+        raise NotImplementedError

onlinepayments_sdk_python3-5.0.0/onlinepayments/sdk/webhooks/signature_validation_exception.py

@@ -0,0 +1,17 @@
+from typing import Optional
+
+
+class SignatureValidationException(RuntimeError):
+    """
+    Represents an error while validating webhooks signatures.
+    """
+
+    def __init__(self, message: Optional[str] = None, cause: Optional[Exception] = None):
+        if message and cause:
+            super(SignatureValidationException, self).__init__(message, cause)
+        elif message:
+            super(SignatureValidationException, self).__init__(message)
+        elif cause:
+            super(SignatureValidationException, self).__init__(cause)
+        else:
+            super(SignatureValidationException, self).__init__()

onlinepayments_sdk_python3-5.0.0/onlinepayments/sdk/webhooks/signature_validator.py

@@ -0,0 +1,56 @@
+import hmac
+import hashlib
+from base64 import b64encode
+from typing import Union, Sequence
+
+from .secret_key_store import SecretKeyStore
+from .signature_validation_exception import SignatureValidationException
+
+from onlinepayments.sdk.communication.request_header import RequestHeader
+
+
+class SignatureValidator(object):
+    """
+    Validator for webhooks signatures.
+    """
+
+    def __init__(self, secret_key_store: SecretKeyStore):
+        if secret_key_store is None:
+            raise ValueError("secret_key_store is required")
+        self.__secret_key_store = secret_key_store
+
+    def validate(self, body: Union[str, bytes], request_headers: Sequence[RequestHeader]) -> None:
+        """
+        Validates the given body using the given request headers.
+
+        :raise SignatureValidationException: If the body could not be validated successfully.
+        """
+        self.__validate_body(body, request_headers)
+
+    def __validate_body(self, body: Union[str, bytes], request_headers: Sequence[RequestHeader]) -> None:
+        signature = self.__get_header_value(request_headers, "X-GCS-Signature")
+        key_id = self.__get_header_value(request_headers, "X-GCS-KeyId")
+        secret_key = self.__secret_key_store.get_secret_key(key_id)
+        unencoded_result = hmac.new(secret_key.encode("utf-8"), body, hashlib.sha256).digest()
+        expected_signature = b64encode(unencoded_result)
+        is_valid = hmac.compare_digest(signature.encode("utf-8"), expected_signature)
+        if is_valid is False:
+            raise SignatureValidationException("failed to validate signature: " + signature)
+
+    @staticmethod
+    def __get_header_value(request_headers: Sequence[RequestHeader], header_name: str) -> str:
+        value = None
+        for header in request_headers:
+            if header_name.lower() == header.name.lower():
+                if value is None:
+                    value = header.value
+                else:
+                    raise SignatureValidationException("encountered multiple occurrences of header '" + header_name + "'")
+        if value is None:
+            raise SignatureValidationException("could not find header '" + header_name + "'")
+        return value
+
+    # Used for unit tests
+    @property
+    def secret_key_store(self) -> SecretKeyStore:
+        return self.__secret_key_store

onlinepayments_sdk_python3-5.0.0/onlinepayments/sdk/webhooks/webhooks_helper.py

@@ -0,0 +1,52 @@
+#
+# This file was automatically generated.
+#
+from typing import Sequence, Union
+
+from onlinepayments.sdk.communication.request_header import RequestHeader
+from onlinepayments.sdk.domain.web_hooks_event import WebhooksEvent
+from onlinepayments.sdk.json.marshaller import Marshaller
+from .api_version_mismatch_exception import ApiVersionMismatchException
+from .secret_key_store import SecretKeyStore
+from .signature_validator import SignatureValidator
+
+
+class WebhooksHelper(object):
+    """
+    Online Payments platform v1 webhooks helper.
+    """
+
+    def __init__(self, marshaller: Marshaller, secret_key_store: SecretKeyStore):
+        if marshaller is None:
+            raise ValueError("marshaller is required")
+        self.__marshaller = marshaller
+        self.__signature_validator = SignatureValidator(secret_key_store)
+
+    def unmarshal(self, body: Union[str, bytes], request_headers: Sequence[RequestHeader]) -> WebhooksEvent:
+        """
+        Unmarshals the given body, while also validating it using the given request headers.
+
+        :raise SignatureValidationException: If the body could not be validated successfully.
+        :raise ApiVersionMismatchException: If the resulting event has an API
+         version that this version of the SDK does not support.
+        :return: The body unmarshalled as a WebhooksEvent.
+        """
+        self.__signature_validator.validate(body, request_headers)
+
+        event = self.__marshaller.unmarshal(body.decode('utf-8'), WebhooksEvent)
+        self.__validate_api_version(event)
+        return event
+
+    @staticmethod
+    def __validate_api_version(event: WebhooksEvent) -> None:
+        if "v1" != event.api_version:
+            raise ApiVersionMismatchException(event.api_version, "v1")
+
+    # Used for unit tests
+    @property
+    def marshaller(self) -> Marshaller:
+        return self.__marshaller
+
+    @property
+    def secret_key_store(self) -> SecretKeyStore:
+        return self.__signature_validator.secret_key_store

onlinepayments_sdk_python3-5.0.0/onlinepayments_sdk_python3.egg-info/PKG-INFO

@@ -0,0 +1,154 @@
+Metadata-Version: 2.4
+Name: onlinepayments-sdk-python3
+Version: 5.0.0
+Summary: SDK to communicate with the Online Payments platform using the Online Payments Server API
+Home-page: https://github.com/wl-online-payments-direct/sdk-python3
+Author: Worldline Direct support team
+Author-email: 82139942+worldline-direct-support-team@users.noreply.github.com
+License: MIT
+Keywords: Online Payments SDK
+Platform: python 3.7
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.7
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Office/Business :: Financial
+Classifier: License :: OSI Approved :: MIT License
+Requires-Python: >= 3.7
+Description-Content-Type: text/x-rst
+License-File: LICENSE.txt
+Requires-Dist: requests>=2.25.0
+Requires-Dist: requests-toolbelt>=0.8.0
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: keywords
+Dynamic: license
+Dynamic: license-file
+Dynamic: platform
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
+
+Online Payments Python SDK
+==========================
+
+Introduction
+------------
+
+The Python SDK helps you to communicate with the payment platform server
+API. Its primary features are:
+
+-  convenient Python library for the API calls and responses
+
+   -  marshals Python request objects to HTTP requests
+   -  unmarshals HTTP responses to Python response objects or Python exceptions
+
+-  handling of all the details concerning authentication
+-  handling of required metadata
+
+Its use is demonstrated by an example for each possible call. The examples execute a call using the provided API key.
+
+Structure of this repository
+----------------------------
+
+This repository consists out of three main components:
+
+#. The source code of the SDK itself: ``/onlinepayments/sdk/``
+#. The source code of the SDK unit tests: ``/tests/unit/``
+#. The source code of the SDK integration tests: ``/tests/integration/``
+
+Note that the source code of the unit tests and integration tests can only be found on GitHub.
+
+Requirements
+------------
+
+Python 3.7 or higher is required. In addition, the following packages are required:
+
+-  `requests <https://requests.readthedocs.io/>`__ 2.25.0 or higher
+-  `requests-toolbelt <https://toolbelt.readthedocs.io/>`__ 0.8.0 or higher
+
+These packages will be installed automatically if the SDK is installed manually or using pip following the below instructions.
+
+Installation
+------------
+
+To install the SDK using pip, execute the following command:
+
+.. code:: bash
+
+   pip install onlinepayments-sdk-python3
+
+Alternatively, you can install the SDK from a source distribution file:
+
+#. Download the latest version of the Python SDK from GitHub. Choose the
+   ``onlinepayments-sdk-python3-x.y.z.zip`` file from the
+   `releases <https://github.com/wl-online-payments-direct/sdk-python3/releases>`__
+   page, where ``x.y.z`` is the version number.
+#. Execute the following command in the folder where the SDK was
+   downloaded to:
+
+#. Execute the following command in the folder where the SDK was downloaded to:
+
+   .. code:: bash
+
+      pip install onlinepayments-sdk-python3-x.y.z.zip
+
+Uninstalling
+------------
+
+After the Python SDK has been installed, it can be uninstalled using the following command:
+
+.. code:: bash
+
+   pip uninstall onlinepayments-sdk-python3
+
+The required packages can be uninstalled in the same way.
+
+Running tests
+-------------
+
+There are two types of tests: unit tests and integration tests. The unit tests will work out-of-the-box; for the integration tests some configuration is required.
+First, some environment variables need to be set:
+-  ``onlinePayments.api.v1hmac.apiKeyId`` for the API key id to use.
+-  ``onlinePayments.api.v1hmac.secretApiKey`` for the secret API key to use.
+-  ``onlinePayments.api.merchantId`` for your merchant ID.
+
+In addition, to run the proxy integration tests, the proxy URI, username and password should be set in the ``tests/resources/configuration.proxy.ini`` file.
+
+In order to run the unit and integration tests, the `mock <https://pypi.python.org/pypi/mock>`__ backport and `mockito <https://pypi.python.org/pypi/mockito>`__ are required. These can be installed using the following command:
+
+.. code:: bash
+
+   pip install mock mockito
+
+The following commands can now be executed from the ``tests`` directory to execute the tests:
+
+-  Unit tests:
+
+   .. code:: bash
+
+      python run_unit_tests.py
+
+-  Integration tests:
+
+   .. code:: bash
+
+      python run_integration_tests.py
+
+-  Both unit and integration tests:
+
+   .. code:: bash
+
+      python run_all_tests.py