Merge pull request #2 from atlassian-api/master

Updating

Author: austinmh12

atlassian/VERSION

@@ -1 +1 @@
-1.12.7
+1.12.16

atlassian/__init__.py

@@ -7,5 +7,17 @@
 from .crowd import Crowd
 from .service_desk import ServiceDesk
 from .marketplace import MarketPlace
+from .jira8 import Jira8
 
-__all__ = ['Confluence', 'Jira', 'Bitbucket', 'Portfolio', 'Bamboo', 'Stash', 'Crowd', 'ServiceDesk', 'MarketPlace']
+__all__ = [
+    'Confluence',
+    'Jira',
+    'Bitbucket',
+    'Portfolio',
+    'Bamboo',
+    'Stash',
+    'Crowd',
+    'ServiceDesk',
+    'MarketPlace',
+    'Jira8'
+]

atlassian/bitbucket.py

@@ -91,6 +91,66 @@ def project_users_with_administrator_permissions(self, key):
                 project_administrators.append(user)
         return project_administrators
 
+    def project_grant_user_permissions(self, project_key, username, permission):
+        """
+        Grant the specified project permission to an specific user
+        :param project_key: project key involved
+        :param username: user name to be granted
+        :param permission: the project permissions available are 'PROJECT_ADMIN', 'PROJECT_WRITE' and 'PROJECT_READ'
+        :return: 
+        """
+        url = 'rest/api/1.0/projects/{project_key}/permissions/users?permission={permission}&name={username}'.format(
+            project_key=project_key,
+            permission=permission,
+            username=username)
+        return self.put(url)
+    
+    def project_grant_group_permissions(self, project_key, groupname, permission):
+        """
+        Grant the specified project permission to an specific group
+        :param project_key: project key involved
+        :param groupname: group to be granted
+        :param permission: the project permissions available are 'PROJECT_ADMIN', 'PROJECT_WRITE' and 'PROJECT_READ'
+        :return: 
+        """
+        url = 'rest/api/1.0/projects/{project_key}/permissions/groups?permission={permission}&name={groupname}'.format(
+            project_key=project_key,
+            permission=permission,
+            groupname=groupname)
+        return self.put(url)
+
+    def repo_grant_user_permissions(self, project_key, repo_key, username, permission):
+        """
+        Grant the specified repository permission to an specific user
+        :param project_key: project key involved
+        :param repo_key: repository key involved (slug)
+        :param username: user name to be granted
+        :param permission: the repository permissions available are 'REPO_ADMIN', 'REPO_WRITE' and 'REPO_READ'
+        :return: 
+        """
+        url = 'rest/api/1.0/projects/{project_key}/repos/{repo_key}/permissions/users?permission={permission}&name={username}'.format(
+            project_key=project_key,
+            repo_key=repo_key,
+            permission=permission,
+            username=username)
+        return self.put(url)
+
+    def repo_grant_group_permissions(self, project_key, repo_key, groupname, permission):
+        """
+        Grant the specified repository permission to an specific group
+        :param project_key: project key involved
+        :param repo_key: repository key involved (slug)
+        :param groupname: group to be granted
+        :param permission: the repository permissions available are 'REPO_ADMIN', 'REPO_WRITE' and 'REPO_READ'
+        :return: 
+        """
+        url = 'rest/api/1.0/projects/{project_key}/repos/{repo_key}/permissions/groups?permission={permission}&name={groupname}'.format(
+            project_key=project_key,
+            repo_key=repo_key,
+            permission=permission,
+            groupname=groupname)
+        return self.put(url)
+
     def project_groups(self, key, limit=99999, filter_str=None):
         """
         Get Project Groups
@@ -398,8 +458,7 @@ def get_pull_requests_changes(self, project, repository, pull_request_id):
             project=project,
             repository=repository,
             pullRequestId=pull_request_id)
-        params = {}
-        params['start'] = 0
+        params = {'start': 0}
         response = self.get(url, params=params)
         if 'values' not in response:
             return []
@@ -425,8 +484,7 @@ def get_pull_requests_commits(self, project, repository, pull_request_id):
             project=project,
             repository=repository,
             pullRequestId=pull_request_id)
-        params = {}
-        params['start'] = 0
+        params = {'start': 0}
         response = self.get(url, params=params)
         if 'values' not in response:
             return []
@@ -450,8 +508,7 @@ def add_pull_request_comment(self, project, repository, pull_request_id, text):
             project=project,
             repository=repository,
             pullRequestId=pull_request_id)
-        body = {}
-        body['text'] = text
+        body = {'text': text}
         return self.post(url, data=body)
 
     def get_pullrequest(self, project, repository, pull_request_id):
@@ -877,3 +934,42 @@ def disable_branching_model(self, project, repository):
             project=project,
             repository=repository)
         return self.delete(url)
+
+    def get_assignable_users_for_issue(self, issue_key, username=None, start=0, limit=50):
+        """
+                Provide assignable users for issue
+                :param issue_key:
+                :param username: OPTIONAL: Can be used to chaeck if user can be assigned
+                :param start: OPTIONAL: The start point of the collection to return. Default: 0.
+                :param limit: OPTIONAL: The limit of the number of users to return, this may be restricted by
+                        fixed system limits. Default by built-in method: 50
+                :return:
+        """
+        url = 'rest/api/2/user/assignable/search?issueKey={issue_key}&startAt={start}&maxResults={limit}'.format(
+            issue_key=issue_key,
+            start=start,
+            limit=limit)
+        if username:
+            url += '&username={username}'.format(username=username)
+        return self.get(url)
+
+    def get_issue_changelog(self, issue_key):
+        """
+        Get issue related change log
+        :param issue_key:
+        :return:
+        """
+        url = 'rest/api/2/issue/{}?expand=changelog'.format(issue_key)
+        return (self.get(url) or {}).get('changelog')
+
+    def assign_issue(self, issue, assignee=None):
+        """Assign an issue to a user. None will set it to unassigned. -1 will set it to Automatic.
+        :param issue: the issue ID or key to assign
+        :type issue: int or str
+        :param assignee: the user to assign the issue to
+        :type assignee: str
+        :rtype: bool
+        """
+        url = 'rest/api/2/issue/{issue}/assignee'.format(issue=issue)
+        data = {'name': assignee}
+        return self.put(url, data=data)

atlassian/confluence.py

@@ -3,6 +3,7 @@
 from requests import HTTPError
 import logging
 import os
+import time
 
 log = logging.getLogger(__name__)
 
@@ -278,25 +279,29 @@ def remove_page(self, page_id, status=None, recursive=False):
             params['status'] = status
         return self.delete(url, params=params)
 
-    def create_page(self, space, title, body, parent_id=None, type='page'):
+    def create_page(self, space, title, body, parent_id=None, type='page',
+                    representation='storage'):
         """
         Create page from scratch
         :param space:
         :param title:
         :param body:
         :param parent_id:
         :param type:
