Module: Testimonials::Widget

Defined in:

lib/testimonials/widget.rb

Overview

Serves the self-contained browser widget. The JavaScript is plain ES (no framework, no build step) and injects its own widget styles, so it drops into any Rails app regardless of its CSS or JS setup. The code is served by the engine instead of the host's asset pipeline, and it lives under lib/ so a host that does run a pipeline never ingests it either.

Constant Summary

SOURCE =

File.expand_path('widget.js', __dir__)

DASHBOARD_SOURCE =

File.expand_path('dashboard.js', __dir__)

DASHBOARD_STYLESHEET_SOURCE =

File.expand_path('dashboard.css', __dir__)

RTL_LANGUAGES =

Right-to-left scripts, so the form renders mirrored for those locales. Matched on the language subtag, so region variants ("ar-EG") count too.

%w[ar arc ckb dv fa ha he ks ku ps sd ug ur yi].freeze

Class Method Summary

• .config_json(locale:, authenticated:, auto_open:, mode:, existing: nil) ⇒ Object
• .dashboard_fingerprint ⇒ Object
• .dashboard_javascript ⇒ Object
• .dashboard_stylesheet ⇒ Object
• .dashboard_stylesheet_fingerprint ⇒ Object
• .fingerprint ⇒ Object

  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.

• .javascript ⇒ Object
• .snippet(locale:, authenticated:, auto_open: nil, mode: 'widget', existing: nil, nonce: nil) ⇒ Object

  The two

  # File 'lib/testimonials/widget.rb', line 71
  
  def config_json(locale:, authenticated:, auto_open:, mode:, existing: nil)
    config = Testimonials.config
    payload = {
      endpoints: {
        testimonials: config.testimonials_endpoint,
        nps: config.nps_endpoint,
        events: config.events_endpoint
      },
      locale: locale.to_s,
      rtl: rtl?(locale),
      authenticated: authenticated ? true : false,
      autoOpen: auto_open&.to_s,
      mode: mode.to_s,
      questions: Testimonials.questions,
      consent: {
        prompt: t(:consent_prompt, 'Where can we use your testimonial?'),
        public: Testimonials.consent_text,
        private: Testimonials.consent_text_private
      },
      # The signed-in user's current review, if any: the widget opens it
      # pre-filled for editing instead of starting a second one — rating,
      # text, consent state, and a playable URL for an attached video.
      existing: existing && {
        rating: existing.rating,
        body: existing.body,
        consent: existing.consent_given ? true : false,
        videoUrl: existing_video_url(existing),
        posterUrl: existing_poster_url(existing)
      },
      video: {
        enabled: config.video_enabled?,
        maxSeconds: config.max_video_seconds.to_i,
        maxSize: config.max_video_size.to_i
      },
      avatars: {
        enabled: config.avatars_enabled?,
        maxSize: config.max_avatar_size.to_i
      },
      nps: { enabled: config.nps ? true : false },
      # The throttle ledger. Off, and the widget skips the shown/dismissed
      # posts: the endpoint would only refuse them.
      promptEvents: { enabled: config.prompt_events ? true : false },
      labels: labels
    }
    # Escape "</" so a value can't close the <script> block early.
    payload.to_json.gsub('</', '<\/')
  end

  .dashboard_fingerprint ⇒ Object

  # File 'lib/testimonials/widget.rb', line 41
  
  def dashboard_fingerprint
    @dashboard_fingerprint ||= Digest::MD5.hexdigest(dashboard_javascript)
  end

  .dashboard_javascript ⇒ Object

  # File 'lib/testimonials/widget.rb', line 26
  
  def dashboard_javascript
    @dashboard_javascript ||= File.read(DASHBOARD_SOURCE)
  end

  .dashboard_stylesheet ⇒ Object

  # File 'lib/testimonials/widget.rb', line 30
  
  def dashboard_stylesheet
    @dashboard_stylesheet ||= File.read(DASHBOARD_STYLESHEET_SOURCE)
  end

  .dashboard_stylesheet_fingerprint ⇒ Object

  # File 'lib/testimonials/widget.rb', line 45
  
  def dashboard_stylesheet_fingerprint
    @dashboard_stylesheet_fingerprint ||= Digest::MD5.hexdigest(dashboard_stylesheet)
  end

  .fingerprint ⇒ Object

  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.

  # File 'lib/testimonials/widget.rb', line 37
  
  def fingerprint
    @fingerprint ||= Digest::MD5.hexdigest(javascript)
  end

  .javascript ⇒ Object

  # File 'lib/testimonials/widget.rb', line 22
  
  def javascript
    @javascript ||= File.read(SOURCE)
  end

  .snippet(locale:, authenticated:, auto_open: nil, mode: 'widget', existing: nil, nonce: nil) ⇒ Object

  The two