connect-sdk-python2 4.0.0__zip → 4.1.0__zip

connect-sdk-python2-4.0.0/worldline/connect/sdk/communicator.py

@@ -1,400 +0,0 @@
-from datetime import datetime
-from httplib import NOT_FOUND
-from urllib import quote
-from urlparse import urlparse
-
-from worldline.connect.sdk.communication.communication_exception import CommunicationException
-from worldline.connect.sdk.communication.not_found_exception import NotFoundException
-from worldline.connect.sdk.communication.multipart_form_data_object import MultipartFormDataObject
-from worldline.connect.sdk.communication.multipart_form_data_request import MultipartFormDataRequest
-from worldline.connect.sdk.communication.pooled_connection import PooledConnection
-from worldline.connect.sdk.communication.request_header import RequestHeader
-from worldline.connect.sdk.communication.response_exception import ResponseException
-from worldline.connect.sdk.communication.response_header import get_header_value
-from worldline.connect.sdk.log.logging_capable import LoggingCapable
-from worldline.connect.sdk.log.obfuscation_capable import ObfuscationCapable
-
-
-class Communicator(LoggingCapable, ObfuscationCapable):
-    """
-    Used to communicate with the Worldline Global Collect platform web services.
-
-    It contains all the logic to transform a request object to an HTTP request and an HTTP response to a response object.
-    """
-
-    def __init__(self, api_endpoint, connection, authenticator, metadata_provider, marshaller):
-        if api_endpoint is None:
-            raise ValueError("api_endpoint is required")
-        if isinstance(api_endpoint, basestring):
-            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 metadata_provider is None:
-            raise ValueError("metadata_provider is required")
-        if marshaller is None:
-            raise ValueError("marshaller is required")
-        self.__api_endpoint = api_endpoint
-        self.__connection = connection
-        self.__authenticator = authenticator
-        self.__metadata_provider = metadata_provider
-        self.__marshaller = marshaller
-
-    def close(self):
-        """
-        Releases any system resources associated with this object.
-        """
-        self.__connection.close()
-
-    def _get_with_binary_response(self, relative_path, request_headers, request_parameters, context):
-        if request_parameters is None:
-            request_parameter_list = None
-        else:
-            request_parameter_list = request_parameters.to_request_parameters()
-        uri = self._to_absolute_uri(relative_path, request_parameter_list)
-        if request_headers is None:
-            request_headers = []
-        self._add_generic_headers("GET", uri, request_headers, context)
-
-        return self.__connection.get(uri, request_headers)
-
-    def get_with_binary_response(self, relative_path, request_headers, request_parameters, context):
-        """
-        Corresponds to the HTTP GET method.
-
-        :param relative_path: The path to call, relative to the base URI.
-        :param request_headers: An optional list of request headers.
-        :param request_parameters: An optional set of request parameters.
-        :param context: The optional call context to use.
-        :raise: CommunicationException when an exception occurred communicating with the Worldline Global Collect platform
-        :raise: ResponseException when an error response was received from the Worldline Global Collect platform
-        """
-        (status, headers, chunks) = self._get_with_binary_response(relative_path, request_headers, request_parameters, context)
-        return self._process_binary_response(status, chunks, headers, relative_path, context)
-
-    def get(self, relative_path, request_headers, request_parameters, response_type, context):
-        """
-        Corresponds to the HTTP GET method.
-
-        :param relative_path: The path to call, relative to the base URI.
-        :param request_headers: An optional list of request headers.
-        :param request_parameters: An optional set of request parameters.
-        :param response_type: The type of response to return.
-        :param context: The optional call context to use.
-        :raise: CommunicationException when an exception occurred communicating with the Worldline Global Collect platform
-        :raise: ResponseException when an error response was received from the Worldline Global Collect platform
-        """
-        (status, headers, chunks) = self._get_with_binary_response(relative_path, request_headers, request_parameters, context)
-        return self._process_response(status, chunks, headers, relative_path, response_type, context)
-
-    def _delete_with_binary_response(self, relative_path, request_headers, request_parameters, context):
-        if request_parameters is None:
-            request_parameter_list = None
-        else:
-            request_parameter_list = request_parameters.to_request_parameters()
-        uri = self._to_absolute_uri(relative_path, request_parameter_list)
-        if request_headers is None:
-            request_headers = []
-        self._add_generic_headers("DELETE", uri, request_headers, context)
-
-        return self.__connection.delete(uri, request_headers)
-
-    def delete_with_binary_response(self, relative_path, request_headers, request_parameters, context):
-        """
-        Corresponds to the HTTP DELETE method.
-
-        :param relative_path: The path to call, relative to the base URI.
-        :param request_headers: An optional list of request headers.
-        :param request_parameters: An optional set of request parameters.
-        :param context: The optional call context to use.
-        :raise: CommunicationException when an exception occurred communicating with the Worldline Global Collect platform
-        :raise: ResponseException when an error response was received from the Worldline Global Collect platform
-        """
-        (status, headers, chunks) = self._delete_with_binary_response(relative_path, request_headers, request_parameters, context)
-        return self._process_binary_response(status, chunks, headers, relative_path, context)
-
-    def delete(self, relative_path, request_headers, request_parameters, response_type, context):
-        """
-        Corresponds to the HTTP DELETE method.
-
-        :param relative_path: The path to call, relative to the base URI.
-        :param request_headers: An optional list of request headers.
-        :param request_parameters: An optional set of request parameters.
-        :param response_type: The type of response to return.
-        :param context: The optional call context to use.
-        :raise: CommunicationException when an exception occurred communicating with the Worldline Global Collect platform
-        :raise: ResponseException when an error response was received from the Worldline Global Collect platform
-        """
-        (status, headers, chunks) = self._delete_with_binary_response(relative_path, request_headers, request_parameters, context)
-        return self._process_response(status, chunks, headers, relative_path, response_type, context)
-
-    def _post_with_binary_response(self, relative_path, request_headers, request_parameters, request_body, context):
-        if request_parameters is None:
-            request_parameter_list = None
-        else:
-            request_parameter_list = request_parameters.to_request_parameters()
-        uri = self._to_absolute_uri(relative_path, request_parameter_list)
-        if request_headers is None:
-            request_headers = []
-
-        body = None
-        if isinstance(request_body, MultipartFormDataObject):
-            request_headers.append(RequestHeader("Content-Type", request_body.content_type))
-            body = request_body
-        elif isinstance(request_body, MultipartFormDataRequest):
-            multipart = request_body.to_multipart_form_data_object()
-            request_headers.append(RequestHeader("Content-Type", multipart.content_type))
-            body = multipart
-        elif request_body is not None:
-            request_headers.append(RequestHeader("Content-Type", "application/json"))
-            body = self.__marshaller.marshal(request_body)
-
-        self._add_generic_headers("POST", uri, request_headers, context)
-        return self.__connection.post(uri, request_headers, body)
-
-    def post_with_binary_response(self, relative_path, request_headers, request_parameters, request_body, context):
-        """
-        Corresponds to the HTTP POST method.
-
-        :param relative_path: The path to call, relative to the base URI.
-        :param request_headers: An optional list of request headers.
-        :param request_parameters: An optional set of request parameters.
-        :param request_body: The optional request body to send.
-        :param context: The optional call context to use.
-        :raise: CommunicationException when an exception occurred communicating with the Worldline Global Collect platform
-        :raise: ResponseException when an error response was received from the Worldline Global Collect platform
-        """
-        (status, headers, chunks) = self._post_with_binary_response(relative_path, request_headers, request_parameters, request_body, context)
-        return self._process_binary_response(status, chunks, headers, relative_path, context)
-
-    def post(self, relative_path, request_headers, request_parameters, request_body, response_type, context):
-        """
-        Corresponds to the HTTP POST method.
-
-        :param relative_path: The path to call, relative to the base URI.
-        :param request_headers: An optional list of request headers.
-        :param request_parameters: An optional set of request parameters.
-        :param request_body: The optional request body to send.
-        :param response_type: The type of response to return.
-        :param context: The optional call context to use.
-        :raise: CommunicationException when an exception occurred communicating with the Worldline Global Collect platform
-        :raise: ResponseException when an error response was received from the Worldline Global Collect platform
-        """
-        (status, headers, chunks) = self._post_with_binary_response(relative_path, request_headers, request_parameters, request_body, context)
-        return self._process_response(status, chunks, headers, relative_path, response_type, context)
-
-    def _put_with_binary_response(self, relative_path, request_headers, request_parameters, request_body, context):
-        if request_parameters is None:
-            request_parameter_list = None
-        else:
-            request_parameter_list = request_parameters.to_request_parameters()
-        uri = self._to_absolute_uri(relative_path, request_parameter_list)
-        if request_headers is None:
-            request_headers = []
-
-        body = None
-        if isinstance(request_body, MultipartFormDataObject):
-            request_headers.append(RequestHeader("Content-Type", request_body.content_type))
-            body = request_body
-        elif isinstance(request_body, MultipartFormDataRequest):
-            multipart = request_body.to_multipart_form_data_object()
-            request_headers.append(RequestHeader("Content-Type", multipart.content_type))
-            body = multipart
-        elif request_body is not None:
-            request_headers.append(RequestHeader("Content-Type", "application/json"))
-            body = self.__marshaller.marshal(request_body)
-
-        self._add_generic_headers("PUT", uri, request_headers, context)
-        return self.__connection.put(uri, request_headers, body)
-
-    def put_with_binary_response(self, relative_path, request_headers, request_parameters, request_body, context):
-        """
-        Corresponds to the HTTP PUT method.
-
-        :param relative_path: The path to call, relative to the base URI.
-        :param request_headers: An optional list of request headers.
-        :param request_parameters: An optional set of request parameters.
-        :param request_body: The optional request body to send.
-        :param context: The optional call context to use.
-        :raise: CommunicationException when an exception occurred communicating with the Worldline Global Collect platform
-        :raise: ResponseException when an error response was received from the Worldline Global Collect platform
-        """
-        (status, headers, chunks) = self._put_with_binary_response(relative_path, request_headers, request_parameters, request_body, context)
-        return self._process_binary_response(status, chunks, headers, relative_path, context)
-
-    def put(self, relative_path, request_headers, request_parameters, request_body, response_type, context):
-        """
-        Corresponds to the HTTP PUT method.
-
-        :param relative_path: The path to call, relative to the base URI.
-        :param request_headers: An optional list of request headers.
-        :param request_parameters: An optional set of request parameters.
-        :param request_body: The optional request body to send.
-        :param response_type: The type of response to return.
-        :param context: The optional call context to use.
-        :raise: CommunicationException when an exception occurred communicating with the Worldline Global Collect platform
-        :raise: ResponseException when an error response was received from the Worldline Global Collect platform
-        """
-        (status, headers, chunks) = self._put_with_binary_response(relative_path, request_headers, request_parameters, request_body, context)
-        return self._process_response(status, chunks, headers, relative_path, response_type, context)
-
-    @property
-    def marshaller(self):
-        """
-        :return: The Marshaller object associated with this communicator. Never None.
-        """
-        return self.__marshaller
-
-    def _to_absolute_uri(self, relative_path, request_parameters):
-        if relative_path.startswith("/"):
-            absolute_path = relative_path
-        else:
-            absolute_path = "/" + relative_path
-        uri = self.__api_endpoint.geturl() + absolute_path
-        separator = "?"
-        if request_parameters is not None:
-            for nvp in request_parameters:
-                uri += separator
-                uri += quote(nvp.name) + "=" + quote(nvp.value)
-                separator = "&"
-        # no need to revalidate that uri has a valid scheme and netloc
-        return urlparse(uri)
-
-    def _add_generic_headers(self, http_method, uri, request_headers, context):
-        """
-        Adds the necessary headers to the given list of headers. This includes
-        the authorization header, which uses other headers, so when you need to
-        override this method, make sure to call super.addGenericHeaders at the
-        end of your overridden method.
-        """
-        # add server meta info header
-        request_headers.extend(self.__metadata_provider.metadata_headers)
-        # add date header
-        request_headers.append(RequestHeader("Date", self._get_header_date_string()))
-        if context is not None and context.idempotence_key is not None:
-            # add context specific headers
-            request_headers.append(RequestHeader("X-GCS-Idempotence-Key", context.idempotence_key))
-        # add authorization
-        authorization = self.__authenticator.get_authorization(http_method, uri, request_headers)
-        request_headers.append(RequestHeader("Authorization", authorization))
-
-    @staticmethod
-    def _get_header_date_string():
-        """
-        Returns the date in the preferred format for the HTTP date header.
-        """
-        date_format_utc = datetime.utcnow().strftime("%a, %d %b %Y %H:%M:%S GMT")
-        return date_format_utc
-
-    @staticmethod
-    def __collect_chunks(chunks):
-        collected_body = b""
-        for chunk in chunks:
-            collected_body += chunk
-        return collected_body.decode('utf-8')
-
-    def _process_binary_response(self, status, chunks, headers, request_path, context):
-        if context is not None:
-            self._update_context(headers, context)
-        self._throw_exception_if_necessary_binary(status, chunks, headers, request_path)
-        return headers, chunks
-
-    def _process_response(self, status, chunks, headers, request_path, response_type, context):
-        if context is not None:
-            self._update_context(headers, context)
-        body = self.__collect_chunks(chunks)
-        self._throw_exception_if_necessary(status, body, headers, request_path)
-        return self.__marshaller.unmarshal(body, response_type)
-
-    @staticmethod
-    def _update_context(headers, context):
-        """
-        Updates the given call context based on the contents of the given response.
-        """
-        idempotence_request_timestamp_value = get_header_value(headers, "X-GCS-Idempotence-Request-Timestamp")
-        if idempotence_request_timestamp_value is not None:
-            idempotence_request_timestamp = long(idempotence_request_timestamp_value)
-            context.idempotence_request_timestamp = idempotence_request_timestamp
-        else:
-            context.idempotence_request_timestamp = None
-
-    def _throw_exception_if_necessary_binary(self, status, chunks, headers, request_path):
-        """
-        Checks the Response for errors and throws an exception if necessary.
-        """
-        # status codes in the 100 or 300 range are not expected
-        if status < 200 or status >= 300:
-            body = self.__collect_chunks(chunks)
-            self.__throw_exception(status, body, headers, request_path)
-
-    def _throw_exception_if_necessary(self, status, body, headers, request_path):
-        """
-        Checks the Response for errors and throws an exception if necessary.
-        """
-        # status codes in the 100 or 300 range are not expected
-        if status < 200 or status >= 300:
-            self.__throw_exception(status, body, headers, request_path)
-
-    def __throw_exception(self, status, body, headers, request_path):
-        if body is not None and not self.__is_json(headers):
-            cause = ResponseException(status, body, headers)
-            if status == NOT_FOUND:
-                raise NotFoundException(cause, "The requested resource was not found; invalid path: " + request_path)
-            else:
-                raise CommunicationException(cause)
-        else:
-            raise ResponseException(status, body, headers)
-
-    @staticmethod
-    def __is_json(headers):
-        content_type = get_header_value(headers, "Content-Type")
-        return (content_type is None) or \
-               ("application/json".lower() == content_type) or \
-               (content_type.lower().startswith("application/json"))
-
-    def close_idle_connections(self, idle_time):
-        """
-        Utility method that delegates the call to this communicator's connection
-        if that's an instance of PooledConnection. If not this method does nothing.
-
-        :param idle_time: a datetime.timedelta object indicating the idle time
-        """
-        if isinstance(self.__connection, PooledConnection):
-            self.__connection.close_idle_connections(idle_time)
-
-    def close_expired_connections(self):
-        """
-        Utility method that delegates the call to this communicator's connection
-        if that's an instance of PooledConnection. If not this method does nothing.
-        """
-        if isinstance(self.__connection, PooledConnection):
-            self.__connection.close_expired_connections()
-
-    def set_body_obfuscator(self, body_obfuscator):
-        # delegate to the connection
-        self.__connection.set_body_obfuscator(body_obfuscator)
-
-    def set_header_obfuscator(self, header_obfuscator):
-        # delegate to the connection
-        self.__connection.set_header_obfuscator(header_obfuscator)
-
-    def enable_logging(self, communicator_logger):
-        # delegate to the connection
-        self.__connection.enable_logging(communicator_logger)
-
-    def disable_logging(self):
-        # delegate to the connection
-        self.__connection.disable_logging()
-
-    def __enter__(self):
-        return self
-
-    def __exit__(self, exc_type, exc_val, exc_tb):
-        self.close()

