Merge branch 'master' of https://github.com/gonchik/atlassian-python-api

Author: Gonchik Tsymzhitov

.gitignore

@@ -70,6 +70,8 @@ instance/
 
 # Sphinx documentation
 docs/_build/
+Thumbs.db
+.DS_Store
 
 # PyBuilder
 target/

README.rst

@@ -58,6 +58,20 @@ Also, you can use the Bitbucket module e.g. for get project list
     data = bitbucket.project_list()
     print(data)
 
+Now you can use Jira Service Desk module. See docs.
+Example to get your requests:
+
+.. code-block:: python
+
+    from atlassian import ServiceDesk
+
+    sd = ServiceDesk(
+            url='http://localhost:7990',
+            username='admin',
+            password='admin')
+    my_requests = sd.get_my_customer_requests()
+    print(my_requests)
+
 Please make sure, you've checked ``examples/`` directory on how to build scripts using the API.
 If you want to see response in pretty print format json. Feel free for use construction like:
 

atlassian/VERSION

@@ -1 +1 @@
-1.10.3
+1.11.0

atlassian/__init__.py

@@ -5,5 +5,6 @@
 from .portfolio import Portfolio
 from .bamboo import Bamboo
 from .crowd import Crowd
+from .service_desk import ServiceDesk
 
-__all__ = ['Confluence', 'Jira', 'Bitbucket', 'Portfolio', 'Bamboo', 'Stash', 'Crowd']
+__all__ = ['Confluence', 'Jira', 'Bitbucket', 'Portfolio', 'Bamboo', 'Stash', 'Crowd', 'ServiceDesk']

atlassian/confluence.py

@@ -34,7 +34,7 @@ def get_page_child_by_type(self, page_id, type='page', start=None, limit=None):
         :param page_id: A string containing the id of the type content container.
         :param type:
         :param start: OPTIONAL: The start point of the collection to return. Default: None (0).
-        :param limit: OPTIONAL: how many items should be returned after the start index. Default: Site limit.
+        :param limit: OPTIONAL: how many items should be returned after the start index. Default: Site limit 200.
         :return:
         """
         params = {}
@@ -46,7 +46,7 @@ def get_page_child_by_type(self, page_id, type='page', start=None, limit=None):
         url = 'rest/api/content/{page_id}/child/{type}'.format(page_id=page_id, type=type)
         log.info(url)
         try:
-            return self.get(url)
+            return (self.get(url, params=params) or {}).get('results')
         except IndexError as e:
             log.error(e)
             return None
@@ -66,7 +66,7 @@ def get_page_space(self, page_id):
         :param page_id: content ID
         :return:
         """
-        return self.get_page_by_id(page_id, expand='space')['space']['key']
+        return ((self.get_page_by_id(page_id, expand='space') or {}).get('space') or {}).get('key')
 
     def get_page_by_title(self, space, title, start=None, limit=None):
         """
@@ -91,7 +91,7 @@ def get_page_by_title(self, space, title, start=None, limit=None):
             params['title'] = str(title)
         url = 'rest/api/content'
         try:
-            return self.get(url, params=params).get('results')[0]
+            return (self.get(url, params=params) or {}).get('results')[0]
         except IndexError as e:
             log.error(e)
             return None
@@ -159,7 +159,7 @@ def get_all_pages_from_space(self, space, start=0, limit=500):
         url = 'rest/api/content?spaceKey={space}&limit={limit}&start={start}'.format(space=space,
                                                                                      limit=limit,
                                                                                      start=start)
-        return self.get(url)['results']
+        return (self.get(url) or {}).get('results')
 
     def get_all_pages_from_space_trash(self, space, start=0, limit=500, status='trashed'):
         """
@@ -460,7 +460,7 @@ def get_page_ancestors(self, page_id):
         :return: get properties
         """
         url = 'rest/api/content/{page_id}?expand=ancestors'.format(page_id=page_id)
-        return self.get(path=url).get('ancestors')
+        return (self.get(path=url) or {}).get('ancestors')
 
     def clean_all_caches(self):
         """ Clean all caches from cache management"""
@@ -580,4 +580,25 @@ def export_page(self, page_id):
         :param page_id: Page ID
         :return: PDF File
         """
