PYAPI-22 Stash Project Administrators

Author: astromatt

PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 1.1
 Name: atlassian-python-api
-Version: 0.3.0
+Version: 0.6.3
 Author: Matt Harasymczuk
 Author-email: code at mattagile com
 Maintainer: Matt Harasymczuk

atlassian/__init__.py

@@ -1,30 +1,56 @@
 import json
+import logging
 import requests
 
 
-class Atlassian:
+logging.basicConfig(level=logging.INFO, format="[%(asctime).19s] [%(levelname)s] %(message)s")
+logging.getLogger("requests").setLevel(logging.WARNING)
+log = logging.getLogger("atlassian")
+
+
+class AtlassianRestAPI:
 
     def __init__(self, url, username, password):
         self.url = url
         self.username = username
         self.password = password
 
-    def get(self, path, headers={"Content-Type": "application/json", "Accept": "application/json"}):
-        url = "{0}{1}".format(self.url, path)
-        return requests.get(url, headers=headers, auth=(self.username, self.password), timeout=60)
-
-    def post(self, path, data=None, headers={"Content-Type": "application/json", "Accept": "application/json"}):
-        url = "{0}{1}".format(self.url, path)
-        return requests.post(url, json.dumps(data), headers=headers, auth=(self.username, self.password))
-
-    def put(self, path, data=None, headers={"Content-Type": "application/json", "Accept": "application/json"}):
-        url = "{0}{1}".format(self.url, path)
-        return requests.put(url, json.dumps(data), headers=headers, auth=(self.username, self.password))
-
-    def delete(self, path, headers={"Content-Type": "application/json", "Accept": "application/json"}):
-        url = "{0}{1}".format(self.url, path)
-        return requests.delete(url, headers=headers, auth=(self.username, self.password))
+    def log_curl_debug(self, method, path, headers={}, data=None):
+        command = "curl --silent -X {method} -u '{username}':'{password}' -H {headers} {data} '{url}'".format(
+            method=method,
+            username=self.username,
+            password=self.password,
+            headers=' -H '.join(["'{0}: {1}'".format(key, value) for key, value in headers.items()]),
+            data='' if not data else "--data '{0}'".format(json.dumps(data)),
+            url='{0}{1}'.format(self.url, path))
+        log.debug(command)
+
+    def request(self, method='GET', path='/', headers={'Content-Type': 'application/json', 'Accept': 'application/json'}, data=None):
+        self.log_curl_debug(method, path, headers, data)
+        response = requests.request(
+            method=method,
+            url='{0}{1}'.format(self.url, path),
+            headers=headers,
+            data=json.dumps(data),
+            auth=(self.username, self.password),
+            timeout=60)
+        response.raise_for_status()
+        log.debug('Received: {0}'.format(response.json()))
+        return response
+
+    def get(self, path, headers={'Content-Type': 'application/json', 'Accept': 'application/json'}):
+        return self.request('GET', path, headers).json()
+
+    def post(self, path, headers={'Content-Type': 'application/json', 'Accept': 'application/json'}, data=None):
+        return self.request('POST', path, headers, data).json()
+
+    def put(self, path, headers={'Content-Type': 'application/json', 'Accept': 'application/json'}, data=None):
+        return self.request('PUT', path, headers, data).json()
+
+    def delete(self, path, headers={'Content-Type': 'application/json', 'Accept': 'application/json'}):
+        return self.request('DELETE', path, headers).json()
 
 
 from .confluence import Confluence
-from .jira import Jira
+from .jira import Jira
+from .stash import Stash

atlassian/confluence.py

@@ -1,14 +1,35 @@
-from atlassian import Atlassian
+import logging
+from atlassian import AtlassianRestAPI
 
 
-class Confluence(Atlassian):
+logging.basicConfig(level=logging.INFO, format="[%(asctime).19s] [%(levelname)s] %(message)s")
+logging.getLogger("requests").setLevel(logging.WARNING)
+log = logging.getLogger("atlassian.confluence")
+
+
+class Confluence(AtlassianRestAPI):
 
     def create_page(self, space, parent_id, title, body):
