Merge pull request #77 from SLRover/master

Generate review autogenerated docs and  a new module for ServiceDesk for work it.

Author: gonchik

.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/__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/service_desk.py

@@ -0,0 +1,120 @@
+# 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))

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)