rename gateway to driver

myagmarsurensedjav · Aug 19, 2023 · c0ad4c2 · c0ad4c2
1 parent 32e4784
commit c0ad4c2
Show file tree

Hide file tree

Showing 27 changed files with 137 additions and 137 deletions.
diff --git a/README.md b/README.md
@@ -35,7 +35,7 @@ This is the contents of the published config file:
 return [
     'default' => env('SIMPLE_PAYMENT_DEFAULT', 'qpay'),
 
-    'gateways' => [
+    'drivers' => [
         'qpay' => [
             'env' => env('QPAY_ENV', 'fake'),
             'username' => env('QPAY_USERNAME'),
@@ -78,7 +78,7 @@ Route::get('/invoices/{invoice}/payment', function (Invoice $invoice) {
 });
 ```
 
-If you need specific gateway, you can use `driver` method.
+If you need specific driver, you can use `driver` method.
 
 ```php
 SimplePayment::driver('socialpay')->create($invoice);

diff --git a/config/simple-payment.php b/config/simple-payment.php
@@ -6,7 +6,7 @@
 return [
     'default' => env('SIMPLE_PAYMENT_DEFAULT', 'qpay'),
 
-    'gateways' => [
+    'drivers' => [
         'qpay' => [
             'env' => env('QPAY_ENV', 'fake'),
             'username' => env('QPAY_USERNAME'),

diff --git a/database/migrations/create_payments_table.php.stub b/database/migrations/create_payments_table.php.stub
@@ -10,16 +10,16 @@ return new class extends Migration
     {
         Schema::create('payments', function (Blueprint $table) {
             $table->uuid('id')->primary();
-            $table->string('gateway', 20)->index();
+            $table->string('driver', 20)->index();
             $table->string('status');
             $table->decimal('amount', 12, 2);
             $table->foreignIdFor(config('simple-payment.user_model'), 'user_id')->nullable();
             $table->uuidMorphs('payable');
             $table->string('description');
-            $table->string('gateway_transaction_id')->nullable();
-            $table->decimal('gateway_transaction_fee', 12, 2)->nullable();
+            $table->string('transaction_id')->nullable();
+            $table->decimal('transaction_fee', 12, 2)->nullable();
             $table->text('error_message')->nullable();
-            $table->json('gateway_data')->nullable();
+            $table->json('driver_data')->nullable();
             $table->timestamp('expires_at')->nullable();
             $table->timestamp('paid_at')->nullable();
             $table->timestamp('verified_at')->nullable();

diff --git a/src/Actions/CreatePayment.php b/src/Actions/CreatePayment.php
@@ -8,28 +8,28 @@
 use MyagmarsurenSedjav\SimplePayment\Contracts\CanBePaidPartially;
 use MyagmarsurenSedjav\SimplePayment\Contracts\Payable;
 use MyagmarsurenSedjav\SimplePayment\Contracts\Results\WithExpiresAt;
-use MyagmarsurenSedjav\SimplePayment\Contracts\Results\WithGatewayData;
+use MyagmarsurenSedjav\SimplePayment\Contracts\Results\WithDriverData;
 use MyagmarsurenSedjav\SimplePayment\Contracts\Results\WithTransactionFee;
 use MyagmarsurenSedjav\SimplePayment\Contracts\Results\WithTransactionId;
 use MyagmarsurenSedjav\SimplePayment\Exceptions\NothingToPay;
 use MyagmarsurenSedjav\SimplePayment\Facades\SimplePayment;
-use MyagmarsurenSedjav\SimplePayment\Gateways\AbstractGateway;
+use MyagmarsurenSedjav\SimplePayment\Drivers\AbstractDriver;
 use MyagmarsurenSedjav\SimplePayment\PendingPayment;
 
 class CreatePayment
 {
-    public function __invoke(AbstractGateway $gateway, Payable $payable, array $options = []): PendingPayment
+    public function __invoke(AbstractDriver $driver, Payable $payable, array $options = []): PendingPayment
     {
         if ($payable->getPaymentAmount() <= 0) {
             throw new NothingToPay(__('Payment amount cannot be zero.'));
         }
 
         $this->guardAgainstInvalidAmountOption($options, $payable);
 
-        return DB::transaction(fn () => $this->process($gateway, $payable, $options));
+        return DB::transaction(fn () => $this->process($driver, $payable, $options));
     }
 
-    private function process(AbstractGateway $gateway, Payable $payable, array $options = []): PendingPayment
+    private function process(AbstractDriver $driver, Payable $payable, array $options = []): PendingPayment
     {
         // Урьдчилаад хүлээгдэж байгаа төлбөрийг өгөгдлийн санд үүсгээд өгнө.
         $payment = SimplePayment::paymentModel()::create([
@@ -38,29 +38,29 @@ private function process(AbstractGateway $gateway, Payable $payable, array $opti
             'description' => $payable->getPaymentDescription(),
             'payable_type' => $payable->getMorphClass(),
             'payable_id' => $payable->getKey(),
-            'gateway' => $gateway->name(),
+            'driver' => $driver->name(),
             'options' => $options,
         ]);
 
         // Төлбөрийг тухайн төлбөрийн гарцад бүртгэж өгнө.
-        $pendingPayment = $gateway->register($payment, $options);
+        $pendingPayment = $driver->register($payment, $options);
 
         $attributesShouldBeUpdated = [];
 
         // Хэрэв тухайн төлбөрийн хэлбэр нь гүйлгээг шалгахад өөрийн гүйлгээний
         // дугаарыг ашиглахыг шаарддаг бол хадгалж авах хэрэгтэй болно.
         if ($pendingPayment instanceof WithTransactionId) {
-            $attributesShouldBeUpdated['gateway_transaction_id'] = $pendingPayment->getTransactionId();
+            $attributesShouldBeUpdated['transaction_id'] = $pendingPayment->getTransactionId();
         }
 
         // Тухайн төлбөрийн гарц гүйлгээг хийхэд шимтгэл авдаг бол хадгалж авна.
         if ($pendingPayment instanceof WithTransactionFee) {
-            $attributesShouldBeUpdated['gateway_transaction_fee'] = $pendingPayment->getTransactionFee();
+            $attributesShouldBeUpdated['transaction_fee'] = $pendingPayment->getTransactionFee();
         }
 
         // Тухайн төлбөрийн гарц нэмэлт өгөгдөлтэй бол хадгалж авна.
-        if ($pendingPayment instanceof WithGatewayData) {
-            $attributesShouldBeUpdated['gateway_data'] = $pendingPayment->getGatewayData();
+        if ($pendingPayment instanceof WithDriverData) {
+            $attributesShouldBeUpdated['driver_data'] = $pendingPayment->getDriverData();
         }
 
         // Тухайн төлбөрийн гарц дуусах хугацаатай бол хадгалж авна.

diff --git a/src/Actions/VerifyPayment.php b/src/Actions/VerifyPayment.php
@@ -4,14 +4,14 @@
 
 use MyagmarsurenSedjav\SimplePayment\CheckedPayment;
 use MyagmarsurenSedjav\SimplePayment\Events\PaymentWasMade;
-use MyagmarsurenSedjav\SimplePayment\Gateways\AbstractGateway;
+use MyagmarsurenSedjav\SimplePayment\Drivers\AbstractDriver;
 use MyagmarsurenSedjav\SimplePayment\Payment;
 
 class VerifyPayment
 {
-    public function __invoke(AbstractGateway $gateway, Payment $payment): CheckedPayment
+    public function __invoke(AbstractDriver $driver, Payment $payment): CheckedPayment
     {
-        $result = $gateway->check($payment);
+        $result = $driver->check($payment);
 
         $attributesShouldBeUpdated = [
             'status' => $result->status(),

diff --git a/src/CheckedPayment.php b/src/CheckedPayment.php
@@ -7,7 +7,7 @@
 
 abstract class CheckedPayment implements Arrayable
 {
-    public function __construct(public Payment $payment, public array $gatewayResponse = [])
+    public function __construct(public Payment $payment, public array $driverResponse = [])
     {
     }
 
@@ -26,7 +26,7 @@ public function toArray(): array
             'status' => $this->status(),
             'error_message' => $this->errorMessage(),
             'payment' => $this->payment->toArray(),
-            'gateway_response' => $this->gatewayResponse,
+            'driver_response' => $this->driverResponse,
         ];
     }
 }
diff --git a/src/Concerns/InteractsWithPayments.php b/src/Concerns/InteractsWithPayments.php
@@ -14,8 +14,8 @@ public function payments(): MorphMany
         return $this->morphMany(SimplePayment::paymentModel(), 'payable');
     }
 
-    public function createPayment(string $gateway): Payment
+    public function createPayment(string $driver): Payment
     {
-        return app(CreatePayment::class)($gateway, $this);
+        return app(CreatePayment::class)($driver, $this);
     }
 }
diff --git a/src/Contracts/Results/WithGatewayData.php → src/Contracts/Results/WithDriverData.php b/src/Contracts/Results/WithGatewayData.php → src/Contracts/Results/WithDriverData.php
@@ -2,7 +2,7 @@
 
 namespace MyagmarsurenSedjav\SimplePayment\Contracts\Results;
 
-interface WithGatewayData
+interface WithDriverData
 {
-    public function getGatewayData(): array;
+    public function getDriverData(): array;
 }
diff --git a/src/Gateways/AbstractGateway.php → src/Drivers/AbstractDriver.php b/src/Gateways/AbstractGateway.php → src/Drivers/AbstractDriver.php
@@ -1,6 +1,6 @@
 <?php
 
-namespace MyagmarsurenSedjav\SimplePayment\Gateways;
+namespace MyagmarsurenSedjav\SimplePayment\Drivers;
 
 use MyagmarsurenSedjav\SimplePayment\Actions\CreatePayment;
 use MyagmarsurenSedjav\SimplePayment\Actions\VerifyPayment;
@@ -9,7 +9,7 @@
 use MyagmarsurenSedjav\SimplePayment\Payment;
 use MyagmarsurenSedjav\SimplePayment\PendingPayment;
 
-abstract class AbstractGateway
+abstract class AbstractDriver
 {
     public function __construct(public readonly string $name, protected readonly array $config)
     {

diff --git a/src/Gateways/Golomt/GolomtCheckedPayment.php → src/Drivers/Golomt/GolomtCheckedPayment.php b/src/Gateways/Golomt/GolomtCheckedPayment.php → src/Drivers/Golomt/GolomtCheckedPayment.php
@@ -1,6 +1,6 @@
 <?php
 
-namespace MyagmarsurenSedjav\SimplePayment\Gateways\Golomt;
+namespace MyagmarsurenSedjav\SimplePayment\Drivers\Golomt;
 
 use Illuminate\Support\Arr;
 use MyagmarsurenSedjav\SimplePayment\CheckedPayment;
@@ -25,11 +25,11 @@ public function status(): PaymentStatus
 
     public function errorMessage(): string|null
     {
-        return Arr::get($this->gatewayResponse, 'errorDesc');
+        return Arr::get($this->driverResponse, 'errorDesc');
     }
 
     private function errorCode()
     {
-        return Arr::get($this->gatewayResponse, 'errorCode');
+        return Arr::get($this->driverResponse, 'errorCode');
     }
 }
diff --git a/src/Gateways/Golomt/GolomtClient.php → src/Drivers/Golomt/GolomtClient.php b/src/Gateways/Golomt/GolomtClient.php → src/Drivers/Golomt/GolomtClient.php
@@ -1,6 +1,6 @@
 <?php
 
-namespace MyagmarsurenSedjav\SimplePayment\Gateways\Golomt;
+namespace MyagmarsurenSedjav\SimplePayment\Drivers\Golomt;
 
 use Illuminate\Http\Client\PendingRequest;
 use Illuminate\Support\Facades\Http;

diff --git a/src/Gateways/Golomt/GolomtGateway.php → src/Drivers/Golomt/GolomtDriver.php b/src/Gateways/Golomt/GolomtGateway.php → src/Drivers/Golomt/GolomtDriver.php
@@ -1,13 +1,13 @@
 <?php
 
-namespace MyagmarsurenSedjav\SimplePayment\Gateways\Golomt;
+namespace MyagmarsurenSedjav\SimplePayment\Drivers\Golomt;
 
 use MyagmarsurenSedjav\SimplePayment\CheckedPayment;
-use MyagmarsurenSedjav\SimplePayment\Gateways\AbstractGateway;
+use MyagmarsurenSedjav\SimplePayment\Drivers\AbstractDriver;
 use MyagmarsurenSedjav\SimplePayment\Payment;
 use MyagmarsurenSedjav\SimplePayment\PendingPayment;
 
-class GolomtGateway extends AbstractGateway
+class GolomtDriver extends AbstractDriver
 {
     private GolomtClient $client;
 

diff --git a/src/Gateways/Golomt/GolomtPendingPayment.php → src/Drivers/Golomt/GolomtPendingPayment.php b/src/Gateways/Golomt/GolomtPendingPayment.php → src/Drivers/Golomt/GolomtPendingPayment.php
@@ -1,6 +1,6 @@
 <?php
 
-namespace MyagmarsurenSedjav\SimplePayment\Gateways\Golomt;
+namespace MyagmarsurenSedjav\SimplePayment\Drivers\Golomt;
 
 use Carbon\Carbon;
 use MyagmarsurenSedjav\SimplePayment\Contracts\Results\ShouldRedirect;
@@ -26,7 +26,7 @@ public function asSocialPay(): static
 
     public function getTransactionId(): string
     {
-        return $this->gatewayResponse['invoice'];
+        return $this->driverResponse['invoice'];
     }
 
     public function getExpiresAt(): Carbon

diff --git a/src/Gateways/Qpay/QpayCheckedPayment.php → src/Drivers/Qpay/QpayCheckedPayment.php b/src/Gateways/Qpay/QpayCheckedPayment.php → src/Drivers/Qpay/QpayCheckedPayment.php
@@ -1,6 +1,6 @@
 <?php
 
-namespace MyagmarsurenSedjav\SimplePayment\Gateways\Qpay;
+namespace MyagmarsurenSedjav\SimplePayment\Drivers\Qpay;
 
 use Illuminate\Support\Arr;
 use MyagmarsurenSedjav\SimplePayment\CheckedPayment;
@@ -10,8 +10,8 @@ class QpayCheckedPayment extends CheckedPayment
 {
     private function isPaidOnQpay(): bool
     {
-        return Arr::get($this->gatewayResponse, 'count') > 0
-            && Arr::get($this->gatewayResponse, 'paid_amount') > 0;
+        return Arr::get($this->driverResponse, 'count') > 0
+            && Arr::get($this->driverResponse, 'paid_amount') > 0;
     }
 
     public function status(): PaymentStatus

diff --git a/src/Gateways/Qpay/QpayClient.php → src/Drivers/Qpay/QpayClient.php b/src/Gateways/Qpay/QpayClient.php → src/Drivers/Qpay/QpayClient.php
@@ -1,6 +1,6 @@
 <?php
 
-namespace MyagmarsurenSedjav\SimplePayment\Gateways\Qpay;
+namespace MyagmarsurenSedjav\SimplePayment\Drivers\Qpay;
 
 use Illuminate\Support\Facades\Cache;
 use Illuminate\Support\Facades\Http;

diff --git a/src/Gateways/Qpay/QpayGateway.php → src/Drivers/Qpay/QpayDriver.php b/src/Gateways/Qpay/QpayGateway.php → src/Drivers/Qpay/QpayDriver.php
@@ -1,13 +1,13 @@
 <?php
 
-namespace MyagmarsurenSedjav\SimplePayment\Gateways\Qpay;
+namespace MyagmarsurenSedjav\SimplePayment\Drivers\Qpay;
 
 use MyagmarsurenSedjav\SimplePayment\CheckedPayment;
-use MyagmarsurenSedjav\SimplePayment\Gateways\AbstractGateway;
+use MyagmarsurenSedjav\SimplePayment\Drivers\AbstractDriver;
 use MyagmarsurenSedjav\SimplePayment\Payment;
 use MyagmarsurenSedjav\SimplePayment\PendingPayment;
 
-class QpayGateway extends AbstractGateway
+class QpayDriver extends AbstractDriver
 {
     private QpayClient $client;
 
@@ -33,7 +33,7 @@ public function register(Payment $payment, array $options): PendingPayment
 
     public function check(Payment $payment): CheckedPayment
     {
-        $checkedPayment = $this->client->checkPayment($payment->gateway_transaction_id);
+        $checkedPayment = $this->client->checkPayment($payment->transaction_id);
 
         return new QpayCheckedPayment($payment, $checkedPayment);
     }

diff --git a/src/Gateways/Qpay/QpayPendingPayment.php → src/Drivers/Qpay/QpayPendingPayment.php b/src/Gateways/Qpay/QpayPendingPayment.php → src/Drivers/Qpay/QpayPendingPayment.php
@@ -1,6 +1,6 @@
 <?php
 
-namespace MyagmarsurenSedjav\SimplePayment\Gateways\Qpay;
+namespace MyagmarsurenSedjav\SimplePayment\Drivers\Qpay;
 
 use Illuminate\View\View;
 use MyagmarsurenSedjav\SimplePayment\Contracts\Results\ShouldRender;
@@ -14,12 +14,12 @@ class QpayPendingPayment extends PendingPayment implements ShouldRender, WithBas
 {
     public function getBase64QrImage(): string
     {
-        return $this->gatewayResponse['qr_image'];
+        return $this->driverResponse['qr_image'];
     }
 
     public function getRedirectUrl(): string
     {
-        return $this->gatewayResponse['qPay_shortUrl'];
+        return $this->driverResponse['qPay_shortUrl'];
     }
 
     public function render(): View
@@ -28,13 +28,13 @@ public function render(): View
             'payment' => $this->payment,
             'base64QrImage' => $this->getBase64QrImage(),
             'redirectUrl' => $this->getRedirectUrl(),
-            'urls' => $this->gatewayResponse['urls'],
+            'urls' => $this->driverResponse['urls'],
         ]);
     }
 
     public function getTransactionId(): string
     {
-        return $this->gatewayResponse['invoice_id'];
+        return $this->driverResponse['invoice_id'];
     }
 
     public function getTransactionFee(): float

diff --git a/src/Gateways/Qpay/result.json → src/Drivers/Qpay/result.json b/src/Gateways/Qpay/result.json → src/Drivers/Qpay/result.json
diff --git a/src/Facades/SimplePayment.php b/src/Facades/SimplePayment.php
@@ -3,12 +3,12 @@
 namespace MyagmarsurenSedjav\SimplePayment\Facades;
 
 use Illuminate\Support\Facades\Facade;
-use MyagmarsurenSedjav\SimplePayment\Gateways\AbstractGateway;
+use MyagmarsurenSedjav\SimplePayment\Drivers\AbstractDriver;
 use MyagmarsurenSedjav\SimplePayment\PendingPayment;
 use MyagmarsurenSedjav\SimplePayment\SimplePaymentManager;
 
 /**
- * @method static AbstractGateway driver($model, array $options = [])
+ * @method static AbstractDriver driver($model, array $options = [])
  * @method static PendingPayment create($model, array $options = [])
  * @method static mixed onBrowserReturn(\Closure $handler)
  * @method static string paymentModel()