joy_ussd_engine 0.1.6 → 0.1.9

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 355763a76b480555d7caa41b14aa790feaab1b1808a58203f506ad35b79dac91
4
- data.tar.gz: bca0bb09e1041f4e3d296cca2d09cc543d129f1a49667ca00c09357af6919455
3
+ metadata.gz: ade8de5e760c7b722295f11d76e842bbcec0c0fb8bebddf011be1ca90bf7be2f
4
+ data.tar.gz: a6b4b4ff1caa34b30612fe60dd8fbc4bef81f32e4493bf872f45ba75ee7c104d
5
5
  SHA512:
6
- metadata.gz: 456e96399fca799748e6172df21f3be5de3b4b4d6c9e58fc81d1b37c750ea0b83f619ca8bd28228922619964f3d2db4ccd4d37a7e1daaf6e87c6578586683752
7
- data.tar.gz: 0a7097d5093c16fb6e828161e4c494f6d4c8cb10c5c3015401fadf18a27621db7d61d50f399e736f26ec91f83aa597c21f9d6aaf345e6e48282ba250acf0ea34
6
+ metadata.gz: b3c507ae3094f6da68393f5fa99bf0e32db83eb1c38926702a89a284378eae506629decdc9cdd50fe06a22bf9b91e7d968d4392cc20b311fe7fa60cfcb827111
7
+ data.tar.gz: 865bade511b0a484f4da15eb98b2076d9bcfdae40327b18c13ea183a0d4f70b4da7066e2424d154fb1c1a6ac660a2f3cb9840a975ba5cdc26e83ab2868a804c2
data/Gemfile.lock CHANGED
@@ -1,7 +1,7 @@
1
1
  PATH
2
2
  remote: .
3
3
  specs:
4
- joy_ussd_engine (0.1.2)
4
+ joy_ussd_engine (0.1.9)
5
5
  will_paginate (~> 3.3.0)
6
6
 
7
7
  GEM
data/README.md CHANGED
@@ -89,7 +89,7 @@ class MyController < ApplicationController
89
89
  skip_before_action :verify_authenticity_token
90
90
 
91
91
  def create
92
- joy_ussd_engine = JoyUssdEngine::Core.new(ussd_params, Ussd::Transformers::HubtelTransformer, start_point: Ussd::Menus::StartMenu, end_point: Ussd::Menus::EndMenu)
92
+ joy_ussd_engine = JoyUssdEngine::Core.new(ussd_params, JoyUssdEngine::HubtelTransformer, start_point: Ussd::Menus::StartMenu, end_point: Ussd::Menus::EndMenu)
93
93
  response = joy_ussd_engine.process
94
94
  render json: response, status: :created
95
95
  end
@@ -146,7 +146,8 @@ class Ussd::Transformers::HubtelTransformer < JoyUssdEngine::DataTransformer
146
146
  session_id: params[:Mobile],
147
147
  message: params[:Message],
148
148
  ClientState: params[:ClientState],
149
- Type: params[:Type]
149
+ Type: params[:Type],
150
+ data: params
150
151
  }
151
152
  end
152
153
 
@@ -1,7 +1,4 @@
1
1
  class Ussd::Menus::<%= menu_name.camelcase %>Menu < JoyUssdEngine::Menu
2
- def on_validate
3
- # User input validation
4
- end
5
2
 
6
3
  def before_render
7
4
  # Implement before call backs
@@ -9,9 +6,20 @@ class Ussd::Menus::<%= menu_name.camelcase %>Menu < JoyUssdEngine::Menu
9
6
  @menu_text = "Welcome to the <%= menu_name.camelcase %> menu"
10
7
  end
11
8
 
9
+ def on_validate
10
+ # User input validation
11
+ # if @context.get_state[:<%= menu_name.underscore %>] == "Hello"
12
+ # @field_error = true
13
+ # @error_text = "Sorry! Make sure you entered `Hello`."
14
+ # end
15
+ end
16
+
12
17
  def on_error
13
- # Render error
18
+ # Render error and wait for new user input
14
19
  # @menu_text = "#{@error_text}\n#{@menu_text }"
20
+
21
+ # OR Render Error and Terminate App Session
22
+ # return raise_error(@error_text)
15
23
  end
16
24
 
17
25
  def after_render
@@ -1,40 +1,48 @@
1
1
  class Ussd::Menus::<%= paginating_menu_name.camelcase %>Menu < JoyUssdEngine::PaginateMenu
2
- def on_validate
3
- # User input validation
4
- end
5
2
 
6
3
  def before_render
7
4
  # Implement before call backs
8
5
  @field_name="<%= paginating_menu_name.underscore %>"
9
6
 
