DataSyncClient - Code Metrics - Inspection of "DataSync HTTP API" - nixsolutions/yandex-php-library - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#143)

by Alexander

created 2016-03-10 15:42 UTC

DataSyncClient F

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	559
Duplicated Lines	6.44 %

Coupling/Cohesion

Components	1
Dependencies	21

Test Coverage

Coverage

100%

Importance

Changes	2
Bugs	0	Features	0

Metric	Value
wmc	64
c	2
b	0
f	0
lcom	1
cbo	21
dl	36
loc	559
ccs	209
cts	209
cp	1
rs	1.9075

18 Methods

Rating	Name	Duplication	Size	Complexity
A	getDatabaseId()	0	4	1
A	setDatabaseId()	0	4	1
A	getContext()	0	4	1
A	setContext()	0	8	3
A	__construct()	0	12	3
B	getDatabasesUrl()	0	27	6
B	getDatabaseUrl()	0	25	6
C	getDatabaseSnapshotUrl()	0	29	7
D	getDatabaseDeltasUrl()	0	37	9
C	sendRequest()	0	44	14
A	getDatabases()	0	14	3
A	createDatabase()	8	8	1
A	getDatabase()	8	8	1
A	deleteDatabase()	0	5	1
A	updateDatabaseTitle()	0	14	1
A	getDatabaseSnapshot()	10	10	1
B	saveDelta()	0	23	4
A	getDelta()	10	10	1

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 DataSyncClient 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 DataSyncClient, and based on these observations, apply Extract Interface, too.

<?php
/**
 * Yandex PHP Library
 *
 * @copyright NIX Solutions Ltd.
 * @link      https://github.com/nixsolutions/yandex-php-library
 */

/**
 * @namespace
 */
namespace Yandex\DataSync;

use Psr\Http\Message\UriInterface;
use Yandex\Common\AbstractServiceClient;
use GuzzleHttp\Psr7\Response;
use GuzzleHttp\Exception\ClientException;
use Yandex\Common\Exception\ForbiddenException;
use Yandex\Common\Exception\IncorrectDataFormatException;
use Yandex\DataSync\Exception\IncorrectRevisionNumberException;
use Yandex\Common\Exception\InvalidArgumentException;
use Yandex\DataSync\Exception\MaxDatabasesCountException;
use Yandex\Common\Exception\NotFoundException;
use Yandex\DataSync\Exception\RevisionOnServerOverCurrentException;
use Yandex\DataSync\Exception\RevisionTooOldException;
use Yandex\Common\Exception\TooManyRequestsException;
use Yandex\Common\Exception\UnauthorizedException;
use Yandex\Common\Exception\UnavailableResourceException;
use Yandex\DataSync\Exception\DataSyncException;
use Yandex\DataSync\Models\Database;
use Yandex\DataSync\Responses\DatabaseDeltasResponse;
use Yandex\DataSync\Responses\DatabaseSnapshotResponse;
use Yandex\DataSync\Responses\DatabasesResponse;

/**
 * Class DataSyncClient
 *
 * @category Yandex
 * @package  DataSync
 *
 * @author   Alexander Khaylo <[email protected]>
 * @created  01.03.15 12:07
 */
class DataSyncClient extends AbstractServiceClient
{
    /**
     * Requested version of API
     *
     * @var string
     */
    private $version = 'v1';

    /**
     * API domain
     *
     * @var string
     */
    protected $serviceDomain = 'cloud-api.yandex.net';

    /**
     * DB app context.
     */
    const CONTEXT_APP = 'app';

    /**
     * DB user context.
     */
    const CONTEXT_USER = 'user';

    /**
     * @var string
     */
    private $context;

    /**
     * @var string
     */
    private $databaseId;

    /**
     * @return string
     */
    public function getDatabaseId()
    {
        return $this->databaseId;
    }

    /**
     * @param string $databaseId
     */
    public function setDatabaseId($databaseId)
    {
        $this->databaseId = $databaseId;
    }

    /**
     * @return string
     */
    public function getContext()
    {
        return $this->context;
    }

    /**
     * @param string $context
     *
     * @throws InvalidArgumentException
     */
    public function setContext($context)
    {
        if ($context === self::CONTEXT_APP || $context === self::CONTEXT_USER) {
            $this->context = $context;
        } else {
            throw new InvalidArgumentException('Incorrect context');
        }
    }

    /**
     * @param string $token access token
     * @param null   $context
     * @param null   $databaseId
     */
    public function __construct($token = '', $context = null, $databaseId = null)
    {
        $this->setAccessToken($token);

        if ($context) {
            $this->setContext($context);
        }

        if ($databaseId) {
            $this->setDatabaseId($databaseId);
        }
    }

