onlinepayments-sdk-python3 7.4.1__py3-none-any.whl

onlinepayments/sdk/merchant/webhooks/i_webhooks_client.py

@@ -0,0 +1,55 @@
+# -*- coding: utf-8 -*-
+#
+# This file was automatically generated.
+#
+from abc import ABC, abstractmethod
+from typing import Optional
+
+from onlinepayments.sdk.call_context import CallContext
+from onlinepayments.sdk.domain.send_test_request import SendTestRequest
+from onlinepayments.sdk.domain.validate_credentials_request import ValidateCredentialsRequest
+from onlinepayments.sdk.domain.validate_credentials_response import ValidateCredentialsResponse
+
+
+class IWebhooksClient(ABC):
+    """
+    Webhooks client interface. Thread-safe.
+    """
+
+    @abstractmethod
+    def validate_webhook_credentials(self, body: ValidateCredentialsRequest, context: Optional[CallContext] = None) -> ValidateCredentialsResponse:
+        """
+        Resource /v2/{merchantId}/webhooks/validateCredentials - Validate credentials
+
+        :param body:     :class:`onlinepayments.sdk.domain.validate_credentials_request.ValidateCredentialsRequest`
+        :param context:  :class:`onlinepayments.sdk.call_context.CallContext`
+        :return: :class:`onlinepayments.sdk.domain.validate_credentials_response.ValidateCredentialsResponse`
+        :raise IdempotenceException: if an idempotent request caused a conflict (HTTP status code 409)
+        :raise ValidationException: if the request was not correct and couldn't be processed (HTTP status code 400)
+        :raise AuthorizationException: if the request was not allowed (HTTP status code 403)
+        :raise ReferenceException: if an object was attempted to be referenced that doesn't exist or has been removed,
+                   or there was a conflict (HTTP status code 404, 409 or 410)
+        :raise PlatformException: if something went wrong at the payment platform,
+                   the payment platform was unable to process a message from a downstream partner/acquirer,
+                   or the service that you're trying to reach is temporary unavailable (HTTP status code 500, 502 or 503)
+        :raise ApiException: if the payment platform returned any other error
+        """
+
+    @abstractmethod
+    def send_test_webhook(self, body: SendTestRequest, context: Optional[CallContext] = None) -> None:
+        """
+        Resource /v2/{merchantId}/webhooks/sendtest - Send test
+
+        :param body:     :class:`onlinepayments.sdk.domain.send_test_request.SendTestRequest`
+        :param context:  :class:`onlinepayments.sdk.call_context.CallContext`
+        :return: None
+        :raise IdempotenceException: if an idempotent request caused a conflict (HTTP status code 409)
+        :raise ValidationException: if the request was not correct and couldn't be processed (HTTP status code 400)
+        :raise AuthorizationException: if the request was not allowed (HTTP status code 403)
+        :raise ReferenceException: if an object was attempted to be referenced that doesn't exist or has been removed,
+                   or there was a conflict (HTTP status code 404, 409 or 410)
+        :raise PlatformException: if something went wrong at the payment platform,
+                   the payment platform was unable to process a message from a downstream partner/acquirer,
+                   or the service that you're trying to reach is temporary unavailable (HTTP status code 500, 502 or 503)
+        :raise ApiException: if the payment platform returned any other error
+        """

onlinepayments/sdk/merchant/webhooks/webhooks_client.py

