Add pagination object [#20]

Author: dnl-blkv

bunq/sdk/client.py

@@ -338,3 +338,18 @@ def headers(self):
         """
 
         return self._headers
+
+
+class Pagination(object):
+    """
+    :type _older_id: int|None
+    :type _newer_id: int|None
+    :type _future_id: int|None
+    :type _count: int|None
+    """
+
+    def __init__(self):
+        self._older_id = None
+        self._newer_id = None
+        self._future_id = None
+        self._count = None

bunq/sdk/json/adapters.py

@@ -1,5 +1,7 @@
 import datetime
+import urllib.parse as urlparse
 
+from bunq.sdk import client
 from bunq.sdk import context
 from bunq.sdk import model
 from bunq.sdk import security
@@ -440,3 +442,101 @@ def serialize(cls, timestamp):
         """
 
         return timestamp.strftime(cls._FORMAT_TIMESTAMP)
+
+
+class PaginationAdapter(converter.JsonAdapter):
+    # Raw pagination response field constants.
+    _FIELD_FUTURE_URL = 'future_url'
+    _FIELD_NEWER_URL = 'newer_url'
+    _FIELD_OLDER_URL = 'older_url'
+
+    # Processed pagination field constants.
+    _FIELD_OLDER_ID = 'older_id'
+    _FIELD_NEWER_ID = 'newer_id'
+    _FIELD_FUTURE_ID = 'future_id'
+    _FIELD_COUNT = 'count'
+
+    # Very first index in an array.
+    _INDEX_FIRST = 0
+
+    @classmethod
+    def deserialize(cls, target_class, pagination_response):
+        """
+        :type target_class: client.Pagination|type
+        :type pagination_response: dict
+
+        :rtype: client.Pagination
+        """
+
+        pagination = client.Pagination.__new__(client.Pagination)
+        pagination.__dict__ = cls.parse_pagination_dict(pagination_response)
+
+        return pagination
+
+    @classmethod
+    def parse_pagination_dict(cls, response_obj):
+        """
+        :type response_obj: dict
+
+        :rtype: dict
+        """
+
+        pagination_dict = {}
+
+        cls.update_dict_id_field_from_response_field(pagination_dict,
+                                                     cls._FIELD_OLDER_ID,
+                                                     response_obj,
+                                                     cls._FIELD_OLDER_URL,
+                                                     cls._FIELD_OLDER_ID)
+        cls.update_dict_id_field_from_response_field(pagination_dict,
+                                                     cls._FIELD_NEWER_ID,
+                                                     response_obj,
+                                                     cls._FIELD_NEWER_URL,
+                                                     cls._FIELD_NEWER_ID)
+        cls.update_dict_id_field_from_response_field(pagination_dict,
+                                                     cls._FIELD_FUTURE_ID,
+                                                     response_obj,
+                                                     cls._FIELD_FUTURE_URL,
+                                                     cls._FIELD_NEWER_ID)
+
+        return pagination_dict
+
+    @classmethod
+    def update_dict_id_field_from_response_field(cls, dict_,
+                                                 dict_id_field,
+                                                 response_obj,
+                                                 response_field,
+                                                 response_param):
+        """
+        :type dict_: dict
+        :type dict_id_field: str
+        :type response_obj: dict
+        :type response_field: str
+        :type response_param: str
+        """
+
+        url = response_obj[response_field]
+
+        if url is not None:
+            url_parsed = urlparse.urlparse(url)
+            parameters = urlparse.parse_qs(url_parsed.query)
+            dict_[dict_id_field] = int(
+                parameters[response_param][cls._INDEX_FIRST]
+            )
+
+            if cls._FIELD_COUNT in parameters:
+                dict_[cls._FIELD_COUNT] = int(
+                    parameters[cls._FIELD_COUNT][cls._INDEX_FIRST]
+                )
+
+    @classmethod
+    def serialize(cls, pagination):
+        """
+        :type pagination: client.Pagination
+
+        :raise: NotImplementedError
+        """
+
+        _ = pagination
+
+        raise NotImplementedError()