App\Services\Musixmatch

Complexity

Total Complexity

14

Size/Duplication

Total Lines	107
Duplicated Lines	8.41 %

Coupling/Cohesion

Components	1
Dependencies	5

Importance

Changes

0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	9	9	3
A	enabled()	0	4	1
A	searchLyricsRelatedToSong()	0	15	4
A	search()	0	22	3
A	jsonpDecode()	0	4	1
A	getLyrics()	0	13	2

<?php

namespace App\Services;

use App\Models\Song;
use Cache;
use GuzzleHttp\Client;
use Log;

class Musixmatch extends RESTfulService
{
    /**
     * Construct an instance of Musixmatch service.
     *
     * @param string      $key    The Musixmatch API key
     * @param Client|null $client The Guzzle HTTP client
     */
    public function __construct($key = null, Client $client = null)

This method seems to be duplicated in your project.

    {
        parent::__construct(
            $key ?: config('koel.musixmatch.key'),
            null,
            'https://api.musixmatch.com/ws/1.1',
            $client ?: new Client()
        );
    }
    
    /**
     * Determine if our application is using Musixmatch.
     *
     * @return bool
     */
    public function enabled()
    {
        return (bool) config('koel.musixmatch.key');
    }
    
    /**
     * @param App\Models\Song $song
     * 
     * @return mixed|null
     */
    public function searchLyricsRelatedToSong(Song $song)
    {
        if($song->hasLyrics() == false)

It seems like you are loosely comparing two booleans. Considering using the strict comparison === instead.

        {
            if (!$song->artist->isUnknown() && !$song->artist->isVarious()) {

The method isUnknown() does not exist on App\Models\Artist. Did you maybe mean getIsUnknownAttribute()?

The method isVarious() does not exist on App\Models\Artist. Did you maybe mean getIsVariousAttribute()?

                $lyrics = $this->search($song->title, $song->artist->name);
            } else {
                $lyrics = $this->search($song->title);
            }
            
            return $song->updateSingle($song->title, $song->album->name, $song->artist->name, $lyrics, $song->track, (int) $song->compilationState);

The property compilationState does not exist on object<App\Models\Song>. Since you implemented __get, maybe consider adding a @property annotation.

It seems like $lyrics can also be of type false; however, App\Models\Song::updateSingle() does only seem to accept string, did you maybe forget to handle an error condition?

        }
        
        return false;
    }
    
    /**
     * @param string $name
     * @param string $artistName
     * 
     * @return mixed|false
     */
    public function search(string $name, string $artistName = null)
    {
        if (!$this->enabled()) {
            return false;
        }
        
        $uri = sprintf('matcher.lyrics.get?format=jsonp&callback=callback&q_track=%s&q_artist=%s&apikey=%s',
            urlencode($name),
            urlencode($artistName),
            $this->key
        );
        
        try{
            $response = $this->jsonpDecode($this->get($uri));

$this->get($uri) is of type object, but the function expects a string.

            
            return $this->getLyrics($response);
        }catch(\Exception $e){
            Log::error($e);

            return false;
        }
    }
    
    /**
     * @param string $response
     * 
     * @return mixed
     */
    private function jsonpDecode($response)
    {
        return json_decode(substr(preg_replace("/[^(]*\((.*)\)/","$1",$response), 0, -1));
    }
    
    /**
     * @param JSON $response
     * 
     * @return string|null
     */
    private function getLyrics($response)
    {
        $lyrics = $response->message->body->lyrics->lyrics_body;
        
        if(strlen($lyrics))
        {
            // Correct Musixmatch spelling mistake (is for are).
            return substr($lyrics, 0, strpos($lyrics, "******* This Lyrics is NOT for Commercial use *******")).
                "*** This Lyrics are NOT for Commercial use ***";
        }
        
        return false;
    }
}