ExRatesTableFinder::constructDirname() - Code Metrics - ksdev-pl/nbp-currency-converter - Measure and Improve Code Quality continuously with Scrutinizer

ExRatesTableFinder::constructDirname() A
last analyzed 2018-01-14 16:54 UTC

↳ Parent: ExRatesTableFinder

Complexity

Conditions	2
Paths	2

Size

Total Lines	9
Code Lines	6

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	9
rs	9.6666
c	0
b	0
f	0
cc	2
eloc	6
nc	2
nop	0

<?php

namespace Ksdev\NBPCurrencyConverter;

class ExRatesTableFinder
{
    const NBP_XML_URL = 'http://www.nbp.pl/kursy/xml/';
    const MIN_PUB_DATE = '2002-01-02';
    const MAX_ONE_TIME_API_REQ = 7;

    /** @var \GuzzleHttp\Client */
    private $guzzle;

    /** @var ExRatesTableFactory */
    private $ratesTableFactory;

    /** @var string */
    private $cachePath;

    /** @var \DateTime */
    private $soughtPubDate;

    /**
     * @param \GuzzleHttp\Client $guzzle
     * @param ExRatesTableFactory $ratesTableFactory
     * @param string $cachePath Optional path to an existing folder where the cache files will be stored
     *
     * @throws \Exception
     */
    public function __construct(
        \GuzzleHttp\Client $guzzle,
        ExRatesTableFactory $ratesTableFactory,
        $cachePath = ''
    ) {
        $this->guzzle = $guzzle;
        $this->ratesTableFactory = $ratesTableFactory;
        if ($cachePath) {
            if (!is_dir($cachePath)) {
                throw new \Exception('Invalid cache path');
            }
            $this->cachePath = rtrim((string)$cachePath, '/') . '/';
        }
    }

    /**
     * Get the ExRatesTable instance
     *
     * @param \DateTime $pubDate Optional rates table publication date
     *
     * @return ExRatesTable
     *
     * @throws \Exception
     */
    public function getExRatesTable(\DateTime $pubDate = null)
    {
        $this->setSoughtPubDate($pubDate);

        $i = 0;
        do {
            // Limit the number of times the loop repeats
            if ($i === self::MAX_ONE_TIME_API_REQ) {
                throw new \Exception('Max requests to api limit has been reached');
            }

            // If user doesn't want a specific date, try to get the rates from the last working day
            if (!$pubDate) {
                $this->soughtPubDate = $this->soughtPubDate->sub(new \DateInterval('P1D'));
            }

            // Try to find the file in cache, otherwise download it
            if ($this->cachePath && ($cachedXml = $this->getCachedXml())) {
                $rawContent = $cachedXml;
            } else {
                $rawContent = $this->downloadXml();
            }

            // If a specific date is sought then break, otherwise continue
            if ($pubDate) {
                break;
            }

            $i++;
        } while (!$rawContent);

        if (!$rawContent) {
            throw new \Exception('Exchange rates file not found');
        }

        return $this->ratesTableFactory->getInstance($rawContent);
    }

    /**
     * Set the sought publication date necessary for finder operation
     *
     * @param \DateTime|null $pubDate
     *
     * @throws \Exception
     */
    private function setSoughtPubDate($pubDate)
    {
        if ($pubDate instanceof \DateTime) {
            if (!($pubDate >= new \DateTime(self::MIN_PUB_DATE) && $pubDate <= new \DateTime())) {
                throw new \Exception('Invalid publication date');
            }
        } else {
            $pubDate = new \DateTime();
        }
        $this->soughtPubDate = $pubDate;
    }

    /**
     * Get the raw xml content from a cache file
     *
     * @return string|int Content string or 0 if the file doesn't exist
     */
    private function getCachedXml()
    {
        $filesArray = scandir($this->cachePath);
        $filename = $this->matchFilename($filesArray);

        if ($filename) {
            $rawContent = file_get_contents($this->cachePath . $filename);
            return $rawContent;
        }

        return 0;
    }

