Merge pull request #251 from mewebstudio/custom-query-support

issue #250 support for custom queries
mewebstudio · Nov 10, 2024 · 970b98c · 970b98c
2 parents e5afa63 + f136422
commit 970b98c
Show file tree

Hide file tree

Showing 79 changed files with 2,574 additions and 71 deletions.
diff --git a/README.md b/README.md
diff --git a/docs/CHANGELOG.md b/docs/CHANGELOG.md
@@ -1,4 +1,15 @@
 # Changelog
+## [1.5.0] - 2024-11-11
+
+### New Features
+- [Custom Query](./CUSTOM-QUERY-EXAMPLE.md) desteği eklendi. (issue #250)
+
+### Changed
+- **VakifKatilimPos** - sipariş detay sorgusunda mapping iyileştirilmesi.
+
+### Fixed
+- Bazı gatewaylarin response'larında bankadan gelen verinin yer almaması.
+
 ## [1.4.0] - 2024-07-02
 
 ### New Features

diff --git a/docs/CUSTOM-QUERY-EXAMPLE.md b/docs/CUSTOM-QUERY-EXAMPLE.md
@@ -0,0 +1,85 @@
+
+### Custom Query
+
+Kütüphanenin desteği olmadığı özel istekleri bu methodla yapabilirsiniz.
+
+```sh
+$ cp ./vendor/mews/pos/config/pos_test.php ./pos_test_ayarlar.php
+```
+
+**config.php (Ayar dosyası)**
+```php
+<?php
+require './vendor/autoload.php';
+
+// API kullanıcı bilgileri
+// AccountFactory'de kullanılacak method Gateway'e göre değişir!!!
+// /examples altındaki _config.php dosyalara bakınız
+// (örn: /examples/tosla/regular/_config.php)
+$account = \Mews\Pos\Factory\AccountFactory::createToslaPosAccount(
+    'tosla',
+    '424342224432',
+    'POS_rwrwwrwr',
+    'POS_4343223',
+);
+$eventDispatcher = new \Symfony\Component\EventDispatcher\EventDispatcher();
+
+try {
+    $config = require __DIR__.'/pos_test_ayarlar.php';
+
+    $pos = \Mews\Pos\Factory\PosFactory::createPosGateway($account, $config, $eventDispatcher);
+
+    // GarantiPos'u test ortamda test edebilmek için zorunlu.
+    $pos->setTestMode(true);
+} catch (\Mews\Pos\Exceptions\BankNotFoundException | \Mews\Pos\Exceptions\BankClassNullException $e) {
+    var_dump($e));
+    exit;
+}
+```
+
+**custom_query.php**
+```php
+<?php
+
+require 'config.php';
+
+/**
+ * requestData içinde API hesap bilgileri, hash verisi ve bazi sabit değerler
+ * eğer zaten bulunmuyorsa kütüphane otomatik ekler.
+ */
+$requestData = [
+    'bin' => 415956,
+];
+
+/** @var \Symfony\Component\EventDispatcher\EventDispatcher $eventDispatcher */
+$eventDispatcher->addListener(\Mews\Pos\Event\RequestDataPreparedEvent::class, function (\Mews\Pos\Event\RequestDataPreparedEvent $event) {
+//    dump($event->getRequestData()); //bankaya gonderilecek veri:
+//
+//    // Burda istek banka API'na gonderilmeden once gonderilecek veriyi degistirebilirsiniz.
+//    // Ornek:
+//    if ($event->getTxType() === PosInterface::TX_TYPE_CUSTOM_QUERY) {
+//        $data         = $event->getRequestData();
+//        $data['abcd'] = '1234';
+//        $event->setRequestData($data);
+//    }
+});
+
+try {
+    $pos->customQuery(
+        $requestData,
+
+        // URL optional, bazı gateway'lerde zorunlu.
+        // Default olarak configdeki query_api ya da payment_api kullanılır.
+        'https://prepentegrasyon.tosla.com/api/Payment/GetCommissionAndInstallmentInfo'
+    );
+} catch (Exception $e) {
+    dd($e);
+}
+
+/**
+ * Bankadan dönen cevap array'e dönüştürülür,
+ * ancak diğer transaction'larda olduğu gibi mapping/normalization yapılmaz.
+ */
+$response = $pos->getResponse();
+var_dump($response);
+```
diff --git a/examples/_common-codes/regular/custom_query.php b/examples/_common-codes/regular/custom_query.php
@@ -0,0 +1,53 @@
+<?php
+
+use Mews\Pos\PosInterface;
+
+$templateTitle = 'Custom Query';
+
+require '_config.php';
+$transaction = PosInterface::TX_TYPE_CUSTOM_QUERY;
+
+require '../../_templates/_header.php';
+
+[$requestData, $apiUrl] = getCustomRequestData();
+
+dump($requestData, $apiUrl);
+
+/** @var \Symfony\Component\EventDispatcher\EventDispatcher $eventDispatcher */
+$eventDispatcher->addListener(\Mews\Pos\Event\RequestDataPreparedEvent::class, function (\Mews\Pos\Event\RequestDataPreparedEvent $event) {
+    dump($event->getRequestData()); //bankaya gonderilecek veri:
+//
+//    // Burda istek banka API'na gonderilmeden once gonderilecek veriyi degistirebilirsiniz.
+//    // Ornek:
+//    if ($event->getTxType() === PosInterface::TX_TYPE_CUSTOM_QUERY) {
+//        $data         = $event->getRequestData();
+//        $data['abcd'] = '1234';
+//        $event->setRequestData($data);
+//    }
+});
+
+
+try {
+    /**
+     * requestData içinde API hesap bilgileri, hash verisi ve bazi sabit değerler
+     * eğer zaten bulunmuyorsa kütüphane otomatik ekler.
+     */
+    $pos->customQuery(
+        $requestData,
+
+        // URL optional, bazı gateway'lerde zorunlu.
+        // Default olarak configdeki query_api ya da payment_api kullanılır.
+        $apiUrl
+    );
+} catch (Exception $e) {
+    dd($e);
+}
+
+/**
+ * Bankadan dönen cevap array'e dönüştürülür,
+ * ancak diğer transaction'larda olduğu gibi mapping/normalization yapılmaz.
+ */
+$response = $pos->getResponse();
+
+require '../../_templates/_simple_response_dump.php';
+require '../../_templates/_footer.php';
diff --git a/examples/_templates/_header.php b/examples/_templates/_header.php
@@ -74,7 +74,7 @@
         </nav>
 </header>
 <div id="wrapper">
-    <div class="container" style="max-width: 640px;">
+    <div class="container" style="max-width: 720px;">
         <h2 class="text-center"><?= $templateTitle; ?></h2>
         <hr>
         <?php if (isset($posClass)): ?>
@@ -133,6 +133,11 @@
                                     <a class="nav-link <?= $transaction === \Mews\Pos\PosInterface::TX_TYPE_HISTORY ? 'active' : ''; ?>" href="<?= $bankTestsUrl ?>/regular/history.php">History</a>
                                 </li>
                             <?php endif; ?>
+                            <?php if ($posClass::isSupportedTransaction(\Mews\Pos\PosInterface::TX_TYPE_CUSTOM_QUERY, \Mews\Pos\PosInterface::MODEL_NON_SECURE)): ?>
+                                <li class="nav-item">
+                                    <a class="nav-link <?= $transaction === \Mews\Pos\PosInterface::TX_TYPE_CUSTOM_QUERY ? 'active' : ''; ?>" href="<?= $bankTestsUrl ?>/regular/custom_query.php">Custom Query</a>
+                                </li>
+                            <?php endif; ?>
                         </ul>
                     </div>
                 </div>

diff --git a/examples/akbankpos/regular/custom_query.php b/examples/akbankpos/regular/custom_query.php
@@ -0,0 +1,27 @@
+<?php
+
+require '../../_common-codes/regular/custom_query.php';
+
+function getCustomRequestData(): array
+{
+    return [
+        [
+            'txnCode'     => '1020',
+            'order'       => [
+                'orderTrackId' => 'ae15a6c8-467e-45de-b24c-b98821a42667',
+            ],
+            'payByLink'   => [
+                'linkTxnCode'       => '3000',
+                'linkTransferType'  => 'SMS',
+                'mobilePhoneNumber' => '5321234567',
+            ],
+            'transaction' => [
+                'amount'       => 1.00,
+                'currencyCode' => 949,
+                'motoInd'      => 0,
+                'installCount' => 1,
+            ],
+        ],
+        null,
+    ];
+}
diff --git a/examples/finansbank-payfor/regular/custom_query.php b/examples/finansbank-payfor/regular/custom_query.php
@@ -0,0 +1,17 @@
+<?php
+
+require '../../_common-codes/regular/custom_query.php';
+
+function getCustomRequestData(): array
+{
+    return [
+        [
+            'SecureType'     => 'Inquiry',
+            'TxnType'        => 'ParaPuanInquiry',
+            'Pan'            => '4155650100416111',
+            'Expiry'         => '0125',
+            'Cvv2'           => '123',
+        ],
+        null,
+    ];
+}
diff --git a/examples/garanti/regular/custom_query.php b/examples/garanti/regular/custom_query.php
@@ -0,0 +1,30 @@
+<?php
+
+require '../../_common-codes/regular/custom_query.php';
+
+function getCustomRequestData(): array
+{
+    return [
+        [
+            'Version'     => 'v0.00',
+            'Customer'    => [
+                'IPAddress'    => '1.1.111.111',
+                'EmailAddress' => '[email protected]',
+            ],
+            'Order'       => [
+                'OrderID'     => 'SISTD5A61F1682E745B28871872383ABBEB1',
+                'GroupID'     => '',
+                'Description' => '',
+            ],
+            'Transaction' => [
+                'Type'   => 'bininq',
+                'Amount' => '1',
+                'BINInq' => [
+                    'Group'    => 'A',
+                    'CardType' => 'A',
+                ],
+            ],
+        ],
+        null,
+    ];
+}
diff --git a/examples/interpos/regular/custom_query.php b/examples/interpos/regular/custom_query.php
@@ -0,0 +1,13 @@
+<?php
+
+require '../../_common-codes/regular/custom_query.php';
+
+function getCustomRequestData(): array
+{
+    return [
+        [
+            'abc' => 'abc',
+        ],
+        null,
+    ];
+}
diff --git a/examples/kuveytpos/regular/custom_query.php b/examples/kuveytpos/regular/custom_query.php
@@ -0,0 +1,13 @@
+<?php
+
+require '../../_common-codes/regular/custom_query.php';
+
+function getCustomRequestData(): array
+{
+    return [
+        [
+            'abc' => 'abc',
+        ],
+        null,
+    ];
+}
diff --git a/examples/payflex-cp-v4/regular/custom_query.php b/examples/payflex-cp-v4/regular/custom_query.php
@@ -0,0 +1,14 @@
+<?php
+
+require '../../_common-codes/regular/custom_query.php';
+
+function getCustomRequestData(): array
+{
+    return [
+        [
+            'abc' => 'abc',
+        ],
+        null,
+    ];
+}
+
diff --git a/examples/payflex-mpi-v4/regular/custom_query.php b/examples/payflex-mpi-v4/regular/custom_query.php
@@ -0,0 +1,14 @@
+<?php
+
+require '../../_common-codes/regular/custom_query.php';
+
+function getCustomRequestData(): array
+{
+    return [
+        [
+            'TransactionType' => 'CampaignSearch',
+            'TransactionId'   => date('Ymd').strtoupper(substr(uniqid(sha1(time()), true), 0, 4)),
+        ],
+        null,
+    ];
+}
diff --git a/examples/payten/regular/custom_query.php b/examples/payten/regular/custom_query.php
@@ -0,0 +1,18 @@
+<?php
+
+require '../../_common-codes/regular/custom_query.php';
+
+function getCustomRequestData(): array
+{
+    return [
+        [
+            'Type'     => 'Query',
+            'Number'   => '4242424242424242',
+            'Expires'  => '10.2028',
+            'Extra'    => [
+                'IMECECARDQUERY' => null,
+            ],
+        ],
+        null,
+    ];
+}
diff --git a/examples/posnet-v1/regular/custom_query.php b/examples/posnet-v1/regular/custom_query.php
@@ -0,0 +1,29 @@
+<?php
+
+require '../../_common-codes/regular/custom_query.php';
+
+function getCustomRequestData(): array
+{
+    return [
+        [
+            'MACParams'              => 'MerchantNo:TerminalNo:CardNo:Cvc2:ExpireDate',
+            'CipheredData'           => null,
+            'DealerData'             => null,
+            'IsEncrypted'            => 'N',
+            'PaymentFacilitatorData' => null,
+            'AdditionalInfoData'     => null,
+            'CardInformationData'    => [
+                'CardHolderName' => 'deneme deneme',
+                'CardNo'         => '5400619360964581',
+                'Cvc2'           => '056',
+                'ExpireDate'     => '2001',
+            ],
+            'IsMailOrder'            => null,
+            'IsRecurring'            => null,
+            'IsTDSecureMerchant'     => 'Y',
+            'PaymentInstrumentType'  => 'CARD',
+            'ThreeDSecureData'       => null,
+        ],
+        'https://epostest.albarakaturk.com.tr/ALBMerchantService/MerchantJSONAPI.svc/PointInquiry',
+    ];
+}
diff --git a/examples/posnet-ykb/regular/custom_query.php b/examples/posnet-ykb/regular/custom_query.php
@@ -0,0 +1,20 @@
+<?php
+
+require '../../_common-codes/regular/custom_query.php';
+
+function getCustomRequestData(): array
+{
+    return [
+        [
+            'pointUsage' => [
+                'amount'       => '250',
+                'lpAmount'     => '40',
+                'ccno'         => '4048090000000001',
+                'currencyCode' => 'TL',
+                'expDate'      => '2411',
+                'orderID'      => 'PKPPislemleriNT000000001',
+            ],
+        ],
+        null,
+    ];
+}
diff --git a/examples/tosla/regular/custom_query.php b/examples/tosla/regular/custom_query.php
@@ -0,0 +1,13 @@
+<?php
+
+require '../../_common-codes/regular/custom_query.php';
+
+function getCustomRequestData(): array
+{
+    return [
+        [
+            'bin' => 415956,
+        ],
+        'https://prepentegrasyon.tosla.com/api/Payment/GetCommissionAndInstallmentInfo',
+    ];
+}