wit 5.0.0 → 6.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a8b09beea4b5f87b4ee4ac6db91a81e302d09415
-  data.tar.gz: 82cd100fe0cb84a361aa96afc8295e2e577afb0d
+  metadata.gz: db82d7c5e9dad4d0566d3bd8bb047954bec32e8b
+  data.tar.gz: 40cbef76d441b36725adfbfe30b31c3271b231aa
 SHA512:
-  metadata.gz: 13b1c151a243c6c6b3a6c1d2b4104cf8217279989360da423b625435781e04171e8ed848e7b66565438270ae25e9f66868f0e91dc8ca6487306f0bb20d55a464
-  data.tar.gz: 924f723edc7da68ceac7cd6287cdd229fee6763050cf754360b434ac2deedcee66f64dc988ab4557940b0cc7fad7be675bb6c1d3e37a1f9de2497c04b3df3ef2
+  metadata.gz: 2eafba1307cd42ecdf78358e64caf018b90fe7065c90e61f38758b3e6abfd56a0d668a193ed54f4b87648c6435df0c9c6f9dc22de4064037266b3dbba7eb0ac2
+  data.tar.gz: 2cfdfddd281f45dd45f32eddd37df3dfcc2bad3064ee3acdf0e4109ddbb793a4bdd6617dc892280de1207640496c00fcdd64c097dfbf43d5d5cb4c133fb097d1

data/CHANGES.md