connect-sdk-python2-4.0.0/worldline/connect/sdk/json/marshaller.py

@@ -1,29 +0,0 @@
-from abc import ABCMeta, abstractmethod
-
-
-class Marshaller(object):
-    """
-    Used to marshal and unmarshal Worldline Global Collect platform request and response objects to and from JSON.
-    """
-    __metaclass__ = ABCMeta
-
-    @abstractmethod
-    def marshal(self, request_object):
-        """
-        Marshal a request object to a JSON string.
-
-        :param request_object: the object to marshal into a serialized JSON string
-        :return: the serialized JSON string of the request_object
-        """
-        raise NotImplementedError
-
-    @abstractmethod
-    def unmarshal(self, response_json, type_class):
-        """
-        Unmarshal a JSON string to a response object.
-
-        :param response_json: the json body that should be unmarshalled
-        :param type_class: The class to which the response_json should be unmarshalled
-        :raise: MarshallerSyntaxException if the JSON is not a valid representation for an object of the given type
-        """
-        raise NotImplementedError

connect-sdk-python2-4.0.0/worldline/connect/sdk/log/logging_capable.py

@@ -1,25 +0,0 @@
-from abc import ABCMeta, abstractmethod
-
-
-class LoggingCapable(object):
-    """
-    Classes that extend this class have support for log messages from
-    communicators.
-    """
-    __metaclass__ = ABCMeta
-
-    @abstractmethod
-    def enable_logging(self, communicator_logger):
-        """
-        Turns on logging using the given communicator logger.
-
-        :raise: ValueError If the given communicator logger is None.
-        """
-        raise NotImplementedError
-
-    @abstractmethod
-    def disable_logging(self):
-        """
-        Turns off logging.
-        """
-        raise NotImplementedError

