cleanup pagination; add basic tests for it [#20]

Author: dnl-blkv

bunq/sdk/client.py

@@ -384,6 +384,8 @@ class Pagination(object):
     # Error constants
     _ERROR_NO_PREVIOUS_PAGE = 'Could not generate previous page URL params: ' \
                               'there is no previous page.'
+    _ERROR_NO_NEXT_PAGE = 'Could not generate next page URL params: ' \
+                          'there is no next page.'
 
     # URL Param constants
     PARAM_OLDER_ID = 'older_id'
@@ -400,17 +402,30 @@ def __init__(self):
     def url_params_previous_page(self):
         """
         :rtype: dict[str, str]
-        :raise: exception.BunqException When there is no previous page.
         """
 
-        if not self.has_previous_item():
-            raise exception.BunqException(self._ERROR_NO_PREVIOUS_PAGE)
+        self.assert_has_previous_page()
 
         params = {self.PARAM_OLDER_ID: str(self.older_id)}
         self._add_count_to_params_if_needed(params)
 
         return params
 
+    def assert_has_previous_page(self):
+        """
+        :raise: exception.BunqException
+        """
+
+        if not self.has_previous_page():
+            raise exception.BunqException(self._ERROR_NO_PREVIOUS_PAGE)
+
+    def has_previous_page(self):
+        """
+        :rtype: bool
+        """
+
+        return self.older_id is not None
+
     @property
     def url_params_count_only(self):
         """
@@ -422,13 +437,6 @@ def url_params_count_only(self):
 
         return params
 
-    def has_previous_item(self):
-        """
-        :rtype: bool
-        """
-
-        return self.older_id is not None
-
     def _add_count_to_params_if_needed(self, params):
         """
         :type params: dict[str, str]
@@ -439,18 +447,7 @@ def _add_count_to_params_if_needed(self, params):
         if self.count is not None:
             params[self.PARAM_COUNT] = str(self.count)
 
-    @property
-    def _next_id(self):
-        """
-        :rtype: int
-        """
-
-        if self.has_next_item_assured():
-            return self.newer_id
-
-        return self.future_id
-
-    def has_next_item_assured(self):
+    def has_next_page_assured(self):
         """
         :rtype: bool
         """
@@ -463,7 +460,28 @@ def url_params_next_page(self):
         :rtype: dict[str, str]
         """
 
+        self.assert_has_next_page()
+
         params = {self.PARAM_NEWER_ID: str(self._next_id)}
         self._add_count_to_params_if_needed(params)
 
         return params
+
+    def assert_has_next_page(self):
+        """
+        :raise: exception.BunqException
+        """
+
+        if self._next_id is None:
+            raise exception.BunqException(self._ERROR_NO_NEXT_PAGE)
+
+    @property
+    def _next_id(self):
+        """
+        :rtype: int
+        """
+
+        if self.has_next_page_assured():
+            return self.newer_id
+
+        return self.future_id

examples/payment_list_example.py

@@ -32,7 +32,7 @@ def run():
     for payment in payments_response.value:
         print(payment.id_)
 
-    if payments_response.pagination.has_previous_item():
+    if payments_response.pagination.has_previous_page():
         print(_MESSAGE_SECOND_LATEST_PAGE_IDS)
         payments_response_previous = generated.Payment.list(
             api_context,

tests/test_pagination.py

@@ -0,0 +1,131 @@
+from bunq.sdk import client
+from bunq.sdk import exception
+from tests.bunq_test import BunqSdkTestCase
+
+
+class TestPagination(BunqSdkTestCase):
+    """
+    Tests:
+        Pagination
+    """
+
+    _PAGINATION_OLDER_ID_CUSTOM = 1
+    _PAGINATION_NEWER_ID_CUSTOM = 2
+    _PAGINATION_FUTURE_ID_CUSTOM = 3
+    _PAGINATION_COUNT_CUSTOM = 5
+
+    def test_get_url_params_count_only(self):
+        pagination = self.create_pagination_with_all_properties_set()
+        url_params_count_only_expected = {
+            client.Pagination.PARAM_COUNT: str(self._PAGINATION_COUNT_CUSTOM),
+        }
+
+        self.assertEqual(url_params_count_only_expected,
+                         pagination.url_params_count_only)
+
+    def create_pagination_with_all_properties_set(self):
+        """
+        :rtype: Pagination
+        """
+
+        pagination = client.Pagination()
+        pagination.older_id = self._PAGINATION_OLDER_ID_CUSTOM
+        pagination.newer_id = self._PAGINATION_NEWER_ID_CUSTOM
+        pagination.future_id = self._PAGINATION_FUTURE_ID_CUSTOM
+        pagination.count = self._PAGINATION_COUNT_CUSTOM
+
+        return pagination
+
+    def test_get_url_params_previous_page(self):
+        pagination = self.create_pagination_with_all_properties_set()
+        url_params_previous_page_expected = {
+            client.Pagination.PARAM_COUNT: str(self._PAGINATION_COUNT_CUSTOM),
+            client.Pagination.PARAM_OLDER_ID:
+                str(self._PAGINATION_OLDER_ID_CUSTOM),
+        }
+
+        self.assertTrue(pagination.has_previous_page())
+        self.assertEqual(url_params_previous_page_expected,
+                         pagination.url_params_previous_page)
+
+    def test_get_url_params_previous_page_no_count(self):
+        pagination = self.create_pagination_with_all_properties_set()
+        pagination.count = None
+        url_params_previous_page_expected = {
+            client.Pagination.PARAM_OLDER_ID:
+                str(self._PAGINATION_OLDER_ID_CUSTOM),
+        }
+
+        self.assertTrue(pagination.has_previous_page())
+        self.assertEqual(url_params_previous_page_expected,
+                         pagination.url_params_previous_page)
+
+    def test_get_url_params_next_page_newer(self):
+        pagination = self.create_pagination_with_all_properties_set()
+        url_params_next_page_expected = {
+            client.Pagination.PARAM_COUNT: str(self._PAGINATION_COUNT_CUSTOM),
+            client.Pagination.PARAM_NEWER_ID:
+                str(self._PAGINATION_NEWER_ID_CUSTOM),
+        }
+
+        self.assertTrue(pagination.has_next_page_assured())
+        self.assertEqual(url_params_next_page_expected,
+                         pagination.url_params_next_page)
+
+    def test_get_url_params_next_page_newer_no_count(self):
+        pagination = self.create_pagination_with_all_properties_set()
+        pagination.count = None
+        url_params_next_page_expected = {
+            client.Pagination.PARAM_NEWER_ID:
+                str(self._PAGINATION_NEWER_ID_CUSTOM),
+        }
+
+        self.assertTrue(pagination.has_next_page_assured())
+        self.assertEqual(url_params_next_page_expected,
+                         pagination.url_params_next_page)
+
+    def test_get_url_params_next_page_future(self):
+        pagination = self.create_pagination_with_all_properties_set()
+        pagination.newer_id = None
+        url_params_next_page_expected = {
+            client.Pagination.PARAM_COUNT: str(self._PAGINATION_COUNT_CUSTOM),
+            client.Pagination.PARAM_NEWER_ID:
+                str(self._PAGINATION_FUTURE_ID_CUSTOM),
+        }
+
+        self.assertFalse(pagination.has_next_page_assured())
+        self.assertEqual(url_params_next_page_expected,
+                         pagination.url_params_next_page)
+
+    def test_get_url_params_next_page_future_no_count(self):
+        pagination = self.create_pagination_with_all_properties_set()
+        pagination.newer_id = None
+        pagination.count = None
+        url_params_next_page_expected = {
+            client.Pagination.PARAM_NEWER_ID:
+                str(self._PAGINATION_FUTURE_ID_CUSTOM),
+        }
+
+        self.assertFalse(pagination.has_next_page_assured())
+        self.assertEqual(url_params_next_page_expected,
+                         pagination.url_params_next_page)
+
+    def test_get_url_params_prev_page_from_pagination_with_no_prev_page(self):
+        pagination = self.create_pagination_with_all_properties_set()
+        pagination.older_id = None
+
+        def access_url_params_previous_page():
+            _ = pagination.url_params_previous_page
+
+        self.assertRaises(exception.BunqException,
+                          access_url_params_previous_page)
+
+    def test_get_url_params_next_page_from_pagination_with_no_next_page(self):
+        pagination = self.create_pagination_with_all_properties_set()
+        pagination.newer_id = None
+        pagination.future_id = None
+
+        def access_url_params_next_page():
+            _ = pagination.url_params_next_page
+
+        self.assertRaises(exception.BunqException, access_url_params_next_page)