    /**
     * @param null|string $context
     * @param array       $fields
     * @param null        $limit
     * @param null        $offset
     *
     * @return string
     * @throws InvalidArgumentException
     */
    public function getDatabasesUrl($context = null, $fields = [], $limit = null, $offset = null)
    {
        if ($context) {
''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
            $this->setContext($context);
        }

        if (!$this->context) {
            throw new InvalidArgumentException('Empty context');
        }

        $params = '?';
        if ($limit) {
            $params .= 'limit=' . $limit . '&';
        }

        if ($offset) {
            $params .= 'offset=' . $offset . '&';
        }

        if ($fields) {

            $params .= 'fields=' . implode(',', $fields) . '&';
        }
        $params = rtrim($params, "&");

        return $this->serviceScheme . '://' . $this->serviceDomain . '/' . $this->version . '/data/'
        . $this->context . '/databases/' . $params;
    }

    /**
     * @param null|string $databaseId
     * @param null|string $context
     * @param array       $fields
     *
     * @return string
     * @throws InvalidArgumentException
     */
    public function getDatabaseUrl($databaseId = null, $context = null, $fields = [])
    {
        if ($context) {
''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
            $this->setContext($context);
        }
        if ($databaseId) {
''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
            $this->setDatabaseId($databaseId);
        }

        if (!$this->context) {
            throw new InvalidArgumentException('Empty context');
        }

        if (!$this->databaseId) {
            throw new InvalidArgumentException('Empty database id');
        }

        $params = '';
        if ($fields) {

            $params = '?fields=' . implode(',', $fields);
        }

        return $this->serviceScheme . '://' . $this->serviceDomain . '/' . $this->version . '/data/'
        . $this->context . '/databases/' . $this->databaseId . '/' . $params;
    }

    /**
     * @param null|string $databaseId
     * @param null|string $context
     * @param null        $collectionId
     * @param array       $fields
     *
     * @return string
     * @throws InvalidArgumentException
     */
    public function getDatabaseSnapshotUrl($databaseId = null, $context = null, $collectionId = null, $fields = [])
    {
        if ($context) {
''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
            $this->setContext($context);
        }
        if ($databaseId) {
''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
            $this->setDatabaseId($databaseId);
        }
        if (!$this->context) {
            throw new InvalidArgumentException('Empty context');
        }

        if (!$this->databaseId) {
            throw new InvalidArgumentException('Empty database id');
        }

        $params = '?';
        if ($collectionId) {
            $params .= 'collection_id=' . $collectionId . '&';
        }

        if ($fields) {

            $params .= 'fields=' . implode(',', $fields) . '&';
        }
        $params = rtrim($params, "&");

        return $this->serviceScheme . '://' . $this->serviceDomain . '/' . $this->version . '/data/'
        . $this->context . '/databases/' . $this->databaseId . '/snapshot/' . $params;
    }

    /**
     * @param null|string $databaseId
     * @param null|string $context
     * @param array       $fields
     * @param int         $baseRevision
     * @param int         $limit
     *
     * @return string
     * @throws InvalidArgumentException
     */
    public function getDatabaseDeltasUrl(
        $databaseId = null,
        $context = null,
        $fields = [],
        $baseRevision = null,
        $limit = null
    ) {
        if ($context) {
''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
            $this->setContext($context);
        }
        if ($databaseId) {
''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
            $this->setDatabaseId($databaseId);
        }
        if (!$this->context) {
            throw new InvalidArgumentException('Empty context');
        }
        if (!$this->databaseId) {
            throw new InvalidArgumentException('Empty database id');
        }
        $params = '';
        if ($baseRevision !== null) {
            $params .= 'base_revision=' . $baseRevision . '&';
        }
        if ($limit > 0) {
            $params .= 'limit=' . $limit . '&';
        }
        if ($fields) {

            $params .= 'fields=' . implode(',', $fields) . '&';
        }
        if ($params) {
            $params = '/?' . $params;
            $params = rtrim($params, "&");
        }

        return $this->serviceScheme . '://' . $this->serviceDomain . '/' . $this->version . '/data/'
        . $this->context . '/databases/' . $this->databaseId . '/deltas' . $params;
    }

