Merge branch 'release/0.13.0'

Author: Kevin Hellemun

.github/ISSUE_TEMPLATE.md

@@ -7,8 +7,17 @@
 ## What happens:
 1.
 
-## Logs
-- Logs
+## Traceback
+[//]: # (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)
+- [ ] Sandbox
+- [ ] Production
+
+## Response id
+[//]: # (If this error has something to do with a request that fails, please provide the response id of the request.)
+- Response id:
 
 ## Extra info:
-- Tested on
+[//]: # (Please provide any other relevant information here)

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,8 @@
+[//]: # (Thanks for opening this pull request! Before you proceed please make sure that you have an issue that explains what this pull request will do.
+         Make sure that all your commits link to this issue e.g. "My commit. \(bunq/sdk_python#<issue nr>\)".
+         If this pull request is changing files that are located in "bunq/sdk/model/generated" then this pull request will be closed as these files must/can only be changed on bunq's side.)
+         
+## 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#
+    - [ ] Tested

.zappr.yaml

@@ -0,0 +1,25 @@
+autobranch:
+  pattern: 'bunq/sdk_python#{number}-{title}'
+  length: 100
+commit:
+  message:
+    patterns:
+      - '([A-Za-z0-9 ]+)\. (\(bunq\/sdk_python#[0-9]+\))'
+specification:
+  title:
+    minimum-length:
+      enabled: true
+      length: 8
+  body:
+    minimum-length:
+      enabled: true
+      length: 8
+    contains-url: true
+    contains-issue-number: true
+  template:
+    differs-from-body: true
+pull-request:
+  labels:
+    additional: true
+    required:
+      - Can be merged

CHANGELOG.md

@@ -1,5 +1,36 @@
 # Change Log
 
+## [0.13.0](https://github.com/bunq/sdk_python/tree/0.13.0) (2018-03-20)
+
+[Full Changelog](https://github.com/bunq/sdk_python/compare/0.12.4...HEAD)
+
+**Implemented enhancements:**
+
+- Add zappr integration for better quality control  [\#62](https://github.com/bunq/sdk_python/issues/62)
+- Add more information to template [\#60](https://github.com/bunq/sdk_python/issues/60)
+- Add response id to error messages from failed requests  [\#59](https://github.com/bunq/sdk_python/issues/59)
+
+**Fixed bugs:**
+
+- Token request ideal is missing id attribute in response. [\#67](https://github.com/bunq/sdk_python/issues/67)
+- Field ID is missing from MasterCardAction [\#54](https://github.com/bunq/sdk_python/issues/54)
+- TokenQrRequestIdeal returns the wrong type [\#53](https://github.com/bunq/sdk_python/issues/53)
+
+**Closed issues:**
+
+- bunq update 7  [\#75](https://github.com/bunq/sdk_python/issues/75)
+
+**Merged pull requests:**
+
+- Bunq update 7  [\#76](https://github.com/bunq/sdk_python/pull/76) ([OGKevin](https://github.com/OGKevin))
+- Regenerate code for release [\#74](https://github.com/bunq/sdk_python/pull/74) ([OGKevin](https://github.com/OGKevin))
+- Regenerated code to add object types. \(bunq/sdk\_python\#53\) [\#70](https://github.com/bunq/sdk_python/pull/70) ([OGKevin](https://github.com/OGKevin))
+- Bunq/sdk python\#67 add missing token qr id field [\#69](https://github.com/bunq/sdk_python/pull/69) ([OGKevin](https://github.com/OGKevin))
+- Added missing id field to mastercard action. \(bunq/sdk\_python\#54\) [\#66](https://github.com/bunq/sdk_python/pull/66) ([OGKevin](https://github.com/OGKevin))
+- Feature/bunq/sdk python\#59 add response id to request error [\#64](https://github.com/bunq/sdk_python/pull/64) ([OGKevin](https://github.com/OGKevin))
+- Configure Zappr [\#63](https://github.com/bunq/sdk_python/pull/63) ([OGKevin](https://github.com/OGKevin))
+- \(bunq/sdk\_python\#60\) improve issue and pr template [\#61](https://github.com/bunq/sdk_python/pull/61) ([OGKevin](https://github.com/OGKevin))
+
 ## [0.12.4](https://github.com/bunq/sdk_python/tree/0.12.4) (2017-12-21)
 [Full Changelog](https://github.com/bunq/sdk_python/compare/0.12.3...0.12.4)
 
@@ -10,6 +41,7 @@
 - Return base class from createFromJsonString [\#49](https://github.com/bunq/sdk_python/issues/49)
 - CHANGELOG.md is empty [\#46](https://github.com/bunq/sdk_python/issues/46)
 - Improve decoder to recognise child object  [\#42](https://github.com/bunq/sdk_python/issues/42)
+- Generated CHANGELOG.md :clap:. \(bunq/sdk\_python\#46\) [\#47](https://github.com/bunq/sdk_python/pull/47) ([OGKevin](https://github.com/OGKevin))
 
 **Closed issues:**
 
@@ -20,7 +52,6 @@
 - Feature/make sure headers are correctly cased bunq/sdk python\#51 [\#57](https://github.com/bunq/sdk_python/pull/57) ([OGKevin](https://github.com/OGKevin))
 - Feature/improve decoder bunq/sdk python\#42 [\#56](https://github.com/bunq/sdk_python/pull/56) ([OGKevin](https://github.com/OGKevin))
 - Renamed camelCase methods. \(bunq/sdk\_python\#45\) [\#48](https://github.com/bunq/sdk_python/pull/48) ([OGKevin](https://github.com/OGKevin))
-- Generated CHANGELOG.md :clap:. \(bunq/sdk\_python\#46\) [\#47](https://github.com/bunq/sdk_python/pull/47) ([OGKevin](https://github.com/OGKevin))
 
 ## [0.12.3](https://github.com/bunq/sdk_python/tree/0.12.3) (2017-11-15)
 [Full Changelog](https://github.com/bunq/sdk_python/compare/0.12.2...0.12.3)

bunq/sdk/client.py

@@ -15,6 +15,13 @@ class ApiClient(object):
     :type _api_context: bunq.sdk.context.ApiContext
     """
 
+    # Error constants
+    _ERROR_COULD_NOT_DETERMINE_RESPONSE_ID_HEADER = ('The response header'
+                                                     '"X-Bunq-Client-Response-'
+                                                     'Id" or "x-bunq-client-'
+                                                     'response-id" could not '
+                                                     'be found.')
+
     # Endpoints not requiring active session for the request to succeed.
     _URL_DEVICE_SERVER = 'device-server'
     _URI_INSTALLATION = 'installation'
@@ -39,6 +46,8 @@ class ApiClient(object):
     HEADER_GEOLOCATION = 'X-Bunq-Geolocation'
     HEADER_SIGNATURE = 'X-Bunq-Client-Signature'
     HEADER_AUTHENTICATION = 'X-Bunq-Client-Authentication'
+    HEADER_RESPONSE_ID_UPPER_CASED = 'X-Bunq-Client-Response-Id'
+    HEADER_RESPONSE_ID_LOWER_CASED = 'x-bunq-client-response-id'
 
     # Default header values
     _USER_AGENT_BUNQ = 'bunq-sdk-python/0.12.4'
@@ -215,7 +224,8 @@ def _assert_response_success(self, response):
         if response.status_code != self._STATUS_CODE_OK:
             raise ExceptionFactory.create_exception_for_response(
                 response.status_code,
-                self._fetch_error_messages(response)
+                self._fetch_all_error_message(response),
+                self._fetch_response_id(response)
             )
 
     @classmethod
@@ -228,7 +238,7 @@ def _create_bunq_response_raw(cls, response):
 
         return BunqResponseRaw(response.content, response.headers)
 
-    def _fetch_error_messages(self, response):
+    def _fetch_all_error_message(self, response):
         """
         :type response: requests.Response
 
@@ -259,6 +269,23 @@ def _fetch_error_descriptions(self, error_dict):
 
         return error_descriptions
 
+    def _fetch_response_id(self, response):
+        """
+        :type response: requests.Response
+
+        :rtype: str
+        """
+
+        headers = response.headers
+
+        if self.HEADER_RESPONSE_ID_UPPER_CASED in headers:
+            return headers[self.HEADER_RESPONSE_ID_UPPER_CASED]
+
+        if self.HEADER_RESPONSE_ID_LOWER_CASED in headers:
+            return headers[self.HEADER_RESPONSE_ID_LOWER_CASED]
+
+        return self._ERROR_COULD_NOT_DETERMINE_RESPONSE_ID_HEADER;
+
     def put(self, uri_relative, request_bytes, custom_headers):
         """
         :type uri_relative: str

bunq/sdk/context.py

@@ -3,9 +3,11 @@
 import aenum
 from Cryptodome.PublicKey import RSA
 
-from bunq.sdk.model import core
 from bunq.sdk import security
+from bunq.sdk.exception import BunqException
 from bunq.sdk.json import converter
+from bunq.sdk.model import core
+from bunq.sdk.model.device_server_internal import DeviceServerInternal
 from bunq.sdk.model.generated import endpoint
 
 
@@ -119,13 +121,11 @@ def _register_device(self, device_description,
         :rtype: None
         """
 
-        endpoint.DeviceServer.create(
-            self,
-            {
-                endpoint.DeviceServer.FIELD_DESCRIPTION: device_description,
-                endpoint.DeviceServer.FIELD_SECRET: self.api_key,
-                endpoint.DeviceServer.FIELD_PERMITTED_IPS: permitted_ips,
-            }
+        DeviceServerInternal.create(
+            device_description,
+            self.api_key,
+            permitted_ips,
+            api_context=self
         )
 
     def _initialize_session(self):
@@ -136,8 +136,9 @@ def _initialize_session(self):
         session_server = core.SessionServer.create(self).value
         token = session_server.token.token
         expiry_time = self._get_expiry_timestamp(session_server)
+        user_id = session_server.get_referenced_object().id_
 
-        self._session_context = SessionContext(token, expiry_time)
+        self._session_context = SessionContext(token, expiry_time, user_id)
 
     @classmethod
     def _get_expiry_timestamp(cls, session_server):
@@ -377,16 +378,18 @@ class SessionContext(object):
     """
     :type _token: str
     :type _expiry_time: datetime.datetime
+    :type _user_id: int
     """
 
-    def __init__(self, token, expiry_time):
+    def __init__(self, token, expiry_time, user_id):
         """
         :type token: str
         :type expiry_time: datetime.datetime
         """
 
         self._token = token
         self._expiry_time = expiry_time
+        self._user_id = user_id
 
     @property
     def token(self):
@@ -403,3 +406,146 @@ def expiry_time(self):
         """
 
         return self._expiry_time
+
+    @property
+    def user_id(self):
+        return self._user_id
+
+
+class UserContext(object):
+    _ERROR_UNEXPECTED_USER_INSTANCE = '"{}" is unexpected user instance.'
+    _ERROR_NO_ACTIVE_MONETARY_ACCOUNT_FOUND = \
+        'No active monetary account found.'
+    _STATUS_ACTIVE = 'ACTIVE'
+
+    def __init__(self, user_id):
+        """
+        :type user_id: int
+        """
+
+        self._user_id = user_id
+        self._user_person = None
+        self._user_company = None
+        self._primary_monetary_account = None
+
+        user_object = endpoint.User.list().value[0].get_referenced_object()
+        self._set_user(user_object)
+
+    def _set_user(self, user):
+        if isinstance(user, endpoint.UserPerson):
+            self._user_person = user
+
+        elif isinstance(user, endpoint.UserCompany):
+            self._user_company = user
+
+        else:
+            raise BunqException(
+                self._ERROR_UNEXPECTED_USER_INSTANCE.format(user.__class__))
+
+    def init_main_monetary_account(self):
+        all_monetary_account = endpoint.MonetaryAccountBank.list().value
+
+        for account in all_monetary_account:
+            if account.status == self._STATUS_ACTIVE:
+                self._primary_monetary_account = account
+
+                return
+
+        raise BunqException(self._ERROR_NO_ACTIVE_MONETARY_ACCOUNT_FOUND)
+
+    @property
+    def user_id(self):
+        return self._user_id
+
+    def is_only_user_person_set(self):
+        """
+        :rtype: bool
+        """
+
+        return self._user_person is not None and self._user_company is None
+
+    def is_only_user_company_set(self):
+        """
+        :rtype: bool
+        """
+
+        return self._user_company is not None and self._user_person is None
+
+    def is_both_user_type_set(self):
+        """
+        :rtype: bool
+        """
+
+        return self._user_company is not None and self._user_person is not None
+
+    @property
+    def user_company(self):
+        """
+        :rtype: endpoint.UserCompany
+        """
+
+        return self._user_company
+
+    @property
+    def user_person(self):
+        """
+        :rtype: endpoint.UserPerson
+        """
+
+        return self._user_person
+
+    @property
+    def primary_monetary_account(self):
+        """
+        :rtype: endpoint.MonetaryAccountBank
+        """
+
+        return self._primary_monetary_account
+
+
+class BunqContext(object):
+    _ERROR_CLASS_SHOULD_NOT_BE_INITIALIZED = \
+        'This class should not be instantiated'
+    _ERROR_API_CONTEXT_HAS_NOT_BEEN_LOADED = \
+        'ApiContext has not been loaded. Please load ApiContext in BunqContext'
+    _ERROR_USER_CONTEXT_HAS_NOT_BEEN_LOADED = \
+        'UserContext has not been loaded, please load this' \
+        ' by loading ApiContext.'
+
+    _api_context = None
+    _user_context = None
+
+    def __init__(self):
+        raise TypeError(self._ERROR_CLASS_SHOULD_NOT_BE_INITIALIZED)
+
+    @classmethod
+    def load_api_context(cls, api_context):
+        """
+        :type api_context: ApiContext
+        """
+
+        cls._api_context = api_context
+        cls._user_context = UserContext(api_context.session_context.user_id)
+        cls._user_context.init_main_monetary_account()
+
+    @classmethod
+    def api_context(cls):
+        """
+        :rtype: ApiContext
+        """
+
+        if cls._api_context is not None:
+            return cls._api_context
+
+        raise BunqException(cls._ERROR_API_CONTEXT_HAS_NOT_BEEN_LOADED)
+
+    @classmethod
+    def user_context(cls):
+        """
+        :rtype: UserContext
+        """
+
+        if cls._user_context is not None:
+            return cls._user_context
+
+        raise BunqException(cls._ERROR_USER_CONTEXT_HAS_NOT_BEEN_LOADED)