UserApi::getAvatarUrl() - Code Metrics - Inspection of "Hardcoded URL's removed everywhere in favor of dyn..." - skobkin/point-tools - Measure and Improve Code Quality continuously with Scrutinizer

Test Setup Failed

Push — master ( d6bd2d...bc363c )

by Alexey

created 2017-01-11 18:03 UTC

UserApi::getAvatarUrl() A

↳ Parent: Project

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	1

Importance

Changes

Metric	Value
c	0
b	0
f	0
dl	0
loc	4
ccs	2
cts	2
cp	1
rs	10
cc	1
eloc	2
nc	1
nop	2
crap	1

<?php

namespace Skobkin\Bundle\PointToolsBundle\Service;

use Doctrine\ORM\EntityManager;
use Doctrine\ORM\EntityRepository;
use GuzzleHttp\ClientInterface;
use GuzzleHttp\Exception\RequestException;
use JMS\Serializer\Serializer;
use Psr\Log\LoggerInterface;
use Skobkin\Bundle\PointToolsBundle\DTO\Api\Auth;
use Skobkin\Bundle\PointToolsBundle\Entity\User;
use Skobkin\Bundle\PointToolsBundle\Service\Exceptions\ApiException;
use Skobkin\Bundle\PointToolsBundle\Service\Exceptions\InvalidResponseException;
use Skobkin\Bundle\PointToolsBundle\Service\Exceptions\UserNotFoundException;
use Symfony\Component\HttpFoundation\Response;

/**
 * Basic Point.im user API functions from /api/user/*
 */
class UserApi extends AbstractApi
{
    /**
     * @var EntityManager
     */
    protected $em;

    /**
     * @var EntityRepository
     */
    protected $userRepository;

    /**
     * @var Serializer
     */
    private $serializer;

    public function __construct(ClientInterface $httpClient, LoggerInterface $logger, EntityManager $entityManager, Serializer $serializer)
function someFunction(ManagerRegistry $registry) {
    $em = $registry->getManager();
    $em->getConnection()->beginTransaction();
    try {
        // Do something.
        $em->getConnection()->commit();
    } catch (\Exception $ex) {
        $em->getConnection()->rollback();
        $em->close();

        throw $ex;
    }
}
    {
        parent::__construct($httpClient, $logger);

        $this->em = $entityManager;
        $this->serializer = $serializer;
        // @todo refactor
        $this->userRepository = $this->em->getRepository('SkobkinPointToolsBundle:User');
    }

    public function isAuthDataValid(string $login, string $password): bool
    {
        $this->logger->info('Checking user auth data via point.im API');

        $auth = $this->authenticate($login, $password);

        if (null === $auth->getError() && null !== $auth->getToken()) {
            $this->logger->debug('Authentication successfull. Logging out.');

            $this->logout($auth);

            return true;
        }

        return false;
    }

