JCFirebase\JCFirebase

Complexity

Total Complexity

25

Size/Duplication

Total Lines	242
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	4

Test Coverage

Coverage

79.8%

Importance

Changes	6
Bugs	0	Features	0

14 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	6	1
A	fromJson()	0	11	2
A	fromKeyFile()	0	11	2
B	getPathURI()	0	37	6
A	getShallow()	0	10	1
A	get()	0	8	1
A	put()	0	7	1
A	post()	0	8	1
A	patch()	0	8	1
A	delete()	0	8	1
A	isValid()	0	6	1
A	refreshToken()	0	4	1
A	addDataToPathURI()	0	11	3
A	addDataToRequest()	0	14	3

<?php
/**
 * Created by PhpStorm.
 * User: jaredchu
 * Date: 11/29/16
 * Time: 3:47 PM
 */

namespace JCFirebase;

use JC\JCRequest;
use JC\JCResponse;
use JCFirebase\Enums\RequestType;
use JCFirebase\Enums\PrintType;

/**
 * Class JCFirebase
 * @package JCFirebase
 * reference https://www.firebase.com/docs/rest/api/
 */
class JCFirebase
{
    public $firebaseURI;

    public $rootPath;

    public $requestHeader = array(
        'accept' => 'application/json',
        'contentType' => 'application/json; charset=utf-8',
        'dataType' => 'json'
    );

    public $requestOptions = array();

    /**
     * @var OAuth
     */
    public $auth;


    /**
     * JCFirebase constructor.
     *
     * @param $firebaseURI
     * @param OAuth $auth
     * @param string $rootPath
     */
    public function __construct($firebaseURI, OAuth $auth, $rootPath = '/')
    {
        $this->firebaseURI = $firebaseURI;
        $this->rootPath = $rootPath;
        $this->auth = $auth;
    }


    /**
     * @param $firebaseURI
     * @param $jsonString
     * @param string $rootPath
     * @return JCFirebase
     * @throws \Exception
     */
    public static function fromJson($firebaseURI, $jsonString, $rootPath = '/')
    {
        if ($jsonString) {
            $serviceAccount = $jsonString->client_email;
            $privateKey = $jsonString->private_key;

            return new self($firebaseURI, new OAuth($privateKey, $serviceAccount), $rootPath);
        } else {
            throw new \Exception("can't get data from key file");
        }
    }

    /**
     * @param $firebaseURI
     * @param $keyFile
     * @param string $rootPath
     *
     * @return JCFirebase
     * @throws \Exception
     */
    public static function fromKeyFile($firebaseURI, $keyFile, $rootPath = '/')
    {
        $jsonString = null;
        try {
            $jsonString = json_decode(file_get_contents($keyFile));
        } catch (\Exception $exception) {
            $jsonString = json_decode(JCRequest::get($keyFile));
        }

        return self::fromJson($firebaseURI, $jsonString, $rootPath);
    }

    public function getPathURI($path = '', $print = '')
    {
        //remove last slash from firebaseURI
        $template = '/';
        $this->firebaseURI = rtrim($this->firebaseURI, $template);
        $path = rtrim($path, $template);
        $path = ltrim($path, $template);

        //check https
        if (strpos($this->firebaseURI, 'http://') !== false) {
            throw new \Exception("https is required.");
        }

        //check firebaseURI
        if (empty($this->firebaseURI)) {
            throw new \Exception("firebase URI is required");
        }

        if (strpos($this->rootPath, "/") !== 0) {
            throw new \Exception("firebase default path must contain /");
        }

        $pathURI = $this->firebaseURI . $this->rootPath . $path . ".json";

        //set query data
        $queryData = array();
        if (!empty($print)) {
            $queryData[Option::_PRINT] = $print;
        }
        if (!empty($queryData)) {
            $pathURI = $pathURI . '?' . http_build_query($queryData);
        }

        $this->refreshToken();

        return $pathURI;
    }

    public function getShallow($path = '', $options = array())
    {
        return JCRequest::get(
            $this->getPathURI($path) . '?' . http_build_query(array(
                Option::_SHALLOW => 'true'
            )),
            $this->addDataToRequest($options),

It seems like $this->addDataToRequest($options) targeting JCFirebase\JCFirebase::addDataToRequest() can also be of type string; however, JC\JCRequest::get() does only seem to accept array|null, maybe add an additional type check?

            $this->requestHeader
        );
    }

    /**
     * @param string $path
     * @param array $options
     *
     * @return JCResponse
     */
    public function get($path = '', $options = array())
    {
        return JCRequest::get(
            $this->addDataToPathURI($path, $options),
            $this->addDataToRequest($options),

It seems like $this->addDataToRequest($options) targeting JCFirebase\JCFirebase::addDataToRequest() can also be of type string; however, JC\JCRequest::get() does only seem to accept array|null, maybe add an additional type check?

            $this->requestHeader
        );
    }

    /**
     * @param string $path
     * @param array $options
     *
     * @return JCResponse
     */
    public function put($path = '', $options = array())
    {
        return JCRequest::put($this->getPathURI($path),
            $this->addDataToRequest($options, true),
            $this->requestHeader
        );
    }

    /**
     * @param string $path
     * @param array $options
     *
     * @return JCResponse
     */
    public function post($path = '', $options = array())
    {
        return JCRequest::post(
            $this->getPathURI($path),
            $this->addDataToRequest($options, true),
            $this->requestHeader
        );
    }

    /**
     * @param string $path
     * @param array $options
     *
     * @return JCResponse
     */
    public function patch($path = '', $options = array())
    {
        return JCRequest::patch(
            $this->getPathURI($path),
            $this->addDataToRequest($options, true),
            $this->requestHeader
        );
    }

    /**
     * @param string $path
     * @param array $options
     *
     * @return JCResponse
     */
    public function delete($path = '', $options = array())
    {
        return JCRequest::delete(
            $this->getPathURI($path),
            $this->addDataToRequest($options),
            $this->requestHeader
        );
    }

    /**
     * Function that check firebase authencation
     * and configuration valid or not
     *
     * @return bool
     */
    public function isValid()
    {
        return $this->get(null, array(
                Option::_PRINT => PrintType::SILENT
            ))->status() == 204;
    }

    protected function refreshToken()
    {
        $this->requestHeader['Authorization'] = 'Bearer ' . $this->auth->getAccessToken();
    }

    protected function addDataToPathURI($path = '', $options = array(), $reqType = RequestType::GET)
    {
        $print = '';
        if (isset($options['print'])) {
            if (Option::isAllowPrint($reqType, $options['print'])) {
                $print = $options['print'];
            }
        }

        return $this->getPathURI($path, $print);
    }

    protected function addDataToRequest($options = array(), $jsonEncode = false)
    {
        $requestOptions = array();

        if (isset($options['data'])) {
            $requestOptions = array_merge($options['data'], $requestOptions);
        }

        if ($jsonEncode) {
            $requestOptions = json_encode($requestOptions);
        }

        return $requestOptions;
    }
}