Adding an function to get the column board configuration (#94)

* feat: Adding board configuration api to get column board configuration

* fix: CI style ci fix

---------

Co-authored-by: Romain MILLAN <rmillan@spiriit.com>

Author: RomainMILLAN

src/Board/BoardColumn.php

@@ -0,0 +1,13 @@
+<?php
+
+namespace JiraCloud\Board;
+
+class BoardColumn implements \JsonSerializable
+{
+    use \JiraCloud\JsonSerializableTrait;
+
+    public string $name;
+    public ?int $max = null;
+    public ?int $min = null;
+    public array $statuses = [];
+}

src/Board/BoardColumnConfig.php

@@ -0,0 +1,12 @@
+<?php
+
+namespace JiraCloud\Board;
+
+class BoardColumnConfig implements \JsonSerializable
+{
+    use \JiraCloud\JsonSerializableTrait;
+
+    /** @var BoardColumn[] */
+    public array $columns;
+    public string $constraintType;
+}

src/Board/BoardService.php

@@ -14,7 +14,7 @@ class BoardService extends \JiraCloud\JiraClient
 
     private $agileVersion = '1.0';
 
-    public function __construct(ConfigurationInterface $configuration = null, LoggerInterface $logger = null, $path = './')
+    public function __construct(?ConfigurationInterface $configuration = null, ?LoggerInterface $logger = null, $path = './')
     {
         parent::__construct($configuration, $logger, $path);
         $this->setAPIUri('/rest/agile/'.$this->agileVersion);
@@ -141,4 +141,20 @@ public function getBoardEpics($boardId, $paramArray = []): ?\ArrayObject
             return null;
         }
     }
+
+    public function getBoardColumnConfiguration($boardId, $paramArray = []): ?BoardColumnConfig
+    {
+        $json = $this->exec($this->uri.'/'.$boardId.'/configuration'.$this->toHttpQueryParameter($paramArray), null);
+
+        try {
+            return $this->json_mapper->map(
+                json_decode($json, false, 512, $this->getJsonOptions())->columnConfig,
+                BoardColumnConfig::class
+            );
+        } catch (\JsonException $exception) {
+            $this->log->error("Response cannot be decoded from json\nException: {$exception->getMessage()}");
+
+            return null;
+        }
+    }
 }

tests/BoardTest.php

@@ -3,6 +3,8 @@
 namespace JiraCloud\Test;
 
 use ArrayObject;
+use JiraCloud\Board\BoardColumn;
+use JiraCloud\Board\BoardColumnConfig;
 use PHPUnit\Framework\TestCase;
 use JiraCloud\Board\BoardService;
 use JiraCloud\Board\Board;
@@ -83,4 +85,21 @@ public function testGetBoardIssues(string $last_board_id)
         }
     }
 
+    /**
+     * @test
+     *
+     * @depends get_last_board
+     * Test can get board column configuration
+     */
+    public function get_board_configuration(string $last_board_id): void
+    {
+        $board_service = new BoardService();
+        $board_column_configuration = $board_service->getBoardColumnConfiguration($last_board_id);
+
+        $this->assertInstanceOf(BoardColumnConfig::class, $board_column_configuration);
+        $this->assertIsArray($board_column_configuration->columns);
+        $this->assertInstanceOf(BoardColumn::class, $board_column_configuration->columns[0]);
+        $this->assertIsString($board_column_configuration->constraintType);
+    }
+
 }