-
Notifications
You must be signed in to change notification settings - Fork 32
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'master' into privileged_ldap
- Loading branch information
Showing
22 changed files
with
705 additions
and
309 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,83 @@ | ||
"""Print Kanboard task information.""" | ||
import json | ||
from collections import namedtuple | ||
|
||
import requests | ||
|
||
|
||
KANBOARD_ROOT = 'https://kanboard.ocf.berkeley.edu' | ||
|
||
|
||
def request(usr, api_key, method, params): | ||
"""Sends a request to the Kanboard API in JSON-RPC 2.0 format.""" | ||
# The purpose of id is to be able to reorder responses to asynchronous, | ||
# batched requests. Any valid integer is OK here, since we're just making | ||
# one simple request. | ||
payload = json.dumps({'jsonrpc': '2.0', 'method': method, 'id': 1, 'params': params}) | ||
return requests.post( | ||
'{}/jsonrpc.php'.format(KANBOARD_ROOT), | ||
data=payload, | ||
auth=(usr, api_key), | ||
timeout=10, | ||
) | ||
|
||
|
||
class KanboardError(ValueError): | ||
pass | ||
|
||
|
||
class KanboardTask(namedtuple('KanboardTask', ('number', 'title', 'creator', 'project'))): | ||
"""A namedtuple representing a Kanboard task.""" | ||
|
||
def __str__(self): | ||
return ( | ||
'k#{self.number}: "{self.title}" | ' | ||
'{self.project}, started by {self.creator} | ' | ||
'https://ocf.io/k/{self.number}' | ||
).format(self=self) | ||
|
||
@classmethod | ||
def from_number(cls, usr, api_key, num): | ||
"""Gets information about a Kanboard task based on its number. | ||
Example usage: | ||
KanboardTask.from_number('jsonrpc', | ||
'19ffd9709d03ce50675c3a43d1c49c1ac207f4bc45f06c5b2701fbdf8929', 1) | ||
:param usr: either the Kanboard username corresponding to the api key for a user | ||
api key or 'jsonrpc' for the application api key | ||
:param api_key: a user api key (which can be found under My profile -> Actions -> API) or the | ||
application api key (which only admins can see) | ||
""" | ||
|
||
task_resp = request(usr, api_key, 'getTask', {'task_id': num}) | ||
if task_resp.status_code != 200: | ||
raise KanboardError( | ||
'Task request gave {}'.format(task_resp.status_code) | ||
) | ||
|
||
task = task_resp.json()['result'] | ||
|
||
users_resp = request(usr, api_key, 'getProjectUsers', {'project_id': task['project_id']}) | ||
if users_resp.status_code != 200: | ||
raise KanboardError( | ||
'Project request gave {}'.format(users_resp.status_code) | ||
) | ||
|
||
users = users_resp.json()['result'] | ||
|
||
proj_resp = request(usr, api_key, 'getProjectById', {'project_id': task['project_id']}) | ||
if proj_resp.status_code != 200: | ||
raise KanboardError( | ||
'Project request gave {}'.format(proj_resp.status_code) | ||
) | ||
|
||
proj = proj_resp.json()['result'] | ||
|
||
return cls( | ||
number=task['id'], | ||
title=task['title'], | ||
creator=users[task['creator_id']], | ||
project=proj['name'], | ||
) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.