Adding a factory class

Author: Nyholm

doc/api_version.md

@@ -8,6 +8,6 @@ For example:
 $client = new Github\Client();
 echo $client->getApiVersion(); // prints "v3"
 
-$client = new Github\Client($httpClient, 'v2');
+$client = new Github\Client(new Github\HttpClient\Builder($httpClient), 'v2');
 echo $client->getApiVersion(); // prints "v2"
 ```

doc/customize.md

@@ -11,7 +11,7 @@ community provided clients is found here: https://packagist.org/providers/php-ht
 You can inject a HTTP client through the `Github\Client` constructor:
 
 ```php
-$client = new Github\Client(new Http\Adapter\Guzzle6\Client());
+$client = Github\Client::createFromHttpClient(new Http\Adapter\Guzzle6\Client());
 ```
 
 ### Configure the HTTP client
@@ -39,7 +39,7 @@ class CustomUserAgentPlugin implements Plugin
 $httpBuilder = new Github\HttpClient\Builder(new Http\Adapter\Guzzle6\Client());
 $httpBuilder->addPlugin(new CustomUserAgentPlugin());
 
-$client = new Github\Client(null, $httpBuilder);
+$client = new Github\Client($httpBuilder);
 ```
 
 ### Run Test Suite

doc/security.md

@@ -54,7 +54,8 @@ The following sample code authenticates as an installation using [lcobucci/jwt](
 to generate a JSON Web Token (JWT).
 
 ```php
-$github = new Github\Client(new GuzzleClient(), 'machine-man-preview');
+$builder = new Github\HttpClient\Builder(new GuzzleClient());
+$github = new Github\Client($builder, 'machine-man-preview');
 
 $jwt = (new Builder)
     ->setIssuer($integrationId)

lib/Github/Client.php

@@ -105,15 +105,14 @@ class Client
     /**
      * Instantiate a new GitHub client.
      *
-     * @param HttpClient|null $httpClient
-     * @param Builder|null    $httpClientBuilder If a builder is provided we assume that $httpClient is added to the builder already.
-     * @param string|null     $apiVersion
-     * @param string|null     $enterpriseUrl
+     * @param Builder|null $httpClientBuilder
+     * @param string|null  $apiVersion
+     * @param string|null  $enterpriseUrl
      */
-    public function __construct(HttpClient $httpClient = null, Builder $httpClientBuilder = null, $apiVersion = null, $enterpriseUrl = null)
+    public function __construct(Builder $httpClientBuilder = null, $apiVersion = null, $enterpriseUrl = null)
     {
         $this->responseHistory = new History();
-        $this->httpClientBuilder = $builder = $httpClientBuilder ?: new Builder($httpClient);
+        $this->httpClientBuilder = $builder = $httpClientBuilder ?: new Builder();
 
         $builder->addPlugin(new GithubExceptionThrower());
         $builder->addPlugin(new Plugin\HistoryPlugin($this->responseHistory));
@@ -132,6 +131,20 @@ public function __construct(HttpClient $httpClient = null, Builder $httpClientBu
         }
     }
 
+    /**
+     * Create a Github\Client using a HttpClient.
+     *
+     * @param HttpClient $httpClient
+     *
+     * @return Client
+     */
+    public static function createFromHttpClient(HttpClient $httpClient)
+    {
+        $builder = new Builder($httpClient);
+
+        return new self($builder);
+    }
+
     /**
      * @param string $name
      *

test/Github/Tests/Api/TestCase.php

@@ -24,7 +24,7 @@ protected function getApiMock()
             ->expects($this->any())
             ->method('sendRequest');
 
-        $client = new \Github\Client($httpClient);
+        $client = \Github\Client::createFromHttpClient($httpClient);
 
         return $this->getMockBuilder($this->getApiClass())
             ->setMethods(array('get', 'post', 'postRaw', 'patch', 'delete', 'put', 'head'))

test/Github/Tests/ClientTest.php

@@ -29,7 +29,7 @@ public function shouldPassHttpClientInterfaceToConstructor()
         $httpClientMock = $this->getMockBuilder(\Http\Client\HttpClient::class)
             ->getMock();
 
-        $client = new Client($httpClientMock);
+        $client = Client::createFromHttpClient($httpClientMock);
 
         $this->assertInstanceOf(\Http\Client\HttpClient::class, $client->getHttpClient());
     }

test/Github/Tests/ResultPagerTest.php

@@ -40,7 +40,7 @@ public function shouldGetAllResults()
             ->method('sendRequest')
             ->will($this->returnValue($response));
 
-        $client = new Client($httpClientMock);
+        $client = \Github\Client::createFromHttpClient($httpClientMock);
 
         // memberApi Mock
         $memberApi = new Members($client);
@@ -87,7 +87,7 @@ public function shouldGetAllSearchResults()
             ->method('sendRequest')
             ->will($this->returnValue($response));
 
-        $client = new Client($httpClientMock);
+        $client = \Github\Client::createFromHttpClient($httpClientMock);
 
         $searchApi = new Search($client);
         $method = 'users';