[11.9] Add support for user starred projects (GitLabPHP#735)

Co-authored-by: Wim Reckman <[email protected]>

Author: wimski

src/Api/Users.php

@@ -174,6 +174,88 @@ public function usersProjects(int $id, array $parameters = [])
         return $this->get('users/'.self::encodePath($id).'/projects', $resolver->resolve($parameters));
     }
 
+    /**
+     * @param int   $id
+     * @param array $parameters {
+     *
+     *     @var bool   $archived                    limit by archived status
+     *     @var string $visibility                  limit by visibility public, internal, or private
+     *     @var string $order_by                    Return projects ordered by id, name, path, created_at, updated_at,
+     *                                              or last_activity_at fields (default is created_at)
+     *     @var string $sort                        Return projects sorted in asc or desc order (default is desc)
+     *     @var string $search                      return list of projects matching the search criteria
+     *     @var bool   $simple                      return only the ID, URL, name, and path of each project
+     *     @var bool   $owned                       limit by projects owned by the current user
+     *     @var bool   $membership                  limit by projects that the current user is a member of
+     *     @var bool   $starred                     limit by projects starred by the current user
+     *     @var bool   $statistics                  include project statistics
+     *     @var bool   $with_issues_enabled         limit by enabled issues feature
+     *     @var bool   $with_merge_requests_enabled limit by enabled merge requests feature
+     *     @var int    $min_access_level            Limit by current user minimal access level
+     *     @var bool   $with_custom_attributes      Include custom attributes in response (administrator only)
+     * }
+     *
+     * @return mixed
+     */
+    public function usersStarredProjects(int $id, array $parameters = [])
+    {
+        $resolver = $this->createOptionsResolver();
+        $booleanNormalizer = function (Options $resolver, $value): string {
+            return $value ? 'true' : 'false';
+        };
+        $resolver->setDefined('archived')
+            ->setAllowedTypes('archived', 'bool')
+            ->setNormalizer('archived', $booleanNormalizer)
+        ;
+        $resolver->setDefined('visibility')
+            ->setAllowedValues('visibility', ['public', 'internal', 'private'])
+        ;
+        $resolver->setDefined('order_by')
+            ->setAllowedValues('order_by', ['id', 'name', 'path', 'created_at', 'updated_at', 'last_activity_at'])
+        ;
+        $resolver->setDefined('sort')
+            ->setAllowedValues('sort', ['asc', 'desc'])
+        ;
+        $resolver->setDefined('search');
+        $resolver->setDefined('simple')
+            ->setAllowedTypes('simple', 'bool')
+            ->setNormalizer('simple', $booleanNormalizer)
+        ;
+        $resolver->setDefined('owned')
+            ->setAllowedTypes('owned', 'bool')
+            ->setNormalizer('owned', $booleanNormalizer)
+        ;
+        $resolver->setDefined('membership')
+            ->setAllowedTypes('membership', 'bool')
+            ->setNormalizer('membership', $booleanNormalizer)
+        ;
+        $resolver->setDefined('starred')
+            ->setAllowedTypes('starred', 'bool')
+            ->setNormalizer('starred', $booleanNormalizer)
+        ;
+        $resolver->setDefined('statistics')
+            ->setAllowedTypes('statistics', 'bool')
+            ->setNormalizer('statistics', $booleanNormalizer)
+        ;
+        $resolver->setDefined('with_issues_enabled')
+            ->setAllowedTypes('with_issues_enabled', 'bool')
+            ->setNormalizer('with_issues_enabled', $booleanNormalizer)
+        ;
+        $resolver->setDefined('with_merge_requests_enabled')
+            ->setAllowedTypes('with_merge_requests_enabled', 'bool')
+            ->setNormalizer('with_merge_requests_enabled', $booleanNormalizer)
+        ;
+        $resolver->setDefined('min_access_level')
+            ->setAllowedValues('min_access_level', [null, 10, 20, 30, 40, 50])
+        ;
+        $resolver->setDefined('with_custom_attributes')
+            ->setAllowedTypes('with_custom_attributes', 'bool')
+            ->setNormalizer('with_custom_attributes', $booleanNormalizer)
+        ;
+
+        return $this->get('users/'.self::encodePath($id).'/starred_projects', $resolver->resolve($parameters));
+    }
+
     /**
      * @return mixed
      */

