Merge remote-tracking branch 'origin/develop' into feature/sdk_python#136_complete_oauth_psd2_implementation

Author: angelomelonas

.github/ISSUE_TEMPLATE.md

@@ -11,7 +11,7 @@
 [//]: # (If there is a traceback please share it in a quote! You can do this by pasting the traceback text, highlighting it and pressing the quote button.)
 
 ## SDK version and environment
-- Tested on [0.12.4](https://github.com/bunq/sdk_python/releases/tag/0.12.4)
+- Tested on [1.14.0](https://github.com/bunq/sdk_python/releases/tag/1.14.0)
 - [ ] Sandbox
 - [ ] Production
 

.github/PULL_REQUEST_TEMPLATE.md

@@ -4,5 +4,5 @@
 
 ## This PR closes/fixes the following issues:
 [//]: # (If for some reason your pull request does not require a test case you can just mark this box as checked and explain why it does not require a test case.)
- - Closes bunq/sdk_php#
+ - Closes bunq/sdk_python#
     - [ ] Tested

CHANGELOG.md

@@ -28,6 +28,9 @@
 
 [Full Changelog](https://github.com/bunq/sdk_python/compare/1.10.16...1.13.0)
 
+**Breaking Changes:**
+- Breaking changes since v1.13.0 [\#142](https://github.com/bunq/sdk_python/issues/142) ([angelomelonas](https://github.com/angelomelonas))
+
 **Implemented enhancements:**
 
 - Python SDK Refactor [\#117](https://github.com/bunq/sdk_python/pull/117) ([angelomelonas](https://github.com/angelomelonas))

CONTRIBUTING.md

@@ -1,12 +1,12 @@
 ### How to contribute to the bunq Python SDK 😎
 
 #### Want to add a new amazing feature to our SDK? 🚀
-- First let’s discuss the feature that you would like to add. [Open a new issue](https://github.com/bunq/bunq-Python/issues/new), describe the feature and explain why you think it should be added.
+- First let’s discuss the feature that you would like to add. [Open a new issue](https://github.com/bunq/sdk_python/issues/new), describe the feature and explain why you think it should be added.
 - Once we agree on the new feature, open a new GitHub pull request and include all the relevant information to get your code approved!
 
 #### Did you find a bug? 🐛
-- Before opening a new issue check if the bug hasn't already been reported by searching on GitHub under [issues](https://github.com/bunq/bunq-Python/issues).  
-- If it hasn't already been reported you can [open a new issue](https://github.com/bunq/bunq-Python/issues/new). Make sure you include a title and clear description, as much relevant information as possible, and a code sample or an executable test case demonstrating the expected behaviour that is not occurring.
+- Before opening a new issue check if the bug hasn't already been reported by searching on GitHub under [issues](https://github.com/bunq/sdk_python/issues).  
+- If it hasn't already been reported you can [open a new issue](https://github.com/bunq/sdk_python/issues/new). Make sure you include a title and clear description, as much relevant information as possible, and a code sample or an executable test case demonstrating the expected behaviour that is not occurring.
 - If you wrote a patch that fixes a bug, open a new GitHub pull request and make sure to clearly describe the problem and your awesome solution. 
 
 #### Do you have questions about the source code?

bunq/__init__.py

@@ -1,4 +1,4 @@
-from typing import Type, Any
+from typing import Type
 
 from bunq.sdk.context.api_environment_type import ApiEnvironmentType
 from bunq.sdk.context.installation_context import InstallationContext
@@ -42,11 +42,11 @@ def initialize_converter() -> None:
     converter.register_adapter(datetime.datetime, DateTimeAdapter)
     converter.register_adapter(Pagination, PaginationAdapter)
 
-    def register_anchor_adapter(class_to_register: Type[Any]) -> None:
+    def register_anchor_adapter(class_to_register: Type[T]) -> None:
         if issubclass(class_to_register, AnchorObjectInterface):
             converter.register_adapter(class_to_register, AnchorObjectAdapter)
 
-    def get_class(class_string_to_get: str) -> Type[Any]:
+    def get_class(class_string_to_get: str) -> Type[T]:
         if hasattr(object_, class_string_to_get):
             return getattr(object_, class_string_to_get)
 

bunq/sdk/context/api_context.py

@@ -84,7 +84,8 @@ def create_for_psd2(cls,
         service_provider_credential = api_context.__initialize_psd2_credential(
             certificate,
             private_key,
-            all_chain_certificate)
+            all_chain_certificate
+        )
 
         api_context._api_key = service_provider_credential.token_value
 

bunq/sdk/json/converter.py

@@ -7,7 +7,7 @@
 import typing
 import warnings
 from types import ModuleType
-from typing import Type, Optional, Callable, Generator, Any, Dict, Match, List, Union, Generic
+from typing import Type, Optional, Callable, Generator, Dict, Match, List, Union, Generic
 
 from bunq.sdk.exception.bunq_exception import BunqException
 from bunq.sdk.util.type_alias import T, JsonValue
@@ -74,14 +74,14 @@ def register_custom_adapter(cls,
             cls._custom_deserializers[class_name] = adapter
 
     @classmethod
-    def _get_serializer(cls, cls_for: Type[Any]) -> type:
+    def _get_serializer(cls, cls_for: Type[T]) -> type:
         if cls_for.__name__ in cls._custom_serializers:
             return cls._custom_serializers[cls_for.__name__]
 
         return JsonAdapter
 
     @classmethod
-    def _get_deserializer(cls, cls_for: Type[Any]) -> Type[JsonAdapter]:
+    def _get_deserializer(cls, cls_for: Type[T]) -> Type[JsonAdapter]:
         if cls_for.__name__ in cls._custom_deserializers:
             return cls._custom_deserializers[cls_for.__name__]
 
@@ -121,7 +121,7 @@ def _deserialize_default(cls,
     @classmethod
     def _is_deserialized(cls,
                          cls_target: Type[T],
-                         obj: Any) -> bool:
+                         obj: T) -> bool:
         if cls_target is None:
             return True
 
@@ -151,7 +151,7 @@ def _deserialize_dict(cls,
 
     @classmethod
     def _deserialize_dict_attributes(cls,
-                                     cls_context: Type[Any],
+                                     cls_context: Type[T],
                                      dict_: Dict) -> Dict:
         dict_deserialized = {}
 
@@ -243,7 +243,7 @@ def _str_to_type(cls,
     @classmethod
     def _str_to_type_from_member_module(cls,
                                         module_: ModuleType,
-                                        string: str) -> Type[Any]:
+                                        string: str) -> Type[T]:
         """
 
         :raise: BunqException when could not find the class for the string.
@@ -307,7 +307,7 @@ def can_serialize(cls) -> bool:
         return True
 
     @classmethod
-    def serialize(cls, obj: Any) -> JsonValue:
+    def serialize(cls, obj: T) -> JsonValue:
         cls._initialize()
         serializer = cls._get_serializer(type(obj))
 
@@ -317,7 +317,7 @@ def serialize(cls, obj: Any) -> JsonValue:
             return serializer.serialize(obj)
 
     @classmethod
-    def _serialize_default(cls, obj: Any) -> JsonValue:
+    def _serialize_default(cls, obj: T) -> JsonValue:
         if obj is None or cls._is_primitive(obj):
             return obj
         elif cls._is_bytes(obj):
@@ -330,19 +330,19 @@ def _serialize_default(cls, obj: Any) -> JsonValue:
             return cls._serialize_dict(dict_)
 
     @classmethod
-    def _is_primitive(cls, obj: Any) -> bool:
+    def _is_primitive(cls, obj: T) -> bool:
         return cls._is_type_primitive(type(obj))
 
     @classmethod
-    def _is_type_primitive(cls, type_: Type[Any]) -> bool:
+    def _is_type_primitive(cls, type_: Type[T]) -> bool:
         return type_ in {int, str, bool, float}
 
     @classmethod
-    def _is_bytes(cls, obj: Any) -> bool:
+    def _is_bytes(cls, obj: T) -> bool:
         return cls._is_bytes_type(type(obj))
 
     @classmethod
-    def _is_bytes_type(cls, type_: Type[Any]) -> bool:
+    def _is_bytes_type(cls, type_: Type[T]) -> bool:
         return type_.__name__ in cls._TYPE_NAMES_BYTES
 
     @classmethod
@@ -356,7 +356,7 @@ def _serialize_list(cls, list_: List) -> List:
         return list_serialized
 
     @classmethod
-    def _get_obj_raw(cls, obj: Any) -> Dict:
+    def _get_obj_raw(cls, obj: T) -> Dict:
         return obj if type(obj) == dict else obj.__dict__
 
     @classmethod
@@ -375,32 +375,22 @@ def _serialize_dict(cls, dict_: Dict) -> Dict:
 
 
 class ValueTypes:
-    """
-    :type _main: type|None
-    :type _sub: type|None
-    """
-
     def __init__(self,
-                 main: Type[Any] = None,
-                 sub: Type[Any] = None) -> None:
+                 main: Type[T] = None,
+                 sub: Type[T] = None) -> None:
         self._main = main
         self._sub = sub
 
     @property
-    def main(self) -> Type[Any]:
+    def main(self) -> Type[T]:
         return self._main
 
     @property
-    def sub(self) -> Type[Any]:
+    def sub(self) -> Type[T]:
         return self._sub
 
 
 class ValueSpecs:
-    """
-    :type _name: str|None
-    :type _types: ValueTypes|None
-    """
-
     def __init__(self,
                  name: str = None,
                  types: ValueTypes = None) -> None:
@@ -444,11 +434,11 @@ def deserialize(cls: Type[T], obj_raw: JsonValue) -> T:
     return JsonAdapter.deserialize(cls, obj_raw)
 
 
-def class_to_json(obj: Any) -> JsonValue:
+def class_to_json(obj: T) -> JsonValue:
     obj_raw = serialize(obj)
 
     return json.dumps(obj_raw, indent=_JSON_INDENT, sort_keys=True)
 
 
-def serialize(obj_cls: Any) -> JsonValue:
+def serialize(obj_cls: T) -> JsonValue:
     return JsonAdapter.serialize(obj_cls)

setup.py

@@ -58,8 +58,6 @@
 
         # Specify the Python versions you support here. In particular, ensure
         # that you indicate whether you support Python 2, Python 3 or both.
-        'Programming Language :: Python :: 3.5',
-        'Programming Language :: Python :: 3.6',
         'Programming Language :: Python :: 3.7',
     ],
 

tests/bunq_test.py

@@ -1,19 +1,22 @@
 import os
 import time
 import unittest
+from typing import AnyStr
 
+from bunq.sdk.context.api_context import ApiContext
 from bunq.sdk.context.bunq_context import BunqContext
 from bunq.sdk.exception.bunq_exception import BunqException
 from bunq.sdk.http.api_client import ApiClient
+from bunq.sdk.model.generated.endpoint import MonetaryAccountBank, RequestInquiry, AttachmentPublic, Avatar, \
+    CashRegister
+from bunq.sdk.model.generated.object_ import Amount, Pointer
 from bunq.sdk.util import util
-from bunq.sdk.model.generated import endpoint
-from bunq.sdk.model.generated import object_
 
 
 class BunqSdkTestCase(unittest.TestCase):
     """
-    :type _second_monetary_account: endpoint.MonetaryAccountBank
-    :type _cash_register: endpoint.CashRegister
+    :type _second_monetary_account: MonetaryAccountBank
+    :type _cash_register: CashRegister
     """
 
     # Error constants.
@@ -61,31 +64,25 @@ def setUp(self):
         BunqContext.user_context().refresh_user_context()
 
     def __set_second_monetary_account(self):
-        response = endpoint.MonetaryAccountBank.create(
+        response = MonetaryAccountBank.create(
             self.__CURRENCY_EUR,
             self.__SECOND_MONETARY_ACCOUNT_DESCRIPTION
         )
 
-        self._second_monetary_account = endpoint.MonetaryAccountBank.get(
+        self._second_monetary_account = MonetaryAccountBank.get(
             response.value
         ).value
 
     def __request_spending_money(self):
-        endpoint.RequestInquiry.create(
-            object_.Amount(self.__SPENDING_MONEY_AMOUNT, self.__CURRENCY_EUR),
-            object_.Pointer(
-                self._POINTER_EMAIL,
-                self.__SPENDING_MONEY_RECIPIENT
-            ),
+        RequestInquiry.create(
+            Amount(self.__SPENDING_MONEY_AMOUNT, self.__CURRENCY_EUR),
+            Pointer(self._POINTER_EMAIL, self.__SPENDING_MONEY_RECIPIENT),
             self.__REQUEST_SPENDING_DESCRIPTION,
             False
         )
-        endpoint.RequestInquiry.create(
-            object_.Amount(self.__SPENDING_MONEY_AMOUNT, self.__CURRENCY_EUR),
-            object_.Pointer(
-                self._POINTER_EMAIL,
-                self.__SPENDING_MONEY_RECIPIENT
-            ),
+        RequestInquiry.create(
+            Amount(self.__SPENDING_MONEY_AMOUNT, self.__CURRENCY_EUR),
+            Pointer(self._POINTER_EMAIL, self.__SPENDING_MONEY_RECIPIENT),
             self.__REQUEST_SPENDING_DESCRIPTION,
             False,
             self._second_monetary_account.id_
@@ -98,55 +95,38 @@ def _get_cash_register_id(self):
         return self._cash_register.id_
 
     @classmethod
-    def _get_api_context(cls):
-        """
-        :rtype: ApiContext
-        """
-
+    def _get_api_context(cls) -> ApiContext:
         return util.automatic_sandbox_install()
 
-    def _get_pointer_bravo(self):
-        """
-        :rtype: object_.Pointer
-        """
-
-        return object_.Pointer(self._POINTER_EMAIL, self._EMAIL_BRAVO)
-
-    def _get_alias_second_account(self):
-        """
-        :rtype: object_.Pointer
-        """
+    def _get_pointer_bravo(self) -> Pointer:
+        return Pointer(self._POINTER_EMAIL, self._EMAIL_BRAVO)
 
+    def _get_alias_second_account(self) -> Pointer:
         return self._second_monetary_account.alias[self._FIRST_INDEX]
 
     @staticmethod
     def _get_directory_test_root():
         return os.path.dirname(os.path.abspath(__file__))
 
     def _set_cash_register(self):
-        attachment_uuid = endpoint.AttachmentPublic.create(
+        attachment_uuid = AttachmentPublic.create(
             self._attachment_contents,
             {
                 ApiClient.HEADER_CONTENT_TYPE: self._CONTENT_TYPE,
-                ApiClient.HEADER_ATTACHMENT_DESCRIPTION:
-                    self._ATTACHMENT_DESCRIPTION,
+                ApiClient.HEADER_ATTACHMENT_DESCRIPTION: self._ATTACHMENT_DESCRIPTION,
             }
         )
-        avatar_uuid = endpoint.Avatar.create(attachment_uuid.value)
-        cash_register_id = endpoint.CashRegister.create(
+        avatar_uuid = Avatar.create(attachment_uuid.value)
+        cash_register_id = CashRegister.create(
             self.__CASH_REGISTER_DESCRIPTION,
             self.__CASH_REGISTER_STATUS,
             avatar_uuid.value
         )
 
-        self._cash_register = endpoint.CashRegister.get(cash_register_id.value)
+        self._cash_register = CashRegister.get(cash_register_id.value)
 
     @property
-    def _attachment_contents(self):
-        """
-        :rtype: bytes
-        """
-
+    def _attachment_contents(self) -> AnyStr:
         with open(
                 self._get_directory_test_root() +
                 self._PATH_ATTACHMENT +
@@ -156,17 +136,11 @@ def _attachment_contents(self):
             return file.read()
 
     @property
-    def alias_first(self):
-        """
-        :rtype: Pointer
-        """
-
+    def alias_first(self) -> Pointer:
         if BunqContext.user_context().is_only_user_company_set():
-            return BunqContext.user_context().user_company.alias[
-                self._FIRST_INDEX]
+            return BunqContext.user_context().user_company.alias[self._FIRST_INDEX]
 
         if BunqContext.user_context().is_only_user_person_set():
-            return BunqContext.user_context().user_person.alias[
-                self._FIRST_INDEX]
+            return BunqContext.user_context().user_person.alias[self._FIRST_INDEX]
 
         raise BunqException(self.__ERROR_COULD_NOT_DETERMINE_USER)