onlinepayments-sdk-python3 4.22.0__zip → 5.0.0__zip

onlinepayments-sdk-python3-4.22.0/onlinepayments/sdk/meta_data_provider.py → onlinepayments_sdk_python3-5.0.0/onlinepayments/sdk/communication/metadata_provider.py

@@ -1,14 +1,17 @@
 import platform
 import re
 from base64 import b64encode
+from typing import Optional, Sequence
 
-from onlinepayments.sdk.data_object import DataObject
-from onlinepayments.sdk.defaultimpl.default_marshaller import DefaultMarshaller
+from .i_metadata_provider import IMetadataProvider
+from .request_header import RequestHeader
+
+from onlinepayments.sdk.domain.data_object import DataObject
 from onlinepayments.sdk.domain.shopping_cart_extension import ShoppingCartExtension
-from onlinepayments.sdk.request_header import RequestHeader
+from onlinepayments.sdk.json.default_marshaller import DefaultMarshaller
 
 
-class IterProperty:
+class IterProperty(object):
     def __init__(self, func):
         self.func = func
 
@@ -16,15 +19,15 @@ class IterProperty:
         return self.func(owner)
 
 
-class MetaDataProvider:
+class MetadataProvider(IMetadataProvider):
     """
     Provides meta info about the server.
     """
-    __SDK_VERSION = "4.22.0"
-    __SERVER_META_INFO_HEADER = "X-GCS-ServerMetaInfo"
-    __prohibited_headers = [__SERVER_META_INFO_HEADER, "X-GCS-Idempotence-Key", "Date", "Content-Type", "Authorization"]
-    __PROHIBITED_HEADERS = tuple(sorted(__prohibited_headers, key=str.lower))
-    __meta_data_headers = None
+    __sdk_version = "5.0.0"
+    __server_meta_info_header = "X-GCS-ServerMetaInfo"
+    __prohibited_headers = tuple(sorted([__server_meta_info_header, "X-GCS-Idempotence-Key", "Date", "Content-Type", "Authorization"],
+                                        key=str.lower))
+    __metadata_headers: Sequence[RequestHeader] = None
 
     class ServerMetaInfo(DataObject):
         platform_identifier = None
@@ -33,8 +36,8 @@ class MetaDataProvider:
         integrator = None
         shopping_cart_extension = None
 
-        def to_dictionary(self):
-            dictionary = super(MetaDataProvider.ServerMetaInfo, self).to_dictionary()
+        def to_dictionary(self) -> dict:
+            dictionary = super(MetadataProvider.ServerMetaInfo, self).to_dictionary()
             if self.platform_identifier is not None:
                 dictionary['platformIdentifier'] = self.platform_identifier
             if self.sdk_identifier is not None:
@@ -47,8 +50,8 @@ class MetaDataProvider:
                 dictionary['shoppingCartExtension'] = self.shopping_cart_extension.to_dictionary()
             return dictionary
 
-        def from_dictionary(self, dictionary):
-            super(MetaDataProvider.ServerMetaInfo, self).from_dictionary(dictionary)
+        def from_dictionary(self, dictionary: dict) -> 'MetadataProvider.ServerMetaInfo':
+            super(MetadataProvider.ServerMetaInfo, self).from_dictionary(dictionary)
             if 'platformIdentifier' in dictionary:
                 self.platform_identifier = dictionary['platformIdentifier']
             if 'sdkIdentifier' in dictionary:
@@ -63,14 +66,16 @@ class MetaDataProvider:
                 self.shopping_cart_extension = ShoppingCartExtension.create_from_dictionary(dictionary['shoppingCartExtension'])
             return self
 
-    def __init__(self, integrator, shopping_cart_extension=None, additional_request_headers=()):
-        MetaDataProvider.__validate_additional_request_headers(additional_request_headers)
+    def __init__(self, integrator: Optional[str], shopping_cart_extension: Optional[ShoppingCartExtension] = None,
+                 additional_request_headers: Optional[Sequence[RequestHeader]] = ()):
+        if integrator is None or not integrator.strip():
+            raise ValueError("integrator is required")
+
+        MetadataProvider.__validate_additional_request_headers(additional_request_headers)
 
         def subber(name_or_value):
             return re.sub(r'\r?\n(?:(?![\r\n])\s)*', " ", name_or_value).strip()
-
-        additional_request_headers = [RequestHeader(subber(header.name), subber(header.value))
-                                      for header in additional_request_headers]
+        additional_request_headers = [RequestHeader(subber(header.name), subber(header.value)) for header in additional_request_headers]
 
         server_meta_info = self.ServerMetaInfo()
         server_meta_info.platform_identifier = self._platform_identifier
