ruby_conversations 1.1.2 → 1.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ebe08b35dd3c009e6bd81c5fb6bbb8e9d109d51b76d4469a8af13deeadaebfc5
-  data.tar.gz: db51099d58654198bcbb1d0c873896f729170937798b0f8cee7928cc44dc5e3c
+  metadata.gz: 65450a67b9c5b73041bae92b1888a1ed62fbaf2e7877cdbf333ffef9f22c66ee
+  data.tar.gz: 60255ec9205d6f84cedb7b9f733fce0121b8f4bc8db4e8adb14cfa58bd745550
 SHA512:
-  metadata.gz: 78866ece10dffbce9e4daaa3b6fff1dd8b019663b5c0f665f4043b984b8de17a4c004ae23e62a490eae3626540be14f0811a3b9fef7b00c18f7593789dced64a
-  data.tar.gz: 84cd8cfe96fad9343323ecd5080586647ab2bb762290954b2aa8887c875f628d96c12d6b61a4473489ea584c2b2cb5749b35cb5632f129e71e5b903a5c890666
+  metadata.gz: 704bd3d750ae71b30890fe19ab9cbe9d2416b881845eee9193dbb8b6bd5b9f6bdcec232715c82b113064977211e7801b64f9bd00fd7e20d020225895526f851c
+  data.tar.gz: efcda7a901213aa9b5ec5e71196aadc2d319d79432ae21d624d3b3d63e45c8f92079e89041c107c7caf36ca513c7b006969163e88f7effbd3342b219e4f02855

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,6 +8,7 @@ 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

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/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 = 2
+  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.2
+  version: 1.1.3
 platform: ruby
 authors:
 - Paul Shippy
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-05-01 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