[11.11] Add expires_at parameter to Groups::addMember() (#746)

ajuchacko · web-flow · commit 0d37c75f5080 · 2023-07-17T10:11:15.000+01:00
diff --git a/src/Api/AbstractApi.php b/src/Api/AbstractApi.php
@@ -38,6 +38,16 @@ abstract class AbstractApi
      */
     private const URI_PREFIX = '/api/v4/';
 
+    /**
+     * The access levels for groups and projects
+     * as defined in the Gitlab::Access module.
+     *
+     * @see https://gitlab.com/gitlab-org/gitlab/-/blob/master/lib/gitlab/access.rb
+     *
+     * @var array
+     */
+    protected const ACCESS_LEVELS = [0, 10, 20, 30, 40, 50];
+
     /**
      * The client instance.
      *
diff --git a/src/Api/Groups.php b/src/Api/Groups.php
@@ -208,15 +208,28 @@ public function allMember($group_id, int $user_id)
      * @param int|string $group_id
      * @param int        $user_id
      * @param int        $access_level
+     * @param array      $parameters
      *
      * @return mixed
      */
-    public function addMember($group_id, int $user_id, int $access_level)
+    public function addMember($group_id, int $user_id, int $access_level, array $parameters = [])
     {
-        return $this->post('groups/'.self::encodePath($group_id).'/members', [
+        $dateNormalizer = function (OptionsResolver $optionsResolver, \DateTimeInterface $date): string {
+            return $date->format('Y-m-d');
+        };
+
+        $resolver = $this->createOptionsResolver()
+            ->setDefined('expires_at')
+            ->setAllowedTypes('expires_at', \DateTimeInterface::class)
+            ->setNormalizer('expires_at', $dateNormalizer)
+        ;
+
+        $parameters = \array_merge([
             'user_id' => $user_id,
             'access_level' => $access_level,
-        ]);
+        ], $resolver->resolve($parameters));
+
+        return $this->post('groups/'.self::encodePath($group_id).'/members', $parameters);
     }
 
     /**
diff --git a/src/Api/Projects.php b/src/Api/Projects.php
@@ -1276,7 +1276,7 @@ public function addShare($project_id, array $parameters = [])
 
         $resolver->setRequired('group_access')
             ->setAllowedTypes('group_access', 'int')
-            ->setAllowedValues('group_access', [0, 10, 20, 30, 40, 50]);
+            ->setAllowedValues('group_access', self::ACCESS_LEVELS);
 
         $resolver->setDefined('expires_at')
             ->setAllowedTypes('expires_at', \DateTimeInterface::class)
diff --git a/tests/Api/GroupsTest.php b/tests/Api/GroupsTest.php
@@ -282,16 +282,19 @@ public function shouldGetMembers(): void
      */
     public function shouldAddMember(): void
     {
-        $expectedArray = ['id' => 1, 'name' => 'Matt'];
+        $tomorrow = (new DateTime('tomorrow'));
+        $expectedArray = ['id' => 1, 'name' => 'Matt', 'expires_at' => $tomorrow];
 
         $api = $this->getApiMock();
         $api->expects($this->once())
             ->method('post')
-            ->with('groups/1/members', ['user_id' => 2, 'access_level' => 3])
+            ->with('groups/1/members', [
+                'user_id' => 2, 'access_level' => 10, 'expires_at' => $tomorrow->format('Y-m-d'),
+            ])
             ->will($this->returnValue($expectedArray))
         ;
 
-        $this->assertEquals($expectedArray, $api->addMember(1, 2, 3));
+        $this->assertEquals($expectedArray, $api->addMember(1, 2, 10, ['expires_at' => $tomorrow]));
     }
 
     /**