-        return self.post("/rest/api/content/", {
+        return self.post("/rest/api/content/", data={
             "type": "page",
-            "title": title,
             "ancestors": [{"type": "page", "id": parent_id}],
+            "title": title,
             "space": {"key": space},
             "body": {"storage": {
                 "value": body,
                 "representation": "storage"}}})
+
+    def history(self, page_id):
+        return self.get("/rest/api/content/{0}/history".format(page_id))
+
+    def update_page(self, parent_id, page_id, title, body, type="page",):
+        version = self.history(page_id)["lastUpdated"]["number"] + 1
+        return self.put("/rest/api/content/{0}".format(page_id), data={
+            "id": page_id,
+            "type": type,
+            "ancestors": [{"type": "page", "id": parent_id}],
+            "title": title,
+            "body": {"storage": {
+                "value": body,
+                "representation": "storage"}},
+            "version": {"number": version}})

atlassian/jira.py

@@ -1,7 +1,13 @@
-from atlassian import Atlassian
+import logging
+from atlassian import AtlassianRestAPI
 
 
-class Jira(Atlassian):
+logging.basicConfig(level=logging.INFO, format="[%(asctime).19s] [%(levelname)s] %(message)s")
+logging.getLogger("requests").setLevel(logging.WARNING)
+log = logging.getLogger("atlassian.jira")
+
+
+class Jira(AtlassianRestAPI):
 
     def reindex_status(self):
         return self.get("/rest/api/2/reindex")
@@ -24,11 +30,14 @@ def project(self, key):
     def issue(self, key):
         return self.get("/rest/api/2/issue/{0}".format(key))
 
+    def update_issue_field(self, key, fields):
+        return self.put("/rest/api/2/issue/{0}".format(key), data={"fields": fields})
+
     def project_leaders(self):
-        for project in self.projects().json():
+        for project in self.projects():
             key = project["key"]
-            project_data = self.project(key).json()
-            lead = self.user(project_data["lead"]["key"]).json()
+            project_data = self.project(key)
+            lead = self.user(project_data["lead"]["key"])
             yield {
                 "project_key": key,
                 "project_name": project["name"],

atlassian/stash.py

@@ -0,0 +1,52 @@
+import logging
+from atlassian import AtlassianRestAPI
+
+
+logging.basicConfig(level=logging.INFO, format="[%(asctime).19s] [%(levelname)s] %(message)s")
+logging.getLogger("requests").setLevel(logging.WARNING)
+log = logging.getLogger("atlassian.stash")
+
+
+class Stash(AtlassianRestAPI):
+
+    def project_list(self):
+        return self.get('/rest/api/1.0/projects')['values']
+
+    def project(self, key):
+        return self.get('/rest/api/1.0/projects/{}'.format(key))['values']
+
+    def project_users(self, key):
+        return self.get('/rest/api/1.0/projects/{}/permissions/users?limit=99999'.format(key))['values']
+
+    def project_users_with_administrator_permissions(self, key):
+        project_administrators = [user['user'] for user in self.project_users(key) if user['permission'] == 'PROJECT_ADMIN']
+
+        for group in self.project_groups_with_administrator_permissions(key):
+            for user in self.group_members(group):
+                project_administrators.append(user)
+
+        return project_administrators
+
+    def project_groups(self, key):
+        return self.get('/rest/api/1.0/projects/{}/permissions/groups?limit=99999'.format(key))['values']
+
+    def project_groups_with_administrator_permissions(self, key):
+        return [group['group']['name'] for group in self.project_groups(key) if group['permission'] == 'PROJECT_ADMIN']
+
+    def project_summary(self, key):
+        return {
+            'key': key,
+            'data': self.project(key),
+            'users': self.project_users(key),
+            'groups': self.project_groups(key)}
+
+    def group_members(self, group):
+        return self.get('/rest/api/1.0/admin/groups/more-members?context={}&limit=99999'.format(group))['values']
+
+    def all_project_administrators(self):
+        for project in self.project_list():
+            log.info("Processing project: {0} - {1}".format(project['key'], project['name']))
+            yield {
+                'project_key': project['key'],
+                'project_name': project['name'],
+                'project_administrators': [{'email': x['emailAddress'], 'name': x['displayName']} for x in self.project_users_with_administrator_permissions(project['key'])]}

examples/confluence-create-page.py

@@ -7,6 +7,9 @@
     username="admin",
     password="admin")
 
-status = confluence.create_page(space="~admin", title="This is the title", body="This is the body")
+status = confluence.create_page(
+    space="DEMO",
+    title="This is the title",
+    body="This is the body")
 
-pprint(status.json())
+pprint(status)

examples/confluence-update-page.py

@@ -0,0 +1,15 @@
+from pprint import pprint
+from atlassian import Confluence
+
+
+confluence = Confluence(
+    url="http://localhost:8090",
+    username="admin",
+    password="admin")
+
+status = confluence.update_page(
+    page_id=123456,
+    title="This is the new title",
+    body="This is the new body")
+
+pprint(status)

examples/jira-jql-query.py

@@ -9,5 +9,5 @@
     username="admin",
     password="admin")
 
-data = jira.jql(JQL).json()
+data = jira.jql(JQL)
 pprint(data)

examples/jira-sprint-rename.py

@@ -13,4 +13,4 @@
     start_date="2014-10-13 11:44",
     end_date="2014-10-20 09:34")
 
