flow_chat 0.5.1 → 0.6.0

data/lib/flow_chat/whatsapp/renderer.rb

@@ -0,0 +1,191 @@
+module FlowChat
+  module Whatsapp
+    class Renderer
+      attr_reader :message, :choices, :media
+
+      def initialize(message, choices: nil, media: nil)
+        @message = message
+        @choices = choices
+        @media = media
+      end
+
+      def render
+        if media && choices
+          build_selection_message_with_media
+        elsif media
+          build_media_message
+        elsif choices
+          build_selection_message
+        else
+          build_text_message
+        end
+      end
+
+      private
+
+      def build_text_message
+        [:text, message, {}]
+      end
+
+      def build_media_message
+        media_type = media[:type] || :image
+        url = media[:url] || media[:path]
+        filename = media[:filename]
+
+        case media_type.to_sym
+        when :image
+          [:media_image, "", {url: url, caption: message}]
+        when :document
+          [:media_document, "", {url: url, caption: message, filename: filename}]
+        when :audio
+          [:media_audio, "", {url: url, caption: message}]
+        when :video
+          [:media_video, "", {url: url, caption: message}]
+        when :sticker
+          [:media_sticker, "", {url: url}] # Stickers don't support captions
+        else
+          raise ArgumentError, "Unsupported media type: #{media_type}"
+        end
+      end
+
+      def build_selection_message
+        # Determine the best way to present choices
+        if choices.is_a?(Array)
+          # Convert array to hash with index-based keys
+          choice_hash = choices.each_with_index.to_h { |choice, index| [index.to_s, choice] }
+          build_interactive_message(choice_hash)
+        elsif choices.is_a?(Hash)
+          build_interactive_message(choices)
+        else
+          raise ArgumentError, "choices must be an Array or Hash"
+        end
+      end
+
+      def build_selection_message_with_media
+        # Convert array to hash with index-based keys if needed, same as build_selection_message
+        if choices.is_a?(Array)
+          choice_hash = choices.each_with_index.to_h { |choice, index| [index.to_s, choice] }
+          build_buttons_message_with_media(choice_hash)
+        elsif choices.is_a?(Hash)
+          build_buttons_message_with_media(choices)
+        else
+          raise ArgumentError, "choices must be an Array or Hash"
+        end
+      end
+
+      def build_interactive_message(choice_hash)
+        if choice_hash.length <= 3
+          # Use buttons for 3 or fewer choices
+          build_buttons_message(choice_hash)
+        else
+          # Use list for more than 3 choices
+          build_list_message(choice_hash)
+        end
+      end
+
+      def build_buttons_message(choices)
+        buttons = choices.map do |key, value|
+          {
+            id: key.to_s,
+            title: truncate_text(value.to_s, 20) # WhatsApp button titles have a 20 character limit
+          }
+        end
+
+        [:interactive_buttons, message, {buttons: buttons}]
+      end
+
+      def build_buttons_message_with_media(choices)
+        buttons = choices.map do |key, value|
+          {
+            id: key.to_s,
+            title: truncate_text(value.to_s, 20) # WhatsApp button titles have a 20 character limit
+          }
+        end
+
+        # Build media header
+        header = build_media_header
+
+        [:interactive_buttons, message, {buttons: buttons, header: header}]
+      end
+
+      def build_media_header
+        media_type = media[:type] || :image
+        url = media[:url] || media[:path]
+        filename = media[:filename]
+
+        case media_type.to_sym
+        when :image
+          {
+            type: "image",
+            image: {link: url}
+          }
+        when :video
+          {
+            type: "video", 
+            video: {link: url}
+          }
+        when :document
+          header_doc = {link: url}
+          header_doc[:filename] = filename if filename
+          {
+            type: "document",
+            document: header_doc
+          }
+        when :text
+          {
+            type: "text",
+            text: url # For text headers, url contains the text
+          }
+        else
+          raise ArgumentError, "Unsupported header media type: #{media_type}. Supported types for button headers: image, video, document, text"
+        end
+      end
+
+      def build_list_message(choices)
+        items = choices.map do |key, value|
+          original_text = value.to_s
+          truncated_title = truncate_text(original_text, 24)
+
+          # If title was truncated, put full text in description (up to 72 chars)
+          description = if original_text.length > 24
+            truncate_text(original_text, 72)
+          end
+
+          {
+            id: key.to_s,
+            title: truncated_title,
+            description: description
+          }.compact
+        end
+
+        # If 10 or fewer items, use single section
+        sections = if items.length <= 10
+          [
+            {
+              title: "Options",
+              rows: items
+            }
+          ]
+        else
+          # Paginate into multiple sections (max 10 items per section)
+          items.each_slice(10).with_index.map do |section_items, index|
+            start_num = (index * 10) + 1
+            end_num = start_num + section_items.length - 1
+
+            {
+              title: "#{start_num}-#{end_num}",
+              rows: section_items
+            }
+          end
+        end
+
+        [:interactive_list, message, {sections: sections}]
+      end
+
+      def truncate_text(text, length)
+        return text if text.length <= length
+        text[0, length - 3] + "..."
+      end
+    end
+  end
+end 

