Add more Crowd functions (#1277)

* Update crowd.py

- Add a new function `user_groups` used to get specify user's all group info
- Introduce new dependencies `jmespath` which is used for search string in json, for more info, read: [JMESPath Tutorial — JMESPath](https://jmespath.org/tutorial.html)

* Add more Crowd functions

- Using universal request to get user's group, controled by `kind` param
- Using universal request to get group's member, controled by `kind` param
- Add a new function to determine whether the user is a member of a group

* Update crowd.py

- Add a parameter `max_results` has prevented insufficient results from being returned, the server default is `1000`

* Update requirements.txt

- Sync latest requirements

* Update .readthedocs.yml

- Add a config parameter: `build.os` try to fix RTD docs build error

* Update .readthedocs.yml

- Add build config to fix RTD doc build error

* Update requirements-dev.txt

- Add `jmespath` into it.

* Update crowd.rst

- Add new functions' doc

* Update setup.py

- Introduce a new dependency package: `jmespath`

* Update crowd.py

- Using black to format code, replace pylint.

---------

Co-authored-by: zhouruixi <[email protected]>

Author: ChowRex

.readthedocs.yml

@@ -8,3 +8,11 @@ version: 2
 # Build documentation in the docs/ directory with Sphinx
 sphinx:
   configuration: docs/conf.py
+
+# Add this to solve RTD build error.
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html#build-os
+build:
+  os: ubuntu-22.04
+  # See https://docs.readthedocs.io/en/stable/config-file/v2.html#build-tools
+  tools:
+    python: "3"

atlassian/crowd.py

@@ -1,6 +1,8 @@
 # coding=utf-8
 import logging
 
+from jmespath import search
+
 from .rest_client import AtlassianRestAPI
 
 log = logging.getLogger(__name__)
@@ -129,6 +131,43 @@ def user_delete(self, username):
 
         return self.delete(self._crowd_api_url("usermanagement", "user"), params=params)
 
+    def user_groups(self, username, kind="direct"):
+        """
+        Get user's all group info
+        :param username: str - username
+        :param kind: str - group type
+        :return: The specify user's group info
+        """
+        path = self._crowd_api_url("usermanagement", "user/group/{kind}".format(kind=kind))
+        response = self.get(path, params={"username": username})
+        return search("groups[*].name", response)
+
+    def group_members(self, group, kind="direct", max_results=99999):
+        """
+        Get group's all direct members
+        :param group: str - group name
+        :param kind: str - group type
+        :param max_results: int - maximum number of results
+        :return: The specify group's direct members info
+        """
+        path = self._crowd_api_url("usermanagement", "group/user/{kind}".format(kind=kind))
+        params = {"groupname": group, "max-results": max_results}
+        response = self.get(path, params=params)
+        return search("users[*].name", response)
+
+    def is_user_in_group(self, username, group, kind="direct"):
+        """
+        Check if the user is a member of the group
+        :param username: str - username
+        :param group: str - group name
+        :param kind: str - group type
+        :return: bool - Return `True` or `False`
+        """
+        path = self._crowd_api_url("usermanagement", "group/user/{kind}".format(kind=kind))
+        params = {"username": username, "groupname": group}
+        response = self.get(path, params=params, advanced_mode=True)
+        return response.status_code == 200
+
     def group_add_user(self, username, groupname):
         """
         Add user to group
@@ -145,15 +184,6 @@ def group_add_user(self, username, groupname):
             json=data,
         )
 
-    def group_nested_members(self, group):
-        """
-        Get nested members of group
-        :param group:
-        :return:
-        """
-        params = {"groupname": group}
-        return self.get(self._crowd_api_url("group", "nested"), params=params)
-
     def health_check(self):
         """
         Get health status

docs/crowd.rst

@@ -21,6 +21,12 @@ Manage users
     # Get user
     crowd.user(username)
 
+    # Get user's all group info
+    crowd.user_groups(username, kind='direct')
+
+    # Check whether the user is a member of the group
+    crowd.is_user_in_group(username, group, kind='direct')
+
 Manage groups
 -------------
 
@@ -29,3 +35,6 @@ Manage groups
     # Add user to group
     crowd.group_add_user(username, groupname)
 
+    # Get group's members
+    crowd.group_members(group, kind='direct', max_results=99999)
+

requirements-dev.txt

@@ -14,4 +14,5 @@ python-magic
 # On October 4, 2022 importlib-metadata released importlib-metadata 5.0.0 and in version 5.0.0
 # They have Deprecated EntryPoints and that's why you are facing this error.
 importlib-metadata<=4.13.0
-
+# Add this package to search string in json
+jmespath

requirements.txt

@@ -4,5 +4,6 @@ six
 oauthlib
 requests_oauthlib
 requests-kerberos==0.14.0
+jmespath
 bs4
-lxml
+lxml

setup.py

@@ -25,7 +25,7 @@
     package_dir={"atlassian": "atlassian"},
     include_package_data=True,
     zip_safe=False,
-    install_requires=["deprecated", "requests", "six", "oauthlib", "requests_oauthlib"],
+    install_requires=["deprecated", "requests", "six", "oauthlib", "requests_oauthlib", "jmespath"],
     extras_require={"kerberos": ["requests-kerberos"]},
     platforms="Platform Independent",
     classifiers=[