flow_chat 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 77864972a34ad8761c6ce77a4f3574b9f45b4f8ef3210c34ca376812d0b54a41
-  data.tar.gz: 47b860cf8170d1cda13fa280ba92ba731c3060ca7d955b727b22ce8367ee8e97
+  metadata.gz: 6eba909e6ae38dfeb26be6f854b185ca2c8097397aa4eea8a094d47e1d3fcd56
+  data.tar.gz: c47e6bf434684b87c7f0c8b2ebb9b6536c5bc17efe46fa3bec3876b976401f96
 SHA512:
-  metadata.gz: fd997d03b94ce1051ab2ad6483b5864fb2b223b510d96d45833c7908a6928b419fdc4c5512730c80bf86e5f1b9741f2fc3d7c377a1f4ba8ea2b7baa0ed2244bf
-  data.tar.gz: c39477b7915c3abe9f2b1ff5c31b99eb3a618ecd2ab53e5405fb34e8564822510ad16dd94a2ceb664e33ada5549910c096b38e1a925e8609a3f73c855b392d3d
+  metadata.gz: f52ba0115aa8000f9de120d436c9800318c8635efa86979b17f2dc01104d6ae65f66dcc193ada68a0a36ff238e9b6a87ef9ee66e00581ca4b5faa72a31fb25a0
+  data.tar.gz: 508138465e83f318e8e889f4e11ea19a709fc06c310b76c44388f56b84c94521fa44b45cc734fcfc07acf3b1cf38bbc764614e1d7252ee7b40ab4e0a20c55877

data/flow_chat.gemspec

@@ -6,9 +6,9 @@ Gem::Specification.new do |spec|
   spec.authors = ["Stefan Froelich"]
   spec.email = ["sfroelich01@gmail.com"]
 
-  spec.summary = "Enable USSD processing support in Rails."
-  spec.description = "Enable USSD processing support in Rails."
-  spec.homepage = "https://github.com/ussd-engine/api-base"
+  spec.summary = "Framework for processing Menu based conversations e.g. USSD in Rails."
+  spec.description = "Framework for processing Menu based conversations e.g. USSD in Rails."
+  spec.homepage = "https://github.com/radioactive-labs/flow_chat"
   spec.license = "MIT"
   spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
 

data/lib/flow_chat/context.rb

@@ -12,6 +12,8 @@ module FlowChat
       @data[key] = value
     end
 
+    def input = @data["request.input"]
+
     def session = @data["session"]
 
     def controller = @data["controller"]

data/lib/flow_chat/session/rails_session_store.rb

@@ -7,8 +7,8 @@ module FlowChat
         @session_data = (session_store[session_id] || {}).with_indifferent_access
       end
 
-      def get(key, default = nil)
-        session_data[key] || default
+      def get(key)
+        session_data[key]
       end
 
       def set(key, value)

data/lib/flow_chat/ussd/app.rb

@@ -5,8 +5,8 @@ module FlowChat
 
       def initialize(context)
         @context = context
-        @session = context["session"]
-        @input = context["request.input"]
+        @session = context.session
+        @input = context.input
         @navigation_stack = []
       end
 

data/lib/flow_chat/ussd/gateway/nalo.rb

@@ -18,26 +18,20 @@ module FlowChat
           # context["request.type"] = params["MSGTYPE"] ? :initial : :response
           context["request.input"] = params["USERDATA"].presence
 
-          type, msg, choices = @app.call(context)
+          type, prompt, choices = @app.call(context)
 
           context.controller.render json: {
             USERID: params["USERID"],
             MSISDN: params["MSISDN"],
-            MSG: build_message(msg, choices),
+            MSG: render_prompt(prompt, choices),
             MSGTYPE: type == :prompt
           }
         end
 
         private
 
-        def build_message(msg, choices)
-          [msg, build_choices(choices)].compact.join "\n\n"
-        end
-
-        def build_choices(choices)
-          return unless choices.present?
-
-          choices.map { |i, c| "#{i}. #{c}" }.join "\n"
+        def render_prompt(prompt, choices)
+          FlowChat::Ussd::Renderer.new(prompt, choices).render
         end
       end
     end

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

@@ -11,17 +11,16 @@ module FlowChat
           @session = context.session
 
           if intercept?
-            @context["ussd.response"] = handle_intercepted_request
-            [200, {}, [""]]
+            type, prompt = handle_intercepted_request
+            [type, prompt, []]
           else
             @session.delete "ussd.pagination"
-            res = @app.call(context)
+            type, prompt, choices = @app.call(context)
 
-            if @context["ussd.response"].present?
-              @context["ussd.response"] = maybe_paginate @context["ussd.response"]
-            end
+            prompt = FlowChat::Ussd::Renderer.new(prompt, choices).render
+            type, prompt = maybe_paginate(type, prompt) if prompt.present?
 