@@ -1,3 +1,11 @@
+## v6.0.0
+The most important change is the removal of `.converse()` and `.run_actions()`. Follow the migration tutorial [here](https://github.com/wit-ai/wit-stories-migration-tutorial), or [read more here](https://wit.ai/blog/2017/07/27/sunsetting-stories).
+
+### Breaking changes
+
+- `converse` and `run_actions` are removed
+- updated and added new examples that leverage the /message API
+
 ## v5.0.0
 
 - `converse` and `run_actions` are deprecated

data/README.md

@@ -21,7 +21,7 @@ gem install wit-*.gem
 Run in your terminal:
 
 ```bash
-ruby examples/quickstart.rb <your_token>
+ruby examples/basic.rb <your_token>
 ```
 
 See the `examples` folder for more examples.
@@ -69,47 +69,6 @@ Example:
 client.interactive
 ```
 
-### .run_actions()
-
-**DEPRECATED** See [our blog post](https://wit.ai/blog) for a migration plan.
-
-A higher-level method to the Wit converse API.
-`run_actions` resets the last turn on new messages and errors.
-
-Takes the following parameters:
-* `session_id` - a unique identifier describing the user session
-* `message` - the text received from the user
-* `context` - the `Hash` representing the session state
-* `max_steps` - (optional) the maximum number of actions to execute (defaults to 5)
-
-Example:
-```ruby
-session = 'my-user-session-42'
-context0 = {}
-context1 = client.run_actions(session, 'what is the weather in London?', context0)
-p "The session state is now: #{context1}"
-context2 = client.run_actions(session, 'and in Brussels?', context1)
-p "The session state is now: #{context2}"
-```
-
-### .converse()
-
-**DEPRECATED** See [our blog post](https://wit.ai/blog) for a migration plan.
-
-The low-level Wit [converse API](https://wit.ai/docs/http/20160330#converse-link).
-
-Takes the following parameters:
-* `session_id` - a unique identifier describing the user session
-* `msg` - the text received from the user
-* `context` - the `Hash` representing the session state
-* `reset` - (optional) whether to reset the last turn
-
-Example:
-```ruby
-rsp = client.converse('my-user-session-42', 'what is the weather in London?', {})
-puts("Yay, got Wit.ai response: #{rsp}")
-```
-
 ### CRUD operations for entities
 payload in the parameters is a hash containing API arguments
 

data/examples/basic.rb

@@ -8,11 +8,5 @@ end
 access_token = ARGV[0]
 ARGV.shift
 
-actions = {
-  send: -> (request, response) {
-    puts("sending... #{response['text']}")
-  },
-}
-
-client = Wit.new(access_token: access_token, actions: actions)
+client = Wit.new(access_token: access_token)
 client.interactive

data/examples/celebrities.rb

@@ -0,0 +1,48 @@
+require 'wit'
+
+if ARGV.length == 0
+  puts("usage: #{$0} <wit-access-token>")
+  exit 1
+end
+
+access_token = ARGV[0]
+ARGV.shift
+
+# Celebrities example
+# See https://wit.ai/aforaleka/wit-example-celebrities/
+
+def first_entity_value(entities, entity)
+  return nil unless entities.has_key? entity
+  val = entities[entity][0]['value']
+  return nil if val.nil?
+  return val
+end
+
+def handle_message(response)
+  entities = response['entities']
+  greetings = first_entity_value(entities, 'greetings')
+  celebrity = first_entity_value(entities, 'notable_person')
+
+  case
+  when celebrity
+    return wikidata_description(celebrity)
+  when greetings
+    return "Hi! You can say something like 'Tell me about Beyonce'"
+  else
+    return "Um. I don't recognize that name. " \
+            "Which celebrity do you want to learn about?"
+  end
+end
+
+def wikidata_description(celebrity)
+  return "I recognize #{celebrity['name']}" unless celebrity.dig('external', 'wikidata')
+  wikidata_id = celebrity.fetch('external').fetch('wikidata')
+  api = URI("https://www.wikidata.org/w/api.php?action=wbgetentities&format=json&ids=#{wikidata_id}&props=descriptions&languages=en")
+  rsp = Net::HTTP.get_response(api)
+  wikidata = JSON.parse(rsp.body)
+  description = wikidata['entities'][wikidata_id]['descriptions']['en']['value']
+  return "ooo yes I know #{celebrity['name']} -- #{description}"
+end
+
+client = Wit.new(access_token: access_token)
+client.interactive(method(:handle_message))

data/examples/joke.rb

@@ -9,7 +9,7 @@ access_token = ARGV[0]
 ARGV.shift
 
 # Joke example
-# See https://wit.ai/patapizza/example-joke
+# See https://wit.ai/aforaleka/wit-example-joke-bot/
 
 def first_entity_value(entities, entity)
   return nil unless entities.has_key? entity
@@ -18,7 +18,7 @@ def first_entity_value(entities, entity)
   return val.is_a?(Hash) ? val['value'] : val
 end
 
-all_jokes = {
+$all_jokes = {
   'chuck' => [
     'Chuck Norris counted to infinity - twice.',
     'Death once had a near-Chuck Norris experience.',
@@ -32,29 +32,24 @@ all_jokes = {
   ],
 }
 
-actions = {
-  send: -> (request, response) {
-    puts("sending... #{response['text']}")
-  },
-  merge: -> (request) {
-    context = request['context']
-    entities = request['entities']
-
-    context.delete 'joke'
-    context.delete 'ack'
-    category = first_entity_value(entities, 'category')
-    context['category'] = category unless category.nil?
-    sentiment = first_entity_value(entities, 'sentiment')
-    context['ack'] = sentiment == 'positive' ? 'Glad you liked it.' : 'Hmm.' unless sentiment.nil?
-    return context
-  },
-  :'select-joke' => -> (request) {
-    context = request['context']
-
-    context['joke'] = all_jokes[context['category'] || 'default'].sample
-    return context
-  },
-}
+def handle_message(response)
+  entities = response['entities']
+  get_joke = first_entity_value(entities, 'getJoke')
+  greetings = first_entity_value(entities, 'greetings')
+  category = first_entity_value(entities, 'category')
+  sentiment = first_entity_value(entities, 'sentiment')
+
+  case
+  when get_joke
+    return $all_jokes[category || 'default'].sample
+  when sentiment
+    return sentiment == 'positive' ? 'Glad you liked it.' : 'Hmm.'
+  when greetings
+    return 'Hey this is joke bot :)'
+  else
+    return 'I can tell jokes! Say "tell me a joke about tech"!'
+  end
+end
 
-client = Wit.new(access_token: access_token, actions: actions)
-client.interactive
+client = Wit.new(access_token: access_token)
+client.interactive(method(:handle_message))

data/lib/wit.rb

@@ -17,13 +17,6 @@ class Wit
     if opts[:logger]
       @logger = opts[:logger]
     end
-
-    if opts[:actions]
-      logger.warn('Stories and POST /converse have been deprecated. This will break in February 2018!')
-      @actions = validate_actions(logger, opts[:actions])
-    end
-
-    @_sessions = {}
   end
 
   def logger
@@ -34,54 +27,16 @@ class Wit
     end
   end
 
-  def message(msg)
+  def message(msg, n=nil, verbose=nil)
     params = {}
     params[:q] = msg unless msg.nil?
+    params[:n] = n unless n.nil?
+    params[:verbose] = verbose unless verbose.nil?
     res = req(logger, @access_token, Net::HTTP::Get, '/message', params)
     return res
   end
 
-  def converse(session_id, msg, context={}, reset=nil)
-    if !context.is_a?(Hash)
-      raise Error.new('context should be a Hash')
-    end
-    params = {}
-    params[:q] = msg unless msg.nil?
-    params[:session_id] = session_id
-    params[:reset] = true if reset
-    res = req(logger, @access_token, Net::HTTP::Post, '/converse', params, context)
-    return res
-  end
-
-  def run_actions(session_id, message, context={}, max_steps=DEFAULT_MAX_STEPS)
-    if !@actions
-      throw_must_have_actions
-    end
-    if !context.is_a?(Hash)
-      raise Error.new('context should be a Hash')
-    end
-
-    # Figuring out whether we need to reset the last turn.
-    # Each new call increments an index for the session.
-    # We only care about the last call to run_actions.
-    # All the previous ones are discarded (preemptive exit).
-    current_request = 1
-    if @_sessions.has_key?(session_id)
-      current_request = @_sessions[session_id] + 1
-    end
-    @_sessions[session_id] = current_request
-
-    context = __run_actions(session_id, current_request, message, context, max_steps)
-
-    # Cleaning up once the last call to run_actions finishes.
-    if current_request == @_sessions[session_id]
-      @_sessions.delete(session_id)
-    end
-
-    return context
-  end
-
-  def interactive(context={})
+  def interactive(handle_message=nil, context={})
     while true
       print '> '
       msg = STDIN.gets.strip
@@ -90,7 +45,11 @@ class Wit
       end
 
       begin
-        puts(message(msg))
+        if handle_message.nil?
+          puts(message(msg))
+        else
+          puts(handle_message.call(message(msg)))
+        end
       rescue Error => exp
         logger.error("error: #{exp.message}")
       end
@@ -99,16 +58,6 @@ class Wit
     puts
   end
 
-  def throw_if_action_missing(action_name)
-    if !@actions.has_key?(action_name)
-      raise Error.new("unknown action: #{action_name}")
-    end
-  end
-
-  def throw_must_have_actions()
-    raise Error.new('You must provide the `actions` parameter to be able to use runActions. ' + LEARN_MORE)
-  end
-
   def get_entities
     req(logger, @access_token, Net::HTTP::Get, "/entities")
   end
@@ -171,67 +120,6 @@ class Wit
     end
   end
 
-  def __run_actions(session_id, current_request, message, context, i)
-    if i <= 0
-      raise Error.new('Max steps reached, stopping.')
-    end
-    json = converse(session_id, message, context)
-    if json['type'].nil?
-      raise Error.new('Couldn\'t find type in Wit response')
-    end
-    if current_request != @_sessions[session_id]
-      return context
-    end
-
-    logger.debug("Context: #{context}")
-    logger.debug("Response type: #{json['type']}")
-
-    # backwards-compatibility with API version 20160516
-    if json['type'] == 'merge'
-      json['type'] = 'action'
-      json['action'] = 'merge'
-    end
-
-    if json['type'] == 'error'
-      raise Error.new('Oops, I don\'t know what to do.')
-    end
-
-    if json['type'] == 'stop'
-      return context
-    end
-
-    request = {
-      'session_id' => session_id,
-      'context' => context.clone,
-      'text' => message,
-      'entities' => json['entities']
-    }
-    if json['type'] == 'msg'
-      throw_if_action_missing(:send)
-      response = {
-        'text' => json['msg'],
-        'quickreplies' => json['quickreplies'],
-      }
-      @actions[:send].call(request, response)
-    elsif json['type'] == 'action'
-      action = json['action'].to_sym
-      throw_if_action_missing(action)
-      context = @actions[action].call(request)
-      if context.nil?
-        logger.warn('missing context - did you forget to return it?')
-        context = {}
-      end
-    else
-      raise Error.new("unknown type: #{json['type']}")
-    end
-
-    if current_request != @_sessions[session_id]
-      return context
-    end
-
-    return __run_actions(session_id, current_request, nil, context, i - 1)
-  end
-
   def req(logger, access_token, meth_class, path, params={}, payload={})
     uri = URI(WIT_API_HOST + path)
     uri.query = URI.encode_www_form(params)
@@ -257,27 +145,4 @@ class Wit
       json
     end
   end
-
-  def validate_actions(logger, actions)
-    [:send].each do |action|
-      if !actions.has_key?(action)
-        logger.warn "The #{action} action is missing. #{LEARN_MORE}"
-      end
-    end
-    actions.each_pair do |k, v|
-      if !k.is_a?(Symbol)
-        logger.warn "The '#{k}' action name should be a symbol"
-      end
-      if !(v.respond_to?(:call) && v.lambda?)
-        logger.warn "The '#{k}' action should be a lambda function"
-      end
-      if k == :send && v.arity != 2
-        logger.warn "The \'send\' action should take 2 arguments: request and response. #{LEARN_MORE}"
-      end
-      if k != :send && v.arity != 1
-        logger.warn "The '#{k}' action should take 1 argument: request. #{LEARN_MORE}"
-      end
-    end
-    return actions
-  end
 end

data/wit.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name = 'wit'
-  s.version = '5.0.0'
+  s.version = '6.0.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: 5.0.0
+  version: 6.0.0
 platform: ruby
 authors:
 - The Wit Team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-07-24 00:00:00.000000000 Z
+date: 2018-02-08 00:00:00.000000000 Z
 dependencies: []
 description: Ruby SDK for Wit.ai
 email: help@wit.ai
@@ -16,14 +16,16 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
 - CHANGES.md
 - Gemfile
 - LICENSE
 - README.md
 - examples/basic.rb
+- examples/celebrities.rb
 - examples/joke.rb
-- examples/quickstart.rb
+- examples/wit-example-celebrities.zip
+- examples/wit-example-joke-bot.zip
 - lib/wit.rb
 - wit.gemspec
 homepage: https://wit.ai
@@ -36,17 +38,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.14.1
+rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
 summary: Ruby SDK for Wit.ai

data/examples/quickstart.rb

@@ -1,43 +0,0 @@
-require 'wit'
-
-if ARGV.length == 0
-  puts("usage: #{$0} <wit-access-token>")
-  exit 1
-end
-
-access_token = ARGV[0]
-ARGV.shift
-
-# Quickstart example
-# See https://wit.ai/ar7hur/Quickstart
-
-def first_entity_value(entities, entity)
-  return nil unless entities.has_key? entity
-  val = entities[entity][0]['value']
-  return nil if val.nil?
-  return val.is_a?(Hash) ? val['value'] : val
-end
-
-actions = {
-  send: -> (request, response) {
-    puts("sending... #{response['text']}")
-  },
-  getForecast: -> (request) {
-    context = request['context']
-    entities = request['entities']
-
-    loc = first_entity_value(entities, 'location')
-    if loc
-        context['forecast'] = 'sunny'
-        context.delete('missingLocation')
-    else
-        context['missingLocation'] = true
-        context.delete('forecast')
-    end
-
-    return context
-  },
-}
-
-client = Wit.new(access_token: access_token, actions: actions)
-client.interactive