connect-sdk-python2-4.0.0/worldline/connect/sdk/v1/api_exception.py

@@ -1,55 +0,0 @@
-#
-# This class was auto-generated from the API references found at
-# https://apireference.connect.worldline-solutions.com/
-#
-class ApiException(RuntimeError):
-    """
-    Represents an error response from the Worldline Global Collect platform which contains an ID and a list of errors.
-    """
-
-    def __init__(self, status_code, response_body, error_id, errors,
-                 message="the Worldline Global Collect platform returned an error response"):
-        super(ApiException, self).__init__(message)
-        self.__status_code = status_code
-        self.__response_body = response_body
-        self.__error_id = error_id
-        if errors is None:
-            self.__errors = ()
-        else:
-            self.__errors = errors
-
-    @property
-    def status_code(self):
-        """
-        :return: The HTTP status code that was returned by the Worldline Global Collect platform.
-        """
-        return self.__status_code
-
-    @property
-    def response_body(self):
-        """
-        :return: The raw response body that was returned by the Worldline Global Collect platform.
-        """
-        return self.__response_body
-
-    @property
-    def error_id(self):
-        """
-        :return: The error ID received from the Worldline Global Collect platform if available.
-        """
-        return self.__error_id
-
-    @property
-    def errors(self):
-        """
-        :return: The error list received from the Worldline Global Collect platform if available. Never None.
-        """
-        return self.__errors
-
-    def __str__(self):
-        string = super(ApiException, self).__str__()
-        if self.__status_code > 0:
-            string += "; status_code=" + str(self.__status_code)
-        if self.__response_body:
-            string += "; response_body='" + self.__response_body + "'"
-        return str(string)

