Merge branch '9.19' into 10.0

Author: GrahamCampbell

CHANGELOG.md

@@ -2,7 +2,7 @@ CHANGE LOG
 ==========
 
 
-## 10.0.0 (Upcoming)
+## 10.0.0 (UPCOMING)
 
 * Removed all deprecated functionality
 * Switched to PSR-17 and PSR-18
@@ -11,6 +11,11 @@ CHANGE LOG
 * Redesigned pagination
 
 
+## 9.19.0 (UPCOMING)
+
+* Added user events API
+
+
 ## 9.18.0 (11/07/2020)
 
 * Deprecated all APIs that are deprecated or removed as of GitLab 13.1

src/Api/Users.php

@@ -416,4 +416,44 @@ public function removeImpersonationToken($user_id, $impersonation_token_id)
     {
         return $this->delete('users/'.self::encodePath($user_id).'/impersonation_tokens/'.self::encodePath($impersonation_token_id));
     }
+
+    /**
+     * @param int   $user_id
+     * @param array $parameters {
+     *
+     *     @var string             $action      include only events of a particular action type
+     *     @var string             $target_type include only events of a particular target type
+     *     @var \DateTimeInterface $before      include only events created before a particular date
+     *     @var \DateTimeInterface $after       include only events created after a particular date
+     *     @var string             $sort        Sort events in asc or desc order by created_at (default is desc)
+     * }
+     *
+     * @return mixed
+     */
+    public function events($user_id, array $parameters = [])
+    {
+        $resolver = $this->createOptionsResolver();
+        $datetimeNormalizer = function (Options $resolver, \DateTimeInterface $value) {
+            return $value->format('Y-m-d');
+        };
+
+        $resolver->setDefined('action')
+            ->setAllowedValues('action', ['created', 'updated', 'closed', 'reopened', 'pushed', 'commented', 'merged', 'joined', 'left', 'destroyed', 'expired'])
+        ;
+        $resolver->setDefined('target_type')
+            ->setAllowedValues('target_type', ['issue', 'milestone', 'merge_request', 'note', 'project', 'snippet', 'user'])
+        ;
+        $resolver->setDefined('before')
+            ->setAllowedTypes('before', \DateTimeInterface::class)
+            ->setNormalizer('before', $datetimeNormalizer);
+        $resolver->setDefined('after')
+            ->setAllowedTypes('after', \DateTimeInterface::class)
+            ->setNormalizer('after', $datetimeNormalizer)
+        ;
+        $resolver->setDefined('sort')
+            ->setAllowedValues('sort', ['asc', 'desc'])
+        ;
+
+        return $this->get('users/'.$this->encodePath($user_id).'/events', $resolver->resolve($parameters));
+    }
 }

tests/Api/UsersTest.php

@@ -707,4 +707,72 @@ protected function getApiClass()
     {
         return 'Gitlab\Api\Users';
     }
+
+    /**
+     * @test
+     */
+    public function shouldGetEvents()
+    {
+        $expectedArray = [
+            ['id' => 1, 'title' => 'An event'],
+            ['id' => 2, 'title' => 'Another event'],
+        ];
+
+        $api = $this->getApiMock();
+        $api->expects($this->once())
+            ->method('get')
+            ->with('users/1/events', [])
+            ->will($this->returnValue($expectedArray));
+
+        $this->assertEquals($expectedArray, $api->events(1));
+    }
+
+    /**
+     * @test
+     */
+    public function shouldGetEventsWithDateTimeParams()
+    {
+        $expectedArray = [
+            ['id' => 1, 'title' => 'An event'],
+            ['id' => 2, 'title' => 'Another event'],
+        ];
+
+        $after = new \DateTime('2018-01-01 00:00:00');
+        $before = new \DateTime('2018-01-31 00:00:00');
+
+        $expectedWithArray = [
+            'after' => $after->format('Y-m-d'),
+            'before' => $before->format('Y-m-d'),
+        ];
+
+        $api = $this->getApiMock();
+        $api->expects($this->once())
+            ->method('get')
+            ->with('users/1/events', $expectedWithArray)
+            ->will($this->returnValue($expectedArray));
+
+        $this->assertEquals($expectedArray, $api->events(1, ['after' => $after, 'before' => $before]));
+    }
+
+    /**
+     * @test
+     */
+    public function shouldGetEventsWithPagination()
+    {
+        $expectedArray = [
+            ['id' => 1, 'title' => 'An event'],
+            ['id' => 2, 'title' => 'Another event'],
+        ];
+
+        $api = $this->getApiMock();
+        $api->expects($this->once())
+            ->method('get')
+            ->with('users/1/events', [
+                'page' => 2,
+                'per_page' => 15,
+            ])
+            ->will($this->returnValue($expectedArray));
+
+        $this->assertEquals($expectedArray, $api->events(1, ['page' => 2, 'per_page' => 15]));
+    }
 }