Merge branch 'master' into protection-configure

Author: bobeagan

CHANGELOG.md

@@ -2,6 +2,24 @@
 
 The change log describes what is "Added", "Removed", "Changed" or "Fixed" between each release. 
 
+## 2.2.0
+
+### Added
+
+- API support for Reviews. 
+- API support for Traffic. 
+- API support for issue Assignees. 
+- API support for Miscellaneous Gitignore and Emojis. 
+- Added endpoints for issue lock, unlock and issue label show. 
+- Added more parameters to `User::starred`.
+- Fluid interface by allowing `configure()` to return `$this`.
+- `configure()` support for issues API.
+
+### Fixed
+
+- Cache issue where some requests are not cached
+- Issue with `User::all()` creates a query with double question marks.
+
 ## 2.1.0
 
 ### Added

composer.json

@@ -24,20 +24,24 @@
         "php-http/discovery": "^1.0",
         "php-http/client-implementation": "^1.0",
         "php-http/client-common": "^1.3",
-        "php-http/cache-plugin": "^1.2"
+        "php-http/cache-plugin": "^1.4"
     },
     "require-dev": {
         "phpunit/phpunit": "^4.0 || ^5.5",
         "php-http/guzzle6-adapter": "^1.0",
+        "php-http/mock-client": "^1.0",
         "guzzlehttp/psr7": "^1.2",
-        "sllh/php-cs-fixer-styleci-bridge": "^1.3"
+        "sllh/php-cs-fixer-styleci-bridge": "^1.3",
+        "cache/array-adapter": "^0.4"
     },
     "autoload": {
         "psr-4": { "Github\\": "lib/Github/" }
     },
+    "minimum-stability": "dev",
+    "prefer-stable": true,
     "extra": {
         "branch-alias": {
-            "dev-master": "2.1.x-dev"
+            "dev-master": "2.3.x-dev"
         }
     }
 }

doc/README.md

@@ -48,4 +48,5 @@ Additional features:
 * [Request any Route](request_any_route.md)
 * [Customize `php-github-api`](customize.md)
 * [Running and writing tests](testing.md)
+* [Response caching](caching.md)
 * [Request / Response info](request_response_info.md)

doc/caching.md

