Core23\LastFm\Connection\AbstractConnection

Complexity

Total Complexity

12

Size/Duplication

Total Lines	156
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Importance

Changes

0

9 Methods

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

<?php

/*
 * This file is part of the ni-ju-san CMS.
 *
 * (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\Connection;

use Core23\LastFm\Exception\ApiException;

abstract class AbstractConnection implements ConnectionInterface
{
    /**
     * Default Endpoint.
     */
    const DEFAULT_WS_ENDPOINT = 'http://ws.audioscrobbler.com/2.0/';

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

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

    /**
     * @var string
     */
    protected $uri;

    /**
     * AbstractConnection constructor.
     *
     * @param string $apikey
     * @param string $sharedSecret
     * @param string $uri
     */
    public function __construct($apikey, $sharedSecret, $uri = null)
    {
        if (null === $uri) {
            $uri = static::DEFAULT_WS_ENDPOINT;
        }

        $this->apiKey       = $apikey;
        $this->sharedSecret = $sharedSecret;
        $this->uri          = $uri;
    }

    /**
     * {@inheritdoc}
     */
    public function signedCall($method, array $params = array(), SessionInterface $session = null, $requestMethod = 'GET')
    {
        // Call parameter
        $callParams = array(
            '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 74 can also be of type string; however, Core23\LastFm\Connection\AbstractConnection::signParams() does only seem to accept array, maybe add an additional type check?

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

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

    }

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

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

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

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

    }

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

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

    /**
     * Performs the webservice call.
     *
     * @param array  $params
     * @param string $requestMethod
     *
     * @return array
     *
     * @throws ApiException
     */
    abstract protected function call(array $params, $requestMethod = 'GET');

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

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

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

    /**
     * {@inheritdoc}
     */
    private function signParams(array $params)
    {
        ksort($params);

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

        return md5($signature);
    }
}