rails_chatbot 0.1.0

data/app/models/rails_chatbot/conversation.rb

@@ -0,0 +1,25 @@
+module RailsChatbot
+  class Conversation < ApplicationRecord
+    self.table_name = 'rails_chatbot_conversations'
+
+    has_many :messages, dependent: :destroy, class_name: 'RailsChatbot::Message'
+
+    validates :session_id, presence: true
+
+    scope :recent, -> { order(created_at: :desc) }
+
+    def add_user_message(content)
+      messages.create!(content: content, role: 'user')
+    end
+
+    def add_assistant_message(content, metadata: {})
+      messages.create!(content: content, role: 'assistant', metadata: metadata)
+    end
+
+    def conversation_history
+      messages.order(created_at: :asc).map do |msg|
+        { role: msg.role, content: msg.content }
+      end
+    end
+  end
+end

data/app/models/rails_chatbot/knowledge_base.rb

@@ -0,0 +1,57 @@
+module RailsChatbot
+  class KnowledgeBase < ApplicationRecord
+    self.table_name = 'rails_chatbot_knowledge_bases'
+
+    begin
+      if defined?(PgSearch)
+        include PgSearch::Model
+
+        pg_search_scope :search_by_content,
+          against: [:title, :content],
+          using: {
+            tsearch: { prefix: true, any_word: true }
+          }
+      else
+        raise LoadError
+      end
+    rescue LoadError, NameError
+      # Fallback search scope without pg_search (works with any database)
+      scope :search_by_content, ->(query) {
+        sanitized_query = connection.quote_string(query.to_s)
+        where("title LIKE ? OR content LIKE ?", "%#{sanitized_query}%", "%#{sanitized_query}%")
+      }
+    end
+
+    validates :title, presence: true
+    validates :content, presence: true
+    validates :source_type, presence: true
+
+    scope :by_source, ->(type, id = nil) {
+      scope = where(source_type: type)
+      scope = scope.where(source_id: id) if id
+      scope
+    }
+
+    def self.index_model(model_class, fields: [:name, :description, :content])
+      model_class.find_each do |record|
+        content_parts = fields.map { |field| record.send(field) if record.respond_to?(field) }.compact
+        content_text = content_parts.join("\n\n")
+
+        source_url = begin
+          Rails.application.routes.url_helpers.polymorphic_path(record)
+        rescue
+          nil
+        end
+
+        find_or_initialize_by(
+          source_type: model_class.name,
+          source_id: record.id.to_s
+        ).update!(
+          title: record.try(:name) || record.try(:title) || "#{model_class.name} ##{record.id}",
+          content: content_text,
+          source_url: source_url
+        )
+      end
+    end
+  end
+end

data/app/models/rails_chatbot/message.rb

@@ -0,0 +1,13 @@
+module RailsChatbot
+  class Message < ApplicationRecord
+    self.table_name = 'rails_chatbot_messages'
+
+    belongs_to :conversation, class_name: 'RailsChatbot::Conversation'
+
+    validates :content, presence: true
+    validates :role, inclusion: { in: %w[user assistant system] }
+
+    scope :user_messages, -> { where(role: 'user') }
+    scope :assistant_messages, -> { where(role: 'assistant') }
+  end
+end

data/app/services/rails_chatbot/chat_service.rb

@@ -0,0 +1,41 @@
+module RailsChatbot
+  class ChatService
+    attr_reader :conversation, :llm_service
+
+    def initialize(conversation:, api_key: nil)
+      @conversation = conversation
+      @llm_service = LlmService.new(api_key: api_key)
+    end
+
+    def process_message(user_message)
+      # Retrieve relevant knowledge
+      knowledge_service = KnowledgeRetrievalService.new(query: user_message)
+      context = knowledge_service.format_context
+
+      # Get conversation history
+      messages = conversation.conversation_history
+
+      # Add the new user message
+      conversation.add_user_message(user_message)
+
+      # Generate response
+      response = llm_service.chat(
+        messages: messages,
+        context: context
+      )
+
+      # Save assistant response
+      conversation.add_assistant_message(
+        response,
+        metadata: {
+          knowledge_results: knowledge_service.retrieve.map { |r| r.slice(:title, :source_type, :source_id) }
+        }
+      )
+
+      {
+        response: response,
+        knowledge_sources: knowledge_service.retrieve
+      }
+    end
+  end
+end

