Completed
Push — master ( 660d7d...79aaa7 )
by BENOIT
01:27
created

EuropeanCentralBankProvider   A

Complexity

Total Complexity 14

Size/Duplication

Total Lines 117
Duplicated Lines 0 %

Coupling/Cohesion

Components 1
Dependencies 6

Importance

Changes 0
Metric Value
dl 0
loc 117
c 0
b 0
f 0
wmc 14
lcom 1
cbo 6
rs 10

3 Methods

Rating   Name   Duplication   Size   Complexity  
A __construct() 0 10 1
C getExchangeRate() 0 46 9
A pickUrl() 0 20 4
1
<?php
2
3
namespace BenTools\Currency\Provider;
4
5
use BenTools\Currency\Model\CurrencyInterface;
6
use BenTools\Currency\Model\ExchangeRateFactoryInterface;
7
use BenTools\Currency\Model\ExchangeRateInterface;
8
use BenTools\Currency\Model\ExchangeRateNotFoundException;
9
use BenTools\Currency\Model\NativeExchangeRateFactory;
10
use DateTime;
11
use DateTimeImmutable;
12
use DateTimeInterface;
13
use DateTimeZone;
14
use Http\Client\HttpClient;
15
use Http\Discovery\HttpClientDiscovery;
16
use Http\Discovery\MessageFactoryDiscovery;
17
use Http\Message\RequestFactory;
18
use Psr\SimpleCache\CacheInterface;
19
use SimpleXMLElement;
20
21
final class EuropeanCentralBankProvider implements ExchangeRateProviderInterface
22
{
23
24
    const LIVE_FEED_URL = 'https://www.ecb.europa.eu/stats/eurofxref/eurofxref-daily.xml';
25
    const NINETYDAYS_FEED_URL = 'https://www.ecb.europa.eu/stats/eurofxref/eurofxref-hist-90d.xml';
26
    const FULL_FEED_URL = 'https://www.ecb.europa.eu/stats/eurofxref/eurofxref-hist.xml';
27
28
    /**
29
     * @var HttpClient|null
30
     */
31
    private $client;
32
33
    /**
34
     * @var RequestFactory|null
35
     */
36
    private $requestFactory;
37
38
    /**
39
     * @var ExchangeRateFactoryInterface|null
40
     */
41
    private $exchangeRateFactory;
42
43
    /**
44
     * EuropeanCentralBankProvider constructor.
45
     * @param HttpClient|null                   $client
46
     * @param RequestFactory|null               $requestFactory
47
     * @param ExchangeRateFactoryInterface|null $exchangeRateFactory
48
     * @param CacheInterface|null               $cache
49
     * @throws \Http\Discovery\Exception\NotFoundException
50
     */
51
    public function __construct(
52
        HttpClient $client = null,
53
        RequestFactory $requestFactory = null,
54
        ExchangeRateFactoryInterface $exchangeRateFactory = null,
55
        CacheInterface $cache = null
0 ignored issues
show
Unused Code introduced by
The parameter $cache is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
56
    ) {
57
        $this->client = $client ?? HttpClientDiscovery::find();
58
        $this->requestFactory = $requestFactory ?? MessageFactoryDiscovery::find();
59
        $this->exchangeRateFactory = $exchangeRateFactory ?? new NativeExchangeRateFactory();
60
    }
61
62
    /**
63
     * @inheritDoc
64
     */
65
    public function getExchangeRate(CurrencyInterface $sourceCurrency, CurrencyInterface $targetCurrency, DateTimeInterface $date = null): ExchangeRateInterface
66
    {
67
        if (null === $date) {
68
            $date = new DateTimeImmutable('now', new DateTimeZone('Europe/Paris'));
69
        }
70
71
        if ($date instanceof DateTime) {
72
            $date = DateTimeImmutable::createFromMutable($date)->setTimezone(new DateTimeZone('Europe/Paris'));
73
        }
74
75
        $dateString = $date->format('Y-m-d');
0 ignored issues
show
Bug introduced by
It seems like $date is not always an object, but can also be of type false. Maybe add an additional type check?

If a variable is not always an object, we recommend to add an additional type check to ensure your method call is safe:

function someFunction(A $objectMaybe = null)
{
    if ($objectMaybe instanceof A) {
        $objectMaybe->doSomething();
    }
}
Loading history...
76
77
        if (!in_array('EUR', [$sourceCurrency->getCode(), $targetCurrency->getCode()])) {
78
            throw new ExchangeRateNotFoundException($sourceCurrency, $targetCurrency, "ECB only provide EUR-based currency conversions.");
79
        }
80
81
        // Same currencies
82
        if ($sourceCurrency->getCode() === $targetCurrency->getCode()) {
83
            return $this->exchangeRateFactory->create($sourceCurrency, $targetCurrency, 1);
84
        }
85
86
        // Invert currencies
87
        if ('EUR' === $targetCurrency->getCode()) { // ECB only provide EUR -> *
88
            $revertExchangeRate = $this->getExchangeRate($targetCurrency, $sourceCurrency, $date);
0 ignored issues
show
Security Bug introduced by
It seems like $date defined by \DateTimeImmutable::crea...meZone('Europe/Paris')) on line 72 can also be of type false; however, BenTools\Currency\Provid...ider::getExchangeRate() does only seem to accept null|object<DateTimeInterface>, did you maybe forget to handle an error condition?

This check looks for type mismatches where the missing type is false. This is usually indicative of an error condtion.

Consider the follow example

<?php

function getDate($date)
{
    if ($date !== null) {
        return new DateTime($date);
    }

    return false;
}

This function either returns a new DateTime object or false, if there was an error. This is a typical pattern in PHP programming to show that an error has occurred without raising an exception. The calling code should check for this returned false before passing on the value to another function or method that may not be able to handle a false.

Loading history...
89
            return $this->exchangeRateFactory->create($targetCurrency, $sourceCurrency, 1 / $revertExchangeRate->getRatio());
90
        }
91
92
        $url = $this->pickUrl($date);
0 ignored issues
show
Security Bug introduced by
It seems like $date can also be of type false; however, BenTools\Currency\Provid...BankProvider::pickUrl() does only seem to accept object<DateTimeInterface>, did you maybe forget to handle an error condition?
Loading history...
93
        $response = $this->client->sendRequest($this->requestFactory->createRequest('GET', $url));
94
        $xml = new SimpleXMLElement($response->getBody());
95
96
        $rates = [];
97
        foreach ($xml->Cube->Cube as $cube) {
98
            foreach ($cube->Cube as $rate) {
99
                $currency = (string) $rate['currency'];
100
                $ratio = (float) (string) $rate['rate'];
101
                $rates[(string) $cube['time']][$currency] = $ratio;
102
            }
103
        }
104
105
        if (isset($rates[$dateString][$targetCurrency->getCode()])) {
106
            return $this->exchangeRateFactory->create($sourceCurrency, $targetCurrency, $rates[$dateString][$targetCurrency->getCode()]);
107
        }
108
109
        throw new ExchangeRateNotFoundException($sourceCurrency, $targetCurrency);
110
    }
111
112
113
    /**
114
     * @param DateTimeInterface|null $date
115
     * @return string
116
     */
117
    private function pickUrl(DateTimeInterface $date): string
118
    {
119
        if ($date instanceof DateTime) {
120
            $date = DateTimeImmutable::createFromMutable($date);
121
        }
122
123
        $today = new DateTimeImmutable('today midnight', $date->getTimezone());
124
125
126
        switch (true) {
127
            case $date->format('Y-m-d') === $today->format('Y-m-d'):
128
                return static::LIVE_FEED_URL;
129
130
            case $date >= new DateTimeImmutable('-90 days', $date->getTimezone()):
131
                return static::NINETYDAYS_FEED_URL;
132
133
            default:
134
                return static::FULL_FEED_URL;
135
        }
136
    }
137
}
138