increase pagination to 50 per request for some endpoints - Fixes #95

Author: bensteUEM

churchtools_api/events.py

@@ -42,7 +42,7 @@ def get_events(self, **kwargs) -> list[dict]:
         headers = {
             'accept': 'application/json'
         }
-        params = {}
+        params = {"limit":50} #increases default pagination size
 
         if 'eventId' in kwargs.keys():
             url += '/{}'.format(kwargs['eventId'])
@@ -75,12 +75,12 @@ def get_events(self, **kwargs) -> list[dict]:
             if 'include' in kwargs.keys():
                 params['include'] = kwargs['include']
 
-        response = self.session.get(url=url, params=params, headers=headers)
+        response = self.session.get(url=url, headers=headers, params=params)
 
         if response.status_code == 200:
             response_content = json.loads(response.content)
             response_data = self.combine_paginated_response_data(
-                response_content, url=url, headers=headers
+                response_content, url=url, headers=headers, params=params
             )
             return [response_data] if isinstance(response_data, dict) else response_data
         else:

churchtools_api/persons.py

@@ -24,14 +24,14 @@ def get_persons(self, **kwargs):
         :rtype: list[dict]
         """
         url = self.domain + '/api/persons'
-        params = {}
+        params = {"limit":50} #increases default pagination size
         if 'ids' in kwargs.keys():
             params['ids[]'] = kwargs['ids']
 
         headers = {
             'accept': 'application/json'
         }
-        response = self.session.get(url=url, params=params, headers=headers)
+        response = self.session.get(url=url, headers=headers, params=params)
 
         if response.status_code == 200:
             response_content = json.loads(response.content)
@@ -45,7 +45,7 @@ def get_persons(self, **kwargs):
                                 'make sure the user has correct permissions'.format(params))
 
             response_data = self.combine_paginated_response_data(
-                response_content, url=url, headers=headers
+                response_content, url=url, headers=headers, params=params
             )
             response_data = [response_data] if isinstance(response_data, dict) else response_data
 

churchtools_api/resources.py

@@ -62,7 +62,7 @@ def get_bookings(self, **kwargs) -> list[dict]:
         """
         url = self.domain + "/api/bookings"
         headers = {"accept": "application/json"}
-        params = {}
+        params = {"limit":50} #increases default pagination size
 
         # at least one of the following arguments is required
         required_kwargs = ["booking_id", "resource_ids"]
@@ -103,7 +103,7 @@ def get_bookings(self, **kwargs) -> list[dict]:
             response_content = json.loads(response.content)
 
             response_data = self.combine_paginated_response_data(
-                response_content, url=url, headers=headers
+                response_content, url=url, headers=headers, params=params
             )
             result_list = (
                 [response_data] if isinstance(response_data, dict) else response_data

churchtools_api/songs.py

@@ -28,12 +28,13 @@ def get_songs(self, **kwargs) -> list[dict]:
         if "song_id" in kwargs.keys():
             url = url + "/{}".format(kwargs["song_id"])
         headers = {"accept": "application/json"}
-        response = self.session.get(url=url, headers=headers)
+        params = {"limit":50} #increases default pagination size
+        response = self.session.get(url=url, headers=headers, params=params)
 
         if response.status_code == 200:
             response_content = json.loads(response.content)
             response_data = self.combine_paginated_response_data(
-                response_content, url=url, headers=headers
+                response_content, url=url, headers=headers, params=params
             )
             return [response_data] if isinstance(response_data, dict) else response_data
 

tests/test_churchtools_api.py

@@ -100,15 +100,15 @@ def test_get_persons(self):
         """
         Tries to get all and a single person from the server
         Be aware that only ct_users that are visible to the user associated with the login token can be viewed!
-        On any elkw.KRZ.TOOLS personId 1 'firstName' starts with 'Ben' and more than 10 ct_users exist(13. Jan 2023)
+        On any elkw.KRZ.TOOLS personId 1 'firstName' starts with 'Ben' and more than 50 ct_users exist(13. Jan 2023)
         :return:
         """
 
         personId = 1
         result1 = self.api.get_persons()
         self.assertIsInstance(result1, list)
         self.assertIsInstance(result1[0], dict)
-        self.assertGreater(len(result1), 10)
+        self.assertGreater(len(result1), 50)
 
         result2 = self.api.get_persons(ids=[personId])
         self.assertIsInstance(result2, list)
@@ -132,7 +132,7 @@ def test_get_songs(self) -> None:
         test_song_id = 2034
 
         songs = self.api.get_songs()
-        self.assertGreater(len(songs), 10)
+        self.assertGreater(len(songs), 50)
 
         song = self.api.get_songs(song_id=test_song_id)[0]
         self.assertEqual(song["id"], 2034)