aplisin / dingtalk

src/Kernel/AccessToken.php

<?php
/**
 * This file is part of the dingtalk.
 * User: Ilham Tahir <yantaq@bilig.biz>
 * This source file is subject to the MIT license that is bundled
 * with this source code in the file LICENSE.
 */

namespace Aplisin\DingTalk\Kernel;

use Aplisin\DingTalk\Kernel\Contracts\AccessTokenInterface;
use Aplisin\DingTalk\Kernel\Traits\HasHttpRequests;
use Aplisin\DingTalk\Kernel\Traits\InteractsWithCache;
use Pimple\Container;
use Psr\Http\Message\RequestInterface;
use Psr\Http\Message\ResponseInterface;
use Aplisin\DingTalk\Kernel\Exceptions\HttpException;
use Aplisin\DingTalk\Kernel\Exceptions\InvalidArgumentException;

abstract class AccessToken implements AccessTokenInterface
{
    use HasHttpRequests, InteractsWithCache;

The trait Aplisin\DingTalk\Kernel\Traits\HasHttpRequests requires the property $baseUri which is not provided by Aplisin\DingTalk\Kernel\AccessToken.

    protected $app;

    protected $requestMethod = 'GET';

    protected $endpointToGetToken;

    protected $queryName;

    protected $token;

    protected $safeSeconds = 500;

    protected $tokenKey = 'access_token';

    protected $cachePrefix = 'aplisindingtalk.kernel.access_token.';

    public function __construct(Container $app)
    {
        $this->app = $app;
    }

    public function getRefreshedToken(): array
    {
        return $this->getToken(true);
    }

    /**
     * @param bool $refresh
     * @return array
     * @throws Exceptions\InvalidConfigException
     * @throws HttpException
     * @throws InvalidArgumentException
     * @throws \GuzzleHttp\Exception\GuzzleException
     * @throws \Psr\SimpleCache\InvalidArgumentException
     */
    public function getToken(bool $refresh = false): array
    {
        $cacheKey = $this->getCacheKey();
        $cache = $this->getCache();

Equals sign not aligned with surrounding assignments; expected 4 spaces but found 1 space

        if (!$refresh && $cache->has($cacheKey)) {
            return $cache->get($cacheKey);

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

        }

        $token = $this->requestToken($this->getCredentials(), true);

        $this->setToken($token[$this->tokenKey], $token['expires_in'] ?? 7200);

        return $token;

The expression return $token could return the type Aplisin\DingTalk\Kernel\Http\Response|Aplisin\DingTalk\Kernel\Support\Collection|Psr\Http\Message\ResponseInterface which is incompatible with the type-hinted return array. Consider adding an additional type-check to rule them out.

    }

    /**
     * @param string $token
     * @param int $lifetime
     * @return AccessTokenInterface
     * @throws \Psr\SimpleCache\InvalidArgumentException
     */
    public function setToken(string $token, int $lifetime = 7200): AccessTokenInterface
    {
        $this->getCache()->set($this->getCacheKey(), [
            $this->tokenKey => $token,
            'expires_in' => $lifetime,
        ], $lifetime - $this->safeSeconds);

        return $this;
    }

    /**
     * @return AccessTokenInterface
     * @throws Exceptions\InvalidConfigException
     * @throws HttpException
     * @throws InvalidArgumentException
     * @throws \GuzzleHttp\Exception\GuzzleException
     * @throws \Psr\SimpleCache\InvalidArgumentException
     */
    public function refresh(): AccessTokenInterface
    {
        $this->getToken(true);

        return $this;
    }

    /**
     * @param array $credentials
     * @param bool $toArray
     * @return Http\Response|Support\Collection|array|mixed|ResponseInterface
     * @throws Exceptions\InvalidConfigException
     * @throws HttpException
     * @throws InvalidArgumentException
     * @throws \GuzzleHttp\Exception\GuzzleException
     */
    public function requestToken(array $credentials, $toArray = false)
    {
        $response = $this->sendRequest($credentials);

Equals sign not aligned with surrounding assignments; expected 2 spaces but found 1 space

        $result = json_decode($response->getBody()->getContents(), true);

Equals sign not aligned with surrounding assignments; expected 4 spaces but found 1 space

        $formatted = $this->castResponseToType($response, $this->app['config']->get('response_type'));

        if (empty($result[$this->tokenKey])) {
            throw new HttpException(
                'Request access_token fail: '.json_encode($result, JSON_UNESCAPED_UNICODE),
                $response,
                $formatted
            );
        }

        return $toArray ? $result : $formatted;
    }


    public function applyToRequest(RequestInterface $request, array $requestOptions = []): RequestInterface
    {
        parse_str($request->getUri()->getQuery(), $query);

        $query = http_build_query(array_merge($this->getQuery(), $query));

        return $request->withUri($request->getUri()->withQuery($query));
    }

    /**
     * @param array $credentials
     * @return ResponseInterface
     * @throws InvalidArgumentException
     * @throws \GuzzleHttp\Exception\GuzzleException
     */
    protected function sendRequest(array $credentials): ResponseInterface
    {
        $options = [
            ('GET' === $this->requestMethod) ? 'query' : 'json' => $credentials,
        ];

        return $this->setHttpClient($this->app['http_client'])
            ->request($this->getEndpoint(), $this->requestMethod, $options);
    }

    protected function getCacheKey()
    {
        return $this->cachePrefix.md5(json_encode($this->getCredentials()));
    }

    /**
     * @return array
     * @throws Exceptions\InvalidConfigException
     * @throws HttpException
     * @throws InvalidArgumentException
     * @throws \GuzzleHttp\Exception\GuzzleException
     * @throws \Psr\SimpleCache\InvalidArgumentException
     */
    protected function getQuery(): array
    {
        return [$this->queryName ?? $this->tokenKey => $this->getToken()[$this->tokenKey]];
    }

    /**
     * @return string
     * @throws InvalidArgumentException
     */
    public function getEndpoint(): string
    {
        if (empty($this->endpointToGetToken)) {
            throw new InvalidArgumentException('No endpoint for access token request.');
        }

        return $this->endpointToGetToken;
    }

    abstract protected function getCredentials(): array;
}