@@ -0,0 +1,97 @@
+# -*- coding: utf-8 -*-
+#
+# This file was automatically generated.
+#
+from typing import Mapping, Optional
+
+from .i_webhooks_client import IWebhooksClient
+
+from onlinepayments.sdk.api_resource import ApiResource
+from onlinepayments.sdk.call_context import CallContext
+from onlinepayments.sdk.communication.response_exception import ResponseException
+from onlinepayments.sdk.domain.error_response import ErrorResponse
+from onlinepayments.sdk.domain.send_test_request import SendTestRequest
+from onlinepayments.sdk.domain.validate_credentials_request import ValidateCredentialsRequest
+from onlinepayments.sdk.domain.validate_credentials_response import ValidateCredentialsResponse
+from onlinepayments.sdk.exception_factory import create_exception
+
+
+class WebhooksClient(ApiResource, IWebhooksClient):
+    """
+    Webhooks client. Thread-safe.
+    """
+
+    def __init__(self, parent: ApiResource, path_context: Optional[Mapping[str, str]]):
+        """
+        :param parent:       :class:`onlinepayments.sdk.api_resource.ApiResource`
+        :param path_context: Mapping[str, str]
+        """
+        super(WebhooksClient, self).__init__(parent=parent, path_context=path_context)
+
+    def validate_webhook_credentials(self, body: ValidateCredentialsRequest, context: Optional[CallContext] = None) -> ValidateCredentialsResponse:
+        """
+        Resource /v2/{merchantId}/webhooks/validateCredentials - Validate credentials
+
+        :param body:     :class:`onlinepayments.sdk.domain.validate_credentials_request.ValidateCredentialsRequest`
+        :param context:  :class:`onlinepayments.sdk.call_context.CallContext`
+        :return: :class:`onlinepayments.sdk.domain.validate_credentials_response.ValidateCredentialsResponse`
+        :raise IdempotenceException: if an idempotent request caused a conflict (HTTP status code 409)
+        :raise ValidationException: if the request was not correct and couldn't be processed (HTTP status code 400)
+        :raise AuthorizationException: if the request was not allowed (HTTP status code 403)
+        :raise ReferenceException: if an object was attempted to be referenced that doesn't exist or has been removed,
+                   or there was a conflict (HTTP status code 404, 409 or 410)
+        :raise PlatformException: if something went wrong at the payment platform,
+                   the payment platform was unable to process a message from a downstream partner/acquirer,
+                   or the service that you're trying to reach is temporary unavailable (HTTP status code 500, 502 or 503)
+        :raise ApiException: if the payment platform returned any other error
+        """
+        uri = self._instantiate_uri("/v2/{merchantId}/webhooks/validateCredentials", None)
+
+
+        try:
+            return self._communicator.post(
+                    uri,
+                    self._client_headers,
+                    None,
+                    body,
+                    ValidateCredentialsResponse,
+                    context)
+
+        except ResponseException as e:
+            error_type = ErrorResponse
+            error_object = self._communicator.marshaller.unmarshal(e.body, error_type)
+            raise create_exception(e.status_code, e.body, error_object, context)
+
+    def send_test_webhook(self, body: SendTestRequest, context: Optional[CallContext] = None) -> None:
+        """
+        Resource /v2/{merchantId}/webhooks/sendtest - Send test
+
+        :param body:     :class:`onlinepayments.sdk.domain.send_test_request.SendTestRequest`
+        :param context:  :class:`onlinepayments.sdk.call_context.CallContext`
+        :return: None
+        :raise IdempotenceException: if an idempotent request caused a conflict (HTTP status code 409)
+        :raise ValidationException: if the request was not correct and couldn't be processed (HTTP status code 400)
+        :raise AuthorizationException: if the request was not allowed (HTTP status code 403)
+        :raise ReferenceException: if an object was attempted to be referenced that doesn't exist or has been removed,
+                   or there was a conflict (HTTP status code 404, 409 or 410)
+        :raise PlatformException: if something went wrong at the payment platform,
+                   the payment platform was unable to process a message from a downstream partner/acquirer,
+                   or the service that you're trying to reach is temporary unavailable (HTTP status code 500, 502 or 503)
+        :raise ApiException: if the payment platform returned any other error
+        """
+        uri = self._instantiate_uri("/v2/{merchantId}/webhooks/sendtest", None)
+
+
+        try:
+            return self._communicator.post(
+                    uri,
+                    self._client_headers,
+                    None,
+                    body,
+                    None,
+                    context)
+
+        except ResponseException as e:
+            error_type = ErrorResponse
+            error_object = self._communicator.marshaller.unmarshal(e.body, error_type)
+            raise create_exception(e.status_code, e.body, error_object, context)

onlinepayments/sdk/platform_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 PlatformException(ApiException):
+    """
+    Represents an error response from the payment platform when something went wrong at the payment platform or further downstream.
+    """
+
+    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(PlatformException, self).__init__(status_code, response_body, error_id, errors, message)

onlinepayments/sdk/proxy_configuration.py

