Validator::getClientConfig() - Code Metrics - Inspection of "Merge pull request #87 from Stafox/3.0.0" - aporat/store-receipt-validator - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 66bd98...7177e9 )

by Adar

created 2018-12-26 21:44 UTC

Validator::getClientConfig() A

↳ Parent: Validator

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes

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

<?php

namespace ReceiptValidator\iTunes;

use ReceiptValidator\RunTimeException;
use GuzzleHttp\Client as HttpClient;

class Validator
{
    const ENDPOINT_SANDBOX = 'https://sandbox.itunes.apple.com/verifyReceipt';
    const ENDPOINT_PRODUCTION = 'https://buy.itunes.apple.com/verifyReceipt';

    /**
     * endpoint url
     *
     * @var string
     */
    protected $endpoint;

    /**
     * Whether to exclude old transactions
     *
     * @var bool
     */
    protected $exclude_old_transactions = false;

    /**
     * itunes receipt data, in base64 format
     *
     * @var string|null
     */
    protected $receipt_data;

    /**
     * The shared secret is a unique code to receive your In-App Purchase receipts.
     * Without a shared secret, you will not be able to test or offer your automatically
     * renewable In-App Purchase subscriptions.
     *
     * @var string|null
     */
    protected $shared_secret;

    /**
     * Guzzle http client
     *
     * @var HttpClient
     */
    protected $client;

    /**
     * Validator constructor
     *
     * @param string $endpoint
     * @throws \InvalidArgumentException
     */
    public function __construct(string $endpoint = self::ENDPOINT_PRODUCTION)
    {
        if ($endpoint !== self::ENDPOINT_PRODUCTION && $endpoint !== self::ENDPOINT_SANDBOX) {
            throw new \InvalidArgumentException("Invalid endpoint '{$endpoint}'");
        }

        $this->endpoint = $endpoint;
    }

    /**
     * Get receipt data
     *
     * @return string|null
     */
    public function getReceiptData(): ?string
    {
        return $this->receipt_data;
    }

    /**
     * Set receipt data, either in base64, or in json
     *
     * @param string|null $receipt_data
     *
     * @return $this
     */
    public function setReceiptData($receipt_data): self
    {
        if (strpos($receipt_data, '{') !== false) {
            $this->receipt_data = base64_encode($receipt_data);
        } else {
            $this->receipt_data = $receipt_data;
        }

        return $this;
    }

    /**
     * @return string|null
     */
    public function getSharedSecret(): ?string
    {
        return $this->shared_secret;
    }

    /**
     * @param string|null $shared_secret
     * @return $this
     */
    public function setSharedSecret($shared_secret = null): self
    {
        $this->shared_secret = $shared_secret;

        return $this;
    }

    /**
     * get endpoint
     *
     * @return string
     */
    public function getEndpoint(): string
    {
        return $this->endpoint;
    }

    /**
     * set endpoint
     *
     * @param string $endpoint
     * @return $this
     */
    public function setEndpoint(string $endpoint): self
    {
        $this->endpoint = $endpoint;

        return $this;
    }

    /**
     * Get exclude old transactions
     *
     * @return bool
     */
    public function getExcludeOldTransactions(): bool
    {
        return $this->exclude_old_transactions;
    }

    /**
     * Set exclude old transactions
     *
     * @param bool $exclude
     * @return Validator
     */
    public function setExcludeOldTransactions(bool $exclude): self
    {
        $this->exclude_old_transactions = $exclude;

        return $this;
    }

    /**
     * Get Guzzle client config
     * @return array
     */
    protected function getClientConfig(): array
    {
        return ['base_uri' => $this->endpoint];
    }

    /**
     * Returns the Guzzle client
     *
     * @return HttpClient
     */
    protected function getClient(): HttpClient
    {
        if ($this->client === null) {
            $this->client = new HttpClient($this->getClientConfig());
        }

        return $this->client;
    }

    /**
     * Prepare request data (json)
     *
     * @return string
     */
    protected function prepareRequestData(): string
    {
        $request = [
            'receipt-data' => $this->getReceiptData(),
            'exclude-old-transactions' => $this->getExcludeOldTransactions(),
        ];

        if ($this->shared_secret !== null) {
            $request['password'] = $this->shared_secret;
        }

        return json_encode($request);
    }


