bianchi 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6fe9c6aabbf8e704a9ea9403896cc71c9aedf9a5f8bf5a5433469dba9e80d40b
+  data.tar.gz: 4caa2699c795f348136640d2300e636c8ce2848daf7605a0596749507034286a
+SHA512:
+  metadata.gz: 3f56b2bf18384a755a4e6022b457e450c54efeb088926e112fca3b0ba6a7732a3762d83243a30572fd704c0131c816154e7cf4bbb3548fb489af5c0f11bdbec9
+  data.tar.gz: f763c36ef9616506fc87223383bb73487f0fc37901e8e14e99078970ad86c618b97f6b4602ef8140f95d182d23f62c23878fe72c68db9b84f3075ed3e5db8419

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,20 @@
+AllCops:
+  NewCops: enable
+  TargetRubyVersion: 3.0
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120
+
+Style/Documentation:
+  Enabled: false
+
+Metrics/MethodLength:
+  CountAsOne: ['array', 'heredoc', 'hash']
+
+
+
+

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at 51008616+SydDaps@users.noreply.github.com. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/Gemfile

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in bianchi.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rspec", "~> 3.0"
+
+gem "rubocop", "~> 0.80"
+
+gem "byebug"

data/Gemfile.lock

@@ -0,0 +1,92 @@
+PATH
+  remote: .
+  specs:
+    bianchi (0.1.0)
+      activesupport
+      json
+      redis
+      thor
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (7.1.3)
+      base64
+      bigdecimal
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      connection_pool (>= 2.2.5)
+      drb
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      mutex_m
+      tzinfo (~> 2.0)
+    ast (2.4.2)
+    base64 (0.2.0)
+    bigdecimal (3.1.6)
+    byebug (11.1.3)
+    concurrent-ruby (1.2.3)
+    connection_pool (2.4.1)
+    diff-lcs (1.5.0)
+    drb (2.2.0)
+      ruby2_keywords
+    i18n (1.14.1)
+      concurrent-ruby (~> 1.0)
+    json (2.7.1)
+    minitest (5.21.2)
+    mutex_m (0.2.0)
+    parallel (1.24.0)
+    parser (3.3.0.2)
+      ast (~> 2.4.1)
+      racc
+    racc (1.7.3)
+    rainbow (3.1.1)
+    rake (13.1.0)
+    redis (5.0.8)
+      redis-client (>= 0.17.0)
+    redis-client (0.19.1)
+      connection_pool
+    regexp_parser (2.9.0)
+    rexml (3.2.6)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.2)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.6)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.1)
+    rubocop (0.93.1)
+      parallel (~> 1.10)
+      parser (>= 2.7.1.5)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8)
+      rexml
+      rubocop-ast (>= 0.6.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-ast (1.30.0)
+      parser (>= 3.2.1.0)
+    ruby-progressbar (1.13.0)
+    ruby2_keywords (0.0.5)
+    thor (1.3.0)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (1.8.0)
+
+PLATFORMS
+  x86_64-darwin-23
+
+DEPENDENCIES
+  bianchi!
+  byebug
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  rubocop (~> 0.80)
+
+BUNDLED WITH
+   2.2.3

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Dapilah Sydney
+
+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,43 @@
+# bianchi
+
+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/bianchi`. 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 'bianchi'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install bianchi
+
+## 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 the created tag, 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]/bianchi. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/bianchi/blob/master/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the bianchi project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/bianchi/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/bianchi.gemspec

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require_relative "lib/bianchi/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "bianchi"
+  spec.version       = Bianchi::VERSION
+  spec.authors       = ["Dapilah Sydney"]
+  spec.email         = ['dapilah.sydney@gmail.com']
+
+  spec.summary       = "Write a short summary, because RubyGems requires one."
+  spec.homepage      = "https://github.com/SydDaps/Bianchi"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 3.0.0")
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org/"
+
+  spec.metadata["homepage_uri"] = "https://github.com/SydDaps/Bianchi"
+  spec.metadata["source_code_uri"] = "https://github.com/SydDaps/Bianchi"
+  spec.metadata["changelog_uri"] = "https://rubygems.org/"
+
+  # 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(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  spec.add_dependency "activesupport"
+  spec.add_dependency "json"
+  spec.add_dependency "redis"
+  spec.add_dependency "thor"
+end

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "bianchi"
+
+# 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/exe/bianchi

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bianchi"
+
+Bianchi::Cli::Main.start

data/lib/bianchi/cli/generator.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Bianchi
+  module Cli
+    class Generator < Thor::Group
+      include Thor::Actions
+      desc "-g {menu_name}_menu_page_{page_number}", "Generates a menu page file in your current directory"
+
+      argument :menu_name_page_number
+
+      def version
+        say "Bianchi version #{Bianchi::VERSION}"
+      end
+
+      def self.exit_on_failure?
+        true
+      end
+    end
+  end
+end

data/lib/bianchi/cli/main.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+# rubocop:disable Metrics/ParameterLists
+module Bianchi
+  module Cli
+    class Main < Thor
+      include Thor::Actions
+
+      desc "-v", "Show bianchi version number"
+      map %w[-v --version] => :version
+
+      def version
+        say "Bianchi version #{Bianchi::VERSION}"
+      end
+
+      def self.source_root
+        File.dirname(__FILE__)
+      end
+
+      desc "setup", "sets up a new ussd project"
+      long_desc <<-LONG_DESC
+        Usage: bianchi setup optional(-p|--provider)
+        \x5 Providers: [:africa_is_talking]
+        \x5 Example: `bianchi setup`
+        \x5 Example: `bianchi setup -p :africa_is_talking`
+
+      LONG_DESC
+      method_option :provider, :aliases => "-p", type: :string, :desc => "Set up ussd project for provider"
+      def setup
+        @provider = options[:provider]
+        unless ["africa_is_talking", "none"].include? @provider
+          say("Error: provider #{@provider} is not yet configured.", :yellow)
+          exit(1)
+        end
+
+        @provider = ", provider: :#{@provider}" if @provider
+
+        template("templates/engine.erb", "ussd/engine.rb")
+      end
+
+      desc "g", "Generates a menu page file"
+      long_desc <<-LONG_DESC
+        Usage: bianchi g|generate menu [name:string] page [number:int]
+        \x5 Example: `bianchi generate menu main page 1`
+      LONG_DESC
+
+      map %w[g generate] => :generate
+      def generate(entity = nil, entity_name = nil, type = nil, number = nil)
+        unless ["menu"].include?(entity) && entity_name.is_a?(String) && type == "page" && number.to_i.to_s == number
+          say("Usage: bianchi g|generate menu [name:string] page [number:int]", :yellow)
+          say("Example: bianchi generate menu main page 1")
+          exit(1)
+        end
+
+        @menu_name = entity_name
+        @page_number = number
+        template("templates/page.erb", "ussd/#{@menu_name}_menu/page_#{@page_number}.rb")
+      end
+
+      def self.exit_on_failure?
+        true
+      end
+    end
+  end
+end
+# rubocop:enable Metrics/ParameterLists

data/lib/bianchi/cli/templates/engine.erb

@@ -0,0 +1,10 @@
+module USSD
+  class Engine
+    def self.start(params)
+
+      Bianchi::USSD::Engine.start(params<%= @provider  %>) do
+        # e.g menu :main, options
+      end
+    end
+  end
+end

data/lib/bianchi/cli/templates/page.erb

@@ -0,0 +1,11 @@
+module USSD
+  module <%= @menu_name.camelize %>Menu
+    class Page<%= @page_number  %> < Bianchi::USSD::Page
+      def request
+      end
+
+      def response
+      end
+    end
+  end
+end

data/lib/bianchi/ussd/engine.rb

@@ -0,0 +1,120 @@
+# frozen_string_literal: true
+
+module Bianchi
+  module USSD
+    class Engine
+      include USSD::ProviderConfigurations
+
+      attr_accessor :params, :session, :menus, :prompt_data, :provider
+
+      def initialize(params, options)
+        validate_engine_options(options)
+
+        @provider = options[:provider]&.to_sym || :none
+        @params = parse_params(params)
+        @session = Session.new @params
+        @menus = []
+        @prompt_data = nil
+      end
+
+      def self.start(params, options = {}, &block)
+        raise ArgumentError, "block required to start the engine" unless block_given?
+
+        new(params, options).tap do |e|
+          validate_params(e.params)
+          e.instance_eval(&block)
+          e.process_activity_state
+        end
+      end
+
+      def validate_engine_options(options)
+        raise ArgumentError, "options expected to be a hash to start engine" unless options.is_a? Hash
+        return if options.empty?
+
+        allowed_options = %i[provider]
+        return if (options.keys.map(&:to_sym) - allowed_options).empty?
+
+        raise ArgumentError, "#{allowed_options} are the only valid option keys"
+      end
+
+      def self.validate_params(params)
+        raise ArgumentError, "params expected to be a hash to start engine" unless params.is_a? Hash
+
+        required_params = %w[session_id mobile_number input_body activity_state]
+
+        left_required_params = required_params - params.keys.map(&:to_s)
+        unless left_required_params.empty?
+          raise ArgumentError, "#{left_required_params} required in params to start engine"
+        end
+
+        return if %w[initial subsequent].include? params[:activity_state]
+
+        raise ArgumentError, "activity_state has to either be initial or subsequent"
+      end
+
+      def menu(menu_name, options = {})
+        unless [String, Symbol].include? menu_name.class
+          raise ArgumentError, "menu_name expected to either be string/symbol to define menus"
+        end
+
+        raise ArgumentError, "menu_options expected to be a hash to start engine" unless options.is_a? Hash
+
+        @menus << Menu.new(menu_name, options)
+      end
+
+      def ensure_initial_menu
+        return if initial_menu
+
+        raise PageLoadError, "an initial menu is required to proceed"
+      end
+
+      def process_activity_state
+        ensure_initial_menu
+
+        page = case session.activity_state.to_sym
+               when :initial
+                 initial_menu_page
+               when :subsequent
+                 subsequent_menu_page
+               end
+
+        @prompt_data = parser_prompt_data page.session_prompt_data
+      end
+
+      def initial_menu_page
+        session.menu = initial_menu
+        menu_page("Page1", :request)
+      end
+
+      def initial_menu
+        menus.find { |menu| menu.options[:initial] }
+      end
+
+      def subsequent_menu_page
+        previous_session = session.store.previous_session
+        unless previous_session
+          raise PageLoadError, "Previous session not found to load subsequent page restart from initial menu"
+        end
+
+        session.menu = previous_session.menu
+
+        menu_page(previous_session.page_number, :response)
+      end
+
+      def menu_page(page_number, action)
+        constant_name = "USSD::#{session.menu.name.camelize}Menu::#{page_number}"
+        page = constant_name.safe_constantize
+
+        unless page
+          raise PageLoadError,
+                "#{constant_name} is supposed to be defined to process #{session.menu.name} menu #{page_number}"
+        end
+
+        page.new(session).tap do |p|
+          p.ensure_methods_defined(%i[request response])
+          p.send(action)
+        end
+      end
+    end
+  end
+end

data/lib/bianchi/ussd/errors.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Bianchi
+  module USSD
+    class ArgumentError < StandardError; end
+    class PageLoadError < StandardError; end
+    class MethodNameError < StandardError; end
+    class ProviderError < StandardError; end
+  end
+end

data/lib/bianchi/ussd/menu.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Bianchi
+  module USSD
+    class Menu
+      attr_reader :name, :options
+
+      def initialize(name, options = {})
+        @name = name.to_s
+        @options = options
+      end
+    end
+  end
+end

data/lib/bianchi/ussd/page.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+module Bianchi
+  module USSD
+    class Page
+      attr_reader :session
+
+      include USSD::PageDelegators
+
+      def initialize(session)
+        @session = session
+      end
+
+      def render(body, options = {})
+        raise ArgumentError, "render body expected to be a string" unless body.is_a? String
+
+        session.tap do |s|
+          s.prompt_data = s.params.merge(
+            { activity_state: options[:state], body: body }
+          )
+
+          s.page_number = self.class.name.split("::").last
+          s.store.track_session
+        end
+      end
+
+      def load_page(page_number, menu_name)
+        constant_name = "USSD::#{menu_name.camelize}Menu::#{page_number}"
+        page = constant_name.safe_constantize
+
+        unless page
+          raise PageLoadError,
+                "#{constant_name} is supposed to be defined to process #{menu_name} menu #{page_number}"
+        end
+
+        session.menu = Menu.new(menu_name)
+        page.new(session).send(:request)
+      end
+
+      def ensure_methods_defined(methods)
+        error_messages = methods.each_with_object([]) do |method, messages|
+          next if methods_defined? method
+
+          messages << "#{self.class.name} is supposed to have method #{method} defined"
+        end
+
+        return if error_messages.empty?
+
+        raise PageLoadError, error_messages.join(", ")
+      end
+
+      def methods_defined?(method)
+        respond_to? method
+      end
+    end
+  end
+end

data/lib/bianchi/ussd/page_delegators.rb

@@ -0,0 +1,102 @@
+# frozen_string_literal: true
+
+module Bianchi
+  module USSD
+    module PageDelegators
+      def method_missing(method_name, *args)
+        name = method_name.to_s
+
+        allowed_dynamic_methods_prefix_delegator = {
+          "redirect_to_" => proc { delegate_redirected_to(name) },
+          "render_and_" => proc { delegate_render_and(name, args) },
+          "session_" => proc { delegate_session(name) }
+        }
+
+        dynamic_method = allowed_dynamic_methods_prefix_delegator.find do |key, _value|
+          name.start_with? key
+        end
+
+        return super unless dynamic_method.present?
+
+        dynamic_method.second.call
+      end
+
+      # redirect delegators
+      def delegate_redirected_to(name)
+        name.delete_prefix!("redirect_to_")
+        page, menu_name = handle_redirect_to_cases(name)
+        load_page(page, menu_name)
+      end
+
+      def handle_redirect_to_cases(name)
+        redirect_to_method_names = [
+          "next_page",
+          "previous_page",
+          "(menu_name)_menu_page_(number)"
+        ]
+
+        case name
+        when /(next|previous)_page/
+          to_next_or_previous_page Regexp.last_match(1)
+        when /(.+)_menu_page_(\d+)/
+          to_menu_page(Regexp.last_match(1), Regexp.last_match(2).to_i)
+        else
+          error_message = redirect_to_method_names.map { |method_name| "redirect_to_#{method_name}" }.join(", ")
+          raise MethodNameError, "do you mean [#{error_message}]"
+        end
+      end
+
+      def to_next_or_previous_page(keyword)
+        page = self.class.name.split("::").last
+
+        next_page_number = keyword == "next" ? (page[-1].to_i + 1) : (page[-1].to_i - 1)
+
+        raise PageLoadError, "can not redirect to previous page from page 1" if next_page_number < 1
+
+        [page_number(page, next_page_number), session.menu.name]
+      end
+
+      def page_number(page, next_page_number)
+        page.length == 4 ? page << next_page_number.to_s : page[-1] = next_page_number.to_s
+
+        page
+      end
+
+      def to_menu_page(menu_name, page_number)
+        page = "Page#{page_number}"
+
+        [page, menu_name]
+      end
+
+      # render delegators
+      def delegate_render_and(name, args)
+        name.delete_prefix!("render_and_")
+
+        states = {
+          "await" => :await,
+          "end" => :end
+        }
+
+        unless states.keys.include? name
+          raise MethodNameError, "do you mean [#{states.keys.map { |state| "render_and_#{state}" }.join(', ')}]"
+        end
+
+        render args.first, state: states[name]
+      end
+
+      # session_delegators
+      def delegate_session(name)
+        name.delete_prefix!("session_")
+
+        allowed_session_instance_names = session.instance_variables.map { |variable| variable.to_s.delete_prefix("@") }
+
+        unless allowed_session_instance_names.include? name
+          error_message = allowed_session_instance_names.map { |method_name| "session_#{method_name}" }.join(", ")
+          raise MethodNameError, "do you mean [#{error_message}]"
+        end
+
+        session.send(name)
+      end
+    end
+  end
+end

data/lib/bianchi/ussd/provider_configurations.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+module Bianchi
+  module USSD
+    module ProviderConfigurations
+      def parse_params(params)
+        provider_parsers = {
+          none: proc { params },
+          africa_is_talking: proc { africa_is_talking_params_parser(params) }
+        }.with_indifferent_access
+
+        parser = provider_parsers[@provider]
+
+        raise ProviderError, "Could not find configurations for provider(#{@provider}) specified" unless parser.present?
+
+        parser.call
+      end
+
+      def africa_is_talking_params_parser(params)
+        required_params = %w[sessionId phoneNumber text serviceCode]
+        left_required_params = required_params - params.keys.map(&:to_s)
+
+        unless left_required_params.empty?
+          raise ArgumentError, "#{left_required_params} required in params to start engine for provider #{@provider}"
+        end
+
+        {
+          session_id: params["sessionId"],
+          mobile_number: params["phoneNumber"],
+          activity_state: params["text"] && params["text"].empty? ? "initial" : "subsequent",
+          input_body: params["text"],
+          service_code: params["serviceCode"]
+        }
+      end
+
+      def parser_prompt_data(prompt_data)
+        provider_parsers = {
+          none: proc { prompt_data },
+          africa_is_talking: proc { africa_is_talking_prompt_data_parser(prompt_data) }
+        }.with_indifferent_access
+
+        parser = provider_parsers[@provider]
+
+        raise StandardError, "could not parse response data for the provider specified." unless parser.present?
+
+        parser.call
+      end
+
+      def africa_is_talking_prompt_data_parser(prompt_data)
+        prompt_data["activity_state"] == :await ? "CON #{prompt_data['body']}" : "END #{prompt_data['body']}"
+      end
+    end
+  end
+end

data/lib/bianchi/ussd/session.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Bianchi
+  module USSD
+    class Session
+      attr_accessor :params, :activity_state, :prompt_data,
+                    :menu, :page_number, :store,
+                    :id, :mobile_number, :input_body
+
+      def initialize(params, menu = nil, page_number = nil)
+        @params = params.with_indifferent_access
+        @activity_state = params[:activity_state]
+        @mobile_number = params[:mobile_number]
+        @id = params[:session_id]
+        @input_body = params[:input_body]
+        @prompt_data = {}
+        @menu = menu
+        @page_number = page_number
+        @store = Store.new(self)
+      end
+    end
+  end
+end

data/lib/bianchi/ussd/store.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+module Bianchi
+  module USSD
+    class Store
+      attr_reader :session
+
+      def initialize(session)
+        @redis = Redis.new(url: ENV.fetch("REDIS_URL", nil))
+        @session = session
+      end
+
+      def track_session
+        data = {
+          params: session.params,
+          menu: session.menu.name,
+          page_number: session.page_number
+        }.to_json
+
+        @redis.hset("#{session.id}-#{session.mobile_number}-activity", data: data)
+      end
+
+      def previous_session
+        previous_activity = @redis.hgetall("#{session.id}-#{session.mobile_number}-activity")
+        return if previous_activity.empty?
+
+        previous_activity_data = JSON.parse(previous_activity["data"]).with_indifferent_access
+
+        menu = Menu.new(previous_activity_data[:menu])
+        page_number = previous_activity_data[:page_number]
+        params = previous_activity_data[:params]
+        Session.new(params, menu, page_number)
+      end
+
+      def get(key)
+        parse_value @redis.hget("#{session.id}-#{session.mobile_number}-store", key)
+      end
+
+      def all
+        parse_values @redis.hgetall("#{session.id}-#{session.mobile_number}-store")
+      end
+
+      def set(key, value)
+        @redis.hset("#{session.id}-#{session.mobile_number}-store", { key => value.to_json })
+      end
+
+      def parse_values(data)
+        data.transform_values { |v| parse_value v }
+      end
+
+      def parse_value(value)
+        JSON.parse(value)
+      rescue StandardError
+        value
+      end
+    end
+  end
+end

data/lib/bianchi/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Bianchi
+  VERSION = "0.1.0"
+end

data/lib/bianchi.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require "active_support/all"
+require "redis"
+require "json"
+require "thor"
+
+require_relative "bianchi/version"
+require_relative "bianchi/ussd/provider_configurations"
+require_relative "bianchi/ussd/engine"
+require_relative "bianchi/ussd/menu"
+require_relative "bianchi/ussd/session"
+require_relative "bianchi/ussd/page_delegators"
+require_relative "bianchi/ussd/page"
+require_relative "bianchi/ussd/store"
+require_relative "bianchi/ussd/errors"
+
+# cli
+require "bianchi/cli/main"

data/ussd/engine.rb

@@ -0,0 +1,10 @@
+module USSD
+  class Engine
+    def self.start(params)
+
+      Bianchi::USSD::Engine.start(params, provider: :africa_is_talking) do
+        # e.g menu :main, options
+      end
+    end
+  end
+end

data/ussd/main_menu/page_1.rb

@@ -0,0 +1,11 @@
+module USSD
+  module MainMenu
+    class Page1 < Bianchi::USSD::Page
+      def request
+      end
+
+      def response
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,133 @@
+--- !ruby/object:Gem::Specification
+name: bianchi
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Dapilah Sydney
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-01-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  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: json
+  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: redis
+  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: thor
+  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:
+email:
+- dapilah.sydney@gmail.com
+executables:
+- bianchi
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bianchi.gemspec
+- bin/console
+- bin/setup
+- exe/bianchi
+- lib/bianchi.rb
+- lib/bianchi/cli/generator.rb
+- lib/bianchi/cli/main.rb
+- lib/bianchi/cli/templates/engine.erb
+- lib/bianchi/cli/templates/page.erb
+- lib/bianchi/ussd/engine.rb
+- lib/bianchi/ussd/errors.rb
+- lib/bianchi/ussd/menu.rb
+- lib/bianchi/ussd/page.rb
+- lib/bianchi/ussd/page_delegators.rb
+- lib/bianchi/ussd/provider_configurations.rb
+- lib/bianchi/ussd/session.rb
+- lib/bianchi/ussd/store.rb
+- lib/bianchi/version.rb
+- ussd/engine.rb
+- ussd/main_menu/page_1.rb
+homepage: https://github.com/SydDaps/Bianchi
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org/
+  homepage_uri: https://github.com/SydDaps/Bianchi
+  source_code_uri: https://github.com/SydDaps/Bianchi
+  changelog_uri: https://rubygems.org/
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.3
+signing_key:
+specification_version: 4
+summary: Write a short summary, because RubyGems requires one.
+test_files: []