    /**
     * Sends a request
     *
     * @param string              $method  HTTP method
     * @param UriInterface|string $uri     URI object or string.
     * @param array               $options Request options to apply.
     *
     * @return Response|\Psr\Http\Message\ResponseInterface
     * @throws DataSyncException
     * @throws ForbiddenException
     * @throws IncorrectDataFormatException
     * @throws IncorrectRevisionNumberException
     * @throws InvalidArgumentException
     * @throws MaxDatabasesCountException
     * @throws NotFoundException
     * @throws RevisionOnServerOverCurrentException
     * @throws RevisionTooOldException
     * @throws TooManyRequestsException
     * @throws UnauthorizedException
     * @throws UnavailableResourceException
     */
    protected function sendRequest($method, $uri, array $options = [])
    {
        try {
            $response = $this->getClient()->request($method, $uri, $options);
        } catch (ClientException $ex) {
            $result  = $ex->getResponse();
            $code    = $result->getStatusCode();
            $message = $result->getReasonPhrase();

            switch ($code) {
                case 400:
                    throw new InvalidArgumentException($message);
                case 401:
                    throw new UnauthorizedException($message);
                case 403:
                    throw new ForbiddenException($message);
                case 404:
                    throw new NotFoundException($message);
                case 406:
                    throw new IncorrectDataFormatException($message);
                case 409:
                    throw new RevisionOnServerOverCurrentException($message);
                case 410:
                    throw new RevisionTooOldException($message);
                case 412:
                    throw new IncorrectRevisionNumberException($message);
                case 415:
                    throw new IncorrectDataFormatException($message);
                case 423:
                    throw new UnavailableResourceException($message);
                case 429:
                    throw new TooManyRequestsException($message);
                case 507:
                    throw new MaxDatabasesCountException($message);
            }

            throw new DataSyncException(
                'Service responded with error code: "' . $code . '" and message: "' . $message . '"',
                $code
            );
        }

        return $response;
    }

    /**
     * @param null|string $context
     * @param array       $fields
     * @param null        $limit
     * @param null        $offset
     *
     * @return DatabasesResponse
     * @throws DataSyncException
     * @throws ForbiddenException
     * @throws IncorrectDataFormatException
     * @throws InvalidArgumentException
     * @throws MaxDatabasesCountException
     * @throws NotFoundException
     * @throws TooManyRequestsException
     * @throws UnauthorizedException
     * @throws UnavailableResourceException
     */
    public function getDatabases($context = null, $fields = [], $limit = null, $offset = null)
    {
        $response            = $this->sendRequest('GET', $this->getDatabasesUrl($context, $fields, $limit, $offset));
        $decodedResponseBody = $this->getDecodedBody($response->getBody());
        $databasesResponse   = new DatabasesResponse($decodedResponseBody);
        if ($databasesResponse->getItems()) {
            $databases = $databasesResponse->getItems()->getAll();
            foreach ($databases as $database) {
                $database->setContext($this->getContext());
            }
        }

        return $databasesResponse;
    }

    /**
     * @param null|string $databaseId
     * @param null|string $context
     * @param array       $fields
     *
     * @return Database
     * @throws DataSyncException
     * @throws ForbiddenException
     * @throws IncorrectDataFormatException
     * @throws InvalidArgumentException
     * @throws MaxDatabasesCountException
     * @throws NotFoundException
     * @throws TooManyRequestsException
     * @throws UnauthorizedException
     * @throws UnavailableResourceException
     */
    public function createDatabase($databaseId = null, $context = null, $fields = [])

    {
        $response            = $this->sendRequest('PUT', $this->getDatabaseUrl($databaseId, $context, $fields));
        $decodedResponseBody = $this->getDecodedBody($response->getBody());
        $database            = new Database($decodedResponseBody);
        $database->setContext($this->getContext());
        return $database;
    }

    /**
     * @param null|string $databaseId
     * @param null|string $context
     * @param array       $fields
     *
     * @return Database
     * @throws DataSyncException
     * @throws ForbiddenException
     * @throws IncorrectDataFormatException
     * @throws InvalidArgumentException
     * @throws MaxDatabasesCountException
     * @throws NotFoundException
     * @throws TooManyRequestsException
     * @throws UnauthorizedException
     * @throws UnavailableResourceException
     */
    public function getDatabase($databaseId = null, $context = null, $fields = [])

    {
        $response            = $this->sendRequest('GET', $this->getDatabaseUrl($databaseId, $context, $fields));
        $decodedResponseBody = $this->getDecodedBody($response->getBody());
        $database            = new Database($decodedResponseBody);
        $database->setContext($this->getContext());
        return $database;
    }

    /**
     * @param null|string $databaseId
     * @param null|string $context
     *
     * @return bool
     *
     * @throws DataSyncException
     * @throws ForbiddenException
     * @throws IncorrectDataFormatException
     * @throws InvalidArgumentException
     * @throws MaxDatabasesCountException
     * @throws NotFoundException
     * @throws TooManyRequestsException
     * @throws UnauthorizedException
     * @throws UnavailableResourceException
     */
    public function deleteDatabase($databaseId = null, $context = null)
    {
        $response = $this->sendRequest('DELETE', $this->getDatabaseUrl($databaseId, $context));
        return $response->getStatusCode() === 204;
    }

