feat: add supports for vpos

Author: bernard-ng

CHANGELOG.md

@@ -0,0 +1,18 @@
+# CHANGELOG
+
+This changelog references the relevant changes (bug and security fixes) done
+
+### 2.0.0 [unreleased]
+- Breaking Change: `pay` supports both `vpos` and `mobile` request
+- Added: `vpos` and `mobile` method to `Client`
+- Added: `VposResponse`, `Request`, `VposRequest`, `MobileRequest` class
+- Fixed: allow `$message` to be an empty string in `CheckResponse`
+- Fixed: `token` and `merchant` are now SensitiveParameters
+- Added: Support for `check`, `vpos`, `mobile` urls in `Environment`,
+- Removed: `getPaymentBaseUrl` method in `Environment`
+
+### 1.0.1
+- Fixed: allow `$message` to be an empty string in `PaymentResponse`
+
+### 1.0.0
+- Initial release

README.md

@@ -36,11 +36,11 @@ $flexpay = new Flexpay(
 ```
 
 ### Create a Payment (Intention)
+
 ```php
-use Devscast\Flexpay\PaymentEntry;
-use Devscast\Flexpay\Data\Currency;
+use Devscast\Flexpay\Data\Currency;use Devscast\Flexpay\Request\MobileRequest;
 
-$entry = new PaymentEntry(
+$entry = new MobileRequest(
     amount: 10, // 10 USD
     currency: Currency::USD,
     phone: "243999999999", // mandatory for mobile money

src/Client.php

@@ -4,11 +4,14 @@
 
 namespace Devscast\Flexpay;
 
-use Devscast\Flexpay\Data\Method;
 use Devscast\Flexpay\Exception\NetworkException;
+use Devscast\Flexpay\Request\MobileRequest;
+use Devscast\Flexpay\Request\Request;
+use Devscast\Flexpay\Request\VposRequest;
 use Devscast\Flexpay\Response\CheckResponse;
 use Devscast\Flexpay\Response\FlexpayResponse;
 use Devscast\Flexpay\Response\PaymentResponse;
+use Devscast\Flexpay\Response\VposResponse;
 use Symfony\Component\HttpClient\HttpClient;
 use Symfony\Component\HttpClient\Retry\GenericRetryStrategy;
 use Symfony\Component\HttpClient\RetryableHttpClient;
@@ -23,20 +26,22 @@
  *
  * @author bernard-ng <bernard@devscast.tech>
  */
-final readonly class Client
+final class Client
 {
     private HttpClientInterface $http;
 
     private Serializer $serializer;
 
     public function __construct(
-        public Credential $credential,
-        public Environment $environment = Environment::SANDBOX
+        public readonly Credential $credential,
+        public readonly Environment $environment = Environment::SANDBOX,
     ) {
-        $this->serializer = new Serializer(normalizers: [
-            new BackedEnumNormalizer(),
-            new ObjectNormalizer(),
-        ]);
+        $this->serializer = new Serializer(
+            normalizers: [
+                new ObjectNormalizer(),
+                new BackedEnumNormalizer(),
+            ]
+        );
 
         $this->http = new RetryableHttpClient(
             client: HttpClient::create(
@@ -53,33 +58,21 @@ public function __construct(
     }
 
     /**
-     * Cette interface permet d’envoyer une requête de redirection de paiement à FlexPay
+     * Permet d'envoyer une directement intention de paiement sur le mobile money du client
      *
-     * @throws NetworkException quand une erreur réseau survient
-     * @throws \InvalidArgumentException quand le numéro de téléphone n'est pas fourni pour un paiement mobile
+     * @throws NetworkException
      */
-    public function pay(PaymentEntry $entry, Method $method = Method::MOBILE): PaymentResponse
+    public function mobile(MobileRequest $request): PaymentResponse
     {
-        /**
-         * Définit ici, pour éviter de préciser manuellement le marchant à chaque fois
-         */
-        $entry->setMerchant($this->credential->merchant);
-
-        if ($method === Method::MOBILE && $entry->phone === null) {
-            throw new \InvalidArgumentException('phone number should be provided for mobile payment');
-        }
+        $request->setCredential($this->credential);
 
         try {
             /** @var PaymentResponse $response */
             $response = $this->getMappedData(
                 type: PaymentResponse::class,
-                data: $this->http->request(
-                    method: 'POST',
-                    url: sprintf('%s/paymentService', $this->environment->getBaseUrl()),
-                    options: [
-                        'json' => $this->serializer->normalize($entry),
-                    ]
-                )->toArray()
+                data: $this->http->request('POST', $this->environment->getMobilePaymentUrl(), [
+                    'json' => $request->getPayload(),
+                ])->toArray()
             );
 
             return $response;
@@ -89,14 +82,41 @@ public function pay(PaymentEntry $entry, Method $method = Method::MOBILE): Payme
     }
 
     /**
-     * Cette interface permet d'obtenir une réponse de paiement provenant de FlexPay
+     * Créer une URL unique de paiement via le gateway de Flexpay
+     * Cela permet d'utiliser différente méthode de paiement
+     * y compris une carte bancaire (VISA, MASTERCARD, etc.)
+     *
+     * @throws NetworkException
      */
-    public function handleCallback(array $data): PaymentResponse
+    public function vpos(VposRequest $request): VposResponse
     {
-        /** @var PaymentResponse $payment */
-        $payment = $this->getMappedData(PaymentResponse::class, $data);
+        $request->setCredential($this->credential);
 
-        return $payment;
+        try {
+            dd(
+                /** @var VposResponse $response */
+                $response = $this->getMappedData(
+                    type: VposResponse::class,
+                    data: $this->http->request('POST', $this->environment->getVposAskUrl(), [
+                        'json' => $request->getPayload(),
+                    ])->toArray()
+                )
+            );
+        } catch (\Throwable $e) {
+            $this->createExceptionFromResponse($e);
+        }
+    }
+
+    /**
+     * @throws NetworkException
+     */
+    public function pay(Request $request): PaymentResponse|VposResponse
+    {
+        return match (true) {
+            $request instanceof MobileRequest => $this->mobile($request),
+            $request instanceof VposRequest => $this->vpos($request),
+            default => throw new \RuntimeException('Unsupported request')
+        };
     }
 
     /**
@@ -112,10 +132,9 @@ public function check(string $orderNumber): CheckResponse
             /** @var CheckResponse $response */
             $response = $this->getMappedData(
                 type: CheckResponse::class,
-                data: $this->http->request(
-                    method: 'GET',
-                    url: sprintf('%s/check/%s', $this->environment->getBaseUrl(), $orderNumber)
-                )->toArray()
+                data: $this->http
+                    ->request('GET', $this->environment->getCheckStatusUrl($orderNumber))
+                    ->toArray()
             );
 
             return $response;
@@ -124,6 +143,17 @@ public function check(string $orderNumber): CheckResponse
         }
     }
 
+    /**
+     * Cette interface permet d'obtenir une réponse de paiement provenant de FlexPay
+     */
+    public function handleCallback(array $data): PaymentResponse
+    {
+        /** @var PaymentResponse $payment */
+        $payment = $this->getMappedData(PaymentResponse::class, $data);
+
+        return $payment;
+    }
+
     /**
      * @psalm-param class-string<FlexpayResponse> $type
      */

src/Credential.php

@@ -14,23 +14,14 @@
 final readonly class Credential
 {
     /**
-     * Le token d’autorisation
+     * @param string $token Le token d’autorisation
+     * @param string $merchant Le code Marchand FlexPay, ex: ZANDO
      */
-    public string $token;
-
-    /**
-     * Le code Marchand FlexPay, ex: ZANDO
-     */
-    public string $merchant;
-
     public function __construct(
-        #[\SensitiveParameter] string $token,
-        #[\SensitiveParameter] string $merchant,
+        #[\SensitiveParameter] public string $token,
+        #[\SensitiveParameter] public string $merchant,
     ) {
-        Assert::notEmpty($token, 'The authorization token cannot be empty');
-        Assert::notEmpty($merchant, 'Merchant cannot be empty');
-
-        $this->token = $token;
-        $this->merchant = $merchant;
+        Assert::notEmpty($this->token, 'The authorization token cannot be empty');
+        Assert::notEmpty($this->merchant, 'Merchant cannot be empty');
     }
 }

src/Environment.php

@@ -14,19 +14,40 @@ enum Environment: string
     case LIVE = 'prod';
     case SANDBOX = 'dev';
 
-    public function getBaseUrl(): string
+    public function getVposAskUrl(): string
     {
         return match ($this) {
-            self::LIVE => 'https://backend.flexpay.cd/api/rest/v1',
-            self::SANDBOX => 'https://beta-backend.flexpay.cd/api/rest/v1',
+            self::LIVE, self::SANDBOX => sprintf('%s/vpos/ask', $this->getBaseUrl()),
+        };
+    }
+
+    public function getMobilePaymentUrl(): string
+    {
+        return match ($this) {
+            self::LIVE, self::SANDBOX => sprintf('%s/paymentService', $this->getBaseUrl()),
         };
     }
 
-    public function getCardPaymentBaseUrl(): string
+    public function getVposPaymentUrl(string $orderNumber): string
     {
         return match ($this) {
-            self::LIVE => 'https://cardpayment.flexpay.cd/v1.1/pay',
-            self::SANDBOX => 'https://beta-cardpayment.flexpay.cd/v1.1/pay'
+            self::LIVE => sprintf('https://cardpayment.flexpay.cd/vpos/pay/%s', $orderNumber),
+            self::SANDBOX => sprintf('https://beta-cardpayment.flexpay.cd/vpos/pay/%s', $orderNumber),
+        };
+    }
+
+    public function getCheckStatusUrl(string $orderNumber): string
+    {
+        return match ($this) {
+            self::LIVE, self::SANDBOX => sprintf('%s/check/%s', $this->getBaseUrl(), $orderNumber),
+        };
+    }
+
+    private function getBaseUrl(): string
+    {
+        return match ($this) {
+            self::LIVE => 'https://backend.flexpay.cd/api/rest/v1',
+            self::SANDBOX => 'https://beta-backend.flexpay.cd/api/rest/v1',
         };
     }
 }

src/Exception/NetworkException.php

@@ -19,7 +19,7 @@ public function __construct(
         public ?int $status = null
     ) {
         if ($this->status !== null) {
-            parent::__construct($message . ' (HTTP ' . $status . '/' . $type . ')');
+            parent::__construct(sprintf('%s (HTTP %d/%s)', $message, $status, $type));
         } else {
             parent::__construct($message);
         }