Add get_endpoints_iterator and paginate get_endpoints (duosecurity#76)

Author: ccassell

duo_client/admin.py

@@ -943,14 +943,30 @@ def delete_user_group(self, user_id, group_id):
         params = {}
         return self.json_api_call('DELETE', path, params)
 
-    def get_endpoints(self):
+    def get_endpoints_iterator(self):
         """
-        Returns list of endpoints.
+        Returns iterator of endpoints objects.
 
         Raises RuntimeError on error.
         """
-        response = self.json_api_call('GET', '/admin/v1/endpoints', {})
-        return response
+        return self.json_paging_api_call('GET', '/admin/v1/endpoints', {})
+
+    def get_endpoints(self, limit=None, offset=0):
+        """
+        Returns a list of endpoints.
+
+        Params:
+            limit - The maximum number of records to return. (Optional)
+            offset - The offset of the first record to return. (Optional)
+
+        Raises RuntimeError on error.
+        """
+        (limit, offset) = self.normalize_paging_args(limit, offset)
+        if limit:
+            return self.json_api_call('GET', '/admin/v1/endpoints',
+                                      {'limit': limit, 'offset': offset})
+
+        return list(self.get_endpoints_iterator())
 
     def get_phones_generator(self):
         """

tests/admin/test_endpoints.py

@@ -4,11 +4,82 @@
 
 
 class TestEndpoints(TestAdmin):
+    def test_get_endpoints_iterator(self):
+        """ Test to get endpoints iterator
+        """
+        iterator = self.client_list.get_endpoints_iterator()
+        response = next(iterator)
+        self.assertEqual(response['method'], 'GET')
+        (uri, args) = response['uri'].split('?')
+        self.assertEqual(uri, '/admin/v1/endpoints')
+        self.assertEqual(
+            util.params_to_dict(args),
+            {
+                'account_id': [self.client.account_id],
+                'limit': ['100'],
+                'offset': ['0'],
+            })
+
     def test_get_endpoints(self):
-        response = self.client.get_endpoints()
+        """ Test to get endpoints.
+        """
+        response = self.client_list.get_endpoints()[0]
+        self.assertEqual(response['method'], 'GET')
+        (uri, args) = response['uri'].split('?')
+        self.assertEqual(uri, '/admin/v1/endpoints')
+        self.assertEqual(
+            util.params_to_dict(args),
+            {
+                'account_id': [self.client.account_id],
+                'limit': ['100'],
+                'offset': ['0'],
+            })
+
+    def test_get_endpoints_offset(self):
+        """ Test to get endpoints with pagination params.
+        """
+        response = self.client_list.get_endpoints(offset=20)[0]
+        self.assertEqual(response['method'], 'GET')
+        (uri, args) = response['uri'].split('?')
+        self.assertEqual(uri, '/admin/v1/endpoints')
+        self.assertEqual(
+            util.params_to_dict(args),
+            {
+                'account_id': [self.client.account_id],
+                'limit': ['100'],
+                'offset': ['0'],
+            })
+
+    def test_get_endpoints_limit(self):
+        """ Test to get endpoints with pagination params.
+        """
+        response = self.client_list.get_endpoints(limit=20)[0]
         self.assertEqual(response['method'], 'GET')
         (uri, args) = response['uri'].split('?')
         self.assertEqual(uri, '/admin/v1/endpoints')
         self.assertEqual(
             util.params_to_dict(args),
-            {'account_id': [self.client.account_id]})
+            {
+                'account_id': [self.client.account_id],
+                'limit': ['20'],
+                'offset': ['0'],
+            })
+
+    def test_get_endpoints_limit_and_offset(self):
+        """ Test to get endpoints with pagination params.
+        """
+        response = self.client_list.get_endpoints(limit=35, offset=20)[0]
+        self.assertEqual(response['method'], 'GET')
+        (uri, args) = response['uri'].split('?')
+        self.assertEqual(uri, '/admin/v1/endpoints')
+        self.assertEqual(
+            util.params_to_dict(args),
+            {
+                'account_id': [self.client.account_id],
+                'limit': ['35'],
+                'offset': ['20'],
+            })
+
+
+if __name__ == '__main__':
+    unittest.main()