data/lib/flow_chat.rb

@@ -1,6 +1,7 @@
 require "zeitwerk"
 require "active_support"
 require "active_support/core_ext/time"
+require "active_support/core_ext/object/blank"
 
 loader = Zeitwerk::Loader.for_gem
 loader.enable_reloading if defined?(Rails.env) && Rails.env.development?

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: flow_chat
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.6.0
 platform: ruby
 authors:
 - Stefan Froelich
@@ -96,8 +96,11 @@ files:
 - README.md
 - Rakefile
 - SECURITY.md
+- app/controllers/demo_controller.rb
+- app/flow_chat/demo_restaurant_flow.rb
 - bin/console
 - bin/setup
+- config/routes_demo.rb
 - examples/initializer.rb
 - examples/media_prompts_examples.rb
 - examples/multi_tenant_whatsapp_controller.rb
@@ -114,6 +117,7 @@ files:
 - lib/flow_chat/context.rb
 - lib/flow_chat/flow.rb
 - lib/flow_chat/interrupt.rb
+- lib/flow_chat/prompt.rb
 - lib/flow_chat/session/cache_session_store.rb
 - lib/flow_chat/session/middleware.rb
 - lib/flow_chat/session/rails_session_store.rb
@@ -126,7 +130,6 @@ files:
 - lib/flow_chat/ussd/middleware/pagination.rb
 - lib/flow_chat/ussd/middleware/resumable_session.rb
 - lib/flow_chat/ussd/processor.rb
-- lib/flow_chat/ussd/prompt.rb
 - lib/flow_chat/ussd/renderer.rb
 - lib/flow_chat/version.rb
 - lib/flow_chat/whatsapp/app.rb
@@ -135,7 +138,7 @@ files:
 - lib/flow_chat/whatsapp/gateway/cloud_api.rb
 - lib/flow_chat/whatsapp/middleware/executor.rb
 - lib/flow_chat/whatsapp/processor.rb
-- lib/flow_chat/whatsapp/prompt.rb
+- lib/flow_chat/whatsapp/renderer.rb
 - lib/flow_chat/whatsapp/send_job_support.rb
 - lib/flow_chat/whatsapp/template_manager.rb
 homepage: https://github.com/radioactive-labs/flow_chat

data/lib/flow_chat/ussd/prompt.rb

@@ -1,102 +0,0 @@
-module FlowChat
-  module Ussd
-    class Prompt
-      attr_reader :user_input
-
-      def initialize(input)
-        @user_input = input
-      end
-
-      def ask(msg, choices: nil, convert: nil, validate: nil, transform: nil, media: nil)
-        if user_input.present?
-          input = user_input
-          input = convert.call(input) if convert.present?
-          validation_error = validate.call(input) if validate.present?
-
-          if validation_error.present?
-            # Include media URL in validation error message
-            original_message_with_media = build_message_with_media(msg, media)
-            prompt!([validation_error, original_message_with_media].join("\n\n"), choices:)
-          end
-
-          input = transform.call(input) if transform.present?
-          return input
-        end
-
-        # Include media URL in the message for USSD
-        final_message = build_message_with_media(msg, media)
-        prompt! final_message, choices:
-      end
-
-      def say(message, media: nil)
-        # Include media URL in the message for USSD
-        final_message = build_message_with_media(message, media)
-        terminate! final_message
-      end
-
-      def select(msg, choices)
-        choices, choices_prompt = build_select_choices choices
-        ask(
-          msg,
-          choices: choices_prompt,
-          convert: lambda { |choice| choice.to_i },
-          validate: lambda { |choice| "Invalid selection:" unless (1..choices.size).cover?(choice) },
-          transform: lambda { |choice| choices[choice - 1] }
-        )
-      end
-
-      def yes?(msg)
-        select(msg, ["Yes", "No"]) == "Yes"
-      end
-
-      private
-
-      def build_message_with_media(message, media)
-        return message unless media
-
-        media_url = media[:url] || media[:path]
-        media_type = media[:type] || :image
-
-        # For USSD, we append the media URL to the message
-        media_text = case media_type.to_sym
-        when :image
-          "📷 Image: #{media_url}"
-        when :document
-          "📄 Document: #{media_url}"
-        when :audio
-          "🎵 Audio: #{media_url}"
-        when :video
-          "🎥 Video: #{media_url}"
-        when :sticker
-          "😊 Sticker: #{media_url}"
-        else
-          "📎 Media: #{media_url}"
-        end
-
-        # Combine message with media information
-        "#{message}\n\n#{media_text}"
-      end
-
-      def build_select_choices(choices)
-        case choices
-        when Array
-          choices_prompt = choices.map.with_index { |c, i| [i + 1, c] }.to_h
-        when Hash
-          choices_prompt = choices.values.map.with_index { |c, i| [i + 1, c] }.to_h
-          choices = choices.keys
-        else
-          raise ArgumentError, "choices must be an array or hash"
-        end
-        [choices, choices_prompt]
-      end
-
-      def prompt!(msg, choices:)
-        raise FlowChat::Interrupt::Prompt.new(msg, choices:)
-      end
-
-      def terminate!(msg)
-        raise FlowChat::Interrupt::Terminate.new(msg)
-      end
-    end
-  end
-end

