connect-sdk-python2 3.45.0__zip → 3.47.0__zip

connect-sdk-python2-3.47.0/ingenico/connect/sdk/validation_exception.py

@@ -0,0 +1,10 @@
+from api_exception import ApiException
+
+
+class ValidationException(ApiException):
+    """
+    Represents an error response from the Ingenico ePayments platform when validation of requests failed.
+    """
+    def __init__(self, status_code, response_body, error_id, errors,
+                 message="the Ingenico ePayments platform returned an incorrect request error response"):
+        super(ValidationException, self).__init__(status_code, response_body, error_id, errors, message)

connect-sdk-python2-3.47.0/ingenico/connect/sdk/webhooks/api_version_mismatch_exception.py

@@ -0,0 +1,24 @@
+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):
+        super(ApiVersionMismatchException, self).__init__(
+            "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):
+        """
+        :return: The API version from the webhooks event.
+        """
+        return self.__event_api_version
+
+    @property
+    def sdk_api_version(self):
+        """
+        :return: The API version that this version of the SDK supports.
+        """
+        return self.__sdk_api_version

connect-sdk-python2-3.47.0/ingenico/connect/sdk/webhooks/in_memory_secret_key_store.py

@@ -0,0 +1,48 @@
+from secret_key_not_available_exception import SecretKeyNotAvailableException
+from secret_key_store import SecretKeyStore
+
+
+class InMemorySecretKeyStore(SecretKeyStore):
+    """
+    An in-memory secret key store.
+    This implementation can be used in applications where secret keys can be
+    specified at application startup.
+    """
+
+    @staticmethod
+    def INSTANCE():
+        return _IN_MEMORY_SECRET_KEY_CACHE_INSTANCE
+
+    __store = {}
+
+    def get_secret_key(self, key_id):
+        try:
+            secret_key = self.__store[key_id]
+        except KeyError:
+            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):
+        """
+        Stores the given secret key for the given key ID.
+        """
+        if key_id is None or not key_id.strip():
+            raise ValueError("key_id is required")
+        elif secret_key is None or not secret_key.strip():
+            raise ValueError("secret_key is required")
+        self.__store[key_id] = secret_key
+
+    def remove_secret_key(self, key_id):
+        """
+        Removes the secret key for the given key ID.
+        """
+        self.__store.pop(key_id)
+
+    def clear(self):
+        """
+        Removes all stored secret keys.
+        """
+        self.__store.clear()
+
+
+_IN_MEMORY_SECRET_KEY_CACHE_INSTANCE = InMemorySecretKeyStore()

connect-sdk-python2-3.47.0/ingenico/connect/sdk/webhooks/secret_key_store.py

@@ -0,0 +1,11 @@
+class SecretKeyStore(object):
+    """
+    A store of secret keys. Implementations could store secret keys in a database, on disk, etc.
+    """
+
+    def get_secret_key(self, key_id):
+        """
+        :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 NotImplementedError

connect-sdk-python2-3.47.0/ingenico/connect/sdk/webhooks/signature_validator.py

@@ -0,0 +1,52 @@
+import hmac
+import hashlib
+from base64 import b64encode
+
+from signature_validation_exception import SignatureValidationException
+
+
+class SignatureValidator:
+    """
+    Validator for webhooks signatures.
+    """
+
+    def __init__(self, secret_key_store):
+        if secret_key_store is None:
+            raise ValueError("secret_key_store is required")
+        self.__secret_key_store = secret_key_store
+
+    def validate(self, body, request_headers):
+        """
+        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, request_headers):
+        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, body, hashlib.sha256).digest()
+        expected_signature = b64encode(unencoded_result)
+        is_valid = hmac.compare_digest(signature, expected_signature)
+        if is_valid is False:
+            raise SignatureValidationException("failed to validate signature: " + signature)
+
+    @staticmethod
+    def __get_header_value(request_headers, header_name):
+        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):
+        return self.__secret_key_store

connect-sdk-python2-3.47.0/ingenico/connect/sdk/webhooks/web_hooks.py

