Merge pull request #17 from bunq/16_proxy

Add proxy support [#16]

Author: OGKevin

bunq/sdk/client.py

@@ -19,6 +19,9 @@ class ApiClient(object):
     :type _api_context: context.ApiContext
     """
 
+    # HTTPS type of proxy, the only used at bunq
+    _FIELD_PROXY_HTTPS = 'https'
+
     # Header constants
     HEADER_ATTACHMENT_DESCRIPTION = 'X-Bunq-Attachment-Description'
     HEADER_CONTENT_TYPE = 'Content-Type'
@@ -98,7 +101,8 @@ def _request(self, method, uri_relative, request_bytes, custom_headers):
             method,
             self._get_uri_full(uri_relative),
             data=request_bytes,
-            headers=all_headers
+            headers=all_headers,
+            proxies={self._FIELD_PROXY_HTTPS: self._api_context.proxy_url}
         )
 
         self._assert_response_success(response)

bunq/sdk/context.py

@@ -41,6 +41,7 @@ class ApiContext(object):
     :type _api_key: str
     :type _session_context: SessionContext
     :type _installation_context: InstallationContext
+    :type _proxy_url: str|None
     """
 
     # File mode for saving and restoring the context
@@ -57,12 +58,13 @@ class ApiContext(object):
     _PATH_API_CONTEXT_DEFAULT = 'bunq.conf'
 
     def __init__(self, environment_type, api_key, device_description,
-                 permitted_ips=None):
+                 permitted_ips=None, proxy_url=None):
         """
         :type environment_type: ApiEnvironmentType
         :type api_key: str
         :type device_description: str
         :type permitted_ips: list[str]|None
+        :type proxy_url: str|None
         """
 
         if permitted_ips is None:
@@ -72,6 +74,7 @@ def __init__(self, environment_type, api_key, device_description,
         self._api_key = api_key
         self._installation_context = None
         self._session_context = None
+        self._proxy_url = proxy_url
         self._initialize(device_description, permitted_ips)
 
     def _initialize(self, device_description, permitted_ips):
@@ -254,6 +257,14 @@ def session_context(self):
 
         return self._session_context
 
+    @property
+    def proxy_url(self):
+        """
+        :rtype: str
+        """
+
+        return self._proxy_url
+
     def save(self, path=None):
         """
         :type path: str

bunq/sdk/json/converter.py

@@ -29,7 +29,8 @@ class JsonAdapter(object):
     _PREFIX_KEY_PROTECTED = '_'
 
     # Constants to fetch param types from the docstrings
-    _PATTERN_PARAM_TYPES = ':type (_?{}): ([\w.]+)(?:\[([\w.]+)\])?'
+    _TEMPLATE_PATTERN_PARAM_TYPES = ':type (_?{}): ([\w.]+)(?:\[([\w.]+)\])?'
+    _PATTERN_PARAM_NAME_TYPED_ANY = ':type (\w+):'
     _SUBMATCH_INDEX_NAME = 1
     _SUBMATCH_INDEX_TYPE_MAIN = 2
     _SUBMATCH_INDEX_TYPE_SUB = 3
@@ -163,7 +164,9 @@ def _deserialize_dict(cls, cls_target, dict_):
         """
 
         instance = cls_target.__new__(cls_target, cls_target)
-        instance.__dict__ = cls._deserialize_dict_attributes(cls_target, dict_)
+        dict_deserialized = cls._deserialize_dict_attributes(cls_target, dict_)
+        instance.__dict__ = cls._fill_default_values(cls_target,
+                                                     dict_deserialized)
 
         return instance
 
@@ -192,18 +195,6 @@ def _deserialize_dict_attributes(cls, cls_context, dict_):
 
         return dict_deserialized
 
-    @classmethod
-    def _warn_key_unknown(cls, cls_context, key):
-        """
-        :type cls_context: type
-        :type key: str
-
-        :rtype: None
-        """
-
-        context_name = cls_context.__name__
-        warnings.warn(cls._WARNING_KEY_UNKNOWN.format(key, context_name))
-
     @classmethod
     def _deserialize_key(cls, key):
         """
@@ -240,7 +231,7 @@ def _fetch_attribute_specs_from_doc(cls, cls_in, attribute_name):
         :rtype: ValueSpecs
         """
 
-        pattern = cls._PATTERN_PARAM_TYPES.format(attribute_name)
+        pattern = cls._TEMPLATE_PATTERN_PARAM_TYPES.format(attribute_name)
         match = re.search(pattern, cls_in.__doc__)
 
         if match is not None:
@@ -366,6 +357,37 @@ def _deserialize_list(cls, type_item, list_):
 
         return list_deserialized
 
+    @classmethod
+    def _warn_key_unknown(cls, cls_context, key):
+        """
+        :type cls_context: type
+        :type key: str
+
+        :rtype: None
+        """
+
+        context_name = cls_context.__name__
+        warnings.warn(cls._WARNING_KEY_UNKNOWN.format(key, context_name))
+
+    @classmethod
+    def _fill_default_values(cls, cls_context, dict_):
+        """
+        :type cls_context: type
+        :type dict_: dict
+
+        :rtype: dict
+        """
+
+        dict_with_default_values = dict(dict_)
+        params = re.findall(cls._PATTERN_PARAM_NAME_TYPED_ANY,
+                            cls_context.__doc__)
+
+        for param in params:
+            if param not in dict_with_default_values:
+                dict_with_default_values[param] = None
+
+        return dict_with_default_values
+
     @classmethod
     def can_serialize(cls):
         """

requirements.txt

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