@@ -79,48 +84,49 @@ class MetaDataProvider:
         server_meta_info.integrator = integrator
         server_meta_info.shopping_cart_extension = shopping_cart_extension
 
-        server_meta_info_string = DefaultMarshaller.INSTANCE().marshal(server_meta_info)
-        server_meta_info_header = RequestHeader(self.__SERVER_META_INFO_HEADER, b64encode(server_meta_info_string.encode('utf-8')))
+        server_meta_info_string = DefaultMarshaller.instance().marshal(server_meta_info)
+        server_meta_info_header = RequestHeader(self.__server_meta_info_header, b64encode(server_meta_info_string.encode('utf-8')).decode('utf-8'))
         if not additional_request_headers:
-            self.__meta_data_headers = tuple([server_meta_info_header])
+            self.__metadata_headers = tuple([server_meta_info_header])
         else:
             request_headers = [server_meta_info_header]
             request_headers.extend(additional_request_headers)
-            self.__meta_data_headers = tuple(request_headers)
+            self.__metadata_headers = tuple(request_headers)
 
     @staticmethod
-    def __validate_additional_request_headers(additional_request_headers):
+    def __validate_additional_request_headers(additional_request_headers: Optional[Sequence[RequestHeader]]) -> None:
         if additional_request_headers is not None:
             for additional_request_header in additional_request_headers:
-                MetaDataProvider.__validate_additional_request_header(additional_request_header)
+                MetadataProvider.__validate_additional_request_header(additional_request_header)
 
     @staticmethod
-    def __validate_additional_request_header(additional_request_header):
+    def __validate_additional_request_header(additional_request_header: RequestHeader) -> None:
         try:
-            if additional_request_header.name in MetaDataProvider.__PROHIBITED_HEADERS:
-                raise ValueError("request header not allowed: ", str(additional_request_header))
+            if additional_request_header.name in MetadataProvider.__prohibited_headers:
+                raise ValueError("request header not allowed: " + str(additional_request_header))
         except AttributeError:
             raise AttributeError("Each request header should have an attribute 'name' and an attribute 'value'")
 
     @IterProperty
-    def prohibited_headers(self):
-        return self.__PROHIBITED_HEADERS
+    def prohibited_headers(self) -> Sequence[str]:
+        return self.__prohibited_headers
 
     @property
-    def meta_data_headers(self):
+    def metadata_headers(self) -> Sequence[RequestHeader]:
         """
-        :return: The server related headers containing the META data to be
+        :return: The server related headers containing the metadata to be
          associated with the request (if any). This will always contain at least
          an automatically generated header X-GCS-ServerMetaInfo.
         """
-        return self.__meta_data_headers
+        return self.__metadata_headers
 
     @property
-    def _platform_identifier(self):
-        return platform.system() + " " + platform.release() + "/" + platform.version() + \
-               " Python/" + platform.python_version() + \
-               " (" + platform.python_implementation() + "; " + str(platform.python_compiler()) + ")"
+    def _platform_identifier(self) -> str:
+        return platform.system() + " " + platform.release() + "/" + \
+               platform.version() + " Python/" + platform.python_version() + \
+               " (" + platform.python_implementation() + "; " + \
+               str(platform.python_compiler()) + ")"
 
     @property
-    def _sdk_identifier(self):
-        return "OnlinePaymentsPython3ServerSDK/v" + self.__SDK_VERSION
+    def _sdk_identifier(self) -> str:
+        return "PythonServerSDK/v" + self.__sdk_version

{onlinepayments-sdk-python3-4.22.0/onlinepayments/sdk → onlinepayments_sdk_python3-5.0.0/onlinepayments/sdk/communication}/multipart_form_data_object.py

@@ -1,7 +1,11 @@
 import uuid
 
+from typing import Mapping
 
-class MultipartFormDataObject:
+from onlinepayments.sdk.domain.uploadable_file import UploadableFile
+
+
+class MultipartFormDataObject(object):
     """
     A representation of a multipart/form-data object.
     """
@@ -13,22 +17,22 @@ class MultipartFormDataObject:
         self.__files = {}
 
     @property
-    def boundary(self):
+    def boundary(self) -> str:
         return self.__boundary
 
     @property
-    def content_type(self):
+    def content_type(self) -> str:
         return self.__content_type
 
     @property
-    def values(self):
+    def values(self) -> Mapping[str, str]:
         return self.__values
 
     @property
