Merge pull request #447 from snapshotpl/contributors

Author: localheinz

composer.json

@@ -18,6 +18,7 @@
     "require-dev": {
         "bjyoungblood/BjyProfiler": "1.1.0",
         "fabpot/php-cs-fixer": "~1.4",
+        "fzaninotto/faker": "^1.4.0",
         "phpunit/phpunit": "4.0.*",
         "zendframework/zend-developer-tools": "dev-master",
         "zendframework/zftool": "dev-master"

composer.lock

@@ -6,6 +6,12 @@
 use Psr\Log;
 
 return [
+    'zf-modules' => [
+        'repository' => [
+            'owner' => 'zendframework',
+            'name'  => 'modules.zendframework.com',
+        ],
+    ],
     'router' => [
         'routes' => [
             'live-search' => [
@@ -30,6 +36,16 @@
                 'priority' => 1,
                 'may_terminate' => true,
             ],
+            'contributors' => [
+                'type' => 'Literal',
+                'options' => [
+                    'route'    => '/contributors',
+                    'defaults' => [
+                        'controller' => Controller\ContributorsController::class,
+                        'action'     => 'index',
+                    ],
+                ],
+            ],
             'feed' => [
                 'type' => 'Literal',
                 'options' => [
@@ -76,6 +92,7 @@
     'controllers' => [
         'factories' => [
             Controller\IndexController::class => Controller\IndexControllerFactory::class,
+            Controller\ContributorsController::class => Controller\ContributorsControllerFactory::class,
             Controller\SearchController::class => Controller\SearchControllerFactory::class,
         ],
     ],
@@ -111,6 +128,7 @@
     ],
     'view_helpers' => [
         'factories' => [
+            'gitHubRepositoryUrl' => View\Helper\GitHubRepositoryUrlFactory::class,
             'sanitizeHtml' => View\Helper\SanitizeHtmlFactory::class,
         ],
     ],

module/Application/config/module.config.php

@@ -0,0 +1,51 @@
+<?php
+
+namespace Application\Controller;
+
+use Application\Service\RepositoryRetriever;
+use Zend\Mvc\Controller\AbstractActionController;
+use Zend\View\Model\ViewModel;
+
+class ContributorsController extends AbstractActionController
+{
+    const LIST_LIMIT = 36;
+
+    /**
+     * @var RepositoryRetriever
+     */
+    private $repositoryRetriever;
+
+    /**
+     * @var array
+     */
+    private $repositoryData;
+
+    /**
+     * @param RepositoryRetriever $repositoryRetriever
+     * @param array $repositoryData
+     */
+    public function __construct(RepositoryRetriever $repositoryRetriever, array $repositoryData)
+    {
+        $this->repositoryRetriever = $repositoryRetriever;
+        $this->repositoryData = $repositoryData;
+    }
+
+    public function indexAction()
+    {
+        $contributors = $this->repositoryRetriever->getContributors(
+            $this->repositoryData['owner'],
+            $this->repositoryData['name'],
+            self::LIST_LIMIT
+        );
+
+        $metadata = $this->repositoryRetriever->getUserRepositoryMetadata(
+            $this->repositoryData['owner'],
+            $this->repositoryData['name']
+        );
+
+        return new ViewModel([
+            'contributors' => $contributors,
+            'metadata' => $metadata,
+        ]);
+    }
+}

module/Application/src/Application/Controller/ContributorsController.php

@@ -0,0 +1,19 @@
+<?php
+
+namespace Application\Controller;
+
+use Application\Service\RepositoryRetriever;
+use Zend\ServiceManager\FactoryInterface;
+use Zend\ServiceManager\ServiceLocatorInterface;
+
+class ContributorsControllerFactory implements FactoryInterface
+{
+    public function createService(ServiceLocatorInterface $serviceLocator)
+    {
+        $serviceManager = $serviceLocator->getServiceLocator();
+        $repositoryRetriever = $serviceManager->get(RepositoryRetriever::class);
+        $repositoryData = $serviceManager->get('Config')['zf-modules']['repository'];
+
+        return new ContributorsController($repositoryRetriever, $repositoryData);
+    }
+}

module/Application/src/Application/Controller/ContributorsControllerFactory.php

@@ -53,6 +53,26 @@ public function getUserRepositories($user, $params = [])
         return $this->githubClient->api('user')->repos($user, $params);
     }
 
+    /**
+     * Get repository contributors list
+     *
+     * @param string $owner
+     * @param string $repo
+     * @return array
+     */
+    public function getContributors($owner, $repo, $limit = 20)
+    {
+        try {
+            $contributors = $this->githubClient->api('repos')->contributors($owner, $repo);
+            $data = json_decode($contributors, true);
+            $data = array_reverse($data);
+
+            return array_slice($data, 0, $limit);
+        } catch (RuntimeException $e) {
+            return false;
+        }
+    }
+
     /**
      * Get File Content from User Repository
      *

module/Application/src/Application/Service/RepositoryRetriever.php

@@ -0,0 +1,49 @@
+<?php
+
+namespace Application\View\Helper;
+
+use Zend\View\Helper\AbstractHelper;
+
+class GitHubRepositoryUrl extends AbstractHelper
+{
+    /**
+     * @var string
+     */
+    private $owner;
+
+    /**
+     * @var string
+     */
+    private $name;
+
+    /**
+     * @var string
+     */
+    private $url;
+
+    /**
+     * @param string $owner
+     * @param string $name
+     */
+    public function __construct($owner, $name)
+    {
+        $this->owner = (string) $owner;
+        $this->name = (string) $name;
+    }
+
+    /**
+     * @return string
+     */
+    public function __invoke()
+    {
+        if (null === $this->url) {
+            $this->url = sprintf(
+                'https://github.com/%s/%s',
+                $this->owner,
+                $this->name
+            );
+        }
+
+        return $this->url;
+    }
+}

module/Application/src/Application/View/Helper/GitHubRepositoryUrl.php

@@ -0,0 +1,28 @@
+<?php
+
+namespace Application\View\Helper;
+
+use Zend\ServiceManager\FactoryInterface;
+use Zend\ServiceManager\ServiceLocatorInterface;
+use Zend\View\HelperPluginManager;
+
+class GitHubRepositoryUrlFactory implements FactoryInterface
+{
+    /**
+     * {@inheritDoc}
+     *
+     * @return GitHubRepositoryUrl
+     */
+    public function createService(ServiceLocatorInterface $serviceLocator)
+    {
+        /* @var HelperPluginManager $serviceLocator */
+        $serviceManager = $serviceLocator->getServiceLocator();
+
+        $config = $serviceManager->get('Config')['zf-modules']['repository'];
+
+        return new GitHubRepositoryUrl(
+            $config['owner'],
+            $config['name']
+        );
+    }
+}

module/Application/src/Application/View/Helper/GitHubRepositoryUrlFactory.php

@@ -0,0 +1,83 @@
+<?php
+
+namespace ApplicationTest\Integration\Controller;
+
+use Application\Controller;
+use Application\Service;
+use ApplicationTest\Integration\Util\Bootstrap;
+use stdClass;
+use Zend\Http;
+use Zend\Test\PHPUnit\Controller\AbstractHttpControllerTestCase;
+
+class ContributorsControllerTest extends AbstractHttpControllerTestCase
+{
+    protected function setUp()
+    {
+        parent::setUp();
+
+        $this->setApplicationConfig(Bootstrap::getConfig());
+    }
+
+    public function testContributorsActionCanBeAccessed()
+    {
+        $vendor = 'foo';
+        $name = 'bar';
+
+        $config = $this->getApplicationServiceLocator()->get('Config');
+
+        $config['zf-modules'] = [
+            'repository' => [
+                'owner' => $vendor,
+                'name'  => $name,
+            ],
+        ];
+
+        $repositoryRetriever = $this->getMockBuilder(Service\RepositoryRetriever::class)
+            ->disableOriginalConstructor()
+            ->getMock()
+        ;
+
+        $repositoryRetriever
+            ->expects($this->once())
+            ->method('getContributors')
+            ->with(
+                $this->equalTo($vendor),
+                $this->equalTo($name)
+            )
+            ->willReturn([])
+        ;
+
+        $metaData = new stdClass();
+        $metaData->forks_count = 200;
+        $metaData->stargazers_count = 250;
+        $metaData->watchers_count = 300;
+
+        $repositoryRetriever
+            ->expects($this->once())
+            ->method('getUserRepositoryMetadata')
+            ->with(
+                $this->equalTo($vendor),
+                $this->equalTo($name)
+            )
+            ->willReturn($metaData)
+        ;
+
+        $this->getApplicationServiceLocator()
+            ->setAllowOverride(true)
+            ->setService(
+                'Config',
+                $config
+            )
+            ->setService(
+                Service\RepositoryRetriever::class,
+                $repositoryRetriever
+            )
+        ;
+
+        $this->dispatch('/contributors');
+
+        $this->assertControllerName(Controller\ContributorsController::class);
+        $this->assertActionName('index');
+        $this->assertResponseStatusCode(Http\Response::STATUS_CODE_200);
+    }
+}