flow_chat 0.8.0 → 0.8.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5ebeb5cdcbacce73ec580e381554dbd2377f7896d7d06c488970051f6a8bf599
-  data.tar.gz: bc33f9f54c78264f416e00163e2ba0cf78da2e8e0961c942bb3aab1e86e783e5
+  metadata.gz: abe12ed32427797b8d7c5dc79766bae76113ec62df415e495f900e4216af5c3f
+  data.tar.gz: d344431fbde29789a0013a78dd099b253b65dc9e8af90ef2d403a5592b5bb7aa
 SHA512:
-  metadata.gz: 34006bb23ddaf1aefd8ec4876cb70d8f06d2bbb23da48663ff7a40dd630d9b01af58d9980c343c9d933fa637512375b5c7ba3b0b336ba91a314fdd9ae5fb2ba1
-  data.tar.gz: 78a242f2b175f57ce29326f342c9d4bf4c7c4402c0e2fcd634c21322280dcd0ac273d86eb19750702472218e9d08fd97267ad711b3673f108f89617e5319b9f7
+  metadata.gz: b05a61d0e7a41db5ecd2137aaa193c7431f1e16277e093af4eacbcf657696aa42a22d177407718618959b021298a3583101004534d3666a51b2607b4f621db88
+  data.tar.gz: a9aab01a2754996205c2b9c1fa8143cdf503f4033c243ed537120c975249eebc0b0cc42f310864a8923b8fd819cc625205cd32463f15e5db93ccd88c2c4ecfe1

data/lib/flow_chat/base_app.rb

@@ -0,0 +1,74 @@
+module FlowChat
+  class BaseApp
+    attr_reader :session, :input, :context, :navigation_stack
+
+    def initialize(context)
+      @context = context
+      @session = context.session
+      @input = context.input
+      @navigation_stack = []
+    end
+
+    def screen(key)
+      raise ArgumentError, "a block is expected" unless block_given?
+      raise ArgumentError, "screen has already been presented" if navigation_stack.include?(key)
+
+      navigation_stack << key
+      return session.get(key) if session.get(key).present?
+
+      user_input = prepare_user_input
+      prompt = FlowChat::Prompt.new user_input
+      @input = nil # input is being submitted to prompt so we clear it
+
+      value = yield prompt
+      session.set(key, value)
+      value
+    end
+
+    def go_back
+      return false if navigation_stack.empty?
+      
+      @context.input = nil
+      current_screen = navigation_stack.last
+      session.delete(current_screen)
+      
+      # Restart the flow from the beginning
+      raise FlowChat::Interrupt::RestartFlow.new
+    end
+
+    def say(msg, media: nil)
+      raise FlowChat::Interrupt::Terminate.new(msg, media: media)
+    end
+
+    def phone_number
+      context["request.msisdn"]
+    end
+
+    def message_id
+      context["request.message_id"]
+    end
+
+    def timestamp
+      context["request.timestamp"]
+    end
+
+    def contact_name
+      nil
+    end
+
+    def location
+      nil
+    end
+
+    def media
+      nil
+    end
+
+    protected
+
+    # Platform-specific methods to be overridden
+    def prepare_user_input
+      input
+    end
+  end
+end 

data/lib/flow_chat/base_executor.rb

