joy_ussd_engine 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 87daa4c0dae57919366d4454695275f33052d7505412c80d19cf571e85e1ea91
-  data.tar.gz: 7d0c6af6ff5792d2bbabc646ab0c5d720ae72eafbe0138dcf7ff9846e097065b
+  metadata.gz: a604dfd6d12b293936040a84184ef0c2e9db87481306f092bfda2d7f34fc24cc
+  data.tar.gz: 8c385b17128c1617228b04edabc55b17c77dad1f2629bff5bf32d7f441f53cf0
 SHA512:
-  metadata.gz: eb4c5b98ce92119a64af3a8983f03282e653fc1728f1c003f61e35a515dade0bf8187f4016cf95103ccdd0222e43f742143d39088f065e08072ba666f4c54c3e
-  data.tar.gz: 74e3b79758b858bbaece5fc524cee1ba3a3eee99e0322013cf16d331f2a9533f961ddd5cc24722f8140e1a0424d9f00e15cdfe37e1358a0ea1c1bdf66670bdfd
+  metadata.gz: b19012528c1a3e8fd021a16fc2953877fec56f9f543d1092e53d0452e365cc16699e0190374f11581ad23def254f9494557a285d386269dca709630fe254a509
+  data.tar.gz: d3ba5cdaaf1072085c0c13574d06900a9653cb97c0b3f70c0654b5a018f20b74a03dc9de09c7ca330b8dafeaefeaf6ed4c56bf61661f0c0aa8ea4b0fc5ebcef3

data/Gemfile.lock

@@ -8,13 +8,28 @@ GEM
   remote: https://rubygems.org/
   specs:
     ast (2.4.2)
+    diff-lcs (1.5.0)
     parallel (1.21.0)
     parser (3.0.2.0)
       ast (~> 2.4.1)
     rainbow (3.0.0)
     rake (13.0.6)
+    redis (4.6.0)
     regexp_parser (2.2.1)
     rexml (3.2.5)
