onlinepayments-sdk-python3 4.23.0__zip → 5.0.0__zip

{onlinepayments-sdk-python3-4.23.0 → onlinepayments_sdk_python3-5.0.0}/LICENSE.txt

@@ -35,3 +35,18 @@ distributed under the License is distributed on an "AS IS" BASIS,
 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 See the License for the specific language governing permissions and
 limitations under the License.
+
+
+*** Notices for Toolbelt - Copyright 2014 Ian Cordasco, Cory Benfield
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+   https://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

{onlinepayments-sdk-python3-4.23.0 → onlinepayments_sdk_python3-5.0.0}/MANIFEST.in

@@ -1,2 +1,2 @@
-include README.md
+include README.rst
 include LICENSE.txt

onlinepayments_sdk_python3-5.0.0/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

onlinepayments_sdk_python3-5.0.0/README.rst

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

onlinepayments_sdk_python3-5.0.0/onlinepayments/sdk/__init__.py

@@ -0,0 +1,4 @@
+# -*- coding: utf-8 -*-
+#
+# This file was automatically generated.
+#

{onlinepayments-sdk-python3-4.23.0 → onlinepayments_sdk_python3-5.0.0}/onlinepayments/sdk/api_exception.py

@@ -1,47 +1,53 @@
-from typing import List, Optional
+# -*- coding: utf-8 -*-
+#
+# This file was automatically generated.
+#
+from typing import List, Optional, Sequence
 
 from onlinepayments.sdk.domain.api_error import APIError
 
 
 class ApiException(RuntimeError):
     """
-    Represents an error response from the Online Payments platform which contains
-    an ID and a list of errors.
+    Represents an error response from the payment platform which contains an ID and a list of errors.
     """
 
-    def __init__(self, status_code, response_body, error_id, errors,
-                 message="the Online Payments platform returned an error response"):
+    def __init__(self, status_code: int, response_body: str, error_id: Optional[str], errors: Optional[List[APIError]],
+                 message: str = "the payment platform returned an error response"):
         super(ApiException, self).__init__(message)
         self.__status_code = status_code
         self.__response_body = response_body
         self.__error_id = error_id
-        self.__errors = errors if errors else ()
+        if errors is None:
+            self.__errors = ()
+        else:
+            self.__errors = errors
 
     @property
     def status_code(self) -> int:
         """
-        :return: The HTTP status code that was returned by the Online Payments platform.
+        :return: The HTTP status code that was returned by the Payment platform.
         """
         return self.__status_code
 
     @property
-    def response_body(self) -> Optional[str]:
+    def response_body(self) -> str:
         """
-        :return: The raw response body that was returned by the Online Payments platform.
+        :return: The raw response body that was returned by the Payment platform.
         """
         return self.__response_body
 
     @property
-    def error_id(self) -> str:
+    def error_id(self) -> Optional[str]:
         """
-        :return: The error ID received from the Online Payments platform if available.
+        :return: The errorId received from the Payment platform if available.
         """
         return self.__error_id
 
     @property
-    def errors(self) -> List[APIError]:
+    def errors(self) -> Sequence[APIError]:
         """
-        :return: The error list received from the Online Payments platform if available. Never None.
+        :return: The errors received from the Payment platform if available. Never None.
         """
         return self.__errors
 

onlinepayments_sdk_python3-5.0.0/onlinepayments/sdk/api_resource.py

@@ -0,0 +1,57 @@
+from typing import Mapping, Sequence, Optional
+
+from .i_communicator import ICommunicator
+
+from onlinepayments.sdk.communication.request_header import RequestHeader
+
+
+class ApiResource(object):
+    """
+    Base class of all Online Payments platform API resources.
+    """
+
+    def __init__(self, parent: Optional['ApiResource'] = None, communicator: Optional[ICommunicator] = None,
+                 path_context: Optional[Mapping[str, str]] = None, client_meta_info: Optional[str] = None):
+        """
+        The parent and/or communicator must be given.
+        """
+        if not parent and not communicator:
+            raise ValueError("parent and/or communicator is required")
+        self.__parent = parent
+        self.__communicator = communicator if communicator else parent._communicator
+        self.__path_context = path_context
+        self.__client_meta_info = client_meta_info if client_meta_info or not parent else parent._client_meta_info
+
+    @property
+    def _communicator(self) -> ICommunicator:
+        return self.__communicator
+
+    @property
+    def _client_meta_info(self) -> str:
+        return self.__client_meta_info
+
+    @property
+    def _client_headers(self) -> Optional[Sequence[RequestHeader]]:
+        if self._client_meta_info is not None:
+            client_headers = [RequestHeader("X-GCS-ClientMetaInfo", self._client_meta_info)]
+            return client_headers
+        else:
+            return None
+
+    def _instantiate_uri(self, uri: str, path_context: Optional[Mapping[str, str]]) -> str:
+        uri = self.__replace_all(uri, path_context)
+        uri = self.__instantiate_uri(uri)
+        return uri
+
+    def __instantiate_uri(self, uri: str) -> str:
+        uri = self.__replace_all(uri, self.__path_context)
+        if self.__parent is not None:
+            uri = self.__parent.__instantiate_uri(uri)
+        return uri
+
+    @staticmethod
+    def __replace_all(uri: str, path_context: Optional[Mapping[str, str]]) -> str:
+        if path_context:
+            for key, value in path_context.items():
+                uri = uri.replace("{" + key + "}", value)
+        return uri