    /**
     * @param null|string $receipt_data
     * @param null|string $shared_secret
     * @return ResponseInterface
     * @throws RunTimeException
     * @throws \GuzzleHttp\Exception\GuzzleException
     */
    public function validate(?string $receipt_data = null, ?string $shared_secret = null): ResponseInterface
    {

        if ($receipt_data !== null) {
            $this->setReceiptData($receipt_data);
        }

        if ($shared_secret !== null) {
            $this->setSharedSecret($shared_secret);
        }

        $client = $this->getClient();

        return $this->sendRequestUsingClient($client);
    }

    /**
     * @param HttpClient $client
     * @return ProductionResponse|SandboxResponse
     * @throws RunTimeException
     * @throws \GuzzleHttp\Exception\GuzzleException
     */
    private function sendRequestUsingClient(HttpClient $client)
    {
        $baseUri = (string)$client->getConfig('base_uri');

        $httpResponse = $client->request('POST', null, ['body' => $this->prepareRequestData()]);

        if ($httpResponse->getStatusCode() !== 200) {
            throw new RunTimeException('Unable to get response from itunes server');
        }

        $decodedBody = json_decode($httpResponse->getBody(), true);

        if ($baseUri === self::ENDPOINT_PRODUCTION) {
            $response = new ProductionResponse($decodedBody);

            // on a 21007 error, retry the request in the sandbox environment
            // these are receipts from the Apple review team
            if ($response->getResultCode() === ResponseInterface::RESULT_SANDBOX_RECEIPT_SENT_TO_PRODUCTION) {
                $config = array_merge($this->getClientConfig(), ['base_uri' => self::ENDPOINT_SANDBOX]);
                $client = new HttpClient($config);

                return $this->sendRequestUsingClient($client);
            }

        } else {
            $response = new SandboxResponse($decodedBody);
        }

        return $response;
    }
}


