bianchi 0.1.1 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 57689540f35b1837b227a23ec9b9badd237e5e1bda6b7f0b5c3d64443b404fd9
-  data.tar.gz: b963e56598337607ef36f0d4ebb514c9a83e354c3dc65d55d3ad299c856668b3
+  metadata.gz: 9d0a4841767acc10455e325dee277cf81119914192754b2da010b99626850986
+  data.tar.gz: 544c49afaa014e0163d86730b5338ead295ddd1f02bf6364aaa480d4a1da38f2
 SHA512:
-  metadata.gz: 9272b56f5a057de49f9695cc615afcf05fbdcb14db6f31f582bf8d6b421b4dc8787ba5fbbcab87a120aaf4fd0519fad88c66f842423984915dbf271de3076207
-  data.tar.gz: ce5f129f37e80ff25fa642af17ae8d5f31b467f580419a7b053afe941979f6e09cf9183668a9443aea262c2d933f41a1656401098e6ef6d8d8ac26ed890b2d22
+  metadata.gz: 993ad14fd38daaf4ee9cf0d55f2450111675195d778c92c4663edff75f8f657cbcb816837bb41ec3ad75b7256e0a6e800b051808c46a0224f3d54cfea16f22e7
+  data.tar.gz: 183c4fbd9c4113c4bf6fcc399e119f1e4f54f5a39b24a220dca9ce8c8fdec81195f0c802e002b36f2e2998b3fd1bfe8b0aa081ac3e88b30d823d5f78a2037e3e

data/.github/workflows/ci.yml

@@ -0,0 +1,45 @@
+name: CI
+
+on:
+  push:
+    branches:
+      - '*'
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  rubocop:
+    runs-on: ubuntu-latest
+
+    services:
+      redis:
+        image: redis
+        ports:
+          - 6379:6379
+        options: --entrypoint redis-server
+
+    steps:
+    - name: Checkout code
+      uses: actions/checkout@v4.1.1
+
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1.171.0
+      with:
+        ruby-version: 3.0
+
+    - name: Install dependencies
+      run: |
+        gem install bundler
+        bundle install
+
+    - name: Run RuboCop
+      run: bundle exec rubocop
+
+    - name: Start Redis
+      run: docker ps -a
+
+    - name: Run RSpec tests
+      env:
+        REDIS_URL: redis://localhost:6379
+      run: bundle exec rspec

data/.gitignore

@@ -9,3 +9,4 @@
 
 # rspec failure tracking
 .rspec_status
+.byebug_history

data/.rubocop.yml

@@ -1,6 +1,7 @@
 AllCops:
   NewCops: enable
   TargetRubyVersion: 3.0
+  SuggestExtensions: false
 
 Style/StringLiterals:
   Enabled: true
@@ -18,3 +19,4 @@ Metrics/MethodLength:
 
 
 
+

data/.vscode/settings.json

@@ -0,0 +1,5 @@
+{
+  "cSpell.words": [
+    "appsnmobile"
+  ]
+}

data/Gemfile

@@ -9,6 +9,6 @@ gem "rake", "~> 13.0"
 
 gem "rspec", "~> 3.0"
 
-gem "rubocop", "~> 0.80"
+gem "rubocop", "~> 1.60", ">= 1.60.2"
 
 gem "byebug"

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    bianchi (0.1.0)
+    bianchi (0.1.2)
       activesupport
       json
       redis
@@ -32,10 +32,11 @@ GEM
     i18n (1.14.1)
       concurrent-ruby (~> 1.0)
     json (2.7.1)
+    language_server-protocol (3.17.0.3)
     minitest (5.21.2)
     mutex_m (0.2.0)
     parallel (1.24.0)
-    parser (3.3.0.2)
+    parser (3.3.0.5)
       ast (~> 2.4.1)
       racc
     racc (1.7.3)
@@ -60,15 +61,17 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.12.0)
     rspec-support (3.12.1)
-    rubocop (0.93.1)
+    rubocop (1.60.2)
+      json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
       parallel (~> 1.10)
