ruby_llm_community 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0d28b384f53784c1954147d9f217caff1325893f1853e6be63c60158d9c37b79
-  data.tar.gz: 3c6e66e260c1300b3b20ae730ec3755fcca19be8afc8dee754e26cc82cbee7f4
+  metadata.gz: 82545649470ef24d251c3cf4a5f7eceff777ea2d3939e48eb76fc5109e8a1b5a
+  data.tar.gz: 378d2d26c2cc08362b5b552ca42ee397c9ab1e96cb394223cf8df2dae2548aa6
 SHA512:
-  metadata.gz: 568f6c9a3facf5e5f721ec6e3d44862eb0988529cf72625a88220fe80f00ba89f5602f0a178d0ead3cfc3c4accca3a4b56321a3a24f84883df16bd1c72432458
-  data.tar.gz: e6336936468acfc005284a1e6f7cbffe58e55e85c760082af71569d9555371ed124b26fe0cc70d274124f4b80530881c012d10079145f0c90383f2d6e2c51ff7
+  metadata.gz: 6340051367db4bd6401e2d8c5468eefded5bbf5a72daa94b3bf930ab8b3601b7d3c3cc26e6e878a45e11d3fce15f99747e09eee7393d966f59ce8f968b7d3640
+  data.tar.gz: 1c7de7980a77d5340325ef1db12c4e6b8e6347639f956a925b1ec8dffeb3ae819086159e35aeb3d7964cc4c60133f09657326dc0eb894c28a2c81efda1a4ddb4

data/README.md

