wit 3.2.0 → 3.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 565021c60a45347a1b360edbcd0dc1736b03167b
-  data.tar.gz: d3b26b07d70c5796bbef81fdbf710c5f04bd10b8
+  metadata.gz: 329b154a407970ed82314b1e600bab97cccb770d
+  data.tar.gz: 92c1f766cdf3de796044e2861cb62816970574ba
 SHA512:
-  metadata.gz: 1183c5c974e9aec6d622311bf604db59a6fd3e6aaca8391839443f33c0cdd38c1f89ffd5aab949b9961f50b71e0f0d70d0b358e7714bbdf31f6824cdfd15bf52
-  data.tar.gz: 76953d61b404a078322520469393ac9870361e7f942a2f5f751b80b0679f27a94254c96f2bcb002c1b109ededbce80ac6ab4b290b2d4a27a9a61d19d4aac5c04
+  metadata.gz: a623fcbc955b0c9d82bdf727bf8219b6087bd44bf696720dbce8cf767803f58d790d92994995901b60c447800a5a270de3edcaf0e34ef3b5ec7b955c0b69f1cb
+  data.tar.gz: 802f6789388f95542d5f3f84a186e2d606ae415051977d67adce303b3d4a41b71477681fb128023b446fcceef2af73afddc68a2f32121f635960a8ce6eff457d

data/CHANGES.md

@@ -1,3 +1,22 @@
+## 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
+
+### breaking
+
+- the `merge` action now takes 4 parameters: `session_id`, `context`, `entities`, `msg`
+- the `error` action now takes `context` as second parameter
+- custom actions now take 2 parameters: `session_id`, `context`
+
 ## v3.1
 
 - allows for custom logging

data/README.md

@@ -45,16 +45,17 @@ actions = {
   :say => -> (session_id, msg) {
     p msg
   },
-  :merge => -> (context, entities) {
+  :merge => -> (session_id, context, entities, msg) {
     return context
   },
-  :error => -> (session_id, msg) {
+  :error => -> (session_id, context) {
     p 'Oops I don\'t know what to do.'
   },
 }
 ```
 
-A custom action takes one parameter:
+A custom action takes the following parameters:
+* `session_id` - a unique identifier describing the user session
 * `context` - the `Hash` representing the session state
 
 Example:

data/examples/joke.rb

@@ -27,26 +27,24 @@ all_jokes = {
 }
 
 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

data/examples/quickstart.rb

@@ -3,7 +3,7 @@ require 'wit'
 # Quickstart example
 # See https://wit.ai/l5t/Quickstart
 
-access_token = 'HEIIUUUJDPXL6YROX5NVLSCGLCVDN3EY'
+access_token = 'YOUR_ACCESS_TOKEN'
 
 def first_entity_value(entities, entity)
   return nil unless entities.has_key? entity
@@ -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

data/examples/template.rb

@@ -3,14 +3,14 @@ require 'wit'
 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

data/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 @@ class Wit
       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,7 +104,7 @@ class Wit
       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 = {}
@@ -112,7 +112,7 @@ class Wit
     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

data/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'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: wit
 version: !ruby/object:Gem::Version
-  version: 3.2.0
+  version: 3.3.0
 platform: ruby
 authors:
 - The Wit Team