-      parser (>= 2.7.1.5)
+      parser (>= 3.3.0.2)
       rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 1.8)
-      rexml
-      rubocop-ast (>= 0.6.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.30.0, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 2.0)
+      unicode-display_width (>= 2.4.0, < 3.0)
     rubocop-ast (1.30.0)
       parser (>= 3.2.1.0)
     ruby-progressbar (1.13.0)
@@ -76,9 +79,10 @@ GEM
     thor (1.3.0)
     tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
-    unicode-display_width (1.8.0)
+    unicode-display_width (2.5.0)
 
 PLATFORMS
+  arm64-darwin-22
   x86_64-darwin-23
 
 DEPENDENCIES
@@ -86,7 +90,7 @@ DEPENDENCIES
   byebug
   rake (~> 13.0)
   rspec (~> 3.0)
-  rubocop (~> 0.80)
+  rubocop (~> 1.60, >= 1.60.2)
 
 BUNDLED WITH
    2.2.3

data/README.md

@@ -1,10 +1,11 @@
 # Bianchi
 A DSL (Domain-Specific Language) and a minimalist framework in Ruby, tailored for USSD development. Structured around a menu page approach, Bianchi offers a comprehensive suite of methods and generators, streamlining the process of building USSD applications efficiently and easily.
+A basic test run with bianchi can be found here https://github.com/SydDaps/sinatra_bianchi_example
 
 ## Installation
-Add `gem 'bianchi', '~> 0.1.0'` to your gem file and run `bundle install`
+Add `gem 'bianchi', '~> 0.1.1'` to your gem file and run `bundle install`
 
-Bianchi relies on Redis and requires the `REDIS_URL` environment variable to be set, pointing to your Redis instance. Ensure Redis is installed, running, and that REDIS_URL is correctly configured before using Bianchi.
+Bianchi relies on Redis and requires the `REDIS_URL` environment variable to be set, pointing to your Redis instance. Ensure Redis is installed, and running, and that REDIS_URL is correctly configured before using Bianchi.
 
 ## Getting Started
 