@@ -0,0 +1,30 @@
+## Response caching
+[Back to the navigation](README.md)
+
+This example uses the PSR6 cache pool [redis-adapter](https://github.com/php-cache/redis-adapter). See http://www.php-cache.com/ for alternatives.
+
+```php
+<?php
+
+// This file is generated by Composer
+require_once 'vendor/autoload.php';
+
+use Cache\Adapter\Redis\RedisCachePool;
+
+$client = new \Redis();
+$client->connect('127.0.0.1', 6379);
+// Create a PSR6 cache pool
+$pool = new RedisCachePool($client);
+
+$client = new \Github\Client();
+$client->addCache($pool);
+
+// Do some request
+
+// Stop using cache
+$client->removeCache();
+```
+
+Using cache, the client will get cached responses if resources haven't changed since last time,
+**without** reaching the `X-Rate-Limit` [imposed by github](http://developer.github.com/v3/#rate-limiting).
+

lib/Github/Api/Integrations.php

@@ -48,9 +48,14 @@ public function findInstallations()
      *
      * @return array
      */
-    public function listRepositories($userId)
+    public function listRepositories($userId = null)
     {
-        return $this->get('/installation/repositories', ['user_id' => $userId]);
+        $parameters = array();
+        if ($userId) {
+            $parameters['user_id'] = $userId;
+        }
+
+        return $this->get('/installation/repositories', $parameters);
     }
 
     /**

lib/Github/Api/PullRequest.php

@@ -11,7 +11,8 @@
 /**
  * API for accessing Pull Requests from your Git/Github repositories.
  *
- * @link   http://developer.github.com/v3/pulls/
+ * @see   http://developer.github.com/v3/pulls/
+ *
  * @author Joseph Bielawski <[email protected]>
  */
 class PullRequest extends AbstractApi
@@ -61,7 +62,7 @@ public function all($username, $repository, array $params = array())
     {
         $parameters = array_merge(array(
             'page' => 1,
-            'per_page' => 30
+            'per_page' => 30,
         ), $params);
 
         return $this->get('/repos/'.rawurlencode($username).'/'.rawurlencode($repository).'/pulls', $parameters);
@@ -93,6 +94,24 @@ public function files($username, $repository, $id)
         return $this->get('/repos/'.rawurlencode($username).'/'.rawurlencode($repository).'/pulls/'.rawurlencode($id).'/files');
     }
 
+    /**
+     * All statuses which are the statuses of its head branch.
+     *
+     * @see http://developer.github.com/v3/pulls/
+     *
+     * @param string $username   the username
+     * @param string $repository the repository
+     * @param string $id         the ID of the pull request for which statuses are retrieved
+     *
+     * @return array array of statuses for the project
+     */
+    public function status($username, $repository, $id)
+    {
+        $link = $this->show($username, $repository, $id)['_links']['statuses']['href'];
+
+        return $this->get($link);
+    }
+
     public function comments()
     {
         return new Comments($this->client);

lib/Github/HttpClient/Builder.php

@@ -13,6 +13,7 @@
 use Http\Message\RequestFactory;
 use Http\Message\StreamFactory;
 use Psr\Cache\CacheItemPoolInterface;
+use Http\Client\Common\Plugin\Cache\Generator\HeaderCacheKeyGenerator;
 
 /**
  * A builder that builds the API client.
@@ -176,12 +177,15 @@ public function addHeaderValue($header, $headerValue)
     /**
      * Add a cache plugin to cache responses locally.
      *
-     * @param CacheItemPoolInterface $cache
+     * @param CacheItemPoolInterface $cachePool
      * @param array                  $config
      */
     public function addCache(CacheItemPoolInterface $cachePool, array $config = [])
     {
-        $this->cachePlugin = new Plugin\CachePlugin($cachePool, $this->streamFactory, $config);
+        if (!isset($config['cache_key_generator'])) {
+            $config['cache_key_generator'] = new HeaderCacheKeyGenerator(['Authorization', 'Cookie', 'Accept', 'Content-type']);
+        }
+        $this->cachePlugin = Plugin\CachePlugin::clientCache($cachePool, $this->streamFactory, $config);
         $this->httpClientModified = true;
     }
 

phpunit.xml.dist

@@ -19,7 +19,7 @@
 
     <groups>
         <exclude>
-            <group>functional</group>
+            <group>integration</group>
         </exclude>
     </groups>
 

test/Github/Tests/Api/PullRequestTest.php

@@ -101,6 +101,28 @@ public function shouldShowFilesFromPullRequest()
         $this->assertEquals($expectedArray, $api->files('ezsystems', 'ezpublish', '15'));
     }
 
+    /**
+     * @test
+     */
+    public function shouldShowStatusesFromPullRequest()
+    {
+        $expectedArray = array(array('id' => 'id', 'sha' => '123123'));
+        $expectedArray['_links']['statuses']['href'] = '/repos/ezsystems/ezpublish/pulls/15/statuses';
+
+        $api = $this->getApiMock();
+        $api->expects($this->at(0))
+            ->method('get')
+            ->with('/repos/ezsystems/ezpublish/pulls/15')
+            ->will($this->returnValue($expectedArray));
+
+        $api->expects($this->at(1))
+            ->method('get')
+            ->with('/repos/ezsystems/ezpublish/pulls/15/statuses')
+            ->will($this->returnValue($expectedArray));
+
+        $this->assertEquals($expectedArray, $api->status('ezsystems', 'ezpublish', '15'));
+    }
+
     /**
      * @test
      */
@@ -187,10 +209,10 @@ public function shouldMergePullRequestWithMergeMethod()
     public function shouldCreatePullRequestUsingTitle()
     {
         $data = array(
-            'base'  => 'master',
-            'head'  => 'virtualtestbranch',
+            'base' => 'master',
+            'head' => 'virtualtestbranch',
             'title' => 'TITLE: Testing pull-request creation from PHP Github API',
-            'body'  => 'BODY: Testing pull-request creation from PHP Github API'
+            'body' => 'BODY: Testing pull-request creation from PHP Github API',
         );
 
         $api = $this->getApiMock();
@@ -207,9 +229,9 @@ public function shouldCreatePullRequestUsingTitle()
     public function shouldCreatePullRequestUsingIssueId()
     {
         $data = array(
-            'base'  => 'master',
-            'head'  => 'virtualtestbranch',
-            'issue' => 25
+            'base' => 'master',
+            'head' => 'virtualtestbranch',
+            'issue' => 25,
         );
 
         $api = $this->getApiMock();
@@ -227,9 +249,9 @@ public function shouldCreatePullRequestUsingIssueId()
     public function shouldNotCreatePullRequestWithoutBase()
     {
         $data = array(
-            'head'  => 'virtualtestbranch',
+            'head' => 'virtualtestbranch',
             'title' => 'TITLE: Testing pull-request creation from PHP Github API',
-            'body'  => 'BODY: Testing pull-request creation from PHP Github API'
+            'body' => 'BODY: Testing pull-request creation from PHP Github API',
         );
 
         $api = $this->getApiMock();
@@ -246,9 +268,9 @@ public function shouldNotCreatePullRequestWithoutBase()
     public function shouldNotCreatePullRequestWithoutHead()
     {
         $data = array(
-            'base'  => 'master',
+            'base' => 'master',
             'title' => 'TITLE: Testing pull-request creation from PHP Github API',
-            'body'  => 'BODY: Testing pull-request creation from PHP Github API'
+            'body' => 'BODY: Testing pull-request creation from PHP Github API',
         );
 
         $api = $this->getApiMock();
@@ -265,8 +287,8 @@ public function shouldNotCreatePullRequestWithoutHead()
     public function shouldNotCreatePullRequestUsingTitleButWithoutBody()
     {
         $data = array(
-            'base'  => 'master',
-            'head'  => 'virtualtestbranch',
+            'base' => 'master',
+            'head' => 'virtualtestbranch',
             'title' => 'TITLE: Testing pull-request creation from PHP Github API',
         );
 
@@ -284,8 +306,8 @@ public function shouldNotCreatePullRequestUsingTitleButWithoutBody()
     public function shouldNotCreatePullRequestWithoutIssueIdOrTitle()
     {
         $data = array(
-            'base'  => 'master',
-            'head'  => 'virtualtestbranch',
+            'base' => 'master',
+            'head' => 'virtualtestbranch',
         );
 
         $api = $this->getApiMock();

test/Github/Tests/Functional/CacheTest.php

@@ -0,0 +1,68 @@
+<?php
+
+namespace Github\Tests\Functional;
+
+use Cache\Adapter\PHPArray\ArrayCachePool;
+use Github\Client;
+use GuzzleHttp\Psr7\Response;
+
+/**
+ * @group functional
+ *
+ * @author Tobias Nyholm <[email protected]>
+ */
+class CacheTest extends \PHPUnit_Framework_TestCase
+{
+    /**
+     * @test
+     */
+    public function shouldServeCachedResponse()
+    {
+        $mockClient = new \Http\Mock\Client();
+        $mockClient->addResponse($this->getCurrentUserResponse('nyholm'));
+        $mockClient->addResponse($this->getCurrentUserResponse('octocat'));
+
+        $github = Client::createWithHttpClient($mockClient);
+        $github->addCache(new ArrayCachePool(), ['default_ttl'=>600]);
+
+        $github->authenticate('fake_token_aaa', Client::AUTH_HTTP_TOKEN);
+        $userA = $github->currentUser()->show();
+        $this->assertEquals('nyholm', $userA['login']);
+
+        $userB = $github->currentUser()->show();
+        $this->assertEquals('nyholm', $userB['login'], 'Two request following each other should be cached.');
+    }
+    /**
+     * @test
+     */
+    public function shouldVaryOnAuthorization()
+    {
+        $mockClient = new \Http\Mock\Client();
+        $mockClient->addResponse($this->getCurrentUserResponse('nyholm'));
+        $mockClient->addResponse($this->getCurrentUserResponse('octocat'));
+
+        $github = Client::createWithHttpClient($mockClient);
+        $github->addCache(new ArrayCachePool(), ['default_ttl'=>600]);
+
+        $github->authenticate('fake_token_aaa', Client::AUTH_HTTP_TOKEN);
+        $userA = $github->currentUser()->show();
+        $this->assertEquals('nyholm', $userA['login']);
+
+        $github->authenticate('fake_token_bbb', Client::AUTH_HTTP_TOKEN);
+        $userB = $github->currentUser()->show();
+        $this->assertEquals('octocat', $userB['login'], 'We must vary on the Authorization header.');
+    }
+
+    private function getCurrentUserResponse($username)
+    {
+        $headers = [
+            'Content-Type' => 'application/json',
+        ];
+
+        $body = \GuzzleHttp\Psr7\stream_for(json_encode([
+          'login' => $username,
+        ]));
+
+        return new Response(200, $headers, $body);
+    }
+}

test/Github/Tests/Functional/CommitTest.php renamed to test/Github/Tests/Integration/CommitTest.php

@@ -1,9 +1,9 @@
 <?php
 
-namespace Github\Tests\Functional;
+namespace Github\Tests\Integration;
 
 /**
- * @group functional
+ * @group integration
  */
 class CommitTest extends TestCase
 {

test/Github/Tests/Functional/GistTest.php renamed to test/Github/Tests/Integration/GistTest.php

@@ -1,9 +1,9 @@
 <?php
 
-namespace Github\Tests\Functional;
+namespace Github\Tests\Integration;
 
 /**
- * @group functional
+ * @group integration
  */
 class GistTest extends TestCase
 {

test/Github/Tests/Functional/IssueCommentTest.php renamed to test/Github/Tests/Integration/IssueCommentTest.php

@@ -1,9 +1,9 @@
 <?php
 
-namespace Github\Tests\Functional;
+namespace Github\Tests\Integration;
 
 /**
- * @group functional
+ * @group integration
  */
 class IssueCommentTest extends TestCase
 {