Add WhatsApp Widget with logging and agent management

This commit introduces the WhatsApp Widget functionality, including support for logging interactions, managing agents, and API endpoints. Key features include model creation, database migrations, request validation, and backend controllers to handle widget-related operations seamlessly. Configuration options and secure request handling are also included.

Author: jeffersongoncalves

config/whatsapp-widget.php

@@ -0,0 +1,7 @@
+<?php
+return [
+    'disk' => env('FILESYSTEM_DISK', 'local'),
+    'url'  => env('APP_URL', 'http://localhost'),
+    'name' => env('APP_NAME', 'Laravel App'),
+    'key'  => env('WHATSAPP_KEY'),
+];

database/migrations/create_whatsapp_agents_table.php

@@ -0,0 +1,20 @@
+<?php
+
+use Illuminate\Database\Migrations\Migration;
+use Illuminate\Database\Schema\Blueprint;
+use Illuminate\Support\Facades\Schema;
+
+return new class extends Migration {
+    public function up()
+    {
+        Schema::create('whatsapp_agents', function (Blueprint $table) {
+            $table->id();
+            $table->boolean('active');
+            $table->string('name');
+            $table->string('phone');
+            $table->string('text')->nullable();
+            $table->string('image')->nullable();
+            $table->timestamps();
+        });
+    }
+};

database/migrations/create_whatsapp_logs_table.php

@@ -0,0 +1,20 @@
+<?php
+
+use Illuminate\Database\Migrations\Migration;
+use Illuminate\Database\Schema\Blueprint;
+use Illuminate\Support\Facades\Schema;
+
+return new class extends Migration {
+    public function up()
+    {
+        Schema::create('whatsapp_logs', function (Blueprint $table) {
+            $table->id();
+            $table->json('agent')->nullable();
+            $table->json('number')->nullable();
+            $table->json('geo')->nullable();
+            $table->string('type')->nullable();
+            $table->string('ref')->nullable();
+            $table->timestamps();
+        });
+    }
+};

routes/whatsapp-widget.php

@@ -0,0 +1,15 @@
+<?php
+
+use Illuminate\Support\Facades\Route;
+use JeffersonGoncalves\WhatsappWidget\Http\Controllers\RedirectController;
+use JeffersonGoncalves\WhatsappWidget\Http\Controllers\WhatsappLogController;
+use JeffersonGoncalves\WhatsappWidget\Http\Controllers\WhatsappLogFrontendController;
+use JeffersonGoncalves\WhatsappWidget\Http\Controllers\WhatsappsController;
+
+Route::get('/api/whatsapps', WhatsappsController::class);
+Route::post('/api/whatsapp-frontend-widget', WhatsappLogFrontendController::class)
+    ->name('whatsapp-widget.api-frontend');
+Route::post('/api/whatsapp-widget', WhatsappLogController::class)
+    ->name('whatsapp-widget.api');
+Route::get('/whatsapp-widget/redirect/{whatsapp_agent}', RedirectController::class)
+    ->name('whatsapp-widget.redirect');

src/Http/Controllers/RedirectController.php

@@ -0,0 +1,15 @@
+<?php
+
+namespace JeffersonGoncalves\WhatsappWidget\Http\Controllers;
+
+use Illuminate\Contracts\View\View;
+use JeffersonGoncalves\WhatsappWidget\Models\WhatsappAgent;
+
+class RedirectController
+{
+    public function __invoke(string $whatsapp_agent): View
+    {
+        $whatsappAgent = WhatsappAgent::query()->where('id', $whatsapp_agent)->firstOrFail();
+        return view('whatsapp-widget::whatsapp-redirect', compact('whatsappAgent'));
+    }
+}

src/Http/Controllers/WhatsappLogController.php

@@ -0,0 +1,18 @@
+<?php
+
+namespace JeffersonGoncalves\WhatsappWidget\Http\Controllers;
+
+use Illuminate\Http\Request;
+use Illuminate\Http\Response;
+use JeffersonGoncalves\WhatsappWidget\Http\Requests\WhatsappLogRequest;
+use JeffersonGoncalves\WhatsappWidget\Models\WhatsappLog;
+
+class WhatsappLogController
+{
+    public function __invoke(WhatsappLogRequest $request): Response
+    {
+        WhatsappLog::createByRequest($request->validated());
+
+        return response()->noContent();
+    }
+}

src/Http/Controllers/WhatsappLogFrontendController.php

