PluginsApiClient::getLatestPluginVersion() - Code Metrics - Inspection of "Version 2.3.0 autorelease" - payeverworldwide/sdk-php - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( afb8f6...f8ce69 )

by payever

created 2019-11-21 07:28 UTC

PluginsApiClient::getLatestPluginVersion() A

↳ Parent: PluginsApiClient

Complexity

Conditions	1
Paths	1

Size

Total Lines	16
Code Lines	10

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
eloc	10
c	0
b	0
f	0
dl	0
loc	16
rs	9.9332
cc	1
nc	1
nop	0

<?php
/**
 * PHP version 5.4 and 7
 *
 * @package   Payever\Plugins
 * @author    Hennadii.Shymanskyi <[email protected]>
 * @copyright 2017-2019 payever GmbH
 * @license   MIT <https://opensource.org/licenses/MIT>
 */

namespace Payever\ExternalIntegration\Plugins;

use Payever\ExternalIntegration\Core\Authorization\OauthTokenList;
use Payever\ExternalIntegration\Core\Base\ClientConfigurationInterface;
use Payever\ExternalIntegration\Core\Base\HttpClientInterface;
use Payever\ExternalIntegration\Core\CommonApiClient;
use Payever\ExternalIntegration\Core\Http\RequestBuilder;
use Payever\ExternalIntegration\Core\Http\RequestEntity;
use Payever\ExternalIntegration\Core\Http\Response;
use Payever\ExternalIntegration\Core\Http\ResponseEntity;
use Payever\ExternalIntegration\Plugins\Base\PluginRegistryInfoProviderInterface;
use Payever\ExternalIntegration\Plugins\Base\PluginsApiClientInterface;
use Payever\ExternalIntegration\Plugins\Http\RequestEntity\PluginRegistryRequestEntity;
use Payever\ExternalIntegration\Plugins\Http\ResponseEntity\CommandsResponseEntity;
use Payever\ExternalIntegration\Plugins\Http\ResponseEntity\PluginRegistryResponseEntity;
use Payever\ExternalIntegration\Plugins\Http\ResponseEntity\PluginVersionResponseEntity;

class PluginsApiClient extends CommonApiClient implements PluginsApiClientInterface
{
    const SUB_URL_REGISTER = 'api/plugin/registry/register';
    const SUB_URL_UNREGISTER = 'api/plugin/registry/unregister';
    const SUB_URL_ACK_COMMAND = 'api/plugin/registry/ack/%s';
    const SUB_URL_GET_COMMANDS = 'api/plugin/command/list';
    const SUB_URL_GET_LATEST_VERSION = 'api/plugin/channel/%s/latest?cmsVersion=%s';

    /** @var PluginRegistryInfoProviderInterface */
    private $registryInfoProvider;

    public function __construct(
        PluginRegistryInfoProviderInterface $registryInfoProvider,
        ClientConfigurationInterface $clientConfiguration,
        OauthTokenList $oauthTokenList = null,
        HttpClientInterface $httpClient = null
    ) {
        parent::__construct($clientConfiguration, $oauthTokenList, $httpClient);

        $this->registryInfoProvider = $registryInfoProvider;
    }

    /**
     * @inheritdoc
     */
    public function getRegistryInfoProvider()
    {
        return $this->registryInfoProvider;
    }

    /**
     * @inheritdoc
     *
     * @throws \Exception
     */
    public function registerPlugin()
    {
        $url = sprintf('%s%s', $this->getLiveBaseUrl(), static::SUB_URL_REGISTER);

        return $this->doPublicJsonPostRequest(
            $url,
            $this->buildRegistryRequestEntity(true),
            new PluginRegistryResponseEntity()
        );
    }

    /**
     * @inheritdoc
     *
     * @throws \Exception
     */
    public function unregisterPlugin()
    {
        $url = sprintf('%s%s', $this->getLiveBaseUrl(), static::SUB_URL_UNREGISTER);

        return $this->doPublicJsonPostRequest(
            $url,
            $this->buildRegistryRequestEntity(),
            new PluginRegistryResponseEntity()
        );
    }

