layered-assistant-rails 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7b9f6574ccdd2e1fe605f6f74bcb50feb69c6eca079a5d5add6bc1b615488972
+  data.tar.gz: cc618f8dde0d9211ae7445dc10f0f75f6e63012a5b3c52a66afbca595ed1aa7f
+SHA512:
+  metadata.gz: 1b853a8464bf2eb6507d8287cefc46c51268e908fe0c6045e6d2265084fd829aec1b6ebfb92cf2a35f41ca15f3a85a19bc1c756c91678e6d872c3234888ff443
+  data.tar.gz: ca37eee8b57612ab350522dec5cbc46c334ed168043d2c8ee581813d1ba224ae42e5c685618669f2af76b61c0c81c46eb044564a3008de3c137ce670cf987c81

data/AGENTS.md

@@ -0,0 +1,94 @@
+# AGENTS.md
+
+This file provides guidance to AI agents when working with code in this repository.
+
+## Project Overview
+
+**layered-assistant-rails** is a Rails 8+ engine gem (`Layered::Assistant`) providing AI assistant UI components. It uses `isolate_namespace Layered::Assistant` and distributes assets (Tailwind CSS + importmap JS) to host applications via a generator.
+
+Requires Rails >= 8.0.0, Ruby >= 3.2.0. Depends on sibling gem `layered-ui-rails` (path dependency at `../layered-ui-rails`).
+
+## Architecture
+
+### Engine Setup
+
+- **Entry point**: `lib/layered-assistant-rails.rb` → `lib/layered/assistant.rb`
+- **Engine**: `lib/layered/assistant/engine.rb` — registers importmap paths and JS asset paths via two initializers
+- **Namespace**: All models/controllers use `Layered::Assistant::*`, tables prefixed `layered_assistant_*`
+
+### Asset Distribution
+
+CSS and JS are authored in the engine and delivered to host apps:
+
+- **CSS**: `app/assets/tailwind/layered/assistant/styles.css` — copied to host app by the install generator
+- **JS**: `app/javascript/layered_assistant/index.js` — pinned via `config/importmap.rb`, made available through engine initializer
+
+The install generator (`lib/generators/layered/assistant/install_generator.rb`) verifies `layered-ui-rails` is installed first, then copies CSS and injects import lines into `application.css` and `application.js`.
+
+### Test Harness
+
+`test/dummy/` is a full Rails 8 app with Devise authentication used for development and testing. Test helper loads migrations from both `db/migrate/` (engine) and `test/dummy/db/migrate/`.
+
+You can run the tests with: `bundle exec rake test`
+
+## Conventions
+
+### Database
+
+- Enums stored as strings (not integers)
+- Tables prefixed `layered_assistant_`
+- Models inherit from `Layered::Assistant::ApplicationRecord`
+
+### Generators
+
+Verify dependencies before modifying host app files. Use `inject_into_file` for safe insertion. Check for existing imports to ensure idempotency.
+
+## Making changes to `layered-ui-rails`
+
+The UI kit gem for this app is located at `../layered-ui-rails`.
+You can find and make edits to that project directly if necessary.
+It has its own `AGENTS.md` file — inspect it for context on the apps's conventions, architecture, and development workflows.
+
+## Conventions
+
+- Use "layered-ui-assistant" not "Layered UI" when referring to the project
+- Use normal dashes '-' not long ones '—'
+- Locale: Favour en-GB (British English), unless terms are defined by technical standards (e.g. LICENSE, COLOR).
+- Titles: capitalise first word only (e.g. "This title")
+- Document new styles in the dummy app
+- Use l-ui classes only in engine views, with no additional Tailwind utilities, as Tailwind classes referenced only inside the engine will not be generated by the host app’s build
+- Importmap for JS (no bundler)
+
+- CRITICAL: Retain WCAG 2.2 AA compliance. Do not be too pedantic though as this introduces audit loops which are undesirable.
+- A WCAG 2.2 AA table looks like this:
+```
+<table>
+  <caption>Agent availability by region</caption>
+
+  <thead>
+    <tr>
+      <th scope="col">Agent</th>
+      <th scope="col">Region</th>
+      <th scope="col">Status</th>
+    </tr>
+  </thead>
+
+  <tbody>
+    <tr>
+      <th scope="row">Agent A</th>
+      <td>UK</td>
+      <td>Available</td>
+    </tr>
+    <tr>
+      <th scope="row">Agent B</th>
+      <td>EU</td>
+      <td>Busy</td>
+    </tr>
+    <tr>
+      <th scope="row">Agent C</th>
+      <td>US</td>
+      <td>Offline</td>
+    </tr>
+  </tbody>
+</table>
+```

