Merge pull request #20 from RPCMoritz/master

Add pagination via kwargs for queries which respect maximum-results

Author: m4ce

crowd_api/__init__.py

@@ -8,7 +8,6 @@
 import json
 import random
 import string
-import logging
 
 
 class CrowdAPI:
@@ -85,8 +84,8 @@ def get_user_groups(self, **kwargs):
         if "username" not in kwargs:
             raise ValueError("Must pass username")
 
-        req = self.api_get("/user/group/direct?username={}&max-results={}".format(
-            kwargs['username'], kwargs.get('max_results', 1000)))
+        req = self.api_get("/user/group/direct?username={}&max-results={}&start-index={}".format(
+            kwargs['username'], kwargs.get('max_results', 1000), kwargs.get('start_index', 0)))
         if req.status_code == 200:
             for group in req.json()['groups']:
                 groups.append(group['name'])
@@ -103,8 +102,8 @@ def get_group_users(self, **kwargs):
         if "groupname" not in kwargs:
             raise ValueError("Must pass username")
 
-        req = self.api_get("/group/user/direct?groupname={}&max-results={}".format(
-            kwargs['groupname'], kwargs.get('max_results', 1000)))
+        req = self.api_get("/group/user/direct?groupname={}&max-results={}}&start-index={}".format(
+            kwargs['groupname'], kwargs.get('max_results', 1000), kwargs.get('start_index', 0)))
         if req.status_code == 200:
             for user in req.json()['users']:
                 users.append(user['name'])
@@ -173,7 +172,8 @@ def get_all_groups(self, **kwargs):
         groups = []
 
         req = self.api_get(
-            "/search?entity-type=group&max-results={}".format(kwargs.get('max_results', 1000)))
+            "/search?entity-type=group&max-results={}&start-index={}".format(
+                kwargs.get('max_results', 1000), kwargs.get('start_index', 0)))
 
         if req.status_code == 200:
             for group in req.json()['groups']:
@@ -192,7 +192,8 @@ def search_group(self, **kwargs):
             raise ValueError("You need to define a certian restriction")
 
         req = self.api_get(
-            "/search?entity-type=group&restriction={}&max-results={}".format(kwargs['restriction'], kwargs.get('max_results', 1000)))
+            "/search?entity-type=group&restriction={}&max-results={}&start-index={}".format(
+                kwargs['restriction'], kwargs.get('max_results', 1000), kwargs.get('start_index', 0)))
 
         if req.status_code == 200:
             for group in req.json()['groups']:
@@ -208,7 +209,8 @@ def get_all_users(self, **kwargs):
         users = []
 
         req = self.api_get(
-            "/search?entity-type=user&max-results={}".format(kwargs.get('max_results', 1000)))
+            "/search?entity-type=user&max-results={}&start-index={}".format(
+                kwargs.get('max_results', 1000), kwargs.get('start_index', 0)))
         if req.status_code == 200:
             for user in req.json()['users']:
                 users.append(user['name'])
@@ -223,10 +225,11 @@ def search_user(self, **kwargs):
         users = []
 
         if 'restriction' not in kwargs:
-            raise ValueError("You need to define a certian restriction")
+            raise ValueError("You need to define a certain restriction")
 
         req = self.api_get(
-            "/search?entity-type=user&restriction={}&max-results={}".format(kwargs['restriction'], kwargs.get('max_results', 1000)))
+            "/search?entity-type=user&restriction={}&max-results={}&start-index={}".format(
+                kwargs['restriction'], kwargs.get('max_results', 1000), kwargs.get('start_index', 0)))
         if req.status_code == 200:
             for user in req.json()['users']:
                 users.append(user['name'])
@@ -237,7 +240,6 @@ def search_user(self, **kwargs):
         else:
             return {"status": False, "code": req.status_code, "reason": req.content}
 
-
     def set_user_attribute(self, **kwargs):
         if "username" not in kwargs:
             raise ValueError("Must pass username")
@@ -279,7 +281,6 @@ def set_user_activity(self, **kwargs):
         else:
             return {"status": False, "code": req.status_code, "reason": req.content}
 
-
     def create_user(self, **kwargs):
         user = {}
 

setup.py

@@ -1,17 +1,17 @@
 from distutils.core import setup
 
-version = '0.0.8'
+version = '0.0.9'
 
 setup(
-  name = 'crowd-api',
-  packages = ['crowd_api'],
-  version = version,
-  description = 'Python library for Atlassian Crowd',
-  author = 'Matteo Cerutti',
-  author_email = 'matteo.cerutti@hotmail.co.uk',
-  url = 'https://github.com/m4ce/crowd-api-python',
-  download_url = 'https://github.com/m4ce/crowd-api-python/tarball/%s' % (version,),
-  keywords = ['crowd'],
-  classifiers = [],
-  install_requires = ["requests"]
+  name='crowd-api',
+  packages=['crowd_api'],
+  version=version,
+  description='Python library for Atlassian Crowd',
+  author='Matteo Cerutti',
+  author_email='matteo.cerutti@hotmail.co.uk',
+  url='https://github.com/m4ce/crowd-api-python',
+  download_url='https://github.com/m4ce/crowd-api-python/tarball/%s' % (version,),
+  keywords=['crowd'],
+  classifiers=[],
+  install_requires=["requests"]
 )