Crossjoin\Browscap\Source\DownloadAbstract

Complexity

Total Complexity

13

Size/Duplication

Total Lines	133
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	4

Importance

Changes

0

8 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	11	2
A	getClient()	0	4	1
A	setClient()	0	4	1
A	getSourceUri()	0	4	1
A	setSourceUri()	0	6	1
A	getUserAgent()	0	8	1
A	getContent()	0	12	3
A	loadContent()	0	20	3

<?php
declare(strict_types=1);

namespace Crossjoin\Browscap\Source;

use Crossjoin\Browscap\Browscap;
use Crossjoin\Browscap\Exception\SourceConditionNotSatisfiedException;
use Crossjoin\Browscap\Exception\SourceUnavailableException;
use GuzzleHttp\Client;
use GuzzleHttp\Exception\GuzzleException;
use Psr\Http\Message\StreamInterface;

/**
 * Class DownloadAbstract
 *
 * @package Crossjoin\Browscap\Source
 * @author Christoph Ziegenberg <ziegenberg@crossjoin.com>
 * @link https://github.com/crossjoin/browscap
 */
abstract class DownloadAbstract
{
    /**
     * The format for the user agent to set for all requests made by the class
     */
    const USER_AGENT_FORMAT = '%libName %libVersion (%client)';

    /**
     * The URI to get the current Browscap data (in the configured format)
     *
     * @var string
     */
    protected $sourceUri;

    /**
     * @var Client
     */
    protected $client;

    /**
     * Download constructor.
     *
     * @param string $sourceUri
     * @param array $clientOptions
     *
     * @throws SourceConditionNotSatisfiedException
     */
    public function __construct(string $sourceUri, array $clientOptions = [])
    {
        // Set user agent
        if (!array_key_exists('headers', $clientOptions)) {
            $clientOptions['headers'] = [];
        }
        $clientOptions['headers']['User-Agent'] = $this->getUserAgent();

        $this->setClient(new Client($clientOptions));
        $this->setSourceUri($sourceUri);
    }

    /**
     * @return Client
     */
    public function getClient() : Client
    {
        return $this->client;
    }

    /**
     * @param Client $client
     */
    protected function setClient(Client $client)
    {
        $this->client = $client;
    }

    /**
     * @return string
     */
    public function getSourceUri() : string
    {
        return $this->sourceUri;
    }

    /**
     * @param string $sourceUri
     *
     * @return DownloadAbstract
     */
    protected function setSourceUri(string $sourceUri) : DownloadAbstract
    {
        $this->sourceUri = $sourceUri;

        return $this;
    }

    /**
     * @return string
     */
    protected function getUserAgent()
    {
        return str_replace(
            array('%libName', '%libVersion', '%client'),
            array('Crossjoin\Browscap', Browscap::VERSION, 'GuzzleHttp'),
            self::USER_AGENT_FORMAT
        );
    }

    /**
     * @inheritdoc
     *
     * @throws SourceUnavailableException
     * @throws \RuntimeException
     */
    public function getContent() : \Generator
    {
        $stream = $this->loadContent($this->getSourceUri());

        if ($stream->isReadable() === false) {
            throw new SourceUnavailableException('Source stream is not readable.', 1459162267);
        }

        while (($data = $stream->read(4096)) !== '') {
            yield $data;
        }
    }

    /**
     * @param $uri
     *
     * @return StreamInterface
     * @throws SourceUnavailableException
     */
    protected function loadContent($uri) : StreamInterface
    {
        try {
            $response = $this->getClient()->request('GET', $uri);

            // Check status code
            if ($response->getStatusCode() !== 200) {
                throw new SourceUnavailableException(
                    'HTTP error: ' . $response->getStatusCode() . ' ' . $response->getReasonPhrase(),
                    1459162268
                );
            }

            return $response->getBody();
        } catch (GuzzleException $e) {
            throw new SourceUnavailableException(
                'Error loading the source, see previous exception for details.', 1459162269, $e
            );
        }
    }
}