@@ -14,7 +15,7 @@ To initialize a new USSD project, generate a project directory using Bianchi's c
 bundle exec bianchi setup -p provider_name
 ```
 
-Replace `provider_name` with your desired provider. Currently supported providers include: africa_is_talking.
+Replace `provider_name` with your desired provider. Currently supported providers include: africastalking.
 
 This command creates a `ussd/engine.rb` file in the project root directory. Here's a sample content of `ussd/engine.rb`:
 
@@ -22,7 +23,7 @@ This command creates a `ussd/engine.rb` file in the project root directory. Here
 module USSD
   class Engine
     def self.start(params)
-      Bianchi::USSD::Engine.start(params, provider: :africa_is_talking) do
+      Bianchi::USSD::Engine.start(params, provider: :africastalking) do
         # e.g menu :main, options
       end
     end
@@ -52,11 +53,9 @@ This creates a `ussd/main_menu/page_1` file in the project root directory. Here'
 module USSD
   module MainMenu
     class Page1 < Bianchi::USSD::Page
-      def request
-      end
+      def request; end
 
-      def response
-      end
+      def response; end
     end
   end
 end
@@ -183,8 +182,8 @@ Here's an example of how you can retrieve the provider prompt data in your USSD
 module USSD
   class Engine
     def self.start(params)
-      Bianchi::USSD::Engine.start(params, provider: :africa_is_talking) do
-          menu :main, options
+      Bianchi::USSD::Engine.start(params, provider: :africastalking) do
+          menu :main, initial: true
           menu :greetings
           menu :repeat
       end

data/bianchi.gemspec

@@ -8,7 +8,10 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Dapilah Sydney"]
   spec.email         = ["dapilah.sydney@gmail.com"]
 
-  spec.summary       = "Write a short summary, because RubyGems requires one."
+  spec.summary       = <<~MSG
+    A DSL (Domain-Specific Language) and a minimalist framework in Ruby, tailored for USSD development.
+  MSG
+
   spec.homepage      = "https://github.com/SydDaps/Bianchi"
   spec.license       = "MIT"
   spec.required_ruby_version = Gem::Requirement.new(">= 3.0.0")
@@ -34,4 +37,5 @@ Gem::Specification.new do |spec|
   spec.add_dependency "json"
   spec.add_dependency "redis"
   spec.add_dependency "thor"
+  spec.metadata["rubygems_mfa_required"] = "true"
 end

data/lib/bianchi/cli/main.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+# rubocop:disable  Metrics/ParameterLists
 module Bianchi
   module Cli
     class Main < Thor
@@ -19,7 +20,7 @@ module Bianchi
       desc "setup", "sets up a new ussd project"
       long_desc <<-LONG_DESC
         Usage: bianchi setup optional(-p|--provider)
-        \x5 Providers: [:africa_is_talking]
+        \x5 Providers: [:africa_is_talking, :appsnmobile]
         \x5 Example: `bianchi setup`
         \x5 Example: `bianchi setup -p :africa_is_talking`
 
@@ -27,7 +28,7 @@ module Bianchi
       method_option :provider, aliases: "-p", type: :string, desc: "Set up ussd project for provider"
       def setup
         @provider = options[:provider]
-        unless %w[africastalking none].include? @provider
+        unless %w[africastalking none appsnmobile].include? @provider
           say("Error: provider #{@provider} is not yet configured.", :yellow)
           exit(1)
         end
@@ -62,3 +63,4 @@ module Bianchi
     end
   end
 end
+# rubocop:enable  Metrics/ParameterLists

data/lib/bianchi/ussd/engine.rb

@@ -110,10 +110,7 @@ module Bianchi
                 "#{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
+        page.call(session, action)
       end
     end
   end

data/lib/bianchi/ussd/{errors.rb → exceptions.rb}

@@ -6,5 +6,7 @@ module Bianchi
     class PageLoadError < StandardError; end
     class MethodNameError < StandardError; end
     class ProviderError < StandardError; end
+    class ProviderError < StandardError; end
+    class DispatchRenderException < StandardError; end
   end
 end

data/lib/bianchi/ussd/page.rb

@@ -11,6 +11,15 @@ module Bianchi
         @session = session
       end
 
+      def self.call(session, action)
+        new(session).tap do |p|
+          p.ensure_methods_defined(%i[request response])
+          p.send(action)
+        rescue DispatchRenderException
+          p
+        end
+      end
+
       def render(body, options = {})
         raise ArgumentError, "render body expected to be a string" unless body.is_a? String
 
@@ -22,6 +31,8 @@ module Bianchi
           s.page_number = self.class.name.split("::").last
           s.store.track_session
         end
+
+        raise DispatchRenderException
       end
 
       def load_page(page_number, menu_name)

data/lib/bianchi/ussd/page_delegators.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+# rubocop:disable Style/MissingRespondToMissing
 module Bianchi
   module USSD
     module PageDelegators
@@ -100,3 +101,4 @@ module Bianchi
     end
   end
 end
+# rubocop:enable Style/MissingRespondToMissing

data/lib/bianchi/ussd/provider_configurations.rb

@@ -4,11 +4,13 @@ module Bianchi
   module USSD
     module ProviderConfigurations
       include ProviderParsers::Africastalking
+      include ProviderParsers::Appsnmobile
 
       def parse_params(params)
         provider_parsers = {
           none: proc { params },
-          africastalking: proc { africastalking_params_parser(params) }
+          africastalking: proc { africastalking_params_parser(params) },
+          appsnmobile: proc { appsnmobile_params_parser(params) }
         }.with_indifferent_access
 
         parser = provider_parsers[@provider]
@@ -21,7 +23,8 @@ module Bianchi
       def parser_prompt_data(prompt_data)
         provider_parsers = {
           none: proc { prompt_data },
-          africastalking: proc { africastalking_prompt_data_parser(prompt_data) }
+          africastalking: proc { africastalking_prompt_data_parser(prompt_data) },
+          appsnmobile: proc { appsnmobile_prompt_data_parser(prompt_data) }
         }.with_indifferent_access
 
         parser = provider_parsers[@provider]

data/lib/bianchi/ussd/provider_parsers/africastalking.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Bianchi
   module USSD
     module ProviderParsers
@@ -25,4 +27,4 @@ module Bianchi
       end
     end
   end
-end
+end

data/lib/bianchi/ussd/provider_parsers/appsnmobile.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module Bianchi
+  module USSD
+    module ProviderParsers
+      module Appsnmobile
+        def appsnmobile_params_parser(params)
+          required_params = %w[session_id msisdn msg_type ussd_body nw_code service_code]
+          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["session_id"],
+            mobile_number: params["msisdn"],
+            activity_state: return_activity_state(params["msg_type"]),
+            input_body: params["ussd_body"],
+            nw_code: params["nw_code"],
+            service_code: params["service_code"]
+          }
+        end
+
+        def appsnmobile_prompt_data_parser(prompt_data)
+          msg_type = prompt_data["activity_state"] == :await ? "1" : "2"
+
+          {
+            session_id: prompt_data["session_id"],
+            msisdn: prompt_data["mobile_number"],
+            msg_type: msg_type,
+            ussd_body: prompt_data["body"],
+            nw_code: prompt_data["nw_code"],
+            service_code: prompt_data["service_code"]
+          }.to_json
+        end
+
+        def return_activity_state(msg_type)
+          case msg_type
+          when "0"
+            "initial"
+          when "1"
+            "subsequent"
+          else
+            raise ArgumentError, "#{@provider} sent in an unknown message type or msg_type"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/bianchi/ussd/store.rb

@@ -6,7 +6,13 @@ module Bianchi
       attr_reader :session
 
       def initialize(session)
-        @redis = Redis.new(url: ENV.fetch("REDIS_URL", nil))
+        redis_url = ENV.fetch("REDIS_URL", nil)
+        unless redis_url.present?
+          raise ArgumentError,
+                "environment variable REDIS_URL required to track engine session."
+        end
+
+        @redis = Redis.new(url: redis_url)
         @session = session
       end
 

data/lib/bianchi/version.rb

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

data/lib/bianchi.rb

@@ -7,6 +7,7 @@ require "thor"
 
 require_relative "bianchi/version"
 require_relative "bianchi/ussd/provider_parsers/africastalking"
+require_relative "bianchi/ussd/provider_parsers/appsnmobile"
 require_relative "bianchi/ussd/provider_configurations"
 require_relative "bianchi/ussd/engine"
 require_relative "bianchi/ussd/menu"
@@ -14,7 +15,7 @@ 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"
+require_relative "bianchi/ussd/exceptions"
 
 # cli
 require "bianchi/cli/main"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bianchi
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.3
 platform: ruby
 authors:
 - Dapilah Sydney
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-01-28 00:00:00.000000000 Z
+date: 2024-02-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -74,9 +74,11 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ci.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
+- ".vscode/settings.json"
 - CODE_OF_CONDUCT.md
 - Gemfile
 - Gemfile.lock
@@ -93,12 +95,13 @@ files:
 - 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/exceptions.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/provider_parsers/africastalking.rb
+- lib/bianchi/ussd/provider_parsers/appsnmobile.rb
 - lib/bianchi/ussd/session.rb
 - lib/bianchi/ussd/store.rb
 - lib/bianchi/version.rb
@@ -112,6 +115,7 @@ metadata:
   homepage_uri: https://github.com/SydDaps/Bianchi
   source_code_uri: https://github.com/SydDaps/Bianchi
   changelog_uri: https://rubygems.org/
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -130,5 +134,6 @@ requirements: []
 rubygems_version: 3.2.3
 signing_key:
 specification_version: 4
-summary: Write a short summary, because RubyGems requires one.
+summary: A DSL (Domain-Specific Language) and a minimalist framework in Ruby, tailored
+  for USSD development.
 test_files: []