changes the metadata logic as now the meta data fields are brought 1 level up in the SDK

Author: sufyankhanrao

apimatic_core/api_call.py

@@ -23,10 +23,6 @@ def response_handler(self):
     def get_pagination_stategies(self):
         return self._pagination_stategies
 
-    @property
-    def get_paginated_item_converter(self):
-        return self._paginated_item_converter
-
     @property
     def global_configuration(self):
         return self._global_configuration
@@ -42,7 +38,6 @@ def __init__(
         self._api_logger = LoggerFactory.get_api_logger(self._global_configuration.get_http_client_configuration()
                                                         .logging_configuration)
         self._pagination_strategy = None
-        self._paginated_item_converter = None
 
     def request(self, request_builder):
         self._request_builder = request_builder
@@ -56,10 +51,6 @@ def pagination_stategies(self, *pagination_stategies):
         self._pagination_stategies = pagination_stategies
         return self
 
-    def paginated_item_converter(self, paginated_item_converter):
-        self._paginated_item_converter = paginated_item_converter
-        return self
-
     def endpoint_configuration(self, endpoint_configuration):
         self._endpoint_configuration = endpoint_configuration
         return self
@@ -95,8 +86,8 @@ def execute(self):
         return self._response_handler.handle(_http_response, self._global_configuration.get_global_errors())
 
 
-    def paginate(self, page_iterable_creator, page_creator):
-        return page_iterable_creator(PaginatedData(self, page_creator))
+    def paginate(self, page_iterable_creator, page_creator, paginated_items_converter):
+        return page_iterable_creator(PaginatedData(self, page_creator, paginated_items_converter))
 
     def clone(self, global_configuration=None, request_builder=None, response_handler=None,
               endpoint_configuration=None, pagination_stategies=None, paginated_item_converter=None):
@@ -106,7 +97,6 @@ def clone(self, global_configuration=None, request_builder=None, response_handle
         new_instance._response_handler = response_handler or self._response_handler
         new_instance._endpoint_configuration = endpoint_configuration or self._endpoint_configuration
         new_instance._pagination_stategies = pagination_stategies or self._pagination_stategies
-        new_instance._paginated_item_converter = paginated_item_converter or self._paginated_item_converter
         return new_instance
 
     def __deepcopy__(self, memodict={}):

apimatic_core/pagination/configuration/cursor_pagination.py

@@ -4,10 +4,6 @@
 
 class CursorPagination(PaginationStrategy):
 
-    @property
-    def metadata(self):
-        return self._metadata_creator(self._cursor_value)
-
     def __init__(self, output, input_, metadata_creator):
         super().__init__(metadata_creator)
 
@@ -39,6 +35,9 @@ 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)
+
     @staticmethod
     def _get_initial_cursor_value(request_builder, input_pointer):
         path_prefix, field_path = ApiHelper.split_into_parts(input_pointer)

apimatic_core/pagination/configuration/link_pagination.py

@@ -6,10 +6,6 @@
 class LinkPagination(PaginationStrategy):
     """Pagination manager implementation for link-based pagination."""
 
-    @property
-    def metadata(self):
-        return self._metadata_creator(self._next_link)
-
     def __init__(self, next_link_pointer, metadata_creator):
         super().__init__(metadata_creator)
 
@@ -42,3 +38,6 @@ def apply(self, paginated_data):
         return request_builder.clone_with(
             query_params=updated_query_params
         )
+
+    def apply_metadata(self, page):
+        return self._metadata_creator(self._next_link, page)

apimatic_core/pagination/configuration/offset_pagination.py

@@ -6,10 +6,6 @@
 class OffsetPagination(PaginationStrategy):
     """Pagination manager implementation for offset-based pagination."""
 
-    @property
-    def metadata(self):
-        return self._metadata_creator(self._offset)
-
     def __init__(self, input_, metadata_creator):
         """
         Initializes a new instance of the OffsetPagination class.
@@ -38,6 +34,9 @@ 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 _get_initial_offset(self, request_builder):
         path_prefix, field_path = ApiHelper.split_into_parts(self._input)
 

apimatic_core/pagination/configuration/page_pagination.py

@@ -3,10 +3,6 @@
 
 class PagePagination(PaginationStrategy):
 
-    @property
-    def metadata(self):
-        return self._metadata_creator(self._page_number)
-
     def __init__(self, input_, metadata_creator):
         super().__init__(metadata_creator)
 
@@ -28,6 +24,9 @@ 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 _get_initial_page_offset(self, request_builder):
         path_prefix, field_path = ApiHelper.split_into_parts(self._input)
 
@@ -38,6 +37,6 @@ def _get_initial_page_offset(self, request_builder):
                 return int(ApiHelper.get_value_by_json_pointer(request_builder.query_params, field_path))
             elif path_prefix == "$request.headers":
                 return int(ApiHelper.get_value_by_json_pointer(request_builder.header_params, field_path))
-        except Exception:
+        except ValueError:
             pass
         return 1

apimatic_core/pagination/paginated_data.py

@@ -19,9 +19,17 @@ def request_builder(self):
     def page_size(self):
         return self._page_size
 
-    def __init__(self, api_call, page_creator):
+    def __init__(self, api_call, page_creator, paginated_items_converter):
+
+        if page_creator is None:
+            raise ValueError('page_creator cannot be None')
+
+        if paginated_items_converter is None:
+            raise ValueError('paginated_items_converter cannot be None')
+
         self._api_call = copy.deepcopy(api_call)
         self._page_creator = page_creator
+        self._paginated_items_converter = paginated_items_converter
         self._initial_request_builder = api_call.request_builder
         self._pagination_strategies = self._api_call.get_pagination_stategies
         self._http_call_context =\
@@ -45,8 +53,7 @@ def __next__(self):
             return item
 
         _, self._page = self._fetch_next_page()
-        self._items = self._api_call.get_paginated_item_converter(
-            self._page) if self._api_call.get_paginated_item_converter is not None else None
+        self._items = self._paginated_items_converter(self._page)
         if not self._items:
             raise StopIteration
         self._page_size, self._current_index = len(self._items), 0
@@ -65,7 +72,7 @@ def pages(self):
             metadata, paginated_data._page = paginated_data._fetch_next_page()
             if not paginated_data._page or not metadata:
                 break
-            paginated_data._items = self._api_call.get_paginated_item_converter(paginated_data._page)
+            paginated_data._items = self._paginated_items_converter(paginated_data._page)
             if not paginated_data._items:
                 break
             paginated_data._page_size = len(paginated_data._items)
@@ -80,10 +87,13 @@ def _fetch_next_page(self):
                 response = self._api_call.clone(
                     global_configuration=self._global_configuration, request_builder=request_builder
                 ).execute()
-                return pagination_strategy.metadata, response
+                return pagination_strategy.apply_metadata(response), response
             except Exception as ex:
                 raise ex
         return []
 
     def _get_new_self_instance(self):
-        return PaginatedData(self._api_call.clone(request_builder=self._initial_request_builder), self._page_creator)
+        return PaginatedData(
+            self._api_call.clone(request_builder=self._initial_request_builder), self._page_creator,
+            self._paginated_items_converter
+        )

apimatic_core/pagination/pagination_strategy.py

@@ -30,9 +30,8 @@ def apply(self, paginated_data):
         """
         ...
 
-    @property
     @abstractmethod
-    def metadata(self):
+    def apply_metadata(self, page):
         ...
 
     @staticmethod