flow_chat 0.4.1 → 0.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bb9a192cee58e0f9f9fd857e0783d098a21922b83185d6978a8d45f225045f4b
-  data.tar.gz: 2901ac304c89aa5f4e4a40a6c9f64a9c4b9fa26b2841d1e5bce34694d6b61cff
+  metadata.gz: 004e0d3a8a9c9da83dfd6386b6e7684b7fea2b69daab7645e28d9a4767e80819
+  data.tar.gz: 85cf51f944ebb00aa7498106f88d60bfbdf060dcfe62762e3ab5a83784cff9f7
 SHA512:
-  metadata.gz: e540ad0ca5341dc7b3e50b3276e81e37f87513e17dfcc7f8104a8346f758c8bf8962672d92b027d96292a31e9bdf2b721bf3a51392250101475bd73980456280
-  data.tar.gz: 3995faacc87bfb01e26a38530eedab34ba67fdf1252f7dda0119c56a735b17c551094f88c85ed2a5a53661a0e983fe3467f13dfb1714bde91ec70e8b05f31ab1
+  metadata.gz: c5a716d3345118c334899299367e1b7ef082e54651d75d7d92a24f01f03ea36a1e55df916aa14b6ddd0e75b353a0a37be08b0ce2681082df4f0d9768dc10a525
+  data.tar.gz: d533c33058573554f5c340460999c6d3b08332800ef33b521a0111ca44e8b4d10d4aa559e5d4f23f6575cffc86e8fa10d0e0850cefec5e18f075397ccb3d449d

data/examples/initializer.rb

@@ -28,4 +28,4 @@ FlowChat::Config.ussd.pagination_next_text = "More"
 
 # Configure resumable sessions (optional)
 FlowChat::Config.ussd.resumable_sessions_enabled = true
-FlowChat::Config.ussd.resumable_sessions_timeout_seconds = 300 # 5 minutes 
+FlowChat::Config.ussd.resumable_sessions_timeout_seconds = 300 # 5 minutes

data/examples/media_prompts_examples.rb

@@ -9,7 +9,7 @@ class MediaPromptFlow < FlowChat::Flow
   def main_page
     # ✅ Simple text input with attached image
     # The prompt text becomes the image caption
-    feedback = app.screen(:feedback) do |prompt|
+    app.screen(:feedback) do |prompt|
       prompt.ask "What do you think of our new product?",
         media: {
           type: :image,
@@ -25,4 +25,3 @@ class MediaPromptFlow < FlowChat::Flow
       }
   end
 end
-

data/examples/multi_tenant_whatsapp_controller.rb

@@ -7,10 +7,10 @@ class MultiTenantWhatsappController < ApplicationController
   def webhook
     # Determine tenant from subdomain, path, or other logic
     tenant = determine_tenant(request)
-    
+
     # Get tenant-specific WhatsApp configuration
     whatsapp_config = get_whatsapp_config_for_tenant(tenant)
-    
+
     processor = FlowChat::Whatsapp::Processor.new(self) do |config|
       config.use_gateway FlowChat::Whatsapp::Gateway::CloudApi, whatsapp_config
       config.use_session_store FlowChat::Session::CacheSessionStore
@@ -26,41 +26,41 @@ class MultiTenantWhatsappController < ApplicationController
   def determine_tenant(request)
     # Option 1: From subdomain
     return request.subdomain if request.subdomain.present?
-    
+
     # Option 2: From path
     tenant_from_path = request.path.match(%r{^/whatsapp/(\w+)/})&.captures&.first
     return tenant_from_path if tenant_from_path
-    
+
     # Option 3: From custom header
-    return request.headers['X-Tenant-ID'] if request.headers['X-Tenant-ID']
-    
+    return request.headers["X-Tenant-ID"] if request.headers["X-Tenant-ID"]
+
     # Fallback to default
-    'default'
+    "default"
   end
 
   def get_whatsapp_config_for_tenant(tenant)
     case tenant
-    when 'acme_corp'
+    when "acme_corp"
       FlowChat::Whatsapp::Configuration.new.tap do |config|
-        config.access_token = ENV['ACME_WHATSAPP_ACCESS_TOKEN']
-        config.phone_number_id = ENV['ACME_WHATSAPP_PHONE_NUMBER_ID']
-        config.verify_token = ENV['ACME_WHATSAPP_VERIFY_TOKEN']
-        config.app_id = ENV['ACME_WHATSAPP_APP_ID']
-        config.app_secret = ENV['ACME_WHATSAPP_APP_SECRET']
-        config.business_account_id = ENV['ACME_WHATSAPP_BUSINESS_ACCOUNT_ID']
+        config.access_token = ENV["ACME_WHATSAPP_ACCESS_TOKEN"]
+        config.phone_number_id = ENV["ACME_WHATSAPP_PHONE_NUMBER_ID"]
+        config.verify_token = ENV["ACME_WHATSAPP_VERIFY_TOKEN"]
+        config.app_id = ENV["ACME_WHATSAPP_APP_ID"]
+        config.app_secret = ENV["ACME_WHATSAPP_APP_SECRET"]
+        config.business_account_id = ENV["ACME_WHATSAPP_BUSINESS_ACCOUNT_ID"]
       end
