Merge pull request #128 from bunq/feature/dependency_upgrades

Feature/dependency upgrades

Author: nickvandegroes

README.md

@@ -21,7 +21,7 @@ This SDK is in **beta**. We cannot guarantee constant availability or stability.
 Thanks to your feedback we will make improvements on it.
 
 ## Installation
-``pip install bunq_sdk --upgrade``
+    pip install bunq_sdk --upgrade
 
 ## Usage
 
@@ -30,19 +30,37 @@ In order to start making calls with the bunq API, you must first register your A
 and create a session. In the SDKs, we group these actions and call it "creating an API context". The
 context can be created by using the following code snippet:
 
-```
-apiContext = context.ApiContext(ENVIRONMENT_TYPE, API_KEY,
-  DEVICE_DESCRIPTION);
-apiContext.save(API_CONTEXT_FILE_PATH)
-context.BunqContext.loadApiContext(apiContext)
-```
 
-This code snippet, except for `context.BunqContext.loadApiContext(apiContext)` should be called once per API key. 
+    apiContext = ApiContext.create(ENVIRONMENT_TYPE, API_KEY, DEVICE_DESCRIPTION)
+    apiContext.save(API_CONTEXT_FILE_PATH)
+
+
+**Please note**: initialising your application is a heavy task and it is recommended to do it only once per device.
+
+    apiContext = ApiContext.restore(self.API_CONTEXT_FILE_PATH)
+    BunqContext.loadApiContext(apiContext)
+
+After saving the context, you can restore it at any time: 
 
 #### Example
 
 See [`tinker/setup_context`](https://github.com/bunq/tinker_python/blob/2182b8be276fda921657ad22cfe0b8b48a585ccf/tinker/libs/bunq_lib.py#L44-L59)
 
+#### PSD2
+It is possible to create an ApiContext as PSD2 Service Provider. Although this might seem a complex task, we wrote some 
+helper implementations to get you started. You need to create a certificate and private key to get you started. 
+Our sandbox environment currently accepts all certificates, if these criteria are met:
+
+- Up to 64 characters
+- PISP and/or AISP used in the end.
+
+Make sure you have your unique eIDAS certificate number and certificates ready when you want to perform these tasks on 
+our production environment.
+
+Creating a PSD2 context is very easy:
+
+    apiContext = ApiContext.create_for_psd2(ENVIRONMENT_TYPE, CERTIFICATE, PRIVATE_KEY, CERTIFICATE_CHAIN, DEVICE_DESCRIPTION)
+
 #### Safety considerations
 The file storing the context details (i.e. `bunq.conf`) is a key to your account. Anyone having
 access to it is able to perform any Public API actions with your account. Therefore, we recommend
@@ -62,14 +80,11 @@ Creating objects through the API requires an `ApiContext`, a `requestMap` and id
 dependencies (such as User ID required for accessing a Monetary Account). Optionally, custom headers
 can be passed to requests.
 
-
-```
-payment_id = endpoint.Payment.create(
-	amount=Amount(amount_string, self._CURRENCY_EURL),
-    counterparty_alias=Pointer(self._POINTER_TYPE_EMAIL, recipient),
-    description=description
+    payment_id = endpoint.Payment.create(
+        amount=Amount(amount_string, self._CURRENCY_EURL),
+        counterparty_alias=Pointer(self._POINTER_TYPE_EMAIL, recipient),
+        description=description
     )
-```
 
 ##### Example
 See [`tinker/make_payment`](https://github.com/bunq/tinker_python/blob/2182b8be276fda921657ad22cfe0b8b48a585ccf/tinker/libs/bunq_lib.py#L140-L151)
@@ -81,11 +96,9 @@ UUID) Optionally, custom headers can be passed to requests.
 
 This type of calls always returns a model.
 
-```
-monetary_account = generated.MonetaryAccountBank.get(
-    _MONETARY_ACCOUNT_ITEM_ID
-)
-```
+    monetary_account = generated.MonetaryAccountBank.get(
+        _MONETARY_ACCOUNT_ITEM_ID
+    )
 
 ##### Example
 See [`tinker/list_all_payment`](https://github.com/bunq/tinker_python/blob/2182b8be276fda921657ad22cfe0b8b48a585ccf/tinker/libs/bunq_lib.py#L85-L103)
@@ -94,12 +107,10 @@ See [`tinker/list_all_payment`](https://github.com/bunq/tinker_python/blob/2182b
 Updating objects through the API goes the same way as creating objects, except that also the object to update identifier 
 (ID or UUID) is needed.
 
-```
-endpoint.Card.update(
-	card_id=int(card_id),
-	monetary_account_current_id=int(account_id)
-	)
-```
+    endpoint.Card.update(
+        card_id=int(card_id),
+        monetary_account_current_id=int(account_id)
+    )
 
 ##### Example
 See [`tinker/update_card`](https://github.com/bunq/tinker_python/blob/2182b8be276fda921657ad22cfe0b8b48a585ccf/tinker/libs/bunq_lib.py#L167-L174)
@@ -109,20 +120,15 @@ Deleting objects through the API requires an `ApiContext`, identifiers of all de
 accessing a Monetary Account), and the identifier of the object to delete (ID or UUID) Optionally, custom headers can be
 passed to requests.
 
-```
-Session.delete(self._SESSION_ID)
-```
+    Session.delete(self._SESSION_ID)
 
 ##### Example
 
-
 #### Listing objects
 Listing objects through the API requires an `ApiContext` and identifiers of all dependencies (such as User ID required
 for accessing a Monetary Account). Optionally, custom headers can be passed to requests.
 
-```
-users = generated.User.list(api_context)
-```
+    users = endpoint.User.list(api_context)
 
 ##### Example
 See [`UserListExample.py`](./examples/user_list_example.py)
@@ -133,8 +139,8 @@ To get an indication on how the SDK works you can use the python tinker which is
 ## Running Tests
 
 Information regarding the test cases can be found in the [README.md](./tests/README.md)
-located in [test](/tests)
+located in [test](/tests).
 
 ## Exceptions
 The SDK can raise multiple exceptions. For an overview of these exceptions please
-take a look at [EXCEPTIONS.md](./bunq/sdk/exception/EXCEPTIONS.md)
+take a look at [EXCEPTIONS.md](./bunq/sdk/exception/EXCEPTIONS.md).

bunq/sdk/exception/EXCEPTIONS.md

@@ -54,7 +54,7 @@ DESCRIPTION = "This wil raise a BadRequestException"
 
 try:
     # Make a call that might raise an exception
-    ApiContext(ApiEnvironmentType.SANDBOX, API_KEY, DESCRIPTION)
+    ApiContext.create(ApiEnvironmentType.SANDBOX, API_KEY, DESCRIPTION)
 except BadRequestException as error:
     # Do something if exception is raised
     print(error.response_code)

requirements.txt

@@ -1,6 +1,6 @@
-aenum==2.0.8
+aenum==2.2.3
 chardet==3.0.4
-pycryptodomex==3.4.6
-requests[socks]==2.18.1
-simplejson==3.11.1
-urllib3==1.21.1
+pycryptodomex==3.9.7
+requests[socks]==2.23.0
+simplejson==3.17.0
+urllib3==1.25.8

setup.py

@@ -70,11 +70,19 @@
     keywords='open-banking sepa bunq finance api payment',
 
     # Packages of the project. "find_packages()" lists all the project packages.
-    packages=find_packages(exclude=['contrib', 'docs', 'tests', 'examples',
-                                    'assets', '.idea', 'run.py']),
+    packages=find_packages(exclude=['contrib',
+                                    'docs',
+                                    'tests',
+                                    'examples',
+                                    'assets',
+                                    '.idea',
+                                    'run.py']),
 
     # Run-time dependencies of the project. These will be installed by pip.
-    install_requires=['aenum==2.0.8', 'chardet==3.0.4', 'pycryptodomex==3.4.6',
-                      'requests==2.18.1', 'simplejson==3.11.1',
-                      'urllib3==1.21.1'],
+    install_requires=['aenum==2.2.3',
+                      'chardet==3.0.4',
+                      'pycryptodomex==3.9.7',
+                      'requests==2.23.0',
+                      'simplejson==3.17.0',
+                      'urllib3==1.25.8'],
 )

tests/README.md

@@ -48,14 +48,14 @@ Note:
 
 ## Execution
 
-You can run the tests via command line: 
+You can run all the tests via command line: 
 
-```
-python -m unittest discover -s tests/model/generated
-```  
+    python -m unittest discover -s tests/context && \
+    python -m unittest discover -s tests/http && \
+    python -m unittest discover -s tests/model/generated
 
 or via PyCharm, but first you must configure PyCharm by doing the following:
-* Got to preferences --> tools --> Python integrated tools and change default
+* Go to `Preferences` --> `Tools` --> `Python integrated tools` and change default
 test runner to `unittests`.
 * Configure your Python interpreter to an supported Python version. Python 3 is
 recommended.

tests/context/test_psd2_context.py

@@ -16,7 +16,7 @@ class TestPsd2Context(unittest.TestCase):
     """
 
     _FILE_TEST_CONFIGURATION = '/assets/bunq-psd2-test.conf'
-    _FILE_TEST_OAUTH = '/assets/bunq-oauth-test.conf'
+    _FILE_TEST_OAUTH = '/assets/bunq-oauth-psd2-test.conf'
 
     _FILE_TEST_CERTIFICATE = '/assets/cert.pem'
     _FILE_TEST_CERTIFICATE_CHAIN = '/assets/cert.pem'