WorkEtcClient\WorkEtcClient

Complexity

Total Complexity

10

Size/Duplication

Total Lines	143
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	3

Importance

Changes

0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
A	connect()	0	8	1
A	login()	0	11	1
A	registerDomain()	0	6	1
A	invoke()	0	14	2
A	buildUrl()	0	8	2
A	checkErrors()	0	8	2

<?php

namespace WorkEtcClient;

/**
 * A thin HTTP client for WORK[etc]'s API.
 */
class WorkEtcClient
{
    /**
     * @var \WorkEtcClient\HttpInterface
     */
    protected $httpClient;

    /**
     * @var string
     */
    protected $domain = null;

    /**
     * @var string
     */
    protected $url = null;

    /**
     * @var string
     */
    protected $sessionKey = null;

    /**
     * @param \WorkEtcClient\HttpInterface
     */
    public function __construct(HttpInterface $httpClient)
    {
        $this->httpClient = $httpClient;
    }

    /**
     * Connect to WORK[etc] and return the connection.
     *
     * @param string $domain
     * @param string $email
     * @param string $password
     *
     * @return \WorkEtcClient\WorkEtcClient
     */
    public static function connect(string $domain, string $email, string $password): WorkEtcClient
    {
        $client = new static(new HttpfulClient);

        $client->login($domain, $email, $password);

        return $client;
    }

    /**
     * Authenticate into WORK[etc].
     *
     * @param string $domain
     * @param string $email
     * @param string $password
     *
     * @return void
     *
     * @throws \WorkEtcClient\WorkEtcException
     */
    public function login(string $domain, string $email, string $password)
    {
        $this->registerDomain($domain);

        $result = $this->invoke('AuthenticateWebSafe', [
            'email' => $email,
            'pass' => $password,
        ]);

        $this->sessionKey = $result['SessionKey'];
    }

    /**
     * @param string $domain
     *
     * @return void
     */
    protected function registerDomain(string $domain)
    {
        $this->domain = $domain;

        $this->url = 'https://' . $domain . '.worketc.com';
    }

    /**
     * Invoke the given method and return the result.
     *
     * @param string $endpoint
     * @param array  $params
     *
     * @return array|string
     *
     * @throws \WorkEtcClient\WorkEtcException
     */
    public function invoke(string $endpoint, array $params = [])
    {
        $url = $this->buildUrl($endpoint);

        $response = $this->httpClient->post($url, $params);

        $this->checkErrors($response);

It seems like $response defined by $this->httpClient->post($url, $params) on line 105 can also be of type string; however, WorkEtcClient\WorkEtcClient::checkErrors() does only seem to accept array, maybe add an additional type check?

        // Account for WORK[etc]'s random addition of a top-level associative
        // array
        $response = isset($response['d']) ? $response['d'] : $response;

        return $response;
    }

    /**
     * Build the URL from the registered domain and the endpoint.
     *
     * @param string $endpoint
     *
     * @return string
     */
    protected function buildUrl(string $endpoint): string
    {
        if ($this->sessionKey !== null) {
            $endpoint = $endpoint . '?VeetroSession=' . $this->sessionKey;
        }

        return $this->url . '/json/' . $endpoint;
    }

    /**
     * Check if the WORK[etc] response had errors and attempts to parse them if
     * so.
     *
     * @param array $response
     *
     * @return void
     *
     * @throws \WorkEtcClient\WorkEtcException if the HTTP response code is 400 or above.
     */
    protected function checkErrors(array $response)
    {
        if ($this->httpClient->hasErrors() === false) {
            return;
        }

        throw new WorkEtcException($response);
    }
}