    public function authenticate(string $login, string $password): Auth
    {
        $this->logger->debug('Trying to authenticate user via Point.im API', ['login' => $login]);

        try {
            $authData = $this->getPostRequestData(
                '/api/login',
                [
                    'login' => $login,
                    'password' => $password,
                ]
            );

            return $this->serializer->deserialize($authData, Auth::class, 'json');
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}
        } catch (RequestException $e) {
            if (Response::HTTP_NOT_FOUND === $e->getResponse()->getStatusCode()) {
                throw new InvalidResponseException('API method not found', 0, $e);
            } else {
                throw $e;
            }
        }
    }

    public function logout(Auth $auth): bool
    {
        $this->logger->debug('Trying to log user out via Point.im API');

        try {
            $this->getPostRequestData('/api/logout', ['csrf_token' => $auth->getCsRfToken()]);

            return true;
        } catch (RequestException $e) {
            if (Response::HTTP_NOT_FOUND === $e->getResponse()->getStatusCode()) {
                throw new InvalidResponseException('API method not found', 0, $e);
            } elseif (Response::HTTP_FORBIDDEN === $e->getResponse()->getStatusCode()) {
                return true;
            } else {
                throw $e;
            }
        }
    }

    /**
     * Get user subscribers by user login
     *
     * @param string $login
     *
     * @return User[]
     *
     * @throws ApiException
     * @throws InvalidResponseException
     * @throws UserNotFoundException
     */
    public function getUserSubscribersByLogin(string $login): array

    {
        $this->logger->debug('Trying to get user subscribers by login', ['login' => $login]);

        try {
            $usersList = $this->getGetRequestData('/api/user/'.urlencode($login).'/subscribers', [], true);
        } catch (RequestException $e) {
            if (Response::HTTP_NOT_FOUND === $e->getResponse()->getStatusCode()) {
                throw new UserNotFoundException('User not found', 0, $e, null, $login);
            } else {
                throw $e;
            }
        }

        return $this->getUsersFromList($usersList);
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}
    }

    /**
     * Get user subscribers by user id
     *
     * @param int $id
     *
     * @return User[]
     *
     * @throws ApiException
     * @throws InvalidResponseException
     * @throws UserNotFoundException
     */
    public function getUserSubscribersById(int $id): array

    {
        $this->logger->debug('Trying to get user subscribers by id', ['id' => $id]);

        try {
            $usersList = $this->getGetRequestData('/api/user/id/'.(int) $id.'/subscribers', [], true);
        } catch (RequestException $e) {
            if (Response::HTTP_NOT_FOUND === $e->getResponse()->getStatusCode()) {
                throw new UserNotFoundException('User not found', 0, $e, $id);
            } else {
                throw $e;
            }
        }

        return $this->getUsersFromList($usersList);
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}
    }

    /**
     * Get user subscriptions by user login
     *
     * @param string $login
     *
     * @return User[]
     *
     * @throws ApiException
     * @throws InvalidResponseException
     * @throws UserNotFoundException
     */
    public function getUserSubscriptionsByLogin(string $login): array

    {
        $this->logger->debug('Trying to get user subscriptions by login', ['login' => $login]);

        try {
            $usersList = $this->getGetRequestData('/api/user/'.urlencode($login).'/subscriptions', [], true);
        } catch (RequestException $e) {
            if (Response::HTTP_NOT_FOUND === $e->getResponse()->getStatusCode()) {
                throw new UserNotFoundException('User not found', 0, $e, null, $login);
            } else {
                throw $e;
            }
        }

        return $this->getUsersFromList($usersList);
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}
    }

    /**
     * Get user subscriptions by user id
     *
     * @param int $id
     *
     * @return User[]
     *
     * @throws ApiException
     * @throws InvalidResponseException
     * @throws UserNotFoundException
     */
    public function getUserSubscriptionsById(int $id): array

    {
        $this->logger->debug('Trying to get user subscriptions by id', ['id' => $id]);

        try {
            $usersList = $this->getGetRequestData('/api/user/id/'.(int) $id.'/subscriptions', [], true);
        } catch (RequestException $e) {
            if (Response::HTTP_NOT_FOUND === $e->getResponse()->getStatusCode()) {
                throw new UserNotFoundException('User not found', 0, $e, $id);
            } else {
                throw $e;
            }
        }

        return $this->getUsersFromList($usersList);
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}
    }

    /**
     * Get single user by login
     *
     * @param string $login
     *
     * @return User
     *
     * @throws UserNotFoundException
     * @throws RequestException
     */
    public function getUserByLogin(string $login): User

    {
        $this->logger->debug('Trying to get user by login', ['login' => $login]);

        try {
            $userInfo = $this->getGetRequestData('/api/user/login/'.urlencode($login), [], true);
        } catch (RequestException $e) {
            if (Response::HTTP_NOT_FOUND === $e->getResponse()->getStatusCode()) {
                throw new UserNotFoundException('User not found', 0, $e, null, $login);
            } else {
                throw $e;
            }
        }

        return $this->getUserFromUserInfo($userInfo);
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}
    }

    /**
     * Get single user by id
     *
     * @param int $id
     *
     * @return User
     *
     * @throws UserNotFoundException
     * @throws RequestException
     */
    public function getUserById(int $id): User

    {
        $this->logger->debug('Trying to get user by id', ['id' => $id]);

        try {
            $userInfo = $this->getGetRequestData('/api/user/id/'.$id, [], true);
        } catch (RequestException $e) {
            if (Response::HTTP_NOT_FOUND === $e->getResponse()->getStatusCode()) {
                throw new UserNotFoundException('User not found', 0, $e, $id);
            } else {
                throw $e;
            }
        }

        return $this->getUserFromUserInfo($userInfo);
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}
    }

    /**
     * Finds and updates or create new user from API response data
     *
     * @param array $userInfo
     *
     * @return User
     *
     * @throws ApiException
     * @throws InvalidResponseException
     */
    public function getUserFromUserInfo(array $userInfo): User
    {
        $this->logger->debug('Trying to create user from array', ['array' => $userInfo]);

        // @todo Refactor to UserFactory->createFromArray()
        if (array_key_exists('id', $userInfo) && array_key_exists('login', $userInfo) && array_key_exists('name', $userInfo) && is_numeric($userInfo['id'])) {
            /** @var User $user */
            if (null === ($user = $this->userRepository->find($userInfo['id']))) {

                // Creating new user
                $user = new User($userInfo['id']);
                $this->em->persist($user);
            }

            // Updating data
            $user
                ->setLogin($userInfo['login'])
                ->setName($userInfo['name'])
            ;

            return $user;
        }

        throw new InvalidResponseException('Invalid API response. Mandatory fields do not exist.');
    }

    /**
     * Get array of User objects from API response containing user list
     *
     * @todo refactor
     *
     * @param array $users
     *
     * @return User[]
     *
     * @throws ApiException
     * @throws InvalidResponseException
     */
    private function getUsersFromList(array $users = []): array
    {
        $this->logger->debug('Trying to create multiple users from array', ['array' => $users]);

        /** @var User[] $resultUsers */
        $resultUsers = [];

        foreach ($users as $userInfo) {
            if (array_key_exists('id', $userInfo) && array_key_exists('login', $userInfo) && array_key_exists('name', $userInfo) && is_numeric($userInfo['id'])) {

                // @todo Optimize with prehashed id's list
                if (null === ($user = $this->userRepository->find($userInfo['id']))) {

                    $user = new User((int) $userInfo['id']);
                    $this->em->persist($user);
                }

                // Updating data
                $user
                    ->setLogin($userInfo['login'])
                    ->setName($userInfo['name'])
                ;

                $resultUsers[] = $user;
            } else {
                throw new InvalidResponseException('Invalid API response. Mandatory fields do not exist.');
            }
        }

        return $resultUsers;
    }
}