data/app/services/rails_chatbot/knowledge_retrieval_service.rb

@@ -0,0 +1,42 @@
+module RailsChatbot
+  class KnowledgeRetrievalService
+    def initialize(query:, limit: 5)
+      @query = query
+      @limit = limit
+    end
+
+    def retrieve
+      return [] if @query.blank?
+
+      # Search knowledge base using pg_search
+      results = KnowledgeBase.search_by_content(@query).limit(@limit)
+
+      # Format results for context
+      results.map do |kb|
+        {
+          title: kb.title,
+          content: kb.content,
+          source_type: kb.source_type,
+          source_id: kb.source_id,
+          source_url: kb.source_url
+        }
+      end
+    end
+
+    def format_context
+      results = retrieve
+      return nil if results.empty?
+
+      context_parts = results.map do |result|
+        <<~CONTEXT
+          Title: #{result[:title]}
+          Source: #{result[:source_type]}#{" (ID: #{result[:source_id]})" if result[:source_id]}
+          Content: #{result[:content]}
+          #{result[:source_url] ? "URL: #{result[:source_url]}" : ""}
+        CONTEXT
+      end
+
+      context_parts.join("\n\n---\n\n")
+    end
+  end
+end

data/app/services/rails_chatbot/llm_service.rb

@@ -0,0 +1,64 @@
+module RailsChatbot
+  class LlmService
+    attr_reader :client, :model
+
+    def initialize(api_key: nil, model: nil)
+      api_key ||= RailsChatbot.configuration.openai_api_key || ENV['OPENAI_API_KEY']
+      model ||= RailsChatbot.configuration.openai_model || 'gpt-4o-mini'
+      
+      raise ArgumentError, "OpenAI API key is required" unless api_key
+      
+      @client = OpenAI::Client.new(access_token: api_key)
+      @model = model
+    end
+
+    def chat(messages:, context: nil, temperature: 0.7)
+      system_message = build_system_message(context)
+      conversation_messages = [system_message] + messages
+
+      response = client.chat(
+        parameters: {
+          model: model,
+          messages: conversation_messages,
+          temperature: temperature
+        }
+      )
+
+      response.dig('choices', 0, 'message', 'content')
+    rescue => e
+      Rails.logger.error("LLM Service Error: #{e.message}")
+      "I apologize, but I'm experiencing technical difficulties. Please try again later."
+    end
+
+    private
+
+    def build_system_message(context)
+      base_prompt = <<~PROMPT
+        You are a helpful AI assistant integrated into a Ruby on Rails application.
+        Your role is to answer questions about the application and help users navigate and understand the system.
+        
+        You have access to the application's knowledge base, which contains information about:
+        - Models and their attributes
+        - Application features and functionality
+        - User guides and documentation
+        - Common questions and answers
+        
+        When answering questions:
+        1. Use the provided context from the knowledge base to give accurate answers
+        2. Be concise but thorough
+        3. If you don't know something, admit it rather than guessing
+        4. Provide helpful examples when relevant
+        5. Format your responses clearly with proper markdown when appropriate
+      PROMPT
+
+      if context.present?
+        base_prompt += "\n\nRelevant Context:\n#{context}"
+      end
+
+      {
+        role: 'system',
+        content: base_prompt
+      }
+    end
+  end
+end

data/app/views/layouts/rails_chatbot/application.html.erb

@@ -0,0 +1,17 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Rails chatbot</title>
+  <%= csrf_meta_tags %>
+  <%= csp_meta_tag %>
+
+  <%= yield :head %>
+
+  <%= stylesheet_link_tag    "rails_chatbot/application", media: "all" %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/app/views/rails_chatbot/chat/index.html.erb