1		<?php
2
3		namespace ReceiptValidator\iTunes;
4
5		use ReceiptValidator\RunTimeException;
6		use GuzzleHttp\Client as HttpClient;
7
8		class Validator
9		{
10		const ENDPOINT_SANDBOX = 'https://sandbox.itunes.apple.com/verifyReceipt';
11		const ENDPOINT_PRODUCTION = 'https://buy.itunes.apple.com/verifyReceipt';
12
13		/**
14		* endpoint url
15		*
16		* @var string
17		*/
18		protected $endpoint;
19
20		/**
21		* Whether to exclude old transactions
22		*
23		* @var bool
24		*/
25		protected $exclude_old_transactions = false;
26
27		/**
28		* itunes receipt data, in base64 format
29		*
30		* @var string\|null
31		*/
32		protected $receipt_data;
33
34		/**
35		* The shared secret is a unique code to receive your In-App Purchase receipts.
36		* Without a shared secret, you will not be able to test or offer your automatically
37		* renewable In-App Purchase subscriptions.
38		*
39		* @var string\|null
40		*/
41		protected $shared_secret;
42
43		/**
44		* Guzzle http client
45		*
46		* @var HttpClient
47		*/
48		protected $client;
49
50		/**
51		* Validator constructor
52		*
53		* @param string $endpoint
54		* @throws \InvalidArgumentException
55		*/
56	6	public function __construct(string $endpoint = self::ENDPOINT_PRODUCTION)
57		{
58	6	if ($endpoint !== self::ENDPOINT_PRODUCTION && $endpoint !== self::ENDPOINT_SANDBOX) {
59	1	throw new \InvalidArgumentException("Invalid endpoint '{$endpoint}'");
60		}
61
62	6	$this->endpoint = $endpoint;
63	6	}
64
65		/**
66		* Get receipt data
67		*
68		* @return string\|null
69		*/
70	2	public function getReceiptData(): ?string
71		{
72	2	return $this->receipt_data;
73		}
74
75		/**
76		* Set receipt data, either in base64, or in json
77		*
78		* @param string\|null $receipt_data
79		*
80		* @return $this
81		*/
82	2	public function setReceiptData($receipt_data): self
83		{
84	2	if (strpos($receipt_data, '{') !== false) {
85	1	$this->receipt_data = base64_encode($receipt_data);
86		} else {
87	1	$this->receipt_data = $receipt_data;
88		}
89
90	2	return $this;
91		}
92
93		/**
94		* @return string\|null
95		*/
96	1	public function getSharedSecret(): ?string
97		{
98	1	return $this->shared_secret;
99		}
100
101		/**
102		* @param string\|null $shared_secret
103		* @return $this
104		*/
105	1	public function setSharedSecret($shared_secret = null): self
106		{
107	1	$this->shared_secret = $shared_secret;
108
109	1	return $this;
110		}
111
112		/**
113		* get endpoint
114		*
115		* @return string
116		*/
117	1	public function getEndpoint(): string
118		{
119	1	return $this->endpoint;
120		}
121
122		/**
123		* set endpoint
124		*
125		* @param string $endpoint
126		* @return $this
127		*/
128	1	public function setEndpoint(string $endpoint): self
129		{
130	1	$this->endpoint = $endpoint;
131
132	1	return $this;
133		}
134
135		/**
136		* Get exclude old transactions
137		*
138		* @return bool
139		*/
140	1	public function getExcludeOldTransactions(): bool
141		{
142	1	return $this->exclude_old_transactions;
143		}
144
145		/**
146		* Set exclude old transactions
147		*
148		* @param bool $exclude
149		* @return Validator
150		*/
151	1	public function setExcludeOldTransactions(bool $exclude): self
152		{
153	1	$this->exclude_old_transactions = $exclude;
154
155	1	return $this;
156		}
157
158		/**
159		* Get Guzzle client config
160		* @return array
161		*/
162		protected function getClientConfig(): array
163		{
164		return ['base_uri' => $this->endpoint];
165		}
166
167		/**
168		* Returns the Guzzle client
169		*
170		* @return HttpClient
171		*/
172		protected function getClient(): HttpClient
173		{
174		if ($this->client === null) {
175		$this->client = new HttpClient($this->getClientConfig());
176		}
177
178		return $this->client;
179		}
180
181		/**
182		* Prepare request data (json)
183		*
184		* @return string
185		*/
186		protected function prepareRequestData(): string
187		{
188		$request = [
189		'receipt-data' => $this->getReceiptData(),
190		'exclude-old-transactions' => $this->getExcludeOldTransactions(),
191		];
192
193		if ($this->shared_secret !== null) {
194		$request['password'] = $this->shared_secret;
195		}
196
197		return json_encode($request);
198		}
199
200
201		/**
202		* @param null\|string $receipt_data
203		* @param null\|string $shared_secret
204		* @return ResponseInterface
205		* @throws RunTimeException
206		* @throws \GuzzleHttp\Exception\GuzzleException
207		*/
208		public function validate(?string $receipt_data = null, ?string $shared_secret = null): ResponseInterface
209		{
210
211		if ($receipt_data !== null) {
212		$this->setReceiptData($receipt_data);
213		}
214
215		if ($shared_secret !== null) {
216		$this->setSharedSecret($shared_secret);
217		}
218
219		$client = $this->getClient();
220
221		return $this->sendRequestUsingClient($client);
222		}
223
224		/**
225		* @param HttpClient $client
226		* @return ProductionResponse\|SandboxResponse
227		* @throws RunTimeException
228		* @throws \GuzzleHttp\Exception\GuzzleException
229		*/
230		private function sendRequestUsingClient(HttpClient $client)
231		{
232		$baseUri = (string)$client->getConfig('base_uri');
233
234		$httpResponse = $client->request('POST', null, ['body' => $this->prepareRequestData()]);
235
236		if ($httpResponse->getStatusCode() !== 200) {
237		throw new RunTimeException('Unable to get response from itunes server');
238		}
239
240		$decodedBody = json_decode($httpResponse->getBody(), true);
241
242		if ($baseUri === self::ENDPOINT_PRODUCTION) {
243		$response = new ProductionResponse($decodedBody);
244
245		// on a 21007 error, retry the request in the sandbox environment
246		// these are receipts from the Apple review team
247		if ($response->getResultCode() === ResponseInterface::RESULT_SANDBOX_RECEIPT_SENT_TO_PRODUCTION) {
248		$config = array_merge($this->getClientConfig(), ['base_uri' => self::ENDPOINT_SANDBOX]);
249		$client = new HttpClient($config);
250
251		return $this->sendRequestUsingClient($client);
252		}
253
254		} else {
255		$response = new SandboxResponse($decodedBody);
256		}
257
258		return $response;
259		}
260		}
261

aporat / store-receipt-validator

Push — master ( 66bd98...7177e9 )

Validator::getClientConfig() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like