-    
-    when 'tech_startup'
+
+    when "tech_startup"
       FlowChat::Whatsapp::Configuration.new.tap do |config|
-        config.access_token = ENV['TECHSTARTUP_WHATSAPP_ACCESS_TOKEN']
-        config.phone_number_id = ENV['TECHSTARTUP_WHATSAPP_PHONE_NUMBER_ID']
-        config.verify_token = ENV['TECHSTARTUP_WHATSAPP_VERIFY_TOKEN']
-        config.app_id = ENV['TECHSTARTUP_WHATSAPP_APP_ID']
-        config.app_secret = ENV['TECHSTARTUP_WHATSAPP_APP_SECRET']
-        config.business_account_id = ENV['TECHSTARTUP_WHATSAPP_BUSINESS_ACCOUNT_ID']
+        config.access_token = ENV["TECHSTARTUP_WHATSAPP_ACCESS_TOKEN"]
+        config.phone_number_id = ENV["TECHSTARTUP_WHATSAPP_PHONE_NUMBER_ID"]
+        config.verify_token = ENV["TECHSTARTUP_WHATSAPP_VERIFY_TOKEN"]
+        config.app_id = ENV["TECHSTARTUP_WHATSAPP_APP_ID"]
+        config.app_secret = ENV["TECHSTARTUP_WHATSAPP_APP_SECRET"]
+        config.business_account_id = ENV["TECHSTARTUP_WHATSAPP_BUSINESS_ACCOUNT_ID"]
       end
-      
-    when 'retail_store'
+
+    when "retail_store"
       # Load from database
       tenant_config = WhatsappConfiguration.find_by(tenant: tenant)
       FlowChat::Whatsapp::Configuration.new.tap do |config|
@@ -71,7 +71,7 @@ class MultiTenantWhatsappController < ApplicationController
         config.app_secret = tenant_config.app_secret
         config.business_account_id = tenant_config.business_account_id
       end
-      
+
     else
       # Use default/global configuration
       FlowChat::Whatsapp::Configuration.from_credentials
@@ -80,11 +80,11 @@ class MultiTenantWhatsappController < ApplicationController
 
   def get_flow_for_tenant(tenant)
     case tenant
-    when 'acme_corp'
+    when "acme_corp"
       AcmeCorpFlow
-    when 'tech_startup'
+    when "tech_startup"
       TechStartupFlow
-    when 'retail_store'
+    when "retail_store"
       RetailStoreFlow
     else
       WelcomeFlow  # Default flow
@@ -99,7 +99,7 @@ class DatabaseWhatsappController < ApplicationController
   def webhook
     # Get account from business phone number or other identifier
     business_account = find_business_account(params)
-    
+
     if business_account.nil?
       return head :not_found
     end
@@ -129,7 +129,7 @@ class DatabaseWhatsappController < ApplicationController
     # 1. Phone number ID from webhook
     # 2. Business account ID from webhook
     # 3. Custom routing parameter
-    
+
     # Example: Find by phone number ID in webhook
     phone_number_id = extract_phone_number_id_from_webhook(params)
     BusinessAccount.find_by(whatsapp_phone_number_id: phone_number_id)
@@ -149,11 +149,11 @@ class EnvironmentWhatsappController < ApplicationController
   def webhook
     # Different configurations for different environments
     whatsapp_config = case Rails.env
-    when 'production'
+    when "production"
       production_whatsapp_config
-    when 'staging'
+    when "staging"
       staging_whatsapp_config
-    when 'development'
+    when "development"
       development_whatsapp_config
     else
       FlowChat::Whatsapp::Configuration.from_credentials
@@ -171,34 +171,34 @@ class EnvironmentWhatsappController < ApplicationController
 
   def production_whatsapp_config
     FlowChat::Whatsapp::Configuration.new.tap do |config|