connect-sdk-python2-4.0.0/worldline/connect/sdk/v1/declined_payment_exception.py

@@ -1,41 +0,0 @@
-#
-# This class was auto-generated from the API references found at
-# https://apireference.connect.worldline-solutions.com/
-#
-from declined_transaction_exception import DeclinedTransactionException
-
-
-class DeclinedPaymentException(DeclinedTransactionException):
-    """
-    Represents an error response from a create payment call.
-    """
-
-    def __init__(self, status_code, response_body, errors):
-        if errors is not None:
-            super(DeclinedPaymentException, self).__init__(status_code, response_body, errors.error_id, errors.errors,
-                                                           DeclinedPaymentException.__create_message(errors))
-        else:
-            super(DeclinedPaymentException, self).__init__(status_code, response_body, None, None,
-                                                           DeclinedPaymentException.__create_message(errors))
-        self.__errors = errors
-
-    @staticmethod
-    def __create_message(errors):
-        if errors is not None and errors.payment_result is not None:
-            payment = errors.payment_result.payment
-        else:
-            payment = None
-        if payment is not None:
-            return "declined payment '" + payment.id + "' with status '" + payment.status + "'"
-        else:
-            return "the Worldline Global Collect platform returned a declined payment response"
-
-    @property
-    def create_payment_result(self):
-        """
-        :return: The result of creating a payment if available, otherwise None.
-        """
-        if self.__errors is None:
-            return None
-        else:
-            return self.__errors.payment_result

