AS1024/Kanboard-Prod
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Add urls in api response for tasks and projects

Browse Source
This commit is contained in:
Frederic Guillot
2015-07-05 14:10:03 -04:00
parent afab68b130
commit 67b9a56469
4 changed files with 122 additions and 29 deletions
Download Patch File Download Diff File Expand all files Collapse all files

30
app/Api/Project.php
View File

@@ -12,17 +12,17 @@ class Project extends Base
{ {
public function getProjectById($project_id) public function getProjectById($project_id)
{ {
return $this->project->getById($project_id); return $this->formatProject($this->project->getById($project_id));
} }
public function getProjectByName($name) public function getProjectByName($name)
{ {
return $this->project->getByName($name); return $this->formatProject($this->project->getByName($name));
} }
public function getAllProjects() public function getAllProjects()
{ {
return $this->project->getAll(); return $this->formatProjects($this->project->getAll());
} }
public function removeProject($project_id) public function removeProject($project_id)
@@ -82,4 +82,28 @@ class Project extends Base
list($valid,) = $this->project->validateModification($values); list($valid,) = $this->project->validateModification($values);
return $valid && $this->project->update($values); return $valid && $this->project->update($values);
} }
private function formatProject($project)
{
if (! empty($project)) {
$project['url'] = array(
'board' => $this->helper->url->base().$this->helper->url->to('board', 'show', array('project_id' => $project['id'])),
'calendar' => $this->helper->url->base().$this->helper->url->to('calendar', 'show', array('project_id' => $project['id'])),
'list' => $this->helper->url->base().$this->helper->url->to('listing', 'show', array('project_id' => $project['id'])),
);
}
return $project;
}
private function formatProjects($projects)
{
if (! empty($projects)) {
foreach ($projects as &$project) {
$project = $this->formatProject($project);
}
}
return $projects;
}
} }

26
app/Api/Task.php
View File

@@ -14,17 +14,17 @@ class Task extends Base
{ {
public function getTask($task_id) public function getTask($task_id)
{ {
return $this->taskFinder->getById($task_id); return $this->formatTask($this->taskFinder->getById($task_id));
} }
public function getTaskByReference($project_id, $reference) public function getTaskByReference($project_id, $reference)
{ {
return $this->taskFinder->getByReference($project_id, $reference); return $this->formatTask($this->taskFinder->getByReference($project_id, $reference));
} }
public function getAllTasks($project_id, $status_id = TaskModel::STATUS_OPEN) public function getAllTasks($project_id, $status_id = TaskModel::STATUS_OPEN)
{ {
return $this->taskFinder->getAll($project_id, $status_id); return $this->formatTasks($this->taskFinder->getAll($project_id, $status_id));
} }
public function getOverdueTasks() public function getOverdueTasks()
@@ -115,4 +115,24 @@ class Task extends Base
list($valid) = $this->taskValidator->validateApiModification($values); list($valid) = $this->taskValidator->validateApiModification($values);
return $valid && $this->taskModification->update($values); return $valid && $this->taskModification->update($values);
} }
private function formatTask($task)
{
if (! empty($task)) {
$task['url'] = $this->helper->url->base().$this->helper->url->to('task', 'show', array('task_id' => $task['id'], 'project_id' => $task['project_id']));
}
return $task;
}
private function formatTasks($tasks)
{
if (! empty($tasks)) {
foreach ($tasks as &$task) {
$task = $this->formatTask($task);
}
}
return $tasks;
}
} }

71
docs/api-json-rpc.markdown
View File