    /**
     * Get the raw xml content from the NBP api
     *
     * @return string|int Content string or 0 if the file doesn't exist
     *
     * @throws \Exception
     */
    private function downloadXml()
    {
        $filename = $this->findFileInRatesDir();
        if ($filename) {
            $response = $this->guzzle->get(self::NBP_XML_URL . $filename);
            if ($response->getStatusCode() === 200) {
                $rawContent = (string)$response->getBody();
                if ($this->cachePath) {
                    file_put_contents($this->cachePath . $filename, $rawContent);
                }
                return $rawContent;
            } else {
                throw new \Exception(
                    "Invalid response status code: {$response->getStatusCode()} {$response->getReasonPhrase()}"
                );
            }
        } else {
            return 0;
        }
    }

    /**
     * Find the file related to the publication date
     *
     * @return string|int Filename or 0 if the file was not found
     *
     * @throws \Exception
     */
    private function findFileInRatesDir()
    {
        $dirname = $this->constructDirname();

        $response = $this->guzzle->get(self::NBP_XML_URL . $dirname);
        if ($response->getStatusCode() === 200) {
            $rawContent = (string)$response->getBody();
        } else {
            throw new \Exception(
                "Invalid response status code: {$response->getStatusCode()} {$response->getReasonPhrase()}"
            );
        }

        $filesArray = explode("\r\n", $rawContent);
        $filename = $this->matchFilename($filesArray);

        return $filename;
    }

    /**
     * Construct the name of directory containing the files
     *
     * @return string
     */
    private function constructDirname()
    {
        if ($this->soughtPubDate->format('Y') !== (new \DateTime())->format('Y')) {
            $dirname = "dir{$this->soughtPubDate->format('Y')}.txt";
        } else {
            $dirname = 'dir.txt';
        }
        return $dirname;
    }

    /**
     * Searches files array for a match to the publication date
     *
     * @todo Optimize to avoid unnecessary regex
     *
     * @param array $filesArray
     *
     * @return string|int Filename or 0 if the file was not found
     */
    private function matchFilename(array $filesArray)
    {
        foreach ($filesArray as $filename) {
            if (preg_match('/(a\d{3}z' . $this->soughtPubDate->format('ymd') . ')/', $filename, $matches)) {
                $filename = "{$matches[1]}.xml";
                return $filename;
            }
        }

        return 0;
    }
}