    /**
     * @inheritdoc
     *
     * @throws \Exception
     */
    public function acknowledgePluginCommand($commandId)
    {
        return $this->doPublicJsonPostRequest(
            $this->buildAcknowledgePluginCommandUrl($commandId),
            $this->buildRegistryRequestEntity(),
            new PluginRegistryResponseEntity()
        );
    }

    /**
     * @inheritdoc
     *
     * @throws \Exception
     */
    public function getCommands($fromTimestamp = null)
    {
        $request = RequestBuilder::get($this->buildGetCommandsUrl($fromTimestamp))
            ->setResponseEntity(new CommandsResponseEntity())
            ->build();

        return $this->getHttpClient()->execute($request);
    }

    /**
     * @inheritDoc
     *
     * @throws \Exception
     */
    public function getLatestPluginVersion()
    {
        $infoProvider = $this->getRegistryInfoProvider();

        $path = sprintf(
            static::SUB_URL_GET_LATEST_VERSION,
            $this->configuration->getChannelSet(),
            $infoProvider->getCmsVersion()
        );
        $url = sprintf('%s%s', $this->getLiveBaseUrl(), $path);

        $request = RequestBuilder::get($url)
            ->setResponseEntity(new PluginVersionResponseEntity())
            ->build();

        return $this->getHttpClient()->execute($request);
    }

    /**
     * @param bool $extended whether we should build entity for Register request
     *
     * @return PluginRegistryRequestEntity
     */
    private function buildRegistryRequestEntity($extended = false)
    {
        $requestEntity = new PluginRegistryRequestEntity();
        $requestEntity
            ->setChannel($this->registryInfoProvider->getChannel())
            ->setHost($this->registryInfoProvider->getHost())
        ;

        if ($extended) {
            $requestEntity
                ->setPluginVersion($this->registryInfoProvider->getPluginVersion())
                ->setCmsVersion($this->registryInfoProvider->getCmsVersion())
                ->setSupportedCommands($this->registryInfoProvider->getSupportedCommands())
                ->setCommandEndpoint($this->registryInfoProvider->getCommandEndpoint())
                ->setBusinessIds($this->registryInfoProvider->getBusinessIds())
            ;
        }

        return $requestEntity;
    }

    /**
     * @param string $url
     * @param RequestEntity $requestEntity
     * @param ResponseEntity $responseEntity
     * @return Response
     *
     * @throws \Exception
     */
    private function doPublicJsonPostRequest($url, RequestEntity $requestEntity, ResponseEntity $responseEntity)
    {
        $request = RequestBuilder::post($url)
            ->contentTypeIsJson()
            ->setRequestEntity($requestEntity)
            ->setResponseEntity($responseEntity)
            ->build();

        return $this->getHttpClient()->execute($request);
    }

    /**
     * @param string $commandId
     * @return string
     */
    private function buildAcknowledgePluginCommandUrl($commandId)
    {
        return sprintf('%s%s', $this->getLiveBaseUrl(), sprintf(static::SUB_URL_ACK_COMMAND, $commandId));
    }

    /**
     * @param int|null $fromTimestamp
     * @return string
     */
    private function buildGetCommandsUrl($fromTimestamp = null)
    {
        $url = sprintf('%s%s', $this->getLiveBaseUrl(), static::SUB_URL_GET_COMMANDS);
        $url .= sprintf('?channelType=%s', $this->getConfiguration()->getChannelSet());

        if ((int) $fromTimestamp > 0) {
            $url .= sprintf('&from=%s', $fromTimestamp);
        }

        return $url;
    }

    /**
     * @return string
     */
    private function getLiveBaseUrl()
    {
        $url = $this->configuration->getCustomLiveUrl() ?: static::URL_LIVE;

        if (substr($url, -1) != '/') {
            $url .= '/';
        }

        return $url;
    }
}


