TextControl\Laminas\ReportingCloud\Service\ReportingCloudFactory

Complexity

Total Complexity

14

Size/Duplication

Total Lines	77
Duplicated Lines	0 %

Test Coverage

Coverage

67.5%

Importance

Changes	1
Bugs	0	Features	0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	__invoke()	0	8	1
A	getHelp()	0	9	1
C	getCredentials()	0	41	12

<?php
declare(strict_types=1);

/**
 * ReportingCloud Laminas Module
 *
 * Laminas Module for ReportingCloud Web API. Authored and supported by Text Control GmbH.
 *
 * @link      https://www.reporting.cloud to learn more about ReportingCloud
 * @link      https://tinyurl.com/4mefj7xz for the canonical source repository
 * @license   https://tinyurl.com/4xh3utpp
 * @copyright © 2023 Text Control GmbH
 */

namespace TextControl\Laminas\ReportingCloud\Service;

use Laminas\ServiceManager\Factory\FactoryInterface;
use Psr\Container\ContainerInterface;
use TextControl\ReportingCloud\Exception\InvalidArgumentException;
use TextControl\ReportingCloud\ReportingCloud;

class ReportingCloudFactory implements FactoryInterface
{
    /**
     * @param string             $requestedName
     */
    public function __invoke(ContainerInterface $container, $requestedName, ?array $options = null): ReportingCloud
    {
        $config = $container->get('Config');
        assert(is_array($config));

        $credentials = $this->getCredentials($config);

        return new ReportingCloud($credentials);
    }

    /**
     * Return required credentials to use the Reporting Cloud Web API
     *
     * @param array<string, array> $config
     *
     * @return array<string, string>
     */
    protected function getCredentials(array $config): array
    {
        if (!array_key_exists('reportingcloud', $config)) {
            $message = "The key 'reportingcloud' has not been specified in your application's configuration file. ";
            $message .= $this->getHelp();
            throw new InvalidArgumentException($message);
        }

        if (!array_key_exists('credentials', $config['reportingcloud'])) {
            $message = "The key 'credentials' has not been specified under the key 'reportingcloud' ";
            $message .= "in your application's configuration file. ";
            $message .= $this->getHelp();
            throw new InvalidArgumentException($message);
        }

        $credentials = $config['reportingcloud']['credentials'];

        if (array_key_exists('api_key', $credentials)) {
            $apiKey = $credentials['api_key'];
            if (is_string($apiKey) && 0 < strlen($apiKey)) {
                return [
                    'api_key' => $apiKey,
                ];
            }
        }

        if (array_key_exists('username', $credentials) && array_key_exists('password', $credentials)) {
            $username = $credentials['username'];
            $password = $credentials['password'];
            if (is_string($username) && 0 < strlen($username) && is_string($password) && 0 < strlen($password)) {
                return [
                    'username' => $username,
                    'password' => $password,
                ];
            }
        }

        $message = "Either the key 'api_key', or the keys 'username' and 'password' have not been specified under ";
        $message .= "the key 'reportingcloud', sub-key 'credentials' in your application's configuration file. ";
        $message .= $this->getHelp();
        throw new InvalidArgumentException($message);
    }

    /**
     * Return help text, used as assistance in exception message
     */
    protected function getHelp(): string
    {
        $path   = '/vendor/textcontrol/textcontrol-reportingcloud-laminas-module';
        $source = sprintf('%s/config/reportingcloud.local.php.dist', $path);
        $dest   = '/config/autoload/reportingcloud.local.php';

        $ret = sprintf("Copy '%s' to '%s' in your Laminas application, ", $source, $dest);

        return $ret . 'then add your ReportingCloud credentials to that file.';
    }
}