ruby_conversations 1.1.1 → 1.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b5c99da86fb4fd6958f8bbd252656dcfcbf08e375731b1f0f45c62f14eb1e9a7
-  data.tar.gz: df34a7844a5a9a41b770c1ac2144542642d6082c22d17b9af7282994e89fe5c4
+  metadata.gz: 65450a67b9c5b73041bae92b1888a1ed62fbaf2e7877cdbf333ffef9f22c66ee
+  data.tar.gz: 60255ec9205d6f84cedb7b9f733fce0121b8f4bc8db4e8adb14cfa58bd745550
 SHA512:
-  metadata.gz: 38f26a3074bb9579e7ef547208273346b85b9255b3c41a1ceb812c758467168494d4b29d602d1f2401c79961835eefb6fa25791b33fb99228c6b73d3da4a225d
-  data.tar.gz: 4b952f7d55e15e22727fb155e6a52e388d9b82900f9f0cbe08fe72bffa4ba898939b651ef070837b43296adb1dec72543a6e18cf2b2ae327def4bac665cce773
+  metadata.gz: 704bd3d750ae71b30890fe19ab9cbe9d2416b881845eee9193dbb8b6bd5b9f6bdcec232715c82b113064977211e7801b64f9bd00fd7e20d020225895526f851c
+  data.tar.gz: efcda7a901213aa9b5ec5e71196aadc2d319d79432ae21d624d3b3d63e45c8f92079e89041c107c7caf36ca513c7b006969163e88f7effbd3342b219e4f02855

data/README.md

@@ -7,9 +7,7 @@ A Rails engine for managing AI conversations and storing them in prompt studio.
 - **Built-in Prompt Management**: Version-controlled prompts with placeholder validation
 - **Conversation History**: Track and manage conversation threads
 - **Input/Output Storage**: Structured storage for message inputs and responses
-- **Real-time Updates**: Built-in broadcasting support for real-time applications
 - **JWT Authentication**: Secure remote mode with JWT authentication
-- **Easy Integration**: Simple setup with Rails generators
 
 ## Installation
 
@@ -36,7 +34,7 @@ gem install ruby_conversations
 Configure the engine in `config/initializers/ai_conversation_engine.rb`:
 
 ```ruby
-AiConversationEngine.configure do |config|
+RubyConversations.configure do |config|
   # API settings
   config.api_url = ENV['AI_CONVERSATION_API_URL']
   config.jwt_secret = ENV['AI_CONVERSATION_JWT_SECRET']
@@ -51,34 +49,13 @@ end
 
 ```ruby
 # Create a new conversation
-conversation = AiConversation.create!
+conversation = RubyConversations::Conversation.new
 
 # Ask a question using a predefined prompt
-conversation.ask("explain_code", inputs: { code: "def hello; end" })
-```
-
-### With Associated Objects
-
-```ruby
-# Create a conversation linked to another object
-class Project < ApplicationRecord
-  has_many :conversations, as: :conversationable,
-           class_name: 'AiConversationEngine::AiConversation'
-end
-
-project = Project.find(1)
-conversation = project.conversations.create!
-conversation.ask("analyze_project", inputs: { name: project.name })
-```
-
-
-### Real-time Updates
-
-```ruby
-# In your view
-<%= turbo_stream_from "chat_#{@conversation.id}" %>
+conversation.with_prompt("explain_code", inputs: { code: "def hello; end" })
+result = conversation.call_llm
 
