connect-sdk-python3 3.47.0__zip → 4.0.1__zip

connect-sdk-python3-3.47.0/ingenico/connect/sdk/response_exception.py

@@ -1,57 +0,0 @@
-from .response_header import get_header_value, get_header
-
-
-class ResponseException(RuntimeError):
-    """
-    Thrown when a response was received from the Ingenico ePayments platform which
-    indicates an error.
-    """
-
-    def __init__(self, status, body, headers):
-        super(ResponseException, self).__init__("the Ingenico ePayments platform returned an error response")
-        self.__status_code = status
-        self.__headers = headers if headers is not None else {}
-        self.__body = body
-
-    @property
-    def status_code(self):
-        """
-        :return: The HTTP status code that was returned by the Ingenico ePayments platform.
-        """
-        return self.__status_code
-
-    @property
-    def body(self):
-        """
-        :return: The raw response body that was returned by the Ingenico ePayments platform.
-        """
-        return self.__body
-
-    @property
-    def headers(self):
-        """
-        :return: The headers that were returned by the Ingenico ePayments platform. Never None.
-        """
-        return self.__headers
-
-    def get_header(self, header_name):
-        """
-        :return: The header with the given name, or None if there was no such header.
-        """
-        return get_header(self.__headers, header_name)
-
-    def get_header_value(self, header_name):
-        """
-        :return: The value header with the given name, or None if there was no such header.
-        """
-        return get_header_value(self.__headers, header_name)
-
-    def __str__(self):
-        string = super(ResponseException, self).__str__()
-        status_code = self.__status_code
-        if status_code > 0:
-            string += "; status_code=" + str(status_code)
-        response_body = self.__body
-        if response_body:
-            string += "; response_body='" + response_body + "'"
-        return str(string)

connect-sdk-python3-3.47.0/ingenico/connect/sdk/response_header.py

@@ -1,49 +0,0 @@
-import re
-
-
-def get_header_value(headers, header_name):
-    """
-    :return: The value of the header with the given name, or None if there was no such header.
-    """
-    if headers is None:
-        return None
-    for name, value in headers.items():
-        if name.lower() == header_name.lower():
-            return value
-    return None
-
-
-def get_header(headers, header_name):
-    """
-    :return: The header with the given name as a tuple with the name and value, or None if there was no such header.
-    """
-    if headers is None:
-        return None
-    for name, value in headers.items():
-        if name.lower() == header_name.lower():
-            return name, value
-    return None
-
-
-def get_disposition_filename(headers):
-    """
-    :return: The value of the filename parameter of the Content-Disposition header, or None if there was no such header or parameter.
-    """
-    header_value = get_header_value(headers, "Content-Disposition")
-    if header_value is None:
-        return None
-    pattern = re.compile("(?:^|;)\\s*filename\\s*=\\s*(.*?)\\s*(?:;|$)", re.IGNORECASE)
-    match = pattern.search(header_value)
-    if match is not None:
-        filename = match.group(1)
-        return __trim_quotes(filename)
-    return None
-
-
-def __trim_quotes(filename):
-    if len(filename) < 2:
-        return filename
-    if (filename.startswith("\"") and filename.endswith("\"")) or \
-       (filename.startswith("'") and filename.endswith("'")):
-        return filename[1:-1]
-    return filename

connect-sdk-python3-3.47.0/ingenico/connect/sdk/session.py

@@ -1,58 +0,0 @@
-from urllib.parse import urlparse
-
-
-class Session(object):
-    """
-    Contains the components needed to communicate with the Ingenico ePayments platform.
-
-    :param api_endpoint: the address of the target server as a string or ParseResult object
-    """
-    def __init__(self, api_endpoint, connection, authenticator, meta_data_provider):
-        if api_endpoint is None:
-            raise ValueError("api_endpoint is required")
-        if isinstance(api_endpoint, str):
-            api_endpoint = urlparse(api_endpoint)
-        if not api_endpoint.scheme.lower() in ["http", "https"] or not api_endpoint.netloc:
-            raise ValueError("invalid api_endpoint: " + str(api_endpoint))
-        if api_endpoint.path:
-            raise ValueError("api_endpoint should not contain a path")
-        if api_endpoint.username is not None or api_endpoint.query or api_endpoint.fragment:
-            raise ValueError("api_endpoint should not contain user info, query or fragment")
-        if connection is None:
-            raise ValueError("connection is required")
-        if authenticator is None:
-            raise ValueError("authenticator is required")
-        if meta_data_provider is None:
-            raise ValueError("meta_data_provider is required")
-        self.__api_endpoint = api_endpoint
-        self.__connection = connection
-        self.__authenticator = authenticator
-        self.__meta_data_provider = meta_data_provider
-
-    @property
-    def api_endpoint(self):
-        """
-        :return: The Ingenico ePayments platform API endpoint URI. This URI's path will be None or empty.
-        """
-        return self.__api_endpoint
-
-    @property
-    def connection(self):
-        """
-        :return: The Connection object associated with this session. Never None.
-        """
-        return self.__connection
-
-    @property
-    def authenticator(self):
-        """
-        :return: The Authenticator object associated with this session. Never None.
-        """
-        return self.__authenticator
-
-    @property
-    def meta_data_provider(self):
-        """
-        :return: The MetaDataProvider object associated with this session. Never None.
-        """
-        return self.__meta_data_provider

connect-sdk-python3-3.47.0/ingenico/connect/sdk/uploadable_file.py

