Merge branch 'master' into repo

Author: pablotoledo

atlassian/VERSION

@@ -1 +1 @@
-1.12.13
+1.12.15

atlassian/confluence.py

@@ -279,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)
@@ -326,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
@@ -631,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
@@ -706,7 +732,7 @@ def get_page_as_pdf(self, page_id):
             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):
         """
         Alias method for export page as pdf
@@ -775,6 +801,7 @@ def get_pdf_download_url_for_confluence_cloud(self, url):
         :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
@@ -784,28 +811,30 @@ def get_pdf_download_url_for_confluence_cloud(self, url):
             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:
-                longrunning_task_response = self.get(poll_url, headers=headers, not_json_response=True)
-                longrunning_task_response_parts = longrunning_task_response.decode(encoding='utf-8', errors='strict').split('\n')
-                percentage_complete = longrunning_task_response_parts[6].strip()
-                is_successful = longrunning_task_response_parts[7].strip()
-                is_complete = longrunning_task_response_parts[8].strip()
+                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_successful == '<isSuccessful>true</isSuccessful>' and is_complete == '<isComplete>true</isComplete>':
-                    log.info(percentage_complete)
-                    log.info('Downloading content...')
-                    log.debug('Extract taskId and download PDF.')
-                    current_status = longrunning_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>' and is_complete == '<isComplete>true</isComplete>':
-                    log.error('PDF conversion not successful.')
-                    return None
+                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

atlassian/jira.py

@@ -384,15 +384,49 @@ def get_custom_fields(self, search=None, start=1, limit=50):
             params['maxResults'] = limit
         return self.get(url, params=params)
 
-    def get_all_screen_fields(self, screen_id):
+    def get_all_available_screen_fields(self, screen_id):
         """
-        Screen id
+        Get all available fields by screen id
         :param screen_id:
         :return:
         """
         url = 'rest/api/2/screens/{}/availableFields'.format(screen_id)
         return self.get(url)
 
+    def get_screen_tabs(self, screen_id):
+        """
+        Get tabs for the screen id
+        :param screen_id:
+        :return:
+        """
+        url = 'rest/api/2/screens/{}/tabs'.format(screen_id)
+        return self.get(url)
+
+    def get_screen_tab_fields(self, screen_id, tab_id):
+        """
+        Get fields by the tab id and the screen id
+        :param tab_id:
+        :param screen_id:
+        :return:
+        """
+        url = 'rest/api/2/screens/{}/tabs/{}/fields'.format(screen_id, tab_id)
+        return self.get(url)
+
+    def get_all_screen_fields(self, screen_id):
+        """
+        Get all fields by screen id
+        :param screen_id:
+        :return:
+        """
+        screen_tabs = self.get_screen_tabs(screen_id)
+        fields = []
+        for screen_tab in screen_tabs:
+            tab_id = screen_tab['id']
+            if tab_id:
+                tab_fields = self.get_screen_tab_fields(screen_id=screen_id, tab_id=tab_id)
+                fields = fields + tab_fields
+        return fields
+
     def get_issue_labels(self, issue_key):
         """
         Get issue labels.
@@ -847,13 +881,22 @@ def delete_component(self, component_id):
         log.warning('Deleting component "{component_id}"'.format(component_id=component_id))
         return self.delete('rest/api/2/component/{component_id}'.format(component_id=component_id))
 
-    def get_resolution_by_id(self, id):
+    def get_resolution_by_id(self, resolution_id):
         """
         Get Resolution info by id
-        :param id:
+        :param resolution_id:
+        :return:
+        """
+        url = 'rest/api/2/resolution/{}'.format(resolution_id)
+        return self.get(url)
+
+    def get_priority_by_id(self, priority_id):
+        """
+        Get Priority info by id
+        :param priority_id:
         :return:
         """
-        url = 'rest/api/2/resolution/{}'.format(id)
+        url = 'rest/api/2/resolution/{}'.format(priority_id)
         return self.get(url)
 
     def get_all_workflows(self):
@@ -880,6 +923,14 @@ def get_all_resolutions(self):
         url = 'rest/api/2/resolution'
         return self.get(url)
 
+    def get_all_priorities(self):
+        """
+        Returns a list of all priorities.
+        :return:
+        """
+        url = 'rest/api/2/priority'
+        return self.get(url)
+
     def get_all_global_project_roles(self):
         """
         Get all the ProjectRoles available in Jira. Currently this list is global.

atlassian/rest_client.py

@@ -166,4 +166,4 @@ def delete(self, path, data=None, headers=None, params=None):
         :return: Empty dictionary to have consistent interface.
         Some of Atlassian REST resources don't return any content.
         """
-        self.request('DELETE', path=path, data=data, headers=headers, params=params)
+        self.request('DELETE', path=path, data=data, headers=headers, params=params)