Merge pull request #111 from radutopala/paginator

added Result Paginator

Author: radutopala

lib/Gitlab/Api/AbstractApi.php

@@ -7,8 +7,9 @@
  *
  * @author Joseph Bielawski <[email protected]>
  * @author Matt Humphrey <[email protected]>
+ * @author Radu Topala <[email protected]>
  */
-abstract class AbstractApi
+abstract class AbstractApi implements ApiInterface
 {
     /**
      * Default entries per page

lib/Gitlab/Api/ApiInterface.php

@@ -0,0 +1,11 @@
+<?php namespace Gitlab\Api;
+
+use Gitlab\Client;
+
+/**
+ * Api interface
+ */
+interface ApiInterface
+{
+    public function __construct(Client $client);
+}

lib/Gitlab/Api/Issues.php

@@ -29,7 +29,7 @@ public function all($project_id = null, $page = 1, $per_page = self::PER_PAGE, a
      */
     public function show($project_id, $issue_id)
     {
-        return $this->get($this->getProjectPath($project_id, 'issues/'.$this->encodePath($issue_id)));
+        return $this->get($this->getProjectPath($project_id, 'issues?iid='.$this->encodePath($issue_id)));
     }
 
     /**

lib/Gitlab/Client.php

@@ -8,6 +8,7 @@
 use Gitlab\HttpClient\HttpClient;
 use Gitlab\HttpClient\HttpClientInterface;
 use Gitlab\HttpClient\Listener\AuthListener;
+use Gitlab\HttpClient\Listener\PaginationListener;
 
 /**
  * Simple API wrapper for Gitlab
@@ -81,6 +82,13 @@ public function __construct($baseUrl, ClientInterface $httpClient = null)
 
         $this->baseUrl     = $baseUrl;
         $this->httpClient  = new HttpClient($this->baseUrl, $this->options, $httpClient);
+
+        /**
+         * a Pagination listener on Response
+         */
+        $this->httpClient->addListener(
+            new PaginationListener()
+        );
     }
 
     /**

lib/Gitlab/HttpClient/Listener/PaginationListener.php

@@ -0,0 +1,38 @@
+<?php namespace Gitlab\HttpClient\Listener;
+
+use Buzz\Listener\ListenerInterface;
+use Buzz\Message\MessageInterface;
+use Buzz\Message\RequestInterface;
+
+class PaginationListener implements ListenerInterface
+{
+    /**
+     * {@inheritDoc}
+     */
+    public function preSend(RequestInterface $request)
+    {
+    }
+
+    /**
+     * {@inheritDoc}
+     */
+    public function postSend(RequestInterface $request, MessageInterface $response)
+    {
+        $header = $response->getHeader('Link');
+
+        if (empty($header)) {
+            return null;
+        }
+
+        $pagination = array();
+        foreach (explode(',', $header) as $link) {
+            preg_match('/<(.*)>; rel="(.*)"/i', trim($link, ','), $match);
+
+            if (3 === count($match)) {
+                $pagination[$match[2]] = $match[1];
+            }
+        }
+
+        $response->setPagination($pagination);
+    }
+}

lib/Gitlab/HttpClient/Message/Response.php

