Use OptionsResolver in Repositories::commits

Author: fbourigault

UPGRADE.md

@@ -67,8 +67,8 @@ Use the `deployKeys`, `deployKey`, `addDeployKey`, `deleteDeployKey`, `removeDep
 
 ## `Gitlab\Api\Repositories` changes
 
-* The `commits` page argument now start from 1 instead of 0.
 * The `commitBuilds` method have been removed. Use `Gitlab\Api\Projects::pipelines` instead.
+* The `commits` method second and subsequent arguments have been replaced by a single associative array of query string parameters.
 
 ## `Gitlab\Model\Project` changes
 

lib/Gitlab/Api/Repositories.php

@@ -129,18 +129,33 @@ public function updateRelease($project_id, $tag_name, $description)
 
     /**
      * @param int $project_id
-     * @param int $page
-     * @param int $per_page
-     * @param null $ref_name
+     * @param array $parameters (
+     *
+     *     @var string             $ref_name The name of a repository branch or tag or if not given the default branch.
+     *     @var \DateTimeInterface $since    Only commits after or on this date will be returned.
+     *     @var \DateTimeInterface $until    Only commits before or on this date will be returned.
+     * )
+     *
      * @return mixed
      */
-    public function commits($project_id, $page = 1, $per_page = self::PER_PAGE, $ref_name = null)
+    public function commits($project_id, array $parameters = [])
     {
-        return $this->get($this->getProjectPath($project_id, 'repository/commits'), array(
-            'page' => $page,
-            'per_page' => $per_page,
-            'ref_name' => $ref_name
-        ));
+        $resolver = $this->createOptionsResolver();
+        $datetimeNormalizer = function (\DateTimeInterface $value) {
+            return $value->format('c');
+        };
+
+        $resolver->setDefined('ref_name');
+        $resolver->setDefined('since')
+            ->setAllowedTypes('since', \DateTimeInterface::class)
+            ->setNormalizer('since', $datetimeNormalizer)
+        ;
+        $resolver->setDefined('until')
+            ->setAllowedTypes('until', \DateTimeInterface::class)
+            ->setNormalizer('until', $datetimeNormalizer)
+        ;
+
+        return $this->get($this->getProjectPath($project_id, 'repository/commits'), $resolver->resolve($parameters));
     }
 
     /**

test/Gitlab/Tests/Api/RepositoriesTest.php

@@ -230,7 +230,7 @@ public function shouldGetCommits()
         $api = $this->getApiMock();
         $api->expects($this->once())
             ->method('get')
-            ->with('projects/1/repository/commits', array('page' => 1, 'per_page' => AbstractApi::PER_PAGE, 'ref_name' => null))
+            ->with('projects/1/repository/commits', array())
             ->will($this->returnValue($expectedArray))
         ;
 
@@ -254,7 +254,7 @@ public function shouldGetCommitsWithParams()
             ->will($this->returnValue($expectedArray))
         ;
 
-        $this->assertEquals($expectedArray, $api->commits(1, 2, 25, 'master'));
+        $this->assertEquals($expectedArray, $api->commits(1, ['page' => 2, 'per_page' => 25, 'ref_name' => 'master']));
     }
 
     /**