Merge branch 'atlassian-api:master' into master

Author: gkowalc

atlassian/VERSION

@@ -1 +1 @@
-3.41.14
+3.41.16

atlassian/bitbucket/base.py

@@ -164,7 +164,10 @@ def get_time(self, id):
             # The format contains a : in the timezone which is supported from 3.7 on.
             if sys.version_info <= (3, 7):
                 value_str = RE_TIMEZONE.sub(r"\1\2", value_str)
-            value = datetime.strptime(value_str, self.CONF_TIMEFORMAT)
+            try:
+                value = datetime.strptime(value_str, self.CONF_TIMEFORMAT)
+            except ValueError:
+                value = datetime.strptime(value_str, "%Y-%m-%dT%H:%M:%S.%fZ", tzinfo="UTC")
         else:
             value = value_str
 

atlassian/confluence.py

@@ -37,6 +37,7 @@ def __init__(self, url, *args, **kwargs):
     @staticmethod
     def _create_body(body, representation):
         if representation not in [
+            "atlas_doc_format",
             "editor",
             "export_view",
             "view",
@@ -521,13 +522,14 @@ def get_draft_page_by_id(self, page_id, status="draft", expand=None):
         # operate differently between different collaborative modes
         return self.get_page_by_id(page_id=page_id, expand=expand, status=status)
 
-    def get_all_pages_by_label(self, label, start=0, limit=50):
+    def get_all_pages_by_label(self, label, start=0, limit=50, expand=None):
         """
         Get all page by label
         :param label:
         :param start: OPTIONAL: The start point of the collection to return. Default: None (0).
         :param limit: OPTIONAL: The limit of the number of pages to return, this may be restricted by
                       fixed system limits. Default: 50
+        :param expand: OPTIONAL: a comma separated list of properties to expand on the content
         :return:
         """
         url = "rest/api/content/search"
@@ -538,6 +540,8 @@ def get_all_pages_by_label(self, label, start=0, limit=50):
             params["start"] = start
         if limit:
             params["limit"] = limit
+        if expand:
+            params["expand"] = expand
 
         try:
             response = self.get(url, params=params)
@@ -792,6 +796,7 @@ def create_page(
         representation="storage",
         editor=None,
         full_width=False,
+        status="current",
     ):
         """
         Create page from scratch
@@ -803,13 +808,15 @@ def create_page(
         :param representation: OPTIONAL: either Confluence 'storage' or 'wiki' markup format
         :param editor: OPTIONAL: v2 to be created in the new editor
         :param full_width: DEFAULT: False
+        :param status: either 'current' or 'draft'
         :return:
         """
         log.info('Creating %s "%s" -> "%s"', type, space, title)
         url = "rest/api/content/"
         data = {
             "type": type,
             "title": title,
+            "status": status,
             "space": {"key": space},
             "body": self._create_body(body, representation),
             "metadata": {"properties": {}},
@@ -1210,7 +1217,8 @@ def attach_content(
         :type  name: ``str``
         :param content: Contains the content which should be uploaded
         :type  content: ``binary``
-        :param content_type: Specify the HTTP content type. The default is
+        :param content_type: Specify the HTTP content type.
+                The default is "application/binary"
         :type  content_type: ``str``
         :param comment: A comment describing this upload/file
         :type  comment: ``str``
@@ -1292,6 +1300,7 @@ def attach_file(
                      Is no name give the file name is used as name
         :type  name: ``str``
         :param content_type: Specify the HTTP content type. The default is
+                            The default is "application/binary"
         :type  content_type: ``str``
         :param comment: A comment describing this upload/file
         :type  comment: ``str``
@@ -3067,10 +3076,8 @@ def add_user_to_group(self, username, group_name):
         :param group_name: str - name of group to add user to
         :return: Current state of the group
         """
-        url = "rest/api/2/group/user"
-        params = {"groupname": group_name}
-        data = {"name": username}
-        return self.post(url, params=params, data=data)
+        url = f"rest/api/user/{username}/group/{group_name}"
+        return self.put(url)
 
     def add_space_permissions(
         self,

atlassian/jira.py

@@ -1232,7 +1232,7 @@ def get_issue_changelog(self, issue_key, start=None, limit=None):
             return self.get(url, params=params)
         else:
             url = "{base_url}/{issue_key}?expand=changelog".format(base_url=base_url, issue_key=issue_key)
-            return (self.get(url) or {}).get("changelog", params)
+            return self._get_response_content(url, fields=[("changelog", params)])
 
     def issue_add_json_worklog(self, key, worklog):
         """
@@ -1378,7 +1378,7 @@ def get_issue_labels(self, issue_key):
         url = "{base_url}/{issue_key}?fields=labels".format(base_url=base_url, issue_key=issue_key)
         if self.advanced_mode:
             return self.get(url)
-        return (self.get(url) or {}).get("fields").get("labels")
+        return self._get_response_content(url, fields=[("fields",), ("labels",)])
 
     def update_issue(self, issue_key, update):
         """
@@ -1776,6 +1776,7 @@ def create_or_update_issue_remote_links(
         icon_url=None,
         icon_title=None,
         status_resolved=False,
+        application: dict = {},
     ):
         """
         Add Remote Link to Issue, update url if global_id is passed
@@ -1787,6 +1788,7 @@ def create_or_update_issue_remote_links(
         :param icon_url: str, OPTIONAL: Link to a 16x16 icon representing the type of the object in the remote system
         :param icon_title: str, OPTIONAL: Text for the tooltip of the main icon describing the type of the object in the remote system
         :param status_resolved: bool, OPTIONAL: if set to True, Jira renders the link strikethrough
+        :param application: dict, OPTIONAL: Application description
         """
         base_url = self.resource_url("issue")
         url = "{base_url}/{issue_key}/remotelink".format(base_url=base_url, issue_key=issue_key)
@@ -1802,6 +1804,8 @@ def create_or_update_issue_remote_links(
             if icon_title:
                 icon_data["title"] = icon_title
             data["object"]["icon"] = icon_data
+        if application:
+            data["application"] = application
         return self.post(url, data=data)
 
     def get_issue_remote_link_by_id(self, issue_key, link_id):
@@ -1919,12 +1923,14 @@ def set_issue_status_by_transition_id(self, issue_key, transition_id):
     def get_issue_status(self, issue_key):
         base_url = self.resource_url("issue")
         url = "{base_url}/{issue_key}?fields=status".format(base_url=base_url, issue_key=issue_key)
-        return (((self.get(url) or {}).get("fields") or {}).get("status") or {}).get("name") or {}
+        fields = [("fields",), ("status",), ("name",)]
+        return self._get_response_content(url, fields=fields) or {}
 
     def get_issue_status_id(self, issue_key):
         base_url = self.resource_url("issue")
         url = "{base_url}/{issue_key}?fields=status".format(base_url=base_url, issue_key=issue_key)
-        return (self.get(url) or {}).get("fields").get("status").get("id")
+        fields = [("fields",), ("status",), ("id",)]
+        return self._get_response_content(url, fields=fields)
 
     def get_issue_transitions_full(self, issue_key, transition_id=None, expand=None):
         """
@@ -2721,7 +2727,7 @@ def get_project_actors_for_role_project(self, project_key, role_id):
         """
         base_url = self.resource_url("project")
         url = "{base_url}/{projectIdOrKey}/role/{id}".format(base_url=base_url, projectIdOrKey=project_key, id=role_id)
-        return (self.get(url) or {}).get("actors")
+        return self._get_response_content(url, fields=[("actors",)])
 
     def delete_project_actors(self, project_key, role_id, actor, actor_type=None):
         """
@@ -3080,7 +3086,7 @@ def get_assignable_users_for_issue(self, issue_key, username=None, start=0, limi
     def get_status_id_from_name(self, status_name):
         base_url = self.resource_url("status")
         url = "{base_url}/{name}".format(base_url=base_url, name=status_name)
-        return int((self.get(url) or {}).get("id"))
+        return int(self._get_response_content(url, fields=[("id",)]))
 
     def get_status_for_project(self, project_key):
         base_url = self.resource_url("project")
@@ -3181,7 +3187,7 @@ def get_issue_link_types(self):
         a name and a label for the outward and inward link relationship.
         """
         url = self.resource_url("issueLinkType")
-        return (self.get(url) or {}).get("issueLinkTypes")
+        return self._get_response_content(url, fields=[("issueLinkTypes",)])
 
     def get_issue_link_types_names(self):
         """
@@ -3712,7 +3718,7 @@ def get_all_permissionschemes(self, expand=None):
         params = {}
         if expand:
             params["expand"] = expand
-        return (self.get(url, params=params) or {}).get("permissionSchemes")
+        return self._get_response_content(url, params=params, fields=[("permissionSchemes",)])
 
     def get_permissionscheme(self, permission_id, expand=None):
         """
@@ -3768,7 +3774,7 @@ def get_issue_security_schemes(self):
         :return: list
         """
         url = self.resource_url("issuesecurityschemes")
-        return self.get(url).get("issueSecuritySchemes")
+        return self._get_response_content(url, fields=[("issueSecuritySchemes",)])
 
     def get_issue_security_scheme(self, scheme_id, only_levels=False):
         """
@@ -3785,7 +3791,7 @@ def get_issue_security_scheme(self, scheme_id, only_levels=False):
         url = "{base_url}/{scheme_id}".format(base_url=base_url, scheme_id=scheme_id)
 
         if only_levels is True:
-            return self.get(url).get("levels")
+            return self._get_response_content(url, fields=[("levels",)])
         else:
             return self.get(url)
 

atlassian/rest_client.py

@@ -362,6 +362,34 @@ def get(
                 log.error(e)
                 return response.text
 
+    def _get_response_content(
+        self,
+        *args,
+        fields,
+        **kwargs,
+    ):
+        """
+        :param fields: list of tuples in the form (field_name, default value (optional)).
+            Used for chaining dictionary value accession.
+            E.g. [("field1", "default1"), ("field2", "default2"), ("field3", )]
+        """
+        response = self.get(*args, **kwargs)
+        if "advanced_mode" in kwargs:
+            advanced_mode = kwargs["advanced_mode"]
+        else:
+            advanced_mode = self.advanced_mode
+
+        if not advanced_mode:  # dict
+            for field in fields:
+                response = response.get(*field)
+        else:  # requests.Response
+            first_field = fields[0]
+            response = response.json().get(*first_field)
+            for field in fields[1:]:
+                response = response.get(*field)
+
+        return response
+
     def post(
         self,
         path,

atlassian/service_desk.py

@@ -1,6 +1,8 @@
 # coding=utf-8
 import logging
 
+from requests import HTTPError
+
 from .rest_client import AtlassianRestAPI
 
 log = logging.getLogger(__name__)
@@ -909,3 +911,22 @@ def create_request_type(
 
         url = "rest/servicedeskapi/servicedesk/{}/requesttype".format(service_desk_id)
         return self.post(url, headers=self.experimental_headers, data=data)
+
+    def raise_for_status(self, response):
+        """
+        Checks the response for an error status and raises an exception with the error message provided by the server
+        :param response:
+        :return:
+        """
+        if response.status_code == 401 and response.headers.get("Content-Type") != "application/json;charset=UTF-8":
+            raise HTTPError("Unauthorized (401)", response=response)
+
+        if 400 <= response.status_code < 600:
+            try:
+                j = response.json()
+                error_msg = j["errorMessage"]
+            except Exception as e:
+                log.error(e)
+                response.raise_for_status()
+            else:
+                raise HTTPError(error_msg, response=response)

docs/confluence.rst

@@ -43,7 +43,7 @@ Get page info
     confluence.get_draft_page_by_id(page_id, status='draft')
 
     # Get all page by label
-    confluence.get_all_pages_by_label(label, start=0, limit=50)
+    confluence.get_all_pages_by_label(label, start=0, limit=50, expand=None)
 
     # Get all pages from Space
     # content_type can be 'page' or 'blogpost'. Defaults to 'page'
@@ -114,14 +114,16 @@ Page actions
 
     # Attach (upload) a file to a page, if it exists it will update the
     # automatically version the new file and keep the old one
+    # content_type is default to "application/binary"
     confluence.attach_file(filename, name=None, content_type=None, page_id=None, title=None, space=None, comment=None)
 
     # Attach (upload) a content to a page, if it exists it will update the
     # automatically version the new file and keep the old one
+    # content_type is default to "application/binary"
     confluence.attach_content(content, name=None, content_type=None, page_id=None, title=None, space=None, comment=None)
 
-    # Download attachments from a page to local system. If download_path is None, current working directory will be used.
-    confluence.download_attachments_from_page(page_id, download_path=None)
+    # Download attachments from a page to local system. If path is None, current working directory will be used.
+    confluence.download_attachments_from_page(page_id, path=None)
 
     # Remove completely a file if version is None or delete version
     confluence.delete_attachment(page_id, filename, version=None)

tests/responses/jira/rest/api/2/issue/FOO-123/remotelink/POST

@@ -0,0 +1,17 @@
+responses[
+    '{"object": {"url": "https://confluence.atlassian-python.atlassian.net/display/Test", "title": "Unused link text", "status": {"resolved": false}}}'
+] = {
+    "id": 10000,
+    "self": "https://atlassian-python.atlassian.net/rest/api/2/issue/FOO-123/remotelink/10000",
+    "application": {},
+}
+responses[
+    '{"object": {"url": "https://confluence.atlassian-python.atlassian.net/display/Test", "title": "Unused link text", "status": {"resolved": false}}, "globalId": "appId=00000000-0000-0000-0000-000000000000&pageId=0", "application": {"type": "com.atlassian.confluence", "name": "Confluence"}}'
+] = {
+    "id": 10000,
+    "self": "https://atlassian-python.atlassian.net/rest/api/2/issue/FOO-123/remotelink/10000",
+    "application": {
+        "type": "com.atlassian.confluence",
+        "name": "Confluence",
+    },
+}

tests/test_jira.py

@@ -92,3 +92,40 @@ def test_delete_issue_property_not_found(self):
             self.jira.get_issue_property("FOO-123", "NotFoundBar1")
         with self.assertRaises(HTTPError):
             self.jira.get_issue_property("FOONotFound-123", "NotFoundBar1")
+
+    def test_post_issue_remotelink(self):
+        """Create a new remote link"""
+        resp = self.jira.create_or_update_issue_remote_links(
+            "FOO-123",
+            "https://confluence.atlassian-python.atlassian.net/display/Test",
+            "Unused link text",
+        )
+        self.assertEqual(resp["id"], 10000)
+        self.assertEqual(
+            resp["self"], "https://atlassian-python.atlassian.net/rest/api/2/issue/FOO-123/remotelink/10000"
+        )
+        self.assertDictEqual(resp["application"], {})
+
+    def test_post_issue_remotelink_confluence(self):
+        """Create a new Confluence remote link"""
+        resp = self.jira.create_or_update_issue_remote_links(
+            "FOO-123",
+            "https://confluence.atlassian-python.atlassian.net/display/Test",
+            "Unused link text",
+            global_id="appId=00000000-0000-0000-0000-000000000000&pageId=0",
+            application={
+                "type": "com.atlassian.confluence",
+                "name": "Confluence",
+            },
+        )
+        self.assertEqual(resp["id"], 10000)
+        self.assertEqual(
+            resp["self"], "https://atlassian-python.atlassian.net/rest/api/2/issue/FOO-123/remotelink/10000"
+        )
+        self.assertDictEqual(
+            resp["application"],
+            {
+                "type": "com.atlassian.confluence",
+                "name": "Confluence",
+            },
+        )