Merge branch 'development'

PHPstan config updates, test file update

Readme.md

@@ -6,7 +6,7 @@ Amazon Gift Codes On Demand (AGCOD). Integration for Amazon Incentive API.
 
 ## How to install
 
-`composer request gullevek/amazon-incentives`
+`composer require gullevek/amazon-incentives`
 
 ## _ENV variables needed
 

composer.json

@@ -20,5 +20,8 @@
     "minimum-stability": "dev",
     "require": {
 		"php": ">=7.4.0"
+	},
+    "archive": {
+        "exclude": ["/test/", "/phpstan.neon", "/psalm.xml", "/.phan/", "/.vscode/"]
     }
 }

phpstan.neon

@@ -2,10 +2,10 @@
 
 parameters:
 	tmpDir: /tmp/phpstan-codeblocks-amazon-incentives
-	level: max
+	level: 8
 	paths:
 		- %currentWorkingDirectory%
-	excludes_analyse:
+	excludePaths:
 		# ignore composer
 		- vendor
 	# ignore errores with

psalm.xml

@@ -0,0 +1,15 @@
+<?xml version="1.0"?>
+<psalm
+    errorLevel="3"
+    resolveFromConfigFile="true"
+    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+    xmlns="https://getpsalm.org/schema/config"
+    xsi:schemaLocation="https://getpsalm.org/schema/config vendor/vimeo/psalm/config.xsd"
+>
+    <projectFiles>
+        <directory name="src" />
+        <ignoreFiles>
+            <directory name="vendor" />
+        </ignoreFiles>
+    </projectFiles>
+</psalm>

src/AWS/AWS.php

@@ -155,7 +155,7 @@ class AWS
 			'Service' => $k_service_hexis,
 		]]);
 
-		$url = 'https://' . (string)$endpoint . '/' . $service_operation;
+		$url = 'https://' . $endpoint . '/' . $service_operation;
 		$headers = $this->buildHeaders($payload, $authorization_value, $date_time_string, $service_target);
 		return (new Client())->request($url, $headers, $payload);
 	}
@@ -332,7 +332,7 @@ class AWS
 			'value' =>
 				[
 					'currencyCode' => $this->config->getCurrency(),
-					'amount' => (float)$amount
+					'amount' => $amount
 				]
 		];
 		return (json_encode($payload)) ?: '';

src/Client/Client.php

@@ -92,7 +92,6 @@ class Client implements ClientInterface
 				$message = 'Could not connect to AWS (' . $url . ').  Please check your '
 					. 'internet connection and try again. [' . $message . ']';
 				break;
-			case CURLE_SSL_CACERT:
 			case CURLE_SSL_PEER_CERTIFICATE:
 				$message = 'Could not verify AWS SSL certificate.  Please make sure '
 					. 'that your network is not intercepting certificates.  '

src/Client/ClientInterface.php

@@ -12,7 +12,6 @@ interface ClientInterface
 	 *
 	 * @return String
 	 */
-
 	public function request(string $url, array $headers, $params): string;
 }
 

src/Config/Config.php

@@ -7,27 +7,27 @@ class Config implements ConfigInterface
 	/**
 	 * @var string
 	 */
-	private $endpoint;
+	private $endpoint = '';
 	/**
 	 * @var string
 	 */
-	private $access_key;
+	private $access_key = '';
 	/**
 	 * @var string
 	 */
-	private $secret_key;
+	private $secret_key = '';
 	/**
 	 * @var string
 	 */
-	private $partner_id;
+	private $partner_id = '';
 	/**
 	 * @var string
 	 */
-	private $currency;
+	private $currency = '';
 	/**
 	 * @var bool
 	 */