@@ -0,0 +1,57 @@
+module FlowChat
+  class BaseExecutor
+    def initialize(app)
+      @app = app
+      FlowChat.logger.debug { "#{log_prefix}: Initialized #{platform_name} executor middleware" }
+    end
+
+    def call(context)
+      flow_class = context.flow
+      action = context["flow.action"]
+      session_id = context["session.id"]
+
+      FlowChat.logger.info { "#{log_prefix}: Executing flow #{flow_class.name}##{action} for session #{session_id}" }
+
+      platform_app = build_platform_app(context)
+      FlowChat.logger.debug { "#{log_prefix}: #{platform_name} app built for flow execution" }
+
+      flow = flow_class.new platform_app
+      FlowChat.logger.debug { "#{log_prefix}: Flow instance created, invoking #{action} method" }
+
+      flow.send action
+      FlowChat.logger.warn { "#{log_prefix}: Flow execution failed to interact with user for #{flow_class.name}##{action}" }
+      raise FlowChat::Interrupt::Terminate, "Unexpected end of flow."
+    rescue FlowChat::Interrupt::RestartFlow => e
+      FlowChat.logger.info { "#{log_prefix}: Flow restart requested - Session: #{session_id}, restarting #{action}" }
+      retry
+    rescue FlowChat::Interrupt::Prompt => e
+      FlowChat.logger.info { "#{log_prefix}: Flow prompted user - Session: #{session_id}, Prompt: '#{e.prompt&.truncate(100)}'" }
+      FlowChat.logger.debug { "#{log_prefix}: Prompt details - Choices: #{e.choices&.size || 0}, Has media: #{!e.media.nil?}" }
+      [:prompt, e.prompt, e.choices, e.media]
+    rescue FlowChat::Interrupt::Terminate => e
+      FlowChat.logger.info { "#{log_prefix}: Flow terminated - Session: #{session_id}, Message: '#{e.prompt&.truncate(100)}'" }
+      FlowChat.logger.debug { "#{log_prefix}: Destroying session #{session_id}" }
+      context.session.destroy
+      [:terminate, e.prompt, nil, e.media]
+    rescue => error
+      FlowChat.logger.error { "#{log_prefix}: Flow execution failed - #{flow_class.name}##{action}, Session: #{session_id}, Error: #{error.class.name}: #{error.message}" }
+      FlowChat.logger.debug { "#{log_prefix}: Stack trace: #{error.backtrace.join("\n")}" }
+      raise
+    end
+
+    protected
+
+    # Subclasses must implement these methods
+    def platform_name
+      raise NotImplementedError, "Subclasses must implement platform_name"
+    end
+
+    def log_prefix
+      raise NotImplementedError, "Subclasses must implement log_prefix"
+    end
+
+    def build_platform_app(context)
+      raise NotImplementedError, "Subclasses must implement build_platform_app"
+    end
+  end
+end 

data/lib/flow_chat/instrumentation/setup.rb

@@ -22,7 +22,6 @@ module FlowChat
         def setup_logging!(options = {})
           return if @log_subscriber_setup
 
-          require_relative "log_subscriber"
           setup_log_subscriber(options)
           @log_subscriber_setup = true
         end
@@ -31,7 +30,6 @@ module FlowChat
         def setup_metrics!(options = {})
           return if @metrics_collector_setup
 
-          require_relative "metrics_collector"
           setup_metrics_collector(options)
           @metrics_collector_setup = true
         end

data/lib/flow_chat/interrupt.rb

@@ -22,5 +22,11 @@ module FlowChat
     end
 
     class Terminate < Base; end
+
+    class RestartFlow < Base
+      def initialize
+        super("restart_flow")
+      end
+    end
   end
 end

data/lib/flow_chat/ussd/app.rb

@@ -1,58 +1,6 @@
 module FlowChat
   module Ussd
-    class App
-      attr_reader :session, :input, :context, :navigation_stack
-
-      def initialize(context)
-        @context = context
-        @session = context.session
-        @input = context.input
-        @navigation_stack = []
-      end
-
-      def screen(key)
-        raise ArgumentError, "a block is expected" unless block_given?
-        raise ArgumentError, "screen has already been presented" if navigation_stack.include?(key)
-
-        navigation_stack << key
-        return session.get(key) if session.get(key).present?
-
-        prompt = FlowChat::Prompt.new input
-        @input = nil # input is being submitted to prompt so we clear it
-
-        value = yield prompt
-        session.set(key, value)
-        value
-      end
-
-      def say(msg, media: nil)
-        raise FlowChat::Interrupt::Terminate.new(msg)
-      end
-
-      # WhatsApp-specific data accessors (not supported in USSD)
-      def contact_name
-        nil
-      end
-
-      def message_id
-        context["request.message_id"]
-      end
-
-      def timestamp
-        context["request.timestamp"]
-      end
-
-      def location
-        nil
-      end
-
-      def media
-        nil
-      end
-
-      def phone_number
-        context["request.msisdn"]
-      end
+    class App < FlowChat::BaseApp
     end
   end
 end

data/lib/flow_chat/ussd/middleware/executor.rb

@@ -1,47 +1,21 @@
+require_relative "../../base_executor"
+
 module FlowChat
   module Ussd
     module Middleware
-      class Executor
-        def initialize(app)
-          @app = app
-          FlowChat.logger.debug { "Ussd::Executor: Initialized USSD executor middleware" }
-        end
-
-        def call(context)
-          flow_class = context.flow
-          action = context["flow.action"]
-          session_id = context["session.id"]
-
-          FlowChat.logger.info { "Ussd::Executor: Executing flow #{flow_class.name}##{action} for session #{session_id}" }
+      class Executor < FlowChat::BaseExecutor
+        protected
 