1			<?php
2
3			namespace Ksdev\NBPCurrencyConverter;
4
5			class ExRatesTableFinder
6			{
7			const NBP_XML_URL = 'http://www.nbp.pl/kursy/xml/';
8			const MIN_PUB_DATE = '2002-01-02';
9			const MAX_ONE_TIME_API_REQ = 7;
10
11			/** @var \GuzzleHttp\Client */
12			private $guzzle;
13
14			/** @var ExRatesTableFactory */
15			private $ratesTableFactory;
16
17			/** @var string */
18			private $cachePath;
19
20			/** @var \DateTime */
21			private $soughtPubDate;
22
23			/**
24			* @param \GuzzleHttp\Client $guzzle
25			* @param ExRatesTableFactory $ratesTableFactory
26			* @param string $cachePath Optional path to an existing folder where the cache files will be stored
27			*
28			* @throws \Exception
29			*/
30			public function __construct(
31			\GuzzleHttp\Client $guzzle,
32			ExRatesTableFactory $ratesTableFactory,
33			$cachePath = ''
34			) {
35			$this->guzzle = $guzzle;
36			$this->ratesTableFactory = $ratesTableFactory;
37			if ($cachePath) {
38			if (!is_dir($cachePath)) {
39			throw new \Exception('Invalid cache path');
40			}
41			$this->cachePath = rtrim((string)$cachePath, '/') . '/';
42			}
43			}
44
45			/**
46			* Get the ExRatesTable instance
47			*
48			* @param \DateTime $pubDate Optional rates table publication date
49			*
50			* @return ExRatesTable
51			*
52			* @throws \Exception
53			*/
54			public function getExRatesTable(\DateTime $pubDate = null)
55			{
56			$this->setSoughtPubDate($pubDate);
57
58			$i = 0;
59			do {
60			// Limit the number of times the loop repeats
61			if ($i === self::MAX_ONE_TIME_API_REQ) {
62			throw new \Exception('Max requests to api limit has been reached');
63			}
64
65			// If user doesn't want a specific date, try to get the rates from the last working day
66			if (!$pubDate) {
67			$this->soughtPubDate = $this->soughtPubDate->sub(new \DateInterval('P1D'));
68			}
69
70			// Try to find the file in cache, otherwise download it
71			if ($this->cachePath && ($cachedXml = $this->getCachedXml())) {
72			$rawContent = $cachedXml;
73			} else {
74			$rawContent = $this->downloadXml();
75			}
76
77			// If a specific date is sought then break, otherwise continue
78			if ($pubDate) {
79			break;
80			}
81
82			$i++;
83			} while (!$rawContent);
84
85			if (!$rawContent) {
86			throw new \Exception('Exchange rates file not found');
87			}
88
89			return $this->ratesTableFactory->getInstance($rawContent);
90			}
91
92			/**
93			* Set the sought publication date necessary for finder operation
94			*
95			* @param \DateTime\|null $pubDate
96			*
97			* @throws \Exception
98			*/
99			private function setSoughtPubDate($pubDate)
100			{
101			if ($pubDate instanceof \DateTime) {
102			if (!($pubDate >= new \DateTime(self::MIN_PUB_DATE) && $pubDate <= new \DateTime())) {
103			throw new \Exception('Invalid publication date');
104			}
105			} else {
106			$pubDate = new \DateTime();
107			}
108			$this->soughtPubDate = $pubDate;
109			}
110
111			/**
112			* Get the raw xml content from a cache file
113			*
114			* @return string\|int Content string or 0 if the file doesn't exist
115			*/
116			private function getCachedXml()
117			{
118			$filesArray = scandir($this->cachePath);
119			$filename = $this->matchFilename($filesArray);
120
121			if ($filename) {
122			$rawContent = file_get_contents($this->cachePath . $filename);
123			return $rawContent;
124			}
125
126			return 0;
127			}
128
129			/**
130			* Get the raw xml content from the NBP api
131			*
132			* @return string\|int Content string or 0 if the file doesn't exist
133			*
134			* @throws \Exception
135			*/
136			private function downloadXml()
137			{
138			$filename = $this->findFileInRatesDir();
139			if ($filename) {
140			$response = $this->guzzle->get(self::NBP_XML_URL . $filename);
141			if ($response->getStatusCode() === 200) {
142			$rawContent = (string)$response->getBody();
143			if ($this->cachePath) {
144			file_put_contents($this->cachePath . $filename, $rawContent);
145			}
146			return $rawContent;
147			} else {
148			throw new \Exception(
149			"Invalid response status code: {$response->getStatusCode()} {$response->getReasonPhrase()}"
150			);
151			}
152			} else {
153			return 0;
154			}
155			}
156
157			/**
158			* Find the file related to the publication date
159			*
160			* @return string\|int Filename or 0 if the file was not found
161			*
162			* @throws \Exception
163			*/
164			private function findFileInRatesDir()
165			{
166			$dirname = $this->constructDirname();
167
168			$response = $this->guzzle->get(self::NBP_XML_URL . $dirname);
169			if ($response->getStatusCode() === 200) {
170			$rawContent = (string)$response->getBody();
171			} else {
172			throw new \Exception(
173			"Invalid response status code: {$response->getStatusCode()} {$response->getReasonPhrase()}"
174			);
175			}
176
177			$filesArray = explode("\r\n", $rawContent);
178			$filename = $this->matchFilename($filesArray);
179
180			return $filename;
181			}
182
183			/**
184			* Construct the name of directory containing the files
185			*
186			* @return string
187			*/
188			private function constructDirname()
189			{
190			if ($this->soughtPubDate->format('Y') !== (new \DateTime())->format('Y')) {
191			$dirname = "dir{$this->soughtPubDate->format('Y')}.txt";
192			} else {
193			$dirname = 'dir.txt';
194			}
195			return $dirname;
196			}
197
198			/**
199			* Searches files array for a match to the publication date
200			*
201			* @todo Optimize to avoid unnecessary regex
202			*
203			* @param array $filesArray
204			*
205			* @return string\|int Filename or 0 if the file was not found
206			*/
207			private function matchFilename(array $filesArray)
208			{
209			foreach ($filesArray as $filename) {
210			if (preg_match('/(a\d{3}z' . $this->soughtPubDate->format('ymd') . ')/', $filename, $matches)) {
211			$filename = "{$matches[1]}.xml";
212			return $filename;
213			}
214			}
215
216			return 0;
217			}
218			}
219

ksdev-pl / nbp-currency-converter

ExRatesTableFinder::constructDirname() A last analyzed 2018-01-14 16:54 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

ExRatesTableFinder::constructDirname() A
last analyzed 2018-01-14 16:54 UTC