livechat 0.1.0

data/lib/livechat/widget.rb

@@ -0,0 +1,115 @@
+# frozen_string_literal: true
+
+require 'json'
+require 'digest'
+
+module Livechat
+  # Serves the self-contained browser widget. The JavaScript is plain ES (no
+  # framework, no build step) and styles itself inline, so it drops into any
+  # Rails app regardless of its CSS or JS setup. It lives under lib/ (not
+  # app/assets/) so a host that runs an asset pipeline never ingests it.
+  module Widget
+    SOURCE = File.expand_path('widget.js', __dir__)
+    DASHBOARD_SOURCE = File.expand_path('dashboard.js', __dir__)
+
+    # Right-to-left scripts, so the chat renders mirrored for those locales.
+    # Matched on the language subtag, so region variants ("ar-EG") count too.
+    RTL_LANGUAGES = %w[ar arc ckb dv fa ha he ks ku ps sd ug ur yi].freeze
+
+    class << self
+      def javascript
+        @javascript ||= File.read(SOURCE)
+      end
+
+      def dashboard_javascript
+        @dashboard_javascript ||= File.read(DASHBOARD_SOURCE)
+      end
+
+      # Content fingerprints for cache-busting script URLs: a changed file is
+      # a changed URL, so no browser can ever run stale widget code — Safari
+      # has been caught ignoring must-revalidate on same-URL scripts.
+      def fingerprint
+        @fingerprint ||= Digest::MD5.hexdigest(javascript)
+      end
+
+      def dashboard_fingerprint
+        @dashboard_fingerprint ||= Digest::MD5.hexdigest(dashboard_javascript)
+      end
+
+      # The two <script> tags the helper renders.
+      #
+      # The config rides in a `type="application/json"` block: it is *data*,
+      # not code, so the browser never executes it and Turbo never tries to
+      # re-run it on a soft visit — which means it needs no CSP nonce and the
+      # widget can re-read the *current* page's config on every `turbo:load`.
+      #
+      # The code is a same-origin `src` script served by the engine — NOT
+      # inlined. Under a nonce-based CSP, Turbo Drive body swaps re-run body
+      # scripts against the *original* page's CSP header, so a fresh inline
+      # 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:)
+        nonce_attr = nonce ? %( nonce="#{nonce}") : ''
+        src = "#{Livechat.config.mount_path.chomp('/')}/widget.js?v=#{fingerprint}"
+
+        %(<script type="application/json" data-livechat-config>#{json}</script>) +
+          %(<script src="#{src}" defer#{nonce_attr} data-livechat-widget></script>)
+      end
+
+      def config_json(locale:, authenticated:)
+        config = Livechat.config
+        payload = {
+          endpoint: config.widget_endpoint,
+          locale: locale.to_s,
+          rtl: rtl?(locale),
+          authenticated: authenticated ? true : false,
+          launcher: config.show_launcher ? true : false,
+          appName: Livechat.app_name,
+          accentColor: config.accent_color,
+          labels: labels
+        }
+        # Escape "</" so a value can't close the <script> block early.
+        payload.to_json.gsub('</', '<\/')
+      end
+
+      private
+
+      # Every user-facing string in the widget, resolved through Rails I18n so
+      # the chat follows the app's current locale. Each lookup carries an
+      # English default, so the widget stays fully worded even when a key is
+      # missing for the active locale.
+      def labels
+        config = Livechat.config
+        {
+          launcher: config.launcher_label.presence || t(:launcher, 'Chat with us'),
+          greeting: config.greeting.presence || t(:greeting, 'Hi! How can we help?'),
+          replyTime: config.reply_time_text.presence ||
+            t(:reply_time, 'We usually reply within a few hours.'),
+          placeholder: t(:placeholder, 'Write a message…'),
+          send: t(:send, 'Send'),
+          close: t(:close, 'Close'),
+          you: t(:you, 'You'),
+          team: t(:team, 'Support'),
+          emailPrompt: t(:email_prompt, 'Get a copy of our reply by email:'),
+          emailPlaceholder: t(:email_placeholder, 'you@example.com'),
+          emailSave: t(:email_save, 'Save'),
+          emailSaved: t(:email_saved, 'We will also reply by email.'),
+          eventResolved: t(:event_resolved, 'Conversation resolved'),
+          eventReopened: t(:event_reopened, 'Conversation reopened'),
+          errorSend: t(:error_send, 'Could not send. Please try again.'),
+          unreadAria: t(:unread_aria, 'unread messages')
+        }
+      end
+
+      def t(key, default, **args)
+        I18n.t(key, scope: :livechat, default: default, **args)
+      end
+
+      def rtl?(locale)
+        RTL_LANGUAGES.include?(locale.to_s.downcase.split(/[-_]/).first)
+      end
+    end
+  end
+end

data/lib/livechat.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+require 'livechat/version'
+require 'livechat/configuration'
+require 'livechat/widget'
+require 'livechat/notifications'
+require 'livechat/engine'
+
+# Live chat for Rails. A floating widget lets visitors — signed-in or
+# anonymous — message your team; your team answers from a built-in inbox at
+# the mount path, every reply signed with its author. Conversations live in
+# your own database. When nobody is around, visitors leave an email and the
+# thread continues there. No third-party script, no separate service.
+module Livechat
+  class << self
+    def config
+      @config ||= Configuration.new
+    end
+
+    def configure
+      yield config
+    end
+
+    # Can this request see the widget and write messages? Checked on the
+    # server for every widget endpoint and by the helper before rendering.
+    def enabled?(request)
+      !!config.enabled.call(request)
+    end
+
+    # Can this request work the inbox? Checked by every inbox action.
+    def agent?(request)
+      !!config.authorize_agent.call(request)
+    end
+
+    def app_name
+      config.app_name.presence || rails_app_name
+    end
+
+    # The public face of an agent message. Blank display names fall back to
+    # a localized "Support", so visitors always see a sender.
+    def display_name_for(agent_label)
+      name = config.agent_display_name.call(agent_label).presence
+      name || I18n.t(:team, scope: :livechat, default: 'Support')
+    end
+
+    private
+
+    # The application's module name, verbatim ("EthicsPortal", "SupeRails") —
+    # no inflection games. Set config.app_name for anything fancier.
+    def rails_app_name
+      Rails.application.class.module_parent_name
+    rescue StandardError
+      'this app'
+    end
+  end
+end

metadata

@@ -0,0 +1,125 @@
+--- !ruby/object:Gem::Specification
+name: livechat
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Yaroslav Shmarov
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.1'
+description: |
+  A mountable Rails engine that adds support chat to your app — the thing
+  you'd otherwise pay Crisp or Intercom for, or deploy Chatwoot to get. A
+  floating widget lets visitors (signed-in or anonymous) message your team;
+  your team answers from a built-in inbox where several teammates can work
+  the same thread, every reply signed with its author. When nobody is
+  around, visitors leave an email and the conversation continues there.
+  Conversations never leave your database. Framework-agnostic: no CSS or JS
+  framework required, works with Turbo Drive and strict CSPs.
+email:
+- yaroslav.shmarov@clickfunnels.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/controllers/livechat/application_controller.rb
+- app/controllers/livechat/conversations_controller.rb
+- app/controllers/livechat/messages_controller.rb
+- app/controllers/livechat/visitor_controller.rb
+- app/controllers/livechat/widgets_controller.rb
+- app/helpers/livechat/widget_helper.rb
+- app/mailers/livechat/mailer.rb
+- app/models/livechat/application_record.rb
+- app/models/livechat/conversation.rb
+- app/models/livechat/message.rb
+- app/views/layouts/livechat/application.html.erb
+- app/views/livechat/conversations/index.html.erb
+- app/views/livechat/conversations/show.html.erb
+- app/views/livechat/mailer/new_agent_reply.text.erb
+- app/views/livechat/mailer/new_visitor_message.text.erb
+- config/locales/livechat.ar.yml
+- config/locales/livechat.bg.yml
+- config/locales/livechat.bn.yml
+- config/locales/livechat.de.yml
+- config/locales/livechat.el.yml
+- config/locales/livechat.en.yml
+- config/locales/livechat.es.yml
+- config/locales/livechat.fr.yml
+- config/locales/livechat.hi.yml
+- config/locales/livechat.hr.yml
+- config/locales/livechat.id.yml
+- config/locales/livechat.it.yml
+- config/locales/livechat.ja.yml
+- config/locales/livechat.ko.yml
+- config/locales/livechat.lb.yml
+- config/locales/livechat.nl.yml
+- config/locales/livechat.pl.yml
+- config/locales/livechat.pt.yml
+- config/locales/livechat.ro.yml
+- config/locales/livechat.ru.yml
+- config/locales/livechat.th.yml
+- config/locales/livechat.tr.yml
+- config/locales/livechat.uk.yml
+- config/locales/livechat.ur.yml
+- config/locales/livechat.vi.yml
+- config/locales/livechat.zh-CN.yml
+- config/routes.rb
+- lib/generators/livechat/install/install_generator.rb
+- lib/generators/livechat/install/templates/create_livechat_tables.rb.tt
+- lib/generators/livechat/install/templates/initializer.rb
+- lib/livechat.rb
+- lib/livechat/configuration.rb
+- lib/livechat/dashboard.js
+- lib/livechat/engine.rb
+- lib/livechat/notifications.rb
+- lib/livechat/version.rb
+- lib/livechat/widget.js
+- lib/livechat/widget.rb
+homepage: https://github.com/yshmarov/livechat
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/yshmarov/livechat
+  source_code_uri: https://github.com/yshmarov/livechat
+  changelog_uri: https://github.com/yshmarov/livechat/blob/main/CHANGELOG.md
+  bug_tracker_uri: https://github.com/yshmarov/livechat/issues
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.2'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 4.0.6
+specification_version: 4
+summary: 'Open-source live chat for Rails: a drop-in support widget plus a team inbox,
+  in your own database.'
+test_files: []