-          ussd_app = build_ussd_app context
-          FlowChat.logger.debug { "Ussd::Executor: USSD app built for flow execution" }
-
-          flow = flow_class.new ussd_app
-          FlowChat.logger.debug { "Ussd::Executor: Flow instance created, invoking #{action} method" }
-
-          flow.send action
-          FlowChat.logger.warn { "Ussd::Executor: Flow execution failed to interact with user for #{flow_class.name}##{action}" }
-          raise FlowChat::Interrupt::Terminate, "Unexpected end of flow."
-        rescue FlowChat::Interrupt::Prompt => e
-          FlowChat.logger.info { "Ussd::Executor: Flow prompted user - Session: #{session_id}, Prompt: '#{e.prompt.truncate(100)}'" }
-          FlowChat.logger.debug { "Ussd::Executor: Prompt details - Choices: #{e.choices&.size || 0}, Has media: #{!e.media.nil?}" }
-          [:prompt, e.prompt, e.choices, e.media]
-        rescue FlowChat::Interrupt::Terminate => e
-          FlowChat.logger.info { "Ussd::Executor: Flow terminated - Session: #{session_id}, Message: '#{e.prompt.truncate(100)}'" }
-          FlowChat.logger.debug { "Ussd::Executor: Destroying session #{session_id}" }
-          context.session.destroy
-          [:terminate, e.prompt, nil, e.media]
-        rescue => error
-          FlowChat.logger.error { "Ussd::Executor: Flow execution failed - #{flow_class.name}##{action}, Session: #{session_id}, Error: #{error.class.name}: #{error.message}" }
-          FlowChat.logger.debug { "Ussd::Executor: Stack trace: #{error.backtrace.join("\n")}" }
-          raise
+        def platform_name
+          "USSD"
         end
 
-        private
+        def log_prefix
+          "Ussd::Executor"
+        end
 
-        def build_ussd_app(context)
-          FlowChat.logger.debug { "Ussd::Executor: Building USSD app instance" }
+        def build_platform_app(context)
+          FlowChat.logger.debug { "#{log_prefix}: Building USSD app instance" }
           FlowChat::Ussd::App.new(context)
         end
       end

data/lib/flow_chat/version.rb

@@ -1,3 +1,3 @@
 module FlowChat
-  VERSION = "0.8.0"
+  VERSION = "0.8.1"
 end

data/lib/flow_chat/whatsapp/app.rb

@@ -1,53 +1,10 @@
 module FlowChat
   module Whatsapp
-    class App
-      attr_reader :session, :input, :context, :navigation_stack
-
-      def initialize(context)
-        @context = context
-        @session = context.session
-        @input = context.input
-        @navigation_stack = []
-      end
-
-      def screen(key)
-        raise ArgumentError, "a block is expected" unless block_given?
-        raise ArgumentError, "screen has already been presented" if navigation_stack.include?(key)
-
-        navigation_stack << key
-        return session.get(key) if session.get(key).present?
-
-        user_input = input
-        if session.get("$started_at$").nil?
-          session.set("$started_at$", Time.current.iso8601)
-          user_input = nil
-        end
-
-        prompt = FlowChat::Prompt.new user_input
-        @input = nil # input is being submitted to prompt so we clear it
-
-        value = yield prompt
-        session.set(key, value)
-        value
-      end
-
-      def say(msg, media: nil)
-        raise FlowChat::Interrupt::Terminate.new(msg, media: media)
-      end
-
-      # WhatsApp-specific data accessors (read-only)
+    class App < FlowChat::BaseApp
       def contact_name
         context["request.contact_name"]
       end
 
-      def message_id
-        context["request.message_id"]
-      end
-
-      def timestamp
-        context["request.timestamp"]
-      end
-
       def location
         context["request.location"]
       end
@@ -56,8 +13,16 @@ module FlowChat
         context["request.media"]
       end
 
-      def phone_number
-        context["request.msisdn"]
+      protected
+
+      # WhatsApp has special startup logic and supports media
+      def prepare_user_input
+        user_input = input
+        if session.get("$started_at$").nil?
+          session.set("$started_at$", Time.current.iso8601)
+          user_input = nil
+        end
+        user_input
       end
     end
   end

