Konsulting\JustGivingApiSdk\Support\GuzzleClientFactory

Complexity

Total Complexity

6

Size/Duplication

Total Lines	102
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	4

Test Coverage

Coverage

100%

Importance

Changes

0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	9	1
A	build()	0	4	1
A	createClient()	0	18	1
A	baseUrl()	0	4	1
A	buildAuthenticationValue()	0	6	2

<?php

namespace Konsulting\JustGivingApiSdk\Support;

use GuzzleHttp\Client;
use GuzzleHttp\HandlerStack;
use GuzzleHttp\Middleware;
use Psr\Http\Message\ResponseInterface;

/**
 * Class GuzzleClientFactory
 *
 * Helper class to instantiate a Guzzle HTTP client with the correct configuration for passing into the JustGiving
 * client.
 */
class GuzzleClientFactory
{
    /** @var string */
    protected $apiKey;

    /** @var string */
    protected $apiVersion;

    /** @var string */
    protected $username;

    /** @var string */
    protected $password;

    /** @var string */
    protected $rootDomain;

    /** @var array */
    protected $userOptions;

    /**
     * GuzzleClientFactory constructor.
     *
     * @param string $rootDomain
     * @param string $apiKey
     * @param string $apiVersion
     * @param string $username
     * @param string $password
     * @param array  $options
     */
    public function __construct($rootDomain, $apiKey, $apiVersion, $username = '', $password = '', $options = [])
    {
        $this->rootDomain = $rootDomain;
        $this->apiKey = $apiKey;
        $this->apiVersion = $apiVersion;
        $this->username = $username;
        $this->password = $password;
        $this->userOptions = $options;
    }

    /**
     * Static method for easily creating a client. Requires the same parameters as the class constructor.
     *
     * @param string $rootDomain
     * @param string $apiKey
     * @param string $apiVersion
     * @param string $username
     * @param string $password
     * @param array  $options
     * @return Client
     */
    public static function build($rootDomain, $apiKey, $apiVersion, $username = '', $password = '', $options = [])
    {
        return (new static($rootDomain, $apiKey, $apiVersion, $username, $password, $options))->createClient();
    }

    /**
     * Set up the handler stack with middleware, configure options and instantiate the Guzzle client.
     *
     * @return Client
     */
    public function createClient()
    {
        $stack = HandlerStack::create();
        $stack->push(Middleware::mapResponse(function (ResponseInterface $response) {
            return new Response($response);
        }));

        return new Client(array_merge([
            'http_errors' => false,
            'handler'     => $stack,
            'base_uri'    => $this->baseUrl(),
            'headers'     => [
                'Accept'        => 'application/json',
                'Authorize'     => 'Basic ' . $this->buildAuthenticationValue(),
                'Authorization' => 'Basic ' . $this->buildAuthenticationValue(),
            ]
        ], $this->userOptions));
    }

    /**
     * Return the base URL string for the API call.
     *
     * @return string
     */
    public function baseUrl()
    {
        return $this->rootDomain . $this->apiKey . '/v' . $this->apiVersion . '/';
    }

    /**
     * Build the base 64 encoded string that contains authentication credentials.
     *
     * @return string
     */
    protected function buildAuthenticationValue()
    {
        return empty($this->username)
            ? ''
            : base64_encode($this->username . ":" . $this->password);
    }
}