Refactor Vodacom Mobile Money package: clean up code, remove unused routes and files, and improve formatting

Author: beesaferoot

src/backend/app/Http/Controllers/VodacomTransactionController.php

@@ -2,9 +2,7 @@
 
 namespace App\Http\Controllers;
 
-use App\Http\Resources\VodacomResource;
 use App\Models\Transaction\VodacomTransaction;
-use App\Services\VodacomService;
 use Illuminate\Http\Request;
 
 /**
@@ -13,8 +11,6 @@
  * API endpoints for integrating with Vodacom's M-Pesa payment services
  */
 class VodacomTransactionController extends Controller {
-    public function __construct(private VodacomService $vodacomService) {}
-
     /**
      * Store a newly created resource in storage.
      *
@@ -41,140 +37,4 @@ public function store(Request $request): void {
             'message' => $transactionData->accountReference,
         ]);
     }
-
-    /**
-     * Validate Transaction.
-     *
-     * Validates a transaction before processing. Use this endpoint to verify if a transaction
-     * can proceed based on the provided information. This is typically the first step in the payment flow.
-     *
-     * @bodyParam serialNumber string required Unique identifier for the product/service being purchased pattern: ^[A-Z0-9]{8,12}$ Example: ABC123456789
-     * @bodyParam amount number required Transaction amount in the local currency  Example: 15000
-     * @bodyParam payerPhoneNumber string required Customer's phone number in international format pattern: ^258[0-9]{9}$ Example: 258712345678
-     * @bodyParam referenceId string required Unique reference identifier for this transaction pattern: ^[A-Za-z0-9\-]{5,20}$ Example: ORD-12345-ABC
-     *
-     * @response scenario="Success" {
-     *   "data": {
-     *     "transactionId": "VOD-TXN-123456",
-     *     "status": "validated",
-     *     "details": {
-     *       "product": "Internet Bundle",
-     *       "validAmount": true
-     *     },
-     *     "success": true
-     *   }
-     * }
-     * @response 400 scenario="Validation Error" {
-     *   "data": {
-     *     "message": "Invalid amount specified for this product",
-     *     "success": false
-     *   }
-     * }
-     *
-     * @param Request $request
-     *
-     * @return VodacomResource
-     */
-    public function validateTransaction(Request $request): VodacomResource {
-        $validatedData = $request->validate([
-            'serialNumber' => 'required|string|regex:/^[A-Z0-9]{8,12}$/',
-            'amount' => 'required|numeric|min:100|max:5000000',
-            'payerPhoneNumber' => 'required|string|regex:/^258[0-9]{9}$/',
-            'referenceId' => 'required|string|regex:/^[A-Za-z0-9\-]{5,20}$/',
-        ]);
-
-        try {
-            $result = $this->vodacomService->validateTransaction($validatedData);
-
-            return VodacomResource::make($result);
-        } catch (\Exception $e) {
-            return VodacomResource::error($e->getMessage());
-        }
-    }
-
-    /**
-     * Process Transaction.
-     *
-     * Processes a previously validated transaction. This endpoint should be called after successful
-     * validation to initiate the payment process with Vodacom M-Pesa.
-     *
-     * @bodyParam referenceId string required The reference ID used during validation pattern: ^[A-Za-z0-9\-]{5,20}$ Example: ORD-12345-ABC
-     * @bodyParam transactionId string required The transaction ID returned from the validation step pattern: ^VOD-TXN-[0-9]{6}$ Example: VOD-TXN-123456
-     *
-     * @response scenario="Success" {
-     *   "data": {
-     *     "transactionId": "VOD-TXN-123456",
-     *     "status": "processing",
-     *     "providerReference": "MPESA-TX-987654321",
-     *     "success": true
-     *   }
-     * }
-     * @response 400 scenario="Processing Error" {
-     *   "data": {
-     *     "message": "Transaction processing failed: Insufficient funds",
-     *     "success": false
-     *   }
-     * }
-     *
-     * @param Request $request
-     *
-     * @return VodacomResource
-     */
-    public function processTransaction(Request $request): VodacomResource {
-        $validatedData = $request->validate([
-            'referenceId' => 'required|string|regex:/^[A-Za-z0-9\-]{5,20}$/',
-            'transactionId' => 'required|string|regex:/^VOD-TXN-[0-9]{6}$/',
-        ]);
-
-        try {
-            $result = $this->vodacomService->processTransaction($validatedData);
-
-            return VodacomResource::make($result);
-        } catch (\Exception $e) {
-            return VodacomResource::error($e->getMessage());
-        }
-    }
-
-    /**
-     * Check Transaction Status.
-     *
-     * Checks the current status of a transaction that has been submitted for processing.
-     * Use this to verify if a payment has been completed, is still pending, or has failed.
-     *
-     * @bodyParam referenceId string required The reference ID of the transaction to check pattern: ^[A-Za-z0-9\-]{5,20}$ Example: ORD-12345-ABC
-     *
-     * @response scenario="Success" {
-     *   "data": {
-     *     "referenceId": "ORD-12345-ABC",
-     *     "transactionId": "VOD-TXN-123456",
-     *     "status": "completed",
-     *     "mpesaReceipt": "QCL4521XYZ",
-     *     "completedAt": "2023-06-15T12:45:32Z",
-     *     "success": true
-     *   }
-     * }
-     * @response 400 scenario="Enquiry Error" {
-     *   "data": {
-     *     "message": "Transaction not found or reference ID is invalid",
-     *     "success": false
-     *   }
-     * }
-     *
-     * @param Request $request
-     *
-     * @return VodacomResource
-     */
-    public function transactionEnquiryStatus(Request $request): VodacomResource {
-        $validatedData = $request->validate([
-            'referenceId' => 'required|string|regex:/^[A-Za-z0-9\-]{5,20}$/',
-        ]);
-
-        try {
-            $result = $this->vodacomService->transactionEnquiryStatus($validatedData);
-
-            return VodacomResource::make($result);
-        } catch (\Exception $e) {
-            return VodacomResource::error($e->getMessage());
-        }
-    }
 }