@@ -1,48 +0,0 @@
-class UploadableFile:
-    """
-    A file that can be uploaded.
-
-    The allowed forms of content are defined by the Connection implementation.
-    The default implementation supports strings, file descriptors and io.BytesIO objects.
-    """
-
-    def __init__(self, file_name, content, content_type, content_length=-1):
-        if file_name is None or not file_name.strip():
-            raise ValueError("file_name is required")
-        if content is None:
-            raise ValueError("content is required")
-        if content_type is None or not content_type.strip():
-            raise ValueError("file_name is required")
-
-        self.__file_name = file_name
-        self.__content = content
-        self.__content_type = content_type
-        self.__content_length = max(content_length, -1)
-
-    @property
-    def file_name(self):
-        """
-        :return: The name of the file.
-        """
-        return self.__file_name
-
-    @property
-    def content(self):
-        """
-        :return: The file's content.
-        """
-        return self.__content
-
-    @property
-    def content_type(self):
-        """
-        :return: The file's content type.
-        """
-        return self.__content_type
-
-    @property
-    def content_length(self):
-        """
-        :return: The file's content length, or -1 if not known.
-        """
-        return self.__content_length

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

@@ -1,10 +0,0 @@
-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-python3-3.47.0/ingenico/connect/sdk/webhooks/api_version_mismatch_exception.py

@@ -1,24 +0,0 @@
-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-python3-3.47.0/ingenico/connect/sdk/webhooks/in_memory_secret_key_store.py

@@ -1,48 +0,0 @@
-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-python3-3.47.0/ingenico/connect/sdk/webhooks/secret_key_not_available_exception.py

@@ -1,23 +0,0 @@
-from .signature_validation_exception import SignatureValidationException
-
-
-class SecretKeyNotAvailableException(SignatureValidationException):
-    """
-    Represents an error that causes a secret key to not be available.
-    """
-
-    def __init__(self, param1, param2, cause=False):
-        if cause is False:
-            if isinstance(param2, str):
-                super(SecretKeyNotAvailableException, self).__init__(param1)
-                self.__key_id = param2
-            else:
-                super(SecretKeyNotAvailableException, self).__init__(param2)
-                self.__key_id = param1
-        else:
-            super(SecretKeyNotAvailableException, self).__init__(param1, cause)
-            self.__key_id = param2
-
-    @property
-    def key_id(self):
-        return self.__key_id

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

@@ -1,11 +0,0 @@
-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-python3-3.47.0/ingenico/connect/sdk/webhooks/signature_validation_exception.py

@@ -1,10 +0,0 @@
-class SignatureValidationException(RuntimeError):
-    """
-    Represents an error while validating webhooks signatures.
-    """
-
-    def __init__(self, param, cause=False):
-        if cause == False:
-            super(SignatureValidationException, self).__init__(param)
-        else:
-            super(SignatureValidationException, self).__init__(param, cause)

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

@@ -1,52 +0,0 @@
-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.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, 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-python3-3.47.0/ingenico/connect/sdk/webhooks/web_hooks.py

@@ -1,22 +0,0 @@
-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-python3-3.47.0/ingenico/connect/sdk/webhooks/web_hooks_helper.py

@@ -1,83 +0,0 @@
-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.decode("utf-8"), 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-python3-3.47.0/ingenico/connect/sdk/webhooks/web_hooks_helper_builder.py

@@ -1,31 +0,0 @@
-from .web_hooks_helper import WebhooksHelper
-
-
-class WebhooksHelperBuilder:
-    """
-    Builder for a WebhooksHelper object.
-    """
-    __marshaller = None
-    __secret_key_store = None
-
-    def with_marshaller(self, marshaller):
-        """
-        Sets the Marshaller to use.
-        """
-        self.__marshaller = marshaller
-        return self
-
-    def with_secret_key_store(self, secret_key_store):
-        """
-        Sets the SecretKeyStore to use.
-        """
-        self.__secret_key_store = secret_key_store
-        return self
-
-    def build(self):
-        """
-        Creates a fully initialized WebhooksHelper object.
-
-        :raise: ValueError: if not all required components are set
-        """
-        return WebhooksHelper(self.__marshaller, self.__secret_key_store)

connect-sdk-python3-3.47.0/setup.cfg

@@ -1,7 +0,0 @@
-[metadata]
-description-file = README.rst
-
-[egg_info]
-tag_build = 
-tag_date = 0
-

connect-sdk-python3-3.47.0/setup.py

@@ -1,74 +0,0 @@
-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-python3 tests' command"""
-    from tests import run_unit_tests
-    loader = unittest.TestLoader()
-    return loader.discover(start_dir=run_unit_tests.__file__)
-
-
-setup(
-    name="connect-sdk-python3",
-    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 3.5",
-    keywords="Ingenico ePayments Connect SDK",
-    url="https://github.com/Ingenico-ePayments/connect-sdk-python3",
-    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 :: 3 :: Only",
-        "Programming Language :: Python :: 3.5",
-        "Programming Language :: Python :: 3.6",
-        "Programming Language :: Python :: 3.7",
-        "Programming Language :: Python :: 3.8",
-        "Programming Language :: Python :: 3.9",
-        "Programming Language :: Python :: 3.10",
-        "Programming Language :: Python :: 3.11",
-        "Programming Language :: Python :: 3.12",
-        "Topic :: Office/Business :: Financial",
-        "License :: OSI Approved :: MIT License"
-    ],
-    scripts=[],  # executable python scripts, none since this is a library
-    python_requires=">= 3.5",
-    install_requires=[
-        "requests >= 2.25.0",
-        "requests-toolbelt >= 0.8.0"
-    ],
-    # test_suite="tests/run_unit_tests"   # enables command 'pip connect-sdk-python3 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
-)