-
Notifications
You must be signed in to change notification settings - Fork 31
/
ApiClient.php
208 lines (196 loc) · 7.58 KB
/
ApiClient.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
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
<?php
namespace Hyperwallet\Util;
use GuzzleHttp\Client;
use GuzzleHttp\Exception\BadResponseException;
use GuzzleHttp\Exception\ConnectException;
use GuzzleHttp\UriTemplate;
use Hyperwallet\Exception\HyperwalletApiException;
use Hyperwallet\Exception\HyperwalletException;
use Hyperwallet\Model\BaseModel;
use Hyperwallet\Response\ErrorResponse;
use Hyperwallet\Util\HyperwalletEncryption;
/**
* The internal API client
*
* @package Hyperwallet\Util
*/
class ApiClient {
/**
* The SDK version number
*
* @var string
*/
const VERSION = '0.1.0';
/**
* The Guzzle http client
*
* @var Client
*/
private $client;
/**
* The Encryption service for http client requests/responses
*
* @var HyperwalletEncryption
*/
private $encryption;
/**
* Boolean flag that checks if ApiClient is constructed with encryption enabled or not
*
* @var boolean
*/
private $isEncrypted = false;
/**
* Creates a instance of the API client
*
* @param string $username The API username
* @param string $password The API password
* @param string $server The API server to connect to
* @param array $clientOptions Guzzle Client Options
* @param array $encryptionData Encryption data to initialize ApiClient with encryption enabled
*/
public function __construct($username, $password, $server, $clientOptions = array(), $encryptionData = array()) {
// Setup http client if not specified
$this->client = new Client(array_merge_recursive(array(
'base_uri' => $server,
'auth' => array($username, $password),
'headers' => array(
'User-Agent' => 'Hyperwallet PHP SDK v' . self::VERSION,
'Accept' => 'application/json'
)
), $clientOptions));
if (!empty($encryptionData) && isset($encryptionData['clientPrivateKeySetLocation']) &&
isset($encryptionData['hyperwalletKeySetLocation'])) {
$this->isEncrypted = true;
$this->encryption = new HyperwalletEncryption($encryptionData['clientPrivateKeySetLocation'], $encryptionData['hyperwalletKeySetLocation']);
}
}
/**
* Do a POST call to the Hyperwallet API server
*
* @param string $partialUrl The url template
* @param array $uriParams The url template parameters
* @param BaseModel $data The data to submit
* @param array $query Query parameters
* @param array $headers Additional headers
* @return array
*
* @throws HyperwalletApiException
*/
public function doPost($partialUrl, array $uriParams, BaseModel $data = null, array $query = array(), array $headers = array()) {
return $this->doRequest('POST', $partialUrl, $uriParams, array(
'query' => $query,
'body' => $data ? \GuzzleHttp\json_encode($data->getPropertiesForCreate(), JSON_FORCE_OBJECT) : '{}',
'headers' => array_merge($headers, array(
'Content-Type' => 'application/json'
))
));
}
/**
* Do a PUT call to the Hyperwallet API server
*
* @param string $partialUrl The url template
* @param array $uriParams The url template parameters
* @param BaseModel $data The data to update
* @param array $query Query parameters
* @return array
*
* @throws HyperwalletApiException
*/
public function doPut($partialUrl, array $uriParams, BaseModel $data, array $query) {
return $this->doRequest('PUT', $partialUrl, $uriParams, array(
'query' => $query,
'body' => \GuzzleHttp\json_encode($data->getPropertiesForUpdate(), JSON_FORCE_OBJECT),
'headers' => array(
'Content-Type' => 'application/json'
)
));
}
/**
* Do a GET call to the Hyperwallet API server
*
* @param string $partialUrl The url template
* @param array $uriParams The url template parameters
* @param array $query Query parameters
* @return array
*
* @throws HyperwalletApiException
*/
public function doGet($partialUrl, array $uriParams, array $query) {
return $this->doRequest('GET', $partialUrl, $uriParams, array(
'query' => $query
));
}
/**
* Execute API call and map error messages
*
* @param string $method The http method
* @param string $url The url template
* @param array $urlParams The url template parameters
* @param array $options The request options
* @return array
*
* @throws HyperwalletApiException
*/
private function doRequest($method, $url, array $urlParams, array $options) {
try {
$uri = new UriTemplate();
if (!isset($options['headers'])) {
$options[] = array('headers' => array());
}
$options['headers']['Accept'] = 'application/json';
if ($this->isEncrypted) {
$options['headers']['Accept'] = 'application/jose+json';
$options['headers']['Content-Type'] = 'application/jose+json';
if (isset($options['body'])) {
$options['body'] = $this->encryption->encrypt(json_decode($options['body'], true));
}
}
$response = $this->client->request($method, $uri->expand($url, $urlParams), $options);
if ($response->getStatusCode() === 204) {
return array();
}
$this->checkResponseHeaderContentType($response);
$body = $this->isEncrypted ? \GuzzleHttp\json_decode(\GuzzleHttp\json_encode($this->encryption->decrypt($response->getBody())), true) :
\GuzzleHttp\json_decode($response->getBody(), true);
if (isset($body['links'])) {
unset($body['links']);
}
return $body;
} catch (ConnectException $e) {
$errorResponse = new ErrorResponse(0, array('errors' => array(
array(
'message' => 'Could not communicate with ' . $this->client->getConfig('base_uri'),
'code' => 'COMMUNICATION_ERROR'
)
)));
throw new HyperwalletApiException($errorResponse, $e);
} catch (BadResponseException $e) {
$body = \GuzzleHttp\json_decode($e->getResponse()->getBody(), true);
if (is_null($body) || !isset($body['errors']) || empty($body['errors'])) {
$body = array('errors' => array(
array(
'message' => 'Failed to get any error message from response',
'code' => 'BAD_REQUEST'
)
));
}
$errorResponse = new ErrorResponse($e->getResponse()->getStatusCode(), $body);
throw new HyperwalletApiException($errorResponse, $e);
}
}
/**
* Checks whether Content-Type header is valid in response
*
* @param string $response Response to be checked
*
* @throws HyperwalletException
*/
private function checkResponseHeaderContentType($response) {
$contentType = implode('', $response->getHeader('Content-Type'));
$expectedContentType = $this->isEncrypted ? 'application/jose+json' : 'application/json';
$invalidContentType = $response->getStatusCode() !== 204 && !empty($contentType) && strpos($contentType, $expectedContentType) === false;
if ($invalidContentType) {
throw new HyperwalletException('Invalid Content-Type specified in Response Header');
}
}
}