feat: add generic parsing of payment method info at summit order (#338)

* feat: add generic parsing of payment method info at summit order

* Update database/migrations/model/Version20250731013533.php

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

* Update app/Services/Apis/PaymentGateways/StripeApi.php

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

* chore: move all hardcoded values to IPaymentGatewayAPI constants
fix: add code at SummitOrder to set up the cc info ( back compat )

* fix: add alipay type
fix: return of nullable SummitOrder::getPaymentInfoDetails

* feat: add job to ingest missing payment info for order from summits not ended yet

---------

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Author: smarcet

app/Console/Commands/IngestSummitOrderPaymentInfoCommand.php

@@ -0,0 +1,89 @@
+<?php namespace App\Console\Commands;
+/**
+ * Copyright 2019 OpenStack Foundation
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ * http://www.apache.org/licenses/LICENSE-2.0
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ **/
+
+use App\Services\Model\ISummitOrderService;
+use Illuminate\Console\Command;
+use Illuminate\Support\Facades\Log;
+
+/**
+ * Class IngestSummitOrderPaymentInfoCommand
+ * @package App\Console\Commands
+ */
+final class IngestSummitOrderPaymentInfoCommand extends Command {
+
+    /**
+     * The console command name.
+     *
+     * @var string
+     */
+    protected $name = 'summit:registration-orders-payment-info-ingest';
+
+    /**
+     * The name and signature of the console command.
+     *
+     * @var string
+     */
+    protected $signature = 'summit:registration-orders-payment-info-ingest';
+
+
+    /**
+     * The console command description.
+     *
+     * @var string
+     */
+    protected $description = 'Ingest missing payment info from Summit registration Orders';
+
+
+    /**
+     * @var ISummitOrderService
+     */
+    private $order_service;
+
+    /**
+     * RegistrationSummitOrderRevocationCommand constructor.
+     * @param ISummitOrderService $order_service
+     */
+    public function __construct(ISummitOrderService $order_service)
+    {
+        parent::__construct();
+        $this->order_service = $order_service;
+    }
+
+    /**
+     * Execute the console command.
+     *
+     * @return mixed
+     */
+    public function handle()
+    {
+
+
+        try {
+            $this->info("processing summit orders with missing payment info");
+            $start = time();
+
+            $this->order_service->ingestPaymentInfoForRegistrationOrders();
+            $end = time();
+            $delta = $end - $start;
+            $this->info(sprintf("execution call %s seconds", $delta));
+
+
+        } catch (Exception $ex) {
+            Log::error($ex);
+        }
+    }
+
+
+
+}

app/Console/Kernel.php

@@ -50,7 +50,8 @@ class Kernel extends ConsoleKernel
         \App\Console\Commands\CreateTestDBCommand::class,
         \App\Console\Commands\SeedTestDataCommand::class,
         \App\Console\Commands\PublishStreamUpdatesCommand::class,
-        \App\Console\Commands\PurgeSummitsMarkAsDeletedCommand::class
+        \App\Console\Commands\PurgeSummitsMarkAsDeletedCommand::class,
+        \App\Console\Commands\IngestSummitOrderPaymentInfoCommand::class,
     ];
 
     /**
@@ -105,5 +106,9 @@ protected function schedule(Schedule $schedule)
 
         $schedule->command('summit:purge-mark-as-deleted')->everyTwoHours()->withoutOverlapping()->onOneServer();
 
+        // ingest missing payment info
+
+        $schedule->command('summit:registration-orders-payment-info-ingest')->everySixHours()->withoutOverlapping()->onOneServer();
+
     }
 }

app/Jobs/Emails/IMailTemplatesConstants.php

@@ -86,6 +86,8 @@ interface IMailTemplatesConstants
     const order_purchase_date= 'order_purchase_date';
     const order_credit_card_type = 'order_credit_card_type';
     const order_credit_card_4number = 'order_credit_card_4number';
+    const order_payment_info_type = 'order_payment_info_type';
+    const order_payment_info_details = 'order_payment_info_details';
     const order_currency = 'order_currency';
     const order_currency_symbol = 'order_currency_symbol';
     const order_discount = 'order_discount';

app/Jobs/Emails/Registration/RegisteredMemberOrderPaidMail.php

@@ -57,8 +57,12 @@ public function __construct(SummitOrder $order)
         $payload[IMailTemplatesConstants::order_number] = $order->getNumber();
         $payload[IMailTemplatesConstants::order_qr_value] = $order->getQRCode();
         $payload[IMailTemplatesConstants::order_purchase_date] = FormatUtils::getNiceDateMonthDayYearTextual($summit->convertDateFromUTC2TimeZone($order->getCreatedUTC()));
+
+        // payment details
         $payload[IMailTemplatesConstants::order_credit_card_type] = $order->getCreditCardType();
         $payload[IMailTemplatesConstants::order_credit_card_4number] = $order->getCreditCard4Number();
+        $payload[IMailTemplatesConstants::order_payment_info_type] = $order->getPaymentInfoType();
+        $payload[IMailTemplatesConstants::order_payment_info_details] = $order->getPaymentInfoDetails();
 
         $summit_reassign_ticket_till_date = $summit->getReassignTicketTillDateLocal();
         if(!is_null($summit_reassign_ticket_till_date)) {
@@ -133,6 +137,8 @@ public static function getEmailTemplateSchema(): array{
         $payload[IMailTemplatesConstants::order_credit_card_type]['type'] = 'string';
         $payload[IMailTemplatesConstants::order_purchase_date]['type'] = 'string';
         $payload[IMailTemplatesConstants::order_credit_card_4number]['type'] = 'string';
+        $payload[IMailTemplatesConstants::order_payment_info_type]['type'] = 'string';
+        $payload[IMailTemplatesConstants::order_payment_info_details]['type'] = 'array';
         $payload[IMailTemplatesConstants::order_currency]['type'] = 'string';
         $payload[IMailTemplatesConstants::order_currency_symbol]['type'] = 'string';
         $payload[IMailTemplatesConstants::order_raw_amount]['type'] = 'string';

app/ModelSerializers/Summit/Registration/SummitOrderReservationSerializer.php

@@ -39,6 +39,8 @@ class SummitOrderReservationSerializer extends SummitOrderBaseSerializer
         'TotalRefundedAmountInCents' => 'total_refunded_amount_in_cents:json_int',
         'CreditCardType' => 'credit_card_type:json_string',
         'CreditCard4Number' => 'credit_card_4number:json_string',
+        'PaymentInfoType' => 'payment_info_type:json_string',
+        'PaymentInfoDetails' => 'payment_info_details:json_string',
     ];
 
     protected static $allowed_relations = [

app/Models/Foundation/Summit/Registration/SummitOrder.php

@@ -15,6 +15,7 @@
 use App\Events\PaymentSummitRegistrationOrderConfirmed;
 use App\libs\Utils\PunnyCodeHelper;
 use App\Models\Utils\Traits\FinancialTrait;
+use App\Services\Apis\IPaymentGatewayAPI;
 use Doctrine\Common\Collections\Criteria;
 use Illuminate\Support\Facades\Config;
 use Illuminate\Support\Facades\Event;
@@ -26,6 +27,7 @@
 use models\utils\SilverstripeBaseModel;
 use Doctrine\Common\Collections\ArrayCollection;
 use Doctrine\ORM\Mapping as ORM;
+use function Psy\debug;
 
 /**
  * @package models\summit
@@ -214,6 +216,19 @@ class SummitOrder extends SilverstripeBaseModel implements IQREntity
     #[ORM\Column(name: 'CreditCard4Numbers', type: 'string')]
     private $credit_card_4numbers;
 
+    /**
+     * @var string
+     */
+    #[ORM\Column(name: 'PaymentInfoType', type: 'string')]
+    private $payment_info_type;
+
+    /**
+     * @var array
+     */
+    #[ORM\Column(name: 'PaymentInfoDetails', type: 'json')]
+    private $payment_info_details;
+
+
     /**
      * SummitOrder constructor.
      */