@@ -9,7 +9,7 @@
 
 Battle tested at [<picture><source media="(prefers-color-scheme: dark)" srcset="https://chatwithwork.com/logotype-dark.svg"><img src="https://chatwithwork.com/logotype.svg" alt="Chat with Work" height="30" align="absmiddle"></picture>](https://chatwithwork.com) — *Claude Code for your documents*
 
-[![Gem Version](https://badge.fury.io/rb/ruby_llm.svg?a=7)](https://badge.fury.io/rb/ruby_llm)
+[![Gem Version](https://badge.fury.io/rb/ruby_llm.svg?a=8)](https://badge.fury.io/rb/ruby_llm)
 [![Ruby Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://github.com/testdouble/standard)
 [![Gem Downloads](https://img.shields.io/gem/dt/ruby_llm)](https://rubygems.org/gems/ruby_llm)
 [![codecov](https://codecov.io/gh/crmne/ruby_llm/branch/main/graph/badge.svg?a=2)](https://codecov.io/gh/crmne/ruby_llm)
@@ -17,6 +17,9 @@ Battle tested at [<picture><source media="(prefers-color-scheme: dark)" srcset="
 <a href="https://trendshift.io/repositories/13640" target="_blank"><img src="https://trendshift.io/api/badge/repositories/13640" alt="crmne%2Fruby_llm | Trendshift" style="width: 250px; height: 55px;" width="250" height="55"/></a>
 </div>
 
+> [!NOTE]
+> Using RubyLLM in production? [Share your story](https://tally.so/r/3Na02p)! Takes 5 minutes.
+
 ---
 
 Build chatbots, AI agents, RAG applications. Works with OpenAI, Anthropic, Google, AWS, local models, and any OpenAI-compatible API.
@@ -27,6 +30,20 @@ Every AI provider ships their own bloated client. Different APIs. Different resp
 
 RubyLLM gives you one beautiful API for all of them. Same interface whether you're using GPT, Claude, or your local Ollama. Just three dependencies: [Faraday](https://github.com/lostisland/faraday), [Zeitwerk](https://github.com/fxn/zeitwerk), and [Marcel](https://github.com/rails/marcel). That's it.
 
+## How does RubyLLM Community differ?
+
+Use this gem to get early access to features currently in PR at the main gem.
+
+Initial examples --
+
+- Prompt caching for Anthropic
+- Image editing for Gemini and OpenAI
+- Responses API for OpenAI
+
+This project is intended to be compatible with RubyLLM. I will attempt to keep it up to date as Carmine pushes commits often.
+
+I may have to bump the major version if I have to break compatibility due to a change in direction on one of the PRs. I will provide instructions on how to upgrade in the release notes.
+
 ## Show me the code
 
 ```ruby

data/lib/generators/ruby_llm/chat_ui/chat_ui_generator.rb

@@ -0,0 +1,127 @@
+# frozen_string_literal: true
+
+require 'rails/generators'
+
+module RubyLLM
+  module Generators
+    # Generates a simple chat UI scaffold for RubyLLM
+    class ChatUIGenerator < Rails::Generators::Base
+      source_root File.expand_path('templates', __dir__)
+
+      namespace 'ruby_llm:chat_ui'
+
+      argument :model_mappings, type: :array, default: [], banner: 'chat:ChatName message:MessageName ...'
+
+      desc 'Creates a chat UI scaffold with Turbo streaming\n' \
+           'Usage: rails g ruby_llm:chat_ui [chat:ChatName] [message:MessageName] ...'
+
+      def parse_model_mappings
+        @model_names = {
+          chat: 'Chat',
+          message: 'Message',
+          tool_call: 'ToolCall',
+          model: 'Model'
+        }
+
+        model_mappings.each do |mapping|
+          if mapping.include?(':')
+            key, value = mapping.split(':', 2)
+            @model_names[key.to_sym] = value.classify
+          end
+        end
+
+        @model_names
+      end
+
+      %i[chat message model].each do |type|
+        define_method("#{type}_model_name") do
+          @model_names ||= parse_model_mappings
+          @model_names[type]
+        end
+
+        define_method("#{type}_table_name") do
+          table_name_for(send("#{type}_model_name"))
+        end
+      end
+
+      def create_views
+        # Chat views
+        template 'views/chats/index.html.erb', "app/views/#{chat_table_name}/index.html.erb"
+        template 'views/chats/new.html.erb', "app/views/#{chat_table_name}/new.html.erb"
+        template 'views/chats/show.html.erb', "app/views/#{chat_table_name}/show.html.erb"
+        template 'views/chats/_chat.html.erb',
+                 "app/views/#{chat_table_name}/_#{chat_model_name.underscore}.html.erb"
+        template 'views/chats/_form.html.erb', "app/views/#{chat_table_name}/_form.html.erb"
+
+        # Message views
+        template 'views/messages/_message.html.erb',
+                 "app/views/#{message_table_name}/_#{message_model_name.underscore}.html.erb"
+        template 'views/messages/_form.html.erb', "app/views/#{message_table_name}/_form.html.erb"
+        template 'views/messages/create.turbo_stream.erb',
+                 "app/views/#{message_table_name}/create.turbo_stream.erb"
+
+        # Model views
+        template 'views/models/index.html.erb', "app/views/#{model_table_name}/index.html.erb"
+        template 'views/models/show.html.erb', "app/views/#{model_table_name}/show.html.erb"
+        template 'views/models/_model.html.erb',
+                 "app/views/#{model_table_name}/_#{model_model_name.underscore}.html.erb"
+      end
+
+      def create_controllers
+        template 'controllers/chats_controller.rb', "app/controllers/#{chat_table_name}_controller.rb"
+        template 'controllers/messages_controller.rb', "app/controllers/#{message_table_name}_controller.rb"
+        template 'controllers/models_controller.rb', "app/controllers/#{model_table_name}_controller.rb"
+      end
+
+      def create_jobs
+        template 'jobs/chat_response_job.rb', "app/jobs/#{chat_model_name.underscore}_response_job.rb"
+      end
+
+      def add_routes
+        model_routes = <<~ROUTES.strip
+          resources :#{model_table_name}, only: [:index, :show] do
+            collection do
+              post :refresh
+            end
+          end
+        ROUTES
+        route model_routes
+        chat_routes = <<~ROUTES.strip
+          resources :#{chat_table_name} do
+            resources :#{message_table_name}, only: [:create]
+          end
+        ROUTES
+        route chat_routes
+      end
+
+      def add_broadcasting_to_message_model
+        msg_var = message_model_name.underscore
+        chat_var = chat_model_name.underscore
+        broadcasting_code = "broadcasts_to ->(#{msg_var}) { \"#{chat_var}_\#{#{msg_var}.#{chat_var}_id}\" }"
+
+        inject_into_class "app/models/#{msg_var}.rb", message_model_name do
+          "\n  #{broadcasting_code}\n"
+        end
+      rescue Errno::ENOENT
+        say "#{message_model_name} model not found. Add broadcasting code to your model.", :yellow
+        say "  #{broadcasting_code}", :yellow
+      end
+
+      def display_post_install_message
+        return unless behavior == :invoke
+
+        say "\n  ✅ Chat UI installed!", :green
+        say "\n  Start your server and visit http://localhost:3000/#{chat_table_name}", :cyan
+        say "\n"
+      end
+
+      private
+
+      def table_name_for(model_name)
+        # Convert namespaced model names to proper table names
+        # e.g., "Assistant::Chat" -> "assistant_chats" (not "assistant/chats")
+        model_name.underscore.pluralize.tr('/', '_')
+      end
+    end
+  end
+end

data/lib/generators/ruby_llm/chat_ui/templates/controllers/chats_controller.rb.tt

@@ -0,0 +1,39 @@
+class <%= chat_model_name.pluralize %>Controller < ApplicationController
+  before_action :set_<%= chat_model_name.underscore %>, only: [:show]
+
+  def index
+    @<%= chat_model_name.tableize %> = <%= chat_model_name %>.order(created_at: :desc)
+  end
+
+  def new
+    @<%= chat_model_name.underscore %> = <%= chat_model_name %>.new
+    @selected_model = params[:model]
+  end
+
+  def create
+    return unless prompt.present?
+
+    @<%= chat_model_name.underscore %> = <%= chat_model_name %>.create!(model: model)
+    <%= chat_model_name %>ResponseJob.perform_later(@<%= chat_model_name.underscore %>.id, prompt)
+
+    redirect_to @<%= chat_model_name.underscore %>, notice: '<%= chat_model_name.humanize %> was successfully created.'
+  end
+
+  def show
+    @<%= message_model_name.underscore %> = @<%= chat_model_name.underscore %>.<%= message_model_name.tableize %>.build
+  end
+
+  private
+
+  def set_<%= chat_model_name.underscore %>
+    @<%= chat_model_name.underscore %> = <%= chat_model_name %>.find(params[:id])
+  end
+
+  def model
+    params[:<%= chat_model_name.underscore %>][:model].presence
+  end
+
+  def prompt
+    params[:<%= chat_model_name.underscore %>][:prompt]
+  end
+end

data/lib/generators/ruby_llm/chat_ui/templates/controllers/messages_controller.rb.tt

@@ -0,0 +1,24 @@
+class <%= message_model_name.pluralize %>Controller < ApplicationController
+  before_action :set_<%= chat_model_name.underscore %>
+
+  def create
+    return unless content.present?
+
+    <%= chat_model_name %>ResponseJob.perform_later(@<%= chat_model_name.underscore %>.id, content)
+
+    respond_to do |format|
+      format.turbo_stream
+      format.html { redirect_to @<%= chat_model_name.underscore %> }
+    end
+  end
+
+  private
+
+  def set_<%= chat_model_name.underscore %>
+    @<%= chat_model_name.underscore %> = <%= chat_model_name %>.find(params[:<%= chat_model_name.underscore %>_id])
+  end
+
+  def content
+    params[:<%= message_model_name.underscore %>][:content]
+  end
+end

data/lib/generators/ruby_llm/chat_ui/templates/controllers/models_controller.rb.tt

@@ -0,0 +1,14 @@
+class <%= model_model_name.pluralize %>Controller < ApplicationController
+  def index
+    @<%= model_model_name.tableize %> = <%= model_model_name %>.all.group_by(&:provider)
+  end
+
+  def show
+    @<%= model_model_name.underscore %> = <%= model_model_name %>.find(params[:id])
+  end
+
+  def refresh
+    <%= model_model_name %>.refresh!
+    redirect_to <%= model_model_name.tableize %>_path, notice: "<%= model_model_name.pluralize %> refreshed successfully"
+  end
+end

data/lib/generators/ruby_llm/chat_ui/templates/jobs/chat_response_job.rb.tt

@@ -0,0 +1,12 @@
+class <%= chat_model_name %>ResponseJob < ApplicationJob
+  def perform(<%= chat_model_name.underscore %>_id, content)
+    <%= chat_model_name.underscore %> = <%= chat_model_name %>.find(<%= chat_model_name.underscore %>_id)
+
+    <%= chat_model_name.underscore %>.ask(content) do |chunk|
+      if chunk.content && !chunk.content.blank?
+        <%= message_model_name.underscore %> = <%= chat_model_name.underscore %>.<%= message_model_name.tableize %>.last
+        <%= message_model_name.underscore %>.update!(content: <%= message_model_name.underscore %>.content + chunk.content)
+      end
+    end
+  end
+end

data/lib/generators/ruby_llm/chat_ui/templates/views/chats/_chat.html.erb.tt

@@ -0,0 +1,16 @@
+<div id="<%%= dom_id <%= chat_model_name.underscore %> %>">
+  <div>
+    <strong>Model:</strong>
+    <%%= <%= chat_model_name.underscore %>.model_association.name %>
+  </div>
+
+  <div>
+    <strong>Messages:</strong>
+    <%%= <%= chat_model_name.underscore %>.messages_association.count %>
+  </div>
+
+  <div>
+    <strong>Created:</strong>
+    <%%= <%= chat_model_name.underscore %>.created_at.strftime("%B %d, %Y at %I:%M %p") %>
+  </div>
+</div>

data/lib/generators/ruby_llm/chat_ui/templates/views/chats/_form.html.erb.tt

@@ -0,0 +1,29 @@
+<%%= form_with(model: <%= chat_model_name.underscore %>, url: <%= chat_model_name.tableize %>_path) do |form| %>
+  <%% if <%= chat_model_name.underscore %>.errors.any? %>
+    <div style="color: red">
+      <h2><%%= pluralize(<%= chat_model_name.underscore %>.errors.count, "error") %> prohibited this <%= chat_model_name.underscore.humanize.downcase %> from being saved:</h2>
+
+      <ul>
+        <%% <%= chat_model_name.underscore %>.errors.each do |error| %>
+          <li><%%= error.full_message %></li>
+        <%% end %>
+      </ul>
+    </div>
+  <%% end %>
+
+  <div>
+    <%%= form.label :model, "Select AI model:", style: "display: block" %>
+    <%%= form.select :model,
+        options_for_select(<%= model_model_name %>.pluck(:name, :model_id).unshift(["Default (#{RubyLLM.config.default_model})", nil]), @selected_model),
+        {},
+        style: "width: 100%; max-width: 600px; padding: 5px;" %>
+  </div>
+
+  <div style="margin-top: 15px;">
+    <%%= form.text_field :prompt, style: "width: 100%; max-width: 600px;", placeholder: "What would you like to discuss?", autofocus: true %>
+  </div>
+
+  <div>
+    <%%= form.submit "Start new <%= chat_model_name.underscore.humanize.downcase %>" %>
+  </div>
+<%% end %>

data/lib/generators/ruby_llm/chat_ui/templates/views/chats/index.html.erb.tt

@@ -0,0 +1,16 @@
+<p style="color: green"><%%= notice %></p>
+
+<%% content_for :title, "<%= chat_model_name.pluralize %>" %>
+
+<h1><%= chat_model_name.pluralize %></h1>
+
+<div id="<%= chat_model_name.tableize %>">
+  <%% @<%= chat_model_name.tableize %>.each do |<%= chat_model_name.underscore %>| %>
+    <%%= render <%= chat_model_name.underscore %> %>
+    <p>
+      <%%= link_to "Show this <%= chat_model_name.underscore.humanize.downcase %>", <%= chat_model_name.underscore %> %>
+    </p>
+  <%% end %>
+</div>
+
+<%%= link_to "New <%= chat_model_name.underscore.humanize.downcase %>", new_<%= chat_model_name.underscore %>_path %>

data/lib/generators/ruby_llm/chat_ui/templates/views/chats/new.html.erb.tt

@@ -0,0 +1,11 @@
+<%% content_for :title, "New <%= chat_model_name.underscore.humanize.downcase %>" %>
+
+<h1>New <%= chat_model_name.underscore.humanize.downcase %></h1>
+
+<%%= render "form", <%= chat_model_name.underscore %>: @<%= chat_model_name.underscore %> %>
+
+<br>
+
+<div>
+  <%%= link_to "Back to <%= chat_model_name.tableize.humanize.downcase %>", <%= chat_model_name.tableize %>_path %>
+</div>

data/lib/generators/ruby_llm/chat_ui/templates/views/chats/show.html.erb.tt

@@ -0,0 +1,23 @@
+<p style="color: green"><%%= notice %></p>
+
+<%%= turbo_stream_from "<%= chat_model_name.underscore %>_#{@<%= chat_model_name.underscore %>.id}" %>
+
+<%% content_for :title, "<%= chat_model_name %>" %>
+
+<h1><%= chat_model_name %> <%%= @<%= chat_model_name.underscore %>.id %></h1>
+
+<p>Using <strong><%%= @<%= chat_model_name.underscore %>.model_association.name %></strong></p>
+
+<div id="<%= message_model_name.tableize %>">
+  <%% @<%= chat_model_name.underscore %>.messages_association.where.not(id: nil).each do |<%= message_model_name.underscore %>| %>
+    <%%= render "<%= message_model_name.tableize %>/<%= message_model_name.underscore %>", <%= message_model_name.underscore %>: <%= message_model_name.underscore %> %>
+  <%% end %>
+</div>
+
+<div style="margin-top: 30px;">
+  <%%= render "<%= message_model_name.tableize %>/form", <%= chat_model_name.underscore %>: @<%= chat_model_name.underscore %>, <%= message_model_name.underscore %>: @<%= message_model_name.underscore %> %>
+</div>
+
+<div style="margin-top: 20px;">
+  <%%= link_to "Back to <%= chat_model_name.tableize.humanize.downcase %>", <%= chat_model_name.tableize %>_path %>
+</div>

data/lib/generators/ruby_llm/chat_ui/templates/views/messages/_form.html.erb.tt

@@ -0,0 +1,21 @@
+<%%= form_with(model: [<%= chat_model_name.underscore %>, <%= message_model_name.underscore %>], id: "new_<%= message_model_name.underscore %>") do |form| %>
+  <%% if <%= message_model_name.underscore %>.errors.any? %>
+    <div style="color: red">
+      <h2><%%= pluralize(<%= message_model_name.underscore %>.errors.count, "error") %> prohibited this <%= message_model_name.underscore.humanize.downcase %> from being saved:</h2>
+
+      <ul>
+        <%% <%= message_model_name.underscore %>.errors.each do |error| %>
+          <li><%%= error.full_message %></li>
+        <%% end %>
+      </ul>
+    </div>
+  <%% end %>
+
+  <div>
+    <%%= form.text_field :content, style: "width: 100%; max-width: 600px;", placeholder: "Message...", autofocus: true %>
+  </div>
+
+  <div>
+    <%%= form.submit "Send <%= message_model_name.underscore.humanize.downcase %>" %>
+  </div>
+<%% end %>

data/lib/generators/ruby_llm/chat_ui/templates/views/messages/_message.html.erb.tt

@@ -0,0 +1,10 @@
+<%%= tag.div id: dom_id(<%= message_model_name.underscore %>), class: "<%= message_model_name.underscore %>",
+    style: "margin-bottom: 20px; padding: 10px; border-left: 3px solid #{<%= message_model_name.underscore %>.role == 'user' ? '#007bff' : '#28a745'};" do %>
+  <div style="font-weight: bold; margin-bottom: 5px;">
+    <%%= <%= message_model_name.underscore %>.role&.capitalize %>
+  </div>
+  <div style="white-space: pre-wrap;"><%%= <%= message_model_name.underscore %>.content %></div>
+  <div style="font-size: 0.85em; color: #666; margin-top: 5px;">
+    <%%= <%= message_model_name.underscore %>.created_at&.strftime("%I:%M %p") %>
+  </div>
+<%% end %>

data/lib/generators/ruby_llm/chat_ui/templates/views/messages/create.turbo_stream.erb.tt

@@ -0,0 +1,9 @@
+<%%= turbo_stream.append "<%= message_model_name.tableize %>" do %>
+  <%% @<%= chat_model_name.underscore %>.messages_association.last(2).each do |<%= message_model_name.underscore %>| %>
+    <%%= render "<%= message_model_name.tableize %>/<%= message_model_name.underscore %>", <%= message_model_name.underscore %>: <%= message_model_name.underscore %> %>
+  <%% end %>
+<%% end %>
+
+<%%= turbo_stream.replace "new_<%= message_model_name.underscore %>" do %>
+  <%%= render "<%= message_model_name.tableize %>/form", <%= chat_model_name.underscore %>: @<%= chat_model_name.underscore %>, <%= message_model_name.underscore %>: @<%= chat_model_name.underscore %>.messages_association.build %>
+<%% end %>

data/lib/generators/ruby_llm/chat_ui/templates/views/models/_model.html.erb.tt

@@ -0,0 +1,16 @@
+<tr id="<%%= dom_id <%= model_model_name.underscore %> %>">
+  <td><%%= <%= model_model_name.underscore %>.provider %></td>
+  <td><%%= <%= model_model_name.underscore %>.name %></td>
+  <td><%%= number_with_delimiter(<%= model_model_name.underscore %>.context_window) if <%= model_model_name.underscore %>.context_window %></td>
+  <td>
+    <%% if <%= model_model_name.underscore %>.pricing && <%= model_model_name.underscore %>.pricing['text_tokens'] && <%= model_model_name.underscore %>.pricing['text_tokens']['standard'] %>
+      <%% input = <%= model_model_name.underscore %>.pricing['text_tokens']['standard']['input_per_million'] %>
+      <%% output = <%= model_model_name.underscore %>.pricing['text_tokens']['standard']['output_per_million'] %>
+      <%% if input && output %>
+        $<%%= "%.2f" % input %> / $<%%= "%.2f" % output %>
+      <%% end %>
+    <%% end %>
+  </td>
+  <td><%%= link_to "Show", <%= model_model_name.underscore %> %></td>
+  <td><%%= link_to "Start <%= chat_model_name.underscore.humanize.downcase %>", new_<%= chat_model_name.underscore %>_path(model: <%= model_model_name.underscore %>.model_id) %></td>
+</tr>

data/lib/generators/ruby_llm/chat_ui/templates/views/models/index.html.erb.tt

@@ -0,0 +1,30 @@
+<p style="color: green"><%%= notice %></p>
+
+<%% content_for :title, "<%= model_model_name.pluralize %>" %>
+
+<h1><%= model_model_name.pluralize %></h1>
+
+<p>
+  <%%= button_to "Refresh <%= model_model_name.pluralize %>", refresh_<%= model_model_name.tableize %>_path, method: :post %>
+</p>
+
+<div id="<%= model_model_name.tableize %>">
+  <table>
+    <thead>
+      <tr>
+        <th>Provider</th>
+        <th>Model</th>
+        <th>Context Window</th>
+        <th>$/1M tokens (In/Out)</th>
+        <th colspan="2"></th>
+      </tr>
+    </thead>
+    <tbody>
+      <%% @<%= model_model_name.tableize %>.values.flatten.each do |<%= model_model_name.underscore %>| %>
+        <%%= render <%= model_model_name.underscore %> %>
+      <%% end %>
+    </tbody>
+  </table>
+</div>
+
+<%%= link_to "Back to <%= chat_model_name.tableize.humanize.downcase %>", <%= chat_model_name.tableize %>_path %>

data/lib/generators/ruby_llm/chat_ui/templates/views/models/show.html.erb.tt

@@ -0,0 +1,18 @@
+<%% content_for :title, @model.name %>
+
+<h1><%%= @model.name %></h1>
+
+<p><strong>ID:</strong> <%%= @model.model_id %></p>
+<p><strong>Provider:</strong> <%%= @model.provider %></p>
+<p><strong>Context Window:</strong> <%%= number_with_delimiter(@model.context_window) %> tokens</p>
+<p><strong>Max Output:</strong> <%%= number_with_delimiter(@model.max_output_tokens) %> tokens</p>
+
+<%% if @model.capabilities.any? %>
+  <p><strong>Capabilities:</strong> <%%= @model.capabilities.join(", ") %></p>
+<%% end %>
+
+<p>
+  <%%= link_to "Start chat with this model", new_chat_path(model: @model.model_id) %> |
+  <%%= link_to "All models", models_path %> |
+  <%%= link_to "Back to chats", chats_path %>
+</p>