[fix] Remove bad post-request guard clause in pagination functions (#303)

- Remove bad post-request guard clause causing pagination functions to never return the final page of results
- Add unit test to beta user children pagination tests to verify pagination function works as expected (allows iteration over all available pages)

Author: nwithan8

easypost/beta/user.py

@@ -45,7 +45,7 @@ def get_next_page_of_children(
 
         data, api_key = requestor.request(method=RequestMethod.GET, url=url, params=params, beta=True)
         next_children_array: List[Any] = data.get("children", [])
-        if len(next_children_array) == 0 or not data.get("has_more", False):
+        if len(next_children_array) == 0:
             raise Error(message="There are no more pages to retrieve.")
 
         return convert_to_easypost_object(response=data, api_key=api_key)

easypost/resource.py

@@ -93,7 +93,7 @@ def get_next_page(
 
         response, api_key = requestor.request(method=RequestMethod.GET, url=url, params=params)
         response_array: List[Any] = response.get(url[1:])  # type: ignore
-        if response is None or len(response_array) == 0 or not response.get("has_more"):
+        if response is None or len(response_array) == 0:
             raise Error(message="There are no more pages to retrieve.")
 
         return convert_to_easypost_object(response=response, api_key=api_key)

tests/cassettes/test_beta_user_get_next_page_collect_all.yaml

@@ -1,3 +1,5 @@
+from unittest.mock import patch
+
 import pytest
 
 import easypost
@@ -28,3 +30,73 @@ def test_beta_user_get_next_page(prod_api_key, page_size):
     except easypost.Error as e:
         if e.message != "There are no more pages to retrieve.":
             raise easypost.Error(message="Test failed intentionally.")
+
+
+@pytest.mark.vcr()  # Cassette not needed due to mocking, but used to avoid making real bogus API calls
+def test_beta_user_get_next_page_collect_all(prod_api_key):
+    page_size = 1  # Doesn't matter what this is, we're mocking the response
+    all_children = []
+
+    first_page_response = {
+        "children": [
+            {
+                "id": "user_123",
+            }
+        ],
+        "has_more": True,
+    }
+
+    # Mock the initial "get all children" call
+    return_value = (first_page_response, prod_api_key)
+    with patch("easypost.requestor.Requestor.request", return_value=return_value):
+        first_page = easypost.beta.User.all_children(page_size=page_size)
+        all_children += first_page["children"]
+        previous_page = first_page
+
+    second_page_response = {
+        "children": [
+            {
+                "id": "user_456",
+            }
+        ],
+        "has_more": True,
+    }
+
+    # Mock the first "get next page" call with more to collect after
+    # (current page "has_more" = True, next page "has_more" = True)
+    return_value = (second_page_response, prod_api_key)
+    with patch("easypost.requestor.Requestor.request", return_value=return_value):
+        next_page = easypost.beta.User.get_next_page_of_children(
+            children=previous_page, page_size=page_size  # type: ignore
+        )
+        all_children += next_page["children"]
+        previous_page = next_page
+
+    third_page_response = {
+        "children": [
+            {
+                "id": "user_789",
+            }
+        ],
+        "has_more": False,
+    }
+
+    # Mock the second "get next page" call with no more to collect
+    # (current page "has_more" = True, next page "has_more" = False)
+    return_value = (third_page_response, prod_api_key)
+    with patch("easypost.requestor.Requestor.request", return_value=return_value):
+        next_page = easypost.beta.User.get_next_page_of_children(
+            children=previous_page, page_size=page_size  # type: ignore
+        )
+        all_children += next_page["children"]
+        previous_page = next_page
+
+    # Verify we have all children (from both the "get all children" and "get next page" calls)
+    # Ensures that no guard clauses inside the "get next page" method are preventing us from collecting all children
+    assert len(all_children) == 3
+
+    # Now that the previous page has "has_more" = False, it should throw an error before even making the API call
+    with pytest.raises(easypost.Error) as error:
+        _ = easypost.beta.User.get_next_page_of_children(children=previous_page, page_size=page_size)  # type: ignore
+
+    assert str(error.value) == "There are no more pages to retrieve."