connect-sdk-python2-4.0.0/worldline/connect/sdk/v1/declined_payout_exception.py

@@ -1,41 +0,0 @@
-#
-# This class was auto-generated from the API references found at
-# https://apireference.connect.worldline-solutions.com/
-#
-from declined_transaction_exception import DeclinedTransactionException
-
-
-class DeclinedPayoutException(DeclinedTransactionException):
-    """
-    Represents an error response from a payout call.
-    """
-
-    def __init__(self, status_code, response_body, errors):
-        if errors is not None:
-            super(DeclinedPayoutException, self).__init__(status_code, response_body, errors.error_id, errors.errors,
-                                                          DeclinedPayoutException.__create_message(errors))
-        else:
-            super(DeclinedPayoutException, self).__init__(status_code, response_body, None, None,
-                                                          DeclinedPayoutException.__create_message(errors))
-        self.__errors = errors
-
-    @staticmethod
-    def __create_message(errors):
-        if errors is not None:
-            payout = errors.payout_result
-        else:
-            payout = None
-        if payout is not None:
-            return "declined payout '" + payout.id + "' with status '" + payout.status + "'"
-        else:
-            return "the Worldline Global Collect platform returned a declined payout response"
-
-    @property
-    def payout_result(self):
-        """
-        :return: The result of creating a payout if available, otherwise None.
-        """
-        if self.__errors is None:
-            return None
-        else:
-            return self.__errors.payout_result

