FixerIOProvider::__construct() - Code Metrics - Inspection of "New providers" - bpolaszek/currency - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( ca4577...8a3c51 )

by BENOIT

created 2018-03-30 10:52 UTC

FixerIOProvider::__construct() A

↳ Parent: FixerIOProvider

Complexity

Conditions	1
Paths	1

Size

Total Lines	12
Code Lines	10

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	12
rs	9.4285
c	0
b	0
f	0
cc	1
eloc	10
nc	1
nop	5

<?php

namespace BenTools\Currency\Provider;

use BenTools\Currency\Model\CurrencyInterface;
use BenTools\Currency\Model\ExchangeRateFactoryInterface;
use BenTools\Currency\Model\ExchangeRateInterface;
use BenTools\Currency\Model\ExchangeRateNotFoundException;
use BenTools\Currency\Model\NativeExchangeRateFactory;
use DateTime;
use DateTimeImmutable;
use DateTimeInterface;
use DateTimeZone;
use Http\Client\HttpClient;
use Http\Discovery\HttpClientDiscovery;
use Http\Discovery\MessageFactoryDiscovery;
use Http\Message\RequestFactory;
use Psr\SimpleCache\CacheInterface;

class FixerIOProvider implements ExchangeRateProviderInterface
{
    /**
     * @var string
     */
    private $accessKey;

    /**
     * @var HttpClient|null
     */
    private $client;

    /**
     * @var RequestFactory|null
     */
    private $requestFactory;

    /**
     * @var ExchangeRateFactoryInterface|null
     */
    private $exchangeRateFactory;

    /**
     * OpenExchangeRatesProvider constructor.
     * @param string                            $accessKey
     * @param HttpClient|null                   $client
     * @param RequestFactory|null               $requestFactory
     * @param ExchangeRateFactoryInterface|null $exchangeRateFactory
     * @param CacheInterface|null               $cache
     * @throws \Http\Discovery\Exception\NotFoundException
     */
    public function __construct(
        string $accessKey,
        HttpClient $client = null,
        RequestFactory $requestFactory = null,
        ExchangeRateFactoryInterface $exchangeRateFactory = null,
        CacheInterface $cache = null

    ) {
        $this->accessKey = $accessKey;
        $this->client = $client ?? HttpClientDiscovery::find();
        $this->requestFactory = $requestFactory ?? MessageFactoryDiscovery::find();
        $this->exchangeRateFactory = $exchangeRateFactory ?? new NativeExchangeRateFactory();
    }

    /**
     * @inheritDoc
     */
    public function getExchangeRate(CurrencyInterface $sourceCurrency, CurrencyInterface $targetCurrency, DateTimeInterface $date = null): ExchangeRateInterface
    {
        if (null === $date) {
            $date = new DateTimeImmutable('now', new DateTimeZone('GMT'));
        }

        if ($date instanceof DateTime) {
            $date = DateTimeImmutable::createFromMutable($date)->setTimezone(new DateTimeZone('GMT'));
        }

        if (!in_array('EUR', [$sourceCurrency->getCode(), $targetCurrency->getCode()])) {
            throw new ExchangeRateNotFoundException($sourceCurrency, $targetCurrency, "FixerIO Free plan only provide USD-based currency conversions.");
        }

        // Same currencies
        if ($sourceCurrency->getCode() === $targetCurrency->getCode()) {
            return $this->exchangeRateFactory->create($sourceCurrency, $targetCurrency, 1);
        }

        // Invert currencies
        if ('EUR' === $targetCurrency->getCode()) { // FixerIO free plan only provide EUR -> *
            return $this->getExchangeRate($targetCurrency, $sourceCurrency, $date)->invertCurrencies();
<?php

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

    return false;
}
        }