-            res
+            [type, prompt, []]
           end
         end
 
@@ -29,57 +28,59 @@ module FlowChat
 
         def intercept?
           pagination_state.present? &&
-            (pagination_state[:type].to_sym == :terminal ||
-             ([Config.pagination_next_option, Config.pagination_back_option].include? @context["ussd.request"][:input]))
+            (pagination_state["type"].to_sym == :terminal ||
+             ([Config.pagination_next_option, Config.pagination_back_option].include? @context.input))
         end
 
         def handle_intercepted_request
           Config.logger&.info "FlowChat::Middleware::Pagination :: Intercepted to handle pagination"
           start, finish, has_more = calculate_offsets
-          type = (pagination_state[:type].to_sym == :terminal && !has_more) ? :terminal : :prompt
-          body = pagination_state[:body][start..finish].strip + build_pagination_options(type, has_more)
+          type = (pagination_state["type"].to_sym == :terminal && !has_more) ? :terminal : :prompt
+          prompt = pagination_state["prompt"][start..finish].strip + build_pagination_options(type, has_more)
           set_pagination_state(current_page, start, finish)
 
-          {body: body, type: type}
+          [type, prompt]
         end
 
-        def maybe_paginate(response)
-          if response[:body].length > Config.pagination_page_size
-            Config.logger&.info "FlowChat::Middleware::Pagination :: Response length (#{response[:body].length}) exceeds page size (#{Config.pagination_page_size}). Paginating."
-            body = response[:body][0..single_option_slice_size]
+        def maybe_paginate(type, prompt)
+          if prompt.length > Config.pagination_page_size
+            original_prompt = prompt
+            Config.logger&.info "FlowChat::Middleware::Pagination :: Response length (#{prompt.length}) exceeds page size (#{Config.pagination_page_size}). Paginating."
+            prompt = prompt[0..single_option_slice_size]
             # Ensure we do not cut words and options off in the middle.
-            current_pagebreak = response[:body][single_option_slice_size + 1].blank? ? single_option_slice_size : body.rindex("\n") || body.rindex(" ") || single_option_slice_size
-            set_pagination_state(1, 0, current_pagebreak, response[:body], response[:type])
-            response[:body] = body[0..current_pagebreak].strip + "\n\n" + next_option
-            response[:type] = :prompt
+            current_pagebreak = prompt[single_option_slice_size + 1].blank? ? single_option_slice_size : prompt.rindex("\n") || prompt.rindex(" ") || single_option_slice_size
+            set_pagination_state(1, 0, current_pagebreak, original_prompt, type)
+            prompt = prompt[0..current_pagebreak].strip + "\n\n" + next_option
+            type = :prompt
           end
-          response
+          [type, prompt]
         end
 
         def calculate_offsets
           page = current_page
-          offset = pagination_state[:offsets][page]
+          offset = pagination_state["offsets"][page.to_s]
           if offset.present?
             Config.logger&.debug "FlowChat::Middleware::Pagination :: Reusing cached offset for page: #{page}"
-            start = offset[:start]
-            finish = offset[:finish]
-            has_more = pagination_state[:body].length > finish
+            start = offset["start"]
+            finish = offset["finish"]
+            has_more = pagination_state["prompt"].length > finish
           else
             Config.logger&.debug "FlowChat::Middleware::Pagination :: Calculating offset for page: #{page}"
             # We are guaranteed a previous offset because it was set in maybe_paginate
-            previous_offset = pagination_state[:offsets][page - 1]
-            start = previous_offset[:finish] + 1
-            has_more, len = (pagination_state[:body].length > start + single_option_slice_size) ? [true, dual_options_slice_size] : [false, single_option_slice_size]
+            previous_page = page - 1
+            previous_offset = pagination_state["offsets"][previous_page.to_s]
+            start = previous_offset["finish"] + 1
+            has_more, len = (pagination_state["prompt"].length > start + single_option_slice_size) ? [true, dual_options_slice_size] : [false, single_option_slice_size]
             finish = start + len
-            if start > pagination_state[:body].length
+            if start > pagination_state["prompt"].length
               Config.logger&.debug "FlowChat::Middleware::Pagination :: No content exists for page: #{page}. Reverting to page: #{page - 1}"
               page -= 1
               has_more = false
-              start = previous_offset[:start]
-              finish = previous_offset[:finish]
+              start = previous_offset["start"]
+              finish = previous_offset["finish"]
             else
-              body = pagination_state[:body][start..finish]
-              current_pagebreak = pagination_state[:body][finish + 1].blank? ? len : body.rindex("\n") || body.rindex(" ") || len
+              prompt = pagination_state["prompt"][start..finish]
+              current_pagebreak = pagination_state["prompt"][finish + 1].blank? ? len : prompt.rindex("\n") || prompt.rindex(" ") || len
               finish = start + current_pagebreak
             end
           end