    /**
     * @param string $title
     * @param null   $databaseId
     * @param null   $context
     * @param array  $fields
     *
     * @return Database
     * @throws DataSyncException
     * @throws ForbiddenException
     * @throws IncorrectDataFormatException
     * @throws InvalidArgumentException
     * @throws MaxDatabasesCountException
     * @throws NotFoundException
     * @throws TooManyRequestsException
     * @throws UnauthorizedException
     * @throws UnavailableResourceException
     */
    public function updateDatabaseTitle($title, $databaseId = null, $context = null, $fields = [])
    {
        $response            = $this->sendRequest(
            'PATCH',
            $this->getDatabaseUrl($databaseId, $context, $fields),
            [
                'json' => ['title' => $title]
            ]
        );
        $decodedResponseBody = $this->getDecodedBody($response->getBody());
        $database            = new Database($decodedResponseBody);
        $database->setContext($this->getContext());
        return $database;
    }

    /**
     * @param null|string $databaseId
     * @param null|string $context
     * @param null        $collectionId
     * @param array       $fields
     *
     * @return DatabaseSnapshotResponse
     * @throws DataSyncException
     * @throws ForbiddenException
     * @throws IncorrectDataFormatException
     * @throws InvalidArgumentException
     * @throws MaxDatabasesCountException
     * @throws NotFoundException
     * @throws TooManyRequestsException
     * @throws UnauthorizedException
     * @throws UnavailableResourceException
     */
    public function getDatabaseSnapshot($databaseId = null, $context = null, $collectionId = null, $fields = [])

    {
        $response            = $this->sendRequest(
            'GET',
            $this->getDatabaseSnapshotUrl($databaseId, $context, $collectionId, $fields)
        );
        $decodedResponseBody = $this->getDecodedBody($response->getBody());
        $result              = new DatabaseSnapshotResponse($decodedResponseBody);
        return $result;
    }

    /**
     * @param array       $data
     * @param int         $revision
     * @param null|string $databaseId
     * @param null|string $context
     * @param array       $fields
     *
     * @return array
     * @throws DataSyncException
     * @throws ForbiddenException
     * @throws IncorrectDataFormatException
     * @throws IncorrectRevisionNumberException
     * @throws InvalidArgumentException
     * @throws MaxDatabasesCountException
     * @throws NotFoundException
     * @throws RevisionOnServerOverCurrentException
     * @throws RevisionTooOldException
     * @throws TooManyRequestsException
     * @throws UnauthorizedException
     * @throws UnavailableResourceException
     *
     * @see https://tech.yandex.ru/datasync/http/doc/tasks/add-changes-docpage/
     */
    public function saveDelta($data, $revision = 0, $databaseId = null, $context = null, $fields = [])
    {
        $options             = [
            'headers' => [
                'If-Match' => $revision,
            ],
            'json'    => $data
        ];
        $response            = $this->sendRequest(
            'POST',
            $this->getDatabaseDeltasUrl($databaseId, $context, $fields),
            $options
        );
        $decodedResponseBody = $this->getDecodedBody($response->getBody());
        if ($response->getHeader('ETag')
            && is_array($response->getHeader('ETag'))
            && count($response->getHeader('ETag')) > 0
        ) {
            $decodedResponseBody['revision'] = $response->getHeader('ETag')[0];
        }

        return $decodedResponseBody;
    }

    /**
     * @param int         $baseRevision
     * @param null|string $databaseId
     * @param null|string $context
     * @param array       $fields
     * @param null|int    $limit
     *
     * @return DatabaseDeltasResponse
     * @throws DataSyncException
     * @throws ForbiddenException
     * @throws IncorrectDataFormatException
     * @throws IncorrectRevisionNumberException
     * @throws InvalidArgumentException
     * @throws MaxDatabasesCountException
     * @throws NotFoundException
     * @throws RevisionOnServerOverCurrentException
     * @throws RevisionTooOldException
     * @throws TooManyRequestsException
     * @throws UnauthorizedException
     * @throws UnavailableResourceException
     */
    public function getDelta($baseRevision = 0, $databaseId = null, $context = null, $fields = [], $limit = null)

    {
        $response            = $this->sendRequest(
            'GET',
            $this->getDatabaseDeltasUrl($databaseId, $context, $fields, $baseRevision, $limit)
        );
        $decodedResponseBody = $this->getDecodedBody($response->getBody());
        $result              = new DatabaseDeltasResponse($decodedResponseBody);
        return $result;
    }
}


nixsolutions / yandex-php-library