livechat 0.6.8 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a2ad48b9206502c979af98f3733631b26075e08efe04c9044e0e5969d21bc7f3
-  data.tar.gz: b40e4efc2e6a014c34104abd860bafc41a330eebd863ad6f8e4663a41bc280fa
+  metadata.gz: 3068cc97c1460ba3cec4f85670bf78b94a98ad38bbc6acf9e244b35b70f7c49c
+  data.tar.gz: 0f384fe194ed0cafae68da41e3bcd20d80f7ff56e89aafdb25f10265ba4202c5
 SHA512:
-  metadata.gz: 19c4dc8d3f683af308f34df8341d5e8221d434bad217e0291a34a1da799afe8029e1e423dbf549d48c341cf7114c7fb14336fef47c7049cd087992d9d0492138
-  data.tar.gz: 4459c416ea3a0ed27422847f41bbef950f11420d448c44ac5b02af0e5cca257eae0ec42e33d7cb5e7cd5f9d6c2d84ba35c6b94b92eb18c68f90cc132375da258
+  metadata.gz: 66fcad915c30d22220db8730e8c2f8433e96dd8db1bfae6e33e2e162230a60e93c9829467135526e797c34c4f82e910c48f4c057adb0fa201db97694f673f9ec
+  data.tar.gz: f13d5a99530347b8ca35eec44e9e4520e595f1d485353cff4b6700251845e3ff6bbd8c6023a4ffb6a0ba9768f389c7cc6bb07afc862113387a689d153314160b

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## 0.7.0
+
+- Added `config.avatar_url`, accepting a URL or per-request callable, to show
+  an optional customer-facing avatar in the visitor widget header. Failed
+  images disappear cleanly, and external image requests omit the referrer.
+- Added `bin/rails livechat:seed_demo` for idempotent sample conversations in
+  development and demo environments.
+
 ## 0.6.8
 
 - Fixed Rails 7.1 compatibility for attachment configuration by avoiding the

data/README.md

@@ -36,6 +36,16 @@ bin/rails db:migrate
 That's it. Visit any page, click the bubble, say hi. Answer yourself at
 `/livechat`.
 
