chore: add token pagination

Author: kridai

tests/unit/base/test_token_pagination.py

@@ -1,5 +1,5 @@
 import unittest
-from unittest.mock import Mock, AsyncMock
+from unittest.mock import Mock
 from tests import IntegrationTestCase
 from tests.holodeck import Request
 from twilio.base.exceptions import TwilioException
@@ -48,9 +48,14 @@ def setUp(self):
 
         self.solution = {
             "account_sid": "ACxxxx",
-            "uri": "/Accounts/ACxxxx/Resources.json",
+            "api_uri": "/Accounts/ACxxxx/Resources.json",
         }
-        self.page = TestTokenPaginationPage(self.version, self.response, self.solution)
+        self.page = TestTokenPaginationPage(
+            self.version,
+            self.response,
+            "/Accounts/ACxxxx/Resources.json",
+            self.solution,
+        )
 
     def test_key_property(self):
         """Test that key property returns the correct value"""
@@ -74,7 +79,9 @@ def test_properties_without_meta(self):
         response.text = '{"items": []}'
         response.status_code = 200
 
-        page = TestTokenPaginationPage(self.version, response, self.solution)
+        page = TestTokenPaginationPage(
+            self.version, response, "/Accounts/ACxxxx/Resources.json", self.solution
+        )
 
         self.assertIsNone(page.key)
         self.assertIsNone(page.page_size)
@@ -87,7 +94,9 @@ def test_properties_with_partial_meta(self):
         response.text = '{"meta": {"key": "items"}, "items": []}'
         response.status_code = 200
 
-        page = TestTokenPaginationPage(self.version, response, self.solution)
+        page = TestTokenPaginationPage(
+            self.version, response, "/Accounts/ACxxxx/Resources.json", self.solution
+        )
 
         self.assertEqual(page.key, "items")
         self.assertIsNone(page.page_size)
@@ -117,7 +126,9 @@ def setUp(self):
             }
             """,
             ),
-            Request(url="https://api.twilio.com/Accounts/ACaaaa/Resources.json"),
+            Request(
+                url="https://api.twilio.com/2010-04-01/Accounts/ACaaaa/Resources.json"
+            ),
         )
 
         # Mock second page response (next page)
@@ -130,14 +141,14 @@ def setUp(self):
                     "key": "items",
                     "pageSize": 2,
                     "nextToken": "token_page3",
-                    "previousToken": "token_page2"
+                    "previousToken": "token_prev1"
                 },
                 "items": [{"id": 3, "name": "Item 3"}, {"id": 4, "name": "Item 4"}]
             }
             """,
             ),
             Request(
-                url="https://api.twilio.com/Accounts/ACaaaa/Resources.json?pageToken=token_page2"
+                url="https://api.twilio.com/2010-04-01/Accounts/ACaaaa/Resources.json?pageToken=token_page2"
             ),
         )
 
@@ -151,18 +162,18 @@ def setUp(self):
                     "key": "items",
                     "pageSize": 2,
                     "nextToken": null,
-                    "previousToken": "token_page3"
+                    "previousToken": "token_prev2"
                 },
                 "items": [{"id": 5, "name": "Item 5"}]
             }
             """,
             ),
             Request(
-                url="https://api.twilio.com/Accounts/ACaaaa/Resources.json?pageToken=token_page3"
+                url="https://api.twilio.com/2010-04-01/Accounts/ACaaaa/Resources.json?pageToken=token_page3"
             ),
         )
 
-        # Mock previous page response
+        # Mock previous page response (going back to page 1)
         self.holodeck.mock(
             Response(
                 200,
@@ -179,7 +190,28 @@ def setUp(self):
             """,
             ),
             Request(
-                url="https://api.twilio.com/Accounts/ACaaaa/Resources.json?pageToken=token_page2"
+                url="https://api.twilio.com/2010-04-01/Accounts/ACaaaa/Resources.json?pageToken=token_prev1"
+            ),
+        )
+
+        # Mock going back from page 3 to page 2
+        self.holodeck.mock(
+            Response(
+                200,
+                """
+            {
+                "meta": {
+                    "key": "items",
+                    "pageSize": 2,
+                    "nextToken": "token_page3",
+                    "previousToken": "token_prev1"
+                },
+                "items": [{"id": 3, "name": "Item 3"}, {"id": 4, "name": "Item 4"}]
+            }
+            """,
+            ),
+            Request(
+                url="https://api.twilio.com/2010-04-01/Accounts/ACaaaa/Resources.json?pageToken=token_prev2"
             ),
         )
 
