Response entities

src/Entity/Response/AbstractResponseEntity.php

@@ -0,0 +1,109 @@
+<?php declare(strict_types = 1);
+
+namespace Contributte\Comgate\Entity\Response;
+
+use Contributte\Comgate\Exceptions\Logical\InvalidArgumentException;
+use Contributte\Comgate\Exceptions\Runtime\InvalidComGateDataException;
+use Contributte\Comgate\Http\Response;
+use Psr\Http\Message\ResponseInterface;
+
+abstract class AbstractResponseEntity extends Response
+{
+
+	/**
+	 * @param Response|ResponseInterface $origin
+	 */
+	public function __construct($origin)
+	{
+		if ($origin instanceof Response) {
+			$origin = $origin->getOrigin();
+		}
+
+		parent::__construct($origin);
+	}
+
+	/**
+	 * @param string $fieldId
+	 * @param int|string|null $default
+	 * @return int|string|null
+	 */
+	public function get(string $fieldId, $default = null)
+	{
+		$value = $this->getData()[$fieldId] ?? $default;
+		if ($value !== null && !is_string($value) && !is_int($value)) {
+			throw new InvalidComGateDataException(sprintf('Comgate response field "%s" - unexpected type', $fieldId));
+		}
+
+		return $value;
+	}
+
+	/**
+	 * @phpstan-return ($default is null ? (string|null) : string)
+	 */
+	protected function getString(string $fieldId, ?string $default = null): ?string
+	{
+		return (string) ($this->get($fieldId) ?? $default);
+	}
+
+	protected function getRequiredString(string $fieldId): string
+	{
+		$value = $this->getString($fieldId);
+		if ($value === null) {
+			throw new InvalidArgumentException(sprintf('Comgate response field "%s" - missing', $fieldId));
+		}
+
+		return $value;
+	}
+
+	/**
+	 * @phpstan-return ($default is null ? (int|null) : int)
+	 */
+	protected function getInteger(string $fieldId, ?int $default = null): ?int
+	{
+		return (int) ($this->get($fieldId) ?? $default);
+	}
+
+	protected function getRequiredInteger(string $fieldId): int
+	{
+		$value = $this->getInteger($fieldId);
+		if ($value === null) {
+			throw new InvalidArgumentException(sprintf('Comgate response field "%s" - missing', $fieldId));
+		}
+
+		return $value;
+	}
+
+	/**
+	 * @phpstan-return ($default is null ? (bool|null) : bool)
+	 */
+	protected function getBool(string $fieldId, ?bool $default = null): ?bool
+	{
+		return (bool) ($this->get($fieldId) ?? $default);
+	}
+
+	protected function getRequiredBool(string $fieldId): bool
+	{
+		$value = $this->getBool($fieldId);
+		if ($value === null) {
+			throw new InvalidArgumentException(sprintf('Comgate response field "%s" - missing', $fieldId));
+		}
+
+		return $value;
+	}
+
+	public function getErrorCode(): int
+	{
+		return $this->getRequiredInteger('code');
+	}
+
+	public function getErrorMessage(): ?string
+	{
+		return $this->getString('message');
+	}
+
+	public function isOk(): bool
+	{
+		return $this->getInteger('code', -1) === 0;
+	}
+
+}

src/Entity/Response/PaymentResponse.php

@@ -0,0 +1,18 @@
+<?php declare(strict_types = 1);
+
+namespace Contributte\Comgate\Entity\Response;
+
+class PaymentResponse extends AbstractResponseEntity
+{
+
+	public function getTransId(): string
+	{
+		return $this->getRequiredString('transId');
+	}
+
+	public function getRedirect(): ?string
+	{
+		return $this->getString('redirect');
+	}
+
+}

src/Entity/Response/PaymentStatusResponse.php

@@ -0,0 +1,93 @@
+<?php declare(strict_types = 1);
+
+namespace Contributte\Comgate\Entity\Response;
+
+class PaymentStatusResponse extends AbstractResponseEntity
+{
+
+	public function getMerchant(): string
+	{
+		return $this->getRequiredString('merchant');
+	}
+
+	public function getTest(): bool
+	{
+		return $this->getRequiredBool('test');
+	}
+
+	public function getPrice(): int
+	{
+		return $this->getRequiredInteger('price');
+	}
+
+	public function getCurr(): string
+	{
+		return $this->getRequiredString('curr');
+	}
+
+	public function getLabel(): string
+	{
+		return $this->getRequiredString('label');
+	}
+
+	public function getRefId(): string
+	{
+		return $this->getRequiredString('refId');
+	}
+
+	public function getPayerId(): ?string
+	{
+		return $this->getString('payerId');
+	}
+
+	public function getMethod(): ?string
+	{
+		return $this->getString('method');
+	}
+
+	public function getAccount(): ?string
+	{
+		return $this->getString('account');
+	}
+
+	public function getEmail(): string
+	{
+		return $this->getRequiredString('email');
+	}
+
+	public function getName(): ?string
+	{
+		return $this->getString('name');
+	}
+
+	public function getTransId(): string
+	{
+		return $this->getRequiredString('transId');
+	}
+
+	public function getSecret(): string
+	{
+		return $this->getRequiredString('secret');
+	}
+
+	public function getStatus(): string
+	{
+		return $this->getRequiredString('status');
+	}
+
+	public function getPayerName(): ?string
+	{
+		return $this->getString('payerName');
+	}
+
+	public function getPayerAcc(): ?string
+	{
+		return $this->getString('payerAcc');
+	}
+
+	public function getFee(): string
+	{
+		return $this->getString('fee', 'unknown');
+	}
+
+}