-      config.access_token = ENV['PROD_WHATSAPP_ACCESS_TOKEN']
-      config.phone_number_id = ENV['PROD_WHATSAPP_PHONE_NUMBER_ID']
-      config.verify_token = ENV['PROD_WHATSAPP_VERIFY_TOKEN']
-      config.app_id = ENV['PROD_WHATSAPP_APP_ID']
-      config.app_secret = ENV['PROD_WHATSAPP_APP_SECRET']
-      config.business_account_id = ENV['PROD_WHATSAPP_BUSINESS_ACCOUNT_ID']
+      config.access_token = ENV["PROD_WHATSAPP_ACCESS_TOKEN"]
+      config.phone_number_id = ENV["PROD_WHATSAPP_PHONE_NUMBER_ID"]
+      config.verify_token = ENV["PROD_WHATSAPP_VERIFY_TOKEN"]
+      config.app_id = ENV["PROD_WHATSAPP_APP_ID"]
+      config.app_secret = ENV["PROD_WHATSAPP_APP_SECRET"]
+      config.business_account_id = ENV["PROD_WHATSAPP_BUSINESS_ACCOUNT_ID"]
     end
   end
 
   def staging_whatsapp_config
     FlowChat::Whatsapp::Configuration.new.tap do |config|
-      config.access_token = ENV['STAGING_WHATSAPP_ACCESS_TOKEN']
-      config.phone_number_id = ENV['STAGING_WHATSAPP_PHONE_NUMBER_ID']
-      config.verify_token = ENV['STAGING_WHATSAPP_VERIFY_TOKEN']
-      config.app_id = ENV['STAGING_WHATSAPP_APP_ID']
-      config.app_secret = ENV['STAGING_WHATSAPP_APP_SECRET']
-      config.business_account_id = ENV['STAGING_WHATSAPP_BUSINESS_ACCOUNT_ID']
+      config.access_token = ENV["STAGING_WHATSAPP_ACCESS_TOKEN"]
+      config.phone_number_id = ENV["STAGING_WHATSAPP_PHONE_NUMBER_ID"]
+      config.verify_token = ENV["STAGING_WHATSAPP_VERIFY_TOKEN"]
+      config.app_id = ENV["STAGING_WHATSAPP_APP_ID"]
+      config.app_secret = ENV["STAGING_WHATSAPP_APP_SECRET"]
+      config.business_account_id = ENV["STAGING_WHATSAPP_BUSINESS_ACCOUNT_ID"]
     end
   end
 
   def development_whatsapp_config
     FlowChat::Whatsapp::Configuration.new.tap do |config|
-      config.access_token = ENV['DEV_WHATSAPP_ACCESS_TOKEN']
-      config.phone_number_id = ENV['DEV_WHATSAPP_PHONE_NUMBER_ID']
-      config.verify_token = ENV['DEV_WHATSAPP_VERIFY_TOKEN']
-      config.app_id = ENV['DEV_WHATSAPP_APP_ID']
-      config.app_secret = ENV['DEV_WHATSAPP_APP_SECRET']
-      config.business_account_id = ENV['DEV_WHATSAPP_BUSINESS_ACCOUNT_ID']
+      config.access_token = ENV["DEV_WHATSAPP_ACCESS_TOKEN"]
+      config.phone_number_id = ENV["DEV_WHATSAPP_PHONE_NUMBER_ID"]
+      config.verify_token = ENV["DEV_WHATSAPP_VERIFY_TOKEN"]
+      config.app_id = ENV["DEV_WHATSAPP_APP_ID"]
+      config.app_secret = ENV["DEV_WHATSAPP_APP_SECRET"]
+      config.business_account_id = ENV["DEV_WHATSAPP_BUSINESS_ACCOUNT_ID"]
     end
   end
 end
@@ -232,13 +232,13 @@ end
 #   constraints subdomain: /\w+/ do
 #     post '/whatsapp/webhook', to: 'multi_tenant_whatsapp#webhook'
 #   end
-#   
-#   # Path-based routing  
+#
+#   # Path-based routing
 #   post '/whatsapp/:tenant/webhook', to: 'multi_tenant_whatsapp#webhook'
-#   
+#
 #   # Environment-specific
 #   post '/whatsapp/env/webhook', to: 'environment_whatsapp#webhook'
-#   
+#
 #   # Custom endpoint
 #   post '/whatsapp/custom/webhook', to: 'custom_whatsapp#webhook'
-# end 
+# end

data/examples/ussd_controller.rb

@@ -9,7 +9,7 @@ class UssdController < ApplicationController
       config.use_gateway FlowChat::Ussd::Gateway::Nalo
       # Use Rails session for USSD (shorter sessions)
       config.use_session_store FlowChat::Session::RailsSessionStore
-      
+
       # Enable resumable sessions (optional)
       config.use_resumable_sessions
     end
@@ -33,7 +33,7 @@ class WelcomeFlow < FlowChat::Flow
     choice = app.screen(:main_menu) do |prompt|
       prompt.select "Hi #{name}! Choose an option:", {
         "1" => "Account Info",
-        "2" => "Make Payment", 
+        "2" => "Make Payment",
         "3" => "Get Balance",
         "4" => "Customer Support"
       }
