Core23\LastFm\Client\ApiClient

Complexity

Total Complexity

14

Size/Duplication

Total Lines	156
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	4

Importance

Changes

0

9 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	6	1
A	getApiKey()	0	4	1
A	getSharedSecret()	0	4	1
A	signedCall()	0	22	2
A	unsignedCall()	0	14	1
A	filterNull()	0	6	1
A	encodeUTF8()	0	8	2
A	signParams()	0	12	2
A	call()	0	12	3

<?php

/*
 * (c) Christian Gripp <mail@core23.de>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Core23\LastFm\Client;

use Core23\LastFm\Connection\ConnectionInterface;
use Core23\LastFm\Exception\ApiException;
use Core23\LastFm\Exception\NotFoundException;
use Core23\LastFm\Session\SessionInterface;

final class ApiClient implements ApiClientInterface
{
    /**
     * @var ConnectionInterface
     */
    private $connection;

    /**
     * @var string
     */
    private $apiKey;

    /**
     * @var string
     */
    private $sharedSecret;

    /**
     * @param ConnectionInterface $connection
     * @param string              $apiKey
     * @param string              $sharedSecret
     */
    public function __construct(ConnectionInterface $connection, string $apiKey, string $sharedSecret)
    {
        $this->connection   = $connection;
        $this->apiKey       = $apiKey;
        $this->sharedSecret = $sharedSecret;
    }

    /**
     * {@inheritdoc}
     */
    public function getApiKey(): string
    {
        return $this->apiKey;
    }

    /**
     * {@inheritdoc}
     */
    public function getSharedSecret(): string
    {
        return $this->sharedSecret;
    }

    /**
     * {@inheritdoc}
     */
    public function signedCall(string $method, array $params = [], SessionInterface $session = null, $requestMethod = 'GET'): array
    {
        // Call parameter
        $callParams = [
            'method'  => $method,
            'api_key' => $this->apiKey,
        ];

        // Add session key
        if (null !== $session) {
            $callParams['sk'] = $session->getKey();
        }

        $params = array_merge($callParams, $params);
        $params = $this->filterNull($params);
        $params = $this->encodeUTF8($params);

        // Sign parameter
        $params['api_sig'] = $this->signParams($params);

It seems like $params defined by $this->encodeUTF8($params) on line 80 can also be of type string; however, Core23\LastFm\Client\ApiClient::signParams() does only seem to accept array, maybe add an additional type check?

        return $this->call($method, $params);

It seems like $params defined by $this->encodeUTF8($params) on line 80 can also be of type string; however, Core23\LastFm\Client\ApiClient::call() does only seem to accept array, maybe add an additional type check?

    }

    /**
     * {@inheritdoc}
     */
    public function unsignedCall(string $method, array $params = [], string $requestMethod = 'GET'): array
    {
        // Call parameter
        $callParameter = [
            'method'  => $method,
            'api_key' => $this->apiKey,
        ];

        $params = array_merge($callParameter, $params);
        $params = $this->filterNull($params);
        $params = $this->encodeUTF8($params);

        return $this->call($method, $params);

It seems like $params defined by $this->encodeUTF8($params) on line 101 can also be of type string; however, Core23\LastFm\Client\ApiClient::call() does only seem to accept array, maybe add an additional type check?

    }

    /**
     * Filter null values.
     *
     * @param array $object
     *
     * @return array
     */
    private function filterNull(array $object): array
    {
        return array_filter($object, static function ($val) {
            return null !== $val;
        });
    }

    /**
     * Converts any string or array of strings to UTF8.
     *
     * @param mixed|mixed[] $object a String or an array
     *
     * @return mixed|mixed[] UTF8-string or array
     */
    private function encodeUTF8($object)
    {
        if (\is_array($object)) {
            return array_map([$this, 'encodeUTF8'], $object);
        }

        return mb_convert_encoding((string) $object, 'UTF-8', 'auto');
    }

    /**
     * @param array $params
     *
     * @return string
     */
    private function signParams(array $params): string
    {
        ksort($params);

        $signature = '';
        foreach ($params as $name => $value) {
            $signature .= $name.$value;
        }
        $signature .= $this->sharedSecret;

        return md5($signature);
    }

    /**
     * @param string $method
     * @param array  $params
     *
     * @return array
     */
    private function call(string $method, array $params): array
    {
        try {
            return $this->connection->call($method, $params);
        } catch (ApiException $e) {
            if (6 === (int) $e->getCode()) {
                throw new NotFoundException('No entity was found for your request.', $e->getCode(), $e);
            }

            throw $e;
        }
    }
}