+        :param representation: OPTIONAL: either Confluence 'storage' or 'wiki' markup format
         :return:
         """
         log.info('Creating {type} "{space}" -> "{title}"'.format(space=space, title=title, type=type))
+        if representation not in ['wiki', 'storage']:
+            raise ValueError("Wrong value for representation, it should be either wiki or storage")
         url = 'rest/api/content/'
         data = {
             'type': type,
             'title': title,
             'space': {'key': space},
-            'body': {'storage': {
+            'body': {representation: {
                 'value': body,
-                'representation': 'storage'}}}
+                'representation': representation}}}
         if parent_id:
             data['ancestors'] = [{'type': type, 'id': parent_id}]
         return self.post(url, data=data)
@@ -325,8 +330,8 @@ def add_comment(self, page_id, text):
         data = {'type': 'comment',
                 'container': {'id': page_id, 'type': 'page', 'status': 'current'},
                 'body': {'storage': {'value': text, 'representation': 'storage'}}}
-        return self.post('rest/api/content/', data=data)    
-    
+        return self.post('rest/api/content/', data=data)
+
     def attach_file(self, filename, page_id=None, title=None, space=None, comment=None):
         """
         Attach (upload) a file to a page, if it exists it will update the
@@ -630,6 +635,28 @@ def get_space(self, space_key, expand='description.plain,homepage'):
                                                                   expand=expand)
         return self.get(url)
 