-        return self.get_page_as_pdf(page_id)
+        return self.get_page_as_pdf(page_id)
+
+    def get_descendant_page_id(self, space, parent_id, title):
+        """
+        Provide  space, parent_id and title of the descendant page, it will return the descendant page_id
+        :param space: str
+        :param parent_id: int
+        :param title: str
+        :return: page_id of the page whose title is passed in argument
+        """
+        page_id = ""
+
+        url = 'rest/api/content/search?cql=parent={}%20AND%20space="{}"'.format(
+            parent_id, space
+        )
+        response = self.get(url, {})
+
+        for each_page in response.get("results", []):
+            if each_page.get("title") == title:
+                page_id = each_page.get("id")
+                break
+        return page_id

atlassian/jira.py

@@ -292,11 +292,11 @@ def issue_create_or_update(self, fields):
     def get_issue_transitions(self, issue_key):
         url = 'rest/api/2/issue/{issue_key}?expand=transitions.fields&fields=status'.format(issue_key=issue_key)
         return [{'name': transition['name'], 'id': int(transition['id']), 'to': transition['to']['name']}
-                for transition in self.get(url)['transitions']]
+                for transition in (self.get(url) or {}).get('transitions')]
 
     def get_status_id_from_name(self, status_name):
         url = 'rest/api/2/status/{name}'.format(name=status_name)
-        return int(self.get(url)['id'])
+        return int((self.get(url) or {}).get('id'))
 
     def get_transition_id_to_status_name(self, issue_key, status_name):
         for transition in self.get_issue_transitions(issue_key):
@@ -313,7 +313,7 @@ def set_issue_status(self, issue_key, status_name):
 
     def get_issue_status(self, issue_key):
         url = 'rest/api/2/issue/{issue_key}?fields=status'.format(issue_key=issue_key)
-        return self.get(url)['fields']['status']['name']
+        return (self.get(url) or {}).get('fields').get('status').get('name')
 
     def component(self, component_id):
         return self.get('rest/api/2/component/{component_id}'.format(component_id=component_id))

atlassian/service_desk.py

@@ -0,0 +1,137 @@
+# coding: utf8
+import logging
+from .rest_client import AtlassianRestAPI
+
+log = logging.getLogger(__name__)
+
+
+class ServiceDesk(AtlassianRestAPI):
+    def get_info(self):
+        """ Get info about Service Desk app """
+        return self.get('rest/servicedeskapi/info')
+
+    def create_customer(self, full_name, email):
+        """
+        Creating customer user
+
+        :param full_name: str
+        :param email: str
+        :return: New customer
+        """
+        log.warning('Creating customer...')
+        data = {'fullName': full_name, 'email': email}
+        headers = {'Content-Type': 'application/json',
+                   'Accept': 'application/json',
+                   'X-ExperimentalApi': 'opt-in'
+                   }
+        return self.post('rest/servicedeskapi/customer', headers=headers, data=data)
+
+    def get_customer_request(self, issue_id_or_key):
+        """
+        Get single request
+
+        :param issue_id_or_key: str
+        :return: Customer request
+        """
+        return self.get('rest/servicedeskapi/request/{}'.format(issue_id_or_key))
+
+    def get_my_customer_requests(self):
+        """ Returning requests where you are the assignee """
+        requests = self.get('rest/servicedeskapi/request')
+        requests_values = requests.get('values')
+        return requests_values
+
+    def create_customer_request(self, service_desk_id, request_type_id, values_dict):
+        """
+        Creating customer request
+
+        :param service_desk_id: str
+        :param request_type_id: str
+        :param values_dict: str
+        :return: New request
+        """
+        log.warning('Creating request...')
+        data = {"serviceDeskId": service_desk_id,
+                "requestTypeId": request_type_id,
+                "requestFieldValues": values_dict
+                }
+        return self.post('rest/servicedeskapi/request', data=data)
+
+    def get_customer_request_status(self, issue_id_or_key):
+        """
+        Get customer request status name
+
+        :param issue_id_or_key: str
+        :return: Status name
+        """
+        request = self.get('rest/servicedeskapi/request/{}/status'.format(issue_id_or_key)).get('values')
+        status = request[0].get('status')
+        return status
+
+    def perform_transition(self, issue_id_or_key, transition_id, comment=None):
+        """
+        Perform a customer transition for a given request and transition ID.
+        An optional comment can be included to provide a reason for the transition.
+
+        :param issue_id_or_key: str
+        :param transition_id: str
+        :param comment: OPTIONAL: str
+        :return: None
+        """
+        log.warning('Performing transition...')
+        headers = {'Content-Type': 'application/json',
+                   'Accept': 'application/json',
+                   'X-ExperimentalApi': 'opt-in'
+                   }
+        data = {'id': transition_id, 'additionalComment': {'body': comment}}
+        url = 'rest/servicedeskapi/request/{}/transition'.format(issue_id_or_key)
+        return self.post(url, headers=headers, data=data)
+
+    def create_request_comment(self, issue_id_or_key, body, public=True):
+        """
+        Creating request comment
+
+        :param issue_id_or_key: str
+        :param body: str
+        :param public: OPTIONAL: bool (default is True)
+        :return: New comment
+        """
+        log.warning('Creating comment...')
+        data = {"body": body, "public": public}
+        return self.post('rest/servicedeskapi/request/{}/comment'.format(issue_id_or_key), data=data)
+
+    def get_request_comments(self, issue_id_or_key):
+        """
+        Get all comments in issue
+
+        :param issue_id_or_key: str
+        :return: Issue comments
+        """
+        return self.get('rest/servicedeskapi/request/{}/comment'.format(issue_id_or_key))
+
+    def get_request_comment_by_id(self, issue_id_or_key, comment_id):
+        """
+        Get single comment by ID
+
+        :param issue_id_or_key: str
+        :param comment_id: str
+        :return: Single comment
+        """
+        return self.get('rest/servicedeskapi/request/{0}/comment/{1}'.format(issue_id_or_key, comment_id))
+
+    def get_organisations(self, start=0, limit=50):
+        """
+        Returns a list of organizations in the JIRA instance. If the user is not an agent, the resource returns a list of organizations the user is a member of.
+        :param start: OPTIONAL: int The starting index of the returned objects.
+                     Base index: 0. See the Pagination section for more details.
+        :param limit: OPTIONAL: int The maximum number of users to return per page.
+                     Default: 50. See the Pagination section for more details.
+        :return:
+        """
+        params = {}
+        if start is not None:
+            params["start"] = int(start)
+        if limit is not None:
+            params["limit"] = int(limit)
+
+        return self.get('rest/servicedeskapi/organization', params=params)