@@ -306,9 +306,19 @@ Response example:
"name": "API test", "name": "API test",
"is_active": "1", "is_active": "1",
"token": "", "token": "",
"last_modified": "1410263246", "last_modified": "1436119135",
"is_public": "0", "is_public": "0",
"description": "A sample project" "is_private": "0",
"is_everybody_allowed": "0",
"default_swimlane": "Default swimlane",
"show_default_swimlane": "1",
"description": "test",
"identifier": "",
"url": {
"board": "http:\/\/127.0.0.1:8000\/?controller=board&action=show&project_id=1",
"calendar": "http:\/\/127.0.0.1:8000\/?controller=calendar&action=show&project_id=1",
"list": "http:\/\/127.0.0.1:8000\/?controller=listing&action=show&project_id=1"
}
} }
} }
``` ```
@@ -345,9 +355,19 @@ Response example:
"name": "Test", "name": "Test",
"is_active": "1", "is_active": "1",
"token": "", "token": "",
"last_modified": "0", "last_modified": "1436119135",
"is_public": "0", "is_public": "0",
"description": "A sample project" "is_private": "0",
"is_everybody_allowed": "0",
"default_swimlane": "Default swimlane",
"show_default_swimlane": "1",
"description": "test",
"identifier": "",
"url": {
"board": "http:\/\/127.0.0.1:8000\/?controller=board&action=show&project_id=1",
"calendar": "http:\/\/127.0.0.1:8000\/?controller=calendar&action=show&project_id=1",
"list": "http:\/\/127.0.0.1:8000\/?controller=listing&action=show&project_id=1"
}
} }
} }
``` ```
@@ -366,7 +386,7 @@ Request example:
{ {
"jsonrpc": "2.0", "jsonrpc": "2.0",
"method": "getAllProjects", "method": "getAllProjects",
"id": 134982303 "id": 2134420212
} }
``` ```
@@ -375,25 +395,26 @@ Response example:
```json ```json
{ {
"jsonrpc": "2.0", "jsonrpc": "2.0",
"id": 134982303, "id": 2134420212,
"result": [ "result": [
{
"id": "2",
"name": "PHP client",
"is_active": "1",
"token": "",
"last_modified": "0",
"is_public": "0",
"description": "PHP client project"
},
{ {
"id": "1", "id": "1",
"name": "Test", "name": "API test",
"is_active": "1", "is_active": "1",
"token": "", "token": "",
"last_modified": "0", "last_modified": "1436119570",
"is_public": "0", "is_public": "0",
"description": "Test project" "is_private": "0",
"is_everybody_allowed": "0",
"default_swimlane": "Default swimlane",
"show_default_swimlane": "1",
"description": null,
"identifier": "",
"url": {
"board": "http:\/\/127.0.0.1:8000\/?controller=board&action=show&project_id=1",
"calendar": "http:\/\/127.0.0.1:8000\/?controller=calendar&action=show&project_id=1",
"list": "http:\/\/127.0.0.1:8000\/?controller=listing&action=show&project_id=1"
}
} }
] ]
} }
@@ -1970,8 +1991,9 @@ Response example:
"recurrence_timeframe": "0", "recurrence_timeframe": "0",
"recurrence_basedate": "0", "recurrence_basedate": "0",
"recurrence_parent": null, "recurrence_parent": null,
"recurrence_child": null "recurrence_child": null,
} "url": "http:\/\/127.0.0.1:8000\/?controller=task&action=show&task_id=1&project_id=1"
}
} }
``` ```
@@ -2033,7 +2055,8 @@ Response example:
"recurrence_timeframe": "0", "recurrence_timeframe": "0",
"recurrence_basedate": "0", "recurrence_basedate": "0",
"recurrence_parent": null, "recurrence_parent": null,
"recurrence_child": null "recurrence_child": null,
"url": "http:\/\/127.0.0.1:8000\/?controller=task&action=show&task_id=5&project_id=1"
} }
} }
``` ```
@@ -2097,7 +2120,8 @@ Response example:
"recurrence_timeframe": "0", "recurrence_timeframe": "0",
"recurrence_basedate": "0", "recurrence_basedate": "0",
"recurrence_parent": null, "recurrence_parent": null,
"recurrence_child": null "recurrence_child": null,
"url": "http:\/\/127.0.0.1:8000\/?controller=task&action=show&task_id=1&project_id=1"
}, },
{ {
"id": "2", "id": "2",
@@ -2128,7 +2152,8 @@ Response example:
"recurrence_timeframe": "0", "recurrence_timeframe": "0",
"recurrence_basedate": "0", "recurrence_basedate": "0",
"recurrence_parent": null, "recurrence_parent": null,
"recurrence_child": null "recurrence_child": null,
"url": "http:\/\/127.0.0.1:8000\/?controller=task&action=show&task_id=2&project_id=1"
}, },
... ...
] ]

24
tests/functionals/ApiTest.php
View File