@@ -0,0 +1,165 @@
+<%= content_for :head do %>
+  <style>
+    .chatbot-container {
+      max-width: 800px;
+      margin: 0 auto;
+      height: 600px;
+      display: flex;
+      flex-direction: column;
+      border: 1px solid #ddd;
+      border-radius: 8px;
+      overflow: hidden;
+      background: #fff;
+    }
+
+    .chatbot-header {
+      background: #4a5568;
+      color: white;
+      padding: 1rem;
+      font-weight: bold;
+    }
+
+    .chatbot-messages {
+      flex: 1;
+      overflow-y: auto;
+      padding: 1rem;
+      background: #f7fafc;
+    }
+
+    .message {
+      margin-bottom: 1rem;
+      display: flex;
+      flex-direction: column;
+    }
+
+    .message.user {
+      align-items: flex-end;
+    }
+
+    .message.assistant {
+      align-items: flex-start;
+    }
+
+    .message-bubble {
+      max-width: 70%;
+      padding: 0.75rem 1rem;
+      border-radius: 1rem;
+      word-wrap: break-word;
+    }
+
+    .message.user .message-bubble {
+      background: #4299e1;
+      color: white;
+    }
+
+    .message.assistant .message-bubble {
+      background: white;
+      color: #2d3748;
+      border: 1px solid #e2e8f0;
+    }
+
+    .message-time {
+      font-size: 0.75rem;
+      color: #718096;
+      margin-top: 0.25rem;
+    }
+
+    .chatbot-input-container {
+      display: flex;
+      padding: 1rem;
+      background: white;
+      border-top: 1px solid #e2e8f0;
+    }
+
+    .chatbot-input {
+      flex: 1;
+      padding: 0.75rem;
+      border: 1px solid #cbd5e0;
+      border-radius: 0.5rem;
+      font-size: 1rem;
+    }
+
+    .chatbot-send {
+      margin-left: 0.5rem;
+      padding: 0.75rem 1.5rem;
+      background: #4299e1;
+      color: white;
+      border: none;
+      border-radius: 0.5rem;
+      cursor: pointer;
+      font-weight: bold;
+    }
+
+    .chatbot-send:hover {
+      background: #3182ce;
+    }
+
+    .chatbot-send:disabled {
+      background: #cbd5e0;
+      cursor: not-allowed;
+    }
+
+    .loading {
+      display: inline-block;
+      width: 20px;
+      height: 20px;
+      border: 3px solid #f3f3f3;
+      border-top: 3px solid #4299e1;
+      border-radius: 50%;
+      animation: spin 1s linear infinite;
+    }
+
+    @keyframes spin {
+      0% { transform: rotate(0deg); }
+      100% { transform: rotate(360deg); }
+    }
+
+    .knowledge-sources {
+      margin-top: 0.5rem;
+      font-size: 0.75rem;
+      color: #718096;
+    }
+
+    .knowledge-sources a {
+      color: #4299e1;
+      text-decoration: none;
+    }
+  </style>
+<% end %>
+
+<div class="chatbot-container" data-controller="chatbot">
+  <div class="chatbot-header">
+    <%= RailsChatbot.configuration.chatbot_title %>
+  </div>
+  
+  <div class="chatbot-messages" data-chatbot-target="messages">
+    <div class="message assistant">
+      <div class="message-bubble">
+        Hello! I'm your application assistant. How can I help you today?
+      </div>
+    </div>
+  </div>
+  
+  <div class="chatbot-input-container">
+    <input 
+      type="text" 
+      class="chatbot-input" 
+      placeholder="Type your message..."
+      data-chatbot-target="input"
+      data-action="keydown->chatbot#handleKeyDown"
+    >
+    <button 
+      class="chatbot-send" 
+      data-action="click->chatbot#sendMessage"
+      data-chatbot-target="sendButton"
+    >
+      Send
+    </button>
+  </div>
+</div>
+
+<script>
+  window.RailsChatbot = window.RailsChatbot || {};
+  window.RailsChatbot.routes = <%= rails_chatbot_routes %>;
+</script>
+<%= javascript_include_tag "rails_chatbot/application" %>

data/config/initializers/rails_chatbot.rb

@@ -0,0 +1,13 @@
+Rails.application.config.rails_chatbot = RailsChatbot.configuration
+
+Rails.application.config.to_prepare do
+  # Allow configuration to be set in initializers
+  if Rails.application.config.rails_chatbot
+    RailsChatbot.configuration.openai_api_key ||= Rails.application.config.rails_chatbot.openai_api_key
+    RailsChatbot.configuration.openai_model ||= Rails.application.config.rails_chatbot.openai_model
+    RailsChatbot.configuration.chatbot_title ||= Rails.application.config.rails_chatbot.chatbot_title
+    RailsChatbot.configuration.current_user_proc ||= Rails.application.config.rails_chatbot.current_user_proc
+    RailsChatbot.configuration.enable_knowledge_base_indexing ||= Rails.application.config.rails_chatbot.enable_knowledge_base_indexing
+    RailsChatbot.configuration.indexable_models ||= Rails.application.config.rails_chatbot.indexable_models
+  end
+end

