IBM\Watson\Common\HttpClient\Builder

Complexity

Total Complexity

21

Size/Duplication

Total Lines	226
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	9

Importance

Changes

0

11 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	7	3
C	createConfiguredClient()	0	32	7
A	withEndpoint()	0	6	1
A	withUsername()	0	6	1
A	withPassword()	0	6	1
A	withApiKey()	0	6	1
A	withVersion()	0	6	1
A	withCredentials()	0	6	1
A	withLearningOptOut()	0	6	1
A	appendPlugin()	0	8	2
A	prependPlugin()	0	10	2

<?php

namespace IBM\Watson\Common\HttpClient;

use Http\Client\Common\Plugin;
use Http\Client\Common\Plugin\AuthenticationPlugin;
use Http\Client\Common\Plugin\HeaderDefaultsPlugin;
use Http\Client\Common\Plugin\QueryDefaultsPlugin;
use Http\Client\Common\PluginClient;
use Http\Client\HttpClient;
use Http\Discovery\HttpClientDiscovery;
use Http\Discovery\UriFactoryDiscovery;
use Http\Message\Authentication\BasicAuth;
use Http\Message\UriFactory;

final class Builder
{
    /**
     * @var string
     */
    private $endpoint;

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

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

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

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

    /**
     * @var \Http\Client\HttpClient
     */
    private $httpClient;

    /**
     * @var \Http\Message\UriFactory
     */
    private $uriFactory;

    /**
     * @var array
     */
    private $pluginsAppend = [];

    /**
     * @var array
     */
    private $pluginsPrepend = [];

    /**
     * @var bool
     */
    private $learningOptOut;

    /**
     * Builder constructor.
     *
     * @param \Http\Client\HttpClient|null      $httpClient
     * @param \Http\Message\UriFactory|null     $uriFactory
     *
     * @throws \Http\Discovery\Exception\NotFoundException
     */
    public function __construct(
        HttpClient $httpClient = null,
        UriFactory $uriFactory = null
    ) {
        $this->httpClient = $httpClient ?: HttpClientDiscovery::find();
        $this->uriFactory = $uriFactory ?: UriFactoryDiscovery::find();
    }

    /**
     * Create HTTP client with specified plugins
     *
     * @return \Http\Client\Common\PluginClient
     *
     * @throws \InvalidArgumentException
     * @throws \RuntimeException
     */
    public function createConfiguredClient()
    {
        $plugins = $this->pluginsPrepend;

        $plugins[] = new HeaderDefaultsPlugin([
            'User-Agent' => 'adam-paterson/ibm-watson-sdk (https://github.com/adam-paterson/ibm-watson-sdk)'
        ]);

        if (null !== $this->endpoint) {
            $plugins[] = new Plugin\BaseUriPlugin($this->uriFactory->createUri($this->endpoint));
        }

        if (null !== $this->username && null !== $this->password) {
            $plugins[] = new AuthenticationPlugin(new BasicAuth($this->username, $this->password));
        }

        if (!$this->learningOptOut) {
            $plugins[] = new HeaderDefaultsPlugin([
                'X-Watson-Learning-Opt-Out' => true
            ]);
        }

        if ($this->apiKey) {
            $plugins[] = new QueryDefaultsPlugin(['api_key' => $this->apiKey]);
        }

        $version = $this->version ?: \date('Y-m-d');
        $plugins[] = new QueryDefaultsPlugin(['version' => $version]);


        return new PluginClient($this->httpClient, array_merge($plugins, $this->pluginsAppend));
    }

    /**
     * Add endpoint to client
     *
     * @param string $endpoint
     *
     * @return $this
     */
    public function withEndpoint($endpoint)
    {
        $this->endpoint = $endpoint;

        return $this;
    }

    /**
     * Add username to client
     *
     * @param string $username
     *
     * @return $this
     */
    public function withUsername($username)
    {
        $this->username = $username;

        return $this;
    }

    /**
     * Add password to client
     *
     * @param string $password
     *
     * @return $this
     */
    public function withPassword($password)
    {
        $this->password = $password;

        return $this;
    }

    public function withApiKey($apiKey)
    {
        $this->apiKey = $apiKey;

        return $this;
    }

    public function withVersion($version)
    {
        $this->version = $version;

        return $this;
    }

    /**
     * Add username and password to client
     *
     * @param string $username
     * @param string $password
     *
     * @return $this
     */
    public function withCredentials($username, $password)
    {
        return $this
            ->withUsername($username)
            ->withPassword($password);
    }

    /**
     * Opt out of Watson request logging for all requests made with this client
     *
     * @return $this
     */
    public function withLearningOptOut()
    {
        $this->learningOptOut = false;

        return $this;
    }

    /**
     * Add plugins to client after it has been configured
     *
     * @param \Http\Client\Common\Plugin|\Http\Client\Common\Plugin[] ...$plugins
     *
     * @return $this
     */
    public function appendPlugin(Plugin ...$plugins)
    {
        foreach ($plugins as $plugin) {
            $this->pluginsAppend[] = $plugin;
        }

        return $this;
    }

    /**
     * Add plugins to client before it has been configured
     *
     * @param \Http\Client\Common\Plugin|\Http\Client\Common\Plugin[] ...$plugins
     *
     * @return $this
     */
    public function prependPlugin(Plugin ...$plugins)
    {
        $plugins = array_reverse($plugins);

        foreach ($plugins as $plugin) {
            array_unshift($this->pluginsPrepend, $plugin);
        }

        return $this;
    }
}