@@ -63,6 +63,9 @@ class Api extends PHPUnit_Framework_TestCase
if ($projects) { if ($projects) {
foreach ($projects as $project) { foreach ($projects as $project) {
$this->assertEquals('http://127.0.0.1:8000/?controller=board&action=show&project_id='.$project['id'], $project['url']['board']);
$this->assertEquals('http://127.0.0.1:8000/?controller=calendar&action=show&project_id='.$project['id'], $project['url']['calendar']);
$this->assertEquals('http://127.0.0.1:8000/?controller=listing&action=show&project_id='.$project['id'], $project['url']['list']);
$this->assertTrue($this->client->removeProject($project['id'])); $this->assertTrue($this->client->removeProject($project['id']));
} }
} }
@@ -80,6 +83,9 @@ class Api extends PHPUnit_Framework_TestCase
$project = $this->client->getProjectById(1); $project = $this->client->getProjectById(1);
$this->assertNotEmpty($project); $this->assertNotEmpty($project);
$this->assertEquals(1, $project['id']); $this->assertEquals(1, $project['id']);
$this->assertEquals('http://127.0.0.1:8000/?controller=board&action=show&project_id='.$project['id'], $project['url']['board']);
$this->assertEquals('http://127.0.0.1:8000/?controller=calendar&action=show&project_id='.$project['id'], $project['url']['calendar']);
$this->assertEquals('http://127.0.0.1:8000/?controller=listing&action=show&project_id='.$project['id'], $project['url']['list']);
} }
public function testGetProjectByName() public function testGetProjectByName()
@@ -87,6 +93,9 @@ class Api extends PHPUnit_Framework_TestCase
$project = $this->client->getProjectByName('API test'); $project = $this->client->getProjectByName('API test');
$this->assertNotEmpty($project); $this->assertNotEmpty($project);
$this->assertEquals(1, $project['id']); $this->assertEquals(1, $project['id']);
$this->assertEquals('http://127.0.0.1:8000/?controller=board&action=show&project_id='.$project['id'], $project['url']['board']);
$this->assertEquals('http://127.0.0.1:8000/?controller=calendar&action=show&project_id='.$project['id'], $project['url']['calendar']);
$this->assertEquals('http://127.0.0.1:8000/?controller=listing&action=show&project_id='.$project['id'], $project['url']['list']);
$project = $this->client->getProjectByName(array('name' => 'API test')); $project = $this->client->getProjectByName(array('name' => 'API test'));
$this->assertNotEmpty($project); $this->assertNotEmpty($project);
@@ -97,6 +106,18 @@ class Api extends PHPUnit_Framework_TestCase
$this->assertNull($project); $this->assertNull($project);
} }
public function testGetAllProjects()
{
$projects = $this->client->getAllProjects();
$this->assertNotEmpty($projects);
foreach ($projects as $project) {
$this->assertEquals('http://127.0.0.1:8000/?controller=board&action=show&project_id='.$project['id'], $project['url']['board']);
$this->assertEquals('http://127.0.0.1:8000/?controller=calendar&action=show&project_id='.$project['id'], $project['url']['calendar']);
$this->assertEquals('http://127.0.0.1:8000/?controller=listing&action=show&project_id='.$project['id'], $project['url']['list']);
}
}
public function testUpdateProject() public function testUpdateProject()
{ {
$project = $this->client->getProjectById(1); $project = $this->client->getProjectById(1);
@@ -385,6 +406,7 @@ class Api extends PHPUnit_Framework_TestCase
$this->assertNotFalse($task); $this->assertNotFalse($task);
$this->assertTrue(is_array($task)); $this->assertTrue(is_array($task));
$this->assertEquals('Task #1', $task['title']); $this->assertEquals('Task #1', $task['title']);
$this->assertEquals('http://127.0.0.1:8000/?controller=task&action=show&task_id='.$task['id'].'&project_id='.$task['project_id'], $task['url']);
} }
public function testGetAllTasks() public function testGetAllTasks()
@@ -394,6 +416,7 @@ class Api extends PHPUnit_Framework_TestCase
$this->assertNotFalse($tasks); $this->assertNotFalse($tasks);
$this->assertTrue(is_array($tasks)); $this->assertTrue(is_array($tasks));
$this->assertEquals('Task #1', $tasks[0]['title']); $this->assertEquals('Task #1', $tasks[0]['title']);
$this->assertEquals('http://127.0.0.1:8000/?controller=task&action=show&task_id='.$tasks[0]['id'].'&project_id='.$tasks[0]['project_id'], $tasks[0]['url']);
$tasks = $this->client->getAllTasks(2, 0); $tasks = $this->client->getAllTasks(2, 0);
@@ -1030,5 +1053,6 @@ class Api extends PHPUnit_Framework_TestCase
$this->assertNotEmpty($task); $this->assertNotEmpty($task);
$this->assertEquals('Task with external ticket number', $task['title']); $this->assertEquals('Task with external ticket number', $task['title']);
$this->assertEquals('TICKET-1234', $task['reference']); $this->assertEquals('TICKET-1234', $task['reference']);
$this->assertEquals('http://127.0.0.1:8000/?controller=task&action=show&task_id='.$task['id'].'&project_id='.$task['project_id'], $task['url']);
} }
} }