App\Controller\TokenController

Complexity

Total Complexity

8

Size/Duplication

Total Lines	160
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	10

Importance

Changes	2
Bugs	0	Features	1

5 Methods

Rating	Name	Duplication	Size	Complexity
A	getToken()	0	14	3
A	refreshToken()	0	14	2
A	buildTokens()	0	21	1
A	failUnknownUser()	0	4	1
A	failUnknownToken()	0	4	1

<?php

namespace App\Controller;

use App\Requests\GetTokenRequest;
use App\Requests\RefreshTokenRequest;
use App\Model\User;
use App\Model\AccessToken;
use App\Model\RefreshToken;

use Slim\Http\Request;
use Slim\Http\Response;

use App\Common\JsonException;

class TokenController extends BaseController
{
    const TOKEN_TYPE = 'Bearer';

    /**
     * @api {post} /token Получение токена
     * @apiName CreateToken
     * @apiGroup Token
     *
     * @apiDescription Метод для получения авторизационного токена. Токен необходим для выполнения запросов к АПИ.
     * Полученный токен отправляется в заголовке запроса:
     * <br/>
     * <strong>Authorization: Bearer xxxxxxxxxxxxxxxxxxxxxxxxxxxxx</strong>
     *
     * @apiHeader {String} Content-Type application/vnd.api+json <br/> application/json
     *
     * @apiParam {String} username Логин
     * @apiParam {String} password Пароль
     *
     * @apiParamExample {json} Пример запроса:
     *    {
     *      "data":{
     *        "attributes":{
     *          "username":"admin@example.com",
     *          "password": "qwerty"
     *        }
     *      }
     *    }
     *
     * @apiSuccessExample {json} Успешно (200)
     *     HTTP/1.1 200 OK
     *     {
     *       "access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOmZhbHNlLCJhdWQiOiJza2VsZXRvbi5kZXYiLCJpYXQiOjE0NzY0Mjk4NjksImV4cCI6MTQ3NjQzMzQ2OX0.NJn_-lK28kEZyZqygLr6B-FZ2zC2-1unStayTGicP5g",
     *       "expires_in": 3600,
     *       "token_type": "Bearer",
     *       "refresh_token": "092ea7e36f6b9bf462cb3ca1f6f86b80"
     *     }
     *
     * @apiUse StandardErrors
     */
    /**
     * @param Request  $request
     * @param Response $response
     *
     * @return \Psr\Http\Message\ResponseInterface
     * @throws JsonException
     */
    public function getToken(Request $request, Response $response)
    {
        $params = $request->getParsedBody();

        $this->validateRequestParams($params, 'token', new GetTokenRequest());

        $user = User::findUserByEmail($params['data']['attributes']['username']);
        // ensure user and password are good
        if (!$user || !password_verify($params['data']['attributes']['password'], $user->password)) {
            $this->failUnknownUser();
        }

        return $this->buildTokens($request, $response, $user);

It seems like $user defined by \App\Model\User::findUserByEmail($params['data']['attributes']['username']) on line 69 can be null; however, App\Controller\TokenController::buildTokens() does not accept null, maybe add an additional type check?

    }

    /**
     * @api {post} /refresh-token Обновление токена
     * @apiName RefreshToken
     * @apiGroup Token
     *
     * @apiDescription Метод для обновления access_token по refresh_token
     *
     * @apiHeader {String} Content-Type application/vnd.api+json <br/> application/json
     *
     * @apiParam {String} refresh_token Токен для обновления
     *
     * @apiParamExample {json} Пример запроса:
     *    {
     *      "data":{
     *        "attributes":{
     *          "refresh_token":"092ea7e36f6b9bf462cb3ca1f6f86b80"
     *        }
     *      }
     *    }
     *
     * @apiSuccessExample {json} Успешно (200)
     *     HTTP/1.1 200 OK
     *     {
     *       "access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOmZhbHNlLCJhdWQiOiJza2VsZXRvbi5kZXYiLCJpYXQiOjE0NzY0Mjk4NjksImV4cCI6MTQ3NjQzMzQ2OX0.NJn_-lK28kEZyZqygLr6B-FZ2zC2-1unStayTGicP5g",
     *       "expires_in": 3600,
     *       "token_type": "Bearer",
     *       "refresh_token": "092ea7e36f6b9bf462cb3ca1f6f86b80"
     *     }
     *
     * @apiUse StandardErrors
     */

    /**
     * @param Request  $request
     * @param Response $response
     *
     * @return \Psr\Http\Message\ResponseInterface
     * @throws JsonException
     */
    public function refreshToken(Request $request, Response $response)
    {
        $params = $request->getParsedBody();

        $this->validateRequestParams($params, 'token', new RefreshTokenRequest());

        $user = RefreshToken::getUserByToken($params['data']['attributes']['refresh_token']);
        // ensure user is good
        if (!$user) {
            $this->failUnknownToken();
        }

        return $this->buildTokens($request, $response, $user);

It seems like $user defined by \App\Model\RefreshToken::getUserByToken($params['data']['attributes']['refresh_token']) on line 123 can be null; however, App\Controller\TokenController::buildTokens() does not accept null, maybe add an additional type check?

    }

    /**
     * @param Request $request
     * @param Response $response
     * @param User $user
     * @return \Psr\Http\Message\ResponseInterface
     */
    protected function buildTokens(Request $request, Response $response, User $user)
    {
        // build tokens
        $accessToken = AccessToken::createToken(
            $user,
            $request->getUri()->getHost(),
            $this->settings['accessToken']
        );
        $refreshToken = RefreshToken::createToken($user);

        // prepare response structure
        $result = [
            'token_type'    => self::TOKEN_TYPE,
            'access_token'  => $accessToken,
            'refresh_token' => $refreshToken,
            'expires_in'    => $this->settings['accessToken']['ttl'],
        ];

        // render response
        return $this->apiRenderer->jsonResponse($response, 200, json_encode($result));
    }

    /**
     * @throws JsonException
     */
    protected function failUnknownUser()
    {
        throw new JsonException('token', 400, 'Invalid Attribute', 'Invalid password or username');
    }

    /**
     * @throws JsonException
     */
    protected function failUnknownToken()
    {
        throw new JsonException('token', 400, 'Invalid Attribute', 'Invalid refresh_token');
    }
}