Lifeboat\SDK\Client

Complexity

Total Complexity

12

Size/Duplication

Total Lines	111
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	getAccessToken()	0	24	4
A	__construct()	0	5	1
A	getAPISecret()	0	3	1
A	refreshAccessToken()	0	5	1
A	getAPIKey()	0	3	1
A	auth_url()	0	3	1
A	getSites()	0	16	3

<?php

namespace Lifeboat\SDK;

use Lifeboat\SDK\Exceptions\OAuthException;
use Lifeboat\SDK\Services\Curl;

/**
 * Class Client
 * @package Lifeboat\SDK
 */
class Client {

    const AUTH_DOMAIN   = 'https://accounts.lifeboat.app';
    const TOKEN_URL     = '/oauth/api_token';
    const SITES_URL     = '/oauth/sites';

    private $_auth_domain = '';
    private $_api_key = '';
    private $_api_secret = '';
    private $_access_token;

    public function __construct(string $_api_key, string $_api_secret, $_auth_domain = self::AUTH_DOMAIN)
    {
        $this->_api_key = $_api_key;
        $this->_api_secret = $_api_secret;
        $this->_auth_domain = rtrim($_auth_domain, '/');
    }

    /**
     * Tries to fetch an access token from the API based on
     * the auth parameters available to client
     *
     * @return string
     * @throws OAuthException If any error is encountered during OAuth
     */
    public function getAccessToken(): string
    {
        if (!$this->_access_token) {
            $curl = new Curl($this->auth_url(self::TOKEN_URL), [
                'api_key'       => $this->getAPIKey(),
                'api_secret'    => $this->getAPISecret()
            ]);

            $curl->setMethod('POST');
            $response = $curl->curl();

            if (!$response->isValid()) {
                throw new OAuthException($response->getRaw());
            }

            $json = $response->getJSON();
            if (!array_key_exists('access_token', $json)) {
                throw new OAuthException("Access token was not returned by API");
            }

            $this->_access_token = $json['access_token'];
        }

        return $this->_access_token;
    }

    /**
     * @param string $access_token
     * @return array
     * @throws OAuthException
     */
    public function getSites(string $access_token = ''): array
    {
        if (!$access_token) $access_token = $this->getAccessToken();

        $curl = new Curl($this->auth_url(self::SITES_URL), [
            'access_token' => $access_token
        ]);

        $curl->setMethod('POST');
        $response = $curl->curl();

        if (!$response->isValid()) {
            throw new OAuthException($response->getRaw());
        }

        return $response->getJSON();

The expression return $response->getJSON() could return the type null which is incompatible with the type-hinted return array. Consider adding an additional type-check to rule them out.

    }

    /**
     * Makes a request to the API to refresh the current access token
     * @see Client::getAccessToken()
     *
     * @return $this
     * @throws OAuthException
     */
    public function refreshAccessToken(): Client
    {
        $this->_access_token = null;
        $this->getAccessToken();
        return $this;
    }

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

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

    /**
     * @param string $path
     * @return string
     */
    private function auth_url(string $path): string
    {
        return $this->_auth_domain . '/' . ltrim($path, '/');
    }
}