ussd_engine 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 57122947aff50821a4a6ec61d38501ce9f525e516be998874590d6104bb1a754
+  data.tar.gz: 581faff4ae10681400a32c21cc72fc5b94525a8e0f7e7a4f1867b7916838238e
+SHA512:
+  metadata.gz: a8f7753521a5405026b20c78072c5009bdb952d79599ec735bd0fcd79d9ed6de96f61975a7c89310da9956ef43ea89055416e881e0214094d10b68e7037e75d2
+  data.tar.gz: 1b67596120f200d6a1f9f830f83052d4d444df48fb77a0719cf2b5fdfd6dae3dcae2e12c92f7043916831ec6013c0bbb91da1965d3d554760bb78044ada96012

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+# Ignore Gemfile.lock for our gem
+/Gemfile.lock

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.7.1
+before_install: gem install bundler -v 2.1.4

data/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in ussd_engine.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "rspec", "~> 3.0"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Stefan Froelich
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,40 @@
+# UssdEngine
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/ussd_engine`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ussd_engine'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install ussd_engine
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/ussd_engine.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "ussd_engine"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/ussd_engine/config.rb

@@ -0,0 +1,18 @@
+require "active_support" unless defined?(Rails)
+
+module UssdEngine
+  module Config
+    mattr_accessor :logger, default: Logger.new($stdout)
+    mattr_accessor :cache, default: nil
+
+    mattr_accessor :pagination_page_size, default: 140
+    mattr_accessor :pagination_back_option, default: "0"
+    mattr_accessor :pagination_back_text, default: "Back"
+    mattr_accessor :pagination_next_option, default: "#"
+    mattr_accessor :pagination_next_text, default: "More"
+
+    mattr_accessor :resumable_sessions_enabled, default: false
+    mattr_accessor :resumable_sessions_global, default: true
+    mattr_accessor :resumable_sessions_timeout_seconds, default: 300
+  end
+end

data/lib/ussd_engine/controller/io.rb

@@ -0,0 +1,23 @@
+module UssdEngine
+  module Controller
+    module Io
+      protected
+
+      def basic_prompt(message)
+        Config.logger&.debug "UssdEngine::Controller::Io :: Sending prompt -> \n\n#{message}\n"
+        {
+          body: message,
+          type: :prompt,
+        }
+      end
+
+      def terminate(message)
+        Config.logger&.debug "UssdEngine::Controller::Io :: Terminating session -> \n\n#{message}\n"
+        {
+          body: message,
+          type: :terminal,
+        }
+      end
+    end
+  end
+end

data/lib/ussd_engine/controller/mixin.rb

@@ -0,0 +1,61 @@
+require "ussd_engine/controller/io"
+require "ussd_engine/controller/options"
+require "ussd_engine/controller/params"
+require "ussd_engine/controller/storable"
+
+module UssdEngine
+  module Controller
+    module Mixin
+      include UssdEngine::Controller::Io
+      include UssdEngine::Controller::Options
+      include UssdEngine::Controller::Params
+
+      def self.included(base)
+        base.send :include, UssdEngine::Controller::Storable
+        base.send :skip_before_action, :verify_authenticity_token, only: :ussd_controller, raise: false
+      end
+
+      def ussd_controller
+        unless request.env["ussd_engine.request"].present?
+          Config.logger&.warn "UssdEngine::Controller::Mixin :: Unknown request type"
+          return render(status: :bad_request)
+        end
+
+        process_ussd_request build_ussd_request
+        render body: nil
+      end
+
+      protected
+
+      def process_ussd_request(ussd_request)
+        display(ussd_request[:screen], ussd_request[:input])
+      end
+
+      def display(screen, input = nil)
+        Config.logger&.debug "UssdEngine::Controller::Mixin :: Display #{screen}"
+        session["ussd_engine.screen"] = screen
+        request.env["ussd_engine.response"] = send screen.to_sym, input
+      end
+
+      def build_ussd_request
+        if ussd_request_type == :initial
+          Config.logger&.debug "UssdEngine::Controller::Mixin :: Starting new session"
+          reset_session
+          ussd_screen = :index
+        else
+          Config.logger&.debug "UssdEngine::Controller::Mixin :: Continuing existing session"
+          user_input = ussd_user_input
+          ussd_screen = session["ussd_engine.screen"] || :index
+        end
+
+        { screen: ussd_screen, input: user_input }
+      end
+
+      def prompt(message, options = nil)
+        return basic_prompt(message) if options.blank?
+
+        options_prompt(message, options)
+      end
+    end
+  end
+end

data/lib/ussd_engine/controller/options.rb

@@ -0,0 +1,26 @@
+module UssdEngine
+  module Controller
+    module Options
+      protected
+
+      def options_prompt(message, options)
+        message += build_options_nav(options)
+        Config.logger&.debug "UssdEngine::Controller::Options :: Sending prompt -> \n\n#{message}\n"
+        {
+          body: message,
+          type: :prompt,
+        }
+      end
+
+      def build_options_nav(options)
+        "\n\n" + options.each_with_index.map { |x, i| "#{i + 1} #{x[1]}" }.join("\n")
+      end
+
+      def resolve_option(input, options)
+        return unless input.match? /^[1-9](\d)?$/
+
+        options.keys[input.to_i - 1]
+      end
+    end
+  end
+end

data/lib/ussd_engine/controller/params.rb

@@ -0,0 +1,30 @@
+require "ussd_engine/controller/io"
+require "ussd_engine/controller/options"
+
+module UssdEngine
+  module Controller
+    module Params
+      protected
+
+      def ussd_request_id
+        request.env["ussd_engine.request"][:id]
+      end
+
+      def ussd_request_type
+        request.env["ussd_engine.request"][:type]
+      end
+
+      def ussd_request_msisdn
+        request.env["ussd_engine.request"][:msisdn]
+      end
+
+      def ussd_request_provider
+        request.env["ussd_engine.request"][:provider]
+      end
+
+      def ussd_user_input
+        request.env["ussd_engine.request"][:input]
+      end
+    end
+  end
+end

data/lib/ussd_engine/controller/storable.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+module UssdEngine
+  module Controller
+    module Storable
+      def self.included(base)
+        base.send :extend, StorableClassMethods
+      end
+
+      protected
+
+      module StorableClassMethods
+        def stores(field, accessor = nil, &block)
+          # Given
+          # field = :user_id
+          instance_prop = "@#{field}" # @user_id
+          key_method_name = "#{field}_key" # user_id_key
+          getter_method_name = field  # user_id
+          setter_method_name = "#{field}="  # user_id=
+
+          # def user_id_key
+          #   File.join ussd_request_id, "user_id"
+          # end
+          define_method key_method_name do
+            File.join ussd_request_id, field.to_s
+          end
+
+          # def user_id
+          #   session[user_id_key]
+          # end
+          define_method getter_method_name do
+            session[send(key_method_name)]
+          end
+
+          # def user_id=(value)
+          #   session[user_id_key] = value
+          # end
+          define_method setter_method_name do |value|
+            session[send(key_method_name)] = value
+          end
+
+          if accessor.present?
+            raise "A block is required if you pass an accessor" unless block_given?
+
+            # Given
+            # accessor = :user
+            cache_method_name = "#{accessor}_cache" # user_cache
+            cache_instance_prop = "@#{cache_method_name}" # @user_cache
+
+            # def user_cache
+            #   @user_cache ||= {}
+            # end
+            define_method cache_method_name do
+              unless instance_variable_defined? cache_instance_prop
+                instance_variable_set cache_instance_prop, {}
+              end
+              instance_variable_get cache_instance_prop
+            end
+
+            # Given
+            # block = do |user_id|
+            #   User.find user_id
+            # end
+            #
+            # def user
+            #   return if user_id.blank?
+            #
+            #   user_cache[user_id] ||= block(user_id)
+            # end
+            define_method accessor do
+              field_value = send(getter_method_name)
+              return if field_value.blank?
+
+              send(cache_method_name)[field_value] ||= instance_exec(field_value, &block)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ussd_engine/middleware/nalo_processor.rb

@@ -0,0 +1,44 @@
+require "phonelib"
+
+module UssdEngine
+  module Middleware
+    class NaloProcessor
+      def initialize(app)
+        @app = app
+      end
+
+      def call(env)
+        input = env["rack.input"].read
+        env["rack.input"].rewind
+        if input.present?
+          params = JSON.parse input
+          if params["USERID"].present? && params["MSISDN"].present?
+            env["ussd_engine.request"] = {
+              provider: :nalo,
+              network: nil,
+              msisdn: Phonelib.parse(params["MSISDN"]).e164,
+              type: params["MSGTYPE"] ? :initial : :response,
+              input: params["USERDATA"].presence,
+            }
+          end
+        end
+
+        status, headers, response = @app.call(env)
+
+        if env["ussd_engine.response"].present? && env["ussd_engine.request"][:provider] == :nalo
+          status = 200
+          response =
+            {
+              USERID: params["USERID"],
+              MSISDN: params["MSISDN"],
+              MSG: env["ussd_engine.response"][:body],
+              MSGTYPE: env["ussd_engine.response"][:type] != :terminal,
+            }.to_json
+          headers = headers.merge({ "Content-Type" => "application/json", "Content-Length" => response.bytesize.to_s })
+          response = [response]
+        end
+        [status, headers, response]
+      end
+    end
+  end
+end

data/lib/ussd_engine/middleware/nsano_processor.rb

@@ -0,0 +1,52 @@
+require "phonelib"
+
+module UssdEngine
+  module Middleware
+    class NsanoProcessor
+      def initialize(app)
+        @app = app
+      end
+
+      def call(env)
+        input = env["rack.input"].read
+        env["rack.input"].rewind
+        if input.present?
+          params = JSON.parse input
+          if params["network"].present? && params["UserSessionID"].present?
+            request_id = "nsano::request_id::#{params["UserSessionID"]}"
+            env["ussd_engine.request"] = {
+              provider: :nsano,
+              network: params["network"].to_sym,
+              msisdn: Phonelib.parse(params["msisdn"]).e164,
+              type: Config.cache&.read(request_id).present? ? :response : :initial,
+              input: params["msg"].presence,
+            }
+          end
+        end
+
+        status, headers, response = @app.call(env)
+
+        if env["ussd_engine.response"].present? && env["ussd_engine.request"][:provider] == :nsano
+          if env["ussd_engine.response"][:type] == :terminal
+            Config.cache&.write(request_id, nil)
+          else
+            Config.cache&.write(request_id, 1)
+          end
+
+          status = 200
+          response =
+            {
+              USSDResp: {
+                action: env["ussd_engine.response"][:type] == :terminal ? :prompt : :input,
+                menus: "",
+                title: env["ussd_engine.response"][:body],
+              },
+            }.to_json
+          headers = headers.merge({ "Content-Type" => "application/json", "Content-Length" => response.bytesize.to_s })
+          response = [response]
+        end
+        [status, headers, response]
+      end
+    end
+  end
+end

data/lib/ussd_engine/middleware/pagination.rb

@@ -0,0 +1,154 @@
+module UssdEngine
+  module Middleware
+    class Pagination
+      def initialize(app)
+        @app = app
+      end
+
+      def call(env)
+        @env = env
+        request = Rack::Request.new(env)
+        @session = request.session
+
+        if intercept?
+          @env["ussd_engine.response"] = handle_intercepted_request
+          [200, {}, [""]]
+        else
+          @session.delete "ussd_engine.pagination"
+          res = @app.call(env)
+
+          if @env["ussd_engine.response"].present?
+            @env["ussd_engine.response"] = maybe_paginate @env["ussd_engine.response"]
+          end
+
+          res
+        end
+      end
+
+      private
+
+      def intercept?
+        pagination_state.present? &&
+          (pagination_state[:type].to_sym == :terminal ||
+           ([Config.pagination_next_option, Config.pagination_back_option].include? @env["ussd_engine.request"][:input]))
+      end
+
+      def handle_intercepted_request
+        Config.logger&.info "UssdEngine::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)
+        set_pagination_state(current_page, start, finish)
+
+        { body: body, type: type }
+      end
+
+      def maybe_paginate(response)
+        if response[:body].length > Config.pagination_page_size
+          Config.logger&.info "UssdEngine::Middleware::Pagination :: Response length (#{response[:body].length}) exceeds page size (#{Config.pagination_page_size}). Paginating."
+          body = response[:body][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
+        end
+        response
+      end
+
+      def calculate_offsets
+        page = current_page
+        offset = pagination_state[:offsets][page]
+        if offset.present?
+          Config.logger&.debug "UssdEngine::Middleware::Pagination :: Reusing cached offset for page: #{page}"
+          start = offset[:start]
+          finish = offset[:finish]
+          has_more = pagination_state[:body].length > finish
+        else
+          Config.logger&.debug "UssdEngine::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]
+          finish = start + len
+          if start > pagination_state[:body].length
+            Config.logger&.debug "UssdEngine::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]
+          else
+            body = pagination_state[:body][start..finish]
+            current_pagebreak = pagination_state[:body][finish + 1].blank? ? len : body.rindex("\n") || body.rindex(" ") || len
+            finish = start + current_pagebreak
+          end
+        end
+        [start, finish, has_more]
+      end
+
+      def build_pagination_options(type, has_more)
+        options_str = ""
+        has_less = current_page > 1
+        if type.to_sym == :prompt
+          options_str += "\n\n"
+          next_opt = has_more ? next_option : ""
+          back_opt = has_less ? back_option : ""
+          options_str += [next_opt, back_opt].join("\n").strip
+        end
+        options_str
+      end
+
+      def next_option
+        "#{Config.pagination_next_option} #{Config.pagination_next_text}"
+      end
+
+      def back_option
+        "#{Config.pagination_back_option} #{Config.pagination_back_text}"
+      end
+
+      def single_option_slice_size
+        unless @single_option_slice_size.present?
+          # To display a single back or next option
+          # We accomodate the 2 newlines and the longest of the options
+          # We subtract an additional 1 to normalize it for slicing
+          @single_option_slice_size = Config.pagination_page_size - 2 - [next_option.length, back_option.length].max - 1
+        end
+        @single_option_slice_size
+      end
+
+      def dual_options_slice_size
+        unless @dual_options_slice_size.present?
+          # To display both back and next options
+          # We accomodate the 3 newlines and both of the options
+          @dual_options_slice_size = Config.pagination_page_size - 3 - [next_option.length, back_option.length].sum - 1
+        end
+        @dual_options_slice_size
+      end
+
+      def current_page
+        current_page = pagination_state[:page]
+        if @env["ussd_engine.request"][:input] == Config.pagination_back_option
+          current_page -= 1
+        elsif @env["ussd_engine.request"][:input] == Config.pagination_next_option
+          current_page += 1
+        end
+        [current_page, 1].max
+      end
+
+      def pagination_state
+        @session["ussd_engine.pagination"] || {}
+      end
+
+      def set_pagination_state(page, offset_start, offset_finish, body = nil, type = nil)
+        offsets = pagination_state[:offsets] || {}
+        offsets[page] = { start: offset_start, finish: offset_finish }
+        @session["ussd_engine.pagination"] = {
+          page: page,
+          offsets: offsets,
+          body: body || pagination_state[:body],
+          type: type || pagination_state[:type],
+        }
+      end
+    end
+  end
+end

data/lib/ussd_engine/middleware/request_id.rb

@@ -0,0 +1,24 @@
+module UssdEngine
+  module Middleware
+    class RequestId
+      def initialize(app)
+        @app = app
+      end
+
+      def call(env)
+        env["ussd_engine.request"][:id] = get_request_identifier(env) if env["ussd_engine.request"].present?
+        @app.call(env)
+      end
+
+      private
+
+      def get_request_identifier(env)
+        File.join(
+          env["PATH_INFO"],
+          Config.resumable_sessions_enabled && Config.resumable_sessions_global ? "global" : env["ussd_engine.request"][:provider].to_s,
+          env["ussd_engine.request"][:msisdn]
+        )
+      end
+    end
+  end
+end

data/lib/ussd_engine/middleware/resumable_sessions.rb

@@ -0,0 +1,50 @@
+module UssdEngine
+  module Middleware
+    class ResumableSessions
+      def initialize(app)
+        @app = app
+      end
+
+      def call(env)
+        if Config.resumable_sessions_enabled && env["ussd_engine.request"].present?
+          request = Rack::Request.new(env)
+          session = request.session
+
+          env["ussd_engine.resumable_sessions"] = {}
+
+          # If this is a new session but we have the flag set, this means the call terminated before
+          # the session closed. Force it to resume.
+          # This is safe since a new session is started if the old session does not indeed exist.
+          if env["ussd_engine.request"][:type] == :initial && can_resume_session?(session)
+            env["ussd_engine.request"][:type] = :response
+            env["ussd_engine.resumable_sessions"][:resumed] = true
+          end
+
+          res = @app.call(env)
+
+          if env["ussd_engine.response"].present?
+            if env["ussd_engine.response"][:type] == :terminal || env["ussd_engine.resumable_sessions"][:disable]
+              session.delete "ussd_engine.resumable_sessions"
+            else
+              session["ussd_engine.resumable_sessions"] = Time.now.to_i
+            end
+          end
+
+          res
+        else
+          @app.call(env)
+        end
+      end
+
+      private
+
+      def can_resume_session?(session)
+        return unless session["ussd_engine.resumable_sessions"].present?
+        return true unless Config.resumable_sessions_timeout_seconds
+
+        last_active_at = Time.at(session["ussd_engine.resumable_sessions"])
+        return (Time.now - Config.resumable_sessions_timeout_seconds) < last_active_at
+      end
+    end
+  end
+end

data/lib/ussd_engine/session/redis_store.rb

@@ -0,0 +1,49 @@
+require "action_dispatch" unless defined?(Rails)
+require "redis-session-store"
+
+module UssdEngine
+  module Session
+    class RedisStore < ::RedisSessionStore
+      def initialize(app, options = {})
+        # Disable cookies
+        options[:cookie_only] = false
+        options[:defer] = true
+
+        super app, options
+      end
+
+      def extract_session_id(request)
+        get_request_identifier(request.env) || super
+      end
+
+      def current_session_id(request)
+        get_request_identifier(request.env) || super
+      end
+
+      private
+
+      def get_request_identifier(env)
+        return unless env["ussd_engine.request"].present?
+
+        env["ussd_engine.request"][:id]
+      end
+
+      def set_cookie(*)
+        raise "This should never be called"
+      end
+
+      def session_default_values(sid)
+        [sid, USE_INDIFFERENT_ACCESS ? {}.with_indifferent_access : {}]
+      end
+
+      def get_session(env, sid)
+        sid && (session = load_session_from_redis(sid)) ? [sid, session] : session_default_values(sid)
+      rescue Errno::ECONNREFUSED, Redis::CannotConnectError => e
+        on_redis_down.call(e, env, sid) if on_redis_down
+        session_default_values(sid)
+      end
+
+      alias find_session get_session
+    end
+  end
+end

data/lib/ussd_engine/simulator.rb

@@ -0,0 +1,47 @@
+module UssdEngine
+  module Simulator
+    def ussd_simulator
+      respond_to do |format|
+        format.html do
+          render inline: simulator_view_template, layout: false, locals: simulator_locals
+        end
+      end
+    end
+
+    protected
+
+    def show_options
+      true
+    end
+
+    def default_msisdn
+      "233200123456"
+    end
+
+    def default_endpoint
+      "/ussd"
+    end
+
+    def default_provider
+      :nalo
+    end
+
+    def simulator_view_template
+      File.read simulator_view_path
+    end
+
+    def simulator_view_path
+      File.join UssdEngine.root, "ussd_engine", "views", "simulator.erb"
+    end
+
+    def simulator_locals
+      {
+        pagesize: Config.pagination_page_size,
+        show_options: show_options,
+        default_msisdn: default_msisdn,
+        default_endpoint: default_endpoint,
+        default_provider: default_provider,
+      }
+    end
+  end
+end

data/lib/ussd_engine/version.rb

@@ -0,0 +1,3 @@
+module UssdEngine
+  VERSION = "0.1.0"
+end

data/lib/ussd_engine/views/simulator.erb

@@ -0,0 +1,244 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <title>USSDEngine Simulator</title>
+    <style>
+      .content {
+        width: 320px;
+        margin: 100px auto;
+      }
+      .label {
+        display: inline-block;
+        width: 80px;
+        font-weight: bold;
+      }
+      .value {
+        display: inline;
+      }
+      .value select, input {
+        width: 200px;
+      }
+      .field {
+        margin: 5px;
+      }
+      #screen {
+        border: 1px black solid;
+        height:400px;
+        width:300px;
+        margin-top: 10px;
+        margin-bottom: 10px;
+        padding: 10px 5px;
+      }
+      #char-count {
+        text-align: center;
+        font-size: 10px;
+      }
+      .hidden {
+        display: none;
+      }
+    </style>
+  </head>
+<body>
+  <div class="content">
+    <div class="field <%=  show_options ? '' : 'hidden' %>">
+      <div class="label">Provider </div>
+      <div class="value">
+        <select id="provider">
+          <option <%=  default_provider == :nalo ? 'selected' : '' %> value="nalo">Nalo</option>
+          <option <%=  default_provider == :nsano ? 'selected' : '' %> value="nsano">Nsano</option>
+        </select>
+      </div>
+    </div>
+
+    <div class="field <%=  show_options ? '' : 'hidden' %>">
+      <div class="label">Endpoint </div>
+      <div class="value">
+        <input id="endpoint" value="<%= default_endpoint %>" />
+      </div>
+    </div>
+
+    <div class="field <%=  show_options ? '' : 'hidden' %>">
+      <div class="label">MSISDN </div>
+      <div class="value">
+        <input id="msisdn" value="<%= default_msisdn %>" />
+      </div>
+    </div>
+    
+    <div id="screen"></div>
+    <div id="char-count"></div>
+
+    <div class="field">
+      <input id="data" disabled> <button id="respond" disabled>Respond</button>
+    </div>
+
+    <div class="field">
+      <button id="initiate" disabled>Initiate</button>
+      <button id="reset" disabled>Reset</button>
+    </div>
+  </div>
+
+  <script>
+    // Config
+    const pagesize = <%= pagesize %>
+
+    // View
+    const $screen = document.getElementById('screen')
+    const $charCount = document.getElementById('char-count')
+
+    const $provider = document.getElementById('provider')
+    const $endpoint = document.getElementById('endpoint')
+    const $msisdn = document.getElementById('msisdn')
+
+    const $data = document.getElementById('data')
+    const $respondBtn = document.getElementById('respond')
+    const $initiateBtn = document.getElementById('initiate')
+    const $resetBtn = document.getElementById('reset')
+
+    $provider.addEventListener('change', function (e) {
+      state.provider = $provider.value
+      render()
+    }, false)
+
+    $endpoint.addEventListener('keyup', function (e) {
+      state.endpoint = $endpoint.value
+      render()
+    }, false)
+
+    $msisdn.addEventListener('keyup', function (e) {
+      state.msisdn = $msisdn.value
+      render()
+    }, false)
+
+    $initiateBtn.addEventListener('click', function (e) {
+      makeRequest()
+    }, false)
+
+    $resetBtn.addEventListener('click',function(e){
+      reset()
+    }, false)
+
+    $respondBtn.addEventListener('click', function (e) {
+      makeRequest()
+    }, false)
+
+    function disableInputs() {
+      $data.disabled = 'disabled'
+      $respondBtn.disabled = 'disabled'
+      $initiateBtn.disabled = 'disabled'
+      $resetBtn.disabled = 'disabled'
+      $data.disabled = 'disabled'
+    }
+
+    function enableResponse() {
+      $data.disabled = false
+      $respondBtn.disabled = false
+      $resetBtn.disabled = false
+    }
+
+    function display(text) {
+      $screen.innerText = text.substr(0, pagesize)
+      if(text.length > 0)
+        $charCount.innerText = `${text.length} chars`
+      else
+        $charCount.innerText = ''
+    }
+
+    function render() {
+      disableInputs()
+
+      if(!state.isRunning){
+        if(state.provider && state.endpoint && state.msisdn)
+          $initiateBtn.disabled = false
+        else
+          $initiateBtn.disabled = 'disabled'
+      }
+      else {
+        enableResponse()
+      }
+    }
+
+    // State
+    const state = {}
+
+    function reset(shouldRender) {
+      state.isRunning = false
+      state.provider = $provider.value
+      state.endpoint = $endpoint.value
+      state.msisdn = $msisdn.value
+
+      $data.value = null
+
+      display("")
+      if(shouldRender !== false) render()
+    }
+
+
+    // API
+
+    function makeRequest() {
+      var data = {}
+      
+      switch (state.provider) {
+        case "nalo":
+          data = {
+            USERID: '12345678',
+            MSISDN: state.msisdn,
+            USERDATA: $data.value,
+            MSGTYPE: !state.isRunning,
+          }
+          break;
+        case "nsano":
+          data = {
+            network: 'MTN',
+            msisdn: state.msisdn,
+            msg: $data.value,
+            UserSessionID: "12345",
+          }
+          break;
+      
+        default:
+          alert(`Unhandled provider request: ${state.provider}`)
+          return
+      }
+
+      disableInputs()
+      fetch(state.endpoint, {
+        method: 'POST',
+        headers: {
+          'Content-Type': 'application/json'
+        },
+        redirect: 'error',
+        body: JSON.stringify(data)
+      })
+        .then(response => {
+          if (!response.ok) {
+              throw Error(`${response.status}: ${response.statusText}`);
+          }
+          return response.json()
+        })
+        .then(data => {
+          switch (state.provider) {
+            case "nalo":
+              display(data.MSG)
+              state.isRunning = data.MSGTYPE
+              break;
+            case "nsano":
+              display(data.USSDResp.title)
+              state.isRunning = data.USSDResp.action == "input"
+              break;
+        
+            default:
+              alert(`Unhandled provider response: ${state.provider}`)
+              return
+          }
+          $data.value = null
+        })
+        .catch(error => alert(error.message))
+        .finally(render);
+    }
+
+    // run the app
+    reset()
+  </script>
+</body>
+</html>

data/lib/ussd_engine.rb

@@ -0,0 +1,16 @@
+require "ussd_engine/version"
+require "ussd_engine/config"
+require "ussd_engine/session/redis_store"
+require "ussd_engine/middleware/request_id"
+require "ussd_engine/middleware/nalo_processor"
+require "ussd_engine/middleware/nsano_processor"
+require "ussd_engine/middleware/resumable_sessions"
+require "ussd_engine/middleware/pagination"
+require "ussd_engine/controller/mixin"
+require "ussd_engine/simulator"
+
+module UssdEngine
+  def self.root
+    __dir__
+  end
+end

data/ussd_engine.gemspec

@@ -0,0 +1,34 @@
+require_relative "lib/ussd_engine/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "ussd_engine"
+  spec.version = UssdEngine::VERSION
+  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.license = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = spec.homepage
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path("..", __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "activesupport", ">= 6"
+  spec.add_runtime_dependency "actionpack", ">= 6"
+  spec.add_runtime_dependency "redis-session-store"
+  spec.add_runtime_dependency "phonelib"
+end

metadata

@@ -0,0 +1,129 @@
+--- !ruby/object:Gem::Specification
+name: ussd_engine
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Stefan Froelich
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2022-07-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6'
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6'
+- !ruby/object:Gem::Dependency
+  name: redis-session-store
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: phonelib
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Enable USSD processing support in Rails.
+email:
+- sfroelich01@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/ussd_engine.rb
+- lib/ussd_engine/config.rb
+- lib/ussd_engine/controller/io.rb
+- lib/ussd_engine/controller/mixin.rb
+- lib/ussd_engine/controller/options.rb
+- lib/ussd_engine/controller/params.rb
+- lib/ussd_engine/controller/storable.rb
+- lib/ussd_engine/middleware/nalo_processor.rb
+- lib/ussd_engine/middleware/nsano_processor.rb
+- lib/ussd_engine/middleware/pagination.rb
+- lib/ussd_engine/middleware/request_id.rb
+- lib/ussd_engine/middleware/resumable_sessions.rb
+- lib/ussd_engine/session/redis_store.rb
+- lib/ussd_engine/simulator.rb
+- lib/ussd_engine/version.rb
+- lib/ussd_engine/views/simulator.erb
+- ussd_engine.gemspec
+homepage: https://github.com/ussd-engine/api-base
+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
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key:
+specification_version: 4
+summary: Enable USSD processing support in Rails.
+test_files: []