Merge pull request #474 from localheinz/fix/json-decode

Fix: Do not json_decode API response to associative array

Author: Ocramius

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

@@ -64,7 +64,7 @@ public function getContributors($owner, $repo)
     {
         try {
             $contributors = $this->githubClient->api('repos')->contributors($owner, $repo);
-            $data = json_decode($contributors, true);
+            $data = json_decode($contributors);
 
             return array_reverse($data);
         } catch (RuntimeException $e) {

module/Application/test/ApplicationTest/Integration/Controller/ContributorsControllerTest.php

@@ -6,12 +6,15 @@
 use Application\Entity;
 use Application\Service;
 use ApplicationTest\Integration\Util\Bootstrap;
+use ApplicationTest\Util\FakerTrait;
 use stdClass;
 use Zend\Http;
 use Zend\Test\PHPUnit\Controller\AbstractHttpControllerTestCase;
 
 class ContributorsControllerTest extends AbstractHttpControllerTestCase
 {
+    use FakerTrait;
+
     protected function setUp()
     {
         parent::setUp();
@@ -46,14 +49,16 @@ public function testContributorsActionCanBeAccessed()
             ->getMock()
         ;
 
+        $contributors = $this->contributors(5);
+
         $repositoryRetriever
             ->expects($this->once())
             ->method('getContributors')
             ->with(
                 $this->equalTo($vendor),
                 $this->equalTo($name)
             )
-            ->willReturn([])
+            ->willReturn($contributors)
         ;
 
         $metaData = new stdClass();
@@ -89,4 +94,39 @@ public function testContributorsActionCanBeAccessed()
         $this->assertActionName('index');
         $this->assertResponseStatusCode(Http\Response::STATUS_CODE_200);
     }
+
+    /**
+     * @link https://developer.github.com/v3/repos/statistics/#response
+     *
+     * @return stdClass
+     */
+    private function contributor()
+    {
+        $contributor = new stdClass();
+
+        $contributor->total = $this->faker()->randomNumber();
+
+        $contributor->author = new stdClass();
+
+        $contributor->author->login = $this->faker()->unique()->userName;
+        $contributor->author->avatar_url = $this->faker()->unique()->url;
+        $contributor->author->html_url = $this->faker()->unique()->url;
+
+        return $contributor;
+    }
+
+    /**
+     * @param int $count
+     * @return stdClass[]
+     */
+    private function contributors($count)
+    {
+        $contributors = [];
+
+        for ($i = 0; $i < $count; $i++) {
+            array_push($contributors, $this->contributor());
+        }
+
+        return $contributors;
+    }
 }

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

@@ -362,15 +362,16 @@ public function testGetContributorsDecodesResponseToArray()
         $this->assertInternalType('array', $contributors);
 
         array_walk($contributors, function ($contributor) {
-            $this->assertInternalType('array', $contributor);
-            $this->assertArrayHasKey('author', $contributor);
+            $this->assertInstanceOf(stdClass::class, $contributor);
 
-            $author = $contributor['author'];
+            $this->assertObjectHasAttribute('total', $contributor);
 
-            $this->assertInternalType('array', $author);
-            $this->assertArrayHasKey('login', $author);
-            $this->assertArrayHasKey('avatar_url', $author);
-            $this->assertArrayHasKey('html_url', $author);
+            $this->assertObjectHasAttribute('author', $contributor);
+            $this->assertInstanceOf(stdClass::class, $contributor->author);
+
+            $this->assertObjectHasAttribute('login', $contributor->author);
+            $this->assertObjectHasAttribute('avatar_url', $contributor->author);
+            $this->assertObjectHasAttribute('html_url', $contributor->author);
         });
     }
 
@@ -424,21 +425,22 @@ public function testGetContributorsReturnsContributorsInReverseOrder()
 
             $expected = array_pop($contributorsAsReturned);
 
-            $this->assertInternalType('array', $contributor);
-            $this->assertArrayHasKey('author', $contributor);
+            $this->assertInstanceOf(stdClass::class, $contributor);
 
-            $author = $contributor['author'];
+            $this->assertObjectHasAttribute('total', $contributor);
+            $this->assertSame($expected->total, $contributor->total);
 
-            $this->assertInternalType('array', $author);
+            $this->assertObjectHasAttribute('author', $contributor);
+            $this->assertInstanceOf(stdClass::class, $contributor->author);
 
-            $this->assertArrayHasKey('login', $author);
-            $this->assertSame($expected->author->login, $author['login']);
+            $this->assertObjectHasAttribute('login', $contributor->author);
+            $this->assertSame($expected->author->login, $contributor->author->login);
 
-            $this->assertArrayHasKey('avatar_url', $author);
-            $this->assertSame($expected->author->avatar_url, $author['avatar_url']);
+            $this->assertObjectHasAttribute('avatar_url', $contributor->author);
+            $this->assertSame($expected->author->avatar_url, $contributor->author->avatar_url);
 
-            $this->assertArrayHasKey('html_url', $author);
-            $this->assertSame($expected->author->html_url, $author['html_url']);
+            $this->assertObjectHasAttribute('html_url', $contributor->author);
+            $this->assertSame($expected->author->html_url, $contributor->author->html_url);
         });
     }
 
@@ -487,15 +489,15 @@ public function testGetContributorsReturnsFalseIfRuntimeExceptionIsThrown()
      */
     private function contributor()
     {
-        $author = new stdClass();
+        $contributor = new stdClass();
 
-        $author->login = $this->faker()->unique()->userName;
-        $author->avatar_url = $this->faker()->unique()->url;
-        $author->html_url = $this->faker()->unique()->url;
+        $contributor->total = $this->faker()->randomNumber();
 
-        $contributor = new stdClass();
+        $contributor->author = new stdClass();
 
-        $contributor->author = $author;
+        $contributor->author->login = $this->faker()->unique()->userName;
+        $contributor->author->avatar_url = $this->faker()->unique()->url;
+        $contributor->author->html_url = $this->faker()->unique()->url;
 
         return $contributor;
     }

module/Application/view/application/contributors/index.phtml

@@ -14,11 +14,11 @@
     </div>
     <?php foreach ($this->contributors as $contributor): ?>
     <div class="col-lg-1 col-md-2 col-sm-2 col-xs-3">
-        <?php $url = $contributor['author']['html_url']; ?>
+        <?php $url = $contributor->author->html_url; ?>
         <a href="<?php echo $this->escapeHtmlAttr($url); ?>" class="thumbnail img-responsive" target="_blank">
-            <?php $src = $contributor['author']['avatar_url']; ?>
-            <?php $alt = $contributor['author']['login']; ?>
-            <?php $title = sprintf('%s with %d contributions', $alt, $contributor['total']); ?>
+            <?php $src = $contributor->author->avatar_url; ?>
+            <?php $alt = $contributor->author->login; ?>
+            <?php $title = sprintf('%s with %d contributions', $alt, $contributor->total); ?>
             <img src="<?php echo $this->escapeHtmlAttr($src); ?>" alt="<?php echo $this->escapeHtmlAttr($alt); ?>" title="<?php echo $this->escapeHtmlAttr($title); ?>">
         </a>
     </div>