polylingo_chat 0.4.1 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 01ec0809c7463514bcbf9249500c51241cf10ed887a0cf3128ce5258922b8861
-  data.tar.gz: 90fdaebab28909605dab1da70779094b0283ec1a08c45f24cb597a317e084645
+  metadata.gz: 7d943177494bfb641a85ca0d44e89bd074f8a320de8843141dc379166e0f4b3c
+  data.tar.gz: 2017bbbeffb249811257755c877d39be524e622dd38c0ea5b4fca71e9617ecf9
 SHA512:
-  metadata.gz: a7546b1a0a4d4c75339a8a54edc3f487acb03d367ee18e4474926f804e432114a8b86a2f4a874d37c2ce5ad83bc63338f685c766f0251f0c4885206484804660
-  data.tar.gz: 4439ee11861544ec14a424be4887b3487b0f8258eae378e1f463ea2df5f0d41301dd793f1d3cece4977a8410dbfa80989f791f062cd5fb4cca3148154073707c
+  metadata.gz: 9a431e3c3fb1f011f4fbb76e8e903390f8cb79e874ecd1a37b88bb7b0baddf5ebd9d414a7c89650977a24f30cc924db95f847f93143c37444bb854f6f0f9776c
+  data.tar.gz: 6324703732e85dd3d244f6bc54d70c5d6b5e8e75ace9ee131524884dc755e4120a0790d637d1e733a47216c062073e0b5c066f615cc4ba973f9ac58b9da318a4

data/README.md

@@ -15,6 +15,7 @@ Perfect for marketplaces, SaaS apps, CRMs, support systems, or global communitie
 - 🧩 **Rails Engine** — mounts directly inside your app
 - 📱 **API-only mode** — works with Rails API applications (auto-detected)
 - 👥 **Polymorphic associations** — supports multiple participant types (User, Vendor, Customer, etc.)
+- 📬 **Read receipts** — per-participant read/unread tracking with visual indicators (✓ sent, ✓✓ read)
 - 🔌 **Works with any ActiveJob backend** (Sidekiq, Solid Queue, Delayed Job, etc.)
 - 🔐 **Secure & scoped** ActionCable channels
 - 🧱 **Extendable architecture** (custom UI, custom providers, custom storage)
@@ -151,6 +152,51 @@ bundle exec sidekiq  # or bin/rails solid_queue:start, or bin/rails jobs:work
 
 ---
 
+## 🔄 Upgrading Existing Installations
+
+### Adding Read Receipts to Existing Installations
+
+If you're upgrading from a previous version and want to add message read receipts:
+
+```bash
+bin/rails generate polylingo_chat:read_receipts
+bin/rails db:migrate
+```
+
+This adds:
+- ✅ `polylingo_chat_message_read_receipts` table migration
+- ✅ Per-participant read/unread message tracking
+- ✅ Read receipt indicators in UI (✓ sent, ✓✓ read)
+- ✅ Unread message counts on conversation list
+- ✅ API endpoints for read receipt management
+- ✅ Automatic read tracking when viewing messages
+
+**New API Methods:**
+```ruby
+# Message methods
+message.mark_as_read_by(user)
+message.read_by?(user)
+message.unread_by?(user)
+message.read_at_by(user)
+
+# Conversation methods
+conversation.unread_messages_count_for(user)
+conversation.has_unread_messages_for?(user)
+
+# Query scopes
+Message.unread_by(user)
+Message.read_by(user)
+```
+
+**New API Endpoints:**
+- `POST /conversations/:conversation_id/messages/:id/mark_as_read` - Mark individual message as read
+- `POST /conversations/:id/mark_all_read` - Mark all messages as read
+- `GET /conversations/:id/unread_count` - Get unread count
+
+See `API_READ_RECEIPTS.md` for complete API documentation.
+
+---
+
 ## 🛠️ Advanced Installation
 
 ### API-Only Mode

data/lib/generators/polylingo_chat/install/install_generator.rb

@@ -28,6 +28,7 @@ module PolylingoChat
         migration_template "create_participants.rb", "db/migrate/create_polylingo_chat_participants.rb"
         migration_template "create_messages.rb", "db/migrate/create_polylingo_chat_messages.rb"
         migration_template "create_message_translations.rb", "db/migrate/create_polylingo_chat_message_translations.rb"