@@ -4,6 +4,28 @@
 
 class Response extends BaseResponse
 {
+    /**
+     * @var array pagination
+     * See PaginationListener
+     */
+    protected $pagination = array();
+
+    /**
+     * @return mixed
+     */
+    public function getPagination()
+    {
+        return $this->pagination;
+    }
+
+    /**
+     * @param array $pagination
+     */
+    public function setPagination(array $pagination)
+    {
+        $this->pagination = $pagination;
+    }
+
     /**
      * {@inheritDoc}
      */

lib/Gitlab/ResultPager.php

@@ -0,0 +1,121 @@
+<?php namespace Gitlab;
+
+use Gitlab\Api\ApiInterface;
+
+/**
+ * Pager class for supporting pagination in Gitlab classes
+ */
+class ResultPager implements ResultPagerInterface
+{
+    /**
+     * @var \Gitlab\Client client
+     */
+    protected $client;
+
+    /**
+     * The Gitlab client to use for pagination. This must be the same
+     * instance that you got the Api instance from, i.e.:
+     *
+     * $client = new \Gitlab\Client();
+     * $api = $client->api('someApi');
+     * $pager = new \Gitlab\ResultPager($client);
+     *
+     * @param \Gitlab\Client $client
+     *
+     */
+    public function __construct(Client $client)
+    {
+        $this->client = $client;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function fetch(ApiInterface $api, $method, array $parameters = array())
+    {
+        $result = call_user_func_array(array($api, $method), $parameters);
+
+        return $result;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function fetchAll(ApiInterface $api, $method, array $parameters = array())
+    {
+        $result = call_user_func_array(array($api, $method), $parameters);
+
+        while ($this->hasNext()) {
+            $result = array_merge($result, $this->fetchNext());
+        }
+
+        return $result;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function hasNext()
+    {
+        return $this->has('next');
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function fetchNext()
+    {
+        return $this->get('next');
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function hasPrevious()
+    {
+        return $this->has('prev');
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function fetchPrevious()
+    {
+        return $this->get('prev');
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function fetchFirst()
+    {
+        return $this->get('first');
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function fetchLast()
+    {
+        return $this->get('last');
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    protected function has($key)
+    {
+        return !empty($this->client->getHttpClient()->getLastResponse()->getPagination()) && isset($this->client->getHttpClient()->getLastResponse()->getPagination()[$key]);
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    protected function get($key)
+    {
+        if ($this->has($key)) {
+            $result = $this->client->getHttpClient()->get(strtr($this->client->getHttpClient()->getLastResponse()->getPagination()[$key], array($this->client->getBaseUrl() => '')))->getContent();
+            return $result;
+        }
+    }
+}

lib/Gitlab/ResultPagerInterface.php

@@ -0,0 +1,68 @@
+<?php namespace Gitlab;
+
+use Gitlab\Api\ApiInterface;
+
+/**
+ * Pager interface
+ */
+interface ResultPagerInterface
+{
+    /**
+     * Fetch a single result (page) from an api call
+     *
+     * @param ApiInterface $api        the Api instance
+     * @param string       $method     the method name to call on the Api instance
+     * @param array        $parameters the method parameters in an array
+     *
+     * @return array returns the result of the Api::$method() call
+     */
+    public function fetch(ApiInterface $api, $method, array $parameters = array());
+
+    /**
+     * Fetch all results (pages) from an api call
+     * Use with care - there is no maximum
+     *
+     * @param ApiInterface $api        the Api instance
+     * @param string       $method     the method name to call on the Api instance
+     * @param array        $parameters the method parameters in an array
+     *
+     * @return array returns a merge of the results of the Api::$method() call
+     */
+    public function fetchAll(ApiInterface $api, $method, array $parameters = array());
+
+    /**
+     * Check to determine the availability of a next page
+     * @return bool
+     */
+    public function hasNext();
+
+    /**
+     * Check to determine the availability of a previous page
+     * @return bool
+     */
+    public function hasPrevious();
+
+    /**
+     * Fetch the next page
+     * @return array
+     */
+    public function fetchNext();
+
+    /**
+     * Fetch the previous page
+     * @return array
+     */
+    public function fetchPrevious();
+
+    /**
+     * Fetch the first page
+     * @return array
+     */
+    public function fetchFirst();
+
+    /**
+     * Fetch the last page
+     * @return array
+     */
+    public function fetchLast();
+}

test/Gitlab/Tests/Api/IssuesTest.php

@@ -74,7 +74,7 @@ public function shouldShowIssue()
         $api = $this->getApiMock();
         $api->expects($this->once())
             ->method('get')
-            ->with('projects/1/issues/2')
+            ->with('projects/1/issues?iid=2')
             ->will($this->returnValue($expectedArray))
         ;