data/lib/flow_chat/whatsapp/prompt.rb

@@ -1,247 +0,0 @@
-module FlowChat
-  module Whatsapp
-    class Prompt
-      attr_reader :input
-
-      def initialize(input)
-        @input = input
-      end
-
-      def ask(message, transform: nil, validate: nil, convert: nil, media: nil)
-        if input.present?
-          begin
-            processed_input = process_input(input, transform, validate, convert)
-            return processed_input unless processed_input.nil?
-          rescue FlowChat::Interrupt::Prompt => validation_error
-            # If validation failed, include the error message with the original prompt
-            error_message = validation_error.prompt[1]
-            combined_message = "#{message}\n\n#{error_message}"
-            raise FlowChat::Interrupt::Prompt.new([:text, combined_message, {}])
-          end
-        end
-
-        # Send message and wait for response, optionally with media
-        if media
-          raise FlowChat::Interrupt::Prompt.new(build_media_prompt(message, media))
-        else
-          raise FlowChat::Interrupt::Prompt.new([:text, message, {}])
-        end
-      end
-
-      def say(message, media: nil)
-        if media
-          raise FlowChat::Interrupt::Terminate.new(build_media_prompt(message, media))
-        else
-          raise FlowChat::Interrupt::Terminate.new([:text, message, {}])
-        end
-      end
-
-      def select(message, choices, transform: nil, validate: nil, convert: nil)
-        if input.present?
-          processed_input = process_selection(input, choices, transform, validate, convert)
-          return processed_input unless processed_input.nil?
-        end
-
-        # Validate choices
-        validate_choices(choices)
-
-        # Standard selection without media support
-        interactive_prompt = build_selection_prompt(message, choices)
-        raise FlowChat::Interrupt::Prompt.new(interactive_prompt)
-      end
-
-      def yes?(message, transform: nil, validate: nil, convert: nil)
-        if input.present?
-          processed_input = process_boolean(input, transform, validate, convert)
-          return processed_input unless processed_input.nil?
-        end
-
-        buttons = [
-          {id: "yes", title: "Yes"},
-          {id: "no", title: "No"}
-        ]
-        raise FlowChat::Interrupt::Prompt.new([:interactive_buttons, message, {buttons: buttons}])
-      end
-
-      private
-
-      def build_media_prompt(message, media)
-        media_type = media[:type] || :image
-        url = media[:url] || media[:path]
-        filename = media[:filename]
-
-        case media_type.to_sym
-        when :image
-          [:media_image, "", {url: url, caption: message}]
-        when :document
-          [:media_document, "", {url: url, caption: message, filename: filename}]
-        when :audio
-          [:media_audio, "", {url: url, caption: message}]
-        when :video
-          [:media_video, "", {url: url, caption: message}]
-        when :sticker
-          [:media_sticker, "", {url: url}] # Stickers don't support captions
-        else
-          raise ArgumentError, "Unsupported media type: #{media_type}"
-        end
-      end
-
-      def build_selection_prompt(message, choices)
-        # Determine the best way to present choices
-        if choices.is_a?(Array)
-          # Convert array to hash with index-based keys
-          choice_hash = choices.each_with_index.to_h { |choice, index| [index.to_s, choice] }
-          build_list_prompt(message, choice_hash)
-        elsif choices.is_a?(Hash)
-          if choices.length <= 3
-            # Use buttons for 3 or fewer choices
-            build_buttons_prompt(message, choices)
-          else
-            # Use list for more than 3 choices
-            build_list_prompt(message, choices)
-          end
-        else
-          raise ArgumentError, "choices must be an Array or Hash"
-        end
-      end
-
-      def build_buttons_prompt(message, choices)
-        buttons = choices.map do |key, value|
-          {
-            id: key.to_s,
-            title: truncate_text(value.to_s, 20) # WhatsApp button titles have a 20 character limit
-          }
-        end
-
-        [:interactive_buttons, message, {buttons: buttons}]
-      end
-
-      def build_list_prompt(message, choices)
-        items = choices.map do |key, value|
-          original_text = value.to_s
-          truncated_title = truncate_text(original_text, 24)
-
-          # If title was truncated, put full text in description (up to 72 chars)
-          description = if original_text.length > 24
-            truncate_text(original_text, 72)
-          end
-
-          {
-            id: key.to_s,
-            title: truncated_title,
-            description: description
-          }.compact
-        end
-
-        # If 10 or fewer items, use single section
-        sections = if items.length <= 10
-          [
-            {
-              title: "Options",
-              rows: items
-            }
-          ]
-        else
-          # Paginate into multiple sections (max 10 items per section)
-          items.each_slice(10).with_index.map do |section_items, index|
-            start_num = (index * 10) + 1
-            end_num = start_num + section_items.length - 1
-
-            {
-              title: "#{start_num}-#{end_num}",
-              rows: section_items
-            }
-          end
-        end
-
-        [:interactive_list, message, {sections: sections}]
-      end
-
-      def process_input(input, transform, validate, convert)
-        # Apply transformation
-        transformed_input = transform ? transform.call(input) : input
-
-        # Apply conversion first, then validation
-        converted_input = convert ? convert.call(transformed_input) : transformed_input
-
-        # Apply validation on converted value
-        if validate
-          error_message = validate.call(converted_input)
-          if error_message
-            raise FlowChat::Interrupt::Prompt.new([:text, error_message, {}])
-          end
-        end
-
-        converted_input
-      end
-
-      def process_selection(input, choices, transform, validate, convert)
-        choice_hash = choices.is_a?(Array) ?
-          choices.each_with_index.to_h { |choice, index| [index.to_s, choice] } :
-          choices
-
-        # Check if input matches a valid choice
-        if choice_hash.key?(input)
-          selected_value = choice_hash[input]
-          process_input(selected_value, transform, validate, convert)
-        elsif choice_hash.value?(input)
-          # Input matches a choice value directly
-          process_input(input, transform, validate, convert)
-        else
-          # Invalid choice
-          choice_list = choice_hash.map { |key, value| "#{key}: #{value}" }.join("\n")
-          error_message = "Invalid choice. Please select one of:\n#{choice_list}"
-          raise FlowChat::Interrupt::Prompt.new([:text, error_message, {}])
-        end
-      end
-
-      def process_boolean(input, transform, validate, convert)
-        boolean_value = case input.to_s.downcase
-        when "yes", "y", "1", "true"
-          true
-        when "no", "n", "0", "false"
-          false
-        end
-
-        if boolean_value.nil?
-          raise FlowChat::Interrupt::Prompt.new([:text, "Please answer with Yes or No.", {}])
-        end
-
-        process_input(boolean_value, transform, validate, convert)
-      end
-
-      def validate_choices(choices)
-        # Check for empty choices
-        if choices.nil? || choices.empty?
-          raise ArgumentError, "choices cannot be empty"
-        end
-
-        choice_count = choices.length
-
-        # WhatsApp supports max 100 total items across all sections
-        if choice_count > 100
-          raise ArgumentError, "WhatsApp supports maximum 100 choice options, got #{choice_count}"
-        end
-
-        # Validate individual choice values
-        choices_to_validate = choices.is_a?(Array) ? choices : choices.values
-
-        choices_to_validate.each_with_index do |choice, index|
-          if choice.nil? || choice.to_s.strip.empty?
-            raise ArgumentError, "choice at index #{index} cannot be empty"
-          end
-
-          choice_text = choice.to_s
-          if choice_text.length > 100
-            raise ArgumentError, "choice '#{choice_text[0..20]}...' is too long (#{choice_text.length} chars). Maximum is 100 characters"
-          end
-        end
-      end
-
-      def truncate_text(text, length)
-        return text if text.length <= length
-        text[0, length - 3] + "..."
-      end
-    end
-  end
-end