src/Entity/Response/RecurringPaymentResponse.php

@@ -0,0 +1,13 @@
+<?php declare(strict_types = 1);
+
+namespace Contributte\Comgate\Entity\Response;
+
+class RecurringPaymentResponse extends AbstractResponseEntity
+{
+
+	public function getTransId(): string
+	{
+		return $this->getRequiredString('transId');
+	}
+
+}

src/Entity/Response/RefundResponse.php

@@ -0,0 +1,8 @@
+<?php declare(strict_types = 1);
+
+namespace Contributte\Comgate\Entity\Response;
+
+class RefundResponse extends AbstractResponseEntity
+{
+
+}

src/Entity/Response/StornoResponse.php

@@ -0,0 +1,8 @@
+<?php declare(strict_types = 1);
+
+namespace Contributte\Comgate\Entity\Response;
+
+class StornoResponse extends AbstractResponseEntity
+{
+
+}

src/Exceptions/Runtime/InvalidComGateDataException.php

@@ -0,0 +1,10 @@
+<?php declare(strict_types = 1);
+
+namespace Contributte\Comgate\Exceptions\Runtime;
+
+use Contributte\Comgate\Exceptions\RuntimeException;
+
+class InvalidComGateDataException extends RuntimeException
+{
+
+}

src/Gateway/PaymentService.php

@@ -6,9 +6,13 @@
 use Contributte\Comgate\Entity\PaymentStatus;
 use Contributte\Comgate\Entity\RecurringPayment;
 use Contributte\Comgate\Entity\Refund;
+use Contributte\Comgate\Entity\Response\PaymentResponse;
+use Contributte\Comgate\Entity\Response\PaymentStatusResponse;
+use Contributte\Comgate\Entity\Response\RecurringPaymentResponse;
+use Contributte\Comgate\Entity\Response\RefundResponse;
+use Contributte\Comgate\Entity\Response\StornoResponse;
 use Contributte\Comgate\Entity\Storno;
 use Contributte\Comgate\Http\HttpClient;
-use Contributte\Comgate\Http\Response;
 
 class PaymentService
 {
@@ -21,37 +25,37 @@ public function __construct(HttpClient $client)
 		$this->client = $client;
 	}
 
-	public function create(Payment $payment): Response
+	public function create(Payment $payment): PaymentResponse
 	{
 		$data = $payment->toArray();
 
-		return $this->client->post('create', $data);
+		return new PaymentResponse($this->client->post('create', $data));
 	}
 
-	public function recurring(RecurringPayment $payment): Response
+	public function recurring(RecurringPayment $payment): RecurringPaymentResponse
 	{
 		$data = $payment->toArray();
 
-		return $this->client->post('recurring', $data);
+		return new RecurringPaymentResponse($this->client->post('recurring', $data));
 	}
 
-	public function status(PaymentStatus $status): Response
+	public function status(PaymentStatus $status): PaymentStatusResponse
 	{
-		return $this->client->post('status', $status->toArray());
+		return new PaymentStatusResponse($this->client->post('status', $status->toArray()));
 	}
 
-	public function refund(Refund $payment): Response
+	public function refund(Refund $payment): RefundResponse
 	{
 		$data = $payment->toArray();
 
-		return $this->client->post('refund', $data);
+		return new RefundResponse($this->client->post('refund', $data));
 	}
 
-	public function storno(Storno $payment): Response
+	public function storno(Storno $payment): StornoResponse
 	{
 		$data = $payment->toArray();
 
-		return $this->client->post('cancel', $data);
+		return new StornoResponse($this->client->post('cancel', $data));
 	}
 
 }

src/Http/Response.php

@@ -29,11 +29,6 @@ public function getStatusCode(): int
 		return $this->origin->getStatusCode();
 	}
 
-	public function isOk(): bool
-	{
-		return ($this->getParsedBody()['code'] ?? -1) === '0';
-	}
-
 	/**
 	 * @return mixed[]
 	 */