+Optional demo data:
+
+```bash
+bin/rails livechat:seed_demo
+```
+
+It creates two idempotent sample conversations: one open thread with an unread
+visitor reply, and one resolved thread. Running the task again refreshes those
+demo messages instead of duplicating conversations.
+
 > [!IMPORTANT]
 > The inbox defaults to **development only**. Set `authorize_agent` before you
 > deploy — see [Configure](#configure).
@@ -117,6 +127,7 @@ Everything is optional — a fresh install works with zero config. In
 | `greeting` | localized default | First message visitors see |
 | `reply_time_text` | localized default | "We usually reply within a few hours" |
 | `launcher_label` | localized default | Text on the bubble |
+| `avatar_url` | `nil` | Customer-facing avatar in the widget header; URL or per-request callable |
 | `accent_color` | `nil` | One hex restyles launcher, header, bubbles, send button |
 | `show_launcher` | `true` | `false` hides the bubble — bring your own entry point |
 | `visitor_label` | name, else email | How a visitor is labelled in the inbox |
@@ -145,10 +156,20 @@ Livechat.configure do |config|
   config.mailer_from      = "chat@example.com"
   config.agent_emails     = -> { User.where(admin: true).pluck(:email) }
   config.reply_time_text  = "We usually reply within an hour."
+  config.avatar_url       = "/support-avatar.png"
   config.accent_color     = "#7c3aed"
 end
 ```
 
+`avatar_url` can also choose branding from the current request:
+
+```ruby
+config.avatar_url = ->(request) { request.env["current_account"]&.support_avatar_url }
+```
+
+Prefer a same-origin image. If the URL uses another host, allow that host in
+your application's `img-src` Content Security Policy.
+
 Gates receive the **raw request**, so they work with any auth:
 
 ```ruby

data/app/helpers/livechat/widget_helper.rb

@@ -13,6 +13,7 @@ module Livechat
       Widget.snippet(
         locale: I18n.locale,
         authenticated: livechat_visitor.present?,
+        avatar_url: livechat_avatar_url,
         nonce: (content_security_policy_nonce if respond_to?(:content_security_policy_nonce))
       ).html_safe
     end
@@ -33,6 +34,12 @@ module Livechat
 
     private
 
+    def livechat_avatar_url
+      value = Livechat.config.avatar_url
+      value = value.call(request) if value.respond_to?(:call)
+      value.to_s.presence
+    end
+
     def livechat_visitor
       return @livechat_visitor if defined?(@livechat_visitor)
 

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

@@ -29,6 +29,7 @@ module Livechat
         say "\nlivechat installed. Run `rails db:migrate`, then add", :green
         say '`<%= livechat_tag %>` before </body> in your layout.'
         say 'Answer visitors at /livechat (development only until you set config.authorize_agent).'
+        say 'Optional: run `bin/rails livechat:seed_demo` for sample conversations.'
         say "Set config.mailer_from + config.agent_emails to hear about new messages by email.\n"
       end
 

data/lib/generators/livechat/install/templates/initializer.rb

@@ -45,6 +45,11 @@ Livechat.configure do |config|
   # config.reply_time_text = "We usually reply within a few hours."
   # config.launcher_label = "Chat with us"
 
+  # Optional customer-facing avatar in the widget header. Use a URL string,
+  # or resolve one per request (for example, for tenant-specific branding).
+  # config.avatar_url = "/support-avatar.png"
+  # config.avatar_url = ->(request) { request.env["current_account"]&.support_avatar_url }
+
   # Brand color (hex) for the launcher, header, bubbles and send button.
   # Text flips black/white automatically for contrast. nil = built-in blue.
   # config.accent_color = "#7c3aed"

data/lib/livechat/configuration.rb

@@ -44,6 +44,11 @@ module Livechat
     # honest line under the greeting — "We usually reply within a few hours."
     attr_accessor :greeting, :reply_time_text, :launcher_label
 
+    # Optional customer-facing avatar shown in the widget header. Use a URL
+    # string, or a callable receiving the request for tenant-specific branding.
+    # nil keeps the text-only header.
+    attr_accessor :avatar_url
+
     # Brand color for the widget (launcher, header, visitor bubbles, send
     # button) as a hex value, e.g. "#7c3aed". The widget picks black or white
     # text automatically for contrast. nil keeps the built-in blue.
@@ -112,6 +117,7 @@ module Livechat
       @greeting = nil
       @reply_time_text = nil
       @launcher_label = nil
+      @avatar_url = nil
       @accent_color = nil
       @show_launcher = true
       @agent_emails = nil

data/lib/livechat/engine.rb

@@ -4,6 +4,10 @@ module Livechat
   class Engine < ::Rails::Engine
     isolate_namespace Livechat
 
+    rake_tasks do
+      load File.expand_path('../tasks/livechat_tasks.rake', __dir__)
+    end
+
     initializer 'livechat.helpers' do
       ActiveSupport.on_load(:action_view) do
         include Livechat::WidgetHelper

data/lib/livechat/seeds.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+module Livechat
+  module Seeds
+    THREADS = [
+      {
+        visitor_token: 'livechat-demo-checkout',
+        visitor_label: 'Demo Customer',
+        visitor_email: 'customer@example.com',
+        page_url: '/checkout',
+        locale: 'en',
+        status: 'open',
+        messages: [
+          {
+            author_type: 'visitor',
+            body: 'I am trying to finish checkout, but the payment button keeps spinning.',
+            read_at: true
+          },
+          {
+            author_type: 'agent',
+            agent_id: 'livechat-demo-agent',
+            agent_label: 'Demo Support',
+            body: 'Thanks for the details. I am checking the payment logs now.',
+            read_at: true
+          },
+          { author_type: 'visitor', body: 'The order number is #DEMO-1042.' }
+        ]
+      },
+      {
+        visitor_token: 'livechat-demo-resolved',
+        visitor_label: 'Demo Admin',
+        visitor_email: 'admin@example.com',
+        page_url: '/settings/billing',
+        locale: 'en',
+        status: 'resolved',
+        messages: [
+          { author_type: 'visitor', body: 'Where can I download last month\'s invoice?' },
+          {
+            author_type: 'agent',
+            agent_id: 'livechat-demo-agent',
+            agent_label: 'Demo Support',
+            body: 'Open Settings, then Billing, then click Download next to the invoice.',
+            read_at: true
+          },
+          {
+            author_type: 'system',
+            agent_label: 'Demo Support',
+            event: 'resolved'
+          }
+        ]
+      }
+    ].freeze
+
+    def self.load!
+      THREADS.map do |attributes|
+        conversation = Livechat::Conversation.find_or_initialize_by(
+          visitor_token: attributes.fetch(:visitor_token),
+          visitor_id: nil
+        )
+        conversation.assign_attributes(attributes.except(:messages))
+        conversation.save!
+        conversation.messages.destroy_all
+        attributes.fetch(:messages).each do |message_attributes|
+          conversation.messages.create!(message_attributes.merge(read_at_value(message_attributes)))
+        end
+        conversation.reload
+      end
+    end
+
+    def self.read_at_value(attributes)
+      attributes[:read_at] ? { read_at: Time.current } : {}
+    end
+    private_class_method :read_at_value
+  end
+end

data/lib/livechat/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Livechat
-  VERSION = '0.6.8'
+  VERSION = '0.7.0'
 end

data/lib/livechat/widget.js

@@ -217,14 +217,27 @@
 
     var header = document.createElement("div");
     header.id = "lvc-header";
+    var identity = document.createElement("div");
+    identity.id = "lvc-identity";
+    if (config.avatarUrl) {
+      var avatar = document.createElement("img");
+      avatar.id = "lvc-avatar";
+      avatar.src = config.avatarUrl;
+      avatar.alt = "";
+      avatar.referrerPolicy = "no-referrer";
+      avatar.addEventListener("error", function () { avatar.remove(); });
+      identity.appendChild(avatar);
+    }
     var titles = document.createElement("div");
+    titles.id = "lvc-titles";
     var title = document.createElement("strong");
     title.textContent = config.appName;
     var subtitle = document.createElement("span");
     subtitle.textContent = config.labels.replyTime;
     titles.appendChild(title);
     titles.appendChild(subtitle);
-    header.appendChild(titles);
+    identity.appendChild(titles);
+    header.appendChild(identity);
 
     var actions = document.createElement("div");
     actions.id = "lvc-actions";
@@ -1219,6 +1232,10 @@
       "#lvc-header{position:relative;z-index:2;flex-shrink:0;display:flex;align-items:flex-start;" +
       "justify-content:space-between;gap:8px;padding:14px 16px;background:var(--lvc-accent);" +
       "color:var(--lvc-accent-text)}" +
+      "#lvc-identity{display:flex;align-items:center;gap:10px;min-width:0}" +
+      "#lvc-avatar{width:44px;height:44px;flex:0 0 44px;border-radius:50%;object-fit:cover;" +
+      "border:2px solid rgba(255,255,255,.35);background:rgba(255,255,255,.15)}" +
+      "#lvc-titles{min-width:0}" +
       "#lvc-header strong{display:block;font-size:15px}" +
       "#lvc-header span{display:block;font-size:12px;opacity:.85;margin-top:2px}" +
       "#lvc-actions{display:flex;align-items:center;gap:2px}" +

data/lib/livechat/widget.rb

@@ -58,8 +58,8 @@ module Livechat
       # nonce gets refused; a same-origin src is covered by `'self'` on every
       # visit. `nonce:` is still stamped for hosts whose script-src has no
       # 'self'; pass nil when the app has no nonce.
-      def snippet(locale:, authenticated:, nonce: nil)
-        json = config_json(locale:, authenticated:)
+      def snippet(locale:, authenticated:, avatar_url: nil, nonce: nil)
+        json = config_json(locale:, authenticated:, avatar_url:)
         nonce_attr = nonce ? %( nonce="#{nonce}") : ''
         src = "#{Livechat.config.mount_path.chomp('/')}/widget.js?v=#{fingerprint}"
 
@@ -67,7 +67,7 @@ module Livechat
           %(<script src="#{src}" defer#{nonce_attr} data-livechat-widget></script>)
       end
 
-      def config_json(locale:, authenticated:)
+      def config_json(locale:, authenticated:, avatar_url: nil)
         config = Livechat.config
         payload = {
           endpoint: config.widget_endpoint,
@@ -76,6 +76,7 @@ module Livechat
           authenticated: authenticated ? true : false,
           launcher: config.show_launcher ? true : false,
           appName: Livechat.app_name,
+          avatarUrl: avatar_url,
           accentColor: config.accent_color,
           attachments: Livechat.attachments_enabled?,
           maxAttachments: config.max_attachments,

data/lib/livechat.rb

@@ -4,6 +4,7 @@ require 'livechat/version'
 require 'livechat/configuration'
 require 'livechat/widget'
 require 'livechat/notifications'
+require 'livechat/seeds'
 require 'livechat/engine'
 
 # Live chat for Rails. A floating widget lets visitors — signed-in or

data/lib/tasks/livechat_tasks.rake

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+namespace :livechat do
+  desc 'Create or refresh livechat demo conversations'
+  task seed_demo: :environment do
+    conversations = Livechat::Seeds.load!
+    puts "Seeded #{conversations.size} livechat demo conversations."
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: livechat
 version: !ruby/object:Gem::Version
-  version: 0.6.8
+  version: 0.7.0
 platform: ruby
 authors:
 - Yaroslav Shmarov
@@ -97,9 +97,11 @@ files:
 - lib/livechat/dashboard.js
 - lib/livechat/engine.rb
 - lib/livechat/notifications.rb
+- lib/livechat/seeds.rb
 - lib/livechat/version.rb
 - lib/livechat/widget.js
 - lib/livechat/widget.rb
+- lib/tasks/livechat_tasks.rake
 homepage: https://github.com/yshmarov/livechat
 licenses:
 - MIT