Use OptionsResolver in Projects::events

Author: fbourigault

UPGRADE.md

@@ -57,6 +57,7 @@ Use the `deployKeys`, `deployKey`, `addDeployKey`, `deleteDeployKey`, `removeDep
 * The `trace` method have been removed. Use `Gitlab\Api\Jobs::trace` instead.
 * The `builds` method have been removed. Use `Gitlab\Api\Jobs::all` instead.
 * The `build` method have been removed. Use `Gitlab\Api\Jobs::show` instead.
+* The `events` method second and subsequent arguments have been replaced by a single associative array of query string parameters.
 
 ## `Gitlab\Api\ProjectNamespaces` changes
 

lib/Gitlab/Api/Projects.php

@@ -413,16 +413,42 @@ public function enableDeployKey($project_id, $key_id)
 
     /**
      * @param int $project_id
-     * @param int $page
-     * @param int $per_page
+     * @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($project_id, $page = 1, $per_page = self::PER_PAGE)
+    public function events($project_id, array $parameters = [])
     {
-        return $this->get($this->getProjectPath($project_id, 'events'), array(
-            'page' => $page,
-            'per_page' => $per_page
-        ));
+        $resolver = $this->createOptionsResolver();
+        $datetimeNormalizer = function (\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($this->getProjectPath($project_id, 'events'), $resolver->resolve($parameters));
     }
 
     /**

test/Gitlab/Tests/Api/ProjectsTest.php

@@ -636,10 +636,7 @@ public function shouldGetEvents()
         $api = $this->getApiMock();
         $api->expects($this->once())
             ->method('get')
-            ->with('projects/1/events', array(
-                'page' => 1,
-                'per_page' => AbstractApi::PER_PAGE
-            ))
+            ->with('projects/1/events', array())
             ->will($this->returnValue($expectedArray))
         ;
 
@@ -666,7 +663,7 @@ public function shouldGetEventsWithPagination()
             ->will($this->returnValue($expectedArray))
         ;
 
-        $this->assertEquals($expectedArray, $api->events(1, 2, 15));
+        $this->assertEquals($expectedArray, $api->events(1, ['page' => 2, 'per_page' => 15]));
     }
 
     /**