-    def files(self):
+    def files(self) -> Mapping[str, UploadableFile]:
         return self.__files
 
-    def add_value(self, parameter_name, value):
+    def add_value(self, parameter_name: str, value: str) -> None:
         if parameter_name is None or not parameter_name.strip():
             raise ValueError("parameter_name is required")
         if value is None:
@@ -37,7 +41,7 @@ class MultipartFormDataObject:
             raise ValueError("duplicate parameterName: " + parameter_name)
         self.__values[parameter_name] = value
 
-    def add_file(self, parameter_name, uploadable_file):
+    def add_file(self, parameter_name: str, uploadable_file: UploadableFile) -> None:
         if parameter_name is None or not parameter_name.strip():
             raise ValueError("parameter_name is required")
         if uploadable_file is None:

onlinepayments_sdk_python3-5.0.0/onlinepayments/sdk/communication/multipart_form_data_request.py

@@ -0,0 +1,16 @@
+from abc import ABC, abstractmethod
+
+from .multipart_form_data_object import MultipartFormDataObject
+
+
+class MultipartFormDataRequest(ABC):
+    """
+    A representation of a multipart/form-data request.
+    """
+
+    @abstractmethod
+    def to_multipart_form_data_object(self) -> MultipartFormDataObject:
+        """
+        :return: :class:`onlinepayments.sdk.communication.MultipartFormDataObject`
+        """
+        raise NotImplementedError

{onlinepayments-sdk-python3-4.22.0/onlinepayments/sdk → onlinepayments_sdk_python3-5.0.0/onlinepayments/sdk/communication}/not_found_exception.py

@@ -1,10 +1,10 @@
 class NotFoundException(RuntimeError):
     """
     Indicates an exception that occurs when the requested resource is not found.
-    In normal usage of the SDK, this exception should not occur, however it is
-    possible. For example when path parameters are set with invalid values.
+    In normal usage of the SDK, this exception should not occur, however it is possible.
+    For example when path parameters are set with invalid values.
     """
 
-    def __init__(self, exception, message=None):
+    def __init__(self, exception: Exception, message: str):
         super(NotFoundException, self).__init__(message, exception)
         self.cause = exception

onlinepayments_sdk_python3-5.0.0/onlinepayments/sdk/communication/param_request.py

@@ -0,0 +1,17 @@
+from abc import ABC, abstractmethod
+from typing import List
+
+from .request_param import RequestParam
+
+
+class ParamRequest(ABC):
+    """
+    Represents a set of request parameters.
+    """
+
+    @abstractmethod
+    def to_request_parameters(self) -> List[RequestParam]:
+        """
+        :return: list[:class:`onlinepayments.sdk.communication.RequestParam`] representing the HTTP request parameters
+        """
+        raise NotImplementedError

{onlinepayments-sdk-python3-4.22.0/onlinepayments/sdk → onlinepayments_sdk_python3-5.0.0/onlinepayments/sdk/communication}/pooled_connection.py

@@ -1,10 +1,10 @@
-from abc import abstractmethod
+from abc import ABC, abstractmethod
+from datetime import timedelta
 
-from onlinepayments.sdk.connection import Connection
+from .connection import Connection
 
 
-# noinspection PyAbstractClass
-class PooledConnection(Connection):
+class PooledConnection(Connection, ABC):
     """
     Represents a pooled connection to the Online Payments platform server.
     Instead of setting up a new HTTP connection for each request, this
@@ -12,16 +12,18 @@ class PooledConnection(Connection):
     """
 
     @abstractmethod
-    def close_idle_connections(self, idle_time):
+    def close_idle_connections(self, idle_time: timedelta) -> None:
         """
         Closes all HTTP connections that have been idle for the specified time.
         This should also include all expired HTTP connections.
 
         :param idle_time: a datetime.timedelta object indicating the idle time
         """
+        raise NotImplementedError
 
     @abstractmethod
-    def close_expired_connections(self):
+    def close_expired_connections(self) -> None:
         """
         Closes all expired HTTP connections.
         """
+        raise NotImplementedError

{onlinepayments-sdk-python3-4.22.0/onlinepayments/sdk → onlinepayments_sdk_python3-5.0.0/onlinepayments/sdk/communication}/request_header.py

@@ -1,23 +1,26 @@
-class RequestHeader:
+from typing import Mapping, Optional, Sequence, Union
+
+
+class RequestHeader(object):
     """
     A single request header. Immutable.
     """
 