10
- # Store paginating items in @paginating_items array variable
11
- # @paginating_items = [
12
- # {title: "Data Structures", item: {id: 1}},
13
- # {title: "Excel Programming", item: {id: 2}},
14
- # {title: "Economics", item: {id: 3}},
15
- # {title: "Big Bang", item: {id: 4}},
16
- # {title: "Democracy Building", item: {id: 5}},
17
- # {title: "Python for Data Scientist", item: {id: 6}},
18
- # {title: "Money Mind", item: {id: 7}},
19
- # {title: "Design Patterns In C#", item: {id: 8}}
20
- # ]
21
-
22
- # Call the paginate method and store the return value in paginated_list
23
- # paginated_list = paginate
24
-
25
- # Use the show menu method to get the paginated list items and return them as text and store in @menu_text
26
- # @menu_text = show_menu(paginated_list, title: "Welcome to the <%= paginating_menu_name.camelcase %> menu", key: 'title')
27
-
28
- # Get the selected item from the user with the `get_selected_item` method and save in state with @context.set_state
29
- # if has_selected?
30
- # selected_book = get_selected_item
31
- # @context.set_state(selected_book: selected_book)
32
- # end
7
+ # Store paginating items in @paginating_items array variable
8
+ # @paginating_items = [
9
+ # {title: "Data Structures", item: {id: 1}},
10
+ # {title: "Excel Programming", item: {id: 2}},
11
+ # {title: "Economics", item: {id: 3}},
12
+ # {title: "Big Bang", item: {id: 4}},
13
+ # {title: "Democracy Building", item: {id: 5}},
14
+ # {title: "Python for Data Scientist", item: {id: 6}},
15
+ # {title: "Money Mind", item: {id: 7}},
16
+ # {title: "Design Patterns In C#", item: {id: 8}}
17
+ # ]
18
+
19
+ # Call the paginate method and store the return value in paginated_list
20
+ # paginated_list = paginate
21
+
22
+ # Use the show menu method to get the paginated list items and return them as text and store in @menu_text
23
+ # @menu_text = show_menu(paginated_list, title: "Welcome to the <%= paginating_menu_name.camelcase %> menu", key: 'title')
24
+
25
+ # Get the selected item from the user with the `get_selected_item` method and save in state with @context.set_state
26
+ # if has_selected?
27
+ # selected_book = get_selected_item
28
+ # @context.set_state(selected_book: selected_book)
29
+ # end
30
+ end
31
+
32
+ def on_validate
33
+ # User input validation
34
+ # if @context.get_state[:<%= menu_name.underscore %>] == "Hello"
35
+ # @field_error = true
36
+ # @error_text = "Sorry! Make sure you entered `Hello`."
37
+ # end
33
38
  end
34
39
 
35
40
  def on_error
36
- # Render error
41
+ # Render error and wait for new user input
37
42
  # @menu_text = "#{@error_text}\n#{@menu_text }"
43
+
44
+ # OR Render Error and Terminate App Session
45
+ # return raise_error(@error_text)
38
46
  end
39
47
 
40
48
  def after_render
@@ -1,11 +1,7 @@
1
1
  class Ussd::Menus::<%= menu_name.camelcase %>Menu < JoyUssdEngine::Menu
2
- def on_validate
3
- # User input validation
4
- end
5
-
6
2
  def before_render
7
3
  # Implement before call backs
8
- # @field_name="<%= menu_name.underscore %>"
4
+ @field_name="<%= menu_name.underscore %>"
9
5
 
10
6
  # title = "Welcome to the <%= menu_name.camelcase %> menu"
11
7
 
@@ -20,9 +16,20 @@ class Ussd::Menus::<%= menu_name.camelcase %>Menu < JoyUssdEngine::Menu
20
16
  # @menu_text = show_menu(title)
21
17
  end
22
18
 
19
+ def on_validate
20
+ # User input validation
21
+ # if @context.get_state[:<%= menu_name.underscore %>] == "Hello"
22
+ # @field_error = true
23
+ # @error_text = "Sorry! Make sure you entered `Hello`."
24
+ # end
25
+ end
26
+
23
27
  def on_error
24
- # Render error
28
+ # Render error and wait for new user input
25
29
  # @menu_text = "#{@error_text}\n#{@menu_text }"
30
+
31
+ # OR Render Error and Terminate App Session
32
+ # return raise_error(@error_text)
26
33
  end
27
34
 
28
35
  def after_render
@@ -105,6 +105,8 @@ module JoyUssdEngine
105
105
  return if @skip_save
106
106
  data = @context.get_state
107
107
  @previous_client_state = @current_client_state
108
+ return if data[:"#{@field_name}"].present?
109
+ return @context.set_state({ClientState: state, PrevClientState: @previous_client_state}) if @field_name.blank?
108
110
  # @context.set_state({"#{data[:field]}".to_sym => @context.params[:message]}) unless data[:field].blank?
