Refund request - api endpoint for refund request

app/Classes/Modules/Bookings/ControllersLogic/CreateBookingRefundLogic.php

@@ -0,0 +1,100 @@
+<?php
+
+namespace App\Classes\Modules\Bookings\ControllersLogic;
+
+
+use App\Classes\Exceptions\MalformedRequestException;
+use App\Classes\General\Abstracts\AbstractControllerLogic;
+use App\Classes\Modules\Transactions\Services\FetchesTransaction;
+use App\Classes\Modules\Companies\Services\FetchesCompanyPaymentAttemptLimit;
+use App\Classes\Modules\Transactions\DataTransferObjects\TransactionObject;
+use App\Classes\Modules\Transactions\DataTransferObjects\TransactionDetailObject;
+use App\Classes\Modules\Transactions\Services\CreatesTransaction;
+use App\Classes\Modules\Transactions\Services\CreatesTransactionDetail;
+use App\Classes\Modules\Transactions\Services\GeneratesTransactionBillNumber;
+use App\Classes\ValueObjects\Constants\ApprovalStatus;
+use App\Classes\ValueObjects\Constants\TransactionType;
+use App\Http\Resources\TransactionResource;
+use App\Models\Booking;
+use Carbon\Carbon;
+use Illuminate\Http\JsonResponse;
+use Illuminate\Http\Request;
+
+class CreateBookingRefundLogic extends AbstractControllerLogic
+{
+
+    /**
+     * @return array
+     */
+    protected function notification():array {
+        return [
+            'title' => 'Create Refund Booking',
+            'message' => 'You have successfully created a refund booking'
+        ];
+    }
+
+    /** @var FetchesTransaction */
+    private $fetchesTransaction;
+
+    /** @var FetchesCompanyPaymentAttemptLimit */
+    private $fetchesCompanyPaymentAttemptLimit;
+
+    /** @var GeneratesTransactionBillNumber */
+    private $generatesTransactionBillNumber;
+
+    /** @var CreatesTransaction */
+    private $createsTransaction;
+
+    /** @var CreatesTransactionDetail */
+    private $createsTransactionDetail;
+
+    /**
+     * CreateBookingPaymentLogic constructor.
+     * @param FetchesTransaction $fetchesTransaction
+     * 
+     * @param FetchesCompanyPaymentAttemptLimit $fetchesCompanyPaymentAttemptLimit
+     * @param GeneratesTransactionBillNumber $generatesTransactionBillNumber
+     * @param CreatesTransaction $createsTransaction
+     */
+    public function __construct(FetchesTransaction $fetchesTransaction, FetchesCompanyPaymentAttemptLimit $fetchesCompanyPaymentAttemptLimit, GeneratesTransactionBillNumber $generatesTransactionBillNumber, CreatesTransaction $createsTransaction, CreatesTransactionDetail $createsTransactionDetail)
+    {
+        $this->fetchesTransaction = $fetchesTransaction;
+        $this->fetchesCompanyPaymentAttemptLimit = $fetchesCompanyPaymentAttemptLimit;
+        $this->generatesTransactionBillNumber = $generatesTransactionBillNumber;
+        $this->createsTransaction = $createsTransaction;
+        $this->createsTransactionDetail = $createsTransactionDetail;
+    }
+
+    /**
+     * @param Request $request
+     * @return JsonResponse
+     * @throws MalformedRequestException
+     */
+    public function logic(Request $request) : JsonResponse
+    {
+
+        $booking = Booking::find($request->route('id'));
+
+        $transaction = $this->fetchesTransaction->execute(['id' => $request->input('payment_id')]);
+
+        $paymentAttemptLimit = $this->fetchesCompanyPaymentAttemptLimit->execute($booking->company);
+
+        $billNumber = $this->generatesTransactionBillNumber->execute('RFD-');
+        
+        $object = new TransactionObject($billNumber, TransactionType::REFUND, 1, $booking->company->id,
+            $booking->bank_id, $transaction->payment_method,
+            $transaction->amount, $transaction->original_amount, 1,
+            $transaction->original_currency_id, $transaction->currency_rate,
+            $transaction->tax, $transaction->service_charge, Carbon::now()->addMinutes($paymentAttemptLimit), ApprovalStatus::PENDING_VERIFICATION);
+
+        $transaction = $this->createsTransaction->execute($booking, $object);
+
+        $detailObject = new TransactionDetailObject($transaction->bill_no, 'Payment refund for '.$transaction->bill_no, 1, $transaction->original_amount);
+
+        $this->createsTransactionDetail->execute($transaction, $detailObject);
+
+        return $this->resourceResponse(new TransactionResource($transaction));
+    }
+
+
+}

app/Classes/Modules/Bookings/Services/CalculatesBookingRefundAmount.php

@@ -0,0 +1,18 @@
+<?php
+
+namespace App\Classes\Modules\Bookings\Services;
+
+
+use App\Classes\ValueObjects\Constants\ApprovalStatus;
+use App\Classes\ValueObjects\Constants\TransactionType;
+use App\Models\Booking;
+use Carbon\Carbon;
+
+class CalculatesBookingRefundAmount
+{
+
+    public function execute(Booking $booking){
+        return $booking->transactions()->refunds()->complete()->sum('original_amount');
+    }
+
+}

app/Http/Controllers/Bookings/CreateBookingRefundController.php

@@ -0,0 +1,20 @@
+<?php
+
+namespace App\Http\Controllers\Bookings;
+
+use App\Classes\Modules\Bookings\ControllersLogic\CreateBookingRefundLogic;
+use Illuminate\Http\JsonResponse;
+use Illuminate\Http\Request;
+
+class CreateBookingRefundController
+{
+    /**
+     * @param Request $request
+     * @param CreateBookingPaymentLogic $logic
+     * @return JsonResponse
+     */
+    public function create(Request $request, CreateBookingRefundLogic $logic): JsonResponse {
+        return $logic->execute($request);
+    }
+
+}

app/Models/Transaction.php

@@ -84,6 +84,15 @@ class Transaction extends AbstractModel implements Documentable
         return $query->where('type', TransactionType::BILL);
     }
 
+    /**
+     * @param Builder $query
+     * @return Builder
+     */
+    public function scopeRefunds(Builder $query)
+    {
+        return $query->where('type', TransactionType::REFUND);
+    }
+
 
     /**
      * @param Builder $query

routes/booking.php

@@ -16,6 +16,14 @@ Route::group(['prefix' => 'booking', 'as' => 'booking.', 'namespace' => 'Booking
         Route::put('/{payment_id}/approval/{status}', 'ApprovePaymentVerificationController@approve')->where('status', 'approve|reject')->name('approval');
     });
 
+    Route::group(['prefix' => '{id}/refund', 'as' => 'refund.'], function () {
+        Route::post('create', 'CreateBookingRefundController@create')->name('create');
+    });
+
+    Route::group(['prefix' => '{id}/refund', 'as' => 'refund.'], function () {
+        Route::post('{payment_id}create', 'CreateBookingRefundController@create')->name('create');
+    });
+
     Route::post('{id}/purchase_order/verification', 'ApprovePurchaseOrderController@approve')->name('po.approval');
 
     Route::post('/merge', 'MergeBookingController@merge')->name('merge');