[WIP] Enhancement: Added GitHub Repository Service

.travis.yml

@@ -3,7 +3,6 @@ language: php
 sudo: false
 
 php:
-  - 5.4
   - 5.5
   - 5.6
   - hhvm

composer.json

@@ -4,7 +4,7 @@
     "license": "BSD-3-Clause",
     "homepage": "https://modules.zendframework.com",
     "require": {
-        "php": "~5.4",
+        "php": "~5.5",
         "bshaffer/oauth2-server-php": "dev-develop",
         "zendframework/zendframework": "~2.3.0",
         "rwoverdijk/assetmanager": "1.3.*",

module/Application/config/module.config.php

@@ -87,6 +87,7 @@
     'service_manager' => array(
         'factories' => array(
             'translator' => 'Zend\I18n\Translator\TranslatorServiceFactory',
+            \Application\Service\RepositoryRetriever::class => \Application\Service\RepositoryRetrieverFactory::class,
         ),
     ),
     'translator' => array(

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

@@ -0,0 +1,85 @@
+<?php
+
+namespace Application\Service;
+
+use EdpGithub\Client;
+use EdpGithub\Collection\RepositoryCollection;
+use EdpGithub\Listener\Exception\RuntimeException;
+
+class RepositoryRetriever
+{
+    /**
+     * @var Client
+     */
+    private $githubClient;
+
+    /**
+     * @param Client $githubClient
+     */
+    public function __construct(Client $githubClient)
+    {
+        $this->githubClient = $githubClient;
+    }
+
+    /**
+     * Return MetaData from User Repository
+     * @param string $user
+     * @param string $module
+     * @return mixed
+     */
+    public function getUserRepositoryMetadata($user, $module)
+    {
+        return json_decode($this->githubClient->api('repos')->show($user, $module));
+    }
+
+    /**
+     * Get all Repositories from GitHub User
+     * @param string $user
+     * @param array $params
+     * @return RepositoryCollection
+     */
+    public function getUserRepositories($user, array $params = array())
+    {
+        return $this->githubClient->api('user')->repos($user, $params);
+    }
+
+    /**
+     * Get File Content from User Repository
+     * @param string $user
+     * @param string $module
+     * @param string $filePath
+     * @return string|null
+     */
+    public function getRepositoryFileContent($user, $module, $filePath)
+    {
+        $contentResponse = $this->getRepositoryFileMetadata($user, $module, $filePath);
+
+        if (!isset($contentResponse->content)) {
+            return null;
+        }
+
+        return base64_decode($contentResponse->content);
+    }
+
+    /**
+     * Return File MetaData from User Repository
+     * @param string $user
+     * @param string $module
+     * @param string $filePath
+     * @return mixed
+     */
+    public function getRepositoryFileMetadata($user, $module, $filePath)
+    {
+        return json_decode($this->githubClient->api('repos')->content($user, $module, $filePath));
+    }
+
+    /**
+     * Return all Repositories from current authenticated GitHub User
+     * @param array $params
+     * @return RepositoryCollection
+     */
+    public function getAuthenticatedUserRepositories(array $params = array())
+    {
+        return $this->githubClient->api('current_user')->repos($params);
+    }
+}

module/Application/src/Application/Service/RepositoryRetrieverFactory.php

@@ -0,0 +1,23 @@
+<?php
+
+namespace Application\Service;
+
+use EdpGithub\Client;
+use Zend\ServiceManager\FactoryInterface;
+use Zend\ServiceManager\ServiceLocatorInterface;
+
+class RepositoryRetrieverFactory implements FactoryInterface
+{
+    /**
+     * {@inheritDoc}
+     *
+     * @return RepositoryRetriever
+     */
+    public function createService(ServiceLocatorInterface $serviceLocator)
+    {
+        /* @var Client $githubClient */
+        $githubClient = $serviceLocator->get(Client::class);
+
+        return new RepositoryRetriever($githubClient);
+    }
+}

module/Application/test/ApplicationTest/Service/RepositoryRetrieverTest.php

@@ -0,0 +1,163 @@
+<?php
+
+namespace ApplicationTest\Service;
+
+use Application\Service\RepositoryRetriever;
+use EdpGithub\Api;
+use PHPUnit_Framework_TestCase;
+
+class RepositoryRetrieverTest extends PHPUnit_Framework_TestCase
+{
+    private $response;
+    private $headers;
+    private $httpClient;
+    private $client;
+
+    protected function setUp()
+    {
+        $this->response = $this->getMock('Zend\Http\Response');
+        $this->headers = $this->getMock('Zend\Http\Headers');
+        $this->httpClient = $this->getMock('EdpGithub\Http\Client');
+        $this->client = $this->getMock('EdpGithub\Client');
+    }
+
+    protected function tearDown()
+    {
+        $this->response = null;
+        $this->headers = null;
+        $this->httpClient = null;
+        $this->client = null;
+    }
+
+    private function getClientMock(Api\AbstractApi $apiInstance, $result)
+    {
+        $this->response->expects($this->any())
+            ->method('getBody')
+            ->will($this->returnValue($result));
+
+        $this->response->expects($this->any())
+            ->method('getHeaders')
+            ->will($this->returnValue($this->headers));
+
+        $this->httpClient->expects($this->any())
+            ->method('get')
+            ->will($this->returnValue($this->response));
+
+        $this->client->expects($this->any())
+            ->method('getHttpClient')
+            ->will($this->returnValue($this->httpClient));
+
+        $apiInstance->setClient($this->client);
+
+        $this->client->expects($this->any())
+            ->method('api')
+            ->will($this->returnValue($apiInstance));
+
+        return $this->client;
+    }
+
+    public function testCanRetrieveUserRepositories()
+    {
+        $payload = [
+            ['name' => 'foo'],
+            ['name' => 'bar'],
+            ['name' => 'baz']
+        ];
+
+        $clientMock = $this->getClientMock(new Api\User, json_encode($payload));
+        $service = new RepositoryRetriever($clientMock);
+
+        $repositories = $service->getUserRepositories('foo');
+        $this->assertInstanceOf(\EdpGithub\Collection\RepositoryCollection::class, $repositories);
+
+        $count = 0;
+        foreach ($repositories as $repository) {
+            $this->assertEquals(current($payload), (array)$repository);
+            next($payload);
+            ++$count;
+        }
+
+        $this->assertEquals(count($payload), $count);
+    }
+
+    public function testCanRetrieveUserRepositoryMetadata()
+    {
+        $payload = [
+            'name' => 'foo',
+            'url' => 'http://foo.com'
+        ];
+
+        $clientMock = $this->getClientMock(new Api\Repos, json_encode($payload));
+        $service = new RepositoryRetriever($clientMock);
+        $metadata = $service->getUserRepositoryMetadata('foo', 'bar');
+
+        $this->assertInstanceOf('stdClass', $metadata);
+        $this->assertEquals($payload, (array)$metadata);
+    }
+
+    public function testCanRetrieveRepositoryFileContent()
+    {
+        $payload = [
+            'content' => base64_encode('foo')
+        ];
+
+        $clientMock = $this->getClientMock(new Api\Repos, json_encode($payload));
+        $service = new RepositoryRetriever($clientMock);
+
+        $response = $service->getRepositoryFileContent('foo', 'bar', 'foo.baz');
+
+        $this->assertEquals('foo', $response);
+    }
+
+    public function testResponseContentMissingOnGetRepositoryFileContent()
+    {
+        $payload = [];
+
+        $clientMock = $this->getClientMock(new Api\Repos, json_encode($payload));
+        $service = new RepositoryRetriever($clientMock);
+
+        $response = $service->getRepositoryFileContent('foo', 'bar', 'baz');
+
+        $this->assertNull($response);
+    }
+
+    public function testCanRetrieveRepositoryFileMetadata()
+    {
+        $payload = [
+            'name' => 'foo',
+            'url' => 'http://foo.com'
+        ];
+
+        $clientMock = $this->getClientMock(new Api\Repos, json_encode($payload));
+        $service = new RepositoryRetriever($clientMock);
+
+        $metadata = $service->getRepositoryFileMetadata('foo', 'bar', 'baz');
+
+        $this->assertInstanceOf('stdClass', $metadata);
+        $this->assertEquals($payload, (array)$metadata);
+    }
+
+    public function testCanRetrieveAuthenticatedUserRepositories()
+    {
+        $payload = [
+            ['name' => 'foo'],
+            ['name' => 'bar'],
+            ['name' => 'baz']
+        ];
+
+        $clientMock = $this->getClientMock(new Api\CurrentUser, json_encode($payload));
+        $service = new RepositoryRetriever($clientMock);
+
+        $repositories = $service->getAuthenticatedUserRepositories();
+        $this->assertInstanceOf(\EdpGithub\Collection\RepositoryCollection::class, $repositories);
+
+        $count = 0;
+        foreach ($repositories as $repository) {
+            $this->assertEquals(current($payload), (array)$repository);
+            next($payload);
+            ++$count;
+        }
+
+        $this->assertEquals(count($payload), $count);
+    }
+}