1			<?php
2
3			namespace Skobkin\Bundle\PointToolsBundle\Service;
4
5			use Doctrine\ORM\EntityManager;
6			use Doctrine\ORM\EntityRepository;
7			use GuzzleHttp\ClientInterface;
8			use GuzzleHttp\Exception\RequestException;
9			use JMS\Serializer\Serializer;
10			use Psr\Log\LoggerInterface;
11			use Skobkin\Bundle\PointToolsBundle\DTO\Api\Auth;
12			use Skobkin\Bundle\PointToolsBundle\Entity\User;
13			use Skobkin\Bundle\PointToolsBundle\Service\Exceptions\ApiException;
14			use Skobkin\Bundle\PointToolsBundle\Service\Exceptions\InvalidResponseException;
15			use Skobkin\Bundle\PointToolsBundle\Service\Exceptions\UserNotFoundException;
16			use Symfony\Component\HttpFoundation\Response;
17
18			/**
19			* Basic Point.im user API functions from /api/user/*
20			*/
21			class UserApi extends AbstractApi
22			{
23			/**
24			* @var EntityManager
25			*/
26			protected $em;
27
28			/**
29			* @var EntityRepository
30			*/
31			protected $userRepository;
32
33			/**
34			* @var Serializer
35			*/
36			private $serializer;
37
38			public function __construct(ClientInterface $httpClient, LoggerInterface $logger, EntityManager $entityManager, Serializer $serializer)
			0 ignored issues – show Bug introduced 2016-12-12 18:42 UTC by Report Bug Copy Issue Report You have injected the EntityManager via parameter `$entityManager`. This is generally not recommended as it might get closed and become unusable. Instead, it is recommended to inject the ManagerRegistry and retrieve the EntityManager via `getManager()` each time you need it. The `EntityManager` might become unusable for example if a transaction is rolled back and it gets closed. Let’s assume that somewhere in your application, or in a third-party library, there is code such as the following: function someFunction(ManagerRegistry $registry) { $em = $registry->getManager(); $em->getConnection()->beginTransaction(); try { // Do something. $em->getConnection()->commit(); } catch (\Exception $ex) { $em->getConnection()->rollback(); $em->close(); throw $ex; } } If that code throws an exception and the `EntityManager` is closed. Any other code which depends on the same instance of the `EntityManager` during this request will fail. On the other hand, if you instead inject the `ManagerRegistry`, the `getManager()` method guarantees that you will always get a usable manager instance. Loading history...
39			{

skobkin / point-tools

Push — master ( d6bd2d...bc363c )

UserApi::getAvatarUrl() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like