feat(project): Adding fetching roles datas for a project (#98)

* feat(project): Add a function to get all project roles

* feat(role): Get project role id info

* fix: Fix StyleCI

Author: RomainMILLAN

README.md

@@ -124,6 +124,8 @@ $iss = new IssueService(new ArrayConfiguration(
 - [Get Project Components](#get-project-components)
 - [Get Project Type](#get-project-type)
 - [Get Project Version](#get-project-version)
+- [Get Project Roles](#get-project-roles)
+- [Get Project Role](#get-project-role)
 
 ### Custom Field
 - [Get All Field list](#get-all-field-list)
@@ -490,6 +492,51 @@ try {
 
 ```
 
+#### Get Project Roles
+
+[See Jira API reference](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-project-roles/#api-rest-api-3-project-projectidorkey-role-get)
+
+```php
+<?php
+require 'vendor/autoload.php';
+
+use JiraCloud\Project\ProjectService;
+use JiraCloud\JiraException;
+
+try {
+    $projectService = new ProjectService();
+
+    // return project roles list. 
+    $ret = $projectService->getProjectRoles('TEST'); 
+    	
+    var_dump($ret);
+} catch (JiraCloud\JiraException $e) {
+	print('Error Occurred! ' . $e->getMessage());
+}
+```
+
+#### Get Project Role
+
+[See Jira API reference](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-project-roles/#api-rest-api-3-project-projectidorkey-role-id-get)
+
+```php
+<?php
+require 'vendor/autoload.php';
+
+use JiraCloud\Project\ProjectService;
+use JiraCloud\JiraException;
+
+try {
+    $projectService = new ProjectService();
+
+    // return project role data with reporter assigned. 
+    $ret = $projectService->getProjectRoles('TEST', '1'); 
+    	
+    var_dump($ret);
+} catch (JiraCloud\JiraException $e) {
+	print('Error Occurred! ' . $e->getMessage());
+}
+```
 
 #### Get All Field List
 

src/Project/ProjectService.php

@@ -7,6 +7,7 @@
 use JiraCloud\Issue\Reporter;
 use JiraCloud\Issue\Version;
 use JiraCloud\JiraException;
+use JiraCloud\Role\Role;
 
 class ProjectService extends \JiraCloud\JiraClient
 {
@@ -392,4 +393,61 @@ public function archiveProject($projectIdOrKey)
 
         return $ret;
     }
+
+    /**
+     * @param $projectIdOrKey
+     *
+     * @throws JiraException
+     *
+     * @return array<string, string>
+     *
+     * STATUS 401 Returned if the user is not logged in.
+     * STATUS 404 - Returned if the project does not exist.
+     */
+    public function getProjectRoles($projectIdOrKey)
+    {
+        $response = $this->exec($this->uri.'/'.$projectIdOrKey.'/role');
+
+        $this->log->info('getProjectRoles Result='.$response);
+
+        return (array) json_decode($response);
+    }
+
+    /**
+     * @param $projectIdOrKey
+     * @param $roleId
+     *
+     * @throws JiraException
+     *
+     * @return Role
+     *
+     * STATUS 401 Returned if the user is not logged in.
+     * STATUS 404 - Returned if the project does not exist.
+     */
+    public function getProjectRole($projectIdOrKey, $roleId, $excludeInactiveUsers = false)
+    {
+        $response = $this->exec($this->uri.'/'.$projectIdOrKey.'/role/'.$roleId.'?excludeInactiveUsers='.$excludeInactiveUsers);
+
+        $this->log->info('getProjectRole Result='.$response);
+
+        $reporters = array_map(
+            function ($elem) {
+                $reporter = $this->json_mapper->map($elem, new Reporter());
+                $reporter->accountId = $elem->actorUser->accountId;
+
+                return $reporter;
+            },
+            array_filter(json_decode($response)->actors, function ($elem) {
+                return $elem->type === 'atlassian-user-role-actor';
+            }),
+        );
+
+        $role = $this->json_mapper->map(
+            json_decode($response),
+            new Role()
+        );
+        $role->actors = $reporters;
+
+        return $role;
+    }
 }

src/Role/Role.php

@@ -0,0 +1,16 @@
+<?php
+
+namespace JiraCloud\Role;
+
+use JiraCloud\ClassSerialize;
+
+class Role
+{
+    use ClassSerialize;
+
+    public string $name;
+    public int $id;
+    public string $description;
+    public string $self;
+    public array $actors;
+}

tests/ProjectTest.php

@@ -7,6 +7,7 @@
 use JiraCloud\JiraException;
 use JiraCloud\Project\Project;
 use JiraCloud\Project\ProjectType;
+use JiraCloud\Role\Role;
 use PHPUnit\Framework\TestCase;
 use JiraCloud\Project\ProjectService;
 
@@ -202,4 +203,54 @@ public function get_unknown_project_type_expect_to_JiraException(string $projKey
 
         return $projKey;
     }
+
+    /**
+     * @test
+     * @depends get_project_lists
+     */
+    public function get_project_roles_array(string $projKey): array
+    {
+        try {
+            $projectService = new ProjectService();
+
+            $roles = $projectService->getProjectRoles($projKey);
+
+            $this->assertIsArray($roles);
+
+            $parts = explode('/', rtrim(array_shift($roles), '/'));
+            $roleId = end($parts);
+        } catch (JiraException $e) {
+            $this->fail('get_project_roles_array ' . $e->getMessage());
+        }
+
+        return ['projKey' => 'JUL', 'roleId' => $roleId];
+    }
+
+    /**
+     * @test
+     * @depends get_project_roles_array
+     * @param array<string, string> $datas
+     *      projKey: project key
+     *      roleId: role id
+     *
+     * @return string
+     * @throws \JsonMapper_Exception
+     */
+    public function get_project_role(array $datas): string
+    {
+        try {
+            $projectService = new ProjectService();
+
+            $role = $projectService->getProjectRole($datas['projKey'], $datas['roleId'], true);
+
+            self::assertInstanceOf(Role::class, $role);
+            self::assertIsString($role->name);
+            self::assertIsString($role->description);
+            self::assertIsInt($role->id);
+        } catch (JiraException $e) {
+            $this->fail('get_project_role ' . $e->getMessage());
+        }
+
+        return '$projKey';
+    }
 }