-	private $debug;
+	private $debug = false;
 
 	/**
 	 * @param string|null $key
@@ -42,14 +42,38 @@ class Config implements ConfigInterface
 		?string $partner,
 		?string $endpoint,
 		?string $currency,
-		?bool $debug,
+		?bool $debug
 	) {
-		$this->setAccessKey(($key) ?: $this->parseEnv('AWS_GIFT_CARD_KEY')); /** @phpstan-ignore-line */
+		/**
-		$this->setSecret(($secret) ?: $this->parseEnv('AWS_GIFT_CARD_SECRET')); /** @phpstan-ignore-line */
+		 * @psalm-suppress InvalidScalarArgument
-		$this->setPartner(($partner) ?: $this->parseEnv('AWS_GIFT_CARD_PARTNER_ID')); /** @phpstan-ignore-line */
+		 * @phpstan-ignore-next-line
-		$this->setEndpoint(($endpoint) ?: $this->parseEnv('AWS_GIFT_CARD_ENDPOINT')); /** @phpstan-ignore-line */
+		 */
-		$this->setCurrency(($currency) ?: $this->parseEnv('AWS_GIFT_CARD_CURRENCY')); /** @phpstan-ignore-line */
+		$this->setAccessKey(($key) ?: $this->parseEnv('AWS_GIFT_CARD_KEY'));
-		$this->setDebug(($debug) ?: $this->parseEnv('AWS_DEBUG')); /** @phpstan-ignore-line */
+		/**
+		 * @psalm-suppress InvalidScalarArgument
+		 * @phpstan-ignore-next-line
+		 */
+		$this->setSecret(($secret) ?: $this->parseEnv('AWS_GIFT_CARD_SECRET'));
+		/**
+		 * @psalm-suppress InvalidScalarArgument
+		 * @phpstan-ignore-next-line
+		 */
+		$this->setPartner(($partner) ?: $this->parseEnv('AWS_GIFT_CARD_PARTNER_ID'));
+		/**
+		 * @psalm-suppress InvalidScalarArgument
+		 * @phpstan-ignore-next-line
+		 */
+		$this->setEndpoint(($endpoint) ?: $this->parseEnv('AWS_GIFT_CARD_ENDPOINT'));
+		/**
+		 * @psalm-suppress InvalidScalarArgument
+		 * @phpstan-ignore-next-line
+		 */
+		$this->setCurrency(($currency) ?: $this->parseEnv('AWS_GIFT_CARD_CURRENCY'));
+		/**
+		 * @psalm-suppress InvalidScalarArgument
+		 * @phpstan-ignore-next-line
+		 */
+		$this->setDebug(($debug) ?: $this->parseEnv('AWS_DEBUG'));
 	}
 
 	/**
@@ -80,9 +104,9 @@ class Config implements ConfigInterface
 	}
 
 	/**
-	 * @return string|null
+	 * @return string
 	 */
-	public function getEndpoint(): ?string
+	public function getEndpoint(): string
 	{
 		return $this->endpoint;
 	}
@@ -100,9 +124,9 @@ class Config implements ConfigInterface
 	}
 
 	/**
-	 * @return string|null
+	 * @return string
 	 */
-	public function getAccessKey(): ?string
+	public function getAccessKey(): string
 	{
 		return $this->access_key;
 	}
@@ -119,9 +143,9 @@ class Config implements ConfigInterface
 	}
 
 	/**
-	 * @return string|null
+	 * @return string
 	 */
-	public function getSecret(): ?string
+	public function getSecret(): string
 	{
 		return $this->secret_key;
 	}
@@ -138,9 +162,9 @@ class Config implements ConfigInterface
 	}
 
 	/**
-	 * @return string|null
+	 * @return string
 	 */
-	public function getCurrency(): ?string
+	public function getCurrency(): string
 	{
 		return $this->currency;
 	}
@@ -158,9 +182,9 @@ class Config implements ConfigInterface
 	}
 
 	/**
-	 * @return string|null
+	 * @return string
 	 */
-	public function getPartner(): ?string
+	public function getPartner(): string
 	{
 		return $this->partner_id;
 	}

src/Config/ConfigInterface.php

@@ -5,68 +5,68 @@ namespace gullevek\AmazonIncentives\Config;
 interface ConfigInterface
 {
 	/**
-	 * @return string|null
+	 * @return string
 	 */
-	public function getEndpoint(): ?string;
+	public function getEndpoint(): string;
 
 	/**
 	 * @param string $endpoint
-	 * @return $this
+	 * @return ConfigInterface
 	 */
 	public function setEndpoint(string $endpoint): ConfigInterface;
 
 	/**
-	 * @return string|null
+	 * @return string
 	 */
-	public function getAccessKey(): ?string;
+	public function getAccessKey(): string;
 
 	/**
 	 * @param string $key
-	 * @return $this
+	 * @return ConfigInterface
 	 */
 	public function setAccessKey(string $key): ConfigInterface;
 
 	/**
-	 * @return string|null
+	 * @return string
 	 */
-	public function getSecret(): ?string;
+	public function getSecret(): string;
 
 	/**
 	 * @param string $secret
-	 * @return $this
+	 * @return ConfigInterface
 	 */
 	public function setSecret(string $secret): ConfigInterface;
 
 	/**
-	 * @return string|null
+	 * @return string
 	 */
-	public function getCurrency(): ?string;
+	public function getCurrency(): string;
 
 	/**
 	 * @param string $currency
-	 * @return $this
+	 * @return ConfigInterface
 	 */
 	public function setCurrency(string $currency): ConfigInterface;
 
 	/**
-	 * @return string|null
+	 * @return string
 	 */
-	public function getPartner(): ?string;
+	public function getPartner(): string;
 
 	/**
 	 * @param string $partner
-	 * @return $this
+	 * @return ConfigInterface
 	 */
 	public function setPartner(string $partner): ConfigInterface;
 
 	/**
-	 * @return bool|null
+	 * @return bool
 	 */
-	public function getDebug(): ?bool;
+	public function getDebug(): bool;
 
 	/**
 	 * @param bool $debug
-	 * @return $this
+	 * @return ConfigInterface
 	 */
 	public function setDebug(bool $debug): ConfigInterface;
 }