1			<?php
2			/**
3			* PHP version 5.4 and 7
4			*
5			* @package Payever\Plugins
6			* @author Hennadii.Shymanskyi <[email protected]>
7			* @copyright 2017-2019 payever GmbH
8			* @license MIT <https://opensource.org/licenses/MIT>
9			*/
10
11			namespace Payever\ExternalIntegration\Plugins;
12
13			use Payever\ExternalIntegration\Core\Authorization\OauthTokenList;
14			use Payever\ExternalIntegration\Core\Base\ClientConfigurationInterface;
15			use Payever\ExternalIntegration\Core\Base\HttpClientInterface;
16			use Payever\ExternalIntegration\Core\CommonApiClient;
17			use Payever\ExternalIntegration\Core\Http\RequestBuilder;
18			use Payever\ExternalIntegration\Core\Http\RequestEntity;
19			use Payever\ExternalIntegration\Core\Http\Response;
20			use Payever\ExternalIntegration\Core\Http\ResponseEntity;
21			use Payever\ExternalIntegration\Plugins\Base\PluginRegistryInfoProviderInterface;
22			use Payever\ExternalIntegration\Plugins\Base\PluginsApiClientInterface;
23			use Payever\ExternalIntegration\Plugins\Http\RequestEntity\PluginRegistryRequestEntity;
24			use Payever\ExternalIntegration\Plugins\Http\ResponseEntity\CommandsResponseEntity;
25			use Payever\ExternalIntegration\Plugins\Http\ResponseEntity\PluginRegistryResponseEntity;
26			use Payever\ExternalIntegration\Plugins\Http\ResponseEntity\PluginVersionResponseEntity;
27
28			class PluginsApiClient extends CommonApiClient implements PluginsApiClientInterface
29			{
30			const SUB_URL_REGISTER = 'api/plugin/registry/register';
31			const SUB_URL_UNREGISTER = 'api/plugin/registry/unregister';
32			const SUB_URL_ACK_COMMAND = 'api/plugin/registry/ack/%s';
33			const SUB_URL_GET_COMMANDS = 'api/plugin/command/list';
34			const SUB_URL_GET_LATEST_VERSION = 'api/plugin/channel/%s/latest?cmsVersion=%s';
35
36			/** @var PluginRegistryInfoProviderInterface */
37			private $registryInfoProvider;
38
39			public function __construct(
40			PluginRegistryInfoProviderInterface $registryInfoProvider,
41			ClientConfigurationInterface $clientConfiguration,
42			OauthTokenList $oauthTokenList = null,
43			HttpClientInterface $httpClient = null
44			) {
45			parent::__construct($clientConfiguration, $oauthTokenList, $httpClient);
46
47			$this->registryInfoProvider = $registryInfoProvider;
48			}
49
50			/**
51			* @inheritdoc
52			*/
53			public function getRegistryInfoProvider()
54			{
55			return $this->registryInfoProvider;
56			}
57
58			/**
59			* @inheritdoc
60			*
61			* @throws \Exception
62			*/
63			public function registerPlugin()
64			{
65			$url = sprintf('%s%s', $this->getLiveBaseUrl(), static::SUB_URL_REGISTER);
66
67			return $this->doPublicJsonPostRequest(
68			$url,
69			$this->buildRegistryRequestEntity(true),
70			new PluginRegistryResponseEntity()
71			);
72			}
73
74			/**
75			* @inheritdoc
76			*
77			* @throws \Exception
78			*/
79			public function unregisterPlugin()
80			{
81			$url = sprintf('%s%s', $this->getLiveBaseUrl(), static::SUB_URL_UNREGISTER);
82
83			return $this->doPublicJsonPostRequest(
84			$url,
85			$this->buildRegistryRequestEntity(),
86			new PluginRegistryResponseEntity()
87			);
88			}
89
90			/**
91			* @inheritdoc
92			*
93			* @throws \Exception
94			*/
95			public function acknowledgePluginCommand($commandId)
96			{
97			return $this->doPublicJsonPostRequest(
98			$this->buildAcknowledgePluginCommandUrl($commandId),
99			$this->buildRegistryRequestEntity(),
100			new PluginRegistryResponseEntity()
101			);
102			}
103
104			/**
105			* @inheritdoc
106			*
107			* @throws \Exception
108			*/
109			public function getCommands($fromTimestamp = null)
110			{
111			$request = RequestBuilder::get($this->buildGetCommandsUrl($fromTimestamp))
112			->setResponseEntity(new CommandsResponseEntity())
113			->build();
114
115			return $this->getHttpClient()->execute($request);
116			}
117
118			/**
119			* @inheritDoc
120			*
121			* @throws \Exception
122			*/
123			public function getLatestPluginVersion()
124			{
125			$infoProvider = $this->getRegistryInfoProvider();
126
127			$path = sprintf(
128			static::SUB_URL_GET_LATEST_VERSION,
129			$this->configuration->getChannelSet(),
130			$infoProvider->getCmsVersion()
131			);
132			$url = sprintf('%s%s', $this->getLiveBaseUrl(), $path);
133
134			$request = RequestBuilder::get($url)
135			->setResponseEntity(new PluginVersionResponseEntity())
136			->build();
137
138			return $this->getHttpClient()->execute($request);
139			}
140
141			/**
142			* @param bool $extended whether we should build entity for Register request
143			*
144			* @return PluginRegistryRequestEntity
145			*/
146			private function buildRegistryRequestEntity($extended = false)
147			{
148			$requestEntity = new PluginRegistryRequestEntity();
149			$requestEntity
150			->setChannel($this->registryInfoProvider->getChannel())
151			->setHost($this->registryInfoProvider->getHost())
152			;
153
154			if ($extended) {
155			$requestEntity
156			->setPluginVersion($this->registryInfoProvider->getPluginVersion())
157			->setCmsVersion($this->registryInfoProvider->getCmsVersion())
158			->setSupportedCommands($this->registryInfoProvider->getSupportedCommands())
159			->setCommandEndpoint($this->registryInfoProvider->getCommandEndpoint())
160			->setBusinessIds($this->registryInfoProvider->getBusinessIds())
161			;
162			}
163
164			return $requestEntity;
165			}
166
167			/**
168			* @param string $url
169			* @param RequestEntity $requestEntity
170			* @param ResponseEntity $responseEntity
171			* @return Response
172			*
173			* @throws \Exception
174			*/
175			private function doPublicJsonPostRequest($url, RequestEntity $requestEntity, ResponseEntity $responseEntity)
176			{
177			$request = RequestBuilder::post($url)
178			->contentTypeIsJson()
179			->setRequestEntity($requestEntity)
180			->setResponseEntity($responseEntity)
181			->build();
182
183			return $this->getHttpClient()->execute($request);
184			}
185
186			/**
187			* @param string $commandId
188			* @return string
189			*/
190			private function buildAcknowledgePluginCommandUrl($commandId)
191			{
192			return sprintf('%s%s', $this->getLiveBaseUrl(), sprintf(static::SUB_URL_ACK_COMMAND, $commandId));
193			}
194
195			/**
196			* @param int\|null $fromTimestamp
197			* @return string
198			*/
199			private function buildGetCommandsUrl($fromTimestamp = null)
200			{
201			$url = sprintf('%s%s', $this->getLiveBaseUrl(), static::SUB_URL_GET_COMMANDS);
202			$url .= sprintf('?channelType=%s', $this->getConfiguration()->getChannelSet());
203
204			if ((int) $fromTimestamp > 0) {
205			$url .= sprintf('&from=%s', $fromTimestamp);
206			}
207
208			return $url;
209			}
210
211			/**
212			* @return string
213			*/
214			private function getLiveBaseUrl()
215			{
216			$url = $this->configuration->getCustomLiveUrl() ?: static::URL_LIVE;
217
218			if (substr($url, -1) != '/') {
219			$url .= '/';
220			}
221
222			return $url;
223			}
224			}
225

payeverworldwide / sdk-php

Push — master ( afb8f6...f8ce69 )

PluginsApiClient::getLatestPluginVersion() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like