@@ -0,0 +1,22 @@
+from web_hooks_helper_builder import WebhooksHelperBuilder
+from ingenico.connect.sdk.defaultimpl.default_marshaller import DefaultMarshaller
+
+
+class Webhooks:
+    """
+    Ingenico ePayments platform factory for several webhooks components.
+    """
+
+    @staticmethod
+    def create_helper_builder(secret_key_store):
+        """
+        Creates a WebhooksHelperBuilder that will use the given SecretKeyStore.
+        """
+        return WebhooksHelperBuilder() \
+            .with_marshaller(DefaultMarshaller.INSTANCE()) \
+            .with_secret_key_store(secret_key_store)
+
+    @staticmethod
+    def create_helper(secret_key_store):
+        web_hooks_helper_builder = Webhooks.create_helper_builder(secret_key_store)
+        return web_hooks_helper_builder.build()

connect-sdk-python2-3.47.0/ingenico/connect/sdk/webhooks/web_hooks_helper.py

@@ -0,0 +1,83 @@
+from api_version_mismatch_exception import ApiVersionMismatchException
+from signature_validator import SignatureValidator
+from ingenico.connect.sdk.client import Client
+from ingenico.connect.sdk.domain.webhooks.web_hooks_event import WebhooksEvent
+
+
+class WebhooksHelper:
+    """
+    Ingenico ePayments platform webhooks helper.
+    """
+
+    def __init__(self, marshaller, secret_key_store):
+        if marshaller is None:
+            raise ValueError("marshaller is requried")
+        self.__marshaller = marshaller
+        self.__signature_validator = SignatureValidator(secret_key_store)
+
+    def unmarshal(self, body, request_headers):
+        """
+        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._validate(body, request_headers)
+        event = self.__marshaller.unmarshal(body, WebhooksEvent)
+        self.__validate_api_version(event)
+        return event
+
+    def _validate(self, body, request_headers):
+        """
+        Validates the given body using the given request headers.
+
+        :raise: SignatureValidationException: If the body could not be validated successfully.
+        """
+        self.__signature_validator.validate(body, request_headers)
+
+    @staticmethod
+    def are_equal_signatures(signature, expected_signature):
+        """
+        Deprecated; use hmac.compare_digest instead
+        """
+        # don't use a simple equals call, as that may leak timing information (it fails fast)
+        length = len(signature)
+        expected_length = len(expected_signature)
+
+        # always check at least 256 characters, to also not leak timing
+        # information about the length of the expected signature
+        limit = max(max(length, expected_length), 256)
+
+        result = True
+
+        # the loop below uses result &= false instead of result = false and
+        # result &= true instead of nothing because those might leak timing
+        # information
+        for i in range(0, limit):
+            if i < length and i < expected_length:
+                # both within string boundaries
+                result = result and (signature[i] == expected_signature[i])
+            elif i >= length and i >= expected_length:
+                # past both string boundaries
+                result = result and True
+            else:
+                # i >= length || i >= expected_length but not both
+                result = result and False
+
+        return result
+
+    @staticmethod
+    def __validate_api_version(event):
+        if not Client.API_VERSION() == event.api_version:
+            raise ApiVersionMismatchException(event.api_version, Client.API_VERSION())
+
+    # Used for unit tests
+    @property
+    def marshaller(self):
+        return self.__marshaller
+
+    @property
+    def secret_key_store(self):
+        return self.__signature_validator.secret_key_store

connect-sdk-python2-3.47.0/setup.py

@@ -0,0 +1,67 @@
+import os
+import unittest
+
+from setuptools import setup, find_packages
+
+
+# Utility function to read the README file.
+# Used for the long_description.  It's nice, because now 1) we have a top level
+# README file and 2) it's easier to type in the README file than to put a raw
+# string in below ...
+def read(fname):
+    return open(os.path.join(os.path.dirname(__file__), fname)).read()
+
+
+def test_collector():
+    """Function to collect tests cases to run for the 'pip connect-sdk-python2 tests' command"""
+    from tests import run_unit_tests
+    loader = unittest.TestLoader()
+    return loader.discover(start_dir=run_unit_tests.__file__)
+
+
+setup(
+    name="connect-sdk-python2",
+    version="3.47.0",
+    author="Ingenico ePayments",
+    author_email="github@epay.ingenico.com",
+    description="SDK to communicate with the Ingenico ePayments platform using the Ingenico Connect Server API",
+    license="MIT",
+    platforms="python 2.7",
+    keywords="Ingenico ePayments Connect SDK",
+    url="https://github.com/Ingenico-ePayments/connect-sdk-python2",
+    packages=find_packages(
+        exclude=["*.examples", "*.examples.*", "examples.*", "examples",  # exclude examples
+                 "*.tests", "*.tests.*", "tests.*", "tests"],             # and tests
+        include="ingenico.*"),  # finds all source packages, recursively
+    # list non-code files used by the SDK
+    package_data={".": ["MANIFEST.in", "README.rst", "setup.py"]},
+    # data_files=[(".", ["LICENSE.txt"])],
+    # installs all files listed in the MANIFEST.in into the installation (currently does not seem to happen either way)
+    include_package_data=True,
+    # data_files=[("index.rst", "README.rst", "setup.py, MANIFEST.in")],  # list miscellaneous files to include
+    # The pypi homepage is based on the long description, standard interpretation is reStructuredText
+    long_description=read('README.rst'),
+    long_description_content_type='text/x-rst',
+    classifiers=[
+        "Development Status :: 5 - Production/Stable",
+        "Operating System :: POSIX :: Linux",
+        "Operating System :: Microsoft :: Windows",
+        "Intended Audience :: Developers",
+        "Programming Language :: Python :: 2 :: Only",
+        "Programming Language :: Python :: 2.7",
+        "Topic :: Office/Business :: Financial",
+        "License :: OSI Approved :: MIT License"
+    ],
+    scripts=[],  # executable python scripts, none since this is a library
+    python_requires="~= 2.7",
+    install_requires=[
+        "requests >= 2.25.0",
+        "requests-toolbelt >= 0.8.0"
+    ],
+    # test_suite="tests/run_unit_tests"   # enables command 'pip connect-sdk-python2 test', which runs unit tests)
+
+    # setup_requires=[               # setuptools_scm automatically reads the version from version control
+    #     'setuptools_scm'
+    # ],
+    # use_scm_version=True           # turns setuptools_scm on
+)

connect-sdk-python2-3.45.0/PKG-INFO

@@ -1,132 +0,0 @@
-Metadata-Version: 2.1
-Name: connect-sdk-python2
-Version: 3.45.0
-Summary: SDK to communicate with the Ingenico ePayments platform using the Ingenico Connect Server API
-Home-page: https://github.com/Ingenico-ePayments/connect-sdk-python2
-Author: Ingenico ePayments
-Author-email: github@epay.ingenico.com
-License: MIT
-Description: Ingenico Connect Python SDK
-        ===========================
-        
-        Introduction
-        ------------
-        
-        The Python SDK helps you to communicate with the `Ingenico Connect <https://epayments.developer-ingenico.com/>`__ 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 keys.
-        
-        See the `Ingenico Connect Developer Hub <https://epayments.developer-ingenico.com/documentation/sdk/server/python/>`__ for more information on how to use the SDK.
-        
-        Structure of this repository
-        ----------------------------
-        
-        This repository consists out of four main components:
-        
-        #. The source code of the SDK itself: ``/ingenico/connect/sdk/``
-        #. The source code of the SDK unit tests: ``/tests/unit/``
-        #. The source code of the SDK integration tests: ``/tests/integration/``
-        #. Usage examples: ``/examples/``
-        
-        Note that the source code of the unit tests and integration tests and the examples can only be found on GitHub.
-        
-        Requirements
-        ------------
-        
-        Python 2.7 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 connect-sdk-python2
-        
-        Alternatively, you can install the SDK from a source distribution file:
-        
-        #. Download the latest version of the Python SDK from GitHub. Choose the ``connect-sdk-python2-x.y.z.zip`` file from the `releases <https://github.com/Ingenico-ePayments/connect-sdk-python2/releases>`__ page, where ``x.y.z`` is the version number.
-        
-        #. Execute the following command in the folder where the SDK was downloaded to:
-        
-           .. code:: bash
-        
-              pip install connect-sdk-python2-x.y.z.zip
-        
-        Uninstalling
-        ------------
-        
-        After the Python SDK has been installed, it can be uninstalled using the following command:
-        
-        .. code:: bash
-        
-           pip uninstall connect-sdk-python2
-        
-        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:
-        
-        -  ``connect.api.apiKeyId`` for the API key id to use. This can be retrieved from the Configuration Center.
-        -  ``connect.api.secretApiKey`` for the secret API key to use. This can be retrieved from the Configuration Center.
-        -  ``connect.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<1.3.1'
-        
-        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
-        
-        Note: in the current version of the unit tests, two errors will pop up ([Errno 10053] for Windows and [Errno 32] for Linux), indicating that there was a client disconnect. These errors occur during cleanup of the tests and do not hinder the tests in any way, and should therefore be ignored.
-        
-Keywords: Ingenico ePayments Connect SDK
-Platform: python 2.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 :: 2 :: Only
-Classifier: Programming Language :: Python :: 2.7
-Classifier: Topic :: Office/Business :: Financial
-Classifier: License :: OSI Approved :: MIT License
-Requires-Python: ~= 2.7
-Description-Content-Type: text/x-rst

connect-sdk-python2-3.45.0/connect_sdk_python2.egg-info/PKG-INFO

@@ -1,132 +0,0 @@
-Metadata-Version: 2.1
-Name: connect-sdk-python2
-Version: 3.45.0
-Summary: SDK to communicate with the Ingenico ePayments platform using the Ingenico Connect Server API
-Home-page: https://github.com/Ingenico-ePayments/connect-sdk-python2
-Author: Ingenico ePayments
-Author-email: github@epay.ingenico.com
-License: MIT
-Description: Ingenico Connect Python SDK
-        ===========================
-        
-        Introduction
-        ------------
-        
-        The Python SDK helps you to communicate with the `Ingenico Connect <https://epayments.developer-ingenico.com/>`__ 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 keys.
-        
-        See the `Ingenico Connect Developer Hub <https://epayments.developer-ingenico.com/documentation/sdk/server/python/>`__ for more information on how to use the SDK.
-        
-        Structure of this repository
-        ----------------------------
-        
-        This repository consists out of four main components:
-        
-        #. The source code of the SDK itself: ``/ingenico/connect/sdk/``
-        #. The source code of the SDK unit tests: ``/tests/unit/``
-        #. The source code of the SDK integration tests: ``/tests/integration/``
-        #. Usage examples: ``/examples/``
-        
-        Note that the source code of the unit tests and integration tests and the examples can only be found on GitHub.
-        
-        Requirements
-        ------------
-        
-        Python 2.7 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 connect-sdk-python2
-        
-        Alternatively, you can install the SDK from a source distribution file:
-        
-        #. Download the latest version of the Python SDK from GitHub. Choose the ``connect-sdk-python2-x.y.z.zip`` file from the `releases <https://github.com/Ingenico-ePayments/connect-sdk-python2/releases>`__ page, where ``x.y.z`` is the version number.
-        
-        #. Execute the following command in the folder where the SDK was downloaded to:
-        
-           .. code:: bash
-        
-              pip install connect-sdk-python2-x.y.z.zip
-        
-        Uninstalling
-        ------------
-        
-        After the Python SDK has been installed, it can be uninstalled using the following command:
-        
-        .. code:: bash
-        
-           pip uninstall connect-sdk-python2
-        
-        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:
-        
-        -  ``connect.api.apiKeyId`` for the API key id to use. This can be retrieved from the Configuration Center.
-        -  ``connect.api.secretApiKey`` for the secret API key to use. This can be retrieved from the Configuration Center.
-        -  ``connect.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<1.3.1'
-        
-        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
-        
-        Note: in the current version of the unit tests, two errors will pop up ([Errno 10053] for Windows and [Errno 32] for Linux), indicating that there was a client disconnect. These errors occur during cleanup of the tests and do not hinder the tests in any way, and should therefore be ignored.
-        
-Keywords: Ingenico ePayments Connect SDK
-Platform: python 2.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 :: 2 :: Only
-Classifier: Programming Language :: Python :: 2.7
-Classifier: Topic :: Office/Business :: Financial
-Classifier: License :: OSI Approved :: MIT License
-Requires-Python: ~= 2.7
-Description-Content-Type: text/x-rst