App\Http\Controllers\API\LastfmController

Complexity

Total Complexity

5

Size/Duplication

Total Lines	86
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes	2
Bugs	1	Features	0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	5	1
A	setSessionKey()	0	5	1
A	disconnect()	0	5	1
A	callback()	0	9	1
A	connect()	0	13	1

<?php

namespace App\Http\Controllers\API;

use App\Http\Requests\API\LastfmCallbackRequest;
use App\Http\Requests\API\LastfmSetSessionKeyRequest;
use App\Services\LastfmService;
use Illuminate\Contracts\Auth\Guard;
use Illuminate\Http\JsonResponse;
use Illuminate\Http\RedirectResponse;
use Tymon\JWTAuth\Exceptions\JWTException;
use Tymon\JWTAuth\JWTAuth;

/**
 * @group Last.fm integration
 */
class LastfmController extends Controller
{
    protected $auth;
    private $lastfmService;
    private $jwtAuth;

    public function __construct(Guard $auth, LastfmService $lastfmService, JWTAuth $jwtAuth)
    {
        $this->auth = $auth;
        $this->lastfmService = $lastfmService;
        $this->jwtAuth = $jwtAuth;
    }

    /**
     * Connect to Last.fm.
     *
     * [Connect](https://www.last.fm/api/authentication) the current user to Last.fm.
     * This is actually NOT an API request. The application should instead redirect the current user to this route,
     * which will send them to Last.fm for authentication. After authentication is successful, the user will be
     * redirected back to `api/lastfm/callback?token=<Last.fm token>`.
     *
     * @queryParam jwt-token required The JWT token of the user.
     *
     * @throws JWTException
     *
     * @return RedirectResponse
     */
    public function connect()
    {
        abort_unless($this->lastfmService->enabled(), 401, 'Koel is not configured to use with Last.fm yet.');

        // A workaround to make sure Tymon's JWTAuth get the correct token via our custom
        // "jwt-token" query string instead of the default "token".
        // This is due to the problem that Last.fm returns the token via "token" as well.
        $this->jwtAuth->parseToken('', '', 'jwt-token');

        $callbackUrl = urlencode(sprintf('%s?jwt-token=%s', route('lastfm.callback'), $this->jwtAuth->getToken()));
        $url = sprintf('https://www.last.fm/api/auth/?api_key=%s&cb=%s', $this->lastfmService->getKey(), $callbackUrl);

        return redirect($url);
    }

    /**
     * Serve the callback request from Last.fm.
     */
    public function callback(LastfmCallbackRequest $request)
    {
        $sessionKey = $this->lastfmService->getSessionKey($request->token);

        abort_unless($sessionKey, 500, 'Invalid token key.');

It seems like $sessionKey can also be of type string; however, parameter $boolean of abort_unless() does only seem to accept boolean, maybe add an additional type check?

        $this->auth->user()->savePreference('lastfm_session_key', $sessionKey);

The method savePreference() does not exist on Illuminate\Contracts\Auth\Authenticatable. It seems like you code against a sub-type of Illuminate\Contracts\Auth\Authenticatable such as Illuminate\Foundation\Auth\User.

        return view('api.lastfm.callback');
    }

    /**
     * Set Last.fm session key.
     *
     * Set the Last.fm session key for the current user. This call should be made after the user is
     * [connected to Last.fm](https://www.last.fm/api/authentication).
     *
     * @bodyParam key string required The Last.fm [session key](https://www.last.fm/api/show/auth.getSession).
     * @response []
     *
     * @param LastfmSetSessionKeyRequest $request
     *
     * @return JsonResponse
     */
    public function setSessionKey(LastfmSetSessionKeyRequest $request)
    {
        $this->auth->user()->savePreference('lastfm_session_key', trim($request->key));

        return response()->json();
    }

    /**
     * Disconnect the current user from Last.fm.
     *
     * @return JsonResponse
     */
    public function disconnect()
    {
        $this->auth->user()->deletePreference('lastfm_session_key');

The method deletePreference() does not exist on Illuminate\Contracts\Auth\Authenticatable. It seems like you code against a sub-type of Illuminate\Contracts\Auth\Authenticatable such as Illuminate\Foundation\Auth\User.

        return response()->json();
    }
}