joy_ussd_engine 0.1.0

data/lib/joy_ussd_engine/session_manager.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module JoyUssdEngine::SessionManager
+    def expire_mins
+      @selected_provider.expiration.blank? ? 60.seconds : @selected_provider.expiration
+    end
+  
+    def user_mobile_number
+      @user_mobile_number ||= get_state[:"session_id"]
+    end
+  
+    # Retrive Session Data
+    def get_state
+      session_id = params["session_id"]
+      REDIS.with do |conn|
+        data = conn.get(session_id)
+        return {} if data.blank?
+        JSON.parse(data, symbolize_names: true)
+      end
+    end
+  
+    # Store USSD sessions in Redis with Expiry
+    def set_state(payload = {})
+      session_id = params["session_id"]
+      current_data = get_state
+      REDIS.with do |conn|
+        payload = current_data.merge(params.merge(payload))
+        conn.set(session_id, payload.to_json)
+        conn.expire(session_id, expire_mins)
+      end
+    end
+  
+    # Delete Session payload
+    def reset_state
+      session_id = params["session_id"]
+      REDIS.with do |conn|
+        conn.del(session_id)
+      end
+    end
+  end
+  

data/lib/joy_ussd_engine/version.rb

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

data/lib/joy_ussd_engine.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+require_relative "joy_ussd_engine/version"
+require 'joy_ussd_engine/menu'
+require 'joy_ussd_engine/paginate_menu'
+require 'joy_ussd_engine/data_transformer'
+require 'joy_ussd_engine/session_manager'
+
+
+module JoyUssdEngine
+  class Error < StandardError; end
+  class Core
+        include JoyUssdEngine::SessionManager
+        
+        attr_reader :params, :selected_provider
+        attr_accessor :current_menu, :last_menu
+
+        def initialize(params, provider, start_point: nil, end_point: nil )
+
+            # gets provider currently in use and convert params to match ussd engines params
+            @selected_provider =  provider.new(self)
+            convert_params =  @selected_provider.send("request_params",params)
+            @params = convert_params
+            @last_menu = end_point.to_s
+            @data = get_state
+            # handles ending or terminating ussd based on provider response (HUBTEL, TWILIO, ETC.)
+            # If a particular provider returns some sort of response that can terminate the app we do that check here
+            return @current_menu = end_point.to_s if @selected_provider.send("app_terminator", params) || @data[:ClientState] == 'EndJoyUssdEngineiuewhjsdj'
+            
+            @current_menu = @data[:ClientState].blank? ? start_point.to_s : @data[:ClientState]
+        end
+
+        def load_menu(name)
+            menu_name =  name.constantize.new(self) 
+            menu_name.send("execute")
+        end
+
+        def load_from_paginate_menu(name)
+          menu_name =  name.constantize.new(self) 
+          menu_name.send("run")
+        end
+
+        def process
+            load_menu(@current_menu)
+        end
+  end
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: joy_ussd_engine
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Caleb Mantey
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2022-03-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: will_paginate
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.3.0
+description: A ruby library for building text based applications rapidly. It supports
+  building whatsapp, ussd, telegram and various text or chat applications that communicate
+  with your rails backend. With this library you can target multiple platforms(whatsapp,
+  ussd, telegram, etc.) at once with just one codebase.
+email:
+- manteycaleb@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".DS_Store"
+- ".gitignore"
+- ".rubocop.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- images/lifecycle.jpg
+- images/menu_doc1.png
+- images/menu_doc2.png
+- images/menu_items_routes.png
+- images/paginate_item_selected.png
+- images/paginate_menu1.png
+- images/paginate_menu2.png
+- images/transactions_menu.png
+- joy_ussd_engine.gemspec
+- lib/generators/joy_data_transformer/USAGE
+- lib/generators/joy_data_transformer/joy_data_transformer_generator.rb
+- lib/generators/joy_data_transformer/templates/joy_transformer_template.template
+- lib/generators/joy_menu/USAGE
+- lib/generators/joy_menu/joy_menu_generator.rb
+- lib/generators/joy_menu/templates/joy_menu_template.template
+- lib/generators/joy_paginate_menu/USAGE
+- lib/generators/joy_paginate_menu/joy_paginate_menu_generator.rb
+- lib/generators/joy_paginate_menu/templates/joy_paginate_menu_template.template
+- lib/generators/joy_route_menu/USAGE
+- lib/generators/joy_route_menu/joy_route_menu_generator.rb
+- lib/generators/joy_route_menu/templates/joy_route_menu_template.template
+- lib/joy_ussd_engine.rb
+- lib/joy_ussd_engine/data_transformer.rb
+- lib/joy_ussd_engine/menu.rb
+- lib/joy_ussd_engine/paginate_menu.rb
+- lib/joy_ussd_engine/session_manager.rb
+- lib/joy_ussd_engine/version.rb
+homepage: https://github.com/Caleb-Mantey/joy_ussd_engine
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/Caleb-Mantey/joy_ussd_engine
+  source_code_uri: https://github.com/Caleb-Mantey/joy_ussd_engine
+  changelog_uri: https://github.com/Caleb-Mantey/joy_ussd_engine/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.9
+signing_key:
+specification_version: 4
+summary: A gem for building ussd and text based applications rapidly.
+test_files: []