Polish Bamboo methods and review upload plugin method

Author: Gonchik Tsymzhitov

README.rst

@@ -8,7 +8,7 @@ Documentation
 
 `Documentation`_
 
-.. _Documentation: https://atlassian-python-api.readthedocs.io/en/latest/index.html
+.. _Documentation: https://atlassian-python-api.readthedocs.io
 
 Install
 -------

atlassian/bamboo.py

@@ -87,14 +87,16 @@ def project(self, project_key, expand=None, favourite=False, clover_enabled=Fals
         resource = 'project/{}'.format(project_key)
         return self.base_list_call(resource, expand, favourite, clover_enabled, start_index=0, max_results=25)
 
-    def project_plans(self, project_key):
+    def project_plans(self, project_key, max_results=25):
         """
         Returns a generator with the plans in a given project
         :param project_key: Project key
+        :param max_results:
         :return: Generator with plans
         """
-        resource = 'project/{}'.format(project_key, max_results=25)
-        return self.base_list_call(resource, expand='plans', favourite=False, clover_enabled=False, max_results=25,
+        resource = 'project/{}'.format(project_key, max_results=max_results)
+        return self.base_list_call(resource, expand='plans', favourite=False,
+                                   clover_enabled=False, max_results=max_results,
                                    elements_key='plans', element_key='plan')
 
     def plans(self, expand=None, favourite=False, clover_enabled=False, start_index=0, max_results=25):
@@ -150,10 +152,10 @@ def enable_plan(self, plan_key):
 
     """ Branches """
 
-    def search_branches(self, plan_key, include_default_branch=True, max_results=25):
+    def search_branches(self, plan_key, include_default_branch=True, max_results=25, start=0):
         params = {
             'max-result': max_results,
-            'start-index': 0,
+            'start-index': start,
             'masterPlanKey': plan_key,
             'includeMasterBranch': include_default_branch
         }
@@ -310,7 +312,7 @@ def plan_results(self, project_key, plan_key, expand=None, favourite=False, clov
                             label=label, issue_key=issue_key, start_index=start_index, max_results=max_results,
                             include_all_states=include_all_states)
 
-    def build_result(self, build_key, expand=None, include_all_states=False):
+    def build_result(self, build_key, expand=None, include_all_states=False, start=0, max_results=25):
         """
         Returns details of a specific build result
         :param expand: expands build result details on request. Possible values are: artifacts, comments, labels,
@@ -319,12 +321,15 @@ def build_result(self, build_key, expand=None, include_all_states=False):
         :param build_key: Should be in the form XX-YY[-ZZ]-99, that is, the last token should be an integer representing
         the build number
         :param include_all_states
+        :param start:
+        :param max_results:
         """
         try:
             int(build_key.split('-')[-1])
             resource = "result/{}".format(build_key)
             return self.base_list_call(resource, expand, favourite=False, clover_enabled=False,
-                                       start_index=0, max_results=25, include_all_states=include_all_states)
+                                       start_index=start, max_results=max_results,
+                                       include_all_states=include_all_states)
         except ValueError:
             raise ValueError('The key "{}" does not correspond to a build result'.format(build_key))
 
@@ -654,10 +659,8 @@ def upload_plugin(self, plugin_path):
         files = {
             'plugin': open(plugin_path, 'rb')
         }
-        headers = {
-            'X-Atlassian-Token': 'nocheck'
-        }
-        upm_token = self.request(method='GET', path='rest/plugins/1.0/', headers=headers, trailing=True).headers[
-            'upm-token']
+        upm_token = \
+            self.request(method='GET', path='rest/plugins/1.0/', headers=self.no_check_headers, trailing=True).headers[
+                'upm-token']
         url = 'rest/plugins/1.0/?token={upm_token}'.format(upm_token=upm_token)
-        return self.post(url, files=files, headers=headers)
+        return self.post(url, files=files, headers=self.no_check_headers)

atlassian/bitbucket.py

@@ -1785,13 +1785,11 @@ def upload_plugin(self, plugin_path):
         files = {
             'plugin': open(plugin_path, 'rb')
         }
-        headers = {
-            'X-Atlassian-Token': 'nocheck'
-        }
-        upm_token = self.request(method='GET', path='rest/plugins/1.0/', headers=headers, trailing=True).headers[
-            'upm-token']
+        upm_token = \
+            self.request(method='GET', path='rest/plugins/1.0/', headers=self.no_check_headers, trailing=True).headers[
+                'upm-token']
         url = 'rest/plugins/1.0/?token={upm_token}'.format(upm_token=upm_token)
-        return self.post(url, files=files, headers=headers)
+        return self.post(url, files=files, headers=self.no_check_headers)
 
     def upload_file(self, project, repository, content, message, branch, filename):
         """
@@ -2170,8 +2168,8 @@ def delete_repo_condition(self, project_key, repo_key, id_condition):
             repoKey=repo_key,
             idCondition=id_condition)
         return self.delete(url) or {}
-    
-    def get_associated_build_statuses(self,commit):
+
+    def get_associated_build_statuses(self, commit):
         """
         To get the build statuses associated with a commit.
         :commit: str- commit id
@@ -2181,7 +2179,5 @@ def get_associated_build_statuses(self,commit):
             url = '/rest/build-status/1.0/commits/{commitId}'.format(commitId=commit)
         else:
             url = '/rest/build-status/2.0/commits/{commitId}'.format(commitId=commit)
-            
+
         return self.get(url)
-        
-        

atlassian/confluence.py

@@ -148,7 +148,8 @@ def get_page_by_title(self, space, title, start=0, limit=1, expand=None):
             return self.get(url, params=params)
         else:
             try:
-                return (self.get(url, params=params) or {}).get('results')[0]
+                response = (self.get(url, params=params) or {}).get('results')
+                return response[0] if response else None
             except (IndexError, TypeError) as e:
                 log.error("Can't find '{title}' page on the {url}!".format(title=title, url=self.url))
                 log.debug(e)
@@ -1266,13 +1267,11 @@ def upload_plugin(self, plugin_path):
         files = {
             'plugin': open(plugin_path, 'rb')
         }
-        headers = {
-            'X-Atlassian-Token': 'nocheck'
-        }
-        upm_token = self.request(method='GET', path='rest/plugins/1.0/', headers=headers, trailing=True).headers[
-            'upm-token']
+        upm_token = \
+            self.request(method='GET', path='rest/plugins/1.0/', headers=self.no_check_headers, trailing=True).headers[
+                'upm-token']
         url = 'rest/plugins/1.0/?token={upm_token}'.format(upm_token=upm_token)
-        return self.post(url, files=files, headers=headers)
+        return self.post(url, files=files, headers=self.no_check_headers)
 
     def delete_plugin(self, plugin_key):
         """

atlassian/crowd.py

@@ -43,3 +43,18 @@ def health_check(self):
             # check as support tools
             response = self.get('rest/supportHealthCheck/1.0/check/')
         return response
+
+    def upload_plugin(self, plugin_path):
+        """
+        Provide plugin path for upload into Jira e.g. useful for auto deploy
+        :param plugin_path:
+        :return:
+        """
+        files = {
+            'plugin': open(plugin_path, 'rb')
+        }
+        upm_token = \
+            self.request(method='GET', path='rest/plugins/1.0/', headers=self.no_check_headers, trailing=True).headers[
+                'upm-token']
+        url = 'rest/plugins/1.0/?token={upm_token}'.format(upm_token=upm_token)
+        return self.post(url, files=files, headers=self.no_check_headers)

atlassian/jira.py

@@ -1458,13 +1458,11 @@ def upload_plugin(self, plugin_path):
         files = {
             'plugin': open(plugin_path, 'rb')
         }
-        headers = {
-            'X-Atlassian-Token': 'nocheck'
-        }
-        upm_token = self.request(method='GET', path='rest/plugins/1.0/', headers=headers, trailing=True).headers[
-            'upm-token']
+        upm_token = \
+            self.request(method='GET', path='rest/plugins/1.0/', headers=self.no_check_headers, trailing=True).headers[
+                'upm-token']
         url = 'rest/plugins/1.0/?token={upm_token}'.format(upm_token=upm_token)
-        return self.post(url, files=files, headers=headers)
+        return self.post(url, files=files, headers=self.no_check_headers)
 
     def delete_plugin(self, plugin_key):
         """

atlassian/service_desk.py

@@ -607,3 +607,18 @@ def get_issues_in_queue(self, service_desk_id, queue_id, start=0, limit=50):
             params['limit'] = int(limit)
 
         return self.get(url, headers=self.experimental_headers, params=params)
+
+    def upload_plugin(self, plugin_path):
+        """
+        Provide plugin path for upload into Jira e.g. useful for auto deploy
+        :param plugin_path:
+        :return:
+        """
+        files = {
+            'plugin': open(plugin_path, 'rb')
+        }
+        upm_token = \
+            self.request(method='GET', path='rest/plugins/1.0/', headers=self.no_check_headers, trailing=True).headers[
+                'upm-token']
+        url = 'rest/plugins/1.0/?token={upm_token}'.format(upm_token=upm_token)
+        return self.post(url, files=files, headers=self.no_check_headers)

docs/bitbucket.rst

@@ -1,4 +1,4 @@
-Bitbucket module
+BitBucket module
 ================
 
 Manage projects

docs/index.rst

@@ -153,6 +153,7 @@ Or reuse cookie file:
    jira
    confluence
    bitbucket
+   bamboo
    service_desk
 
 .. |Build Status| image:: https://travis-ci.org/atlassian-api/atlassian-python-api.svg?branch=master