UserApi - Code Metrics - Inspection of "MisdGuzzleBundle removed from project in favor of..." - skobkin/point-tools - Measure and Improve Code Quality continuously with Scrutinizer

Test Failed

Push — master ( 997f41...cf0056 )

by Alexey

created 2017-01-08 23:26 UTC

UserApi B

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	343
Duplicated Lines	27.11 %

Coupling/Cohesion

Components	3
Dependencies	9

Test Coverage

Coverage

9.17%

Importance

Changes

Metric	Value
wmc	45
lcom	3
cbo	9
dl	93
loc	343
ccs	10
cts	109
cp	0.0917
rs	8.3673
c	0
b	0
f	0

14 Methods

Rating	Name	Duplication	Size	Complexity
A	isAuthDataValid()	0	12	3
A	authenticate()	0	20	3
A	logout()	0	16	4
A	__construct()	0	8	1
A	getUserSubscribersByLogin()	14	14	3
A	getUserSubscribersById()	14	14	3
A	getUserSubscriptionsByLogin()	14	14	3
A	getUserSubscriptionsById()	14	14	3
A	getUserByLogin()	14	14	3
A	getUserById()	14	14	3
B	getUserFromUserInfo()	5	22	6
C	getUsersFromList()	4	28	7
A	getAvatarUrl()	0	4	1
A	getAvatarUrlByLogin()	0	8	2

How to fix Duplicated Code Complexity

Duplicated Code

Duplicate code is one of the most pungent code smells. A rule that is often used is to re-structure code once it is duplicated in three or more places.

Common duplication problems, and corresponding solutions are:

If you have the same expression in different places: Extract expression to a method
If you have the same method in different sub-classes: Extract method, and pull up field to the parent class
If you have the same code in unrelated classes: Consider extracting the code to a new class, and injecting that class

Complex Class

Tip: Before tackling complexity, make sure that you eliminate any duplication first. This often can reduce the size of classes significantly.

Complex classes like UserApi often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes. You can also have a look at the cohesion graph to spot any un-connected, or weakly-connected components.

Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.

While breaking up the class, it is a good idea to analyze how other classes use UserApi, and based on these observations, apply Extract Interface, too.

<?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 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
{
    const AVATAR_SIZE_SMALL = '24';
    const AVATAR_SIZE_MEDIUM = '40';
    const AVATAR_SIZE_LARGE = '80';

    /**
     * @var string Base URL for user avatars
     */
    protected $avatarsBaseUrl = '//point.im/avatar/';

    /**
     * @var EntityManager
     */
    protected $em;

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

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


    public function __construct(ClientInterface $httpClient, 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);

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

    public function isAuthDataValid(string $login, string $password): bool
    {
        $auth = $this->authenticate($login, $password);

        if (null === $auth->getError() && null !== $auth->getToken()) {
            $this->logout($auth);

            return true;
        }

        return false;
    }

    public function authenticate(string $login, string $password): Auth
    {
        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
    {
        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

    {
        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

    {
        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

    {
        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

    {
        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

    {
        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

    {
        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
    {
        // @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
     *
     * @param array $users
     *
     * @return User[]
     *
     * @throws ApiException
     * @throws InvalidResponseException
     */
    private function getUsersFromList(array $users = []): array
    {
        /** @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;
    }

    /**
     * Creates URL of avatar with specified size by User object
     *
     * @param User $user
     * @param string $size
     *
     * @return string
     */
    public function getAvatarUrl(User $user, string $size): string
    {
        return $this->getAvatarUrlByLogin($user->getLogin(), $size);
    }

    /**
     * Creates URL of avatar with specified size by login string
     *
     * @param string $login
     * @param string $size
     *
     * @return string
     */
    public function getAvatarUrlByLogin(string $login, string $size): string
    {
        if (!in_array($size, [self::AVATAR_SIZE_SMALL, self::AVATAR_SIZE_MEDIUM, self::AVATAR_SIZE_LARGE], true)) {
            throw new \InvalidArgumentException('Avatar size must be one of restricted variants. See UserApi class AVATAR_SIZE_* constants.');
        }

        return $this->avatarsBaseUrl.urlencode($login).'/'.$size;
    }
}


skobkin / point-tools