@@ -126,28 +127,31 @@ module FlowChat
         end
 
         def current_page
-          current_page = pagination_state[:page]
-          if @context["ussd.request"][:input] == Config.pagination_back_option
-            current_page -= 1
-          elsif @context["ussd.request"][:input] == Config.pagination_next_option
-            current_page += 1
+          page = pagination_state["page"]
+          if @context.input == Config.pagination_back_option
+            page -= 1
+          elsif @context.input == Config.pagination_next_option
+            page += 1
           end
-          [current_page, 1].max
+          [page, 1].max
         end
 
         def pagination_state
-          @context.session.get("pagination", {})
+          @pagination_state ||= @context.session.get("ussd.pagination") || {}
         end
 
-        def set_pagination_state(page, offset_start, offset_finish, body = nil, type = nil)
-          offsets = pagination_state[:offsets] || {}
+        def set_pagination_state(page, offset_start, offset_finish, prompt = nil, type = nil)
+          offsets = pagination_state["offsets"] || {}
           offsets[page] = {start: offset_start, finish: offset_finish}
-          @session["ussd.pagination"] = {
-            page: page,
-            offsets: offsets,
-            body: body || pagination_state[:body],
-            type: type || pagination_state[:type]
+          prompt ||= pagination_state["prompt"]
+          type ||= pagination_state["type"]
+          @pagination_state = {
+            "page" => page,
+            "offsets" => offsets,
+            "prompt" => prompt,
+            "type" => type
           }
+          @session.set "ussd.pagination", @pagination_state
         end
       end
     end

data/lib/flow_chat/ussd/processor.rb

@@ -33,21 +33,22 @@ module FlowChat
         self
       end
 
-      def use_pagination
-        middleware.use FlowChat::Ussd::Middleware::Pagination
-      end
-
-      def run(flow, action)
-        @context["flow.class"] = flow
+      def run(flow_class, action)
+        @context["flow.name"] = flow_class.name.underscore
+        @context["flow.class"] = flow_class
         @context["flow.action"] = action
 
-        ::Middleware::Builder.new name: "ussd" do |b|
+        stack = ::Middleware::Builder.new name: "ussd" do |b|
           b.use gateway
           b.use FlowChat::Session::Middleware
-          # b.use FlowChat::Middleware::Pagination
+          b.use FlowChat::Ussd::Middleware::Pagination
           b.use middleware
           b.use FlowChat::Ussd::Middleware::Executor
-        end.inject_logger(Rails.logger).call(@context)
+        end.inject_logger(Rails.logger)
+
+        yield stack if block_given?
+
+        stack.call(@context)
       end
     end
   end

data/lib/flow_chat/ussd/renderer.rb

@@ -0,0 +1,26 @@
+module FlowChat
+  module Ussd
+    class Renderer
+      attr_reader :prompt, :choices
+
+      def initialize(prompt, choices)
+        @prompt = prompt
+        @choices = choices
+      end
+
+      def render = build_prompt
+
+      private
+
+      def build_prompt
+        [prompt, build_choices].compact.join "\n\n"
+      end
+
+      def build_choices
+        return unless choices.present?
+
+        choices.map { |i, c| "#{i}. #{c}" }.join "\n"
+      end
+    end
+  end
+end

data/lib/flow_chat/version.rb

@@ -1,3 +1,3 @@
 module FlowChat
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: flow_chat
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Stefan Froelich
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-04-04 00:00:00.000000000 Z
+date: 2024-04-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: zeitwerk
@@ -80,7 +80,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.4.2
-description: Enable USSD processing support in Rails.
+description: Framework for processing Menu based conversations e.g. USSD in Rails.
 email:
 - sfroelich01@gmail.com
 executables: []
@@ -111,17 +111,18 @@ files:
 - 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/ussd/simulator/controller.rb
 - lib/flow_chat/ussd/simulator/views/simulator.html.erb
 - lib/flow_chat/version.rb
-homepage: https://github.com/ussd-engine/api-base
+homepage: https://github.com/radioactive-labs/flow_chat
 licenses:
 - MIT
 metadata:
   allowed_push_host: https://rubygems.org
-  homepage_uri: https://github.com/ussd-engine/api-base
-  source_code_uri: https://github.com/ussd-engine/api-base
-  changelog_uri: https://github.com/ussd-engine/api-base
+  homepage_uri: https://github.com/radioactive-labs/flow_chat
+  source_code_uri: https://github.com/radioactive-labs/flow_chat
+  changelog_uri: https://github.com/radioactive-labs/flow_chat
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -140,5 +141,5 @@ requirements: []
 rubygems_version: 3.5.6
 signing_key:
 specification_version: 4
-summary: Enable USSD processing support in Rails.
+summary: Framework for processing Menu based conversations e.g. USSD in Rails.
 test_files: []