Flagship::requestCampaignActivation() - Code Metrics - Inspection of "Add the possibility to inject baseUrl instead of h..." - wcomnisky/flagship-php-sdk - Measure and Improve Code Quality continuously with Scrutinizer

Failed Conditions

Pull Request — develop (#6)

unknown

created 2020-03-13 13:17 UTC

Flagship::requestCampaignActivation() A

↳ Parent: Flagship

Complexity

Conditions	1
Paths	1

Size

Total Lines	22
Code Lines	10

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes

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

<?php

declare(strict_types=1);

namespace Wcomnisky\Flagship;

use Symfony\Contracts\HttpClient\Exception\TransportExceptionInterface;
use Symfony\Contracts\HttpClient\HttpClientInterface;
use Symfony\Contracts\HttpClient\ResponseInterface;
use Wcomnisky\Flagship\Api\RequestParameters;
use Wcomnisky\Flagship\Context\ContextInterface;

/**
 * Class Flagship
 * @package Wcomnisky\Flagship
 * @see http://developers.flagship.io/api/v1/
 */
class Flagship
{
    private const NAMED_PARAM_ENV_ID = '%ENVIRONMENT_ID';
    private const NAMED_PARAM_CAMPAIGN_ID = '%CAMPAIGN_ID';
    private const NAMED_PARAM_BASE_URL = '%BASE_URL';

    private const URL_ALL_CAMPAIGNS = self::NAMED_PARAM_BASE_URL . '/' . self::NAMED_PARAM_ENV_ID . '/campaigns';
    private const URL_SINGLE_CAMPAIGN = self::URL_ALL_CAMPAIGNS . '/' . self::NAMED_PARAM_CAMPAIGN_ID;
    private const URL_CAMPAIGN_ACTIVATION = self::NAMED_PARAM_BASE_URL . '/activate';

    /**
     * @var string the base url of flagship endpoints ex: https://decision-api.flagship.io/v1
     */
    private $baseUrl;

    /**
     * @var RequestParameters
     * @see http://developers.flagship.io/api/v1/#request-parameters
     */
    private $requestParameters;

    /**
     * @var string The environment ID identifies your account and environment
     */
    private $environmentId;

    /**
     * @var HttpClientInterface
     */
    private $httpClient;

    /**
     * Flagship constructor.
     *
     * @param string              $baseUrl
     * @param string              $environmentId
     * @param HttpClientInterface $httpClient
     */
    public function __construct(string $baseUrl, string $environmentId, HttpClientInterface $httpClient)
    {
        if (empty($baseUrl)) {
            throw new \InvalidArgumentException('baseUrl cannot be empty');
        }

        if (empty($environmentId)) {
            throw new \InvalidArgumentException('Environment ID cannot be empty');
        }

        $this->baseUrl = $baseUrl;
        $this->environmentId = $environmentId;
        $this->httpClient = $httpClient;
        $this->requestParameters = new RequestParameters();
    }

    /**
     * Sets the Request Parameters
     *
     * @param RequestParameters $requestParameters
     */
    public function setRequestParameters(RequestParameters $requestParameters): void
    {
        $this->requestParameters = $requestParameters;
    }

    /**
     * Affects a visitor to a variation. It should be use to manually activate a single
     * campaign and variation in case you do not automatically activate them when running
     * campaign assignment (See trigger_hit parameter)
     *
     * It returns a 204 HTTP response
     *
     * @param string $visitorId
     * @param string $variationGroupId
     * @param string $variationId
     * @return ResponseInterface
     * @throws TransportExceptionInterface
     * @see http://developers.flagship.io/api/v1/?shell#campaign-activation
     * @see http://developers.flagship.io/api/v1/?shell#trigger-hit
     */
    public function requestCampaignActivation(
        string $visitorId,
        string $variationGroupId,
        string $variationId
    ): ResponseInterface {

        $jsonArray = [
            'vid' => $visitorId,
            'cid' => $this->environmentId,
            'caid' => $variationGroupId,
            'vaid' => $variationId
        ];

        $response = $this->httpClient->request(
            'POST',
            $this->getCompaignActivationUrl(),
            [
                'json' => $jsonArray
            ]
        );

        return $response;
    }

    /**
     * Retrieves the affection of your visitor ID with a specific
     * context (key/value pairs) to the specified campaign ID.
     *
     * By default, the API will send a hit to trigger a campaign
     * assignment event for the visitor ID and the affected campaign.
     *
     * @param string $visitorId ID of the visitor
     * @param string $campaignId The same as Custom ID on their docs
     * @param ContextInterface $context
     * @return ResponseInterface
     * @throws TransportExceptionInterface
     */
    public function requestSingleCampaign(
        string $visitorId,
        string $campaignId,
        ContextInterface $context
    ): ResponseInterface {

        $jsonArray = [
            'visitor_id' => $visitorId,
            'context' => $context->getList(),
            'decision_group' => $this->requestParameters->getDecisionGroup(),
            'format_response' => $this->requestParameters->isFormatResponseEnabled(),
            'trigger_hit' => $this->requestParameters->isTriggerHitEnabled()
        ];

        $response = $this->httpClient->request(
            'POST',
            $this->getSingleCampaignUrl($campaignId),
            [
                'json' => $jsonArray
            ]
        );

        return $response;
    }

    /**
     * Retrieves all the campaigns affected to your visitor and the context (key/value pairs).
     *
     * By default, the API will send a hit to trigger a campaign
     * assignment event for the visitor ID and each affected campaign.
     *
     * @param string $visitorId
     * @param ContextInterface $context
     * @return ResponseInterface
     * @throws TransportExceptionInterface
     */
    public function requestAllCampaigns(string $visitorId, ContextInterface $context): ResponseInterface
    {
        $jsonArray = [
            'visitor_id' => $visitorId,
            'context' => $context->getList(),
            'decision_group' => $this->requestParameters->getDecisionGroup(),
            'trigger_hit' => $this->requestParameters->isTriggerHitEnabled()
        ];

        $response = $this->httpClient->request(
            'POST',
            $this->getAllCampaignsUrl(),
            [
                'json' => $jsonArray
            ]
        );

        return $response;
    }

    /**
     * Replaces the named parameter (key) with its correlated value
     *
     * @param string $source
     * @param array $namedParamKVP
     * @return string
     */
    private function replaceNamedParameter(string $source, array $namedParamKVP): string
    {
        return str_replace(array_keys($namedParamKVP), array_values($namedParamKVP), $source);
    }

    /**
     * Returns the SingleCampaign URL with the Environment ID and Campaign ID in place
     *
     * @param string $campaignId
     * @return string
     */
    private function getSingleCampaignUrl(string $campaignId): string
    {
        return $this->replaceNamedParameter(
            self::URL_SINGLE_CAMPAIGN,
            [
                self::NAMED_PARAM_BASE_URL => $this->baseUrl,
                self::NAMED_PARAM_ENV_ID => $this->environmentId,
                self::NAMED_PARAM_CAMPAIGN_ID => $campaignId
            ]
        );
    }

    /**
     * @return string
     */
    private function getCompaignActivationUrl(): string
    {
        return $this->replaceNamedParameter(
            self::URL_CAMPAIGN_ACTIVATION,
            [
                self::NAMED_PARAM_BASE_URL => $this->baseUrl
            ]
        );
    }

    /**
     * Returns the AllCampaigns URL with the Environment ID in place. If the Mode is
     * different than normal (default) it is appended to the URL as a Query String
     *
     * @return string
     */
    private function getAllCampaignsUrl(): string
    {
        $url = $this->replaceNamedParameter(
            self::URL_ALL_CAMPAIGNS,
            [
                self::NAMED_PARAM_BASE_URL => $this->baseUrl,
                self::NAMED_PARAM_ENV_ID => $this->environmentId
            ]
        );

        if (! $this->requestParameters->isDefaultMode()) {
            $url .= '?mode=' . $this->requestParameters->getMode();
        }

        return $url;
    }
}


1		<?php
2
3		declare(strict_types=1);
4
5		namespace Wcomnisky\Flagship;
6
7		use Symfony\Contracts\HttpClient\Exception\TransportExceptionInterface;
8		use Symfony\Contracts\HttpClient\HttpClientInterface;
9		use Symfony\Contracts\HttpClient\ResponseInterface;
10		use Wcomnisky\Flagship\Api\RequestParameters;
11		use Wcomnisky\Flagship\Context\ContextInterface;
12
13		/**
14		* Class Flagship
15		* @package Wcomnisky\Flagship
16		* @see http://developers.flagship.io/api/v1/
17		*/
18		class Flagship
19		{
20		private const NAMED_PARAM_ENV_ID = '%ENVIRONMENT_ID';
21		private const NAMED_PARAM_CAMPAIGN_ID = '%CAMPAIGN_ID';
22		private const NAMED_PARAM_BASE_URL = '%BASE_URL';
23
24		private const URL_ALL_CAMPAIGNS = self::NAMED_PARAM_BASE_URL . '/' . self::NAMED_PARAM_ENV_ID . '/campaigns';
25		private const URL_SINGLE_CAMPAIGN = self::URL_ALL_CAMPAIGNS . '/' . self::NAMED_PARAM_CAMPAIGN_ID;
26		private const URL_CAMPAIGN_ACTIVATION = self::NAMED_PARAM_BASE_URL . '/activate';
27
28		/**
29		* @var string the base url of flagship endpoints ex: https://decision-api.flagship.io/v1
30		*/
31		private $baseUrl;
32
33		/**
34		* @var RequestParameters
35		* @see http://developers.flagship.io/api/v1/#request-parameters
36		*/
37		private $requestParameters;
38
39		/**
40		* @var string The environment ID identifies your account and environment
41		*/
42		private $environmentId;
43
44		/**
45		* @var HttpClientInterface
46		*/
47		private $httpClient;
48
49		/**
50		* Flagship constructor.
51		*
52		* @param string $baseUrl
53		* @param string $environmentId
54		* @param HttpClientInterface $httpClient
55		*/
56	6	public function __construct(string $baseUrl, string $environmentId, HttpClientInterface $httpClient)
57		{
58	6	if (empty($baseUrl)) {
59	1	throw new \InvalidArgumentException('baseUrl cannot be empty');
60		}
61
62	5	if (empty($environmentId)) {
63	1	throw new \InvalidArgumentException('Environment ID cannot be empty');
64		}
65
66	4	$this->baseUrl = $baseUrl;
67	4	$this->environmentId = $environmentId;
68	4	$this->httpClient = $httpClient;
69	4	$this->requestParameters = new RequestParameters();
70	4	}
71
72		/**
73		* Sets the Request Parameters
74		*
75		* @param RequestParameters $requestParameters
76		*/
77	1	public function setRequestParameters(RequestParameters $requestParameters): void
78		{
79	1	$this->requestParameters = $requestParameters;
80	1	}
81
82		/**
83		* Affects a visitor to a variation. It should be use to manually activate a single
84		* campaign and variation in case you do not automatically activate them when running
85		* campaign assignment (See trigger_hit parameter)
86		*
87		* It returns a 204 HTTP response
88		*
89		* @param string $visitorId
90		* @param string $variationGroupId
91		* @param string $variationId
92		* @return ResponseInterface
93		* @throws TransportExceptionInterface
94		* @see http://developers.flagship.io/api/v1/?shell#campaign-activation
95		* @see http://developers.flagship.io/api/v1/?shell#trigger-hit
96		*/
97		public function requestCampaignActivation(
98		string $visitorId,
99		string $variationGroupId,
100		string $variationId
101		): ResponseInterface {
102
103		$jsonArray = [
104		'vid' => $visitorId,
105		'cid' => $this->environmentId,
106		'caid' => $variationGroupId,
107		'vaid' => $variationId
108		];
109
110		$response = $this->httpClient->request(
111		'POST',
112		$this->getCompaignActivationUrl(),
113		[
114		'json' => $jsonArray
115		]
116		);
117
118		return $response;
119		}
120
121		/**
122		* Retrieves the affection of your visitor ID with a specific
123		* context (key/value pairs) to the specified campaign ID.
124		*
125		* By default, the API will send a hit to trigger a campaign
126		* assignment event for the visitor ID and the affected campaign.
127		*
128		* @param string $visitorId ID of the visitor
129		* @param string $campaignId The same as Custom ID on their docs
130		* @param ContextInterface $context
131		* @return ResponseInterface
132		* @throws TransportExceptionInterface
133		*/
134	1	public function requestSingleCampaign(
135		string $visitorId,
136		string $campaignId,
137		ContextInterface $context
138		): ResponseInterface {
139
140		$jsonArray = [
141	1	'visitor_id' => $visitorId,
142	1	'context' => $context->getList(),
143	1	'decision_group' => $this->requestParameters->getDecisionGroup(),
144	1	'format_response' => $this->requestParameters->isFormatResponseEnabled(),
145	1	'trigger_hit' => $this->requestParameters->isTriggerHitEnabled()
146		];
147
148	1	$response = $this->httpClient->request(
149	1	'POST',
150	1	$this->getSingleCampaignUrl($campaignId),
151		[
152	1	'json' => $jsonArray
153		]
154		);
155
156	1	return $response;
157		}
158
159		/**
160		* Retrieves all the campaigns affected to your visitor and the context (key/value pairs).
161		*
162		* By default, the API will send a hit to trigger a campaign
163		* assignment event for the visitor ID and each affected campaign.
164		*
165		* @param string $visitorId
166		* @param ContextInterface $context
167		* @return ResponseInterface
168		* @throws TransportExceptionInterface
169		*/
170	2	public function requestAllCampaigns(string $visitorId, ContextInterface $context): ResponseInterface
171		{
172		$jsonArray = [
173	2	'visitor_id' => $visitorId,
174	2	'context' => $context->getList(),
175	2	'decision_group' => $this->requestParameters->getDecisionGroup(),
176	2	'trigger_hit' => $this->requestParameters->isTriggerHitEnabled()
177		];
178
179	2	$response = $this->httpClient->request(
180	2	'POST',
181	2	$this->getAllCampaignsUrl(),
182		[
183	2	'json' => $jsonArray
184		]
185		);
186
187	2	return $response;
188		}
189
190		/**
191		* Replaces the named parameter (key) with its correlated value
192		*
193		* @param string $source
194		* @param array $namedParamKVP
195		* @return string
196		*/
197	3	private function replaceNamedParameter(string $source, array $namedParamKVP): string
198		{
199	3	return str_replace(array_keys($namedParamKVP), array_values($namedParamKVP), $source);
200		}
201
202		/**
203		* Returns the SingleCampaign URL with the Environment ID and Campaign ID in place
204		*
205		* @param string $campaignId
206		* @return string
207		*/
208	1	private function getSingleCampaignUrl(string $campaignId): string
209		{
210	1	return $this->replaceNamedParameter(
211	1	self::URL_SINGLE_CAMPAIGN,
212		[
213	1	self::NAMED_PARAM_BASE_URL => $this->baseUrl,
214	1	self::NAMED_PARAM_ENV_ID => $this->environmentId,
215	1	self::NAMED_PARAM_CAMPAIGN_ID => $campaignId
216		]
217		);
218		}
219
220		/**
221		* @return string
222		*/
223		private function getCompaignActivationUrl(): string
224		{
225		return $this->replaceNamedParameter(
226		self::URL_CAMPAIGN_ACTIVATION,
227		[
228		self::NAMED_PARAM_BASE_URL => $this->baseUrl
229		]
230		);
231		}
232
233		/**
234		* Returns the AllCampaigns URL with the Environment ID in place. If the Mode is
235		* different than normal (default) it is appended to the URL as a Query String
236		*
237		* @return string
238		*/
239	2	private function getAllCampaignsUrl(): string
240		{
241	2	$url = $this->replaceNamedParameter(
242	2	self::URL_ALL_CAMPAIGNS,
243		[
244	2	self::NAMED_PARAM_BASE_URL => $this->baseUrl,
245	2	self::NAMED_PARAM_ENV_ID => $this->environmentId
246		]
247		);
248
249	2	if (! $this->requestParameters->isDefaultMode()) {
250	1	$url .= '?mode=' . $this->requestParameters->getMode();
251		}
252
253	2	return $url;
254		}
255		}
256

wcomnisky / flagship-php-sdk

Pull Request — develop (#6)

Flagship::requestCampaignActivation() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like