@@ -0,0 +1,102 @@
+from typing import Optional
+from urllib.parse import urlparse
+
+
+class ProxyConfiguration(object):
+    """
+    HTTP proxy configuration.
+
+    Can be initialised directly from a host and port or can be constructed from a uri using fromuri
+    """
+
+    def __init__(self, host: str, port: int, scheme: str = "http", username: Optional[str] = None, password: Optional[str] = None):
+        if not host:
+            raise ValueError("host is required")
+        if not port:
+            raise ValueError("port is required")
+        if port <= 0 or port > 65535:
+            raise ValueError("""port "{}" is invalid""".format(port))
+        self.__scheme = scheme
+        self.__host = host
+        self.__port = port
+        self.__username = username
+        self.__password = password
+
+    @staticmethod
+    def from_uri(uri: str, username: Optional[str] = None, password: Optional[str] = None) -> 'ProxyConfiguration':
+        """
+        Constructs a ProxyConfiguration from a URI; if username and/or password
+        are given they will be used instead of corresponding data in the URI
+        """
+        parsed = urlparse(uri)
+        scheme = parsed.scheme
+        host = parsed.hostname + parsed.path
+        port = parsed.port
+        if username is None:
+            username = parsed.username
+        if password is None:
+            password = parsed.password
+        if port is None:
+            if scheme == "http":
+                port = 80
+            elif scheme == "https":
+                port = 443
+            else:
+                raise ValueError("unsupported scheme: " + scheme)
+        return ProxyConfiguration(scheme=scheme,
+                                  host=host,
+                                  port=port,
+                                  username=username,
+                                  password=password)
+
+    @property
+    def scheme(self) -> str:
+        return self.__scheme
+
+    @scheme.setter
+    def scheme(self, scheme: str) -> None:
+        self.__scheme = scheme
+
+    @property
+    def host(self) -> str:
+        return self.__host
+
+    @host.setter
+    def host(self, host: str) -> None:
+        self.__host = host
+
+    @property
+    def port(self) -> int:
+        return self.__port
+
+    @port.setter
+    def port(self, port: int) -> None:
+        self.__port = port
+
+    @property
+    def username(self) -> Optional[str]:
+        return self.__username
+
+    @username.setter
+    def username(self, username: Optional[str]) -> None:
+        self.__username = username
+
+    @property
+    def password(self) -> Optional[str]:
+        return self.__password
+
+    @password.setter
+    def password(self, password: Optional[str]) -> None:
+        self.__password = password
+
+    def __str__(self):
+        """
+        Return a proxy string in the form scheme://username:password@host:port
+        or scheme://host:port if authentication is absent
+
+        Supports HTTP Basic Auth
+        """
+        if self.username is None or self.password is None:
+            return r"{0}://{1}:{2}".format(self.scheme, self.host, self.port)
+        else:
+            return r"{0}://{3}:{4}@{1}:{2}".format(self.scheme, self.host, self.port, self.username, self.password)

onlinepayments/sdk/reference_exception.py

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

onlinepayments/sdk/validation_exception.py

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

onlinepayments/sdk/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: str, sdk_api_version: str):
+        super(ApiVersionMismatchException, self).__init__(
+            "event API version" + event_api_version + " is not compatible with SDK API version" + sdk_api_version)
+        self.__event_api_version = event_api_version
+        self.__sdk_api_version = sdk_api_version
+
+    @property
+    def event_api_version(self) -> str:
+        """
+        :return: The API version from the webhooks event.
+        """
+        return self.__event_api_version
+
+    @property
+    def sdk_api_version(self) -> str:
+        """
+        :return: The API version that this version of the SDK supports.
+        """
+        return self.__sdk_api_version

onlinepayments/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() -> 'InMemorySecretKeyStore':
+        return _IN_MEMORY_SECRET_KEY_CACHE_INSTANCE
+
+    __store = {}
+
+    def get_secret_key(self, key_id: str) -> str:
+        try:
+            secret_key = self.__store[key_id]
+        except KeyError:
+            raise SecretKeyNotAvailableException("could not find secret key for key id " + key_id, key_id)
+        return secret_key
+
+    def store_secret_key(self, key_id: str, secret_key: str) -> None:
+        """
+        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: str) -> None:
+        """
+        Removes the secret key for the given key ID.
+        """
+        self.__store.pop(key_id)
+
+    def clear(self) -> None:
+        """
+        Removes all stored secret keys.
+        """
+        self.__store.clear()
+
+
+_IN_MEMORY_SECRET_KEY_CACHE_INSTANCE = InMemorySecretKeyStore()

onlinepayments/sdk/webhooks/secret_key_not_available_exception.py

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

onlinepayments/sdk/webhooks/secret_key_store.py

@@ -0,0 +1,15 @@
+from abc import ABC, abstractmethod
+
+
+class SecretKeyStore(ABC):
+    """
+    A store of secret keys. Implementations could store secret keys in a database, on disk, etc.
+    """
+
+    @abstractmethod
+    def get_secret_key(self, key_id: str) -> str:
+        """
+        :return: The secret key for the given key ID. Never None.
+        :raise SecretKeyNotAvailableException: If the secret key for the given key ID is not available.
+        """
+        raise NotImplementedError

onlinepayments/sdk/webhooks/signature_validation_exception.py

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

onlinepayments/sdk/webhooks/signature_validator.py

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

onlinepayments/sdk/webhooks/webhooks_helper.py

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