Merge branch 'dillon/accounting-bank-mapping' into 'master'

New route, middleware, token table, filters for query to allow  third party to access api

See merge request CIEFWorldwideSdnBhd/shipping-portal!161

app/Classes/General/Eloquent/Filters/AmountExceed.php

@@ -0,0 +1,19 @@
+<?php
+
+namespace App\Classes\General\Eloquent\Filters;
+
+use Illuminate\Database\Eloquent\Builder;
+
+class AmountExceed implements Filter
+{
+
+    /**
+     * @param Builder $builder
+     * @param $value
+     * @return mixed
+     */
+    public static function apply(Builder $builder, $value)
+    {
+        return $builder->where('amount', '>', $value);
+    }
+}

app/Classes/General/Eloquent/Filters/AmountShort.php

@@ -0,0 +1,19 @@
+<?php
+
+namespace App\Classes\General\Eloquent\Filters;
+
+use Illuminate\Database\Eloquent\Builder;
+
+class AmountShort implements Filter
+{
+
+    /**
+     * @param Builder $builder
+     * @param $value
+     * @return mixed
+     */
+    public static function apply(Builder $builder, $value)
+    {
+        return $builder->where('amount', '<', $value);
+    }
+}

app/Classes/General/Eloquent/Filters/CreatedBefore.php

@@ -0,0 +1,20 @@
+<?php
+
+namespace App\Classes\General\Eloquent\Filters;
+
+use Carbon\Carbon;
+use Illuminate\Database\Eloquent\Builder;
+
+class CreatedBefore implements Filter
+{
+
+    /**
+     * @param Builder $builder
+     * @param $value
+     * @return mixed
+     */
+    public static function apply(Builder $builder, $value)
+    {
+        return $builder->where('created_at', '<', Carbon::parse($value));
+    }
+}

app/Classes/General/Eloquent/Filters/PaymentMethod.php

@@ -0,0 +1,20 @@
+<?php
+
+namespace App\Classes\General\Eloquent\Filters;
+
+use Illuminate\Database\Eloquent\Builder;
+
+class PaymentMethod implements Filter
+{
+
+    /**
+     * @param Builder $builder
+     * @param $value
+     * @return Builder|mixed
+     */
+    public static function apply(Builder $builder, $value)
+    {
+        return $builder->where('payment_method', $value);
+    }
+
+}

app/Http/Kernel.php

@@ -44,6 +44,11 @@ class Kernel extends HttpKernel
             'throttle:300,1',
             \Illuminate\Routing\Middleware\SubstituteBindings::class,
         ],
+
+        'apipub' => [
+            // \Laravel\Sanctum\Http\Middleware\EnsureFrontendRequestsAreStateful::class,
+            \Illuminate\Routing\Middleware\SubstituteBindings::class,
+        ],
     ];
 
     /**
@@ -63,6 +68,7 @@ class Kernel extends HttpKernel
         'signed' => \Illuminate\Routing\Middleware\ValidateSignature::class,
         'throttle' => \Illuminate\Routing\Middleware\ThrottleRequests::class,
         'verified' => \Illuminate\Auth\Middleware\EnsureEmailIsVerified::class,
-        'valid.token' => ValidateToken::class
+        'valid.token' => ValidateToken::class,
+        'token.check' => \App\Http\Middleware\TokenCheckerMiddleware::class,
     ];
 }

app/Http/Middleware/TokenCheckerMiddleware.php

@@ -0,0 +1,56 @@
+<?php
+
+namespace App\Http\Middleware;
+
+use App\Models\PersonalAccessTokens;
+use Closure;
+use Illuminate\Http\Request;
+
+class TokenCheckerMiddleware
+{
+    /**
+     * Handle an incoming request.
+     *
+     * @param  \Illuminate\Http\Request  $request
+     * @param  \Closure(\Illuminate\Http\Request): (\Illuminate\Http\Response|\Illuminate\Http\RedirectResponse)  $next
+     * @return \Illuminate\Http\Response|\Illuminate\Http\RedirectResponse
+     */
+    public function handle(Request $request, Closure $next)
+    {
+        //Method 1: Token pass via query parameter
+        // Check if the api_key query parameter is present
+        if (!$request->query('api-key')) {
+            return response()->json(['message' => 'Invalid API key.'], 401);
+        }
+
+        // Check if the api_key is valid
+        $apiKey = $request->query('api-key');
+        $personalAccessToken = PersonalAccessTokens::where('token', $apiKey)->first();
+
+        if (!$personalAccessToken) {
+            return response()->json(['error' => 'Unauthorized'], 401);
+        }
+        return $next($request);
+
+        //Method 2: Token pass via request header
+        /*
+        $authHeader = $request->header('Authorization');
+        if (preg_match('/Bearer\s+(.*)$/i', $authHeader, $matches)) {
+            $token = $matches[1];
+            // validate the token here
+
+            $personalAccessToken = PersonalAccessToken::where('token', $token)->first();
+
+            if (!$personalAccessToken) {
+                return response()->json(['error' => 'Unauthorized'], 401);
+            }
+
+
+            // if the token is valid, you can attach it to the request
+            $request->attributes->add(['bearerToken' => $token]);
+            return $next($request);
+        }
+        return response()->json(['error' => 'Unauthorized'], 401);
+        */
+    }
+}

app/Models/PersonalAccessTokens.php

@@ -0,0 +1,9 @@
+<?php
+
+namespace App\Models;
+
+class PersonalAccessTokens extends AbstractModel
+{
+    protected $table = 'personal_access_tokens';
+
+}

app/Providers/RouteServiceProvider.php

@@ -43,6 +43,11 @@ class RouteServiceProvider extends ServiceProvider
                 ->namespace($this->namespace)
                 ->group(base_path('routes/api.php'));
 
+            Route::prefix('public/api')
+                ->middleware('apipub')
+                ->namespace($this->namespace)
+                ->group(base_path('routes/apipub.php'));
+
             Route::middleware('web')
                 ->namespace($this->namespace)
                 ->group(base_path('routes/web.php'));

database/migrations/2023_04_06_000001_create_personal_access_tokens_table.php

@@ -0,0 +1,36 @@
+<?php
+
+use Illuminate\Database\Migrations\Migration;
+use Illuminate\Database\Schema\Blueprint;
+use Illuminate\Support\Facades\Schema;
+
+class CreatePersonalAccessTokensTable extends Migration
+{
+    /**
+     * Run the migrations.
+     *
+     * @return void
+     */
+    public function up()
+    {
+        Schema::create('personal_access_tokens', function (Blueprint $table) {
+            $table->bigIncrements('id');
+            // $table->morphs('tokenable');
+            $table->string('name');
+            $table->string('token', 64)->unique();
+            $table->text('abilities')->nullable();
+            $table->timestamp('last_used_at')->nullable();
+            $table->timestamps();
+        });
+    }
+
+    /**
+     * Reverse the migrations.
+     *
+     * @return void
+     */
+    public function down()
+    {
+        Schema::dropIfExists('personal_access_tokens');
+    }
+}

routes/apipub.php

@@ -0,0 +1,9 @@
+<?php
+
+use Illuminate\Support\Facades\Route;
+
+Route::group(['middleware' => 'apipub', 'prefix' => 'v1', 'as' => 'apipub.'], function () {
+    Route::group(['middleware' => 'token.check'], function () {
+        Route::get('/list', 'Transactions\ListTransactionsController@list')->name('list');
+    });
+});