Request::own_private_key() - Code Metrics - Inspection of "add JWT-tokens support in Request and Response exc..." - dshovchko/php_UAPAY - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Push — master ( 419110...a41d9b )

by Dmitry
created 2017-11-17 16:49 UTC
Request::own_private_key() B

↳ Parent: Request
Complexity

Conditions	4
Paths	1
Size

Total Lines	22
Code Lines	10
Duplication

Lines	22
Ratio	100 %
Importance

Changes
Metric	Value
cc	4
eloc	10
nc	1
nop	0
dl	22
loc	22
rs	8.9197
c	0
b	0
f	0
<?php

namespace UAPAY;

use UAPAY\Log as Log;
use UAPAY\Exception;
use Firebase\JWT\JWT;

abstract class Request
{
    /**
     *      @var object
     */
    protected $client;

    /**
     *      @var array
     */
    protected $jwt=array(
        'using'         => false,
        'UAPAY_pubkey'  => '',
        'our_privkey'   => '',
    );

    /**
     *      @var array
     */
    protected $data;

    /**
     *      Constructor
     *
     *      @param array $options array of options
     *      @throws Exception\Data
     */
    public function __construct($options)
    {
        // api_url
        if ( ! isset($options['api_uri']))
        {
            throw new Exception\Data('parameter api_uri is not specified');
        }

        if (isset($options['jwt']))
        {
            // using
            if ( ! isset($options['jwt']['using']))
            {
                throw new Exception\Data('parameter jwt/using is not specified');
            }
            if ( ! is_bool($options['jwt']['using']))
            {
                throw new Exception\Data('parameter jwt/using is incorrect');
            }
            // using
            if ( ! isset($options['jwt']['UAPAY_pubkey']))
            {
                throw new Exception\Data('parameter jwt/UAPAY_pubkey is not specified');
            }
            // using
            if ( ! isset($options['jwt']['our_privkey']))
            {
                throw new Exception\Data('parameter jwt/our_privkey is not specified');
            }

            $this->jwt = $options['jwt'];
        }

        // http client
        $this->client = new \GuzzleHttp\Client([
            'base_uri'      => $options['api_uri'],
            'timeout'       => 2.0,
        ]);
    }

    /**
     *      get/set data
     *
     *      @param array $value
     *      @return array
     */
    public function data($value=null)
    {
        if ($value !== null)
        {
            $this->data = $this->as_array($value);
        }

        return $this->data;
    }

    /**
     *      Cast to string
     *
     *      @param mixed $value
     *      @return string
     */
    protected function as_string($value=null)
    {
        return (is_scalar($value))?((is_bool($value))?(($value)?'true':'false'):"$value"):null;
    }

    /**
     *      Cast to integer
     *
     *      @param mixed $value
     *      @return integer
     */
    protected function as_int($value=null)
    {
        return (is_int($value))?$value:null;
    }

    /**
     *      Cast to array
     *
     *      @param mixed $value
     *      @return array
     */
    protected function as_array($value=null)
    {
        return (is_array($value))?$value:null;
    }

    /**
     *      Returns params set
     *
     *      @return array
     */
    public function get_params()
    {
        return array();
    }

    /**
     *      Returns iat param
     *
     *      @return array
     */
    public function get_param_iat()
    {
        return time();

    }

    /**
     *      Returns the JSON representation of class
     *
     *      @return string
     */
    public function get_json()
    {
        $ar = array(
            'params' => $this->get_params()
        );
        if (isset($this->data))
        {
            $ar['data'] = $this->data;
        }
        if ($this->jwt['using'] === true)
        {
            $payload = $ar;
            $payload['iat'] = $this->get_param_iat();
            $ar['token'] = $this->token_encode($payload);

            if (isset($ar['data'])) unset($ar['data']);
        }
        $json = json_encode($ar, JSON_UNESCAPED_SLASHES);

        Log::instance()->debug('build JSON:');
        Log::instance()->/** @scrutinizer ignore-call */ debug('build JSON:');
        Log::instance()->debug($json);

        return $json;
    }

    /**
     *      Get private key for encode payload
     *
     *      @throws Exception\Runtime
     *      @return string
     */
    protected function own_private_key()

    {
        // check private key file
        if ( ! file_exists($this->jwt['our_privkey']))
        {
            throw new Exception\Runtime('The file with the private key was not find!');
        }

        // load private key file
        $fpkey = fopen($this->jwt['our_privkey'], "rb");
        if ($fpkey === FALSE)
        {
            throw new Exception\Runtime('The file with the private key was not open!');
        }
        $private_key = fread($fpkey, 8192);
        if ($private_key === FALSE)
        {
            throw new Exception\Runtime('The file with the private key was not read!');
        }
        fclose($fpkey);

        return $private_key;
    }

    /**
     *      Encode payload and return token
     *
     *      @param array $payload
     *      @throws Exception\JSON
     *      @return string Token
     */
    protected function token_encode($payload)

    {
        Log::instance()->debug('encode payload:');
        Log::instance()->debug(print_r($payload, true));
        try
        {
            $token = JWT::encode($payload, $this->own_private_key(), 'RS512');
        }
        catch (\Exception $e)
        {
            Log::instance()->error($e->getMessage().PHP_EOL.$e->getTraceAsString());
            Log::instance()->/** @scrutinizer ignore-call */ error($e->getMessage().PHP_EOL.$e->getTraceAsString());
            throw new Exception\JSON('unable to create JWT token', $e);
        }

        return $token;
    }

    /**
     *      Send request to UAPAY
     *
     *      @throws Exception\Transfer
     *      @return object Response
     */
    public function send()
    {
        Log::instance()->debug('send request to '.$this->api_path);
        try
        {
            $httpresponse = $this->client->request('POST', $this->api_path, [
                'headers' => [
                    'User-Agent'    => 'php_UAPAY/1.0',
                    'Content-Type'  => 'application/json'
                ],
                'body' => $this->get_json()
            ]);
            $body = $httpresponse->getBody()->getContents();
            Log::instance()->debug('got response:'.PHP_EOL.$body);
            $response = new $this->response_class($body, $this->jwt);
        }
        catch (\GuzzleHttp\Exception\TransferException $e)
        {
            Log::instance()->debug('request:'.PHP_EOL.\GuzzleHttp\Psr7\str($e->getRequest()));
            Log::instance()->debug('request:'.PHP_EOL.\GuzzleHttp\Psr7\str($e->/** @scrutinizer ignore-call */ getRequest()));
            if ($e->hasResponse()) {
            if ($e->/** @scrutinizer ignore-call */ hasResponse()) {
                Log::instance()->debug('response:'.PHP_EOL.\GuzzleHttp\Psr7\str($e->getResponse()));
                Log::instance()->debug('response:'.PHP_EOL.\GuzzleHttp\Psr7\str($e->/** @scrutinizer ignore-call */ getResponse()));
            }

            throw new Exception\Transfer('an error occured during a transfer');
        }

        return $response;
    }
}

dshovchko / php_UAPAY

Push — master ( 419110...a41d9b )

Request::own_private_key() B

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like
