Crowd: add additional functions (#865)

Crowd - add additional functions:
  * add user
  * delete user
  * activate user
  * deactivate user
  * add user to group

Author: kevingunn-wk

CONTRIBUTING.rst

@@ -105,6 +105,8 @@ All methods based on docs from: https://developer.atlassian.com/docs/
 * Confluence
     - `Confluence Server`_
     - `Confluence Cloud`_
+* Crowd
+    - `Crowd Server`_
 * Advanced Roadmaps (formerly Portfolio for Jira)
     - `Portfolio for Jira`_
     - `Portfolio for Jira Teams`_
@@ -133,6 +135,7 @@ All methods based on docs from: https://developer.atlassian.com/docs/
 .. _`Jira Cloud`: https://developer.atlassian.com/cloud/jira/platform/rest/v3/
 .. _`Confluence Server`: https://developer.atlassian.com/server/confluence/confluence-server-rest-api/
 .. _`Confluence Cloud`: https://developer.atlassian.com/cloud/confluence/rest/
+.. _`Crowd Server`: https://developer.atlassian.com/server/crowd/crowd-rest-apis/
 .. _`Jira Service Desk Cloud`: https://developer.atlassian.com/cloud/jira/service-desk/rest/
 .. _`Jira Service Desk Server`: https://docs.atlassian.com/jira-servicedesk/REST/server
 .. _`Portfolio for Jira Teams`: https://docs.atlassian.com/portfolio-for-jira-server/REST/2.13.0/teams/

atlassian/crowd.py

@@ -1,5 +1,7 @@
 # coding=utf-8
 import logging
+import string
+import secrets
 
 from .rest_client import AtlassianRestAPI
 
@@ -15,18 +17,112 @@ def __init__(self, url, username, password, timeout=60, api_root="rest", api_ver
         super(Crowd, self).__init__(url, username, password, timeout, api_root, api_version)
 
     def _crowd_api_url(self, api, resource):
-        return "{server}/{api_root}/{api}/{version}/{resource}".format(
-            server=self.url,
+        return "/{api_root}/{api}/{version}/{resource}".format(
             api_root=self.api_root,
             api=api,
             version=self.api_version,
             resource=resource,
         )
 
+    def _user_change_status(self, username, active):
+        """
+        Change user status
+
+        :params active bool
+
+        :return:
+        """
+
+        user = self.user(username)
+
+        user_object = {
+            "name": username,
+            "active": active,
+            "display-name": user.get("display-name"),
+            "first-name": user.get("first-name"),
+            "last-name": user.get("last-name"),
+            "email": user.get("email"),
+        }
+
+        params = {"username": username}
+
+        return self.put(self._crowd_api_url("usermanagement", "user"), params=params, data=user_object)
+
     def user(self, username):
         params = {"username": username}
         return self.get(self._crowd_api_url("usermanagement", "user"), params=params)
 
+    def user_activate(self, username):
+        """
+        Activate user
+        """
+
+        return self._user_change_status(username, True)
+
+    def user_create(self, username, active, first_name, last_name, display_name, email, password=None):
+        """
+        Create new user
+
+        :param active: bool, OPTIONAL: password can be auto-generated if not included
+            username (string)
+            active (bool)
+            first-name (string)
+            last-name (string)
+            display-name (string)
+            email (string)
+            password (string, optional)
+
+        :return:
+        """
+
+        if not password:
+            characters = string.ascii_letters + string.punctuation + string.digits
+            password = "".join(secrets.choice(characters) for x in range(30))
+
+        user_object = {
+            "name": username,
+            "password": {"value": password},
+            "active": active,
+            "first-name": first_name,
+            "last-name": last_name,
+            "display-name": display_name,
+            "email": email,
+        }
+
+        return self.post(self._crowd_api_url("usermanagement", "user"), data=user_object)
+
+    def user_deactivate(self, username):
+        """
+        Deactivate user
+
+        :return:
+        """
+
+        return self._user_change_status(username, False)
+
+    def user_delete(self, username):
+        """
+        Delete user
+
+        :return:
+        """
+
+        params = {"username": username}
+
+        return self.delete(self._crowd_api_url("usermanagement", "user"), params=params)
+
+    def group_add_user(self, username, groupname):
+        """
+        Add user to group
+        :return:
+        """
+
+        data = {"name": groupname}
+
+        params = {"username": username}
+
+        return self.post(self._crowd_api_url("usermanagement", "user/group/direct"), params=params, json=data)
+
     def group_nested_members(self, group):
         params = {"groupname": group}
         return self.get(self._crowd_api_url("group", "nested"), params=params)

docs/crowd.rst

@@ -0,0 +1,34 @@
+Crowd module
+============
+
+Manage users
+------------
+
+.. code-block:: python
+
+    # Activate user
+    crowd.user_activate(username)
+
+    # Add user
+    crowd.user_create(username, active, first_name, last_name, display_name, email, password)
+
+    # Add user with auto-generated password
+    crowd.user_create(username, active, first_name, last_name, display_name, email)
+
+    # Deactive user
+    crowd.user_deactivate(username)
+
+    # Delete user
+    crowd.user_delete(username)
+
+    # Get user
+    crowd.user(username)
+
+Manage groups
+-------------
+
+.. code-block:: python
+
+    # Add user to group
+    crowd.group_add_user(username, groupname)
+

docs/index.rst

@@ -20,6 +20,7 @@ Add a connection:
 
     from atlassian import Jira
     from atlassian import Confluence
+    from atlassian import Crowd
     from atlassian import Bitbucket
     from atlassian import ServiceDesk
     from atlassian import Xray
@@ -34,6 +35,12 @@ Add a connection:
         username='admin',
         password='admin')
 
+    crowd = Crowd(
+        url='http://localhost:4990',
+        username='app-name',
+        password='app-password'
+    )
+
     bitbucket = Bitbucket(
         url='http://localhost:7990',
         username='admin',
@@ -217,6 +224,7 @@ And to Bitbucket Cloud:
 
    jira
    confluence
+   crowd
    bitbucket
    bamboo
    service_desk