+    def create_space(self, space_key, space_name):
+        """
+        Create space
+        :param space_key:
+        :param space_name:
+        :return:
+        """
+        data = {
+            'key': space_key,
+            'name': space_name
+        }
+        self.post('rest/api/space', data=data)
+
+    def delete_space(self, space_key):
+        """
+        Delete space
+        :param space_key:
+        :return:
+        """
+        url = 'rest/api/space/{}'.format(space_key)
+        return self.delete(url)
+
     def get_user_details_by_username(self, username, expand=None):
         """
         Get information about a user through username
@@ -701,6 +728,9 @@ def get_page_as_pdf(self, page_id):
         """
         headers = self.form_token_headers
         url = 'spaces/flyingpdf/pdfpageexport.action?pageId={pageId}'.format(pageId=page_id)
+        if self.api_version == 'cloud':
+            url = self.get_pdf_download_url_for_confluence_cloud(url)
+
         return self.get(url, headers=headers, not_json_response=True)
 
     def export_page(self, page_id):
@@ -761,3 +791,50 @@ def health_check(self):
             response = self.get('rest/supportHealthCheck/1.0/check/')
         return response
 
+    def get_pdf_download_url_for_confluence_cloud(self, url):
+        """
+        Confluence cloud does not return the PDF document when the PDF
+        export is initiated. Instead it starts a process in the background 
+        and provides a link to download the PDF once the process completes.
+        This functions polls the long running task page and returns the
+        download url of the PDF.
+        :param url: URL to initiate PDF export
+        :return: Download url for PDF file
+        """
+        download_url = None
+        try:
+            long_running_task = True
+            headers = self.form_token_headers
+            log.info('Initiate PDF export from Confluence Cloud')
+            response = self.get(url, headers=headers, not_json_response=True)
+            response_string = response.decode(encoding='utf-8', errors='strict')
+            task_id = response_string.split('name="ajs-taskId" content="')[1].split('">')[0]
+            poll_url = 'runningtaskxml.action?taskId={0}'.format(task_id)
+            while long_running_task:
+                long_running_task_response = self.get(poll_url, headers=headers, not_json_response=True)
+                long_running_task_response_parts = long_running_task_response.decode(encoding='utf-8',
+                                                                                     errors='strict').split('\n')
+                percentage_complete = long_running_task_response_parts[6].strip()
+                is_successful = long_running_task_response_parts[7].strip()
+                is_complete = long_running_task_response_parts[8].strip()
+                log.info('Sleep for 5s.')
+                time.sleep(5)
+                log.info('Check if export task has completed.')
+                if is_complete == '<isComplete>true</isComplete>':
+                    if is_successful == '<isSuccessful>true</isSuccessful>':
+                        log.info(percentage_complete)
+                        log.info('Downloading content...')
+                        log.debug('Extract taskId and download PDF.')
+                        current_status = long_running_task_response_parts[3]
+                        download_url = current_status.split('href=&quot;/wiki/')[1].split('&quot')[0]
+                        long_running_task = False
+                    elif is_successful == '<isSuccessful>false</isSuccessful>':
+                        log.error('PDF conversion not successful.')
+                        return None
+                else:
+                    log.info(percentage_complete)
+        except IndexError as e:
+            log.error(e)
+            return None
+
+        return download_url