v0.1.3 (#13)

* Added missing endpoints and refactored all tests

* Updated the ApiClient so that you can you can create an ApiClient with any variables using a kwargs

* Updated the Readme and changed the __init__ function in ApiClientPersisting

* Changed the folder structure in order to adhere to the PyPi standards (tests needs to be a top-level folder)

* Fixed the Avatar endpoint (added a verify parameter to making get-requests)
Fixed the ApiClientPersistent instantiation

* Fixed the get request for the case that a byte response is returned instead of JSON

* Changed the constructor of ApiClient and ApiClientPersisting based on OGKevin’s suggestion.

Author: PJUllrich

apiwrapper/clients/api_client.py

@@ -24,27 +24,28 @@ class ApiClient:
     _uri_production = "https://api.bunq.com/v%d" % __version_api
     _uri_sandbox = "https://sandbox.public.api.bunq.com/v%d" % __version_api
 
-    __variables = ['installation_id', 'installation_token', 'privkey',
+    __variables = ['installation_id', 'installation_token', 'api_key',
                    'server_token', 'server_pubkey', 'session_token']
 
-    def __init__(self, api_key, use_sandbox=True, **kwargs):
-        self.api_key = api_key
+    def __init__(self, privkey, use_sandbox=True, **kwargs):
+        self.privkey = privkey
         self._uri = self._uri_sandbox if use_sandbox else self._uri_production
         self._handle_kwargs(kwargs)
 
         self.__endpoint_controller = EndpointController(self)
 
     def _handle_kwargs(self, kwargs):
         for k in self.__variables:
-            setattr(self, k, kwargs.get(k))
+            if getattr(self, k, None) is None:
+                setattr(self, k, kwargs.get(k))
 
-    def get(self, endpoint):
+    def get(self, endpoint, verify=True):
         result = self.request('GET', endpoint)
 
-        if self.verify(result):
-            return result
+        if verify and not self.verify(result):
+            return None
 
-        return None
+        return result
 
     def post(self, endpoint, payload):
         return self.request('POST', endpoint, payload)

apiwrapper/clients/api_client_persisting.py

@@ -11,11 +11,11 @@ class ApiClientPersisting(ApiClient):
     in config/configcontroller.
     """
 
-    def __init__(self, api_key=None, use_sandbox=True, **kwargs):
+    def __init__(self, privkey=None, use_sandbox=True, **kwargs):
         self.config = Controller()
-        self.api_key = api_key if api_key is not None else self.config.get('api_key')
+        self.privkey = privkey if privkey is not None else self.config.get('key_private')
 
-        super.__init__(self.api_key, use_sandbox, kwargs)
+        super().__init__(self.privkey, use_sandbox=use_sandbox, **kwargs)
 
     @property
     def api_key(self):
@@ -45,6 +45,10 @@ def installation_token(self, value):
     def privkey(self):
         return self.config.get('key_private')
 
+    @privkey.setter
+    def privkey(self, value):
+        self.config.set('key_private', value)
+
     @property
     def server_pubkey(self):
         return self.config.get('server_pubkey')
@@ -68,5 +72,3 @@ def session_token(self):
     @session_token.setter
     def session_token(self, value):
         self.config.set('session_token', value)
-
-

apiwrapper/config/controller.py

@@ -25,14 +25,19 @@ def __init__(self, filepath=None):
 
     def get(self, name, section=__section_default):
         """Returns a value with a given name from the configuration file."""
-        try:
+        
+        if self.parser.has_option(section, name):
             return self.parser[section][name]
-        except KeyError:
+        else:
             return None
 
     def set(self, name, val, section=__section_default):
         """Sets an entry in the default section of the config file to a 
         specified value
+
+        If the entry should be set to None, this function will delete it
+        from the config file.
+
         :param section: [Optional] The section in which an entry 
         should be changed
         :param name: The entry whose value should be changed
@@ -42,7 +47,12 @@ def set(self, name, val, section=__section_default):
         if section not in self.parser.sections():
             self.parser.add_section(section)
 
-        self.parser.set(section, name, str(val))
+        if val is None:
+            if self.parser.has_option(section, name):
+                self.parser.remove_option(section, name)
+        else:
+            self.parser.set(section, name, str(val))
+            
         self.save()
 
     def save(self):

apiwrapper/endpoints/attachment_public.py

@@ -13,10 +13,10 @@ def _get_base_endpoint(cls, attachment_id):
     def get_public_attachment_by_id(self, attachment_id):
         endpoint = self._get_base_endpoint(attachment_id)
 
-        return self._make_get_request(endpoint)
+        return self._make_get_request(endpoint, verify=False)
 
     def get_content_of_public_attachment(self, attachment_id):
         endpoint = self._get_base_endpoint(attachment_id)
         endpoint += "/%s" % self.__endpoint_attachment_public_content
 
-        return self._make_get_request(endpoint)
+        return self._make_get_request(endpoint, verify=False)

apiwrapper/endpoints/avatar.py

@@ -12,4 +12,4 @@ def _get_base_endpoint(cls, avatar_id):
     def get_avatar_by_id(self, avatar_id):
         endpoint = self._get_base_endpoint(avatar_id)
 
-        return self._make_get_request(endpoint)
+        return self._make_get_request(endpoint, verify=False)

apiwrapper/endpoints/endpoint.py

@@ -8,8 +8,8 @@ class Endpoint:
     def __init__(self, api_client):
         self._api_client = api_client
 
-    def _make_get_request(self, endpoint):
-        return self._api_client.get(endpoint)
+    def _make_get_request(self, endpoint, verify=True):
+        return self._api_client.get(endpoint, verify)
 
     def _make_post_request(self, endpoint, payload):
         return self._api_client.post(endpoint, payload)

apiwrapper/utils/setup.py

@@ -34,9 +34,10 @@ def setup_w_new_key_pair(self, save_to_config=True):
 
     def setup_w_existing_private_key(self, private_key, save_to_config=True):
         if save_to_config:
-            self.api_client = ApiClientPersisting(self.api_key)
+            self.api_client = ApiClientPersisting(private_key,
+                                                  api_key=self.api_key)
         else:
-            self.api_client = ApiClient(private_key, self.api_key)
+            self.api_client = ApiClient(private_key, api_key=self.api_key)
 
         self.endpoints = endpoints.Controller(self.api_client)
 
@@ -59,7 +60,7 @@ def convert_private_key_to_pem(private_key):
 
     def create_new_key_pair(self, save_to_config=True):
         """Creates a new public/private key pair and saves them to the config file
-        
+
         :return: Prints out a success message
         """
         private_key = rsa.generate_private_key(
@@ -93,18 +94,18 @@ def create_new_key_pair(self, save_to_config=True):
     def register_key_pair(self):
         """Registers a public/private key pair with the Bunq API
         Ref: https://doc.bunq.com/api/1/call/installation/method/post
-        
+
         Saves the installation (user) token and server public key to config
-        
+
         KEY_PRIVATE needs to be set in the config for this method to run
-        
-        :return: Prints out either a success message or 
+
+        :return: Prints out either a success message or
         the Error message of the API
         """
 
-        r = self.endpoints.installation.create_installation()
+        r = self.endpoints.installation.create_installation().json()
         try:
-            res = r.json()['Response']
+            res = r['Response']
 
             id_entry = [x for x in res if list(x)[0] == 'Id'][0]
             token_entry = [x for x in res if list(x)[0] == 'Token'][0]
@@ -132,18 +133,18 @@ def register_key_pair(self):
             return False
 
     def create_new_device_server(self):
-        """Creates a new device server at the Bunq API 
+        """Creates a new device server at the Bunq API
         Ref: https://doc.bunq.com/api/1/call/device-server/method/post
-        
+
         API_KEY needs to be set in the config for this method to run
-        
+
         :return: Prints out either a Success or the Error message of the API
         """
         r = self.endpoints.device_server.create_new_device_server(
-            description="New Device")
+            description="New Device").json()
 
         try:
-            res = r.json()['Response']
+            res = r['Response']
 
             print('New device server was created successfully.')
             return True
@@ -154,19 +155,19 @@ def create_new_device_server(self):
     def create_new_session(self):
         """Creates a new session at the Bunq API
         Ref: https://doc.bunq.com/api/1/call/session-server/method/post
-        
+
         Saves the session token to config
-        
+
         API_KEY needs to be set in the config for this method to run
-        
-        :return: Prints out either a success message or the Error 
+
+        :return: Prints out either a success message or the Error
         message of the API
         """
 
-        r = self.endpoints.session_server.create_new_session_server()
+        r = self.endpoints.session_server.create_new_session_server().json()
 
         try:
-            res = r.json()['Response']
+            res = r['Response']
 
             res = [x for x in res if list(x)[0] == 'Token'][0]
             session_token = res['Token']['token']

setup.py

@@ -9,10 +9,9 @@
 def read(fname):
     return open(os.path.join(os.path.dirname(__file__), fname)).read()
 
-
 setup(
     name="bunq-api-sdk",
-    version="0.1.0",
+    version="0.1.2",
     author="Peter Ullrich",
     author_email="peter.j.ullrich@gmail.com",
     description=("A SDK for the Bunq API through which all HTTP "