data/lib/flow_chat/whatsapp/middleware/executor.rb

@@ -1,49 +1,21 @@
+require_relative "../../base_executor"
+
 module FlowChat
   module Whatsapp
     module Middleware
-      class Executor
-        def initialize(app)
-          @app = app
-          FlowChat.logger.debug { "Whatsapp::Executor: Initialized WhatsApp executor middleware" }
-        end
-
-        def call(context)
-          flow_class = context.flow
-          action = context["flow.action"]
-          session_id = context["session.id"]
-
-          FlowChat.logger.info { "Whatsapp::Executor: Executing flow #{flow_class.name}##{action} for session #{session_id}" }
+      class Executor < FlowChat::BaseExecutor
+        protected
 
-          whatsapp_app = build_whatsapp_app context
-          FlowChat.logger.debug { "Whatsapp::Executor: WhatsApp app built for flow execution" }
-
-          flow = flow_class.new whatsapp_app
-          FlowChat.logger.debug { "Whatsapp::Executor: Flow instance created, invoking #{action} method" }
-
-          flow.send action
-          FlowChat.logger.warn { "Whatsapp::Executor: Flow execution failed to interact with user for #{flow_class.name}##{action}" }
-          raise FlowChat::Interrupt::Terminate, "Unexpected end of flow."
-        rescue FlowChat::Interrupt::Prompt => e
-          FlowChat.logger.info { "Whatsapp::Executor: Flow prompted user - Session: #{session_id}, Prompt: '#{e.prompt.truncate(100)}'" }
-          FlowChat.logger.debug { "Whatsapp::Executor: Prompt details - Choices: #{e.choices&.size || 0}, Has media: #{!e.media.nil?}" }
-          # Return the same triplet format as USSD for consistency
-          [:prompt, e.prompt, e.choices, e.media]
-        rescue FlowChat::Interrupt::Terminate => e
-          FlowChat.logger.info { "Whatsapp::Executor: Flow terminated - Session: #{session_id}, Message: '#{e.prompt.truncate(100)}'" }
-          FlowChat.logger.debug { "Whatsapp::Executor: Destroying session #{session_id}" }
-          # Clean up session and return terminal message
-          context.session.destroy
-          [:terminate, e.prompt, nil, e.media]
-        rescue => error
-          FlowChat.logger.error { "Whatsapp::Executor: Flow execution failed - #{flow_class.name}##{action}, Session: #{session_id}, Error: #{error.class.name}: #{error.message}" }
-          FlowChat.logger.debug { "Whatsapp::Executor: Stack trace: #{error.backtrace.join("\n")}" }
-          raise
+        def platform_name
+          "WhatsApp"
         end
 
-        private
+        def log_prefix
+          "Whatsapp::Executor"
+        end
 
-        def build_whatsapp_app(context)
-          FlowChat.logger.debug { "Whatsapp::Executor: Building WhatsApp app instance" }
+        def build_platform_app(context)
+          FlowChat.logger.debug { "#{log_prefix}: Building WhatsApp app instance" }
           FlowChat::Whatsapp::App.new(context)
         end
       end

data/lib/flow_chat.rb

@@ -15,7 +15,6 @@ module FlowChat
   end
 
   def self.setup_instrumentation!
-    require_relative "flow_chat/instrumentation/setup"
     FlowChat::Instrumentation::Setup.setup_instrumentation!
   end
 
@@ -27,13 +26,4 @@ module FlowChat
   def self.metrics
     FlowChat::Instrumentation::Setup.metrics_collector
   end
-end
-
-loader.eager_load
-
-# Auto-setup instrumentation in Rails environments
-if defined?(Rails)
-  Rails.application.config.after_initialize do
-    FlowChat.setup_instrumentation!
-  end
-end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: flow_chat
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.8.1
 platform: ruby
 authors:
 - Stefan Froelich
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-06-09 00:00:00.000000000 Z
+date: 2025-06-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: zeitwerk
@@ -119,6 +119,8 @@ files:
 - examples/whatsapp_message_job.rb
 - flow_chat.gemspec
 - lib/flow_chat.rb
+- lib/flow_chat/base_app.rb
+- lib/flow_chat/base_executor.rb
 - lib/flow_chat/base_processor.rb
 - lib/flow_chat/config.rb
 - lib/flow_chat/context.rb