data/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 LAYERED AI LIMITED (UK company number: 17056830)
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,176 @@
+# layered-assistant-rails
+
+[![CI](https://github.com/layered-ai-public/layered-ui-rails/actions/workflows/ci.yml/badge.svg)](https://github.com/layered-ai-public/layered-assistant-rails/actions/workflows/ci.yml)
+[![WCAG 2.2 AA](https://img.shields.io/badge/WCAG_2.2-AA-green)](https://www.w3.org/WAI/WCAG22/quickref/)
+[![License: Apache 2.0](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
+[![Website](https://img.shields.io/badge/Website-layered.ai-purple)](https://www.layered.ai/)
+[![GitHub](https://img.shields.io/badge/GitHub-layered--assistant--rails-black)](https://github.com/layered-ai-public/layered-assistant-rails)
+[![Discord](https://img.shields.io/badge/Discord-join-5865F2)](https://discord.gg/aCGqz9Bx)
+
+An open source Rails 8+ engine built on [layered-ui-rails](https://github.com/layered-ai-public/layered-ui-rails) that provides a multi-provider AI assistant with streaming responses and a full conversation UI.
+
+## Requirements
+
+- Ruby >= 3.2.0
+- Ruby on Rails >= 8.0
+- [layered-ui-rails](https://github.com/layered-ai-public/layered-ui-rails) installed in the host app
+
+## Installation
+
+Add to your Gemfile:
+
+```ruby
+gem "layered-assistant-rails"
+```
+
+Then run:
+
+```bash
+bundle install
+```
+
+## Setup
+
+### Install generator
+
+Run the install generator to copy CSS and register imports:
+
+```bash
+bin/rails generate layered:assistant:install
+```
+
+This will:
+- Copy `layered_ui.css` to `app/assets/tailwind/`
+- Add `@import "./layered_ui";` to your `application.css`
+- Add `import "layered_ui"` to your `application.js`
+- Copy `layered_assistant.css` to `app/assets/tailwind/layered_assistant.css`
+- Add `@import "./layered_assistant";` to your `app/assets/tailwind/application.css` (after the layered-ui import)
+- Add `import "layered_assistant"` to your `app/javascript/application.js` (after the layered-ui import)
+- Mount the engine at `/layered/assistant` in your `config/routes.rb`
+- Copy engine migrations into your application
+
+All steps are idempotent - re-running the generator will not duplicate imports, routes, or migrations.
+
+## Authorization
+
+All non-public engine routes are **blocked by default** (403 Forbidden) until you configure an `authorize` block. The install generator creates a starter initialiser at `config/initializers/layered_assistant.rb` - uncomment one of the examples to get started.
+
+Once configured, visit `/layered/assistant` (or wherever you mounted the engine) to verify access.
+
+### Allow all requests
+
+```ruby
+Layered::Assistant.authorize do
+  # No-op: all requests permitted
+end
+```
+
+### Require sign-in (Devise)
+
+```ruby
+Layered::Assistant.authorize do
+  redirect_to main_app.new_user_session_path unless user_signed_in?
+end
+```
+
+### Restrict to admins
+
+```ruby
+Layered::Assistant.authorize do
+  head :forbidden unless current_user&.admin?
+end
+```
+
+The block runs in controller context, so you have access to `request`, `current_user`, `redirect_to`, `head`, `main_app`, and all other controller methods.
+
+### Checking access in views
+
+The `l_assistant_accessible?` helper evaluates the authorize block without side effects. Use it to conditionally show navigation or links to the engine:
+
+```erb
+<% if l_assistant_accessible? %>
+  <%= link_to "Assistant", layered_assistant.root_path %>
+<% end %>
+```
+
+## Panel helpers
+
+The engine provides two convenience helpers for wiring the layered-ui panel to the assistant. Use them inside `content_for` blocks in your application layout:
+
+```erb
+<% content_for :l_ui_panel_heading do %>
+  <%= layered_assistant_panel_header %>
+<% end %>
+
+<% content_for :l_ui_panel_body do %>
+  <%= layered_assistant_panel_body %>
+<% end %>
+
+<%= render template: "layouts/layered_ui/application" %>
+```
+
+Both helpers accept keyword arguments that are forwarded as HTML attributes to the underlying `turbo_frame_tag`:
+
+```erb
+<%= layered_assistant_panel_body data: { controller: "panel" } %>
+```
+
+| Helper | Description |
+|---|---|
+| `layered_assistant_panel_header` | Empty Turbo Frame (`assistant_panel_header`) populated by the engine's panel views |
+| `layered_assistant_panel_body` | Turbo Frame (`assistant_panel`) that loads the conversation list from the engine's panel routes |
+
+## Configuration
+
+### Environment Variables
+
+| Variable | Default | Description |
+|---|---|---|
+| `LAYERED_ASSISTANT_DANGEROUSLY_SKIP_DB_ENCRYPTION` | `nil` | Set to `"yes"` to skip Active Record Encryption on `Provider#secret`. Only for development/test environments without encryption keys configured |
+| `LAYERED_ASSISTANT_LOG_ERRORS` | `nil` | Set to `"yes"` to enable error logging from the AI API clients |
+
+## Demo
+
+A dummy Rails app is included for development and testing:
+
+```bash
+cd test/dummy
+bin/setup
+bin/dev
+```
+
+Then visit `http://localhost:3000`.
+
+### Deploying the dummy app
+
+The dummy app can be deployed with [Kamal](https://kamal-deploy.org). Set the required environment variables and deploy from `test/dummy`:
+
+```bash
+cd test/dummy
+export KAMAL_DEPLOY_IP=<server-ip>
+export KAMAL_DEPLOY_DOMAIN=<domain>
+export KAMAL_SSH_KEY=<path-to-ssh-key>
+kamal deploy
+```
+
+## Testing
+
+Run the gem tests from the root directory:
+
+```bash
+bundle exec rake test
+```
+
+## License
+
+Released under the [Apache 2.0 License](LICENSE).
+
+Copyright 2026 LAYERED AI LIMITED (UK company number: 17056830). See [NOTICE](NOTICE) for attribution details.
+
+## Trademarks
+
+The source code is fully open, but the layered.ai name, logo, and brand assets are trademarks of LAYERED AI LIMITED. The Apache 2.0 license does not grant rights to use the layered.ai branding. Forks and redistributions must use a distinct name. See [TRADEMARK.md](TRADEMARK.md) for the full policy.
+
+## Contributing
+
+- [CLA.md](CLA.md) - contributor license agreement

data/Rakefile

@@ -0,0 +1,15 @@
+require "bundler/setup"
+
+APP_RAKEFILE = File.expand_path("test/dummy/Rakefile", __dir__)
+load "rails/tasks/engine.rake"
+
+require "bundler/gem_tasks"
+
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.pattern = "test/**/*_test.rb"
+end
+
+task default: :test

data/app/assets/tailwind/layered/assistant/styles.css

@@ -0,0 +1,13 @@
+/*
+ * CSS Formatting Convention
+ *
+ * All @apply directives use multi-line formatting with logical grouping:
+ * 1. Layout (flex, block, fixed, relative, etc.)
+ * 2. Spacing (padding, margin, gap, width, height)
+ * 3. Typography (text, font)
+ * 4. Colors (bg, text, border)
+ * 5. Effects (hover, transitions, shadows, etc.)
+ *
+ * Single-utility classes may remain on one line for brevity.
+ * This structure improves readability, maintainability, and makes diffs easier to review.
+ */

data/app/controllers/concerns/layered/assistant/message_creation.rb

@@ -0,0 +1,49 @@
+module Layered
+  module Assistant
+    module MessageCreation
+      private
+
+      def create_messages_for(conversation:, content:, model_id:)
+        message = conversation.messages.create(
+          role: :user,
+          content: content,
+          model_id: model_id,
+          input_tokens: TokenEstimator.estimate(content),
+          tokens_estimated: true
+        )
+
+        return { message: message } unless message.persisted?
+
+        conversation.update_name_from_content!(content)
+        message.broadcast_created
+
+        models = Model.available
+        selected_model_id = model_id
+        assistant_message = nil
+        error = nil
+
+        begin
+          assistant_message = conversation.messages.create!(
+            role: :assistant,
+            content: nil,
+            model_id: model_id
+          )
+          assistant_message.broadcast_created
+
+          Messages::ResponseJob.perform_later(assistant_message.id)
+        rescue => e
+          Rails.logger.error("Assistant response failed: #{e.message}")
+          error = "Something went wrong while generating a response."
+        end
+
+        {
+          message: message,
+          assistant_message: assistant_message,
+          models: models,
+          selected_model_id: selected_model_id,
+          error: error
+        }
+      end
+    end
+  end
+end

data/app/controllers/concerns/layered/assistant/public/session_conversations.rb

@@ -0,0 +1,50 @@
+module Layered
+  module Assistant
+    module Public
+      module SessionConversations
+        extend ActiveSupport::Concern
+
+        private
+
+        def session_conversation_ids
+          session[:layered_assistant_conversation_ids] ||= []
+        end
+
+        MAX_SESSION_CONVERSATIONS = 50
+
+        def add_conversation_to_session(conversation)
+          ids = session_conversation_ids
+          ids << conversation.id unless ids.include?(conversation.id)
+          ids.shift while ids.size > MAX_SESSION_CONVERSATIONS
+        end
+
+        def find_session_conversation(id)
+          id = id.to_i
+          unless session_conversation_ids.include?(id)
+            raise ActiveRecord::RecordNotFound, "Conversation not found in session"
+          end
+
+          Conversation.joins(:assistant).merge(Assistant.publicly_available).find(id)
+        rescue ActiveRecord::RecordNotFound
+          remove_conversation_from_session(id)
+          raise
+        end
+
+        def remove_conversation_from_session(id)
+          session_conversation_ids.delete(id.to_i)
+        end
+
+        def existing_session_conversation_for(assistant)
+          return nil if session_conversation_ids.empty?
+
+          Conversation
+            .joins(:assistant)
+            .merge(Assistant.publicly_available)
+            .where(id: session_conversation_ids, assistant: assistant)
+            .order(created_at: :desc)
+            .first
+        end
+      end
+    end
+  end
+end

data/app/controllers/layered/assistant/application_controller.rb

@@ -0,0 +1,25 @@
+module Layered
+  module Assistant
+    class ApplicationController < ActionController::Base
+      include Pagy::Method
+      include Layered::Ui::AuthenticationHelper
+
+      before_action :layered_assistant_authorize!
+
+      helper Rails.application.routes.url_helpers
+
+      private
+
+      def layered_assistant_authorize!
+        block = Layered::Assistant.authorize_block
+
+        unless block
+          head :forbidden
+          return
+        end
+
+        instance_exec(&block)
+      end
+    end
+  end
+end