@@ -190,10 +222,15 @@ def setUp(self):
 
         self.solution = {
             "account_sid": "ACaaaa",
-            "uri": "/Accounts/ACaaaa/Resources.json",
+            "api_uri": "/2010-04-01/Accounts/ACaaaa/Resources.json",
         }
 
-        self.page = TestTokenPaginationPage(self.version, self.response, self.solution)
+        self.page = TestTokenPaginationPage(
+            self.version,
+            self.response,
+            "/2010-04-01/Accounts/ACaaaa/Resources.json",
+            self.solution,
+        )
 
     def test_next_page(self):
         """Test that next_page() navigates to the next page using token"""
@@ -206,7 +243,7 @@ def test_next_page(self):
         self.assertIsInstance(next_page, TestTokenPaginationPage)
         # Verify we got the next page's data
         self.assertEqual(next_page.next_token, "token_page3")
-        self.assertEqual(next_page.previous_token, "token_page2")
+        self.assertEqual(next_page.previous_token, "token_prev1")
 
     def test_next_page_none_when_no_token(self):
         """Test that next_page() returns None when there's no next token"""
@@ -226,7 +263,7 @@ def test_previous_page(self):
         # Navigate to second page first
         next_page = self.page.next_page()
         self.assertIsNotNone(next_page.previous_token)
-        self.assertEqual(next_page.previous_token, "token_page2")
+        self.assertEqual(next_page.previous_token, "token_prev1")
 
         # Go back to previous page
         prev_page = next_page.previous_page()
@@ -250,12 +287,12 @@ def test_navigation_chain(self):
         """Test navigating through multiple pages forward and backward"""
         # Page 1 -> Page 2
         page2 = self.page.next_page()
-        self.assertEqual(page2.previous_token, "token_page2")
+        self.assertEqual(page2.previous_token, "token_prev1")
 
         # Page 2 -> Page 3
         page3 = page2.next_page()
         self.assertIsNone(page3.next_token)
-        self.assertEqual(page3.previous_token, "token_page3")
+        self.assertEqual(page3.previous_token, "token_prev2")
 
         # Page 3 -> Page 2 (backward)
         back_to_page2 = page3.previous_page()
@@ -266,7 +303,7 @@ class TokenPaginationErrorTest(unittest.TestCase):
     """Test TokenPagination error handling"""
 
     def test_next_page_without_uri_in_solution(self):
