RpcRequest::resolveSecurityToken() - Code Metrics - Inspection of "improve tests" - aliyun/openapi-sdk-php-client - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Pull Request — master (#142)

by Yong
created 2019-04-22 06:35 UTC
RpcRequest::resolveSecurityToken() A

↳ Parent: Project
Complexity

Conditions	3
Paths	3
Size

Total Lines	11
Code Lines	5
Duplication

Lines	0
Ratio	0 %
Code Coverage

Tests	6
CRAP Score	3
Importance

Changes
Metric	Value
cc	3
eloc	5
nc	3
nop	0
dl	0
loc	11
ccs	6
cts	6
cp	1
crap	3
rs	10
c	0
b	0
f	0
<?php

namespace AlibabaCloud\Client\Request;

use Exception;
use Ramsey\Uuid\Uuid;
use RuntimeException;
use AlibabaCloud\Client\Credentials\StsCredential;
use AlibabaCloud\Client\Exception\ClientException;
use AlibabaCloud\Client\Exception\ServerException;
use AlibabaCloud\Client\Credentials\BearerTokenCredential;

/**
 * RESTful RPC Request.
 *
 * @package   AlibabaCloud\Client\Request
 */
class RpcRequest extends Request
{

    /**
     * @var string
     */
    private $dateTimeFormat = 'Y-m-d\TH:i:s\Z';

    /**
     * Resolve request parameter.
     *
     * @throws ClientException
     */
    public function resolveParameter()
    {
        $this->resolveBoolInParameters();
        $this->resolveCommonParameters();
        $this->repositionParameters();
    }

    /**
     * Convert a Boolean value to a string
     */
    private function resolveBoolInParameters()
    {
        if (isset($this->options['query'])) {
            $this->options['query'] = array_map(
                static function ($value) {
                    return self::boolToString($value);
                },
                $this->options['query']
            );
        }
    }

    /**
     * Convert a Boolean value to a string.
     *
     * @param bool|string $value
     *
     * @return string
     */
    public static function boolToString($value)
    {
        if (is_bool($value)) {
            return $value ? 'true' : 'false';
        }

        return $value;
    }

    /**
     * Resolve Common Parameters.
     *
     * @throws ClientException
     * @throws Exception
     */
    private function resolveCommonParameters()
    {
        $signature                                  = $this->httpClient()->getSignature();
        $this->options['query']['RegionId']         = $this->realRegionId();
        $this->options['query']['Format']           = $this->format;
        $this->options['query']['SignatureMethod']  = $signature->getMethod();
        $this->options['query']['SignatureVersion'] = $signature->getVersion();
        $this->options['query']['SignatureNonce']   = Uuid::uuid1()->toString();
        $this->options['query']['Timestamp']        = gmdate($this->dateTimeFormat);
        $this->options['query']['Action']           = $this->action;
        if ($this->credential()->getAccessKeyId()) {
        if ($this->credential()->/** @scrutinizer ignore-call */ getAccessKeyId()) {
            $this->options['query']['AccessKeyId'] = $this->credential()->getAccessKeyId();
        }
        if ($signature->getType()) {
            $this->options['query']['SignatureType'] = $signature->getType();
        }
        if (!isset($this->options['query']['Version'])) {
            $this->options['query']['Version'] = $this->version;
        }
        $this->resolveSecurityToken();
        $this->resolveBearerToken();
        $this->options['query']['Signature'] = $this->signature();
    }

    /**
     * @throws ClientException
     * @throws ServerException
     */
    private function resolveSecurityToken()
    {
        if (!$this->credential() instanceof StsCredential) {
            return;
        }

        if (!$this->credential()->getSecurityToken()) {
            return;
        }

        $this->options['query']['SecurityToken'] = $this->credential()->getSecurityToken();
    }

    /**
     * @throws ClientException
     * @throws ServerException
     */
    private function resolveBearerToken()
    {
        if ($this->credential() instanceof BearerTokenCredential) {
            $this->options['query']['BearerToken'] = $this->credential()->getBearerToken();
        }
    }

    /**
     * Sign the parameters.
     *
     * @return mixed
     * @throws ClientException
     * @throws ServerException
     */
    private function signature()
    {
        return $this->httpClient()
                    ->getSignature()
                    ->sign(
                        $this->stringToSign(),
                        $this->credential()->getAccessKeySecret() . '&'
                        $this->credential()->/** @scrutinizer ignore-call */ getAccessKeySecret() . '&'
                    );
    }

    /**
     * @return string
     */
    public function stringToSign()
    {
        $query      = isset($this->options['query']) ? $this->options['query'] : [];
        $form       = isset($this->options['form_params']) ? $this->options['form_params'] : [];
        $parameters = \AlibabaCloud\Client\arrayMerge([$query, $form]);
        ksort($parameters);
        $canonicalized = '';
        foreach ($parameters as $key => $value) {
            $canonicalized .= '&' . $this->percentEncode($key) . '=' . $this->percentEncode($value);
        }

        return $this->method . '&%2F&' . $this->percentEncode(substr($canonicalized, 1));
    }

    /**
     * @param string $string
     *
     * @return null|string|string[]
     */
    private function percentEncode($string)
    {
        $result = urlencode($string);
        $result = str_replace(['+', '*'], ['%20', '%2A'], $result);
        $result = preg_replace('/%7E/', '~', $result);

        return $result;
    }

    /**
     * Adjust parameter position
     */
    private function repositionParameters()
    {
        if ($this->method === 'POST' || $this->method === 'PUT') {
            foreach ($this->options['query'] as $apiParamKey => $apiParamValue) {
                $this->options['form_params'][$apiParamKey] = $apiParamValue;
            }
            unset($this->options['query']);
        }
    }

    /**
     * Magic method for set or get request parameters.
     *
     * @param string $name
     * @param mixed  $arguments
     *
     * @return $this
     */
    public function __call($name, $arguments)
    {
        if (strncmp($name, 'get', 3) === 0) {
            $parameterName = $this->propertyNameByMethodName($name);

            return $this->__get($parameterName);
        }

        if (strncmp($name, 'with', 4) === 0) {
            $parameterName = $this->propertyNameByMethodName($name, 4);
            $this->__set($parameterName, $arguments[0]);
            $this->options['query'][$parameterName] = $arguments[0];

            return $this;
        }

        if (strncmp($name, 'set', 3) === 0) {
            $parameterName = $this->propertyNameByMethodName($name);
            $withMethod    = "with$parameterName";

            throw new RuntimeException("Please use $withMethod instead of $name");
        }

        throw new RuntimeException('Call to undefined method ' . __CLASS__ . '::' . $name . '()');
    }
}

aliyun / openapi-sdk-php-client

GitHub Access Token became invalid

Pull Request — master (#142)

RpcRequest::resolveSecurityToken() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like