data/config/routes.rb

@@ -0,0 +1,13 @@
+RailsChatbot::Engine.routes.draw do
+  root to: 'chat#index'
+  
+  resources :conversations, only: [:index,  :show, :create, :destroy] do
+    resources :messages, only: [:create]
+  end
+  
+  post 'messages', to: 'messages#create'
+  get 'search', to: 'chat#search'
+  
+  # Add explicit route for conversation messages
+  post 'conversations/:conversation_id/messages', to: 'messages#create'
+end

data/db/migrate/001_create_rails_chatbot_conversations.rb

@@ -0,0 +1,10 @@
+class CreateRailsChatbotConversations < ActiveRecord::Migration[8.0]
+  def change
+    create_table :rails_chatbot_conversations do |t|
+      t.string :session_id, null: false, index: true
+      t.references :user, polymorphic: true, null: true, index: true
+      t.string :title
+      t.timestamps
+    end
+  end
+end

data/db/migrate/002_create_rails_chatbot_messages.rb

@@ -0,0 +1,11 @@
+class CreateRailsChatbotMessages < ActiveRecord::Migration[8.0]
+  def change
+    create_table :rails_chatbot_messages do |t|
+      t.references :conversation, null: false, foreign_key: { to_table: :rails_chatbot_conversations }, index: true
+      t.text :content, null: false
+      t.string :role, null: false, default: 'user' # user, assistant, system
+      t.json :metadata
+      t.timestamps
+    end
+  end
+end

data/db/migrate/003_create_rails_chatbot_knowledge_bases.rb

@@ -0,0 +1,16 @@
+class CreateRailsChatbotKnowledgeBases < ActiveRecord::Migration[8.0]
+  def change
+    create_table :rails_chatbot_knowledge_bases do |t|
+      t.string :title, null: false
+      t.text :content, null: false
+      t.string :source_type, null: false # model, page, document, etc.
+      t.string :source_id
+      t.string :source_url
+      t.text :embedding_data # For vector search if needed
+      t.timestamps
+    end
+
+    add_index :rails_chatbot_knowledge_bases, [:source_type, :source_id]
+    add_index :rails_chatbot_knowledge_bases, :title
+  end
+end

data/db/seeds.rb