src/backend/app/Http/Resources/VodacomResource.php

@@ -1,13 +1,10 @@
 ## Package-Development-Starter-Pack
- 
- #### Starter pack for package development to MicroPowerManager.
 
- - This repo has created by the MicroPowerManager development team for developers who will develop a new package for MicroPowerManager.
- - The team suggests developers use this repo when they decide to develop new packages to MicroPowerManager.
- - Developers should clone our `Core` project with this url `https://github.com/inensus/MPManager` first. After cloning and running the core project, They have to go into laravel container and  navigate to mpmanager & run `php artisan micropowermanager:new-package {{package-name}}` command to clone  `this repo` into packages folder in MicroPowerManager core project.
- - After cloning Package-Development-Starter-Pack, developers can keep developing the package inside of core project.
- - When the developing will have been finished they can upload their packages to `https://packagist.org/` for the other developers usage
-  
- 
+#### Starter pack for package development to MicroPowerManager
 
-  
+- This repo has created by the MicroPowerManager development team for developers who will develop a new package for MicroPowerManager.
+- The team suggests developers use this repo when they decide to develop new packages to MicroPowerManager.
+- Developers should clone our `Core` project with this url `https://github.com/inensus/MPManager` first. After cloning and running the core project, They have to go into laravel container and  navigate to mpmanager & run `php artisan micropowermanager:new-package {{package-name}}` command to clone  `this repo` into packages folder in MicroPowerManager core project.
+- After cloning Package-Development-Starter-Pack, developers can keep developing the package inside of core project.
+- When the developing will have been finished they can upload their packages to `https://packagist.org/` for the other developers usage
+  

src/backend/app/Services/VodacomService.php

@@ -1,5 +1,4 @@
 <?php
 
 return [
-
-];
+];

src/backend/packages/inensus/vodacom-mobile-money/README.md

@@ -2,7 +2,6 @@
 
 namespace Inensus\VodacomMobileMoney\Models;
 
-
 use App\Models\Base\BaseModel;
 
 class VodacomMobileMoneyTransaction extends BaseModel {

src/backend/packages/inensus/vodacom-mobile-money/config/vodacom-mobile-money.php

@@ -4,21 +4,16 @@
 
 use Illuminate\Foundation\Support\Providers\EventServiceProvider as ServiceProvider;
 
-class EventServiceProvider  extends ServiceProvider
-{
+class EventServiceProvider extends ServiceProvider {
     protected $subscribe = [
-
     ];
 
     /**
      * Register any events for your application.
      *
      * @return void
      */
-    public function boot()
-    {
+    public function boot() {
         parent::boot();
-
-        //
     }
-}
+}

src/backend/packages/inensus/vodacom-mobile-money/src/Models/VodacomMobileMoneyTransaction.php

@@ -4,17 +4,13 @@
 
 use Illuminate\Foundation\Support\Providers\EventServiceProvider as ServiceProvider;
 
-class ObserverServiceProvider extends ServiceProvider
-{
+class ObserverServiceProvider extends ServiceProvider {
     /**
      * Register any events for your application.
      *
      * @return void
      */
-    public function boot()
-    {
+    public function boot() {
         parent::boot();
-
-
     }
-}
+}

src/backend/packages/inensus/vodacom-mobile-money/src/Providers/EventServiceProvider.php

@@ -2,28 +2,24 @@
 
 namespace Inensus\VodacomMobileMoney\Providers;
 
-use Illuminate\Support\Facades\Route;
 use Illuminate\Foundation\Support\Providers\RouteServiceProvider as ServiceProvider;
+use Illuminate\Support\Facades\Route;
 
-class RouteServiceProvider extends ServiceProvider
-{
+class RouteServiceProvider extends ServiceProvider {
     protected $namespace = 'Inensus\VodacomMobileMoney\Http\Controllers';
 
-    public function boot()
-    {
+    public function boot() {
         parent::boot();
     }
 
-    public function map()
-    {
+    public function map() {
         $this->mapApiRoutes();
     }
 
-    protected function mapApiRoutes()
-    {
+    protected function mapApiRoutes() {
         Route::prefix('api')
             ->middleware('api')
             ->namespace($this->namespace)
-            ->group(__DIR__ . '/../routes/api.php');
+            ->group(__DIR__.'/../routes/api.php');
     }
-}
+}

src/backend/packages/inensus/vodacom-mobile-money/src/Providers/ObserverServiceProvider.php

@@ -332,9 +332,3 @@ static function () {
 Route::group(['prefix' => 'usage-types'], static function () {
     Route::get('/', 'UsageTypeController@index');
 });
-
-Route::group(['prefix' => 'vodacom'], static function () {
-    Route::post('/transactions/validation', 'VodacomTransactionController@validateTransaction');
-    Route::post('/transactions/process', 'VodacomTransactionController@processTransaction');
-    Route::post('/transactions/enquiry', 'VodacomTransactionController@transactionEnquiryStatus');
-});

src/backend/packages/inensus/vodacom-mobile-money/src/Providers/RouteServiceProvider.php

@@ -1,3 +1,2 @@
-
-Vue.component('Component', require('./components/Component.vue'))
-window.packageNameEvent = new Vue()
+Vue.component("Component", require("./components/Component.vue"))
+window.packageNameEvent = new Vue()