Rename column 'seen_at' to 'read_at'

* Remove the web and auth middlewares from routes.

Author: ksidibe

src/Http/Controllers/InboxController.php

@@ -51,15 +51,16 @@ public function getSluggedThreads($slug, $id)
     $query = $owner->threads()->summaryFor($owner);
     $total = $query->count();
     $threads = $this->applySkipAndTake($query)->get();
-    $threads->each(function ($aThread) use ($owner) {
+    foreach ($threads as $aThread) {
+      $aThread->latestMessage()->forParticipant(get_class($owner), $owner->id)->first();
       $aThread->latestMessage->setPerspective($owner);
-    });
+    }
 
     return $this->responder->toResponse([
       'threads' => $threads,
-      'threads_sorted' => $threads->sortBy(function ($aThread) {
+      'threads_sorted' => $threads/* ->sortBy(function ($aThread) {
         return $aThread->latestMessage ? $aThread->latestMessage->created_at->format('Y-m-d H:i:s') : null;
-      }),
+      }) */,
       'total' => $total,
     ]);
   }
@@ -99,12 +100,13 @@ public function getSluggedThreadMessages(Request $request, $slug, $id, $threadId
     $query = $messageClassName::forThread($threadId)->for($owner)->withParticipants()->latest();
     $total = $query->count();
     $query = $this->applySkipAndTake($query);
+    $messages = $query->get();
+    $messages->each(function ($aMessage) use ($owner) {
+      $aMessage->setPerspective($owner);
+    });
     try {
       return $this->responder->toResponse([
-        'messages' => $query->get(),
-        // 'threads_sorted' => $threads->sortBy(function ($aThread) {
-        //   return $aThread->latestMessage ? $aThread->latestMessage->created_at->format('Y-m-d H:i:s') : null;
-        // }),
+        'messages' => $messages,
         'total' => $total,
       ]);
     } catch (Exception $ex) {

src/InboxServiceProvider.php

@@ -42,7 +42,7 @@ protected function registerRoutes()
         'prefix' => config('andale-inbox.routing.prefix', 'andale-inbox'),
         'namespace' => 'Andaletech\Inbox\Http\Controllers',
         'middleware' => config('andale-inbox.routing.middleware', ['web', 'auth']),
-        'name' => config('andale-inbox.routing.name', ['web', 'auth']),
+        'name' => config('andale-inbox.routing.name', 'andaleInbox'),
       ],
       function () {
         $this->loadRoutesFrom(__DIR__ . '/routes/web.php');

src/Models/Message.php

@@ -126,6 +126,13 @@ public function scopeWithParticipants(Builder $query)
     return $query->with(['participants']);
   }
 
+  public function scopeForParticipant(Builder $query, $type, $id)
+  {
+    return $query->whereHas('participants', function ($subQuery) use ($type, $id) {
+      return $subQuery->forParticipant($type, $id);
+    });
+  }
+
   #endregion query scopes
 
   #region override parent methods
@@ -154,7 +161,7 @@ protected function addPerspective(array $arr)
       });
       if ($participant) {
         $arr['meta'] = [
-          'seen_at' => $participant->seen_at,
+          'read_at' => $participant->read_at,
           'trashed_at' => $participant->trashed_at,
           'extra' => $participant->extra,
         ];

src/Models/Participant.php

@@ -2,12 +2,14 @@
 
 namespace Andaletech\Inbox\Models;
 
+use DateTime;
 use Andaletech\Inbox\Libs\Utils;
 use Illuminate\Database\Eloquent\Model;
+use Illuminate\Database\Eloquent\Builder;
 use Andaletech\Inbox\Contracts\Models\IParticipant;
 
 /**
- * @property Carbon\Carbon $seen_at
+ * @property Carbon\Carbon $read_at
  * @property Carbon\Carbon $trashed_at
  * @property array $tags
  * @property array $extra
@@ -88,6 +90,41 @@ public function participant()
 
   #endregion relationships
 
+  #region query scope
+
+  public function scopeForParticipant(Builder $query, $type, $id)
+  {
+    return $query->where($query->qualifyColumn('participant_type'), $type)
+      ->where(
+        $query->qualifyColumn('participant_id'),
+        $id
+      );
+  }
+
+  public function scopeForMessageNanoId(Builder $query, $messageNanoId)
+  {
+    return $query->whereHas('message', function ($subQ) use ($messageNanoId) {
+      return $subQ->where('nano_id', $messageNanoId);
+    });
+  }
+
+  public function scopeForThreadId(Builder $query, $threadId)
+  {
+    return $query->where('thread_id', $threadId);
+  }
+
+  public function scopeWasRead(Builder $query)
+  {
+    return $query->whereNotNull('read_at');
+  }
+
+  public function scopeNotRead(Builder $query)
+  {
+    return $query->whereNull('read_at');
+  }
+
+  #endregion query scope
+
   #region override parent methods.
 
   public function toArray()
@@ -105,5 +142,18 @@ public function toArray()
 
   #region class specific methods
 
+  public function markAsRead(?DateTime $dateTime = null, $save = true)
+  {
+    if ($this->read_at) {
+      return $this->read_at;
+    }
+    $this->read_at = ($dateTime ?? (new DateTime()))->format('Y-m-d H:i:s');
+    if ($save) {
+      $this->save();
+    }
+
+    return $this->read_at;;
+  }
+
   #endregion class specific methods
 }

src/Traits/HasInbox.php

@@ -73,7 +73,7 @@ public function threads()
       config('andale-inbox.tables.participants'),
       'participant_id',
       'thread_id'
-    )->where('participant_type', get_class($this))->distinct();
+    )->where('participant_type', get_class($this))->latest('created_at')->distinct();
 
     if ($this->isMultitenant()) {
       $query = $query->withPivot([config('andale-inbox.tenancy.tenant_id_column', 'tenant_id')]);

src/config/andale-inbox.php

@@ -78,10 +78,15 @@
     'middleware' => ['web', 'auth'],
     'name' => 'andale-inbox.',
 
-    'id_patern' => '[0-9]+',
+    'id_pattern' => '[0-9]+',
 
+    /**
+     * For example in messaging route user_101 will  be mapped to user model with id 101.
+     * student_89 will be mapped to student model with id 89
+     */
     'slug_to_model_map' => [
       // 'users' => 'App\Models\User\User',
+      // 'student' => 'App\Models\Student\Student,
     ],
     'responder' => 'Andaletech\Inbox\Http\Response\ResponseBuilder',
   ],

src/database/migrations/2021_12_25_104649_create_inbox_participants_table.php

@@ -21,7 +21,7 @@ public function up()
       $table->morphs('participant');
       $table->json('tags')->nullable();
       $table->json('extra')->nullable();
-      $table->timestamp('seen_at')->nullable();
+      $table->timestamp('read_at')->nullable();
       $table->timestamp('trashed_at')->nullable();
       $table->timestamps();
       $table->softDeletes();

src/routes/sluggedRoutes.php

@@ -5,7 +5,7 @@
 
 Route::group(
   [
-    'prefix' => '/{slug}', /* 'as' => 'profile', */ /* 'middleware' => ['can:view,user'], */
+    'prefix' => '/{slug}',
     'where' => [
       'slug' => join(
         '',
@@ -21,10 +21,9 @@ function () {
     Route::group(
       [
         'prefix' => '/{id}',
-        'where' => ['id' => config('andale-inbox.routing.id_patern', '[0-9]+')],
+        'where' => ['id' => config('andale-inbox.routing.id_pattern', '[0-9]+')],
       ],
       function () {
-        // Route::get('/', 'InboxController@getSluggedThreads');
         Route::name('threads.')->prefix('threads')->group(__DIR__ . '/./parts/threads.php');
       }
     );