bridgetown-ai-chatbot 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ec8a22027dea0a642f58f72dc9f1ea495fc7ba4e424eb6139445f2e78755d048
+  data.tar.gz: f742004f93f182466e5435c286b665730f3e9b92d724979cce44bace1a8898e7
+SHA512:
+  metadata.gz: 067652eae23aedca9679dcec2a24902d7407dc440b2e3d1a671a87f2c5f14fc1645288e12bbf616c78dc79ff1ae76b9dbe6806f7f4e75687e80f061ddc56fd88
+  data.tar.gz: 0ed08586920bb6c31e0cfccc1c12478c1aec91ebaeabab5cdc25a44a1fe65488f04ece64bc44a977c2425a14b55b0de2de463cb493745a50511ab41180815e7a

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Asyntai
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,81 @@
+# bridgetown-ai-chatbot
+
+Add the [Asyntai](https://asyntai.com) AI chat assistant to your Bridgetown
+site. It answers visitor questions from your own content, in more than 80
+languages.
+
+## Install
+
+```bash
+bundle add bridgetown-ai-chatbot
+```
+
+Then add the plugin in `config/initializers.rb`:
+
+```ruby
+Bridgetown.configure do |config|
+  init :"bridgetown-ai-chatbot", widget_id: "asyntai_1a2b3c4d5e6f"
+end
+```
+
+Build the site. The chat bubble is on every page.
+
+## Where the widget ID comes from
+
+Open the Install page in your [Asyntai dashboard](https://asyntai.com/dashboard).
+The widget ID is the value of `data-asyntai-id` in the snippet shown there. It
+starts with `asyntai_`.
+
+Creating an account is free, and the Free plan is enough to try the widget.
+
+## Options
+
+| Option | Type | Default | What it does |
+| --- | --- | --- | --- |
+| `widget_id` | string | required | Your Asyntai widget ID |
+| `enable_in_development` | boolean | `true` | Set to `false` to keep the widget off the site while `BRIDGETOWN_ENV` is `development` |
+| `script_url` | string | the Asyntai CDN | Advanced. Load the widget from another URL |
+
+You can also use the block form:
+
+```ruby
+init :"bridgetown-ai-chatbot" do
+  widget_id "asyntai_1a2b3c4d5e6f"
+  enable_in_development false
+end
+```
+
+A missing or malformed `widget_id` stops the build with a message that says how
+to fix it.
+
+## What the plugin does
+
+- It adds the Asyntai loader to every HTML page, just before `</body>`.
+  That includes pages from collections, posts and pagination.
+- The loader waits for the page's `load` event, so your own content always
+  renders first.
+- Feeds, JSON and other non-HTML files stay as they are.
+- A page that already has the Asyntai snippet keeps it and gets no second one.
+
+It works with every template engine: ERB, Serbea and Liquid.
+
+Tested with Bridgetown 1.3 and 2.2.
+
+## Answering from your content
+
+Asyntai reads your published pages. Add your site URL in the dashboard, and the
+assistant answers from the same pages the widget sits on. You can also add extra
+documents and question and answer pairs.
+
+## Removing it
+
+Delete the `init` line and build again. The widget is gone.
+
+## Support
+
+Email [hello@asyntai.com](mailto:hello@asyntai.com), or read the
+[Bridgetown guide](https://asyntai.com/documentation/integrations/bridgetown/).
+
+## Licence
+
+MIT. See [LICENSE](LICENSE).

data/lib/bridgetown-ai-chatbot/core.rb

@@ -0,0 +1,111 @@
+# frozen_string_literal: true
+
+# Asyntai AI chatbot for Bridgetown: the logic, without the initializer, so
+# it can be tested outside a Bridgetown build.
+#
+# Adds the Asyntai chat widget to every HTML page the site builds. The plugin
+# hooks into rendering: after a page is rendered, it puts the ordinary embed
+# loader just before </body> and changes nothing else about the page.
+
+require "json"
+require "bridgetown"
+require "bridgetown-ai-chatbot/version"
+
+module BridgetownAiChatbot
+  DEFAULT_SCRIPT_URL = "https://widget.asyntai.com/static/js/chat-widget.js"
+  WIDGET_ID_PATTERN = /\Aasyntai_[A-Za-z0-9]+\z/
+  NAME = "bridgetown-ai-chatbot"
+
+  class ConfigurationError < StandardError; end
+
+  Settings = Struct.new(:widget_id, :script_url, :enable_in_development, keyword_init: true)
+
+  module_function
+
+  # Bridgetown runs the initializer before it builds anything, so a wrong option
+  # stops the build with a clear message instead of producing a site with no chat.
+  def validate_options(options)
+    opts = (options || {}).to_h.transform_keys(&:to_sym)
+    widget_id = opts[:widget_id].is_a?(String) ? opts[:widget_id].strip : ""
+
+    if widget_id.empty?
+      raise ConfigurationError,
+            "#{NAME}: \"widget_id\" is required. Copy it from the Install page of your " \
+            "Asyntai dashboard, for example asyntai_1a2b3c4d5e6f."
+    end
+    unless WIDGET_ID_PATTERN.match?(widget_id)
+      raise ConfigurationError,
+            "#{NAME}: \"#{widget_id}\" does not look like a widget ID. It starts with " \
+            "asyntai_, for example asyntai_1a2b3c4d5e6f."
+    end
+
+    script_url = opts[:script_url].is_a?(String) && !opts[:script_url].strip.empty? ?
+      opts[:script_url].strip : DEFAULT_SCRIPT_URL
+
+    Settings.new(
+      widget_id: widget_id,
+      script_url: script_url,
+      # Set to false to keep the widget off the site while BRIDGETOWN_ENV is development.
+      enable_in_development: opts[:enable_in_development] != false
+    )
+  end
+
+  # JSON string, safe inside an HTML <script> element.
+  def js_string(value)
+    JSON.generate(value.to_s).gsub("<", "\\u003c")
+  end
+
+  # The loader waits for the page's load event before it fetches the widget.
+  # An ordinary `<script async src>` holds the load event open until its own
+  # fetch finishes, so an unreachable server would delay the host page. This
+  # pattern cannot.
+  def build_loader(widget_id, script_url)
+    "(function(){var l=function(){" \
+      "if(document.querySelector(\"script[data-asyntai-id]\"))return;" \
+      "var s=document.createElement(\"script\");" \
+      "s.src=#{js_string(script_url)};s.async=true;" \
+      "s.setAttribute(\"data-asyntai-id\",#{js_string(widget_id)});" \
+      "document.head.appendChild(s)};" \
+      "if(document.readyState===\"complete\"){l()}" \
+      "else{window.addEventListener(\"load\",l)}})();"
+  end
+
+  def build_tag(settings)
+    "<script data-asyntai-loader>#{build_loader(settings.widget_id, settings.script_url)}</script>"
+  end
+
+  # Puts the tag before the last </body>, or before </html> when the page has no
+  # body tag. A fragment with neither is left alone: it is not a whole page.
+  # A page that already carries an Asyntai snippet is left alone too.
+  def inject_into_html(html, tag)
+    return html unless html.is_a?(String)
+    return html if html.include?("data-asyntai-id")
+
+    lower = html.downcase
+    at = lower.rindex("</body>") || lower.rindex("</html>")
+    return html if at.nil?
+
+    html[0...at] + tag + html[at..]
+  end
+
+  # Only pages that are written to disk as .html get the widget. Feeds, JSON,
+  # CSS and pages with `permalink: false` stay as they are.
+  def html_output?(document)
+    if document.respond_to?(:write?)
+      return false unless document.write?
+    end
+    ext = document.respond_to?(:output_ext) ? document.output_ext.to_s.downcase : ""
+    [".html", ".htm"].include?(ext)
+  end
+
+  def development?
+    Bridgetown.environment.to_s == "development"
+  end
+
+  def apply(document, settings, tag)
+    return if !settings.enable_in_development && development?
+    return unless html_output?(document)
+
+    document.output = inject_into_html(document.output, tag)
+  end
+end

data/lib/bridgetown-ai-chatbot/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module BridgetownAiChatbot
+  VERSION = "1.0.0"
+end

data/lib/bridgetown-ai-chatbot.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+# Asyntai AI chatbot for Bridgetown.
+#
+# In config/initializers.rb:
+#
+#   init :"bridgetown-ai-chatbot", widget_id: "asyntai_1a2b3c4d5e6f"
+
+require "bridgetown-ai-chatbot/core"
+
+Bridgetown.initializer :"bridgetown-ai-chatbot" do |config, **options|
+  settings = BridgetownAiChatbot.validate_options(options)
+  tag = BridgetownAiChatbot.build_tag(settings)
+
+  # Low priority, so the widget goes in after other plugins change the page.
+  config.hook :resources, :post_render, priority: :low do |resource|
+    BridgetownAiChatbot.apply(resource, settings, tag)
+  end
+  config.hook :generated_pages, :post_render, priority: :low do |page|
+    BridgetownAiChatbot.apply(page, settings, tag)
+  end
+end

metadata

@@ -0,0 +1,72 @@
+--- !ruby/object:Gem::Specification
+name: bridgetown-ai-chatbot
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Asyntai
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2026-10-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bridgetown
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Adds the Asyntai AI chatbot to every page of your Bridgetown site. It
+  answers visitor questions from your own content, in 80+ languages.
+email: hello@asyntai.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/bridgetown-ai-chatbot.rb
+- lib/bridgetown-ai-chatbot/core.rb
+- lib/bridgetown-ai-chatbot/version.rb
+homepage: https://asyntai.com/documentation/integrations/bridgetown/
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://asyntai.com/documentation/integrations/bridgetown/
+  source_code_uri: https://github.com/asyntai/bridgetown-ai-chatbot
+  bug_tracker_uri: https://github.com/asyntai/bridgetown-ai-chatbot/issues
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.7'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.22
+signing_key:
+specification_version: 4
+summary: Add the Asyntai AI chat assistant to your Bridgetown site.
+test_files: []