class-wc-rest-payments-terminal-locations-controller.php
9.37 KB
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
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
<?php
/**
* Class WC_REST_Payments_Terminal_Locations_Controller
*
* @package WooCommerce\Payments\Admin
*/
defined( 'ABSPATH' ) || exit;
use WCPay\Exceptions\API_Exception;
/**
* REST controller for account details and status.
*/
class WC_REST_Payments_Terminal_Locations_Controller extends WC_Payments_REST_Controller {
const STORE_LOCATIONS_TRANSIENT_KEY = 'wcpay_store_terminal_locations';
/**
* Endpoint path.
*
* @var string
*/
protected $rest_base = 'payments/terminal/locations';
/**
* Configure REST API routes.
*/
public function register_routes() {
register_rest_route(
$this->namespace,
$this->rest_base . '/store',
[
'methods' => WP_REST_Server::READABLE,
'callback' => [ $this, 'get_store_location' ],
'permission_callback' => [ $this, 'check_permission' ],
]
);
register_rest_route(
$this->namespace,
'/' . $this->rest_base . '/(?P<location_id>\w+)',
[
'methods' => WP_REST_Server::DELETABLE,
'callback' => [ $this, 'delete_location' ],
'permission_callback' => [ $this, 'check_permission' ],
]
);
register_rest_route(
$this->namespace,
'/' . $this->rest_base . '/(?P<location_id>\w+)',
[
'methods' => WP_REST_Server::CREATABLE,
'callback' => [ $this, 'update_location' ],
'permission_callback' => [ $this, 'check_permission' ],
'args' => [
'display_name' => [
'type' => 'string',
'required' => false,
],
'address' => [
'type' => 'object',
'required' => false,
],
],
]
);
register_rest_route(
$this->namespace,
'/' . $this->rest_base . '/(?P<location_id>\w+)',
[
'methods' => WP_REST_Server::READABLE,
'callback' => [ $this, 'get_location' ],
'permission_callback' => [ $this, 'check_permission' ],
]
);
register_rest_route(
$this->namespace,
'/' . $this->rest_base,
[
'methods' => WP_REST_Server::CREATABLE,
'callback' => [ $this, 'create_location' ],
'permission_callback' => [ $this, 'check_permission' ],
'args' => [
'display_name' => [
'type' => 'string',
'required' => true,
],
'address' => [
'type' => 'object',
'required' => true,
],
],
]
);
register_rest_route(
$this->namespace,
'/' . $this->rest_base,
[
'methods' => WP_REST_Server::READABLE,
'callback' => [ $this, 'get_all_locations' ],
'permission_callback' => [ $this, 'check_permission' ],
]
);
}
/**
* Get store terminal location.
*
* @param WP_REST_Request $request Request object.
*
* @return WP_REST_Response|WP_Error
*/
public function get_store_location( $request ) {
$store_address = WC()->countries;
$location_address = array_filter(
[
'city' => $store_address->get_base_city(),
'country' => $store_address->get_base_country(),
'line1' => $store_address->get_base_address(),
'line2' => $store_address->get_base_address_2(),
'postal_code' => $store_address->get_base_postcode(),
'state' => $store_address->get_base_state(),
]
);
// If address is not populated, emit an error and specify the URL where this can be done.
// See also https://tosbourn.com/list-of-countries-without-a-postcode/ when launching in new countries.
$is_address_populated = isset( $location_address['country'], $location_address['city'], $location_address['postal_code'], $location_address['line1'] );
if ( ! $is_address_populated ) {
return rest_ensure_response(
new \WP_Error(
'store_address_is_incomplete',
admin_url(
add_query_arg(
[
'page' => 'wc-settings',
'tab' => 'general',
],
'admin.php'
)
)
)
);
}
try {
// Check the existing locations to see if one of them matches the store.
// Originally we picked `get_bloginfo` for generating names, but later switched to `site_url` for max immutability.
$store_hostname = str_replace( [ 'https://', 'http://' ], '', get_site_url() );
$possible_names = [ get_bloginfo(), $store_hostname ];
foreach ( $this->fetch_locations() as $location ) {
if ( in_array( $location['display_name'], $possible_names, true ) ) {
$matching_address_fields = array_intersect( $location['address'], $location_address );
if ( count( $matching_address_fields ) === count( $location_address ) ) {
return rest_ensure_response( $this->extract_location_fields( $location ) );
}
}
}
// If the location is missing, Create a new one and actualize the transient.
$location = $this->api_client->create_terminal_location( $store_hostname, $location_address );
$this->reload_locations();
return rest_ensure_response( $this->extract_location_fields( $location ) );
} catch ( API_Exception $e ) {
return rest_ensure_response( new WP_Error( $e->get_error_code(), $e->getMessage() ) );
}
}
/**
* Proxies the delete location request to the server.
*
* @param WP_REST_Request $request Request object.
* @return WP_REST_Response|WP_Error
*/
public function delete_location( $request ) {
try {
// Delete the location and reload the transient.
$location = $this->api_client->delete_terminal_location( $request->get_param( 'location_id' ) );
$this->reload_locations();
return rest_ensure_response( $location );
} catch ( API_Exception $e ) {
return rest_ensure_response( new WP_Error( $e->get_error_code(), $e->getMessage() ) );
}
}
/**
* Proxies the update location request to the server.
*
* @param WP_REST_Request $request Request object.
* @return WP_REST_Response|WP_Error
*/
public function update_location( $request ) {
try {
// Update the location and reload the transient.
$location = $this->api_client->update_terminal_location( $request->get_param( 'location_id' ), $request['display_name'], $request['address'] );
$this->reload_locations();
return rest_ensure_response( $this->extract_location_fields( $location ) );
} catch ( API_Exception $e ) {
return rest_ensure_response( new WP_Error( $e->get_error_code(), $e->getMessage() ) );
}
}
/**
* Proxies the get location request to the server.
*
* @param WP_REST_Request $request Request object.
* @return WP_REST_Response|WP_Error
*/
public function get_location( $request ) {
try {
// Check if the location is already in the transient.
$location_id = $request->get_param( 'location_id' );
foreach ( $this->fetch_locations() as $location ) {
if ( $location['id'] === $location_id ) {
return rest_ensure_response( $this->extract_location_fields( $location ) );
}
}
// If the location is missing, fetch it individually and reload the transient.
$location = $this->api_client->get_terminal_location( $location_id );
$this->reload_locations();
return rest_ensure_response( $this->extract_location_fields( $location ) );
} catch ( API_Exception $e ) {
return rest_ensure_response( new WP_Error( $e->get_error_code(), $e->getMessage() ) );
}
}
/**
* Proxies the create location request to the server.
*
* @param WP_REST_Request $request Request object.
* @return WP_REST_Response|WP_Error
*/
public function create_location( $request ) {
try {
// Create location and reload the transient.
$location = $this->api_client->create_terminal_location( $request['display_name'], $request['address'] );
$this->reload_locations();
return rest_ensure_response( $this->extract_location_fields( $location ) );
} catch ( API_Exception $e ) {
return rest_ensure_response( new WP_Error( $e->get_error_code(), $e->getMessage() ) );
}
}
/**
* Proxies the get all locations request to the server.
*
* @param WP_REST_Request $request Request object.
* @return WP_REST_Response|WP_Error
*/
public function get_all_locations( $request ) {
try {
return rest_ensure_response( array_map( [ $this, 'extract_location_fields' ], $this->fetch_locations() ) );
} catch ( API_Exception $e ) {
return rest_ensure_response( new WP_Error( $e->get_error_code(), $e->getMessage() ) );
}
}
/**
* Extracts the relevant fields from a terminal location object.
*
* @param array $location The location.
* @return array The picked fields from location object.
*/
private function extract_location_fields( array $location ): array {
return [
'id' => $location['id'],
'address' => $location['address'],
'display_name' => $location['display_name'],
'livemode' => $location['livemode'],
];
}
/**
* Attempts to read locations from transient and re-populates it if needed.
*
* @return array Terminal locations.
* @throws API_Exception If request to server fails.
*/
private function fetch_locations(): array {
$locations = get_transient( static::STORE_LOCATIONS_TRANSIENT_KEY );
if ( ! $locations ) {
$locations = $this->api_client->get_terminal_locations();
set_transient( static::STORE_LOCATIONS_TRANSIENT_KEY, $locations, DAY_IN_SECONDS );
}
return $locations;
}
/**
* Refreshes the locations stored in transient.
*
* @return void
* @throws API_Exception If request to server fails.
*/
private function reload_locations() {
$locations = $this->api_client->get_terminal_locations();
set_transient( static::STORE_LOCATIONS_TRANSIENT_KEY, $locations, DAY_IN_SECONDS );
}
}