Merge pull request #228 from mistermoper/fb-boards

#227 | Boards integration

Author: lesstif

src/Board/Board.php

@@ -0,0 +1,76 @@
+<?php
+
+namespace JiraRestApi\Board;
+
+use JiraRestApi\ClassSerialize;
+
+class Board implements \JsonSerializable
+{
+    use ClassSerialize;
+
+    /** @var int */
+    public $id;
+
+    /** @var string */
+    public $self;
+
+    /** @var string */
+    public $name;
+
+    /** @var string */
+    public $type;
+
+    /**
+     * Location [\JiraRestApi\Board\Location].
+     *
+     * @var \JiraRestApi\Board\Location
+     */
+    public $location;
+
+    /**
+     * Get board id.
+     */
+    public function getId()
+    {
+        return $this->id;
+    }
+
+    /**
+     * Get board url.
+     */
+    public function getSelf()
+    {
+        return $this->self;
+    }
+
+    /**
+     * Get board name.
+     */
+    public function getName()
+    {
+        return $this->name;
+    }
+
+    /**
+     * Get board type.
+     */
+    public function getType()
+    {
+        return $this->type;
+    }
+
+    /**
+     * Get location.
+     */
+    public function getLocation()
+    {
+        return $this->location;
+    }
+
+    public function jsonSerialize()
+    {
+        return array_filter(get_object_vars($this), function ($var) {
+            return !is_null($var);
+        });
+    }
+}

src/Board/BoardService.php

@@ -0,0 +1,56 @@
+<?php
+
+namespace JiraRestApi\Board;
+
+use JiraRestApi\Configuration\ConfigurationInterface;
+use JiraRestApi\Issue\Issue;
+
+class BoardService extends \JiraRestApi\JiraClient
+{
+    private $uri = '/board';
+
+    public function __construct(ConfigurationInterface $configuration = null, Logger $logger = null, $path = './')
+    {
+        parent::__construct($configuration, $logger, $path);
+        $this->setAPIUri('/rest/agile/1.0');
+    }
+
+    /**
+     * get all project list.
+     *
+     * @param array $paramArray
+     *
+     * @throws \JiraRestApi\JiraException
+     *
+     * @return Project[] array of Project class
+     */
+    public function getBoardList($paramArray = [])
+    {
+        $json = $this->exec($this->uri.$this->toHttpQueryParameter($paramArray), null);
+        $boards = $this->json_mapper->mapArray(
+            json_decode($json)->values, new \ArrayObject(), Board::class
+        );
+
+        return $boards;
+    }
+
+    public function getBoard($id, $paramArray = [])
+    {
+        $json = $this->exec($this->uri.'/'.$id.$this->toHttpQueryParameter($paramArray), null);
+        $board = $this->json_mapper->map(
+            json_decode($json), new Board()
+        );
+
+        return $board;
+    }
+
+    public function getBoardIssues($id, $paramArray = [])
+    {
+        $json = $this->exec($this->uri.'/'.$id.'/issue'.$this->toHttpQueryParameter($paramArray), null);
+        $board = $this->json_mapper->mapArray(
+            json_decode($json)->issues, new \ArrayObject(), Issue::class
+        );
+
+        return $board;
+    }
+}

src/Board/Location.php

@@ -0,0 +1,93 @@
+<?php
+
+namespace JiraRestApi\Board;
+
+class Location implements \JsonSerializable
+{
+    /** @var int * */
+    public $projectId;
+
+    /** @var string * */
+    public $displayName;
+
+    /** @var string * */
+    public $projectName;
+
+    /** @var string * */
+    public $projectKey;
+
+    /** @var string * */
+    public $projectTypeKey;
+
+    /** @var string * */
+    public $avatarUri;
+
+    /** @var string * */
+    public $name;
+
+    /**
+     * Get project id.
+     */
+    public function getProjectId()
+    {
+        return $this->projectId;
+    }
+
+    /**
+     * Get project id.
+     */
+    public function getDisplayName()
+    {
+        return $this->displayName;
+    }
+
+    /**
+     * Get project name.
+     */
+    public function getProjectName()
+    {
+        return $this->projectName;
+    }
+
+    /**
+     * Get project key.
+     */
+    public function getProjectKey()
+    {
+        return $this->projectKey;
+    }
+
+    /**
+     * Get project type key.
+     */
+    public function getProjectTypeKey()
+    {
+        return $this->projectTypeKey;
+    }
+
+    /**
+     * Get avatar uri.
+     */
+    public function getAvatarUri()
+    {
+        return $this->avatarUri;
+    }
+
+    /**
+     * Get name.
+     */
+    public function getName()
+    {
+        return $this->name;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function jsonSerialize()
+    {
+        return array_filter(get_object_vars($this), function ($var) {
+            return !is_null($var);
+        });
+    }
+}

tests/BoardTest.php

@@ -0,0 +1,61 @@
+<?php
+
+use JiraRestApi\Board\BoardService;
+use JiraRestApi\Board\Board;
+use JiraRestApi\Board\Location;
+use JiraRestApi\Issue\Issue;
+
+/**
+ * Test agile boards integration.
+ */
+class BoardTest extends PHPUnit_Framework_TestCase
+{
+
+    /**
+     * Test we can obtain the board list.
+     */
+    public function testGetBoards()
+    {
+        $board_service = new BoardService();
+
+        $board_list = $board_service->getBoardList();
+        $this->assertInstanceOf(ArrayObject::class, $board_list, 'We receive a board list.');
+        /** @var \JiraRestApi\Board\Board $first_board */
+        $first_board = reset($board_list);
+        $this->assertInstanceOf(Board::class, $first_board, 'Each element of the list is a Board instance.');
+
+    }
+
+    /**
+     * Test we can obtain a single board.
+     */
+    public function testGetBoard()
+    {
+        $board_service = new BoardService();
+
+        $board = $board_service->getBoard(42);
+
+        /** @var \JiraRestApi\Board\Board $board */
+        $this->assertInstanceOf(Board::class, $board, 'We receive a board instance');
+        $this->assertNotEmpty($board->getId(), 'Check board id.');
+        $this->assertNotEmpty($board->getName(), 'Check board name.');
+        $this->assertNotEmpty($board->getType(), 'Check board type.');
+        $this->assertNotEmpty($board->getSelf(), 'Check board self.');
+        $this->assertInstanceOf(Location::class, $board->getLocation(), 'Check board location.');
+
+    }
+
+    /**
+     * Test we can obtain board issues.
+     */
+    public function testGetBoardIssues()
+    {
+        $board_service = new BoardService();
+        $board_issues = $board_service->getBoardIssues(42);
+        $this->assertInstanceOf(ArrayObject::class, $board_issues, 'We receive a board issue list.');
+        $first_issue = reset($board_issues);
+        $this->assertInstanceOf(Issue::class, $first_issue);
+        $this->assertNotEmpty($first_issue->id);
+    }
+
+}