@@ -224,6 +239,8 @@ public function __construct()
         $this->extra_question_answers = new ArrayCollection();
         $this->status = IOrderConstants::ReservedStatus;
         $this->payment_method = IOrderConstants::OnlinePaymentMethod;
+        $this->payment_info_details = [];
+        $this->payment_info_type = null;
     }
 
     public function setPaymentMethodOffline()
@@ -304,13 +321,17 @@ public function getStatus(): string
         return $this->status;
     }
 
-    public function setPaidStatus()
+    public function setPaidStatus():void
     {
         $this->status = IOrderConstants::PaidStatus;
         $this->approved_payment_date = new \DateTime('now', new \DateTimeZone('UTC'));
     }
 
-    public function setPaid(array $payload = null)
+    /**
+     * @param array|null $payload
+     * @return void
+     */
+    public function setPaid(array $payload = null):void
     {
         Log::debug(sprintf("SummitOrder::setPaid order %s", $this->id));
         if ($this->isPaid()) {
@@ -324,21 +345,7 @@ public function setPaid(array $payload = null)
             $ticket->setPaid();
         }
 
-        if (!is_null($payload) && isset($payload['order_credit_card_type']) && isset($payload['order_credit_card_4numbers'])) {
-
-            Log::debug
-            (
-                sprintf
-                (
-                    "SummitOrder::setPaid order %s setting credit card info %s",
-                    $this->id,
-                    json_encode($payload)
-                )
-            );
-
-            $this->credit_card_type = $payload['order_credit_card_type'];
-            $this->credit_card_4numbers = $payload['order_credit_card_4numbers'];
-        }
+        $this->setPaymentInfo($payload);
 
         Event::dispatch(new PaymentSummitRegistrationOrderConfirmed($this->getId()));
     }
@@ -1245,4 +1252,43 @@ public function getCreditCard4Number():?string
     {
         return $this->credit_card_4numbers;
     }
