Connector::getAuthDomain() - Code Metrics - Inspection of "Update Connector.php" - lifeboat-app/php-sdk - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Push — main ( 16966e...d887ef )

by Dylan
created 2022-03-22 07:09 UTC
Connector::getAuthDomain() A

↳ Parent: Connector
Complexity

Conditions	1
Paths	1
Size

Total Lines	3
Code Lines	1
Duplication

Lines	0
Ratio	0 %
Importance

Changes	1
Bugs	0	Features	0
Metric	Value
cc	1
eloc	1
c	1
b	0
f	0
nc	1
nop	0
dl	0
loc	3
rs	10
<?php

namespace Lifeboat;

require_once __DIR__ . DIRECTORY_SEPARATOR . 'includes' . DIRECTORY_SEPARATOR . 'functions.php';

use Lifeboat\Exceptions\BadMethodException;
use Lifeboat\Exceptions\OAuthException;
use Lifeboat\Factory\ServiceFactory;
use Lifeboat\Services\ApiService;
use Lifeboat\Utils\Curl;
use Lifeboat\Utils\URL;

/**
 * Class Connector
 * @package Lifeboat
 *
 * @property string $_auth_domain
 * @property string|null $_access_token
 * @property string $_site_key
 *
 * // Services
 * @property \Lifeboat\Services\Orders $orders
 * @property \Lifeboat\Services\Addresses $addresses
 * @property \Lifeboat\Services\Customers $customers
 * @property \Lifeboat\Services\Collections $collections
 * @property \Lifeboat\Services\Pages $pages
 * @property \Lifeboat\Services\CustomPages $custom_pages
 * @property \Lifeboat\Services\DeliveryZones $delivery_zones
 * @property \Lifeboat\Services\TaxCodes $tax_codes
 * @property \Lifeboat\Services\Locations $locations
 * @property \Lifeboat\Services\Media $media
 * @property \Lifeboat\Services\Products $products
 */
abstract class Connector {

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

    const ACTIVE_HOST_PARAM = 'lb_active_host';
    const ACTIVE_KEY_PARAM  = 'lb_active_site_key';

    protected $_auth_domain = 'https://accounts.lifeboat.app';
    protected $_access_token = '';
    protected $_site_key = '';
    protected $_host = '';

    /**
     * @return string
     *
     * @throws OAuthException
     */
    abstract public function getAccessToken(): string;

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

    /**
     * @param string $service
     * @return ApiService|null
     * @throws BadMethodException
     */
    public function __get(string $service): ?ApiService
    {
        $obj = ServiceFactory::inst($this, $service);
        if (!$obj) throw new BadMethodException("Service for `{$service}` does not exist");

        return $obj;
    }

    /**
     * @return array
     * @throws OAuthException
     */
    public function getSites(): array
    {
        $curl = new Curl($this->auth_url(self::SITES_URL), [
            'access_token' => $this->getAccessToken()
        ]);

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

        if (!$response->isValid()) {
            $error = $response->getJSON();
            throw new OAuthException($error['error'], $error['code']);
        }

        return $response->getJSON() ?? [];
    }

    /**
     * Makes a request to the API to refresh the current access token
     *
     * @return $this
     * @throws OAuthException
     */
    public function refreshAccessToken(): Connector
    {
        $curl = new Curl($this->auth_url('/oauth/refresh_token'), [
            'access_token'  => $this->getAccessToken(),
        ]);

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

        if (!$response->isValid() || !$json || !array_key_exists('access_token', $json)) {
            throw new OAuthException($response->getError());
        } else {
            $this->setAccessToken($json['access_token']);
                   setAccessToken($json['access_token']);
        }

        return $this;
    }

    /**
     * @param string $host
     * @param string $site_key
     * @return $this
     */
    public function setActiveSite(string $host, string $site_key): Connector
    {
        $this->_host        = $host;
        $this->_site_key    = $site_key;

        if (session_status() === PHP_SESSION_ACTIVE) {
            $_SESSION[self::ACTIVE_HOST_PARAM]  = $this->_host;
            $_SESSION[self::ACTIVE_KEY_PARAM]   = $this->_site_key;
        }

        return $this;
    }

    /**
     * @param bool $check_session
     * @return array|null
     */
    public function getActiveSite(bool $check_session = true): ?array
    {
        if ($this->_host && $this->_site_key) {
            return ['host' => $this->_host, 'site_key' => $this->_site_key];
        }

        if ($check_session && session_status() === PHP_SESSION_ACTIVE) {
            $this->setActiveSite(
                $_SESSION[self::ACTIVE_HOST_PARAM] ?? '',
                $_SESSION[self::ACTIVE_KEY_PARAM] ?? ''
            );

            return $this->getActiveSite(false);
        }

        return null;
    }

    /**
     * @return string|null
     */
    public function getHost(): ?string
    {
        if (!$this->getActiveSite(true)) return null;
        return $this->_host;
    }

    /**
     * @return string|null
     */
    public function getSiteKey(): ?string
    {
        if (!$this->getActiveSite(true)) return null;
        return $this->_site_key;
    }

    /**
     * @param string $url
     * @param string $method
     * @param array $data
     * @param array $headers
     * @return CurlResponse
     * @throws OAuthException
     */
    public function curl_api(string $url, string $method = 'GET', array $data = [], array $headers = []): CurlResponse
    {
        $url = URL::is_absolute_url($url) ? $url
            : 'https://' . rtrim($this->getHost(), '/') . '/' . ltrim($url, '/');
            : 'https://' . rtrim(/** @scrutinizer ignore-type */ $this->getHost(), '/') . '/' . ltrim($url, '/');

        $curl = new Curl($url, $data, $headers);

        $curl->setMethod($method);
        $curl->addHeader('access-token', $this->getAccessToken());
        $curl->addHeader('site-key', $this->getSiteKey());
        $curl->addHeader('site-key', /** @scrutinizer ignore-type */ $this->getSiteKey());
        $curl->addHeader('Host', $this->getHost());
        $curl->addHeader('Accept', 'application/json');

        return $curl->curl_json();
    }

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

lifeboat-app / php-sdk

Push — main ( 16966e...d887ef )

Connector::getAuthDomain() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like