-# Updates are automatically broadcast when messages are added
+puts result[:content]
 ```
 
 ## Development

data/app/models/ruby_conversations/concerns/conversation_chat.rb

@@ -6,15 +6,17 @@ module RubyConversations
     module ConversationChat
       extend ActiveSupport::Concern
 
-      def execute(system_message: nil)
+      def call_llm(system_message: nil, &block)
         validate_conversation_state
-        chat_messages = generate_chat_response(system_message)
+        chat_messages = generate_chat_response(system_message, &block)
 
         validate_tool_calls(chat_messages)
 
         store_and_update_conversation(chat_messages)
       end
 
+      alias execute call_llm
+
       def validate_tool_calls(chat_messages)
         return unless tools_configured?
         return if tool_calls?(chat_messages)
@@ -50,9 +52,9 @@ module RubyConversations
         raise ArgumentError, 'Conversation must have at least one message to execute' unless message
       end
 
-      def generate_chat_response(system_message)
+      def generate_chat_response(system_message, &)
         setup_llm_chat(system_message: system_message)
-        chat.ask(messages.last.request)
+        chat.ask(messages.last.request, &)
         chat.messages
       end
 
@@ -62,7 +64,8 @@ module RubyConversations
 
         {
           response: chat_messages,
-          conversation: self
+          conversation: self,
+          content: chat_messages.last.content
         }
       end
 

data/app/models/ruby_conversations/concerns/conversation_messages.rb

@@ -17,15 +17,20 @@ module RubyConversations
         end
       end
 
-      def ask_multiple(prompt_inputs, description: nil)
+      def with_prompts(prompt_inputs, description: nil)
         MessageBuilder.new(self).build_from_multiple_prompts(prompt_inputs, description: description)
         self
       end
 
-      def ask(name, description: nil, inputs: {})
+      def with_prompt(name, description: nil, inputs: {})
         MessageBuilder.new(self).build_from_single_prompt(name, description: description, inputs: inputs)
         self
       end
+
+      def with_user_message(message, description: nil)
+        MessageBuilder.new(self).build_from_user_message(message, description: description)
+        self
+      end
     end
   end
 end

data/app/models/ruby_conversations/concerns/conversation_templates.rb

@@ -0,0 +1,107 @@
+# frozen_string_literal: true
+
+module RubyConversations
+  module Concerns
+    # Handles template-related functionality for Conversation
+    module ConversationTemplates
+      extend ActiveSupport::Concern
+
+      # Fetch template metadata for a given template name
+      # @param template_name [String] The name of the template to fetch
+      # @return [Hash] Template metadata including fields and UI configuration
+      def template_for(template_name)
+        begin
+          template_data = RubyConversations.client.fetch_conversation_template(template_name)
+        rescue RubyConversations::ClientError => e
+          raise RubyConversations::TemplateNotFoundError, "Template #{template_name} not found" if e.status_code == 404
+
+          raise e
+        end
+        extract_template_metadata(template_data)
+      end
+
+      private
+
+      def extract_template_metadata(template_data)
+        return nil unless template_data
+
+        build_template_metadata(template_data)
+      end
+
+      def build_template_metadata(template_data)
+        base_metadata(template_data).merge(ui_metadata(template_data))
+      end
+
+      def base_metadata(template_data)
+        {
+          id: template_data['template_name'],
+          name: template_display_name(template_data),
+          description: template_data['template_description'] || "Template: #{template_data['template_name']}",
+          fields: extract_fields_from_template(template_data)
+        }
+      end
+
+      def ui_metadata(template_data)
+        {
+          icon: template_data['template_icon'] || 'fa-light fa-comment',
+          color: template_data['template_color'] || 'blue',
+          response_enabled: template_response_enabled?(template_data),
+          cta: template_data['template_call_to_action'] || 'Submit'
+        }
+      end
+
+      def template_display_name(template_data)
+        prompt_name = extract_prompt_name(template_data)
+        template_data['template_display_name'] || default_display_name(prompt_name, template_data)
+      end
+
+      def extract_prompt_name(template_data)
+        return nil unless template_data['ai_messages']
+        return nil unless template_data['ai_messages'].first
+
+        prompts = template_data['ai_messages'].first['ai_message_prompts']
+        prompts&.first&.dig('name')
+      end
+
+      def default_display_name(prompt_name, template_data)
+        return prompt_name.titleize if prompt_name
+
+        template_data['template_name'].titleize
+      end
+
+      def template_response_enabled?(template_data)
+        template_data['template_response_enabled'].nil? ||
+          template_data['template_response_enabled']
+      end
+
+      def extract_fields_from_template(template_data)
+        return [] unless message_inputs?(template_data)
+
+        inputs = get_message_inputs(template_data)
+        inputs.map do |input|
+          {
+            name: input['placeholder_name'],
+            type: input['field_type'] || 'text',
+            label: input['label'] || input['placeholder_name'].titleize
+          }
+        end
+      end
+
+      def message_inputs?(template_data)
+        return false unless template_data['ai_messages']
+        return false unless template_data['ai_messages'].first
+
+        prompts = template_data['ai_messages'].first['ai_message_prompts']
+        return false unless prompts&.first
+
+        prompts.first['ai_message_inputs'].present?
+      end
+
+      def get_message_inputs(template_data)
+        return [] unless message_inputs?(template_data)
+
+        template_data['ai_messages'].first['ai_message_prompts'].first['ai_message_inputs']
+      end
+    end
+  end
+end

data/app/models/ruby_conversations/conversation.rb

@@ -8,51 +8,28 @@ module RubyConversations
     include ActiveModel::Model
     include RubyConversations::Concerns::ConversationChat
     include RubyConversations::Concerns::ConversationMessages
+    include RubyConversations::Concerns::ConversationTemplates
     include RubyConversations::Concerns::LlmCredentials
     include RubyConversations::Concerns::MessageValidation
     include RubyConversations::Concerns::MessageProcessing
 
     # Define attributes needed for API interaction & local state
-    attr_accessor :chat, :id, :conversationable_type, :conversationable_id, :conversationable,
-                  :messages, :tool, :tools, :created_at, :updated_at, :persist
+    attr_accessor :id, :conversationable_type, :conversationable_id, :conversationable,
+                  :messages, :tool, :tools, :created_at, :updated_at
 
     # Validations
     validates :messages, presence: { message: 'At least one message is required' }, on: :update
     validate :validate_messages
 
     # Initialization
-    def initialize(attributes = nil)
-      attributes ||= {}
+    def initialize(attributes = {})
+      @chat = attributes.delete(:chat)
       @messages = []
-      messages_attrs = extract_message_attributes(attributes)
-      @persist = extract_persist_flag(attributes)
-
-      super # Initialize with remaining attributes using ActiveModel::Model
-      initialize_messages(messages_attrs)
-
-      build_chat
-    end
-
-    def extract_message_attributes(attributes)
-      attributes.delete(:messages) ||
-        attributes.delete('messages') ||
-        attributes.delete(:messages_attributes) ||
-        attributes.delete('messages_attributes') ||
-        []
+      super
     end
 
-    def extract_persist_flag(attributes)
-      attributes.delete(:persist) ||
-        attributes.delete('persist') ||
-        false
-    end
-
-    def build_chat
-      @chat = if @persist && RubyConversations.configuration.persistence_model
-                resolve_persistence_model.create!(model_id: llm, provider: provider)
-              else
-                RubyLLM.chat(model: llm, provider: provider).with_temperature(0.0)
-              end
+    def chat
+      @chat ||= RubyLLM.chat(model: llm, provider: provider).with_temperature(0.0)
     end
 
     def model_identifier
@@ -63,36 +40,12 @@ module RubyConversations
       @provider ||= RubyConversations.configuration.default_llm_provider
     end
 
-    def initialize_messages(message_attributes)
-      (message_attributes || []).each do |msg_data|
-        processed_prompts = process_message_prompts(msg_data)
-
-        message_instance = RubyConversations::Message.new(msg_data.except('id', 'conversation_id', 'created_at',
-                                                                          'updated_at'))
-        message_instance.message_prompts = processed_prompts
-        @messages << message_instance # Add to the messages array
-      end
-    end
-
     def conversation_attributes_for_storage
       { ai_conversation: base_attributes.merge(relationship_attributes).merge(messages_attributes).compact }
     end
 
     private
 
-    def resolve_persistence_model
-      model_config = RubyConversations.configuration.persistence_model
-      unless model_config.is_a?(String)
-        raise ConfigurationError, "Invalid persistence_model configured: Must be a String, got #{model_config.class}"
-      end
-
-      model_config.safe_constantize ||
-        raise(ConfigurationError, "Invalid persistence_model configured: '#{model_config}' could not be resolved.")
-    rescue NameError => e
-      # Catch potential NameError from constantize if the class name is invalid
-      raise ConfigurationError, "Invalid persistence_model configured: #{e.message}"
-    end
-
     def base_attributes
       {
         id: id

data/app/models/ruby_conversations/message_builder.rb

@@ -15,7 +15,13 @@ module RubyConversations
       message = build_message(interpolated_message, description)
       build_prompt_association(message, prompt, inputs)
 
-      message # Return the built message
+      message
+    end
+
+    def build_from_user_message(raw_message, description: nil)
+      message = build_message(raw_message, description)
+      build_message_prompt(message, Prompt.new(name: 'user_message', role: 'user', message: raw_message))
+      message
     end
 
     def build_from_multiple_prompts(prompt_inputs, description: nil)

data/lib/ruby_conversations/client.rb

@@ -60,6 +60,14 @@ module RubyConversations
       handle_response(response)
     end
 
+    # Fetch a conversation template by name
+    # @param template_name [String] The name of the template to fetch
+    # @return [Hash] The template data including messages and prompts
+    def fetch_conversation_template(template_name)
+      response = client.get("api/ai_conversations/#{template_name}")
+      handle_response(response)
+    end
+
     # Fetch a prompt by name
     # @param name [String] The name of the prompt to fetch
     # @return [Hash] The prompt attributes
@@ -119,7 +127,7 @@ module RubyConversations
       return response.body if response.success?
 
       @logger.error("API request failed: #{response.body.inspect}")
-      raise RubyConversations::Error, "API request failed: #{response.body}"
+      raise RubyConversations::ClientError.new("API request failed: #{response.body}", status_code: response.status)
     end
   end
 end

data/lib/ruby_conversations/configuration.rb

@@ -3,7 +3,7 @@
 module RubyConversations
   # Configuration options for RubyConversations
   class Configuration
-    attr_accessor :api_url, :jwt_secret, :default_llm_model, :default_llm_provider, :persistence_model
+    attr_accessor :api_url, :jwt_secret, :default_llm_model, :default_llm_provider
 
     def initialize
       @default_llm_model = 'claude-3-7-sonnet'

data/lib/ruby_conversations/errors.rb

@@ -6,4 +6,17 @@ module RubyConversations
 
   # Error raised when there is a configuration issue
   class ConfigurationError < Error; end
+
+  # Error raised when there is an error with the client
+  class ClientError < StandardError
+    attr_reader :status_code
+
+    def initialize(message, status_code: nil)
+      super(message)
+      @status_code = status_code
+    end
+  end
+
+  # Error raised when a template is not found
+  class TemplateNotFoundError < Error; end
 end

data/lib/ruby_conversations/version.rb

@@ -3,7 +3,7 @@
 module RubyConversations
   MAJOR = 1
   MINOR = 1
-  PATCH = 1
+  PATCH = 3
 
   VERSION = "#{RubyConversations::MAJOR}.#{RubyConversations::MINOR}.#{RubyConversations::PATCH}".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby_conversations
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.1.3
 platform: ruby
 authors:
 - Paul Shippy
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-04-25 00:00:00.000000000 Z
+date: 2025-05-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -258,6 +258,7 @@ files:
 - README.md
 - app/models/ruby_conversations/concerns/conversation_chat.rb
 - app/models/ruby_conversations/concerns/conversation_messages.rb
+- app/models/ruby_conversations/concerns/conversation_templates.rb
 - app/models/ruby_conversations/concerns/llm_credentials.rb
 - app/models/ruby_conversations/concerns/message_api_attributes.rb
 - app/models/ruby_conversations/concerns/message_attributes.rb