Skip to content

Commit c915187

Browse files
committed
Fixed tests and docs
1 parent 511775a commit c915187

File tree

7 files changed

+13
-10
lines changed

7 files changed

+13
-10
lines changed

doc/api_version.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,6 @@ For example:
88
$client = new Github\Client();
99
echo $client->getApiVersion(); // prints "v3"
1010

11-
$client = new Github\Client(new Github\HttpClient\Builder(), 'v2');
11+
$client = new Github\Client($httpClient, 'v2');
1212
echo $client->getApiVersion(); // prints "v2"
1313
```

doc/customize.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ community provided clients is found here: https://packagist.org/providers/php-ht
1111
You can inject a HTTP client through the `Github\Client` constructor:
1212

1313
```php
14-
$client = new Github\Client(new \Github\HttpClient\Builder(new Http\Adapter\Guzzle6\Client()));
14+
$client = new Github\Client(new Http\Adapter\Guzzle6\Client());
1515
```
1616

1717
### Configure the HTTP client
@@ -36,7 +36,10 @@ class CustomUserAgentPlugin implements Plugin
3636
}
3737
}
3838

39-
$githubClient->addPlugin(new CustomUserAgentPlugin());
39+
$httpBuilder = new Github\HttpClient\Builder(new Http\Adapter\Guzzle6\Client());
40+
$httpBuilder->addPlugin(new CustomUserAgentPlugin());
41+
42+
$client = new Github\Client(null, $httpBuilder);
4043
```
4144

4245
### Run Test Suite

doc/security.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ The following sample code authenticates as an installation using [lcobucci/jwt](
5454
to generate a JSON Web Token (JWT).
5555

5656
```php
57-
$github = new Github\Client(new Github\HttpClient\Builder(), 'machine-man-preview');
57+
$github = new Github\Client(new GuzzleClient(), 'machine-man-preview');
5858

5959
$jwt = (new Builder)
6060
->setIssuer($integrationId)

lib/Github/Client.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -110,7 +110,7 @@ class Client
110110
* @param string|null $apiVersion
111111
* @param string|null $enterpriseUrl
112112
*/
113-
public function __construct(HttpClient $httpClient, Builder $httpClientBuilder = null, $apiVersion = null, $enterpriseUrl = null)
113+
public function __construct(HttpClient $httpClient = null, Builder $httpClientBuilder = null, $apiVersion = null, $enterpriseUrl = null)
114114
{
115115
$this->responseHistory = new History();
116116
$this->httpClientBuilder = $builder = $httpClientBuilder ?: new Builder($httpClient);

test/Github/Tests/Api/TestCase.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ protected function getApiMock()
2424
->expects($this->any())
2525
->method('sendRequest');
2626

27-
$client = new \Github\Client(new Builder($httpClient));
27+
$client = new \Github\Client($httpClient);
2828

2929
return $this->getMockBuilder($this->getApiClass())
3030
->setMethods(array('get', 'post', 'postRaw', 'patch', 'delete', 'put', 'head'))

test/Github/Tests/ClientTest.php

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,12 +24,12 @@ public function shouldNotHaveToPassHttpClientToConstructor()
2424
/**
2525
* @test
2626
*/
27-
public function shouldPassHttpClientBulderInterfaceToConstructor()
27+
public function shouldPassHttpClientInterfaceToConstructor()
2828
{
2929
$httpClientMock = $this->getMockBuilder(\Http\Client\HttpClient::class)
3030
->getMock();
3131

32-
$client = new Client(new Builder($httpClientMock));
32+
$client = new Client($httpClientMock);
3333

3434
$this->assertInstanceOf(\Http\Client\HttpClient::class, $client->getHttpClient());
3535
}

test/Github/Tests/ResultPagerTest.php

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ public function shouldGetAllResults()
4040
->method('sendRequest')
4141
->will($this->returnValue($response));
4242

43-
$client = new Client(new Builder($httpClientMock));
43+
$client = new Client($httpClientMock);
4444

4545
// memberApi Mock
4646
$memberApi = new Members($client);
@@ -87,7 +87,7 @@ public function shouldGetAllSearchResults()
8787
->method('sendRequest')
8888
->will($this->returnValue($response));
8989

90-
$client = new Client(new Builder($httpClientMock));
90+
$client = new Client($httpClientMock);
9191

9292
$searchApi = new Search($client);
9393
$method = 'users';

0 commit comments

Comments
 (0)