-
Notifications
You must be signed in to change notification settings - Fork 3.4k
/
HttpClientTrait.php
124 lines (113 loc) · 3.98 KB
/
HttpClientTrait.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
<?php
declare(strict_types=1);
/**
* CakePHP(tm) : Rapid Development Framework (https://cakephp.org)
* Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
*
* Licensed under The MIT License
* For full copyright and license information, please see the LICENSE.txt
* Redistributions of files must retain the above copyright notice.
*
* @copyright Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
* @link https://cakephp.org CakePHP(tm) Project
* @since 4.3.0
* @license https://opensource.org/licenses/mit-license.php MIT License
*/
namespace Cake\Http\TestSuite;
use Cake\Http\Client;
use Cake\Http\Client\Response;
/**
* Define mock responses and have mocks automatically cleared.
*/
trait HttpClientTrait
{
/**
* Resets mocked responses
*
* @after
* @return void
*/
public function cleanupMockResponses(): void
{
Client::clearMockResponses();
}
/**
* Create a new response.
*
* @param int $code The response code to use. Defaults to 200
* @param list<string> $headers A list of headers for the response. Example `Content-Type: application/json`
* @param string $body The body for the response.
* @return \Cake\Http\Client\Response
*/
public function newClientResponse(int $code = 200, array $headers = [], string $body = ''): Response
{
$headers = array_merge(["HTTP/1.1 {$code}"], $headers);
return new Response($headers, $body);
}
/**
* Add a mock response for a POST request.
*
* @param string $url The URL to mock
* @param \Cake\Http\Client\Response $response The response for the mock.
* @param array<string, mixed> $options Additional options. See Client::addMockResponse()
* @return void
*/
public function mockClientPost(string $url, Response $response, array $options = []): void
{
Client::addMockResponse('POST', $url, $response, $options);
}
/**
* Add a mock response for a GET request.
*
* @param string $url The URL to mock
* @param \Cake\Http\Client\Response $response The response for the mock.
* @param array<string, mixed> $options Additional options. See Client::addMockResponse()
* @return void
*/
public function mockClientGet(string $url, Response $response, array $options = []): void
{
Client::addMockResponse('GET', $url, $response, $options);
}
/**
* Add a mock response for a PATCH request.
*
* @param string $url The URL to mock
* @param \Cake\Http\Client\Response $response The response for the mock.
* @param array<string, mixed> $options Additional options. See Client::addMockResponse()
* @return void
*/
public function mockClientPatch(string $url, Response $response, array $options = []): void
{
Client::addMockResponse('PATCH', $url, $response, $options);
}
/**
* Add a mock response for a PUT request.
*
* @param string $url The URL to mock
* @param \Cake\Http\Client\Response $response The response for the mock.
* @param array<string, mixed> $options Additional options. See Client::addMockResponse()
* @return void
*/
public function mockClientPut(string $url, Response $response, array $options = []): void
{
Client::addMockResponse('PUT', $url, $response, $options);
}
/**
* Add a mock response for a DELETE request.
*
* @param string $url The URL to mock
* @param \Cake\Http\Client\Response $response The response for the mock.
* @param array<string, mixed> $options Additional options. See Client::addMockResponse()
* @return void
*/
public function mockClientDelete(string $url, Response $response, array $options = []): void
{
Client::addMockResponse('DELETE', $url, $response, $options);
}
}
// phpcs:disable
class_alias(
'Cake\Http\TestSuite\HttpClientTrait',
'Cake\TestSuite\HttpClientTrait'
);
// phpcs:enable