onlinepayments_sdk_python3-5.0.0/onlinepayments/sdk/authentication/authenticator.py

@@ -0,0 +1,24 @@
+from abc import ABC, abstractmethod
+from typing import Optional, Sequence
+from urllib.parse import ParseResult
+
+from onlinepayments.sdk.communication.request_header import RequestHeader
+
+
+class Authenticator(ABC):
+    """
+    Used to authenticate requests to the Online Payments platform.
+    """
+
+    @abstractmethod
+    def get_authorization(self, http_method: str, resource_uri: ParseResult,
+                          request_headers: Optional[Sequence[RequestHeader]]) -> str:
+        """
+        Returns a value that can be used for the "Authorization" header.
+
+        :param http_method: The HTTP method.
+        :param resource_uri: The URI of the resource.
+        :param request_headers: A sequence of RequestHeaders.
+         This sequence may not be modified and may not contain headers with the same name.
+        """
+        raise NotImplementedError

onlinepayments_sdk_python3-5.0.0/onlinepayments/sdk/authentication/authorization_type.py

@@ -0,0 +1,10 @@
+class AuthorizationType:
+    V1HMAC = "v1HMAC"
+    AUTHORIZATION_TYPES = [V1HMAC]
+
+    @staticmethod
+    def get_authorization(name: str) -> str:
+        if name in AuthorizationType.AUTHORIZATION_TYPES:
+            return name
+        else:
+            raise ValueError("Authorization '{}' not found".format(name))

onlinepayments-sdk-python3-4.23.0/onlinepayments/sdk/defaultimpl/default_authenticator.py → onlinepayments_sdk_python3-5.0.0/onlinepayments/sdk/authentication/v1hmac_authenticator.py

@@ -3,50 +3,57 @@ import hmac
 from base64 import b64encode
 from operator import attrgetter
 from re import sub
+from typing import Optional, Sequence
+from urllib.parse import ParseResult
 
-from onlinepayments.sdk.authenticator import Authenticator
-from onlinepayments.sdk.defaultimpl.authorization_type import AuthorizationType
-from onlinepayments.sdk.request_header import RequestHeader
+from .authenticator import Authenticator
 
+from onlinepayments.sdk.authentication.authorization_type import AuthorizationType
+from onlinepayments.sdk.communicator_configuration import CommunicatorConfiguration
+from onlinepayments.sdk.communication.request_header import RequestHeader
 
-class DefaultAuthenticator(Authenticator):
+
+class V1HmacAuthenticator(Authenticator):
     """
-    Default Authenticator implementation.
+    V1Hmac Authenticator implementation.
     """
 
-    def __init__(self, api_key_id: str, secret_api_key: str, authorization_type: str = AuthorizationType.V1HMAC):
+    def __init__(self, communicator_configuration: CommunicatorConfiguration):
         """
-        :param authorization_type: Based on this value both the Online Payments
-         platform and the merchant know which security implementation is used.
-         A version number is used for backward compatibility in the future.
-        :param api_key_id: An identifier for the secret API key. The api_key_id
-         can be retrieved from the Configuration Center. This identifier is
-         visible in the HTTP request and is also used to identify the correct
-         account.
-        :param secret_api_key: A shared secret. The shared secret can be
-         retrieved from the Configuration Center. An api_key_id and
-         secret_api_key always go hand-in-hand, the difference is that
-         secret_api_key is never visible in the HTTP request. This secret is
-         used as input for the HMAC algorithm.
+        Constructs a new V1HmacAuthenticator instance using the provided CommunicatorConfiguration.
+
+        :param communicator_configuration: The configuration object containing the v1Hmac api key and api key secret
+         , connection timeout, and socket timeout. None of these can be None or empty,
+         and the timeout values must be positive.
         """
         Authenticator.__init__(self)