        $url = sprintf('http://data.fixer.io/api/%s?access_key=%s', $date->format('Y-m-d'), $this->accessKey);
function someFunction(A $objectMaybe = null)
{
    if ($objectMaybe instanceof A) {
        $objectMaybe->doSomething();
    }
}
        $response = $this->client->sendRequest($this->requestFactory->createRequest('GET', $url));
        $json = json_decode((string) $response->getBody(), true);
        if (isset($json['rates'][$targetCurrency->getCode()])) {
            return $this->exchangeRateFactory->create($sourceCurrency, $targetCurrency, $json['rates'][$targetCurrency->getCode()]);
        }

        throw new ExchangeRateNotFoundException($sourceCurrency, $targetCurrency);
    }
}


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
20			class FixerIOProvider implements ExchangeRateProviderInterface
21			{
22			/**
23			* @var string
24			*/
25			private $accessKey;
26
27			/**
28			* @var HttpClient\|null
29			*/
30			private $client;
31
32			/**
33			* @var RequestFactory\|null
34			*/
35			private $requestFactory;
36
37			/**
38			* @var ExchangeRateFactoryInterface\|null
39			*/
40			private $exchangeRateFactory;
41
42			/**
43			* OpenExchangeRatesProvider constructor.
44			* @param string $accessKey
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			string $accessKey,
53			HttpClient $client = null,
54			RequestFactory $requestFactory = null,
55			ExchangeRateFactoryInterface $exchangeRateFactory = null,
56			CacheInterface $cache = null
			0 ignored issues – show Unused Code introduced 2018-03-30 10:55 UTC by Report Bug Copy Issue Report 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...
57			) {
58			$this->accessKey = $accessKey;
59			$this->client = $client ?? HttpClientDiscovery::find();
60			$this->requestFactory = $requestFactory ?? MessageFactoryDiscovery::find();
61			$this->exchangeRateFactory = $exchangeRateFactory ?? new NativeExchangeRateFactory();
62			}
63
64			/**
65			* @inheritDoc
66			*/
67			public function getExchangeRate(CurrencyInterface $sourceCurrency, CurrencyInterface $targetCurrency, DateTimeInterface $date = null): ExchangeRateInterface
68			{
69			if (null === $date) {
70			$date = new DateTimeImmutable('now', new DateTimeZone('GMT'));
71			}
72
73			if ($date instanceof DateTime) {
74			$date = DateTimeImmutable::createFromMutable($date)->setTimezone(new DateTimeZone('GMT'));
75			}
76
77			if (!in_array('EUR', [$sourceCurrency->getCode(), $targetCurrency->getCode()])) {
78			throw new ExchangeRateNotFoundException($sourceCurrency, $targetCurrency, "FixerIO Free plan only provide USD-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()) { // FixerIO free plan only provide EUR -> *
88			return $this->getExchangeRate($targetCurrency, $sourceCurrency, $date)->invertCurrencies();
			0 ignored issues – show Security Bug introduced 2018-03-30 10:55 UTC by Report Bug Copy Issue Report It seems like `$date` defined by `\DateTimeImmutable::crea...w \DateTimeZone('GMT'))` on line `74` 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			}
90
91			$url = sprintf('http://data.fixer.io/api/%s?access_key=%s', $date->format('Y-m-d'), $this->accessKey);
			0 ignored issues – show Bug introduced 2018-03-30 10:55 UTC by Report Bug Copy Issue Report 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...
92			$response = $this->client->sendRequest($this->requestFactory->createRequest('GET', $url));
93			$json = json_decode((string) $response->getBody(), true);
94			if (isset($json['rates'][$targetCurrency->getCode()])) {
95			return $this->exchangeRateFactory->create($sourceCurrency, $targetCurrency, $json['rates'][$targetCurrency->getCode()]);
96			}
97
98			throw new ExchangeRateNotFoundException($sourceCurrency, $targetCurrency);
99			}
100			}
101

bpolaszek / currency

Push — master ( ca4577...8a3c51 )

FixerIOProvider::__construct() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like