-pprint(data.json())
+pprint(data)

examples/stash-project.py

@@ -0,0 +1,18 @@
+from pprint import pprint
+from atlassian import Stash
+
+
+stash = Stash(
+    url='http://localhost:7990',
+    username='admin',
+    password='admin')
+
+data = stash.project_users("DEMO")
+
+
+def html(project):
+    html = '<tr><td>{project_key}</td><td>{project_name}</td><td><ul>'.format(**project)
+    for user in project['project_administrators']:
+        html += '\n\t<li><a href="mailto:{email}">{name}</a></li>'.format(**user)
+    return html + '</ul></td></tr>\n'
+

examples/stash-projects-administrators.py

@@ -0,0 +1,24 @@
+import logging
+from atlassian import Stash
+
+
+logging.basicConfig(level=logging.DEBUG, format='[%(asctime).19s] [%(levelname)s] %(message)s')
+logging.getLogger('requests').setLevel(logging.WARNING)
+log = logging.getLogger('stash-projects-administrators')
+
+stash = Stash(
+    url='http://localhost:7990',
+    username='admin',
+    password='admin')
+
+html = '<table><tr><th>Project Key</th><th>Project Name</th><th>Administrator</th></tr>'
+
+for data in stash.all_project_administrators():
+    html += '<tr><td>{project_key}</td><td>{project_name}</td><td><ul>'.format(**data)
+    for user in data['project_administrators']:
+        html += '<li><a href="mailto:{email}">{name}</a></li>'.format(**user)
+    html += '</ul></td></tr>'
+
+html += '</table><p></p><p></p>'
+
+print(html)

setup.py

@@ -2,13 +2,13 @@
 from setuptools import setup
 
 
-assert sys.version_info >= (2, 7), "Python 2.7+ required."
+assert sys.version_info >= (3, 0), "Python 3.0+ required."
 
 setup(
     name="atlassian-python-api",
     description="Atlassian Python API",
     license="Apache License 2.0",
-    version="0.3.3",
+    version="0.6.3",
     download_url="https://github.com/MattAgile/atlassian-python-api",
 
     author="Matt Harasymczuk",
@@ -21,7 +21,7 @@
     include_package_data=True,
 
     zip_safe=False,
-    install_requires=["requests==2.4.3"],
+    install_requires=["requests==2.5.3"],
 
     classifiers=[
         "Development Status :: 4 - Beta",
@@ -36,6 +36,10 @@
         "Operating System :: Microsoft :: Windows",
         "Programming Language :: Python",
         "Programming Language :: Python :: 3",
+        "Programming Language :: Python :: 3.0",
+        "Programming Language :: Python :: 3.1",
+        "Programming Language :: Python :: 3.2",
+        "Programming Language :: Python :: 3.3",
         "Programming Language :: Python :: 3.4",
         "Topic :: Internet",
         "Topic :: Internet :: WWW/HTTP",