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

Passed

Push — master ( cbaed7...1988ba )

by payever

created 2019-09-26 15:28 UTC

PluginsApiClient::getLiveBaseUrl() A

↳ Parent: PluginsApiClient

Complexity

Conditions	3
Paths	2

Size

Total Lines	9
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
eloc	4
c	0
b	0
f	0
dl	0
loc	9
rs	10
cc	3
nc	2
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;

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';

    /** @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
     *
     * @pga-return Response<CommandsResponseEntity>
     *
     * @throws \Exception
     */
    public function getCommands($fromTimestamp = null)
    {
        $request = RequestBuilder::get($this->buildGetCommandsUrl($fromTimestamp))
            ->setResponseEntity(new CommandsResponseEntity())
            ->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);

        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
27			class PluginsApiClient extends CommonApiClient implements PluginsApiClientInterface
28			{
29			const SUB_URL_REGISTER = 'api/plugin/registry/register';
30			const SUB_URL_UNREGISTER = 'api/plugin/registry/unregister';
31			const SUB_URL_ACK_COMMAND = 'api/plugin/registry/ack/%s';
32			const SUB_URL_GET_COMMANDS = 'api/plugin/command/list';
33
34			/** @var PluginRegistryInfoProviderInterface */
35			private $registryInfoProvider;
36
37			public function __construct(
38			PluginRegistryInfoProviderInterface $registryInfoProvider,
39			ClientConfigurationInterface $clientConfiguration,
40			OauthTokenList $oauthTokenList = null,
41			HttpClientInterface $httpClient = null
42			) {
43			parent::__construct($clientConfiguration, $oauthTokenList, $httpClient);
44
45			$this->registryInfoProvider = $registryInfoProvider;
46			}
47
48			/**
49			* @inheritdoc
50			*/
51			public function getRegistryInfoProvider()
52			{
53			return $this->registryInfoProvider;
54			}
55
56			/**
57			* @inheritdoc
58			*
59			* @throws \Exception
60			*/
61			public function registerPlugin()
62			{
63			$url = sprintf('%s%s', $this->getLiveBaseUrl(), static::SUB_URL_REGISTER);
64
65			return $this->doPublicJsonPostRequest(
66			$url,
67			$this->buildRegistryRequestEntity(true),
68			new PluginRegistryResponseEntity()
69			);
70			}
71
72			/**
73			* @inheritdoc
74			*
75			* @throws \Exception
76			*/
77			public function unregisterPlugin()
78			{
79			$url = sprintf('%s%s', $this->getLiveBaseUrl(), static::SUB_URL_UNREGISTER);
80
81			return $this->doPublicJsonPostRequest(
82			$url,
83			$this->buildRegistryRequestEntity(),
84			new PluginRegistryResponseEntity()
85			);
86			}
87
88			/**
89			* @inheritdoc
90			*
91			* @throws \Exception
92			*/
93			public function acknowledgePluginCommand($commandId)
94			{
95			return $this->doPublicJsonPostRequest(
96			$this->buildAcknowledgePluginCommandUrl($commandId),
97			$this->buildRegistryRequestEntity(),
98			new PluginRegistryResponseEntity()
99			);
100			}
101
102			/**
103			* @inheritdoc
104			*
105			* @pga-return Response<CommandsResponseEntity>
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			* @param bool $extended whether we should build entity for Register request
120			*
121			* @return PluginRegistryRequestEntity
122			*/
123			private function buildRegistryRequestEntity($extended = false)
124			{
125			$requestEntity = new PluginRegistryRequestEntity();
126			$requestEntity
127			->setChannel($this->registryInfoProvider->getChannel())
128			->setHost($this->registryInfoProvider->getHost())
129			;
130
131			if ($extended) {
132			$requestEntity
133			->setPluginVersion($this->registryInfoProvider->getPluginVersion())
134			->setCmsVersion($this->registryInfoProvider->getCmsVersion())
135			->setSupportedCommands($this->registryInfoProvider->getSupportedCommands())
136			->setCommandEndpoint($this->registryInfoProvider->getCommandEndpoint())
137			->setBusinessIds($this->registryInfoProvider->getBusinessIds())
138			;
139			}
140
141			return $requestEntity;
142			}
143
144			/**
145			* @param string $url
146			* @param RequestEntity $requestEntity
147			* @param ResponseEntity $responseEntity
148			* @return Response
149			*
150			* @throws \Exception
151			*/
152			private function doPublicJsonPostRequest($url, RequestEntity $requestEntity, ResponseEntity $responseEntity)
153			{
154			$request = RequestBuilder::post($url)
155			->contentTypeIsJson()
156			->setRequestEntity($requestEntity)
157			->setResponseEntity($responseEntity)
158			->build();
159
160			return $this->getHttpClient()->execute($request);
161			}
162
163			/**
164			* @param string $commandId
165			* @return string
166			*/
167			private function buildAcknowledgePluginCommandUrl($commandId)
168			{
169			return sprintf('%s%s', $this->getLiveBaseUrl(), sprintf(static::SUB_URL_ACK_COMMAND, $commandId));
170			}
171
172			/**
173			* @param int\|null $fromTimestamp
174			* @return string
175			*/
176			private function buildGetCommandsUrl($fromTimestamp = null)
177			{
178			$url = sprintf('%s%s', $this->getLiveBaseUrl(), static::SUB_URL_GET_COMMANDS);
179
180			if ((int) $fromTimestamp > 0) {
181			$url .= sprintf('?from=%s', $fromTimestamp);
182			}
183
184			return $url;
185			}
186
187			/**
188			* @return string
189			*/
190			private function getLiveBaseUrl()
191			{
192			$url = $this->configuration->getCustomLiveUrl() ?: static::URL_LIVE;
193
194			if (substr($url, -1) != '/') {
195			$url .= '/';
196			}
197
198			return $url;
199			}
200			}
201

payeverworldwide / sdk-php

Push — master ( cbaed7...1988ba )

PluginsApiClient::getLiveBaseUrl() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like