+        migration_template "create_message_read_receipts.rb", "db/migrate/create_polylingo_chat_message_read_receipts.rb"
       end
 
       def create_channels

data/lib/generators/polylingo_chat/install/templates/create_message_read_receipts.rb

@@ -0,0 +1,14 @@
+class CreatePolylingoChatMessageReadReceipts < ActiveRecord::Migration[<%= ActiveRecord::Migration.current_version %>]
+  def change
+    create_table :polylingo_chat_message_read_receipts do |t|
+      t.references :message, null: false, foreign_key: { to_table: :polylingo_chat_messages }
+      t.references :reader, polymorphic: true, null: false
+      t.datetime :read_at, null: false
+
+      t.timestamps
+    end
+
+    add_index :polylingo_chat_message_read_receipts, [:message_id, :reader_type, :reader_id], unique: true, name: 'idx_read_receipts_unique'
+    add_index :polylingo_chat_message_read_receipts, [:reader_type, :reader_id]
+  end
+end

data/lib/generators/polylingo_chat/read_receipts/read_receipts_generator.rb

@@ -0,0 +1,48 @@
+require 'rails/generators'
+require 'rails/generators/migration'
+
+module PolylingoChat
+  module Generators
+    class ReadReceiptsGenerator < Rails::Generators::Base
+      include Rails::Generators::Migration
+
+      source_root File.expand_path('../install/templates', __dir__)
+
+      desc "Adds message read receipts migration to existing PolylingoChat installation"
+
+      def self.next_migration_number(dirname)
+        next_migration_number = current_migration_number(dirname) + 1
+        ActiveRecord::Migration.next_migration_number(next_migration_number)
+      end
+
+      def copy_migration
+        migration_template "create_message_read_receipts.rb",
+                          "db/migrate/create_polylingo_chat_message_read_receipts.rb"
+      end
+
+      def show_instructions
+        say "\n" + "=" * 80, :green
+        say "Read receipts migration has been created!", :green
+        say "=" * 80, :green
+        say "\nNext steps:", :yellow
+        say "  1. Run: rails db:migrate"
+        say "  2. Messages will now automatically track read/unread status per participant"
+        say "\nNew features available:", :cyan
+        say "  - Message model:"
+        say "    • message.mark_as_read_by(user)"
+        say "    • message.read_by?(user)"
+        say "    • message.unread_by?(user)"
+        say "    • message.read_at_by(user)"
+        say "    • Message.unread_by(user)"
+        say "    • Message.read_by(user)"
+        say "\n  - Conversation model:"
+        say "    • conversation.unread_messages_count_for(user)"
+        say "    • conversation.has_unread_messages_for?(user)"
+        say "\n  - Views automatically show:"
+        say "    • Read receipts (✓✓) on sent messages"
+        say "    • Unread message counts on conversation list"
+        say "\n"
+      end
+    end
+  end
+end

data/lib/polylingo_chat/version.rb

@@ -1,3 +1,3 @@
 module PolylingoChat
-  VERSION = '0.4.1'
+  VERSION = '0.5.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: polylingo_chat
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.5.0
 platform: ruby
 authors:
 - Shoaib Malik
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-11-18 00:00:00.000000000 Z
+date: 2026-01-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -75,6 +75,7 @@ files:
 - lib/generators/polylingo_chat/install/templates/controllers/polylingo_chat/conversations_controller.rb
 - lib/generators/polylingo_chat/install/templates/controllers/polylingo_chat/messages_controller.rb
 - lib/generators/polylingo_chat/install/templates/create_conversations.rb
+- lib/generators/polylingo_chat/install/templates/create_message_read_receipts.rb
 - lib/generators/polylingo_chat/install/templates/create_message_translations.rb
 - lib/generators/polylingo_chat/install/templates/create_messages.rb
 - lib/generators/polylingo_chat/install/templates/create_participants.rb
@@ -88,6 +89,7 @@ files:
 - lib/generators/polylingo_chat/install/templates/models/participant.rb
 - lib/generators/polylingo_chat/install/templates/views/polylingo_chat/conversations/index.html.erb
 - lib/generators/polylingo_chat/install/templates/views/polylingo_chat/conversations/show.html.erb
+- lib/generators/polylingo_chat/read_receipts/read_receipts_generator.rb
 - lib/polylingo_chat.rb
 - lib/polylingo_chat/config.rb
 - lib/polylingo_chat/engine.rb