-    def __init__(self, name, value):
+    def __init__(self, name: str, value: Optional[str]):
         if name is None or not name.strip():
             raise ValueError("name is required")
         self.__name = name
         self.__value = value
 
     @property
-    def name(self):
+    def name(self) -> str:
         """
         :return: The header name.
         """
         return self.__name
 
     @property
-    def value(self):
+    def value(self) -> Optional[str]:
         """
         :return: The un-encoded value.
         """
@@ -27,7 +30,7 @@ class RequestHeader:
         return self.__name + ":" + str(self.__value)
 
 
-def get_header_value(headers, header_name):
+def get_header_value(headers: Union[Sequence[RequestHeader], Mapping[str, str], None], header_name: str) -> Optional[str]:
     """
     :return: The value of the header with the given name, or None if there was no such header.
     """
@@ -42,7 +45,7 @@ def get_header_value(headers, header_name):
     return None
 
 
-def get_header(headers, header_name):
+def get_header(headers: Union[Sequence[RequestHeader], Mapping[str, str], None], header_name: str) -> Optional[RequestHeader]:
     """
     :return: The header with the given name, or None if there was no such header.
     """

{onlinepayments-sdk-python3-4.22.0/onlinepayments/sdk → onlinepayments_sdk_python3-5.0.0/onlinepayments/sdk/communication}/request_param.py

@@ -1,23 +1,26 @@
-class RequestParam:
+from typing import Optional
+
+
+class RequestParam(object):
     """
     A single request parameter. Immutable.
     """
 
-    def __init__(self, name, value):
+    def __init__(self, name: str, value: Optional[str]):
         if name is None or not name.strip():
             raise ValueError("name is required")
         self.__name = name
         self.__value = value
 
     @property
-    def name(self):
+    def name(self) -> str:
         """
         :return: The parameter name.
         """
         return self.__name
 
     @property
-    def value(self):
+    def value(self) -> Optional[str]:
         """
         :return: The un-encoded value.
         """

{onlinepayments-sdk-python3-4.22.0/onlinepayments/sdk → onlinepayments_sdk_python3-5.0.0/onlinepayments/sdk/communication}/response_exception.py

@@ -1,17 +1,16 @@
-from typing import Any, Dict, Optional, Tuple
+from typing import Mapping, Optional, Tuple
 
-from onlinepayments.sdk.response_header import get_header, get_header_value
+from .response_header import get_header_value, get_header
 
 
 class ResponseException(RuntimeError):
     """
-    Thrown when a response was received from the Online Payments platform which
-    indicates an error.
+    Thrown when a response was received from the Online Payments platform which indicates an error.
     """
 
-    def __init__(self, status_code: int, body: Optional[str], headers: Dict[str, str]):
+    def __init__(self, status: int, body: Optional[str], headers: Optional[Mapping[str, str]]):
         super(ResponseException, self).__init__("the Online Payments platform returned an error response")
-        self.__status_code = status_code
+        self.__status_code = status
         self.__headers = headers if headers is not None else {}
         self.__body = body
 
@@ -30,20 +29,19 @@ class ResponseException(RuntimeError):
         return self.__body
 
     @property
-    def headers(self) -> Dict[str, str]:
+    def headers(self) -> Mapping[str, str]:
         """
-        :return: The headers that were returned by the Online Payments platform.
-         Never None.
+        :return: The headers that were returned by the Online Payments platform. Never None.
         """
         return self.__headers
 
-    def get_header(self, header_name) -> Optional[Tuple[str, Any]]:
+    def get_header(self, header_name: str) -> Optional[Tuple[str, str]]:
         """
         :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) -> str:
+    def get_header_value(self, header_name: str) -> Optional[str]:
         """
         :return: The value header with the given name, or None if there was no such header.
         """

onlinepayments_sdk_python3-5.0.0/onlinepayments/sdk/communication/response_header.py

@@ -0,0 +1,50 @@
+import re
+from typing import Mapping, Optional, Tuple
+
+
+def get_header_value(headers: Optional[Mapping[str, str]], header_name: str) -> Optional[str]:
+    """
+    :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: Optional[Mapping[str, str]], header_name: str) -> Optional[Tuple[str, str]]:
+    """
+    :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: Optional[Mapping[str, str]]) -> Optional[str]:
+    """
+    :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: str) -> str:
+    if len(filename) < 2:
+        return filename
+    if (filename.startswith("\"") and filename.endswith("\"")) or \
+       (filename.startswith("'") and filename.endswith("'")):
+        return filename[1:-1]
+    return filename