@@ -0,0 +1,21 @@
+<?php
+
+namespace JeffersonGoncalves\WhatsappWidget\Http\Controllers;
+
+use Illuminate\Http\Request;
+use Illuminate\Http\Response;
+use JeffersonGoncalves\WhatsappWidget\Http\Requests\WhatsappLogRequest;
+use JeffersonGoncalves\WhatsappWidget\Models\WhatsappLog;
+use function abort_if;
+use function config;
+
+class WhatsappLogFrontendController
+{
+    public function __invoke(WhatsappLogRequest $request): Response
+    {
+        abort_if($request->token !== config('whatsapp-widget.key'), 403);
+        WhatsappLog::createByRequest($request->validated());
+
+        return response()->noContent();
+    }
+}

src/Http/Controllers/WhatsappsController.php

@@ -0,0 +1,28 @@
+<?php
+
+namespace JeffersonGoncalves\WhatsappWidget\Http\Controllers;
+
+use Illuminate\Http\JsonResponse;
+use Illuminate\Http\Request;
+use JeffersonGoncalves\WhatsappWidget\Models\WhatsappAgent;
+
+class WhatsappsController
+{
+    public function __invoke(Request $request): JsonResponse
+    {
+        abort_if($request->token !== config('whatsapp-widget.key'), 403);
+        $whatsappAgents = WhatsappAgent::query()->where('active', true)->get();
+        $ref = config('whatsapp-widget.url');
+        $data = [];
+        foreach ($whatsappAgents as $whatsappAgent) {
+            $data[] = [
+                'id' => $whatsappAgent->id,
+                'name' => $whatsappAgent->name,
+                'image_url' => $whatsappAgent->image_url ?? null,
+                'phone' => $whatsappAgent->phone,
+                'link' => $whatsappAgent->getLinkByWhatsappAgent($whatsappAgent, $ref),
+            ];
+        }
+        return response()->json($data);
+    }
+}

src/Http/Requests/WhatsappLogRequest.php

@@ -0,0 +1,20 @@
+<?php
+
+namespace JeffersonGoncalves\WhatsappWidget\Http\Requests;
+
+use Illuminate\Foundation\Http\FormRequest;
+
+class WhatsappLogRequest extends FormRequest
+{
+    public function rules(): array
+    {
+        return [
+            'agent' => 'required',
+            'number' => 'required',
+            'type' => 'nullable',
+            'ref' => 'nullable',
+            'geo' => 'nullable',
+            'token' => 'exclude',
+        ];
+    }
+}

src/Models/WhatsappAgent.php

@@ -0,0 +1,40 @@
+<?php
+
+namespace JeffersonGoncalves\WhatsappWidget\Models;
+
+use Illuminate\Database\Eloquent\Model;
+use Illuminate\Support\Facades\Storage;
+use Illuminate\Support\Facades\URL;
+
+class WhatsappAgent extends Model
+{
+    protected $fillable = [
+        'active',
+        'name',
+        'phone',
+        'text',
+        'image',
+    ];
+
+    protected $casts = [
+        'active' => 'bool',
+    ];
+
+    public function getImageUrlAttribute(): ?string
+    {
+        if (empty($this->image)) {
+            return null;
+        }
+        return Storage::disk(config('whatsapp-widget.disk'))->url($this->image);
+    }
+
+    public function getLinkByWhatsappAgent($whatsappAgent, $ref): string
+    {
+        return URL::signedRoute('whatsapp-widget.redirect', [
+            'whatsapp_agent' => $whatsappAgent->id,
+            'agent' => $whatsappAgent->id,
+            'number' => $whatsappAgent->phone,
+            'ref' => $ref,
+        ]);
+    }
+}

src/Models/WhatsappLog.php

@@ -0,0 +1,33 @@
+<?php
+
+namespace JeffersonGoncalves\WhatsappWidget\Models;
+
+use Illuminate\Database\Eloquent\Model;
+
+class WhatsappLog extends Model
+{
+    protected $casts = [
+        'agent' => 'json',
+        'number' => 'json',
+        'geo' => 'json',
+    ];
+    protected $table = 'whatsapp_logs';
+    protected $fillable = [
+        'agent',
+        'number',
+        'type',
+        'ref',
+        'geo',
+    ];
+
+    public static function createByRequest(array $data): void
+    {
+        self::create([
+            'agent' => [$data['agent']],
+            'number' => [$data['number']],
+            'type' => $data['type'],
+            'ref' => $data['ref'],
+            'geo' => $data['geo'] ?? [],
+        ]);
+    }
+}