PSR-17 and HttpMethodsClientInterface

Author: GrahamCampbell

README.md

@@ -20,30 +20,29 @@ Uses [GitHub API v3](http://developer.github.com/v3/) & supports [GitHub API v4]
 ## Requirements
 
 * PHP >= 7.1
-* A [HTTP client](https://packagist.org/providers/psr/http-client-implementation)
-* A [PSR-7 implementation](https://packagist.org/providers/psr/http-message-implementation)
-* (optional) PHPUnit to run tests.
+* A [PSR-17 implementation](https://packagist.org/providers/psr/http-factory-implementation)
+* A [PSR-18 implementation](https://packagist.org/providers/psr/http-client-implementation)
 
 ## Install
 
 Via [Composer](https://getcomposer.org).
 
-### PHP 7.2+:
+### PHP 7.1+:
 
 ```bash
-composer require knplabs/github-api guzzlehttp/guzzle:^7.0.1
+composer require knplabs/github-api:^3.0 php-http/guzzle6-adapter:^2.0.1 http-interop/http-factory-guzzle:^1.0
 ```
 
-### PHP 7.1+:
+### PHP 7.2+:
 
 ```bash
-composer require knplabs/github-api php-http/guzzle6-adapter:^2.0.1
+composer require knplabs/github-api:^3.0 guzzlehttp/guzzle:^7.0.1 http-interop/http-factory-guzzle:^1.0
 ```
 
-### Laravel 5.5+:
+### Laravel 6+:
 
 ```bash
-composer require graham-campbell/github guzzlehttp/guzzle:^7.0.1
+composer require graham-campbell/github^10.0 guzzlehttp/guzzle:^7.0.1 http-interop/http-factory-guzzle:^1.0
 ```
 
 We are decoupled from any HTTP messaging client with help by [HTTPlug](http://httplug.io). Read about clients in our [docs](doc/customize.md). [graham-campbell/github](https://github.com/GrahamCampbell/Laravel-GitHub) is by [Graham Campbell](https://github.com/GrahamCampbell).

composer.json

@@ -18,30 +18,33 @@
     ],
     "require": {
         "php": "^7.1",
-        "php-http/client-common": "^2.1",
+        "php-http/client-common": "^2.2",
         "php-http/cache-plugin": "^1.7",
-        "php-http/discovery": "^1.7",
+        "php-http/discovery": "^1.9",
         "php-http/httplug": "^2.1",
+        "php-http/multipart-stream-builder": "^1.1",
         "psr/cache": "^1.0",
         "psr/http-client-implementation": "^1.0",
+        "psr/http-factory-implementation": "^1.0",
         "psr/http-message": "^1.0"
     },
     "require-dev": {
-        "phpunit/phpunit": "^7.0 || ^8.0",
-        "php-http/guzzle6-adapter": "^2.0",
-        "php-http/mock-client": "^1.2",
-        "guzzlehttp/psr7": "^1.2",
-        "cache/array-adapter": "^0.4",
-        "phpstan/phpstan": "^0.12.23"
+        "cache/array-adapter": "^1.0.1",
+        "guzzlehttp/psr7": "^1.5.2",
+        "http-interop/http-factory-guzzle": "^1.0",
+        "php-http/guzzle6-adapter": "^2.0.1",
+        "php-http/mock-client": "^1.4",
+        "phpstan/phpstan": "^0.12.32",
+        "phpstan/extension-installer": "^1.0.4",
+        "phpstan/phpstan-deprecation-rules": "^0.12.4",
+        "phpunit/phpunit": "^7.5.15 || ^8.4 || ^9.0"
     },
     "autoload": {
         "psr-4": { "Github\\": "lib/Github/" }
     },
     "autoload-dev": {
         "psr-4": { "Github\\Tests\\": "test/Github/Tests/"}
     },
-    "minimum-stability": "dev",
-    "prefer-stable": true,
     "extra": {
         "branch-alias": {
             "dev-master": "3.0.x-dev"

lib/Github/Client.php

@@ -10,9 +10,9 @@
 use Github\HttpClient\Plugin\GithubExceptionThrower;
 use Github\HttpClient\Plugin\History;
 use Github\HttpClient\Plugin\PathPrepend;
-use Http\Client\Common\HttpMethodsClient;
+use Http\Client\Common\HttpMethodsClientInterface;
 use Http\Client\Common\Plugin;
-use Http\Discovery\UriFactoryDiscovery;
+use Http\Discovery\Psr17FactoryDiscovery;
 use Psr\Cache\CacheItemPoolInterface;
 use Psr\Http\Client\ClientInterface;
 
@@ -116,12 +116,12 @@ class Client
     public function __construct(Builder $httpClientBuilder = null, $apiVersion = null, $enterpriseUrl = null)
     {
         $this->responseHistory = new History();
-        $this->httpClientBuilder = $builder = $httpClientBuilder ?: new Builder();
+        $this->httpClientBuilder = $builder = $httpClientBuilder ?? new Builder();
 
         $builder->addPlugin(new GithubExceptionThrower());
         $builder->addPlugin(new Plugin\HistoryPlugin($this->responseHistory));
         $builder->addPlugin(new Plugin\RedirectPlugin());
-        $builder->addPlugin(new Plugin\AddHostPlugin(UriFactoryDiscovery::find()->createUri('https://api.github.com')));
+        $builder->addPlugin(new Plugin\AddHostPlugin(Psr17FactoryDiscovery::findUrlFactory()->createUri('https://api.github.com')));
         $builder->addPlugin(new Plugin\HeaderDefaultsPlugin([
             'User-Agent' => 'php-github-api (http://github.com/KnpLabs/php-github-api)',
         ]));
@@ -331,7 +331,7 @@ private function setEnterpriseUrl($enterpriseUrl)
         $builder->removePlugin(Plugin\AddHostPlugin::class);
         $builder->removePlugin(PathPrepend::class);
 
-        $builder->addPlugin(new Plugin\AddHostPlugin(UriFactoryDiscovery::find()->createUri($enterpriseUrl)));
+        $builder->addPlugin(new Plugin\AddHostPlugin(Psr17FactoryDiscovery::findUrlFactory()->createUri($enterpriseUrl)));
         $builder->addPlugin(new PathPrepend(sprintf('/api/%s', $this->getApiVersion())));
     }
 
@@ -390,7 +390,7 @@ public function getLastResponse()
     }
 
     /**
-     * @return HttpMethodsClient
+     * @return HttpMethodsClientInterface
      */
     public function getHttpClient()
     {

lib/Github/HttpClient/Builder.php

@@ -3,16 +3,16 @@
 namespace Github\HttpClient;
 
 use Http\Client\Common\HttpMethodsClient;
+use Http\Client\Common\HttpMethodsClientInterface;
 use Http\Client\Common\Plugin;
 use Http\Client\Common\Plugin\Cache\Generator\HeaderCacheKeyGenerator;
 use Http\Client\Common\PluginClientFactory;
-use Http\Discovery\MessageFactoryDiscovery;
+use Http\Discovery\Psr17FactoryDiscovery;
 use Http\Discovery\Psr18ClientDiscovery;
-use Http\Discovery\StreamFactoryDiscovery;
-use Http\Message\RequestFactory;
-use Http\Message\StreamFactory;
 use Psr\Cache\CacheItemPoolInterface;
 use Psr\Http\Client\ClientInterface;
+use Psr\Http\Message\RequestFactoryInterface;
+use Psr\Http\Message\StreamFactoryInterface;
 
 /**
  * A builder that builds the API client.
@@ -32,17 +32,17 @@ class Builder
     /**
      * A HTTP client with all our plugins.
      *
-     * @var HttpMethodsClient
+     * @var HttpMethodsClientInterface
      */
     private $pluginClient;
 
     /**
-     * @var RequestFactory
+     * @var RequestFactoryInterface
      */
     private $requestFactory;
 
     /**
-     * @var StreamFactory
+     * @var StreamFactoryInterface
      */
     private $streamFactory;
 
@@ -73,22 +73,22 @@ class Builder
     private $headers = [];
 
     /**
-     * @param ClientInterface $httpClient
-     * @param RequestFactory  $requestFactory
-     * @param StreamFactory   $streamFactory
+     * @param ClientInterface|null         $httpClient
+     * @param RequestFactoryInterface|null $requestFactory
+     * @param StreamFactoryInterface|null  $streamFactory
      */
     public function __construct(
         ClientInterface $httpClient = null,
-        RequestFactory $requestFactory = null,
-        StreamFactory $streamFactory = null
+        RequestFactoryInterface $requestFactory = null,
+        StreamFactoryInterface $streamFactory = null
     ) {
-        $this->httpClient = $httpClient ?: Psr18ClientDiscovery::find();
-        $this->requestFactory = $requestFactory ?: MessageFactoryDiscovery::find();
-        $this->streamFactory = $streamFactory ?: StreamFactoryDiscovery::find();
+        $this->httpClient = $httpClient ?? Psr18ClientDiscovery::find();
+        $this->requestFactory = $requestFactory ?? Psr17FactoryDiscovery::findRequestFactory();
+        $this->streamFactory = $streamFactory ?? Psr17FactoryDiscovery::findStreamFactory();
     }
 
     /**
-     * @return HttpMethodsClient
+     * @return HttpMethodsClientInterface
      */
     public function getHttpClient()
     {

test/Github/Tests/Api/AbstractApiTest.php

@@ -209,19 +209,12 @@ protected function getClientMock()
      *
      * @param array $methods
      *
-     * @return \Http\Client\Common\HttpMethodsClient
+     * @return \Http\Client\Common\HttpMethodsClientInterface
      */
     protected function getHttpMethodsMock(array $methods = [])
     {
-        if (interface_exists(HttpMethodsClientInterface::class)) {
-            $mock = $this->createMock(HttpMethodsClientInterface::class);
-        } else {
-            $methods = array_merge(['sendRequest'], $methods);
-            $mock = $this->getMockBuilder(\Http\Client\Common\HttpMethodsClient::class)
-                ->disableOriginalConstructor()
-                ->setMethods($methods)
-                ->getMock();
-        }
+        $mock = $this->createMock(HttpMethodsClientInterface::class);
+
         $mock
             ->expects($this->any())
             ->method('sendRequest');

test/Github/Tests/Api/RateLimitTest.php

@@ -37,11 +37,9 @@ class RateLimitTest extends TestCase
     protected $api;
 
     /**
-     * Used to construct common expectations for the API input data in each unit test.
-     *
-     * {@inheritdoc}
+     * @before
      */
-    protected function setUp(): void
+    public function initMocks()
     {
         $this->api = $this->getApiMock();
         $this->api->expects($this->once())

test/Github/Tests/Integration/TestCase.php

@@ -16,7 +16,10 @@ class TestCase extends \PHPUnit\Framework\TestCase
      */
     protected $client;
 
-    public function setUp(): void
+    /**
+     * @before
+     */
+    public function initClient()
     {
         // You have to specify authentication here to run full suite
         $client = new Client();