wit 3.3.1 → 3.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fd594fc892e82bfd4d1a23bff6eb062a3b31a117
-  data.tar.gz: a385c71e0165ab8ca866effc5e099fbe48547834
+  metadata.gz: b70a97f9ec0b2c9b01f49983870ae7981cd0ca9a
+  data.tar.gz: a575cf16cc6fd9ae10ce374617364c6edc6ea80a
 SHA512:
-  metadata.gz: 059661c6167529bc21f5700f7a93db866629cd20bb103b479b625f31982e84a3d97995990eaa27e6ebaf1596aced8df7c85cc5b4126f1a23da1e8446c55eca6d
-  data.tar.gz: e934ef82f3b4178b5fe36d681708e0a40a7df88695b5441b6df777abe103c0d9d51f06b5d4459fc9505372667c00c97f0a101dd43dcf7fc77cbe9d905727f91c
+  metadata.gz: 2f8a5583c0e72f940c9b7eff2c2cbcf31103b309ba040049b6f68bef599df4b14264fe99a5c18314c5202db928408157ad7d1bb38cef47bedce0bd46830bac09
+  data.tar.gz: 58496e8a8bcb1f0c3183e00a611f713740932b2afbb2418534e244596dc303a1265a5681dbcb711907265283681e460c42094ba474573a27351d95369ba422e3

data/.gitignore

@@ -1,4 +1,5 @@
 *.gem
 *.swo
 *.swp
+.idea/
 Gemfile.lock

data/CHANGES.md

@@ -1,3 +1,12 @@
+## v3.4
+
+- allows for overriding API version, by setting `WIT_API_VERSION`
+- warns instead of throwing when validating actions
+
+### breaking
+
+- bumped default API version from `20160330` to `20160516`
+
 ## v3.3.1
 
 - fixed recursive call when running actions

data/README.md

@@ -16,9 +16,15 @@ gem build wit.gemspec
 gem install wit-*.gem
 ```
 
-## Usage
+## Quickstart
 
-See the `examples` folder for examples.
+Run in your terminal:
+
+```bash
+ruby examples/quickstart.rb <your_token>
+```
+
+See the `examples` folder for more examples.
 
 ## API
 
@@ -28,6 +34,7 @@ See the `examples` folder for examples.
 * `message` - the Wit [message API](https://wit.ai/docs/http/20160330#get-intent-via-text-link)
 * `converse` - the low-level Wit [converse API](https://wit.ai/docs/http/20160330#converse-link)
 * `run_actions` - a higher-level method to the Wit converse API
+* `interactive` - starts an interactive conversation with your bot
 
 ### Wit class
 
@@ -123,6 +130,15 @@ p "Yay, got Wit.ai response: #{resp}"
 ```
 
 
+### interactive
+
+Starts an interactive conversation with your bot.
+
+Example:
+```ruby
+client.interactive
+```
+
 See the [docs](https://wit.ai/docs) for more information.
 
 

data/examples/quickstart.rb

@@ -3,7 +3,11 @@ require 'wit'
 # Quickstart example
 # See https://wit.ai/l5t/Quickstart
 
-access_token = 'YOUR_ACCESS_TOKEN'
+access_token = ARGV.shift
+unless access_token
+  puts 'usage: ruby examples/quickstart.rb <access-token>'
+  exit
+end
 
 def first_entity_value(entities, entity)
   return nil unless entities.has_key? entity
@@ -30,6 +34,4 @@ actions = {
   },
 }
 client = Wit.new access_token, actions
-
-session_id = 'my-user-id-42'
-client.run_actions session_id, 'weather in London', {}
+client.interactive

data/lib/wit.rb

@@ -1,8 +1,10 @@
 require 'json'
 require 'logger'
 require 'net/http'
+require 'securerandom'
 
 WIT_API_HOST = ENV['WIT_URL'] || 'https://api.wit.ai'