109
111
  @context.set_state({ClientState: state, PrevClientState: @previous_client_state , field: @field_name, field_error: @field_error, error_text: @error_text})
110
112
  end
@@ -112,9 +114,26 @@ module JoyUssdEngine
112
114
  def save_field_value
113
115
  data = get_previous_state
114
116
  return if @skip_save
117
+ return if data[:"#{data[:field]}"].present?
115
118
  @context.set_state({"#{data[:field]}".to_sym => @context.params[:message]}) unless data[:field].blank?
116
119
  end
117
120
 
121
+ # def save_state_load_menu(state)
122
+ # return if @skip_save
123
+ # data = @context.get_state
124
+ # @previous_client_state = @current_client_state
125
+ # # @context.set_state({"#{data[:field]}".to_sym => @context.params[:message]}) unless data[:field].blank?
126
+ # return if data[:"#{@field_name}"].present?
127
+ # @context.set_state({ClientState: state, PrevClientState: @previous_client_state , field: @field_name, field_error: @field_error, error_text: @error_text})
128
+ # end
129
+
130
+ # def save_field_value_load_menu
131
+ # data = get_previous_state
132
+ # return if @skip_save
133
+ # return if data[:"#{data[:field]}"].present?
134
+ # @context.set_state({"#{data[:field]}".to_sym => @context.params[:message]}) unless data[:field].blank?
135
+ # end
136
+
118
137
  def get_previous_state
119
138
  data = @context.get_state
120
139
  @previous_client_state = data[:PrevClientState]
@@ -148,10 +167,16 @@ module JoyUssdEngine
148
167
  joy_release(@error_text)
149
168
  end
150
169
 
170
+ def remove_error_field
171
+ data = @context.get_state
172
+ @context.set_state({"#{@field_name}".to_sym => nil})
173
+ end
174
+
151
175
  def render_field_error
152
176
  before_show_menu
153
177
  before_render
154
178
  on_error
179
+ remove_error_field
155
180
  return render_menu_error[:data] if menu_error
156
181
  response = render
157
182
  response = response.blank? ? joy_response(current_client_state) : response
@@ -184,12 +209,12 @@ module JoyUssdEngine
184
209
  def run
185
210
  save_field_value
186
211
  do_validation
187
- before_show_menu
188
- before_render
189
212
  return render_menu_error[:data] if @menu_error
190
213
  if allow_validation
191
214
  return render_previous if @previous_menu.field_error
192
215
  end
216
+ before_show_menu
217
+ before_render
193
218
  response = render
194
219
  response = response.blank? ? joy_response(@current_client_state) : response
195
220
  after_render
@@ -201,12 +226,12 @@ module JoyUssdEngine
201
226
  def execute
202
227
  save_field_value
203
228
  do_validation
204
- before_show_menu
205
- before_render
206
229
  return render_menu_error[:data] if @menu_error
207
230
  if allow_validation
208
231
  return render_previous if @previous_menu.field_error
209
232
  end
233
+ before_show_menu
234
+ before_render
210
235
  response = render
211
236
  response = response.blank? ? joy_response(@current_client_state) : response
212
237
  after_render
@@ -1,5 +1,5 @@
1
1
  # frozen_string_literal: true
2
2
 
3
3
  module JoyUssdEngine
4
- VERSION = "0.1.6"
4
+ VERSION = "0.1.9"
5
5
  end
Binary file
Binary file
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: joy_ussd_engine
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.1.6
4
+ version: 0.1.9
5
5
  platform: ruby
6
6
  authors:
7
7
  - Caleb Mantey
8
8
  autorequire:
9
9
  bindir: exe
10
10
  cert_chain: []
11
- date: 2022-04-06 00:00:00.000000000 Z
11
+ date: 2022-06-07 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: will_paginate
@@ -99,11 +99,8 @@ files:
99
99
  - lib/joy_ussd_engine/paginate_menu.rb
100
100
  - lib/joy_ussd_engine/session_manager.rb
101
101
  - lib/joy_ussd_engine/version.rb
102
- - pkg/joy_ussd_engine-0.1.1.gem
103
- - pkg/joy_ussd_engine-0.1.2.gem
104
- - pkg/joy_ussd_engine-0.1.3.gem
105
- - pkg/joy_ussd_engine-0.1.4.gem
106
- - pkg/joy_ussd_engine-0.1.5.gem
102
+ - pkg/joy_ussd_engine-0.1.8.gem
103
+ - pkg/joy_ussd_engine-0.1.9.gem
107
104
  - spec/joy_ussd_engine_spec.rb
108
105
  - spec/joy_ussd_engine_transformer.spec
109
106
  - spec/spec_helper.rb
Binary file
Binary file
Binary file
Binary file
Binary file