find users, find assignable users

Author: lesstif

README.md

@@ -122,6 +122,8 @@ $iss = new IssueService(new ArrayConfiguration(
 
 ### User
 - [Get User Info](#get-user-info)
+- [Find Users](#find-users)
+- [Find Assignable Users](#find-assignable-users)
 
 ### Group
 - [Create Group](#create-group)
@@ -932,6 +934,66 @@ try {
 
 ```
 
+#### Find Users
+
+Returns a list of users that match the search string and/or property. 
+
+```php
+<?php
+require 'vendor/autoload.php';
+
+use JiraRestApi\JiraException;
+use JiraRestApi\User\UserService;
+
+try {
+    $us = new UserService();
+
+    $paramArray = [
+        'username' => '.', // get all users. 
+        'startAt' => 0,
+        'maxResults' => 1000,
+        'includeInactive' => true,
+        //'property' => '*',
+        ];
+
+    // get the user info.
+    $users = $us->findUsers($paramArray);
+} catch (JiraException $e) {
+	print("Error Occured! " . $e->getMessage());
+}
+
+```
+
+#### Find Assignable Users
+
+Returns a list of users that match the search string. 
+
+```php
+<?php
+require 'vendor/autoload.php';
+
+use JiraRestApi\JiraException;
+use JiraRestApi\User\UserService;
+
+try {
+    $us = new UserService();
+
+    $paramArray = [
+        //'username' => null,
+        'project' => 'TEST',
+        //'issueKey' => 'TEST-1',
+        'startAt' => 0,
+        'maxResults' => 50, //max 1000
+        //'actionDescriptorId' => 1,
+    ];
+
+    $users = $us->findAssignableUsers($paramArray);
+} catch (JiraException $e) {
+	print("Error Occured! " . $e->getMessage());
+}
+
+```
+
 #### Create Group
 
 Create new group.

src/User/UserService.php

@@ -21,7 +21,7 @@ class UserService extends \JiraRestApi\JiraClient
      */
     public function get($paramArray)
     {
-        $queryParam = '?'.http_build_query($paramArray);
+        $queryParam = '?' . http_build_query($paramArray);
 
         $ret = $this->exec($this->uri.$queryParam, null);
 
@@ -32,11 +32,49 @@ public function get($paramArray)
         );
     }
 
-    public function search($paramArray)
+    /**
+     * Returns a list of users that match the search string and/or property.
+     *
+     * @param $paramArray
+     * @return array
+     * @throws \JiraRestApi\JiraException
+     * @throws \JsonMapper_Exception
+     */
+    public function findUsers($paramArray)
+    {
+        $queryParam = '?' . http_build_query($paramArray);
+
+        $ret = $this->exec($this->uri . '/search' . $queryParam, null);
+
+        $this->log->addInfo("Result=\n".$ret);
+
+        $userData = json_decode($ret);
+        $users = [];
+
+        foreach($userData as $user) {
+            $users[] = $this->json_mapper->map(
+                $user, new User()
+            );
+        }
+        return $users;
+    }
+
+    /**
+     * Returns a list of users that match the search string.
+     * Please note that this resource should be called with an issue key when a list of assignable users is retrieved for editing.
+     *
+     * @param $paramArray
+     * @return array
+     * @throws \JiraRestApi\JiraException
+     * @throws \JsonMapper_Exception
+     *
+     * @see https://docs.atlassian.com/jira/REST/cloud/#api/2/user-findAssignableUsers
+     */
+    public function findAssignableUsers($paramArray)
     {
-        $queryParam = '?'.http_build_query($paramArray);
+        $queryParam = '?' . http_build_query($paramArray);
 
-        $ret = $this->exec($this->uri.'/search'.$queryParam, null);
+        $ret = $this->exec($this->uri . '/assignable/search' . $queryParam, null);
 
         $this->log->addInfo("Result=\n".$ret);
 
@@ -48,6 +86,7 @@ public function search($paramArray)
                 $user, new User()
             );
         }
+
         return $users;
     }
 }

tests/UserTest.php

@@ -28,4 +28,54 @@ public function testAddUser()
         $this->markTestSkipped('not yet implemented');
     }
 
+    /**
+     * @depends testGetUser
+     */
+    public function testSearch()
+    {
+        try {
+            $us = new UserService();
+
+            $paramArray = [
+                'username' => '.',  // . means all users
+                'startAt' => 0,
+                'maxResults' => 1000,
+                'includeInactive' => true,
+                //'property' => '*',
+                ];
+
+            // get the user info.
+            $users = $us->findUsers($paramArray);
+
+            Dumper::dump($users);
+        } catch (JiraException $e) {
+            $this->assertTrue(false, 'testGetUser Failed : '.$e->getMessage());
+        }
+    }
+
+    /**
+     * @depends testSearch
+     */
+    public function testSearchAssignable()
+    {
+        try {
+            $us = new UserService();
+
+            $paramArray = [
+                //'username' => null,
+                'project' => 'TEST',
+                //'issueKey' => 'TEST-1',
+                'startAt' => 0,
+                'maxResults' => 1000,
+                //'actionDescriptorId' => 1,
+            ];
+
+            // get the user info.
+            $users = $us->findAssignableUsers($paramArray);
+
+            Dumper::dump($users);
+        } catch (JiraException $e) {
+            $this->assertTrue(false, 'testSearchAssignable Failed : '.$e->getMessage());
+        }
+    }
 }