Support bulk get endpoints (#142)

* support for new bulk endpoints
* Need to update mock tests but merging due to breaking API changes.

Author: travispavek

.travis.yml

@@ -4,9 +4,10 @@ os:
   - linux
 python:
   - '2.7'
-  - '3.4'
-  - '3.5'
   - '3.6'
+  - '3.7'
+  - '3.8'
+  - '3.9'
 install:
   - pip install -U pip
   - pip install -U tox-travis

setup.py

@@ -15,12 +15,12 @@
 setup(
     name='testrail',
     packages=['testrail'],
-    version='0.3.13',
+    version='0.3.14',
     description='Python library for interacting with TestRail via REST APIs.',
     author='Travis Pavek',
     author_email='[email protected]',
     url='https://github.com/travispavek/testrail-python',
-    download_url='https://github.com/travispavek/testrail-python/tarball/0.3.13',
+    download_url='https://github.com/travispavek/testrail-python/tarball/0.3.14',
     keywords=['testrail', 'api', 'client', 'library', 'rest'],
     install_requires=install_requires,
     classifiers=[
@@ -37,8 +37,9 @@
         'Programming Language :: Python :: 2',
         'Programming Language :: Python :: 2.7',
         'Programming Language :: Python :: 3',
-        'Programming Language :: Python :: 3.4',
-        'Programming Language :: Python :: 3.5',
         'Programming Language :: Python :: 3.6',
+        'Programming Language :: Python :: 3.7',
+        'Programming Language :: Python :: 3.8',
+        'Programming Language :: Python :: 3.9',
     ],
 )

testrail/api.py

@@ -164,6 +164,17 @@ def _conf(self):
 
         return {'email': _email, 'key': _key, 'url': _url, 'verify_ssl': verify_ssl}
 
+    def _paginate_request(self, end_point, params, field):
+        params["offset"] = 0
+        params["limit"] = 250
+        values = []
+        while True:
+            items = self._get(end_point, params=params)
+            if items["size"] == 0:
+                return values
+            values.extend(items[field])
+            params["offset"] += params["limit"]
+
     @staticmethod
     def _raise_on_429_or_503_status(resp):
         """ 429 is TestRail's status for too many API requests
@@ -234,7 +245,7 @@ def user_with_email(self, user_email):
     def projects(self):
         if self._refresh(self._projects['ts']):
             # get new value, if request is good update value with new ts.
-            self._projects['value'] = self._get('get_projects')
+            self._projects['value'] = self._paginate_request("get_projects", {}, "projects")
             self._projects['ts'] = datetime.now()
         return self._projects['value']
 
@@ -270,13 +281,13 @@ def add_suite(self, suite):
         return self._post('add_suite/%s' % project_id, payload)
 
     # Case Requests
-    def cases(self, project_id=None, suite_id=10):
+    def cases(self, project_id=None, suite_id=-1):
         project_id = project_id or self._project_id
         if self._refresh(self._cases[project_id][suite_id]['ts']):
             # get new value, if request is good update value with new ts.
-            params = {'suite_id': suite_id} if suite_id != -1 else None
-            _cases = self._get('get_cases/%s' % project_id, params=params)
-            self._cases[project_id][suite_id]['value'] = _cases
+            endpoint = 'get_cases/%s' % project_id
+            params = {'suite_id': suite_id} if suite_id != -1 else {}
+            self._cases[project_id][suite_id]["value"] = self._paginate_request(endpoint, params, "cases")
             self._cases[project_id][suite_id]['ts'] = datetime.now()
         return self._cases[project_id][suite_id]['value']
 
@@ -326,8 +337,8 @@ def case_type_with_id(self, case_type_id):
     def milestones(self, project_id):
         if self._refresh(self._milestones[project_id]['ts']):
             # get new value, if request is good update value with new ts.
-            _milestones = self._get('get_milestones/%s' % project_id)
-            self._milestones[project_id]['value'] = _milestones
+            endpoint = 'get_milestones/%s' % project_id
+            self._milestones[project_id]['value'] = self._paginate_request(endpoint, {}, "milestones")
             self._milestones[project_id]['ts'] = datetime.now()
         return self._milestones[project_id]['value']
 
@@ -384,9 +395,8 @@ def sections(self, project_id=None, suite_id=-1):
         project_id = project_id or self._project_id
         if self._refresh(self._sections[project_id][suite_id]['ts']):
             params = {'suite_id': suite_id} if suite_id != -1 else None
-            _sections = self._get(
-                'get_sections/%s' % project_id, params=params)
-            self._sections[project_id][suite_id]['value'] = _sections
+            endpoint = 'get_sections/%s' % project_id
+            self._sections[project_id][suite_id]['value'] = self._paginate_request(endpoint, params, "sections")
             self._sections[project_id][suite_id]['ts'] = datetime.now()
         return self._sections[project_id][suite_id]['value']
 
@@ -414,8 +424,8 @@ def plans(self, project_id=None):
         project_id = project_id or self._project_id
         if self._refresh(self._plans[project_id]['ts']):
             # get new value, if request is good update value with new ts.
-            _plans = self._get('get_plans/%s' % project_id)
-            self._plans[project_id]['value'] = _plans
+            endpoint = 'get_plans/%s' % project_id
+            self._plans[project_id]['value'] = self._paginate_request(endpoint, {}, "plans")
             self._plans[project_id]['ts'] = datetime.now()
         return self._plans[project_id]['value']
 
@@ -452,11 +462,10 @@ def runs(self, project_id=None, completed=None):
         project_id = project_id or self._project_id
         if self._refresh(self._runs[project_id]['ts']):
             # get new value, if request is good update value with new ts.
-            end_point = 'get_runs/%s' % project_id
+            endpoint = 'get_runs/%s' % project_id
             if completed is not None:
-                end_point += '&is_completed=%s' % str(int(completed))
-            _runs = self._get(end_point)
-            self._runs[project_id]['value'] = _runs
+                endpoint += '&is_completed=%s' % str(int(completed))
+            self._runs[project_id]['value'] = self._paginate_request(endpoint, {}, "runs")
             self._runs[project_id]['ts'] = datetime.now()
         return self._runs[project_id]['value']
 
@@ -521,8 +530,8 @@ def delete_plan(self, plan_id):
     # Test Requests
     def tests(self, run_id):
         if self._refresh(self._tests[run_id]['ts']):
-            _tests = self._get('get_tests/%s' % run_id)
-            self._tests[run_id]['value'] = _tests
+            endpoint = 'get_tests/%s' % run_id
+            self._tests[run_id]['value'] = self._paginate_request(endpoint, {}, "tests")
             self._tests[run_id]['ts'] = datetime.now()
         return self._tests[run_id]['value']
 
@@ -541,15 +550,15 @@ def test_with_id(self, test_id, run_id=None):
     # Result Requests
     def results_by_run(self, run_id):
         if self._refresh(self._results[run_id]['ts']):
-            _results = self._get('get_results_for_run/%s' % run_id)
-            self._results[run_id]['value'] = _results
+            endpoint = 'get_results_for_run/%s' % run_id
+            self._results[run_id]['value'] = self._paginate_request(endpoint, {}, "results")
             self._results[run_id]['ts'] = datetime.now()
         return self._results[run_id]['value']
 
     def results_by_test(self, test_id):
         if self._refresh(self._results[test_id]['ts']):
-            _results = self._get('get_results/%s' % test_id)
-            self._results[test_id]['value'] = _results
+            endpoint = 'get_results/%s' % test_id
+            self._results[test_id]['value'] = self._paginate_request(endpoint, {}, "results")
             self._results[test_id]['ts'] = datetime.now()
         return self._results[test_id]['value']