-        if secret_api_key is None or not secret_api_key.strip():
+
+        if not communicator_configuration.api_key_id:
+            raise ValueError("api_key_id is required")
+        if not communicator_configuration.secret_api_key:
             raise ValueError("secret_api_key is required")
-        if api_key_id is None or not api_key_id.strip():
-            raise ValueError("api_id_key is required")
-        if authorization_type is None:
+        if communicator_configuration.authorization_type is None:
             raise ValueError("authorization_type is required")
-        self.__api_id_key = api_key_id
-        self.__secret_api_key = secret_api_key
-        self.__authorization_type = AuthorizationType.get_authorization(authorization_type)
+        if communicator_configuration.connect_timeout <= 0:
+            raise ValueError("connect_timeout must be positive")
+        if communicator_configuration.socket_timeout <= 0:
+            raise ValueError("socket_timeout must be positive")
+
+        self.__api_id_key = communicator_configuration.api_key_id
+        self.__secret_api_key = communicator_configuration.secret_api_key
+        self.__authorization_type = AuthorizationType.get_authorization(communicator_configuration.authorization_type)
+        self.__connect_timeout = communicator_configuration.connect_timeout
+        self.__socket_timeout = communicator_configuration.socket_timeout
+        self.__proxy_configuration = communicator_configuration.proxy_configuration
 
-    def create_simple_authentication_signature(self, http_method: str, resource_uri, http_headers):
+    def get_authorization(self, http_method: Optional[str], resource_uri: Optional[ParseResult],
+                          request_headers: Optional[Sequence[RequestHeader]]) -> str:
         """Returns a v1HMAC authentication signature header"""
         if http_method is None or not http_method.strip():
             raise ValueError("http_method is required")
         if resource_uri is None:
             raise ValueError("resource_uri is required")
-        data_to_sign = self.to_data_to_sign(http_method, resource_uri, http_headers)
+        data_to_sign = self.to_data_to_sign(http_method, resource_uri, request_headers)
         return "GCS " + self.__authorization_type + ":" + self.__api_id_key + \
                ":" + self.create_authentication_signature(data_to_sign)
 

onlinepayments_sdk_python3-5.0.0/onlinepayments/sdk/authorization_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 AuthorizationException(ApiException):
+    """
+    Represents an error response from the payment platform when authorization 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 authorization error response"):
+        super(AuthorizationException, self).__init__(status_code, response_body, error_id, errors, message)

onlinepayments_sdk_python3-5.0.0/onlinepayments/sdk/call_context.py

@@ -0,0 +1,62 @@
+from typing import Optional
+from datetime import datetime
+
+
+class CallContext(object):
+    """
+    A call context can be used to send extra information with a request, and to receive extra information from a response.
+
+    Please note that this class is not thread-safe. Each request should get its own call context instance.
+    """
+    __idempotence_key: Optional[str] = None
+    __idempotence_request_timestamp: Optional[int] = None
+    __idempotence_response_date_time: Optional[datetime] = None
+
+    def __init__(self, idempotence_key: Optional[str] = None):
+        """
+        Sets the idempotence key to use for the next request for which this call context is used.
+        """
+        self.__idempotence_key = idempotence_key
+
+    @property
+    def idempotence_key(self) -> Optional[str]:
+        """
+        :return: The idempotence key.
+        """
+        return self.__idempotence_key
+
+    @property
+    def idempotence_request_timestamp(self) -> Optional[int]:
+        """
+        :return: The idempotence request timestamp from the response to the last
+         request for which this call context was used, or None if no idempotence
+         request timestamp was present.
+        """
+        return self.__idempotence_request_timestamp
+
+    @idempotence_request_timestamp.setter
+    def idempotence_request_timestamp(self, idempotence_request_timestamp: int) -> None:
+        """
+        Sets the idempotence request timestamp.
+        This method should only be called by Communicator objects based on the
+        response to the request for which this call context was used.
+        """
+        self.__idempotence_request_timestamp = idempotence_request_timestamp
+
+    @property
+    def idempotence_response_date_time(self) -> Optional[datetime]:
+        """
+        :return: The idempotence response date/time from the response to the
+         last request for which this call context was used, or None if no idempotence
+         response date/time was present.
+        """
+        return self.__idempotence_response_date_time
+
+    @idempotence_response_date_time.setter
+    def idempotence_response_date_time(self, idempotence_response_date_time: datetime) -> None:
+        """
+        Sets the idempotence response date/time.
+        This method should only be called by Communicator objects based on the
+        response to the request for which this call context was used.
+        """
+        self.__idempotence_response_date_time = idempotence_response_date_time