docs/Makefile

@@ -0,0 +1,19 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+SOURCEDIR     = .
+BUILDDIR      = _build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/bitbucket.rst

@@ -0,0 +1,83 @@
+Bitbucket module
+================
+
+Manage projects
+---------------
+
+.. code-block:: python
+
+    # Project list
+    bitbucket.project_list()
+
+    # Project info
+    bitbucket.project(key)
+
+    # Get users who has permission in project
+    bitbucket.project_users(key, limit=99999)
+
+    # Get project administrators for project
+    butbucket.project_users_with_administrator_permissions(key)
+
+    # Get Project Groups
+    bitbucket.project_groups(key, limit=99999)
+
+    # Get groups with admin permissions
+    bitbucket.project_groups_with_administrator_permissions(key)
+
+    # Project summary
+    butbucket.project_summary(key)
+
+Groups and admins
+-----------------
+
+.. code-block:: python
+
+    # Get group of members
+    bitbucket.group_members(group, limit=99999)
+
+    # All project administrators
+    bitbucket.all_project_administrators()
+
+Manage code
+-----------
+
+.. code-block:: python
+
+    # Get repositories list from project
+    bitbucket.repo_list(project_key, limit=25)
+
+    # Get branches from repo
+    bitbucket.get_branches(project, repository, filter='', limit=99999, details=True)
+
+    # Delete branch from related repo
+    bitbucket.delete_branch(project, repository, name, end_point)
+
+    # Get pull requests
+    bitbucket.get_pull_requests(project, repository, state='OPEN', order='newest', limit=100, start=0)
+
+    # Get tags for related repo
+    bitbucket.get_tags(project, repository, filter='', limit=99999)
+
+    # Get project tags
+    # The authenticated user must have REPO_READ permission for the context repository to call this resource
+    bitbucket.get_project_tags(project, repository, tag_name)
+
+    # Set tag
+    # The authenticated user must have REPO_WRITE permission for the context repository to call this resource
+    bitbucket.set_tag(project, repository, tag_name, commit_revision, description=None)
+
+    # Delete tag
+    # The authenticated user must have REPO_WRITE permission for the context repository to call this resource
+    bitbucket.delete_tag(project, repository, tag_name)
+
+    # Get diff
+    bitbucket.get_diff(project, repository, path, hash_oldest, hash_newest)
+
+    # Get commit list from repo
+    bitbucket.get_commits(project, repository, hash_oldest, hash_newest, limit=99999)
+
+    # Get change log between 2 refs
+    bitbucket.get_changelog(project, repository, ref_from, ref_to, limit=99999)
+
+    # Get raw content of the file from repo
+    bitbucket.get_content_of_file(project, repository, filename)