Insght: adjsut methods variables

Author: gonchik

atlassian/VERSION

@@ -1 +1 @@
-3.29.1
+3.30.0

atlassian/bitbucket/cloud/base.py

@@ -1,9 +1,12 @@
 # coding=utf-8
 
+import logging
 from ..base import BitbucketBase
 
 from requests import HTTPError
 
+log = logging.getLogger(__name__)
+
 
 class BitbucketCloudBase(BitbucketBase):
     def __init__(self, url, *args, **kwargs):
@@ -104,7 +107,8 @@ def raise_for_status(self, response):
                 error_msg = e["message"]
                 if e.get("detail"):
                     error_msg += "\n" + e["detail"]
-            except Exception:
+            except Exception as e:
+                log.error(e)
                 response.raise_for_status()
             else:
                 raise HTTPError(error_msg, response=response)

atlassian/confluence.py

@@ -1511,7 +1511,7 @@ def update_page(
         :return:
         """
         # update current page
-        params = {'status': 'current'}
+        params = {"status": "current"}
         log.info('Updating {type} "{title}" with {parent_id}'.format(title=title, type=type, parent_id=parent_id))
 
         if not always_update and body is not None and self.is_page_content_is_already_updated(page_id, body, title):
@@ -2785,7 +2785,8 @@ def raise_for_status(self, response):
             try:
                 j = response.json()
                 error_msg = j["message"]
-            except Exception:
+            except Exception as e:
+                log.error(e)
                 response.raise_for_status()
             else:
                 raise HTTPError(error_msg, response=response)

atlassian/insight.py

@@ -8,7 +8,6 @@
 
 
 class Insight(AtlassianRestAPI):
-
     """Insight for Jira API wrapper."""
 
     # https://insight-javadoc.riada.io/insight-javadoc-8.6/insight-rest/
@@ -285,21 +284,21 @@ def get_object(self, object_id):
         url = self.url_joiner(self.api_root, "object/{id}".format(id=object_id))
         return self.get(url)
 
-    def update_object(self, object_id, object_type_id, attributes, has_avatar=False, avatar_UUID=""):
+    def update_object(self, object_id, object_type_id, attributes, has_avatar=False, avatar_uuid=""):
         """
         Update an existing object in Insight
 
         :param object_id:
         :param object_type_id:
         :param attributes:
         :param has_avatar:
-        :param avatar_UUID:
+        :param avatar_uuid:
         :return:
         """
         body = {
             "attributes": attributes,
             "objectTypeId": object_type_id,
-            "avatarUUID": avatar_UUID,
+            "avatarUUID": avatar_uuid,
             "hasAvatar": has_avatar,
         }
         url = self.url_joiner(self.api_root, "object/{id}".format(id=object_id))
@@ -337,7 +336,7 @@ def get_object_history(self, object_id, asc=False, abbreviate=True):
         params = {"asc": asc, "abbreviate": abbreviate}
         url = self.url_joiner(self.api_root, "object/{id}/history".format(id=object_id))
         return self.get(url, params=params)
-        
+
     @deprecated(version="3.29.0", reason="Use get_object_reference_info()")
     def get_object_referenceinfo(self, object_id):
         """Let's use the get_object_reference_info()"""
@@ -354,65 +353,71 @@ def get_object_reference_info(self, object_id):
         url = self.url_joiner(self.api_root, "object/{id}/referenceinfo".format(id=object_id))
         return self.get(url)
 
-    def create_object(self, objectTypeId, attributes, hasAvatar=False, avatarUUID=""):
+    def create_object(self, object_type_id, attributes, has_avatar=False, avatar_uuid=""):
         """
         Create a new object in Insight
 
-        :param objectTypeId:
+        :param object_type_id:
         :param attributes:
-        :param hasAvatar:
-        :param avatarUUID:
+        :param has_avatar:
+        :param avatar_uuid:
         :return:
         :return:
         """
         data = {
             "attributes": attributes,
-            "objectTypeId": objectTypeId,
-            "avatarUUID": avatarUUID,
-            "hasAvatar": hasAvatar,
+            "objectTypeId": object_type_id,
+            "avatarUUID": avatar_uuid,
+            "hasAvatar": has_avatar,
         }
         url = self.url_joiner(self.api_root, "object/create")
         return self.post(url, data=data)
 
     def create_object_navlist_iql(
         self,
         iql,
-        objectTypeId,
-        resultsPerPage,
-        orderByTypeAttrId,
-        objectId,
-        objectSchemaId,
-        includeAttributes,
-        attributesToDisplay,
+        object_type_id,
+        results_per_page,
+        order_by_type_attr_id,
+        object_id,
+        object_schema_id,
+        include_attributes,
+        attributes_to_display,
         page=1,
         asc=0,
     ):
         """
-        A filter object that is used to find a paginatad result set based on an object type and an IQL query
+        A filter object that is used to find a paginated result set based on an object type and an IQL query
 
         :param iql:
-        :param objectTypeId:
+        :param object_type_id:
         :param page:
-        :param resultsPerPage:
-        :param orderByTypeAttrId:
+        :param results_per_page:
+        :param order_by_type_attr_id:
         :param asc:
-        :param objectId:
-        :param objectSchemaId:
-        :param includeAttributes:
-        :param attributesToDisplay:
+        :param object_id:
+        :param object_schema_id:
+        :param include_attributes:
+        :param attributes_to_display:
         :return:
         """
-        data = {"objectTypeId": objectTypeId, "iql": iql, "resultsPerPage": resultsPerPage, "page": page, "asc": asc}
-        if attributesToDisplay is not None:
-            data["attributesToDisplay"] = attributesToDisplay
-        if includeAttributes is not None:
-            data["includeAttributes"] = includeAttributes
-        if objectSchemaId is not None:
-            data["objectSchemaId"] = objectSchemaId
-        if orderByTypeAttrId is not None:
-            data["orderByTypeAttrId"] = orderByTypeAttrId
-        if objectId is not None:
-            data["objectId"] = objectId
+        data = {
+            "objectTypeId": object_type_id,
+            "iql": iql,
+            "resultsPerPage": results_per_page,
+            "page": page,
+            "asc": asc,
+        }
+        if attributes_to_display is not None:
+            data["attributesToDisplay"] = attributes_to_display
+        if include_attributes is not None:
+            data["includeAttributes"] = include_attributes
+        if object_schema_id is not None:
+            data["objectSchemaId"] = object_schema_id
+        if order_by_type_attr_id is not None:
+            data["orderByTypeAttrId"] = order_by_type_attr_id
+        if object_id is not None:
+            data["objectId"] = object_id
         url = self.url_joiner(self.api_root, "iql/objects")
         return self.post(url, data=data)
 
@@ -494,7 +499,67 @@ def get_object_schema_object_types_flat(self, schema_id):
         """
         raise NotImplementedError
 
-    # Objecttype
-    # Objecttypeattribute
-    # Progress
-    # Config
+    def get_object_type_attributes(
+        self,
+        type_id,
+        only_value_editable=None,
+        order_by_name=None,
+        query=None,
+        include_values_exist=None,
+        exclude_parent_attributes=None,
+        include_children=None,
+        order_by_required=None,
+    ):
+        """
+        Find all attributes for this object type
+        https://developer.atlassian.com/cloud/insight/rest/api-group-objecttype/#api-objecttype-id-attributes-get
+        Args:
+            type_id (str): id of the object type
+            only_value_editable (bool, optional): only return editable values, defaults to None (Use API default)
+            order_by_name (bool, optional): values, defaults to None (Use API default)
+            query (str, optional): Not documented in API, defaults to None (Use API default)
+            include_values_exist (bool, optional): Include only where values exist, defaults to None (Use API default)
+            exclude_parent_attributes (bool, optional): Exclude parent attributes, defaults to None (Use API default)
+            include_children (bool, optional): include attributes from children, defaults to None (Use API default)
+            order_by_required (bool, optional): Order by required fields, defaults to None (Use API default)
+        """
+
+        kwargs = locals().items()
+        params = dict()
+        params.update({k: v for k, v in kwargs if v is not None and k not in ["self", "type_id"]})
+
+        return self.get(
+            "{0}objecttype/{1}/attributes".format(self.api_root, type_id),
+            headers=self.experimental_headers,
+            params=params,
+        )
+
+    ### Objecttype
+    # TODO: Post objecttype {id} position:
+    #       https://developer.atlassian.com/cloud/insight/rest/api-group-objecttype/#api-objecttype-id-position-post
+    # TODO: Post objecttype create:
+    #       https://developer.atlassian.com/cloud/insight/rest/api-group-objecttype/#api-objecttype-create-post
+
+    ### Insight ObjectTypeAttribute API
+    # TODO: Post objecttypeattribute {objectTypeId}:
+    #       https://developer.atlassian.com/cloud/insight/rest/api-group-objecttypeattribute/#api-objecttypeattribute-objecttypeid-post
+    # TODO: Put objecttypeattribute {objectTypeId} {id}:
+    #       https://developer.atlassian.com/cloud/insight/rest/api-group-objecttypeattribute/#api-objecttypeattribute-objecttypeid-id-put
+    # TODO: Delete objecttypeattribute {id}:
+    #       https://developer.atlassian.com/cloud/insight/rest/api-group-objecttypeattribute/#api-objecttypeattribute-id-delete
+
+    ### Insight Progress API
+    # TODO: Get progress category imports {id}:
+    #       https://developer.atlassian.com/cloud/insight/rest/api-group-progress/#api-progress-category-imports-id-get
+
+    ### Insight Config API
+    # TODO: Get config statustype:
+    #       https://developer.atlassian.com/cloud/insight/rest/api-group-config/#api-config-statustype-get
+    # TODO: Post config statustype:
+    #       https://developer.atlassian.com/cloud/insight/rest/api-group-config/#api-config-statustype-post
+    # TODO: Get config statustype {id}:
+    #       https://developer.atlassian.com/cloud/insight/rest/api-group-config/#api-config-statustype-id-get
+    # TODO: Put config statustype {id}:
+    #       https://developer.atlassian.com/cloud/insight/rest/api-group-config/#api-config-statustype-id-put
+    # TODO: Delete config statustype {id}:
+    #       https://developer.atlassian.com/cloud/insight/rest/api-group-config/#api-config-statustype-id-delete

atlassian/jira.py

@@ -902,6 +902,8 @@ def epic_issues(self, epic, fields="*all", expand=None):
         base_url = self.resource_url("epic", api_root="rest/agile", api_version="1.0")
         url = "{base_url}/{key}/issue?fields={fields}".format(base_url=base_url, key=epic, fields=fields)
         params = {}
+        if expand:
+            params["expand"] = expand
         return self.get(url, params=params)
 
     def bulk_issue(self, issue_list, fields="*all"):
@@ -1048,7 +1050,8 @@ def bulk_update_issue_field(self, key_list, fields="*all"):
         try:
             for key in key_list:
                 self.put("{base_url}/{key}".format(base_url=base_url, key=key), data={"fields": fields})
-        except Exception:
+        except Exception as e:
+            log.error(e)
             return False
         return True
 
@@ -1183,7 +1186,7 @@ def issue_delete_watcher(self, issue_key, user):
     def issue_get_watchers(self, issue_key):
         """
         Get watchers for an issue
-        :param issue_key: Issue Id or Key
+        :param issue_key: Issue ID or Key
         :return: List of watchers for issue
         """
         base_url = self.resource_url("issue")
@@ -2938,27 +2941,27 @@ def get_all_workflows(self):
         url = self.resource_url("workflow")
         return self.get(url)
 
-    def get_workflows_paginated(self, startAt=None, maxResults=None, workflowName=None, expand=None):
+    def get_workflows_paginated(self, start_at=None, max_results=None, workflow_name=None, expand=None):
         """
         Provide all workflows paginated (see https://developer.atlassian.com/cloud/jira/platform/rest/v2/\
 api-group-workflows/#api-rest-api-2-workflow-search-get)
         :param expand:
-        :param startAt: OPTIONAL The index of the first item to return in a page of results (page offset).
-        :param maxResults: OPTIONAL The maximum number of items to return per page.
-        :param workflowName: OPTIONAL The name of a workflow to return.
+        :param start_at: OPTIONAL The index of the first item to return in a page of results (page offset).
+        :param max_results: OPTIONAL The maximum number of items to return per page.
+        :param workflow_name: OPTIONAL The name of a workflow to return.
         :param: expand: OPTIONAL Use expand to include additional information in the response. This parameter accepts a
             comma-separated list. Expand options include: transitions, transitions.rules, statuses, statuses.properties
         :return:
         """
         url = self.resource_url("workflow/search")
 
         params = {}
-        if startAt:
-            params["startAt"] = startAt
-        if maxResults:
-            params["maxResults"] = maxResults
-        if workflowName:
-            params["workflowName"] = workflowName
+        if start_at:
+            params["startAt"] = start_at
+        if max_results:
+            params["maxResults"] = max_results
+        if workflow_name:
+            params["workflowName"] = workflow_name
         if expand:
             params["expand"] = expand
 

atlassian/rest_client.py

@@ -420,7 +420,8 @@ def raise_for_status(self, response):
                     error_msg = "\n".join(
                         j.get("errorMessages", list()) + [k + ": " + v for k, v in j.get("errors", dict()).items()]
                     )
-            except Exception:
+            except Exception as e:
+                log.error(e)
                 response.raise_for_status()
             else:
                 raise HTTPError(error_msg, response=response)