-        """Test that next_page() raises error when URI is missing from solution"""
+        """Test that next_page() raises error when URI is missing"""
         version = Mock()
         response = Mock()
         response.text = """
@@ -284,139 +321,14 @@ def test_next_page_without_uri_in_solution(self):
         # Solution without URI
         solution = {"account_sid": "ACxxxx"}
 
-        page = TestTokenPaginationPage(version, response, solution)
+        # Pass empty string as URI to test the error case
+        page = TestTokenPaginationPage(version, response, "", solution)
 
         with self.assertRaises(TwilioException) as context:
             page.next_page()
 
         self.assertIn("URI must be provided", str(context.exception))
 
-    def test_previous_page_without_uri_in_solution(self):
-        """Test that previous_page() raises error when URI is missing from solution"""
-        version = Mock()
-        response = Mock()
-        response.text = """
-        {
-            "meta": {
-                "key": "items",
-                "pageSize": 50,
-                "previousToken": "xyz789"
-            },
-            "items": []
-        }
-        """
-        response.status_code = 200
-
-        # Solution without URI
-        solution = {"account_sid": "ACxxxx"}
-
-        page = TestTokenPaginationPage(version, response, solution)
-
-        with self.assertRaises(TwilioException) as context:
-            page.previous_page()
-
-        self.assertIn("URI must be provided", str(context.exception))
-
-
-class TokenPaginationAsyncTest(unittest.TestCase):
-    """Test TokenPagination async methods"""
-
-    async def test_next_page_async(self):
-        """Test that next_page_async() works correctly"""
-        version = Mock()
-        version.domain = Mock()
-        version.domain.absolute_url = Mock(
-            return_value="https://api.twilio.com/Accounts/ACxxxx/Resources.json"
-        )
-        version.domain.twilio = Mock()
-
-        # Mock async request
-        future_response = Mock()
-        future_response.text = """
-        {
-            "meta": {
-                "key": "items",
-                "pageSize": 50,
-                "nextToken": "next_token_2",
-                "previousToken": "prev_token_1"
-            },
-            "items": [{"id": 3}]
-        }
-        """
-        future_response.status_code = 200
-
-        version.domain.twilio.request_async = AsyncMock(return_value=future_response)
-
-        response = Mock()
-        response.text = """
-        {
-            "meta": {
-                "key": "items",
-                "pageSize": 50,
-                "nextToken": "token_next",
-                "previousToken": null
-            },
-            "items": [{"id": 1}]
-        }
-        """
-        response.status_code = 200
-
-        solution = {"account_sid": "ACxxxx", "uri": "/Accounts/ACxxxx/Resources.json"}
-        page = TestTokenPaginationPage(version, response, solution)
-
-        next_page = await page.next_page_async()
-
-        self.assertIsNotNone(next_page)
-        version.domain.twilio.request_async.assert_called_once()
-
-    async def test_previous_page_async(self):
-        """Test that previous_page_async() works correctly"""
-        version = Mock()
-        version.domain = Mock()
-        version.domain.absolute_url = Mock(
-            return_value="https://api.twilio.com/Accounts/ACxxxx/Resources.json"
-        )
-        version.domain.twilio = Mock()
-
-        # Mock async request
-        future_response = Mock()
-        future_response.text = """
-        {
-            "meta": {
-                "key": "items",
-                "pageSize": 50,
-                "nextToken": null,
-                "previousToken": null
-            },
-            "items": [{"id": 1}]
-        }
-        """
-        future_response.status_code = 200
-
-        version.domain.twilio.request_async = AsyncMock(return_value=future_response)
-
-        response = Mock()
-        response.text = """
-        {
-            "meta": {
-                "key": "items",
-                "pageSize": 50,
-                "nextToken": "token_next",
-                "previousToken": "token_prev"
-            },
-            "items": [{"id": 2}]
-        }
-        """
-        response.status_code = 200
-
-        solution = {"account_sid": "ACxxxx", "uri": "/Accounts/ACxxxx/Resources.json"}
-        page = TestTokenPaginationPage(version, response, solution)
-
-        prev_page = await page.previous_page_async()
-
-        self.assertIsNotNone(prev_page)
-        version.domain.twilio.request_async.assert_called_once()
-
 
 class TokenPaginationStreamTest(IntegrationTestCase):
     """Test streaming with TokenPagination"""
@@ -439,7 +351,9 @@ def setUp(self):
             }
             """,
             ),
-            Request(url="https://api.twilio.com/Accounts/ACaaaa/Records.json"),
+            Request(
+                url="https://api.twilio.com/2010-04-01/Accounts/ACaaaa/Records.json"
+            ),
         )
 
         # Mock page 2
@@ -459,7 +373,7 @@ def setUp(self):
             """,
             ),
             Request(
-                url="https://api.twilio.com/Accounts/ACaaaa/Records.json?pageToken=token_2"
+                url="https://api.twilio.com/2010-04-01/Accounts/ACaaaa/Records.json?pageToken=token_2"
             ),
         )
 
@@ -480,7 +394,7 @@ def setUp(self):
             """,
             ),
             Request(
-                url="https://api.twilio.com/Accounts/ACaaaa/Records.json?pageToken=token_3"
+                url="https://api.twilio.com/2010-04-01/Accounts/ACaaaa/Records.json?pageToken=token_3"
             ),
         )
 
@@ -491,10 +405,15 @@ def setUp(self):
 
         self.solution = {
             "account_sid": "ACaaaa",
-            "uri": "/Accounts/ACaaaa/Records.json",
+            "api_uri": "/2010-04-01/Accounts/ACaaaa/Records.json",
         }
 
-        self.page = TestTokenPaginationPage(self.version, self.response, self.solution)
+        self.page = TestTokenPaginationPage(
+            self.version,
+            self.response,
+            "/2010-04-01/Accounts/ACaaaa/Records.json",
+            self.solution,
+        )
 
     def test_stream_all_records(self):
         """Test streaming through all pages"""
@@ -520,22 +439,5 @@ def test_stream_with_page_limit(self):
         self.assertEqual(len(records), 2)
 
 
-class TokenPaginationReprTest(unittest.TestCase):
-    """Test TokenPagination string representation"""
-
-    def test_repr(self):
-        """Test __repr__ method"""
-        version = Mock()
-        response = Mock()
-        response.text = '{"meta": {"key": "items"}, "items": []}'
-        response.status_code = 200
-
-        solution = {"account_sid": "ACxxxx"}
-        page = TestTokenPaginationPage(version, response, solution)
-
-        repr_str = repr(page)
-        self.assertEqual(repr_str, "<TokenPagination>")
-
-
 if __name__ == "__main__":
     unittest.main()