fixes the integration of pagedResponse for all types of pagination and refactors the apply_metadata method and related variables

Author: sufyankhanrao

apimatic_core/pagination/configuration/cursor_pagination.py

@@ -4,8 +4,8 @@
 
 class CursorPagination(PaginationStrategy):
 
-    def __init__(self, output, input_, metadata_creator):
-        super().__init__(metadata_creator)
+    def __init__(self, output, input_, metadata_wrapper):
+        super().__init__(metadata_wrapper)
 
         if input_ is None:
             raise ValueError("Input pointer for cursor based pagination cannot be None")
@@ -35,8 +35,8 @@ def apply(self, paginated_data):
 
         return self.get_updated_request_builder(request_builder, self._input, self._cursor_value)
 
-    def apply_metadata(self, page):
-        return self._metadata_creator(self._cursor_value, page)
+    def apply_metadata_wrapper(self, paged_response):
+        return self._metadata_wrapper(self._cursor_value, paged_response)
 
     @staticmethod
     def _get_initial_cursor_value(request_builder, input_pointer):

apimatic_core/pagination/configuration/link_pagination.py

@@ -6,8 +6,8 @@
 class LinkPagination(PaginationStrategy):
     """Pagination manager implementation for link-based pagination."""
 
-    def __init__(self, next_link_pointer, metadata_creator):
-        super().__init__(metadata_creator)
+    def __init__(self, next_link_pointer, metadata_wrapper):
+        super().__init__(metadata_wrapper)
 
         if next_link_pointer is None:
             raise ValueError("Next link pointer for cursor based pagination cannot be None")
@@ -39,5 +39,5 @@ def apply(self, paginated_data):
             query_params=updated_query_params
         )
 
-    def apply_metadata(self, page):
-        return self._metadata_creator(self._next_link, page)
+    def apply_metadata_wrapper(self, paged_response):
+        return self._metadata_wrapper(self._next_link, paged_response)

apimatic_core/pagination/configuration/offset_pagination.py

@@ -6,14 +6,14 @@
 class OffsetPagination(PaginationStrategy):
     """Pagination manager implementation for offset-based pagination."""
 
-    def __init__(self, input_, metadata_creator):
+    def __init__(self, input_, metadata_wrapper):
         """
         Initializes a new instance of the OffsetPagination class.
 
         Args:
             input_ (str): JSON pointer to the request field representing the offset.
         """
-        super().__init__(metadata_creator)
+        super().__init__(metadata_wrapper)
 
         if input_ is None:
             raise ValueError("Input pointer for offset based pagination cannot be None")
@@ -34,8 +34,8 @@ def apply(self, paginated_data):
 
         return self.get_updated_request_builder(request_builder, self._input, self._offset)
 
-    def apply_metadata(self, page):
-        return self._metadata_creator(self._offset, page)
+    def apply_metadata_wrapper(self, page_response):
+        return self._metadata_wrapper(self._offset, page_response)
 
     def _get_initial_offset(self, request_builder):
         path_prefix, field_path = ApiHelper.split_into_parts(self._input)

apimatic_core/pagination/configuration/page_pagination.py

@@ -3,8 +3,8 @@
 
 class PagePagination(PaginationStrategy):
 
-    def __init__(self, input_, metadata_creator):
-        super().__init__(metadata_creator)
+    def __init__(self, input_, metadata_wrapper):
+        super().__init__(metadata_wrapper)
 
         if input_ is None:
             raise ValueError("Input pointer for page based pagination cannot be None")
@@ -24,8 +24,8 @@ def apply(self, paginated_data):
 
         return self.get_updated_request_builder(request_builder, self._input, self._page_number)
 
-    def apply_metadata(self, page):
-        return self._metadata_creator(self._page_number, page)
+    def apply_metadata_wrapper(self, paged_response):
+        return self._metadata_wrapper(self._page_number, paged_response)
 
     def _get_initial_page_offset(self, request_builder):
         path_prefix, field_path = ApiHelper.split_into_parts(self._input)

apimatic_core/pagination/paginated_data.py

@@ -49,7 +49,7 @@ def __next__(self):
             return item
 
         self._paged_response = self._fetch_next_page()
-        self._items = self._paginated_items_converter(self._paged_response.data)
+        self._items = self._paginated_items_converter(self._paged_response.body)
         if not self._items:
             raise StopIteration
         self._page_size, self._current_index = len(self._items), 0
@@ -66,9 +66,7 @@ def pages(self):
 
         while True:
             paginated_data._paged_response = paginated_data._fetch_next_page()
-            if not paginated_data._paged_response:
-                break
-            paginated_data._items = self._paginated_items_converter(paginated_data._paged_response)
+            paginated_data._items = self._paginated_items_converter(paginated_data._paged_response.body)
             if not paginated_data._items:
                 break
             paginated_data._page_size = len(paginated_data._items)
@@ -83,7 +81,7 @@ def _fetch_next_page(self):
                 response = self._api_call.clone(
                     global_configuration=self._global_configuration, request_builder=request_builder
                 ).execute()
-                return pagination_strategy.apply_metadata(response)
+                return pagination_strategy.apply_metadata_wrapper(response)
             except Exception as ex:
                 raise ex
         return []

apimatic_core/pagination/pagination_strategy.py

@@ -11,11 +11,11 @@ class PaginationStrategy(ABC):
     to provide specific pagination management logic for paginated API responses.
     """
 
-    def __init__(self, metadata_creator):
-        if metadata_creator is None:
-            raise ValueError("Metadata creator for offset based pagination cannot be None")
+    def __init__(self, metadata_wrapper):
+        if metadata_wrapper is None:
+            raise ValueError("Metadata wrapper for the pagination cannot be None")
 
-        self._metadata_creator = metadata_creator
+        self._metadata_wrapper = metadata_wrapper
 
     @abstractmethod
     def apply(self, paginated_data):
@@ -31,7 +31,7 @@ def apply(self, paginated_data):
         ...
 
     @abstractmethod
-    def apply_metadata(self, page):
+    def apply_metadata_wrapper(self, paged_response):
         ...
 
     @staticmethod