@@ -118,7 +118,7 @@ class WelcomeFlow < FlowChat::Flow
     support_choice = app.screen(:support_menu) do |prompt|
       prompt.select "Customer Support:", {
         "1" => "Report an Issue",
-        "2" => "Account Questions", 
+        "2" => "Account Questions",
         "3" => "Technical Support",
         "4" => "Speak to Agent",
         "0" => "Main Menu"
@@ -159,12 +159,12 @@ 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!"
   end
 
   # Helper methods (implement your business logic)
-  
+
   def process_payment(amount, recipient)
     # Your payment processing logic here
     # Return transaction ID
@@ -175,7 +175,7 @@ class WelcomeFlow < FlowChat::Flow
     # Your balance checking logic here
     {
       available: "150.75",
-      pending: "25.00", 
+      pending: "25.00",
       total: "175.75"
     }
   end
@@ -190,6 +190,7 @@ end
 # Configuration Examples:
 
 # 1. Basic configuration with custom pagination
+# rubocop:disable Lint/DuplicateMethods
 class UssdController < ApplicationController
   skip_forgery_protection
 
@@ -207,6 +208,7 @@ class UssdController < ApplicationController
     processor.run WelcomeFlow, :main_page
   end
 end
+# rubocop:enable Lint/DuplicateMethods
 
 # 2. Configuration with custom middleware
 class LoggingMiddleware
@@ -215,18 +217,19 @@ class LoggingMiddleware
   end
 
   def call(context)
-    Rails.logger.info "USSD Request from #{context['request.msisdn']}: #{context.input}"
+    Rails.logger.info "USSD Request from #{context["request.msisdn"]}: #{context.input}"
     start_time = Time.current
-    
+
     result = @app.call(context)
-    
+
     duration = Time.current - start_time
     Rails.logger.info "USSD Response (#{duration.round(3)}s): #{result[1]}"
-    
+
     result
   end
 end
 
+# rubocop:disable Lint/DuplicateMethods
 class UssdController < ApplicationController
   skip_forgery_protection
 
@@ -241,8 +244,10 @@ class UssdController < ApplicationController
     processor.run WelcomeFlow, :main_page
   end
 end
+# rubocop:enable Lint/DuplicateMethods
 
 # 3. Configuration with cache-based sessions for longer persistence
+# rubocop:disable Lint/DuplicateMethods
 class UssdController < ApplicationController
   skip_forgery_protection
 
@@ -256,9 +261,10 @@ class UssdController < ApplicationController
     processor.run WelcomeFlow, :main_page
   end
 end
+# rubocop:enable Lint/DuplicateMethods
 
 # Add this route to your config/routes.rb:
 # post '/ussd', to: 'ussd#process_request'
 
 # For Nsano gateway, use:
-# config.use_gateway FlowChat::Ussd::Gateway::Nsano 
+# config.use_gateway FlowChat::Ussd::Gateway::Nsano

data/examples/whatsapp_controller.rb

@@ -22,12 +22,12 @@ class CustomWhatsappController < ApplicationController
   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']
+    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"]
 
     processor = FlowChat::Whatsapp::Processor.new(self) do |config|
       config.use_gateway FlowChat::Whatsapp::Gateway::CloudApi, custom_config
@@ -53,7 +53,7 @@ class WelcomeFlow < FlowChat::Flow
     choice = app.screen(:main_menu) do |prompt|
       prompt.select "Hi #{name}! What can I help you with today?", {
         "info" => "📋 Get Information",
-        "support" => "🆘 Contact Support", 
+        "support" => "🆘 Contact Support",
         "feedback" => "💬 Give Feedback"
       }
     end
@@ -94,7 +94,7 @@ class WelcomeFlow < FlowChat::Flow
     contact_method = app.screen(:contact_method) do |prompt|
       prompt.select "How would you like to contact support?", {
         "call" => "📞 Call Us",
-        "email" => "📧 Email Us", 
+        "email" => "📧 Email Us",
         "chat" => "💬 Live Chat"
       }
     end
@@ -113,7 +113,7 @@ class WelcomeFlow < FlowChat::Flow
     rating = app.screen(:rating) do |prompt|
       prompt.select "How would you rate our service?", {
         "5" => "⭐⭐⭐⭐⭐ Excellent",
-        "4" => "⭐⭐⭐⭐ Good", 
+        "4" => "⭐⭐⭐⭐ Good",
         "3" => "⭐⭐⭐ Average",
         "2" => "⭐⭐ Poor",
         "1" => "⭐ Very Poor"
@@ -137,4 +137,4 @@ class WelcomeFlow < FlowChat::Flow
 end
 
 # Add this route to your config/routes.rb:
-# post '/whatsapp/webhook', to: 'whatsapp#webhook' 
+# post '/whatsapp/webhook', to: 'whatsapp#webhook'