+    rspec (3.11.0)
+      rspec-core (~> 3.11.0)
+      rspec-expectations (~> 3.11.0)
+      rspec-mocks (~> 3.11.0)
+    rspec-core (3.11.0)
+      rspec-support (~> 3.11.0)
+    rspec-expectations (3.11.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-mocks (3.11.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-support (3.11.0)
     rubocop (1.20.0)
       parallel (~> 1.10)
       parser (>= 3.0.0.0)
@@ -36,6 +51,8 @@ PLATFORMS
 DEPENDENCIES
   joy_ussd_engine!
   rake (~> 13.0)
+  redis
+  rspec
   rubocop (~> 1.7)
 
 BUNDLED WITH

data/README.md

@@ -29,6 +29,9 @@ A ruby library for building text based applications rapidly. It supports buildin
       - [PaginateMenu Properties](#paginatemenu-properties)
       - [PaginateMenu Methods](#paginatemenu-methods)
       - [PaginateMenu Example](#paginatemenu-example)
+  - [Transformer Configs](#transformer-configs)
+    - [Hubtel Transformer](#hubtel-transformer)
+    - [Twilio Transformer](#twilio-transformer)
   - [Development](#development)
   - [Contributing](#contributing)
   - [License](#license)
@@ -546,6 +549,108 @@ When th user selects an item in the `PaginateMenu` we get the users selection wi
 
 ![paginate_item_select](images/paginate_item_selected.png)
 
+## Transformer Configs
+
+Transformer configs for various providers. This configs can be used if you use any of these providers.
+
+### Hubtel Transformer
+
+```ruby
+class HubtelTransformer < JoyUssdEngine::DataTransformer
+    # Tranforms request and response payload between hubtel and our application
+    def request_params(params)
+        {
+            session_id: params[:Mobile],
+            message: params[:Message],
+            ClientState: params[:ClientState],
+            Type: params[:Type]
+            data: params
+        }
+    end
+
+    def app_terminator(params)
+        params[:Type] == 'Release' || (params[:Type] != "Initiation" && @context.get_state.blank?)
+    end
+
+    def response(message, client_state)
+        {
+            Type: "Response",
+            Message: message,
+            ClientState: client_state
+        }
+    end
+
+    def release(message)
+        {
+            Type: "Release",
+            Message: message,
+            ClientState: "End"
+        }
+    end
+
+    def expiration
+        60.seconds
+    end
+end
+```
+
+### Twilio Transformer
+
+```ruby
+class TwilioTransformer < JoyUssdEngine::DataTransformer
+    ACCOUNT_SID = "932843hwhjewhje7388"
+    AUTH_TOKEN = "3473847hewjrejrheeee"
+
+    def client
+        @client ||= Twilio::REST::Client.new(ACCOUNT_SID, AUTH_TOKEN)
+    end
+
+    # Tranforms request and response payload between twilio and our application
+    def request_params(params)
+        {
+            session_id: "0#{params[:From].last(9)}",
+            message: params[:Body],
+            Mobile: "0#{params[:From].last(9)}",
+            data: params
+        }
+    end
+
+    def app_terminator(params)
+        params[:Body] == 'end'
+    end
+
+    def response(message, client_state)
+        client.messages.create(
+            from: from,
+            to: to,
+            body: message
+        )
+        {message: message}
+    end
+
+    def release(message)
+        client.messages.create(
+            from: from,
+            to: to,
+            body: message
+        )
+        {message: message}
+    end
+
+    def expiration
+        # set expiration for different providers
+    end
+
+    def to
+        "whatsapp:+233#{@context.params[:Mobile].last(9)}"
+    end
+
+    def from
+        'whatsapp:+14155238886'
+    end
+end
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/joy_ussd_engine.gemspec

@@ -37,6 +37,8 @@ Gem::Specification.new do |spec|
   # Uncomment to register a new dependency of your gem
   # spec.add_dependency "example-gem", "~> 1.0"
   spec.add_dependency "will_paginate", "~> 3.3.0"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "redis"
 
   # For more information and examples about making a new gem, checkout our
   # guide at: https://bundler.io/guides/creating_gem.html

data/lib/joy_ussd_engine/data_transformer.rb

@@ -8,7 +8,7 @@ module JoyUssdEngine
             # what our application can understand
             attr_reader :context
             def initialize(context)
-                @context = context
+                @context = context 
             end
 
             def request_params(params)
@@ -30,6 +30,7 @@ module JoyUssdEngine
 
             def expiration
                 # set expiration for different providers
+                @context.expiration.blank? ? 60.seconds : @expiration
             end
         end
 end

data/lib/joy_ussd_engine/hubtel_transformer.rb

@@ -0,0 +1,36 @@
+require 'data_transformer'
+
+module JoyUssdEngine
+    class HubtelTransformer < JoyUssdEngine::DataTransformer
+        # Tranforms request and response payload between hubtel and our application
+        def request_params(params)
+            {
+                session_id: params[:Mobile],
+                message: params[:Message],
+                ClientState: params[:ClientState],
+                Type: params[:Type]
+                data: params
+            }
+        end
+
+        def app_terminator(params)
+            params[:Type] == 'Release' || (params[:Type] != "Initiation" && @context.get_state.blank?)
+        end
+
+        def response(message, client_state)
+            {
+                Type: "Response",
+                Message: message,
+                ClientState: client_state
+            }
+        end
+    
+        def release(message)
+            {
+                Type: "Release",
+                Message: message,
+                ClientState: "EndJoyUssdEngine"
+            }
+        end
+    end
+end

data/lib/joy_ussd_engine/menu.rb

@@ -31,7 +31,7 @@ module JoyUssdEngine
         def joy_release(error_message = "")
             @context.reset_state
             { 
-                ClientState: "EndJoyUssdEngineiuewhjsdj",
+                ClientState: "EndJoyUssdEngine",
                 data: @context.selected_provider.send("release", error_message.blank? ? @menu_text : error_message)
             }
         end
@@ -156,8 +156,8 @@ module JoyUssdEngine
             response = render
             response = response.blank? ? joy_response(current_client_state) : response
             after_render
-            save_state(response[:ClientState]) if response[:ClientState] != "EndJoyUssdEngineiuewhjsdj"
-            @context.reset_state if response[:ClientState] == "EndJoyUssdEngineiuewhjsdj" 
+            save_state(response[:ClientState]) if response[:ClientState] != "EndJoyUssdEngine"
+            @context.reset_state if response[:ClientState] == "EndJoyUssdEngine" 
             response[:data].blank? ? response : response[:data]
         end
 
@@ -193,8 +193,8 @@ module JoyUssdEngine
             response = render
             response = response.blank? ? joy_response(@current_client_state) : response
             after_render
-            save_state(response[:ClientState]) if response[:ClientState] != "EndJoyUssdEngineiuewhjsdj"
-            @context.reset_state if response[:ClientState] == "EndJoyUssdEngineiuewhjsdj" 
+            save_state(response[:ClientState]) if response[:ClientState] != "EndJoyUssdEngine"
+            @context.reset_state if response[:ClientState] == "EndJoyUssdEngine" 
             response
         end
 
@@ -210,8 +210,8 @@ module JoyUssdEngine
             response = render
             response = response.blank? ? joy_response(@current_client_state) : response
             after_render
-            save_state(response[:ClientState]) if response[:ClientState] != "EndJoyUssdEngineiuewhjsdj"
-            @context.reset_state if response[:ClientState] == "EndJoyUssdEngineiuewhjsdj" 
+            save_state(response[:ClientState]) if response[:ClientState] != "EndJoyUssdEngine"
+            @context.reset_state if response[:ClientState] == "EndJoyUssdEngine" 
             response[:data].blank? ? response : response[:data]
         end
     end

data/lib/joy_ussd_engine/paginate_menu.rb

@@ -185,8 +185,8 @@ module JoyUssdEngine
             response = render
             response = response.blank? ? joy_response(@current_client_state) : response
             after_render
-            save_state(response[:ClientState]) if response[:ClientState] != "EndJoyUssdEngineiuewhjsdj"
-            @context.reset_state if response[:ClientState] == "EndJoyUssdEngineiuewhjsdj" 
+            save_state(response[:ClientState]) if response[:ClientState] != "EndJoyUssdEngine"
+            @context.reset_state if response[:ClientState] == "EndJoyUssdEngine" 
             response[:data].blank? ? response : response[:data]
         end
     end

data/lib/joy_ussd_engine/version.rb

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

data/lib/joy_ussd_engine.rb

@@ -5,6 +5,7 @@ require 'joy_ussd_engine/menu'
 require 'joy_ussd_engine/paginate_menu'
 require 'joy_ussd_engine/data_transformer'
 require 'joy_ussd_engine/session_manager'
+require 'joy_ussd_engine/hubtel_transformer'
 
 
 module JoyUssdEngine
@@ -13,11 +14,12 @@ module JoyUssdEngine
         include JoyUssdEngine::SessionManager
         
         attr_reader :params, :selected_provider
-        attr_accessor :current_menu, :last_menu
+        attr_accessor :current_menu, :last_menu, :expiration
 
-        def initialize(params, provider, start_point: nil, end_point: nil )
+        def initialize(params, provider, start_point: nil, end_point: nil, expiration: nil )
 
             # gets provider currently in use and convert params to match ussd engines params
+            @expiration = expiration
             @selected_provider =  provider.new(self)
             convert_params =  @selected_provider.send("request_params",params)
             @params = convert_params
@@ -25,7 +27,7 @@ module JoyUssdEngine
             @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'
+            return @current_menu = end_point.to_s if @selected_provider.send("app_terminator", params) || @data[:ClientState] == 'EndJoyUssdEngine'
             
             @current_menu = @data[:ClientState].blank? ? start_point.to_s : @data[:ClientState]
         end
@@ -43,5 +45,9 @@ module JoyUssdEngine
         def process
             load_menu(@current_menu)
         end
+
+        def expiration
+          @expiration
+        end
   end
 end

data/spec/joy_ussd_engine_spec.rb

@@ -0,0 +1,7 @@
+require "spec_helper"
+
+RSpec.describe JoyUssdEngine do
+  it "has a version number" do
+    expect(JoyUssdEngine::VERSION).not_to be nil
+  end
+end

data/spec/joy_ussd_engine_transformer.spec

@@ -0,0 +1,26 @@
+require "spec_helper"
+
+RSpec.describe JoyUssdEngine::DataTransformer do
+
+
+
+  it "saves the context object" do
+    expect(@transformer_context).to eq(nil)
+  end
+
+  it "returns false when calling the appterminator method" do
+    expect(@transformer_context).to eq(@context)
+  end
+
+  it 'transforms an incoming request params' do
+    params = { Message: "hello", phone: "+233578876155" }
+    allow(@data_transformer).to receive(:request_params).with(params).and_return({message: params[:Message], session_id: params[:phone]})
+    expect(@data_transformer.request_params(params)).to eq({message: "hello", session_id: "+233578876155"})
+  end
+
+  it 'returns false when app_terminator is called' do
+    allow(@data_transformer).to receive(:app_terminator).and_call_original
+    expect(@data_transformer.app_terminator({})).to eq(false)
+  end
+  
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+require 'bundler/setup'
+Bundler.setup
+
+require 'joy_ussd_engine' # and any other gems you need
+
+RSpec.configure do |config|
+  # some (optional) config here
+  @params = { Message: "hello", phone: "+233578876155" }
+  @context = JoyUssdEngine::Core
+  @data_transformer = JoyUssdEngine::DataTransformer.new(@context)
+  @transformer_context = @data_transformer.context
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: joy_ussd_engine
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Caleb Mantey
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-03-17 00:00:00.000000000 Z
+date: 2022-04-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: will_paginate
@@ -24,6 +24,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 3.3.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  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: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '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,
@@ -66,12 +94,16 @@ files:
 - 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/hubtel_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
 - pkg/joy_ussd_engine-0.1.1.gem
 - pkg/joy_ussd_engine-0.1.2.gem
+- spec/joy_ussd_engine_spec.rb
+- spec/joy_ussd_engine_transformer.spec
+- spec/spec_helper.rb
 homepage: https://github.com/Caleb-Mantey/joy_ussd_engine
 licenses:
 - MIT