@@ -0,0 +1,86 @@
+# This file contains sample data for the RailsChatbot knowledge base
+# Run with: rails db:seed
+
+RailsChatbot::KnowledgeIndexer.add_custom_knowledge(
+  title: "Getting Started with RailsChatbot",
+  content: <<~CONTENT
+    RailsChatbot is a powerful AI-powered chatbot system for Rails applications.
+    
+    To get started:
+    1. Install the gem and run migrations
+    2. Configure your OpenAI API key
+    3. Mount the engine in your routes
+    4. Index your models or add custom knowledge
+    
+    The chatbot will then be able to answer questions about your application.
+  CONTENT,
+  source_type: "documentation",
+  source_url: "/docs/getting-started"
+)
+
+RailsChatbot::KnowledgeIndexer.add_custom_knowledge(
+  title: "API Configuration",
+  content: <<~CONTENT
+    Configure RailsChatbot in config/initializers/rails_chatbot.rb:
+    
+    RailsChatbot.configure do |config|
+      config.openai_api_key = ENV['OPENAI_API_KEY']
+      config.openai_model = 'gpt-4o-mini'
+      config.chatbot_title = 'Your Assistant'
+    end
+    
+    Make sure to set your OPENAI_API_KEY environment variable.
+  CONTENT,
+  source_type: "configuration",
+  source_url: "/docs/configuration"
+)
+
+RailsChatbot::KnowledgeIndexer.add_custom_knowledge(
+  title: "Knowledge Base Management",
+  content: <<~CONTENT
+    You can manage the knowledge base using these rake tasks:
+    
+    - rake rails_chatbot:index_all - Index all models
+    - rake rails_chatbot:index_models[User,Post] - Index specific models
+    - rake rails_chatbot:add_knowledge['Title','Content'] - Add custom knowledge
+    - rake rails_chatbot:clear_knowledge_base - Clear all entries
+    - rake rails_chatbot:stats - View statistics
+    
+    The knowledge base uses PostgreSQL full-text search for fast retrieval.
+  CONTENT,
+  source_type: "management",
+  source_url: "/docs/knowledge-base"
+)
+
+RailsChatbot::KnowledgeIndexer.add_custom_knowledge(
+  title: "Troubleshooting Common Issues",
+  content: <<~CONTENT
+    Common issues and solutions:
+    
+    1. OpenAI API errors: Check your API key and model selection
+    2. Search not working: Ensure PostgreSQL is properly configured
+    3. No knowledge found: Run rake rails_chatbot:index_all to populate the base
+    4. Routing errors: Verify the engine is mounted correctly in routes.rb
+    5. Permission errors: Check database permissions for the chatbot tables
+  CONTENT,
+  source_type: "troubleshooting",
+  source_url: "/docs/troubleshooting"
+)
+
+RailsChatbot::KnowledgeIndexer.add_custom_knowledge(
+  title: "Customizing the Chat Interface",
+  content: <<~CONTENT
+    You can customize the chat interface by:
+    
+    1. Overriding views in your app/views/rails_chatbot/
+    2. Modifying CSS styles in app/assets/stylesheets/rails_chatbot/
+    3. Extending JavaScript functionality in app/javascript/rails_chatbot/
+    4. Customizing the system prompt in LlmService
+    
+    The interface is built with vanilla JavaScript and can be easily customized.
+  CONTENT,
+  source_type: "customization",
+  source_url: "/docs/customization"
+)
+
+puts "✓ RailsChatbot sample knowledge base seeded successfully!"

data/lib/generators/rails_chatbot/install/install_generator.rb

@@ -0,0 +1,19 @@
+module RailsChatbot
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path('templates', __dir__)
+
+      def create_initializer
+        copy_file 'rails_chatbot.rb', 'config/initializers/rails_chatbot.rb'
+      end
+
+      def add_routes
+        route "mount RailsChatbot::Engine => '/chatbot'"
+      end
+
+      def show_readme
+        readme 'README' if behavior == :invoke
+      end
+    end
+  end
+end

data/lib/generators/rails_chatbot/install/templates/README

@@ -0,0 +1,16 @@
+RailsChatbot Installation Complete!
+
+Next steps:
+
+1. Set your OpenAI API key:
+   export OPENAI_API_KEY=your_api_key_here
+
+2. Run migrations:
+   rails db:migrate
+
+3. Index your models:
+   rake rails_chatbot:index_all
+
+4. Visit /chatbot in your application to start using the chatbot!
+
+For more information, see the README.md file.

data/lib/generators/rails_chatbot/install/templates/rails_chatbot.rb

@@ -0,0 +1,13 @@
+RailsChatbot.configure do |config|
+  # Set your OpenAI API key
+  config.openai_api_key = ENV['OPENAI_API_KEY']
+  
+  # Choose the model (gpt-4o-mini, gpt-4, gpt-3.5-turbo, etc.)
+  config.openai_model = 'gpt-4o-mini'
+  
+  # Customize the chatbot title
+  config.chatbot_title = 'Application Assistant'
+  
+  # Optional: Define how to get current user (uncomment and customize)
+  # config.current_user_proc = proc { |controller| controller.current_user }
+end

data/lib/rails_chatbot/engine.rb

@@ -0,0 +1,19 @@
+module RailsChatbot
+  class Engine < ::Rails::Engine
+    isolate_namespace RailsChatbot
+
+    initializer "rails_chatbot.assets.precompile" do |app|
+      app.config.assets.precompile += %w[rails_chatbot/application.js rails_chatbot/application.css]
+    end
+
+    config.generators do |g|
+      g.test_framework :rspec
+      g.fixture_replacement :factory_bot
+      g.factory_bot dir: 'spec/factories'
+    end
+
+    initializer "rails_chatbot.load_config" do
+      require_relative '../../config/initializers/rails_chatbot' if File.exist?(Rails.root.join('config/initializers/rails_chatbot.rb'))
+    end
+  end
+end