v3.3.0 - unifying action parameters

Author: patapizza

CHANGES.md

@@ -1,3 +1,12 @@
+## v3.3
+
+Unifying action parameters
+
+### breaking
+
+- the `say` action now takes 3 parameters: `session_id`, `context`, `msg`
+- the `error` action now takes 3 parameters: `session_id`, `context`, `error`
+
 ## v3.2
 
 Updating action parameters

examples/joke.rb

@@ -27,26 +27,24 @@ def first_entity_value(entities, entity)
 }
 
 actions = {
-  :say => -> (session_id, msg) {
+  :say => -> (session_id, context, msg) {
     p msg
   },
   :merge => -> (session_id, context, entities, msg) {
-    new_context = context.clone
-    new_context.delete 'joke'
-    new_context.delete 'ack'
+    context.delete 'joke'
+    context.delete 'ack'
     category = first_entity_value entities, 'category'
-    new_context['category'] = category unless category.nil?
+    context['category'] = category unless category.nil?
     sentiment = first_entity_value entities, 'sentiment'
-    new_context['ack'] = sentiment == 'positive' ? 'Glad you liked it.' : 'Hmm.' unless sentiment.nil?
-    return new_context
+    context['ack'] = sentiment == 'positive' ? 'Glad you liked it.' : 'Hmm.' unless sentiment.nil?
+    return context
   },
-  :error => -> (session_id, context) {
-    p 'Oops I don\'t know what to do.'
+  :error => -> (session_id, context, error) {
+    p error.message
   },
   :'select-joke' => -> (session_id, context) {
-    new_context = context.clone
-    new_context['joke'] = all_jokes[new_context['cat'] || 'default'].sample
-    return new_context
+    context['joke'] = all_jokes[context['cat'] || 'default'].sample
+    return context
   },
 }
 client = Wit.new access_token, actions

examples/quickstart.rb

@@ -13,22 +13,20 @@ def first_entity_value(entities, entity)
 end
 
 actions = {
-  :say => -> (session_id, msg) {
+  :say => -> (session_id, context, msg) {
     p msg
   },
   :merge => -> (session_id, context, entities, msg) {
-    new_context = context.clone
     loc = first_entity_value entities, 'location'
-    new_context['loc'] = loc unless loc.nil?
-    return new_context
+    context['loc'] = loc unless loc.nil?
+    return context
   },
-  :error => -> (session_id, context) {
-    p 'Oops I don\'t know what to do.'
+  :error => -> (session_id, context, error) {
+    p error.message
   },
   :'fetch-weather' => -> (session_id, context) {
-    new_context = context.clone
-    new_context['forecast'] = 'sunny'
-    return new_context
+    context['forecast'] = 'sunny'
+    return context
   },
 }
 client = Wit.new access_token, actions

examples/template.rb

@@ -3,14 +3,14 @@
 access_token = 'YOUR_ACCESS_TOKEN'
 
 actions = {
-  :say => -> (session_id, msg) {
+  :say => -> (session_id, context, msg) {
     p msg
   },
   :merge => -> (session_id, context, entities, msg) {
     return context
   },
-  :error => -> (session_id, context) {
-    p 'Oops I don\'t know what to do.'
+  :error => -> (session_id, context, error) {
+    p error.message
   },
 }
 client = Wit.new access_token, actions

lib/wit.rb

@@ -36,9 +36,9 @@ def validate_actions(actions)
   actions.each_pair do |k, v|
     raise WitException.new "The '#{k}' action name should be a symbol" unless k.is_a? Symbol
     raise WitException.new "The '#{k}' action should be a lambda function" unless v.respond_to? :call and v.lambda?
-    raise WitException.new "The \'say\' action should take 2 arguments: session_id, msg. #{learn_more}" if k == :say and v.arity != 2
+    raise WitException.new "The \'say\' action should take 3 arguments: session_id, context, msg. #{learn_more}" if k == :say and v.arity != 3
     raise WitException.new "The \'merge\' action should take 4 arguments: session_id, context, entities, msg. #{learn_more}" if k == :merge and v.arity != 4
-    raise WitException.new "The \'error\' action should take 2 arguments: session_id, context. #{learn_more}" if k == :error and v.arity != 2
+    raise WitException.new "The \'error\' action should take 3 arguments: session_id, context, error. #{learn_more}" if k == :error and v.arity != 3
     raise WitException.new "The '#{k}' action should take 2 arguments: session_id, context. #{learn_more}" if k != :say and k != :merge and k != :error and v.arity != 2
   end
   return actions
@@ -91,11 +91,11 @@ def run_actions_(session_id, message, context, max_steps, user_message)
       raise WitException.new 'unknown action: say' unless @actions.has_key? :say
       msg = rst['msg']
       logger.info "Executing say with: #{msg}"
-      @actions[:say].call session_id, msg
+      @actions[:say].call session_id, context.clone, msg
     elsif type == 'merge'
       raise WitException.new 'unknown action: merge' unless @actions.has_key? :merge
       logger.info 'Executing merge'
-      context = @actions[:merge].call session_id, context, rst['entities'], user_message
+      context = @actions[:merge].call session_id, context.clone, rst['entities'], user_message
       if context.nil?
         logger.warn 'missing context - did you forget to return it?'
         context = {}
@@ -104,15 +104,15 @@ def run_actions_(session_id, message, context, max_steps, user_message)
       action = rst['action'].to_sym
       raise WitException.new "unknown action: #{action}" unless @actions.has_key? action
       logger.info "Executing action #{action}"
-      context = @actions[action].call session_id, context
+      context = @actions[action].call session_id, context.clone
       if context.nil?
         logger.warn 'missing context - did you forget to return it?'
         context = {}
       end
     elsif type == 'error'
       raise WitException.new 'unknown action: error' unless @actions.has_key? :error
       logger.info 'Executing error'
-      @actions[:error].call session_id, context
+      @actions[:error].call session_id, context.clone, WitException.new('Oops, I don\'t know what to do.')
     else
       raise WitException.new "unknown type: #{type}"
     end

wit.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name = 'wit'
-  s.version = '3.2.0'
+  s.version = '3.3.0'
   s.date = Date.today.to_s
   s.summary = 'Ruby SDK for Wit.ai'
   s.description = 'Ruby SDK for Wit.ai'