+WIT_API_VERSION = ENV['WIT_API_VERSION']  || '20160516'
 DEFAULT_MAX_STEPS = 5
 
 class WitException < Exception
@@ -14,7 +16,7 @@ def req(access_token, meth_class, path, params={}, payload={})
 
   request = meth_class.new uri
   request['authorization'] = 'Bearer ' + access_token
-  request['accept'] = 'application/vnd.wit.20160330+json'
+  request['accept'] = 'application/vnd.wit.' + WIT_API_VERSION + '+json'
   request.add_field 'Content-Type', 'application/json'
   request.body = payload.to_json
 
@@ -29,17 +31,17 @@ end
 
 def validate_actions(actions)
   learn_more = 'Learn more at https://wit.ai/docs/quickstart'
-  raise WitException.new 'The second parameter should be a Hash' unless actions.is_a? Hash
+  Wit.logger.warn 'The second parameter should be a Hash' unless actions.is_a? Hash
   [:say, :merge, :error].each do |action|
-    raise WitException.new "The #{action} action is missing. #{learn_more}" unless actions.has_key? action
+    Wit.logger.warn "The #{action} action is missing. #{learn_more}" unless actions.has_key? action
   end
   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 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 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
+    Wit.logger.warn "The '#{k}' action name should be a symbol" unless k.is_a? Symbol
+    Wit.logger.warn "The '#{k}' action should be a lambda function" unless v.respond_to? :call and v.lambda?
+    Wit.logger.warn "The \'say\' action should take 3 arguments: session_id, context, msg. #{learn_more}" if k == :say and v.arity != 3
+    Wit.logger.warn "The \'merge\' action should take 4 arguments: session_id, context, entities, msg. #{learn_more}" if k == :merge and v.arity != 4
+    Wit.logger.warn "The \'error\' action should take 3 arguments: session_id, context, error. #{learn_more}" if k == :error and v.arity != 3
+    Wit.logger.warn "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
 end
@@ -66,17 +68,23 @@ class Wit
   end
 
   def message(msg)
+    logger.debug "Message request: msg=#{msg}"
     params = {}
     params[:q] = msg unless msg.nil?
-    req @access_token, Net::HTTP::Get, '/message', params
+    res = req @access_token, Net::HTTP::Get, '/message', params
+    logger.debug "Message response: #{res}"
+    return res
   end
 
   def converse(session_id, msg, context={})
+    logger.debug "Converse request: session_id=#{session_id} msg=#{msg} context=#{context}"
     raise WitException.new 'context should be a Hash' unless context.is_a? Hash
     params = {}
     params[:q] = msg unless msg.nil?
     params[:session_id] = session_id
-    req @access_token, Net::HTTP::Post, '/converse', params, context
+    res = req @access_token, Net::HTTP::Post, '/converse', params, context
+    logger.debug "Converse response: #{res}"
+    return res
   end
 
   def run_actions_(session_id, message, context, max_steps, user_message)
@@ -125,5 +133,22 @@ class Wit
     return run_actions_ session_id, message, context, max_steps, message
   end
 
+  def interactive(context={}, max_steps=DEFAULT_MAX_STEPS)
+    session_id = SecureRandom.uuid
+
+    while true
+      print '> '
+      msg = gets.strip
+
+      begin
+        context = run_actions(session_id, msg, context, max_steps)
+      rescue WitException => exp
+        p exp.message
+      end
+    end
+  rescue Interrupt => _exp
+    puts
+  end
+
   private :run_actions_
 end

data/wit.gemspec

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: wit
 version: !ruby/object:Gem::Version
-  version: 3.3.1
+  version: 3.4.0
 platform: ruby
 authors:
 - The Wit Team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-18 00:00:00.000000000 Z
+date: 2016-05-23 00:00:00.000000000 Z
 dependencies: []
 description: Ruby SDK for Wit.ai
 email: help@wit.ai