+
+    public function getPaymentInfoType(): ?string
+    {
+        return $this->payment_info_type;
+    }
+
+
+    public function getPaymentInfoDetails(): ?array
+    {
+        return $this->payment_info_details;
+    }
+
+    /**
+     * @param array|null $payment_info
+     * @return void
+     */
+    public function setPaymentInfo(array $payment_info = null): void{
+        if (!is_null($payment_info) && isset($payment_info[IPaymentGatewayAPI::PaymentInfo])) {
+
+            Log::debug
+            (
+                sprintf
+                (
+                    "SummitOrder::setPaymentInfo order %s setting payment info %s",
+                    $this->id,
+                    json_encode($payment_info)
+                )
+            );
+
+            $this->payment_info_type = $payment_info[IPaymentGatewayAPI::PaymentInfo][IPaymentGatewayAPI::PaymentInfo_Type] ?? null;
+            $this->payment_info_details = $payment_info[IPaymentGatewayAPI::PaymentInfo][IPaymentGatewayAPI::PaymentInfo_Details] ?? [];
+
+            if($this->payment_info_type === IPaymentGatewayAPI::PaymentInfo_Type_Card){
+                // back compat
+                $this->credit_card_type = $this->payment_info_details[IPaymentGatewayAPI::PaymentInfo_Type_Card_Brand] ?? null;
+                $this->credit_card_4numbers = $this->payment_info_details[IPaymentGatewayAPI::PaymentInfo_Type_Card_Last4] ?? null;
+            }
+        }
+    }
 }

app/Models/Foundation/Summit/Repositories/ISummitOrderRepository.php

@@ -93,4 +93,12 @@ public function getAllOrderIdsThatNeedsEmailActionReminder(Summit $summit, Pagin
      * @throws \Doctrine\DBAL\Driver\Exception
      */
     public function deleteAllBySummit(int $summit_id):bool;
+
+    /**
+     * @param Summit $summit
+     * @param PagingInfo $paging_info
+     * @return array
+     */
+    public function getAllOrderIdsThatNeedsPaymentInfo(Summit $summit, PagingInfo $paging_info):array;
+
 }

app/Repositories/Summit/DoctrineSummitOrderRepository.php

@@ -431,4 +431,32 @@ public function getAllOrderIdsThatNeedsEmailActionReminder(Summit $summit, Pagin
         $res = $query->getQuery()->getArrayResult();
         return array_column($res, 'id');
     }
+
+    /**
+     * @param Summit $summit
+     * @param PagingInfo $paging_info
+     * @return array
+     */
+    public function getAllOrderIdsThatNeedsPaymentInfo(Summit $summit, PagingInfo $paging_info): array
+    {
+        $query = $this->getEntityManager()
+            ->createQueryBuilder()
+            ->distinct(true)
+            ->select("e.id")
+            ->from($this->getBaseEntity(), "e")
+            ->join("e.summit","s")
+            ->where('e.status = :order_status')
+            ->andWhere('s.id = :summit_id')
+            ->andWhere("e.payment_info_type is null");
+
+        $query->setParameter("order_status", IOrderConstants::PaidStatus);
+        $query->setParameter("summit_id", $summit->getId());
+
+        $query= $query
+            ->setFirstResult($paging_info->getOffset())
+            ->setMaxResults($paging_info->getPerPage());
+
+        $res = $query->getQuery()->getArrayResult();
+        return array_column($res, 'id');
+    }
 }

app/Services/Apis/IPaymentGatewayAPI.php

@@ -29,6 +29,21 @@ class CartAlreadyPaidException extends Exception {
  */
 interface IPaymentGatewayAPI
 {
+    public const string PaymentInfo = 'payment_info';
+    public const string PaymentInfo_Type = 'type';
+
+    public const string PaymentInfo_Details = 'details';
+
+    public const string PaymentInfo_Type_Card = 'card';
+
+    public const string PaymentInfo_Type_Card_Brand = 'brand';
+    public const string PaymentInfo_Type_Card_Last4 = 'last4';
+    public const string PaymentInfo_Type_ACH = 'us_bank_account';
+
+    public const string PaymentInfo_Type_AliPay = 'alipay';
+
+    public const string PaymentInfo_Type_Link = 'link';
+
     /**
      * @param SummitOrder $order
      * @throws ValidationException
@@ -100,12 +115,7 @@ public function getCartStatus(string $cart_id):?string;
      * @param string $cart_id
      * @return array|null
      */
-    public function getCartCreditCardInfo(string $cart_id):?array;
-    /**
-     * @param array $payload
-     * @return array
-     */
-    public function getCreditCardInfo(array $payload): array;
+    public function getPaymentDetailsInfo(string $cart_id):?array;
 
     /**
      * @param string $status

app/Services/Apis/PaymentGateways/LawPayApi.php

@@ -539,12 +539,8 @@ public function clearWebHooks():void{
         }
     }
 
-    public function getCreditCardInfo(array $payload): array
-    {
-        return [];
-    }
 
-    public function getCartCreditCardInfo(string $cart_id): ?array
+    public function getPaymentDetailsInfo(string $cart_id): ?array
     {
         return [];
     }