src/Response/CancelResponse.php

@@ -2,7 +2,6 @@
 
 namespace gullevek\AmazonIncentives\Response;
 
-use gullevek\AmazonIncentives\Exceptions\AmazonErrors;
 use gullevek\AmazonIncentives\Debug\AmazonDebug;
 
 class CancelResponse
@@ -12,25 +11,25 @@ class CancelResponse
 	 *
 	 * @var string
 	 */
-	protected $id;
+	protected $id = '';
 	/**
 	 * Amazon Gift Card creationRequestId
 	 *
 	 * @var string
 	 */
-	protected $creation_request_id;
+	protected $creation_request_id = '';
 	/**
 	 * Amazon Gift Card status
 	 *
 	 * @var string
 	 */
-	protected $status;
+	protected $status = '';
 	/**
 	 * Amazon Gift Card Raw JSON
 	 *
 	 * @var array<mixed>
 	 */
-	protected $raw_json;
+	protected $raw_json = [];
 
 	/**
 	 * Response constructor.
@@ -88,15 +87,6 @@ class CancelResponse
 	 */
 	public function parseJsonResponse(array $json_response): self
 	{
-		if (!is_array($json_response)) {
-			throw AmazonErrors::getError(
-				'FAILURE',
-				'E001',
-				'NonScalarValue',
-				'Response must be a scalar value',
-				0
-			);
-		}
 		if (array_key_exists('gcId', $json_response)) {
 			$this->id = $json_response['gcId'];
 		}

src/Response/CreateBalanceResponse.php

@@ -2,7 +2,6 @@
 
 namespace gullevek\AmazonIncentives\Response;
 
-use gullevek\AmazonIncentives\Exceptions\AmazonErrors;
 use gullevek\AmazonIncentives\Debug\AmazonDebug;
 
 class CreateBalanceResponse
@@ -12,31 +11,31 @@ class CreateBalanceResponse
 	 *
 	 * @var string
 	 */
-	protected $amount;
+	protected $amount = '';
 	/**
 	 * Amazon Gift Card Balance Currency
 	 *
 	 * @var string
 	 */
-	protected $currency;
+	protected $currency = '';
 	/**
 	 * Amazon Gift Card Balance Status
 	 *
 	 * @var string
 	 */
-	protected $status;
+	protected $status = '';
 	/**
 	 * Amazon Gift Card Balance Timestamp
 	 *
 	 * @var string
 	 */
-	protected $timestamp;
+	protected $timestamp = '';
 	/**
 	 * Amazon Gift Card Raw JSON
 	 *
 	 * @var array<mixed>
 	 */
-	protected $raw_json;
+	protected $raw_json = [];
 
 	/**
 	 * Response constructor.
@@ -105,15 +104,6 @@ class CreateBalanceResponse
 	 */
 	public function parseJsonResponse(array $json_response): self
 	{
-		if (!is_array($json_response)) {
-			throw AmazonErrors::getError(
-				'FAILURE',
-				'E001',
-				'NonScalarValue',
-				'Response must be a scalar value',
-				0
-			);
-		}
 		if (array_key_exists('amount', $json_response['availableFunds'])) {
 			$this->amount = $json_response['availableFunds']['amount'];
 		}

src/Response/CreateResponse.php

@@ -2,7 +2,6 @@
 
 namespace gullevek\AmazonIncentives\Response;
 
-use gullevek\AmazonIncentives\Exceptions\AmazonErrors;
 use gullevek\AmazonIncentives\Debug\AmazonDebug;
 
 class CreateResponse
@@ -12,59 +11,59 @@ class CreateResponse
 	 *
 	 * @var string
 	 */
-	protected $id;
+	protected $id = '';
 
 	/**
 	 * Amazon Gift Card creationRequestId
 	 *
 	 * @var string
 	 */
-	protected $creation_request_id;
+	protected $creation_request_id = '';
 
 	/**
 	 * Amazon Gift Card gcClaimCode
 	 *
 	 * @var string
 	 */
-	protected $claim_code;
+	protected $claim_code = '';
 
 	/**
 	 * Amazon Gift Card amount
 	 *
 	 * @var float
 	 */
-	protected $value;
+	protected $value = 0;
 
 	/**
 	 * Amazon Gift Card currency
 	 *
 	 * @var string
 	 */
-	protected $currency;
+	protected $currency = '';
 	/**
 	 * Amazon Gift Card status
 	 *
 	 * @var string
 	 */
-	protected $status;
+	protected $status = '';
 	/**
 	 * Amazon Gift Card Expiration Date
 	 *
 	 * @var string
 	 */
-	protected $expiration_date;
+	protected $expiration_date = '';
 	/**
 	 * Amazon Gift Card Expiration Date
 	 *
 	 * @var string
 	 */
-	protected $card_status;
+	protected $card_status = '';
 	/**
 	 * Amazon Gift Card Raw JSON
 	 *
 	 * @var array<mixed>
 	 */
-	protected $raw_json;
+	protected $raw_json = [];
 
 	/**
 	 * Response constructor.
@@ -158,20 +157,11 @@ class CreateResponse
 	}
 
 	/**
-	 * @param array<mixed> $json_response
+	 * @param array<array-key,mixed|array> $json_response
 	 * @return CreateResponse
 	 */
 	public function parseJsonResponse(array $json_response): self
 	{
-		if (!is_array($json_response)) {
-			throw AmazonErrors::getError(
-				'FAILURE',
-				'E001',
-				'NonScalarValue',
-				'Response must be a scalar value',
-				0
-			);
-		}
 		if (array_key_exists('gcId', $json_response)) {
 			$this->id = $json_response['gcId'];
 		}

test/.env.example

@@ -0,0 +1,7 @@
+# for AWS gift card testing
+AWS_GIFT_CARD_ENDPOINT=
+AWS_GIFT_CARD_KEY=
+AWS_GIFT_CARD_SECRET=
+AWS_GIFT_CARD_PARTNER_ID=
+AWS_GIFT_CARD_CURRENCY=
+AWS_DEBUG=

test/aws_gift_card_tests.php

@@ -76,21 +76,6 @@ print "<h1>Amazon Gift Card Incentives</h1><br>";
 // optional
 // debug: AWS_DEBUG (if not set: off)
 
-// as in .env
-// AWS_GIFT_CARD_ENDPOINT.TEST
-// AWS_GIFT_CARD_ENDPOINT.LIVE
-
-define('LOCATION', 'test');
-foreach (
-	[
-		'AWS_GIFT_CARD_KEY', 'AWS_GIFT_CARD_SECRET', 'AWS_GIFT_CARD_PARTNER_ID',
-		'AWS_GIFT_CARD_ENDPOINT', 'AWS_GIFT_CARD_CURRENCY', 'AWS_DEBUG'
-	] as $key
-) {
-	//
-	$_ENV[$key] = $_ENV[$key . '.' . strtoupper((LOCATION))] ?? $_ENV[$key] ?? '';
-}
-
 // open debug file output
 $fp = fopen('log/debug.' . date('YmdHis') . '.log', 'w');
 if (!is_resource($fp)) {
@@ -196,6 +181,28 @@ if ($run_gift_tests === true) {
 	}
 	print "<br>";
 	sleep($debug_wait);
+	// request same card again and get error
+	try {
+		$aws_test = AmazonIncentives::make()->buyGiftCard((float)$value, $creation_request_id);
+		$request_status = $aws_test->getStatus();
+		// same?
+		$claim_code = $aws_test->getClaimCode();
+		$expiration_date = $aws_test->getExpirationDate();
+		print "AWS: buyGiftCard: CANCLED SAME CODE AGAIN: " . $request_status . ": "
+			. "creationRequestId: " . $creation_request_id . ", gcId: " . $gift_card_id . ", "
+			. "EXPIRE DATE: <b>" . dateTr($expiration_date) . "</b>, "
+			. "CLAIM CODE: <b>" . $claim_code . "</b>";
+		if ($debug_print === true) {
+			print "<pre>" . print_r($aws_test, true) . "</pre>";
+		}
+		fwrite($fp, writeLog((array)$aws_test));
+	} catch (\Exception $e) {
+		$error = AmazonIncentives::decodeExceptionMessage($e->getMessage());
+		printException('buyGiftCard', $e->getCode(), $error, $debug_print);
+		fwrite($fp, writeLog($error));
+	}
+	print "<br>";
+	sleep($debug_wait);
 
 	// set same request ID twice to get same response test
 	try {