connect-sdk-python2-4.0.0/worldline/connect/sdk/v1/declined_refund_exception.py

@@ -1,41 +0,0 @@
-#
-# This class was auto-generated from the API references found at
-# https://apireference.connect.worldline-solutions.com/
-#
-from declined_transaction_exception import DeclinedTransactionException
-
-
-class DeclinedRefundException(DeclinedTransactionException):
-    """
-    Represents an error response from a refund call.
-    """
-
-    def __init__(self, status_code, response_body, errors):
-        if errors is not None:
-            super(DeclinedRefundException, self).__init__(status_code, response_body, errors.error_id, errors.errors,
-                                                          DeclinedRefundException.__create_message(errors))
-        else:
-            super(DeclinedRefundException, self).__init__(status_code, response_body, None, None,
-                                                          DeclinedRefundException.__create_message(errors))
-        self.__errors = errors
-
-    @staticmethod
-    def __create_message(errors):
-        if errors is not None:
-            refund = errors.refund_result
-        else:
-            refund = None
-        if refund is not None:
-            return "declined refund '" + refund.id + "' with status '" + refund.status + "'"
-        else:
-            return "the Worldline Global Collect platform returned a declined refund response"
-
-    @property
-    def refund_result(self):
-        """
-        :return: The result of creating a refund if available, otherwise None.
-        """
-        if self.__errors is None:
-            return None
-        else:
-            return self.__errors.refund_result