flow_chat 0.6.1 → 0.7.0

data/examples/ussd_controller.rb

@@ -25,17 +25,17 @@ class WelcomeFlow < FlowChat::Flow
   def main_page
     # Welcome the user
     name = app.screen(:name) do |prompt|
-      prompt.ask "Welcome to our service! What's your name?",
+      prompt.ask "Welcome! What's your name?",
         transform: ->(input) { input.strip.titleize }
     end
 
     # Show main menu with numbered options (USSD style)
     choice = app.screen(:main_menu) do |prompt|
-      prompt.select "Hi #{name}! Choose an option:", {
+      prompt.select "Hi #{name}! Choose:", {
         "1" => "Account Info",
         "2" => "Make Payment",
         "3" => "Get Balance",
-        "4" => "Customer Support"
+        "4" => "Support"
       }
     end
 
@@ -55,54 +55,55 @@ class WelcomeFlow < FlowChat::Flow
 
   def show_account_info
     info_choice = app.screen(:account_info) do |prompt|
-      prompt.select "Account Information:", {
+      prompt.select "Account Info:", {
         "1" => "Personal Details",
-        "2" => "Account Balance",
+        "2" => "Balance",
         "3" => "Transaction History",
-        "0" => "Back to Main Menu"
+        "0" => "Main Menu"
       }
     end
 
     case info_choice
     when "1"
-      app.say "Name: John Doe\\nPhone: #{app.phone_number}\\nAccount: Active"
+      app.say "Name: John Doe\nPhone: #{app.phone_number}\nStatus: Active"
     when "2"
-      app.say "Current Balance: $150.75\\nAvailable Credit: $1,000.00"
+      app.say "Balance: $150.75\nCredit: $1,000.00"
     when "3"
-      app.say "Last 3 Transactions:\\n1. +$50.00 - Deposit\\n2. -$25.50 - Purchase\\n3. -$15.00 - Transfer"
+      app.say "Recent:\n+$50.00 Deposit\n-$25.50 Purchase\n-$15.00 Transfer"
     when "0"
-      main_page  # Go back to main menu
+      main_page
     end
   end
 
   def make_payment
     amount = app.screen(:payment_amount) do |prompt|
-      prompt.ask "Enter amount to pay:",
-        convert: ->(input) { input.to_f },
-        validate: ->(amount) {
-          return "Amount must be greater than 0" unless amount > 0
-          return "Maximum payment is $500" unless amount <= 500
+      prompt.ask "Enter amount:",
+        validate: ->(input) {
+          amt = input.to_f
+          return "Invalid amount" unless amt > 0
+          return "Max $500" unless amt <= 500
           nil
-        }
+        },
+        transform: ->(input) { input.to_f }
     end
 
     recipient = app.screen(:payment_recipient) do |prompt|
-      prompt.ask "Enter recipient phone number:",
+      prompt.ask "Recipient phone:",
         validate: ->(input) {
-          return "Phone number must be 10 digits" unless input.match?(/\\A\\d{10}\\z/)
+          return "10 digits required" unless input.match?(/\A\d{10}\z/)
           nil
         }
     end
 
     # Confirmation screen
     confirmed = app.screen(:payment_confirmation) do |prompt|
-      prompt.yes? "Pay $#{amount} to #{recipient}?\\nConfirm payment?"
+      prompt.yes? "Pay $#{amount} to #{recipient}?"
     end
 
     if confirmed
       # Process payment (your business logic here)
       transaction_id = process_payment(amount, recipient)
-      app.say "Payment successful!\\nTransaction ID: #{transaction_id}\\nAmount: $#{amount}\\nTo: #{recipient}"
+      app.say "Payment successful!\nID: #{transaction_id}\nAmount: $#{amount}"
     else
       app.say "Payment cancelled"
     end
@@ -111,16 +112,14 @@ class WelcomeFlow < FlowChat::Flow
   def get_balance
     # Simulate balance check
     balance = check_account_balance(app.phone_number)
-    app.say "Account Balance\\n\\nAvailable: $#{balance[:available]}\\nPending: $#{balance[:pending]}\\nTotal: $#{balance[:total]}"
+    app.say "Balance\n\nAvailable: $#{balance[:available]}\nPending: $#{balance[:pending]}"
   end
 
   def customer_support
     support_choice = app.screen(:support_menu) do |prompt|
-      prompt.select "Customer Support:", {
-        "1" => "Report an Issue",
-        "2" => "Account Questions",
-        "3" => "Technical Support",
-        "4" => "Speak to Agent",
+      prompt.select "Support:", {
+        "1" => "Report Issue",
+        "2" => "Contact Info",
         "0" => "Main Menu"
       }
     end
@@ -129,11 +128,7 @@ class WelcomeFlow < FlowChat::Flow
     when "1"
       report_issue
     when "2"
-      app.say "For account questions:\\nCall: 123-456-7890\\nEmail: support@company.com\\nHours: 9AM-5PM Mon-Fri"
-    when "3"
-      app.say "Technical Support:\\nCall: 123-456-7891\\nEmail: tech@company.com\\n24/7 Support Available"
-    when "4"
-      app.say "Connecting you to an agent...\\nPlease call 123-456-7890\\nOr visit our nearest branch"
+      app.say "Support:\nCall: 123-456-7890\nEmail: support@company.com\nHours: 9AM-5PM"
     when "0"
       main_page
     end
@@ -141,7 +136,7 @@ class WelcomeFlow < FlowChat::Flow
 
   def report_issue
     issue_type = app.screen(:issue_type) do |prompt|
-      prompt.select "Select issue type:", {
+      prompt.select "Issue type:", {
         "1" => "Payment Problem",
         "2" => "Account Access",
         "3" => "Service Error",
@@ -150,9 +145,9 @@ class WelcomeFlow < FlowChat::Flow
     end
 
     description = app.screen(:issue_description) do |prompt|
-      prompt.ask "Briefly describe the issue:",
+      prompt.ask "Describe issue:",
         validate: ->(input) {
-          return "Description must be at least 10 characters" unless input.length >= 10
+          return "Min 10 characters" if input.length < 10
           nil
         }
     end
@@ -160,7 +155,7 @@ class WelcomeFlow < FlowChat::Flow
     # Save the issue (your business logic here)
     ticket_id = create_support_ticket(issue_type, description, app.phone_number)
 
-    app.say "Issue reported successfully!\\n\\nTicket ID: #{ticket_id}\\nWe'll contact you within 24 hours.\\n\\nThank you!"
+    app.say "Issue reported!\n\nTicket: #{ticket_id}\nWe'll contact you within 24hrs"
   end
 
   # Helper methods (implement your business logic)
@@ -175,14 +170,13 @@ class WelcomeFlow < FlowChat::Flow
     # Your balance checking logic here
     {
       available: "150.75",
-      pending: "25.00",
-      total: "175.75"
+      pending: "25.00"
     }
   end
 
   def create_support_ticket(issue_type, description, phone_number)
     # Your ticket creation logic here
-    Rails.logger.info "Support ticket created: #{issue_type} - #{description} from #{phone_number}"
+    Rails.logger.info "Ticket: #{issue_type} - #{description} from #{phone_number}"
     "TICKET#{rand(10000..99999)}"
   end
 end

data/examples/whatsapp_controller.rb

@@ -1,82 +1,38 @@
 # Example WhatsApp Controller
 # Add this to your Rails application as app/controllers/whatsapp_controller.rb
 
+# Basic WhatsApp controller using Rails credentials
 class WhatsappController < ApplicationController
   skip_forgery_protection
 
   def webhook
-    # Enable simulator mode for local endpoint testing in development
     processor = FlowChat::Whatsapp::Processor.new(self, enable_simulator: Rails.env.development?) do |config|
       config.use_gateway FlowChat::Whatsapp::Gateway::CloudApi
-      # Use cache-based session store for longer WhatsApp conversations
       config.use_session_store FlowChat::Session::CacheSessionStore
     end
 
     processor.run WelcomeFlow, :main_page
-  rescue FlowChat::Whatsapp::ConfigurationError => e
-    Rails.logger.error "WhatsApp configuration error: #{e.message}"
-    head :internal_server_error
   rescue => e
-    Rails.logger.error "Unexpected error processing WhatsApp webhook: #{e.message}"
+    Rails.logger.error "Error processing WhatsApp webhook: #{e.message}"
     head :internal_server_error
   end
 end
 
-# Example with Custom Configuration and Security
+# Controller with custom configuration
 class CustomWhatsappController < ApplicationController
   skip_forgery_protection
 
   def webhook
-    # Create custom WhatsApp configuration for this endpoint
-    custom_config = FlowChat::Whatsapp::Configuration.new
-    custom_config.access_token = ENV["MY_WHATSAPP_ACCESS_TOKEN"]
-    custom_config.phone_number_id = ENV["MY_WHATSAPP_PHONE_NUMBER_ID"]
-    custom_config.verify_token = ENV["MY_WHATSAPP_VERIFY_TOKEN"]
-    custom_config.app_id = ENV["MY_WHATSAPP_APP_ID"]
-    custom_config.app_secret = ENV["MY_WHATSAPP_APP_SECRET"]
-    custom_config.business_account_id = ENV["MY_WHATSAPP_BUSINESS_ACCOUNT_ID"]
-    
-    # Security configuration
-    custom_config.skip_signature_validation = !Rails.env.production? # Only skip in non-production
-
-    # Enable simulator for local endpoint testing in non-production environments  
-    processor = FlowChat::Whatsapp::Processor.new(self, enable_simulator: !Rails.env.production?) do |config|
-      config.use_gateway FlowChat::Whatsapp::Gateway::CloudApi, custom_config
-      config.use_session_store FlowChat::Session::CacheSessionStore
-    end
-
-    processor.run WelcomeFlow, :main_page
-  rescue FlowChat::Whatsapp::ConfigurationError => e
-    Rails.logger.error "WhatsApp configuration error: #{e.message}"
-    head :internal_server_error
-  rescue => e
-    Rails.logger.error "Unexpected error processing WhatsApp webhook: #{e.message}"
-    head :internal_server_error
-  end
-end
-
-# Example with Environment-Specific Security
-class EnvironmentAwareWhatsappController < ApplicationController
-  skip_forgery_protection
-
-  def webhook
-    # Configure security based on environment
     custom_config = build_whatsapp_config
-    
-    # Enable simulator for local endpoint testing in development/staging
-    enable_simulator = Rails.env.development? || Rails.env.staging?
 
-    processor = FlowChat::Whatsapp::Processor.new(self, enable_simulator: enable_simulator) do |config|
+    processor = FlowChat::Whatsapp::Processor.new(self, enable_simulator: !Rails.env.production?) do |config|
       config.use_gateway FlowChat::Whatsapp::Gateway::CloudApi, custom_config
       config.use_session_store FlowChat::Session::CacheSessionStore
     end
 
     processor.run WelcomeFlow, :main_page
-  rescue FlowChat::Whatsapp::ConfigurationError => e
-    Rails.logger.error "WhatsApp configuration error: #{e.message}"
-    head :internal_server_error
   rescue => e
-    Rails.logger.error "Unexpected error processing WhatsApp webhook: #{e.message}"
+    Rails.logger.error "Error processing WhatsApp webhook: #{e.message}"
     head :internal_server_error
   end
 
@@ -84,63 +40,41 @@ class EnvironmentAwareWhatsappController < ApplicationController
 
   def build_whatsapp_config
     config = FlowChat::Whatsapp::Configuration.new
-    
+
     case Rails.env
-    when 'development'
-      # Development: More relaxed security for easier testing
+    when "development", "test"
       config.access_token = ENV["WHATSAPP_ACCESS_TOKEN"]
       config.phone_number_id = ENV["WHATSAPP_PHONE_NUMBER_ID"]
       config.verify_token = ENV["WHATSAPP_VERIFY_TOKEN"]
-      config.app_id = ENV["WHATSAPP_APP_ID"]
-      config.app_secret = ENV["WHATSAPP_APP_SECRET"]  # Optional in development
-      config.business_account_id = ENV["WHATSAPP_BUSINESS_ACCOUNT_ID"]
-      config.skip_signature_validation = true  # Skip validation for easier development
-      
-    when 'test'
-      # Test: Use test credentials
-      config.access_token = "test_token"
-      config.phone_number_id = "test_phone_id"
-      config.verify_token = "test_verify_token"
-      config.app_id = "test_app_id"
-      config.app_secret = "test_app_secret"
-      config.business_account_id = "test_business_id"
-      config.skip_signature_validation = true  # Skip validation in tests
-      
-    when 'staging', 'production'
-      # Production: Full security enabled
+      config.app_secret = ENV["WHATSAPP_APP_SECRET"]
+      config.skip_signature_validation = true  # Skip for easier development
+
+    when "staging", "production"
       config.access_token = ENV["WHATSAPP_ACCESS_TOKEN"]
       config.phone_number_id = ENV["WHATSAPP_PHONE_NUMBER_ID"]
       config.verify_token = ENV["WHATSAPP_VERIFY_TOKEN"]
-      config.app_id = ENV["WHATSAPP_APP_ID"]
-      config.app_secret = ENV["WHATSAPP_APP_SECRET"]  # Required for security
-      config.business_account_id = ENV["WHATSAPP_BUSINESS_ACCOUNT_ID"]
+      config.app_secret = ENV["WHATSAPP_APP_SECRET"]
       config.skip_signature_validation = false  # Always validate in production
-      
-      # Ensure required security configuration is present
+
       if config.app_secret.blank?
-        raise FlowChat::Whatsapp::ConfigurationError, 
-          "WHATSAPP_APP_SECRET is required for webhook signature validation in #{Rails.env}"
+        raise "WHATSAPP_APP_SECRET required for signature validation in #{Rails.env}"
       end
     end
-    
+
     config
   end
 end
 
-# Example Flow for WhatsApp
-# Add this to your Rails application as app/flow_chat/welcome_flow.rb
-
+# Example flow for WhatsApp
 class WelcomeFlow < FlowChat::Flow
   def main_page
-    # Welcome the user
     name = app.screen(:name) do |prompt|
-      prompt.ask "Hello! Welcome to our WhatsApp service. What's your name?",
+      prompt.ask "Hello! What's your name?",
         transform: ->(input) { input.strip.titleize }
     end
 
-    # Show main menu
     choice = app.screen(:main_menu) do |prompt|
-      prompt.select "Hi #{name}! What can I help you with today?", {
+      prompt.select "Hi #{name}! How can I help?", {
         "info" => "📋 Get Information",
         "support" => "🆘 Contact Support",
         "feedback" => "💬 Give Feedback"
@@ -149,7 +83,7 @@ class WelcomeFlow < FlowChat::Flow
 
     case choice
     when "info"
-      show_information_menu
+      show_info
     when "support"
       contact_support
     when "feedback"
@@ -159,69 +93,42 @@ class WelcomeFlow < FlowChat::Flow
 
   private
 
-  def show_information_menu
-    info_choice = app.screen(:info_menu) do |prompt|
-      prompt.select "What information do you need?", {
-        "hours" => "🕒 Business Hours",
-        "location" => "📍 Our Location",
-        "services" => "🛠 Our Services"
-      }
-    end
-
-    case info_choice
-    when "hours"
-      app.say "We're open Monday-Friday 9AM-6PM, Saturday 9AM-2PM. Closed Sundays."
-    when "location"
-      app.say "📍 We're located at 123 Main Street, City, State 12345"
-    when "services"
-      app.say "Here are our main services:\\n\\n🌐 Web Development - Custom websites and applications\\n📱 Mobile Apps - iOS and Android development\\n🔧 Consulting - Technical consulting services"
-    end
+  def show_info
+    app.say "📍 Located at 123 Main Street\n🕒 Hours: Mon-Fri 9AM-6PM\n📞 Call: (555) 123-4567"
   end
 
   def contact_support
-    # Use standard select menu instead of send_buttons
-    contact_method = app.screen(:contact_method) do |prompt|
-      prompt.select "How would you like to contact support?", {
+    method = app.screen(:contact_method) do |prompt|
+      prompt.select "How would you like to contact us?", {
         "call" => "📞 Call Us",
-        "email" => "📧 Email Us",
-        "chat" => "💬 Live Chat"
+        "email" => "📧 Email Us"
       }
     end
 
-    case contact_method
+    case method
     when "call"
-      app.say "📞 You can call us at (555) 123-4567"
+      app.say "📞 Call us at (555) 123-4567"
     when "email"
-      app.say "📧 Send us an email at support@example.com"
-    when "chat"
-      app.say "💬 Our live chat is available on our website: www.example.com"
+      app.say "📧 Email us at support@example.com"
     end
   end
 
   def collect_feedback
     rating = app.screen(:rating) do |prompt|
-      prompt.select "How would you rate our service?", {
-        "5" => "⭐⭐⭐⭐⭐ Excellent",
-        "4" => "⭐⭐⭐⭐ Good",
-        "3" => "⭐⭐⭐ Average",
-        "2" => "⭐⭐ Poor",
-        "1" => "⭐ Very Poor"
-      }
+      prompt.select "Rate our service:", ["⭐", "⭐⭐", "⭐⭐⭐", "⭐⭐⭐⭐", "⭐⭐⭐⭐⭐"]
     end
 
     feedback = app.screen(:feedback_text) do |prompt|
-      prompt.ask "Thank you for the #{rating}-star rating! Please share any additional feedback:"
+      prompt.ask "Any additional comments?"
     end
 
-    # Save feedback (implement your logic here)
     save_feedback(app.phone_number, rating, feedback)
-
-    app.say "Thank you for your feedback! We really appreciate it. 🙏"
+    app.say "Thank you for your feedback! 🙏"
   end
 
   def save_feedback(phone, rating, feedback)
-    # Implement your feedback saving logic here
-    Rails.logger.info "Feedback from #{phone}: #{rating} stars - #{feedback}"
+    Rails.logger.info "Feedback from #{phone}: #{rating} - #{feedback}"
+    # Add your feedback saving logic here
   end
 end