onlinepayments-sdk-python3 4.23.0__zip → 5.0.0__zip

onlinepayments-sdk-python3-4.23.0/PKG-INFO

@@ -1,139 +0,0 @@
-Metadata-Version: 1.1
-Name: onlinepayments-sdk-python3
-Version: 4.23.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
-Description: 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
-        
-           -  marshalls Python request objects to HTTP requests
-           -  unmarshalls HTTP responses to Python response objects or Python
-              exceptions
-        
-        -  handling of all the details concerning authentication
-        -  handling of required meta data
-        
-        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 example 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.5 or higher is required. In addition, the following package is
-        required:
-        
-        -  `requests <https://requests.readthedocs.io/>`__ 2.20.0 or higher
-        
-        This package 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:
-        
-        ::
-        
-            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:
-        
-           ::
-        
-               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:
-        
-        ::
-        
-            pip uninstall onlinepayments-sdk-python3
-        
-        The required package 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.apiKeyId`` for the API key id to use.
-        -  ``onlinePayments.api.secretApiKey`` for the secret API key to use.
-        -  ``onlinePayments.api.merchantId`` for your merchant ID.
-        
-        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>`__ packages are
-        required. These can be installed using the following command:
-        
-        ::
-        
-            pip install mock mockito
-        
-        The following commands can then be executed from the ``tests`` directory
-        to execute the tests:
-        
-        -  Unit tests:
-        
-           ::
-        
-               python run_unit_tests.py
-        
-        -  Integration tests:
-        
-           ::
-        
-               python run_integration_tests.py
-        
-        -  Both unit and integration tests:
-        
-           ::
-        
-               python run_all_tests.py
-        
-Keywords: Online Payments SDK
-Platform: python 3.5
-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.5
-Classifier: Topic :: Office/Business :: Financial
-Classifier: License :: OSI Approved :: MIT License

onlinepayments-sdk-python3-4.23.0/README.md

@@ -1,83 +0,0 @@
-# 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
-    * marshalls Python request objects to HTTP requests
-    * unmarshalls HTTP responses to Python response objects or Python exceptions
-* handling of all the details concerning authentication
-* handling of required meta data
-
-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:
-
-1. The source code of the SDK itself: `/onlinepayments/sdk/` 
-2. The source code of the SDK unit tests: `/tests/unit/`
-3. The source code of the example 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.5 or higher is required. In addition, the following package is required:
-
-* [requests](https://requests.readthedocs.io/) 2.20.0 or higher
-
-This package 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:
-
-    pip install onlinepayments-sdk-python3
-
-Alternatively, you can install the SDK from a source distribution file:
-
-1. 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.
-2. Execute the following command in the folder where the SDK was downloaded to:
-    
-    ```
-    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:
-
-    pip uninstall onlinepayments-sdk-python3
-
-The required package 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.apiKeyId` for the API key id to use.
-* `onlinePayments.api.secretApiKey` for the secret API key to use.
-* `onlinePayments.api.merchantId` for your merchant ID.
-
-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) packages are required. These can be installed using the following command:
-
-    pip install mock mockito
-
-The following commands can then be executed from the `tests` directory to execute the tests:
-* Unit tests:
-    
-    ```
-    python run_unit_tests.py
-    ```
-* Integration tests:
-    
-    ```
-    python run_integration_tests.py
-    ```
-* Both unit and integration tests:
-    
-    ```
-    python run_all_tests.py
-    ```

onlinepayments-sdk-python3-4.23.0/README.rst

@@ -1,120 +0,0 @@
-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
-
-   -  marshalls Python request objects to HTTP requests
-   -  unmarshalls HTTP responses to Python response objects or Python
-      exceptions
-
--  handling of all the details concerning authentication
--  handling of required meta data
-
-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 example 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.5 or higher is required. In addition, the following package is
-required:
-
--  `requests <https://requests.readthedocs.io/>`__ 2.20.0 or higher
-
-This package 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:
-
-::
-
-    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:
-
-   ::
-
-       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:
-
-::
-
-    pip uninstall onlinepayments-sdk-python3
-
-The required package 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.apiKeyId`` for the API key id to use.
--  ``onlinePayments.api.secretApiKey`` for the secret API key to use.
--  ``onlinePayments.api.merchantId`` for your merchant ID.
-
-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>`__ packages are
-required. These can be installed using the following command:
-
-::
-
-    pip install mock mockito
-
-The following commands can then be executed from the ``tests`` directory
-to execute the tests:
-
--  Unit tests:
-
-   ::
-
-       python run_unit_tests.py
-
--  Integration tests:
-
-   ::
-
-       python run_integration_tests.py
-
--  Both unit and integration tests:
-
-   ::
-
-       python run_all_tests.py

onlinepayments-sdk-python3-4.23.0/onlinepayments/sdk/api_resource.py

@@ -1,115 +0,0 @@
-from typing import Dict, Union
-
-from onlinepayments.sdk.api_exception import ApiException
-from onlinepayments.sdk.authorization_exception import AuthorizationException
-from onlinepayments.sdk.communicator import Communicator
-from onlinepayments.sdk.declined_payment_exception import DeclinedPaymentException
-from onlinepayments.sdk.declined_payout_exception import DeclinedPayoutException
-from onlinepayments.sdk.declined_refund_exception import DeclinedRefundException
-from onlinepayments.sdk.domain.error_response import ErrorResponse
-from onlinepayments.sdk.domain.payment_error_response import PaymentErrorResponse
-from onlinepayments.sdk.domain.payout_error_response import PayoutErrorResponse
-from onlinepayments.sdk.domain.refund_error_response import RefundErrorResponse
-from onlinepayments.sdk.idempotence_exception import IdempotenceException
-from onlinepayments.sdk.payment_platform_exception import PaymentPlatformException
-from onlinepayments.sdk.reference_exception import ReferenceException
-from onlinepayments.sdk.request_header import RequestHeader
-from onlinepayments.sdk.validation_exception import ValidationException
-
-
-class ApiResource:
-    """
-    Base class of all Online Payments platform API resources.
-    """
-
-    def __init__(self, arg: Union['ApiResource', Communicator], path_context: Dict[str, str], client_meta_info=None):
-        """
-        :param arg: communicator or parent
-        """
-        if arg is None:
-            raise ValueError("parent or communicator is required")
-        if isinstance(arg, ApiResource):
-            self.__parent = arg
-            self.__communicator = arg._communicator
-            self.__client_meta_info = arg._client_meta_info
-        else:
-            self.__parent = None
-            self.__communicator = arg
-            self.__client_meta_info = client_meta_info
-        self.__path_context = path_context
-
-    @property
-    def _communicator(self):
-        return self.__communicator
-
-    @property
-    def _client_meta_info(self):
-        return self.__client_meta_info
-
-    @property
-    def _client_headers(self):
-        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, path_context):
-        uri = self.__replace_all(uri, path_context)
-        uri = self.__instantiate_uri(uri)
-        return uri
-
-    def __instantiate_uri(self, uri: str):
-        uri = self.__replace_all(uri, self.__path_context)
-        if self.__parent is not None:
-            uri = self.__parent.__instantiate_uri(uri)
-        return uri
-
-    def __replace_all(self, uri, path_context):
-        if path_context:
-            for key, value in path_context.items():
-                uri = uri.replace("{" + key + "}", value)
-        return uri
-
-    def _create_exception(self, status_code, body, error_object, context):
-        """Return a raisable api-exception based on the error object given"""
-        if isinstance(error_object, PaymentErrorResponse) and error_object.payment_result is not None:
-            return DeclinedPaymentException(status_code=status_code, response_body=body, error_response=error_object)
-        elif isinstance(error_object, PayoutErrorResponse) and error_object.payout_result is not None:
-            return DeclinedPayoutException(status_code=status_code, response_body=body, error_response=error_object)
-        elif isinstance(error_object, RefundErrorResponse) and error_object.refund_result is not None:
-            return DeclinedRefundException(status_code=status_code, response_body=body, error_response=error_object)
-        if not isinstance(error_object,
-                          (PaymentErrorResponse, PayoutErrorResponse, RefundErrorResponse, ErrorResponse)):
-            raise ValueError("Unsupported error object encountered: {}".format(error_object.__class__.__name__)) \
-                from error_object  # unsupported error object
-        error_id = error_object.error_id
-        errors = error_object.errors
-        if _is_idempotence_error(status_code, errors, context):
-            return IdempotenceException(context.idempotence_key,
-                                        context.idempotence_request_timestamp,
-                                        status_code, body, error_id, errors)
-        # get error based on status code, defaulting to ApiException
-        return ERROR_MAP.get(status_code, ApiException)(status_code, body, error_id, errors)
-
-
-def _is_idempotence_error(status_code, errors, context):
-    """
-    Determines if an idempotence error has occurred based on the status code, errors and context
-    """
-    return status_code == 409 \
-           and context is not None \
-           and context.idempotence_key is not None \
-           and len(errors) == 1 \
-           and errors[0].code
-
-
-ERROR_MAP = {
-    400: ValidationException,
-    403: AuthorizationException,
-    404: ReferenceException,
-    409: ReferenceException,  # idempotence has already been tested
-    410: ReferenceException,
-    500: PaymentPlatformException,
-    502: PaymentPlatformException,
-}

onlinepayments-sdk-python3-4.23.0/onlinepayments/sdk/authenticator.py

@@ -1,18 +0,0 @@
-from abc import ABC, abstractmethod
-
-
-class Authenticator(ABC):
-    """
-    Used to sign requests to the Online Payments platform.
-    """
-
-    @abstractmethod
-    def create_simple_authentication_signature(self, http_method, resource_uri, request_headers):
-        """
-        Creates a signature for the simple security model.
-
-        :param http_method: The HTTP method.
-        :param resource_uri: The URI of the resource.
-        :param request_headers:  A list of RequestHeaders. This list may not be
-         modified and may not contain headers with the same name.
-        """

onlinepayments-sdk-python3-4.23.0/onlinepayments/sdk/authorization_exception.py

@@ -1,12 +0,0 @@
-from onlinepayments.sdk.api_exception import ApiException
-
-
-class AuthorizationException(ApiException):
-    """
-    Represents an error response from the Online Payments platform when
-    authorization failed.
-    """
-
-    def __init__(self, status_code, response_body, error_id, errors,
-                 message="the Online Payments platform returned an authorization error response"):
-        super(AuthorizationException, self).__init__(status_code, response_body, error_id, errors, message)

onlinepayments-sdk-python3-4.23.0/onlinepayments/sdk/call_context.py

@@ -1,42 +0,0 @@
-class CallContext:
-    """
-    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 = None
-    __idempotence_request_timestamp = None
-
-    def __init__(self, idempotence_key=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):
-        """
-        :return: The idempotence key.
-        """
-        return self.__idempotence_key
-
-    @property
-    def idempotence_request_timestamp(self):
-        """
-        :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):
-        """
-        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

onlinepayments-sdk-python3-4.23.0/onlinepayments/sdk/client.py

@@ -1,91 +0,0 @@
-#
-# This class was auto-generated.
-#
-from base64 import b64encode
-
-from onlinepayments.sdk.api_resource import ApiResource
-from onlinepayments.sdk.i_client import IClient
-from onlinepayments.sdk.merchant.merchant_client import MerchantClient
-
-
-class Client(ApiResource, IClient):
-    """
-    Payment platform client.
-
-    This client and all its child clients are bound to one specific value for the X-GCS-ClientMetaInfo header.
-    To get a new client with a different header value, use with_client_meta_info.
-
-    Thread-safe.
-    """
-
-    def __init__(self, communicator, client_meta_info=None):
-        """
-        :param communicator:      :class:`onlinepayments.sdk.communicator.Communicator`
-        :param client_meta_info:  str
-        """
-        super(Client, self).__init__(communicator, None, client_meta_info)
-
-    def with_client_meta_info(self, client_meta_info):
-        """
-        :param client_meta_info: JSON string containing the meta data for the client
-        :return: a new Client which uses the passed meta data for the X-GCS-ClientMetaInfo header.
-        :raise: MarshallerSyntaxException if the given clientMetaInfo is not a valid JSON string
-        """
-        if self._client_meta_info is None and client_meta_info is None:
-            return self
-        elif client_meta_info is None:
-            return Client(self._communicator, None)
-        else:
-            # Checking to see if this is valid JSON (no JSON parse exceptions)
-            self._communicator.marshaller.unmarshal(client_meta_info, object)
-            client_meta_info = b64encode(client_meta_info.encode('UTF-8'))
-            if client_meta_info == self._client_meta_info:
-                return self
-            else:
-                return Client(self._communicator, client_meta_info)
-
-    def close_idle_connections(self, idle_time):
-        """
-        Utility method that delegates the call to this client's communicator.
-
-        :param idle_time: a datetime.timedelta object indicating the idle time
-        """
-        self._communicator.close_idle_connections(idle_time)
-
-    def close_expired_connections(self):
-        """
-        Utility method that delegates the call to this client's communicator.
-        """
-        self._communicator.close_expired_connections()
-
-    def enable_logging(self, communicator_logger):
-        # delegate to the communicator
-        self._communicator.enable_logging(communicator_logger)
-
-    def disable_logging(self):
-        # delegate to the communicator
-        self._communicator.disable_logging()
-
-    def close(self):
-        """
-        Releases any system resources associated with this object.
-        """
-        self._communicator.close()
-
-    def __enter__(self):
-        return self
-
-    def __exit__(self, exc_type, exc_val, exc_tb):
-        self.close()
-
-    def merchant(self, merchant_id: str) -> MerchantClient:
-        """
-        Resource /v2/{merchantId}
-
-        :param merchant_id: str
-        :return: :class:`onlinepayments.sdk.merchant.i_merchant_client.IMerchantClient`
-        """
-        sub_context = {
-            "merchantId": merchant_id,
-        }
-        return MerchantClient(self, sub_context)