tests/Api/UsersTest.php

@@ -294,6 +294,97 @@ public function shouldSearchUsersProjects(): void
         $this->assertEquals($expectedArray, $api->usersProjects(1, ['search' => 'a project']));
     }
 
+    /**
+     * @test
+     */
+    public function shouldShowUsersStarredProjects(): void
+    {
+        $expectedArray = $this->getUsersProjectsData();
+
+        $api = $this->getUsersProjectsRequestMock('users/1/starred_projects', $expectedArray);
+
+        $this->assertEquals($expectedArray, $api->usersStarredProjects(1));
+    }
+
+    /**
+     * @test
+     */
+    public function shouldShowUsersStarredProjectsWithLimit(): void
+    {
+        $expectedArray = [$this->getUsersProjectsData()[0]];
+
+        $api = $this->getUsersProjectsRequestMock('users/1/starred_projects', $expectedArray, ['per_page' => 1]);
+
+        $this->assertEquals($expectedArray, $api->usersStarredProjects(1, ['per_page' => 1]));
+    }
+
+    /**
+     * @test
+     */
+    public function shouldGetAllUsersStarredProjectsSortedByName(): void
+    {
+        $expectedArray = $this->getUsersProjectsData();
+
+        $api = $this->getUsersProjectsRequestMock(
+            'users/1/starred_projects',
+            $expectedArray,
+            ['page' => 1, 'per_page' => 5, 'order_by' => 'name', 'sort' => 'asc']
+        );
+
+        $this->assertEquals(
+            $expectedArray,
+            $api->usersStarredProjects(1, ['page' => 1, 'per_page' => 5, 'order_by' => 'name', 'sort' => 'asc'])
+        );
+    }
+
+    /**
+     * @test
+     */
+    public function shouldGetNotArchivedUsersStarredProjects(): void
+    {
+        $expectedArray = $this->getUsersProjectsData();
+
+        $api = $this->getUsersProjectsRequestMock('users/1/starred_projects', $expectedArray, ['archived' => 'false']);
+
+        $this->assertEquals($expectedArray, $api->usersStarredProjects(1, ['archived' => false]));
+    }
+
+    /**
+     * @test
+     */
+    public function shouldGetOwnedUsersStarredProjects(): void
+    {
+        $expectedArray = $this->getUsersProjectsData();
+
+        $api = $this->getUsersProjectsRequestMock('users/1/starred_projects', $expectedArray, ['owned' => 'true']);
+
+        $this->assertEquals($expectedArray, $api->usersStarredProjects(1, ['owned' => true]));
+    }
+
+    /**
+     * @test
+     * @dataProvider possibleAccessLevels
+     */
+    public function shouldGetStarredProjectsWithMinimumAccessLevel($level): void
+    {
+        $expectedArray = $this->getUsersProjectsData();
+
+        $api = $this->getUsersProjectsRequestMock('users/1/starred_projects', $expectedArray, ['min_access_level' => $level]);
+
+        $this->assertEquals($expectedArray, $api->usersStarredProjects(1, ['min_access_level' => $level]));
+    }
+
+    /**
+     * @test
+     */
+    public function shouldSearchUsersStarredProjects(): void
+    {
+        $expectedArray = $this->getUsersProjectsData();
+
+        $api = $this->getUsersProjectsRequestMock('users/1/starred_projects', $expectedArray, ['search' => 'a project']);
+        $this->assertEquals($expectedArray, $api->usersStarredProjects(1, ['search' => 'a project']));
+    }
+
     /**
      * @test
      */