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
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
|
<?php
/*
* Copyright (C) 2013-2016 Mailgun
*
* This software may be modified and distributed under the terms
* of the MIT license. See the LICENSE file for details.
*/
namespace Mailgun\Api;
use Http\Client\Exception as HttplugException;
use Http\Client\HttpClient;
use Mailgun\Exception\UnknownErrorException;
use Mailgun\Hydrator\Hydrator;
use Mailgun\Hydrator\NoopHydrator;
use Mailgun\Exception\HttpClientException;
use Mailgun\Exception\HttpServerException;
use Mailgun\RequestBuilder;
use Psr\Http\Message\ResponseInterface;
/**
* @author Tobias Nyholm <tobias.nyholm@gmail.com>
*/
abstract class HttpApi
{
/**
* The HTTP client.
*
* @var HttpClient
*/
private $httpClient;
/**
* @var Hydrator
*/
protected $hydrator;
/**
* @var RequestBuilder
*/
protected $requestBuilder;
/**
* @param HttpClient $httpClient
* @param RequestBuilder $requestBuilder
* @param Hydrator $hydrator
*/
public function __construct(HttpClient $httpClient, RequestBuilder $requestBuilder, Hydrator $hydrator)
{
$this->httpClient = $httpClient;
$this->requestBuilder = $requestBuilder;
if (!$hydrator instanceof NoopHydrator) {
$this->hydrator = $hydrator;
}
}
/**
* @param ResponseInterface $response
* @param string $class
*
* @return mixed|ResponseInterface
*
* @throws \Exception
*/
protected function hydrateResponse(ResponseInterface $response, $class)
{
if (!$this->hydrator) {
return $response;
}
if ($response->getStatusCode() !== 200 && $response->getStatusCode() !== 201) {
$this->handleErrors($response);
}
return $this->hydrator->hydrate($response, $class);
}
/**
* Throw the correct exception for this error.
*
* @param ResponseInterface $response
*
* @throws \Exception
*/
protected function handleErrors(ResponseInterface $response)
{
$statusCode = $response->getStatusCode();
switch ($statusCode) {
case 400:
throw HttpClientException::badRequest($response);
case 401:
throw HttpClientException::unauthorized($response);
case 402:
throw HttpClientException::requestFailed($response);
case 404:
throw HttpClientException::notFound($response);
case 500 <= $statusCode:
throw HttpServerException::serverError($statusCode);
default:
throw new UnknownErrorException();
}
}
/**
* Send a GET request with query parameters.
*
* @param string $path Request path
* @param array $parameters GET parameters
* @param array $requestHeaders Request Headers
*
* @return ResponseInterface
*/
protected function httpGet($path, array $parameters = [], array $requestHeaders = [])
{
if (count($parameters) > 0) {
$path .= '?'.http_build_query($parameters);
}
try {
$response = $this->httpClient->sendRequest(
$this->requestBuilder->create('GET', $path, $requestHeaders)
);
} catch (HttplugException\NetworkException $e) {
throw HttpServerException::networkError($e);
}
return $response;
}
/**
* Send a POST request with parameters.
*
* @param string $path Request path
* @param array $parameters POST parameters
* @param array $requestHeaders Request headers
*
* @return ResponseInterface
*/
protected function httpPost($path, array $parameters = [], array $requestHeaders = [])
{
return $this->httpPostRaw($path, $this->createRequestBody($parameters), $requestHeaders);
}
/**
* Send a POST request with raw data.
*
* @param string $path Request path
* @param array|string $body Request body
* @param array $requestHeaders Request headers
*
* @return ResponseInterface
*/
protected function httpPostRaw($path, $body, array $requestHeaders = [])
{
try {
$response = $this->httpClient->sendRequest(
$this->requestBuilder->create('POST', $path, $requestHeaders, $body)
);
} catch (HttplugException\NetworkException $e) {
throw HttpServerException::networkError($e);
}
return $response;
}
/**
* Send a PUT request.
*
* @param string $path Request path
* @param array $parameters PUT parameters
* @param array $requestHeaders Request headers
*
* @return ResponseInterface
*/
protected function httpPut($path, array $parameters = [], array $requestHeaders = [])
{
try {
$response = $this->httpClient->sendRequest(
$this->requestBuilder->create('PUT', $path, $requestHeaders, $this->createRequestBody($parameters))
);
} catch (HttplugException\NetworkException $e) {
throw HttpServerException::networkError($e);
}
return $response;
}
/**
* Send a DELETE request.
*
* @param string $path Request path
* @param array $parameters DELETE parameters
* @param array $requestHeaders Request headers
*
* @return ResponseInterface
*/
protected function httpDelete($path, array $parameters = [], array $requestHeaders = [])
{
try {
$response = $this->httpClient->sendRequest(
$this->requestBuilder->create('DELETE', $path, $requestHeaders, $this->createRequestBody($parameters))
);
} catch (HttplugException\NetworkException $e) {
throw HttpServerException::networkError($e);
}
return $response;
}
/**
* Prepare a set of key-value-pairs to be encoded as multipart/form-data.
*
* @param array $parameters Request parameters
*
* @return array
*/
protected function createRequestBody(array $parameters)
{
$resources = [];
foreach ($parameters as $key => $values) {
if (!is_array($values)) {
$values = [$values];
}
foreach ($values as $value) {
$resources[] = [
'name' => $key,
'content' => $value,
];
}
}
return $resources;
}
}
|
