add ticket messages api

Author: ousid

config/laravel_ticket.php

@@ -15,7 +15,12 @@
         'tickets' => 'tickets',
         'categories' => 'categories',
         'labels' => 'labels',
-        'messages' => 'messages',
+        'messages' => [
+            'table' => 'messages',
+            'columns' => [
+                'ticket_foreing_id' => 'ticket_id',
+            ],
+        ],
         'label_ticket' => [
             'table' => 'label_ticket',
             'columns' => [

database/migrations/create_messages_table.php.stub

@@ -5,18 +5,19 @@ namespace Coderflex\LaravelTicket\Database\Factories;
 use Illuminate\Database\Migrations\Migration;
 use Illuminate\Database\Schema\Blueprint;
 use Illuminate\Support\Facades\Schema;
+use Illuminate\Support\Str;
 
 return new class extends Migration
 {
     public function up()
     {
         $tableName = config('laravel_ticket.table_names.messages', 'messages');
 
-        Schema::create($tableName, function (Blueprint $table) {
+        Schema::create($tableName['table'], function (Blueprint $table) use ($tableName) {
             $table->id();
             $table->foreignId('user_id');
-            $table->foreignId('laravel_ticket_id');
-            $table->text('comment');
+            $table->foreignId($tableName['columns']['ticket_foreing_id']);
+            $table->text('message');
             $table->timestamps();
         });
     }

src/Concerns/HasTickets.php

@@ -2,6 +2,7 @@
 
 namespace Coderflex\LaravelTicket\Concerns;
 
+use Coderflex\LaravelTicket\Models\Message;
 use Coderflex\LaravelTicket\Models\Ticket;
 use Illuminate\Database\Eloquent\Relations\HasMany;
 
@@ -16,4 +17,14 @@ public function tickets(): HasMany
     {
         return $this->hasMany(Ticket::class, 'user_id');
     }
+
+    /**
+     * Get User tickets relationship
+     *
+     * @return \Illuminate\Database\Eloquent\Relations\HasMany
+     */
+    public function messages(): HasMany
+    {
+        return $this->hasMany(Message::class, 'user_id');
+    }
 }

src/Concerns/InteractsWithTicketRelations.php

@@ -2,6 +2,8 @@
 
 namespace Coderflex\LaravelTicket\Concerns;
 
+use Illuminate\Database\Eloquent\Model;
+
 trait InteractsWithTicketRelations
 {
     /**
@@ -53,4 +55,30 @@ public function syncCategories($ids, $detaching = true)
     {
         return $this->categories()->sync($ids, $detaching);
     }
+
+    /**
+     * Add new message on an existing ticket
+     *
+     * @param  string  $message
+     * @return \Illuminate\Database\Eloquent\Model
+     */
+    public function message(string $message): Model
+    {
+        return $this->messageAsUser(auth()->user(), $message);
+    }
+
+    /**
+     * Add new message on an existing ticket as a custom user
+     *
+     * @param  \Illuminate\Database\Eloquent\Model|null  $user
+     * @param  string  $message
+     * @return \Illuminate\Database\Eloquent\Model
+     */
+    public function messageAsUser(?Model $user, string $message): Model
+    {
+        return $this->messages()->create([
+            'user_id' => $user->id, // @phpstan-ignore-line
+            'message' => $message,
+        ]);
+    }
 }

src/Models/Message.php

@@ -6,6 +6,12 @@
 use Illuminate\Database\Eloquent\Model;
 use Illuminate\Database\Eloquent\Relations\BelongsTo;
 
+/**
+ * Coderflex\LaravelTicket\Models\Message
+ *
+ * @property int $user_id
+ * @property string $message
+ */
 class Message extends Model
 {
     use HasFactory;
@@ -24,7 +30,12 @@ class Message extends Model
      */
     public function ticket(): BelongsTo
     {
-        return $this->belongsTo(Ticket::class, 'laravel_ticket_id');
+        $tableName = config('laravel_ticket.table_names.messages', 'messages');
+
+        return $this->belongsTo(
+            Ticket::class,
+            $tableName['columns']['ticket_foreing_id']
+        );
     }
 
     /**
@@ -35,7 +46,7 @@ public function ticket(): BelongsTo
     public function getTable()
     {
         return config(
-            'laravel_ticket.table_names.messages',
+            'laravel_ticket.table_names.messages.table',
             parent::getTable()
         );
     }

src/Models/Ticket.php

@@ -52,9 +52,14 @@ public function user(): BelongsTo
      *
      * @return \Illuminate\Database\Eloquent\Relations\HasMany
      */
-    public function comments(): HasMany
+    public function messages(): HasMany
     {
-        return $this->hasMany(Message::class);
+        $tableName = config('laravel_ticket.table_names.messages', 'messages');
+
+        return $this->hasMany(
+            Message::class,
+            (string) $tableName['columns']['ticket_foreing_id'],
+        );
     }
 
     /**

tests/Database/Factories/MessageFactory.php

@@ -13,10 +13,12 @@ class MessageFactory extends Factory
 
     public function definition()
     {
+        $tableName = config('laravel_ticket.table_names.messages', 'messages');
+
         return [
             'user_id' => User::factory(),
-            'laravel_ticket_id' => Ticket::factory(),
-            'comment' => $this->faker->paragraph(2),
+            $tableName['columns']['ticket_foreing_id'] => Ticket::factory(),
+            'message' => $this->faker->paragraph(2),
         ];
     }
 }

tests/Feature/TicketRelationsTest.php

@@ -77,3 +77,24 @@
     $this->assertEquals($ticket->categories->count(), 5);
 });
 
+it('can create a message inside the ticket by authenticated user', function () {
+    $this->actingAs(User::factory()->create());
+
+    $ticket = Ticket::factory()->create();
+
+    $ticket->message('How are you today?');
+
+    $this->assertEquals($ticket->messages->count(), 1);
+});
+
+it('can create a message inside the ticket by another user', function () {
+    $user = $this->actingAs(User::factory()->create());
+    $anotherUser = User::factory()->create();
+
+    $ticket = Ticket::factory()->create();
+
+    $ticket->messageAsUser($anotherUser, 'How are you today?');
+
+    $this->assertEquals($ticket->messages->count(), 1);
+    $this->assertEquals($ticket->messages->first()->user_id, $anotherUser->id);
+});

tests/Models/User.php

@@ -4,13 +4,24 @@
 
 use Coderflex\LaravelTicket\Concerns\HasTickets;
 use Coderflex\LaravelTicket\Contracts\CanUseTickets;
+use Illuminate\Auth\Authenticatable;
+use Illuminate\Auth\MustVerifyEmail;
+use Illuminate\Auth\Passwords\CanResetPassword;
+use Illuminate\Contracts\Auth\Access\Authorizable as AuthorizableContract;
+use Illuminate\Contracts\Auth\Authenticatable as AuthenticatableContract;
+use Illuminate\Contracts\Auth\CanResetPassword as CanResetPasswordContract;
 use Illuminate\Database\Eloquent\Factories\HasFactory;
 use Illuminate\Database\Eloquent\Model;
+use Illuminate\Foundation\Auth\Access\Authorizable;
 
-class User extends Model implements CanUseTickets
+class User extends Model implements CanUseTickets, AuthenticatableContract, AuthorizableContract, CanResetPasswordContract
 {
-    use HasFactory;
-    use HasTickets;
+    use Authenticatable,
+        Authorizable,
+        CanResetPassword,
+        MustVerifyEmail,
+        HasFactory,
+        HasTickets;
 
     protected $guarded = [];
 }

tests/Unit/MessageTest.php

@@ -8,20 +8,20 @@
         'title' => 'Laravel is cool!',
     ]);
 
-    $message = Message::factory()
-                ->create([
-                    'laravel_ticket_id' => $ticket->id,
-                    'comment' => 'Message from a ticket',
-                ]);
-
     $tableName = config(
         'laravel_ticket.table_names.messages',
         'messages'
     );
 
-    $this->assertDatabaseHas($tableName, [
-        'laravel_ticket_id' => $ticket->id,
-        'comment' => 'Message from a ticket',
+    $message = Message::factory()
+                ->create([
+                    $tableName['columns']['ticket_foreing_id'] => $ticket->id,
+                    'message' => 'Message from a ticket',
+                ]);
+
+    $this->assertDatabaseHas($tableName['table'], [
+        $tableName['columns']['ticket_foreing_id'] => $ticket->id,
+        'message' => 'Message from a ticket',
     ]);
 
     $this->assertEquals($message->count(), 1);