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
<?php
/**
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
namespace Magento\Directory\Model\Currency\Import;
use Magento\Store\Model\ScopeInterface;
/**
* Currency rate import model (From http://fixer.io/)
*/
class FixerIo extends AbstractImport
{
/**
* @var string
*/
const CURRENCY_CONVERTER_URL = 'http://data.fixer.io/api/latest?access_key={{ACCESS_KEY}}'
. '&base={{CURRENCY_FROM}}&symbols={{CURRENCY_TO}}';
/**
* Http Client Factory
*
* @var \Magento\Framework\HTTP\ZendClientFactory
*/
protected $httpClientFactory;
/**
* Core scope config
*
* @var \Magento\Framework\App\Config\ScopeConfigInterface
*/
private $scopeConfig;
/**
* Initialize dependencies
*
* @param \Magento\Directory\Model\CurrencyFactory $currencyFactory
* @param \Magento\Framework\App\Config\ScopeConfigInterface $scopeConfig
* @param \Magento\Framework\HTTP\ZendClientFactory $httpClientFactory
*/
public function __construct(
\Magento\Directory\Model\CurrencyFactory $currencyFactory,
\Magento\Framework\App\Config\ScopeConfigInterface $scopeConfig,
\Magento\Framework\HTTP\ZendClientFactory $httpClientFactory
) {
parent::__construct($currencyFactory);
$this->scopeConfig = $scopeConfig;
$this->httpClientFactory = $httpClientFactory;
}
/**
* @inheritdoc
*/
public function fetchRates()
{
$data = [];
$currencies = $this->_getCurrencyCodes();
$defaultCurrencies = $this->_getDefaultCurrencyCodes();
foreach ($defaultCurrencies as $currencyFrom) {
if (!isset($data[$currencyFrom])) {
$data[$currencyFrom] = [];
}
$data = $this->convertBatch($data, $currencyFrom, $currencies);
ksort($data[$currencyFrom]);
}
return $data;
}
/**
* @inheritdoc
*/
protected function _convert($currencyFrom, $currencyTo)
{
}
/**
* Return currencies convert rates in batch mode
*
* @param array $data
* @param string $currencyFrom
* @param array $currenciesTo
* @return array
*/
private function convertBatch(array $data, string $currencyFrom, array $currenciesTo): array
{
$accessKey = $this->scopeConfig->getValue('currency/fixerio/api_key', ScopeInterface::SCOPE_STORE);
if (empty($accessKey)) {
$this->_messages[] = __('No API Key was specified or an invalid API Key was specified.');
$data[$currencyFrom] = $this->makeEmptyResponse($currenciesTo);
return $data;
}
$currenciesStr = implode(',', $currenciesTo);
$url = str_replace(
['{{ACCESS_KEY}}', '{{CURRENCY_FROM}}', '{{CURRENCY_TO}}'],
[$accessKey, $currencyFrom, $currenciesStr],
self::CURRENCY_CONVERTER_URL
);
set_time_limit(0);
try {
$response = $this->getServiceResponse($url);
} finally {
ini_restore('max_execution_time');
}
if (!$this->validateResponse($response, $currencyFrom)) {
$data[$currencyFrom] = $this->makeEmptyResponse($currenciesTo);
return $data;
}
foreach ($currenciesTo as $currencyTo) {
if ($currencyFrom == $currencyTo) {
$data[$currencyFrom][$currencyTo] = $this->_numberFormat(1);
} else {
if (empty($response['rates'][$currencyTo])) {
$this->_messages[] = __('We can\'t retrieve a rate from %1 for %2.', $url, $currencyTo);
$data[$currencyFrom][$currencyTo] = null;
} else {
$data[$currencyFrom][$currencyTo] = $this->_numberFormat(
(double)$response['rates'][$currencyTo]
);
}
}
}
return $data;
}
/**
* Get Fixer.io service response
*
* @param string $url
* @param int $retry
* @return array
*/
private function getServiceResponse(string $url, int $retry = 0): array
{
/** @var \Magento\Framework\HTTP\ZendClient $httpClient */
$httpClient = $this->httpClientFactory->create();
$response = [];
try {
$jsonResponse = $httpClient->setUri($url)
->setConfig(
[
'timeout' => $this->scopeConfig->getValue(
'currency/fixerio/timeout',
ScopeInterface::SCOPE_STORE
),
]
)
->request('GET')
->getBody();
$response = json_decode($jsonResponse, true);
} catch (\Exception $e) {
if ($retry == 0) {
$response = $this->getServiceResponse($url, 1);
}
}
return $response;
}
/**
* Validates rates response.
*
* @param array $response
* @param string $baseCurrency
* @return bool
*/
private function validateResponse(array $response, string $baseCurrency): bool
{
if ($response['success']) {
return true;
}
$errorCodes = [
101 => __('No API Key was specified or an invalid API Key was specified.'),
102 => __('The account this API request is coming from is inactive.'),
105 => __('The "%1" is not allowed as base currency for your subscription plan.', $baseCurrency),
201 => __('An invalid base currency has been entered.'),
];
$this->_messages[] = $errorCodes[$response['error']['code']] ?? __('Currency rates can\'t be retrieved.');
return false;
}
/**
* Creates array for provided currencies with empty rates.
*
* @param array $currenciesTo
* @return array
*/
private function makeEmptyResponse(array $currenciesTo): array
{
return array_fill_keys($currenciesTo, null);
}
}