wit 3.4.0 → 7.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: b70a97f9ec0b2c9b01f49983870ae7981cd0ca9a
-  data.tar.gz: a575cf16cc6fd9ae10ce374617364c6edc6ea80a
+SHA256:
+  metadata.gz: 1a15b6f521d5b67b3c2d512e1ea9262ef4b1e39109e22eb9822a10aabe8e7b34
+  data.tar.gz: 6fd43d27a1edc8ccba793c45ca0fac4e90f9c27d265b3a105135e1bfb85b707e
 SHA512:
-  metadata.gz: 2f8a5583c0e72f940c9b7eff2c2cbcf31103b309ba040049b6f68bef599df4b14264fe99a5c18314c5202db928408157ad7d1bb38cef47bedce0bd46830bac09
-  data.tar.gz: 58496e8a8bcb1f0c3183e00a611f713740932b2afbb2418534e244596dc303a1265a5681dbcb711907265283681e460c42094ba474573a27351d95369ba422e3
+  metadata.gz: eed12472514c8efdcbf6716b637aed58820dd98c437703566c027a10b57dca54877011d02dbc173e326aad8f7fa6a7d6c28ca499161070a73b913e73d840b650
+  data.tar.gz: 6d6f64a64117a9fd39ba9eb6074e3b7dc17bad80e48382930ea21f4584b2a1c96b5289df4ffdc6623ab8691d10c4af515f112551fd8e787184dec83e8fa01091

data/.github/ISSUE_TEMPLATE.md

@@ -0,0 +1,9 @@
+**Do you want to request a *feature*, report a *bug*, or ask a *question* about wit-ruby?**
+
+**What is the current behavior?**
+
+**If the current behavior is a bug, please provide the steps to reproduce and if possible a minimal demo of the problem.**
+
+**What is the expected behavior?**
+
+**If applicable, what is the App ID where you are experiencing this issue? If you do not provide this, we cannot help.**

data/CHANGES.md

@@ -1,6 +1,52 @@
+## v7.0.0
+- Updated API version to latest: `20200513`.  Browse the latest HTTP API documentation [here](https://wit.ai/docs/http/20200513#get__message_link).
+- Added intents and traits CRUD methods.
+- More consistent, transparent naming of entities methods.
+
+## 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
+- `interactive` now calls `message`
+
+### Breaking changes
+- Renamed WitException to Wit::Error
+- Changed Wit::Error to inherit from StandardError instead of Exception
+- Moved constants inside Wit namespace
+- Moved #req and #validate_actions to private methods within Wit namespace
+
+## v4.1.0
+
+- `converse` now takes `reset` as optional parameter.
+
+### Breaking changes
+
+- `run_actions` now resets the last turn on new messages and errors.
+
+## v4.0.0
+
+After a lot of internal dogfooding and bot building, we decided to change the API in a backwards-incompatible way. The changes are described below and aim to simplify user code and accommodate upcoming features.
+
+See `./examples` to see how to use the new API.
+
+### Breaking changes
+
+- `say` renamed to `send` to reflect that it deals with more than just text
+- Removed built-in actions `merge` and `error`
+- Actions signature simplified with `request` and `response` arguments
+- INFO level replaces LOG level
+
 ## v3.4
 
 - allows for overriding API version, by setting `WIT_API_VERSION`
+- `interactive()` mode
 - warns instead of throwing when validating actions
 
 ### breaking

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,76 @@
+# Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to make participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, sex characteristics, gender identity and expression,
+level of experience, education, socio-economic status, nationality, personal
+appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+  advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies within all project spaces, and it also applies when
+an individual is representing the project or its community in public spaces.
+Examples of representing a project or community include using an official
+project e-mail address, posting via an official social media account, or acting
+as an appointed representative at an online or offline event. Representation of
+a project may be further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at <opensource-conduct@fb.com>. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see
+https://www.contributor-covenant.org/faq

data/CONTRIBUTING.md

@@ -0,0 +1,34 @@
+# Contributing to wit-ruby
+
+We want to make contributing to this project as easy and transparent as
+possible.
+
+## Pull Requests
+We actively welcome your pull requests.
+
+1. Fork the repo and create your branch from `master`.
+2. If you've added code that should be tested, add tests.
+3. If you've changed APIs, update the documentation.
+4. Ensure the test suite passes.
+5. If you haven't already, complete the Contributor License Agreement ("CLA").
+
+## Contributor License Agreement ("CLA")
+
+In order to accept your pull request, we need you to submit a CLA. You only need
+to do this once to work on any of Facebook's open source projects.
+
+Complete your CLA here: <https://code.facebook.com/cla>
+
+## Issues
+
+We use GitHub issues to track public bugs. Please ensure your description is
+clear and has sufficient instructions to be able to reproduce the issue.
+
+Facebook has a [bounty program](https://www.facebook.com/whitehat/) for the safe
+disclosure of security bugs. In those cases, please go through the process
+outlined on that page and do not file a public issue.
+
+## License
+
+By contributing to wit-ruby, you agree that your contributions will be licensed
+under the LICENSE file in the root directory of this source tree.

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.
@@ -31,117 +31,157 @@ See the `examples` folder for more examples.
 ### Overview
 
 `wit-ruby` provides a Wit class with the following methods:
-* `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
+* `message` - the Wit [message API](https://wit.ai/docs/http/20200513#get-intent-via-text-link)
 * `interactive` - starts an interactive conversation with your bot
 
 ### Wit class
 
-The Wit constructor takes the following parameters:
-* `access_token` - the access token of your Wit instance
-* `actions` - the `Hash` with your actions
+The Wit constructor takes a `Hash` with the following symbol keys:
+* `:access_token` - the access token of your Wit instance
 
-The `actions` `Hash` has action names as keys, and action implementations as values.
-Action names are symbols, and action implementations are lambda functions (not `Proc`).
-You need to provide at least an implementation for the special actions `:say`, `:merge` and `:error`.
-
-A minimal `actions` `Hash` looks like this:
+A minimal example looks like this:
 ```ruby
-actions = {
-  :say => -> (session_id, context, msg) {
-    p msg
-  },
-  :merge => -> (session_id, context, entities, msg) {
-    return context
-  },
-  :error => -> (session_id, context, error) {
-    p error.message
-  },
-}
+require 'wit'
+
+client = Wit.new(access_token: access_token)
+client.message('set an alarm tomorrow at 7am')
 ```
 
-A custom action takes the following parameters:
-* `session_id` - a unique identifier describing the user session
-* `context` - the `Hash` representing the session state
+### .message()
+
+The Wit [message API](https://wit.ai/docs/http/20200513#get-intent-via-text-link).
+
+Takes the following parameters:
+* `msg` - the text you want Wit.ai to extract the information from
 
 Example:
 ```ruby
-require 'wit'
-client = Wit.new access_token, actions
+rsp = client.message('what is the weather in London?')
+puts("Yay, got Wit.ai response: #{rsp}")
 ```
 
-### Logging
+### .interactive()
 
-Default logging is to `STDOUT` with `INFO` level.
+Starts an interactive conversation with your bot.
 
-You can setup your logging level as follows:
+Example:
 ```ruby
-Wit.logger.level = Logger::WARN
+client.interactive
 ```
-See the [Logger class](http://ruby-doc.org/stdlib-2.1.0/libdoc/logger/rdoc/Logger.html) docs for more information.
 
-### message
+### CRUD operations for intents
+`payload` in the parameters is a hash containing API arguments.
 
-The Wit [message API](https://wit.ai/docs/http/20160330#get-intent-via-text-link).
+#### .get_intents()
+Returns a list of available intents for the app.
+See [GET /intents](https://wit.ai/docs/http/20200513#get__intents_link).
 
-Takes the following parameters:
-* `msg` - the text you want Wit.ai to extract the information from
+#### .get_intent(intent)
+Returns all available information about an intent.
+See [GET /intents/:intent](https://wit.ai/docs/http/20200513#get__intents__intent_link).
 
-Example:
-```ruby
-resp = client.message 'what is the weather in London?'
-p "Yay, got Wit.ai response: #{resp}"
-```
+#### .post_intents(payload)
+Creates a new intent.
+See [POST /intents](https://wit.ai/docs/http/20200513#post__intents_link).
 
-### run_actions
+#### .delete_intents(intent)
+Permanently deletes the intent.
+See [DELETE /intents/:intent](https://wit.ai/docs/http/20200513#delete__intents__intent_link).
 
-A higher-level method to the Wit converse API.
+### CRUD operations for entities
+`payload` in the parameters is a hash containing API arguments.
 
-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)
+#### .get_entities()
+Returns a list of available entities for the app.  
+See [GET /entities](https://wit.ai/docs/http/20200513#get--entities-link)
 
-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}"
-```
+#### .post_entities(payload)
+Creates a new entity with the given attributes.  
+See [POST /entities](https://wit.ai/docs/http/20200513#post--entities-link)
 
-### converse
+#### .get_entity(entity)
+Returns all the information available for an entity.  
+See [GET /entities/:entity](https://wit.ai/docs/http/20200513#get--entities-:entity-link)
 
-The low-level Wit [converse API](https://wit.ai/docs/http/20160330#converse-link).
+#### .put_entities(entity, payload)
+Updates an entity with the given attributes.  
+See [PUT /entities/:entity](https://wit.ai/docs/http/20200513#put--entities-:entity-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
+#### .delete_entities(entity)
+Permanently removes the entity.  
+See [DELETE /entities/:entity](https://wit.ai/docs/http/20200513#delete--entities-:entity-link)
 
-Example:
-```ruby
-resp = client.converse 'my-user-session-42', 'what is the weather in London?', {}
-p "Yay, got Wit.ai response: #{resp}"
-```
+#### .post_entities_keywords(entity, payload)
+Adds a possible value into the list of keywords for the keywords entity.
+See [POST /entities/:entity/keywords](https://wit.ai/docs/http/20160526#post--entities-:entity-id-values-link)
 
+#### .delete_entities_keywords(entity, keyword)
+Deletes a keyword from the entity.  
+See [DELETE /entities/:entity/keywords/:keyword](https://wit.ai/docs/http/20200513#delete--entities-:entity-keywords-link)
 
-### interactive
+#### .post_entities_keywords_synonyms(entity, keyword, payload)
+Creates a new synonym for the keyword of the entity.  
+See [POST /entities/:entity/keywords/:keyword/synonyms](https://wit.ai/docs/http/20200513#post--entities-:entity-keywords-:keyword-synonyms-link)
 
-Starts an interactive conversation with your bot.
+#### delete_entities_keywords_synonyms(entity, keyword, synonym)
+Deletes a synonym of the keyword of the entity.  
+See [DELETE /entities/:entity/keywords/:keyword/synonyms/:synonym](https://wit.ai/docs/http/20200513#delete--entities-:entity-keywords-:keyword-synonyms-link)
+
+### CRUD operations for traits
+`payload` in the parameters is a hash containing API arguments.
+
+#### .get_traits()
+Returns a list of available traits for the app.
+See [GET /traits](https://wit.ai/docs/http/20200513#get__traits_link).
+
+#### .get_trait(trait)
+Returns all available information about a trait.
+See [GET /traits/:trait](https://wit.ai/docs/http/20200513#get__traits__trait_link).
+
+#### .post_traits(payload)
+Creates a new trait.
+See [POST /traits](https://wit.ai/docs/http/20200513#post__traits_link).
+
+#### .post_traits_values(trait, payload)
+Adds a new value to an existing trait.
+See [POST /traits/:trait/values](https://wit.ai/docs/http/20200513#post__traits__trait_values_link).
+
+#### .delete_traits_values(trait, value)
+Permanently deletes a value of an existing trait.
+See [POST /traits/:trait/values](https://wit.ai/docs/http/20200513#delete__traits__trait_values_link).
+
+#### .delete_traits(trait)
+Permanently deletes the trait.
+See [DELETE /traits/:trait](https://wit.ai/docs/http/20200513#delete__traits__trait_link).
 
-Example:
-```ruby
-client.interactive
-```
 
 See the [docs](https://wit.ai/docs) for more information.
 
+### Logging
+
+Default logging is to `STDOUT` with `INFO` level.
+
+You can setup your logging level as follows:
+```ruby
+Wit.logger.level = Logger::WARN
+```
+See the [Logger class](http://ruby-doc.org/stdlib-2.1.0/libdoc/logger/rdoc/Logger.html) docs for more information.
 
 ## Thanks
 
 Thanks to [Justin Workman](http://github.com/xtagon) for releasing a first version in October 2013. We really appreciate!
+
+
+## License
+
+The license for wit-ruby can be found in LICENSE file in the root directory of this source tree.
+
+
+## Terms of Use
+
+Our terms of use can be found at https://opensource.facebook.com/legal/terms.
+
+
+## Privacy Policy
+
+Our privacy policy can be found at https://opensource.facebook.com/legal/privacy.

data/examples/basic.rb

@@ -0,0 +1,14 @@
+# Copyright (c) Facebook, Inc. and its affiliates. All Rights Reserved.
+
+require 'wit'
+
+if ARGV.length == 0
+  puts("usage: #{$0} <wit-access-token>")
+  exit 1
+end
+
+access_token = ARGV[0]
+ARGV.shift
+
+client = Wit.new(access_token: access_token)
+client.interactive

data/examples/celebrities.rb

@@ -0,0 +1,56 @@
+# Copyright (c) Facebook, Inc. and its affiliates. All Rights Reserved.
+
+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/aleka/wit-example-celebrities/
+
+def first_entity_resolved_value(entities, entity)
+  return nil unless entities.has_key? entity
+  val = entities[entity][0]['resolved']['values'][0]
+  return nil if val.nil?
+  return val
+end
+
+def first_trait_value(traits, trait)
+  return nil unless traits.has_key? trait
+  val = traits[trait][0]['value']
+  return nil if val.nil?
+  return val
+end
+
+def handle_message(response)
+  greetings = first_trait_value(response['traits'], 'wit$greetings')
+  celebrity = first_entity_resolved_value(response['entities'], 'wit$notable_person: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

@@ -1,18 +1,26 @@
+# Copyright (c) Facebook, Inc. and its affiliates. All Rights Reserved.
+
 require 'wit'
 
-# Joke example
-# See https://wit.ai/patapizza/example-joke
+if ARGV.length == 0
+  puts("usage: #{$0} <wit-access-token>")
+  exit 1
+end
+
+access_token = ARGV[0]
+ARGV.shift
 
-access_token = 'YOUR_ACCESS_TOKEN'
+# Joke example
+# See https://wit.ai/aleka/wit-example-joke-bot/
 
-def first_entity_value(entities, entity)
-  return nil unless entities.has_key? entity
-  val = entities[entity][0]['value']
+def first_value(obj, key)
+  return nil unless obj.has_key? key
+  val = obj[key][0]['value']
   return nil if val.nil?
-  return val.is_a?(Hash) ? val['value'] : val
+  return val
 end
 
-all_jokes = {
+$all_jokes = {
   'chuck' => [
     'Chuck Norris counted to infinity - twice.',
     'Death once had a near-Chuck Norris experience.',
@@ -26,28 +34,25 @@ all_jokes = {
   ],
 }
 
-actions = {
-  :say => -> (session_id, context, msg) {
-    p msg
-  },
-  :merge => -> (session_id, context, entities, msg) {
-    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
-  },
-  :error => -> (session_id, context, error) {
-    p error.message
-  },
-  :'select-joke' => -> (session_id, context) {
-    context['joke'] = all_jokes[context['cat'] || 'default'].sample
-    return context
-  },
-}
-client = Wit.new access_token, actions
+def handle_message(response)
+  entities = response['entities']
+  traits = response['traits']
+  get_joke = first_value(traits, 'getJoke')
+  greetings = first_value(traits, 'wit$greetings')
+  category = first_value(entities, 'category:category')
+  sentiment = first_value(traits, 'wit$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
 
-session_id = 'my-user-id-42'
-client.run_actions session_id, 'tell me a joke about tech', {}
+client = Wit.new(access_token: access_token)
+client.interactive(method(:handle_message))

data/lib/wit.rb

@@ -1,154 +1,186 @@
+# Copyright (c) Facebook, Inc. and its affiliates. All Rights Reserved.
+
 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 Wit
+  class Error < StandardError; end
 
-class WitException < Exception
-end
+  WIT_API_HOST = ENV['WIT_URL'] || 'https://api.wit.ai'
+  WIT_API_VERSION = ENV['WIT_API_VERSION']  || '20200513'
+  LEARN_MORE = 'Learn more at https://wit.ai/docs/quickstart'
 
-def req(access_token, meth_class, path, params={}, payload={})
-  uri = URI(WIT_API_HOST + path)
-  uri.query = URI.encode_www_form params
+  def initialize(opts = {})
+    @access_token = opts[:access_token]
 
-  request = meth_class.new uri
-  request['authorization'] = 'Bearer ' + access_token
-  request['accept'] = 'application/vnd.wit.' + WIT_API_VERSION + '+json'
-  request.add_field 'Content-Type', 'application/json'
-  request.body = payload.to_json
+    if opts[:logger]
+      @logger = opts[:logger]
+    end
+  end
 
-  Net::HTTP.start uri.host, uri.port, {:use_ssl => uri.scheme == 'https'} do |http|
-    rsp = http.request request
-    raise WitException.new "HTTP error code=#{rsp.code}" unless rsp.code.to_i <= 200
-    json = JSON.parse rsp.body
-    raise WitException.new "Wit responded with an error: #{json['error']}" if json.has_key? 'error'
-    json
+  def logger
+    @logger ||= begin
+      x = Logger.new(STDOUT)
+      x.level = Logger::INFO
+      x
+    end
   end
-end
 
-def validate_actions(actions)
-  learn_more = 'Learn more at https://wit.ai/docs/quickstart'
-  Wit.logger.warn 'The second parameter should be a Hash' unless actions.is_a? Hash
-  [:say, :merge, :error].each do |action|
-    Wit.logger.warn "The #{action} action is missing. #{learn_more}" unless actions.has_key? action
-  end
-  actions.each_pair do |k, v|
-    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
+  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
 
-class Wit
-  class << self
-    attr_writer :logger
-
-    def logger
-      @logger ||= begin
-        $stdout.sync = true
-        Logger.new(STDOUT)
-      end.tap { |logger| logger.level = Logger::INFO }
+  def interactive(handle_message=nil, context={})
+    while true
+      print '> '
+      msg = STDIN.gets.strip
+      if msg == ''
+        next
+      end
+
+      begin
+        if handle_message.nil?
+          puts(message(msg))
+        else
+          puts(handle_message.call(message(msg)))
+        end
+      rescue Error => exp
+        logger.error("error: #{exp.message}")
+      end
     end
+  rescue Interrupt => _exp
+    puts
   end
 
-  def initialize(access_token, actions)
-    @access_token = access_token
-    @actions = validate_actions actions
+  def get_intents
+    req(logger, @access_token, Net::HTTP::Get, "/intents")
   end
 
-  def logger
-    self.class.logger
+  def get_intent(intent)
+    req(logger, @access_token, Net::HTTP::Get, "/intents/#{URI.encode(intent)}")
   end
 
-  def message(msg)
-    logger.debug "Message request: msg=#{msg}"
-    params = {}
-    params[:q] = msg unless msg.nil?
-    res = req @access_token, Net::HTTP::Get, '/message', params
-    logger.debug "Message response: #{res}"
-    return res
+  def post_intents(payload)
+    req(logger, @access_token, Net::HTTP::Post, "/intents", {}, payload)
   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
-    res = req @access_token, Net::HTTP::Post, '/converse', params, context
-    logger.debug "Converse response: #{res}"
-    return res
+  def delete_intents(intent)
+    req(logger, @access_token, Net::HTTP::Delete, "/intents/#{URI.encode(intent)}")
   end
 
-  def run_actions_(session_id, message, context, max_steps, user_message)
-    raise WitException.new 'max iterations reached' unless max_steps > 0
+  def get_entities
+    req(logger, @access_token, Net::HTTP::Get, "/entities")
+  end
 
-    rst = converse session_id, message, context
-    raise WitException.new 'couldn\'t find type in Wit response' unless rst.has_key? 'type'
+  def post_entities(payload)
+    payload = payload.map {|k, v| [(k.to_sym rescue k), v]}.to_h.reject{ |k| ![:name, :roles, :lookups, :keywords].include?(k) }
+    validate_payload payload
+    req(logger, @access_token, Net::HTTP::Post, "/entities", {}, payload)
+  end
 
-    type = rst['type']
+  def get_entity(entity)
+    req(logger, @access_token, Net::HTTP::Get, "/entities/#{URI.encode(entity)}")
+  end
 
-    return context if type == 'stop'
-    if type == 'msg'
-      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, 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.clone, rst['entities'], user_message
-      if context.nil?
-        logger.warn 'missing context - did you forget to return it?'
-        context = {}
-      end
-    elsif type == 'action'
-      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.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.clone, WitException.new('Oops, I don\'t know what to do.')
-    else
-      raise WitException.new "unknown type: #{type}"
-    end
-    return run_actions_ session_id, nil, context, max_steps - 1, user_message
+  def put_entities(entity, payload)
+    payload = payload.map {|k, v| [(k.to_sym rescue k), v]}.to_h.reject{ |k| ![:name, :roles, :lookups, :keywords].include?(k) }
+    validate_payload payload
+    req(logger, @access_token, Net::HTTP::Put, "/entities/#{URI.encode(entity)}", {}, payload)
   end
 
-  def run_actions(session_id, message, context={}, max_steps=DEFAULT_MAX_STEPS)
-    raise WitException.new 'context should be a Hash' unless context.is_a? Hash
-    return run_actions_ session_id, message, context, max_steps, message
+  def delete_entities(entity)
+    req(logger, @access_token, Net::HTTP::Delete, "/entities/#{URI.encode(entity)}")
   end
 
-  def interactive(context={}, max_steps=DEFAULT_MAX_STEPS)
-    session_id = SecureRandom.uuid
+  def post_entities_keywords(entity, payload)
+    payload = payload.map {|k, v| [(k.to_sym rescue k), v]}.to_h.reject{ |k| ![:keyword, :synonyms].include?(k) }
+    validate_payload payload
+    req(logger, @access_token, Net::HTTP::Post, "/entities/#{URI.encode(entity)}/keywords", {}, payload)
+  end
 
-    while true
-      print '> '
-      msg = gets.strip
+  def delete_entities_keywords(entity, keyword)
+    req(logger, @access_token, Net::HTTP::Delete, "/entities/#{URI.encode(entity)}/keywords/#{URI.encode(keyword)}")
+  end
 
-      begin
-        context = run_actions(session_id, msg, context, max_steps)
-      rescue WitException => exp
-        p exp.message
-      end
+  def post_entities_keywords_synonyms(entity, keyword, payload)
+    payload = payload.map {|k, v| [(k.to_sym rescue k), v]}.to_h.reject{ |k| ![:synonym].include?(k) }
+    validate_payload payload
+    req(logger,@access_token, Net::HTTP::Post, "/entities/#{URI.encode(entity)}/keywords/#{URI.encode(keyword)}/synonyms", {}, payload)
+  end
+
+  def delete_entities_keywords_synonyms(entity, keyword, synonym)
+    req(logger,@access_token, Net::HTTP::Delete, "/entities/#{URI.encode(entity)}/keywords/#{URI.encode(keyword)}/synonyms/#{URI.encode(synonym)}")
+  end
+
+  def get_traits
+    req(logger, @access_token, Net::HTTP::Get, "/traits")
+  end
+
+  def get_trait(trait)
+    req(logger, @access_token, Net::HTTP::Get, "/traits/#{URI.encode(trait)}")
+  end
+
+  def post_traits(payload)
+    req(logger, @access_token, Net::HTTP::Post, "/traits", {}, payload)
+  end
+
+  def post_traits_values(trait, payload)
+    req(logger, @access_token, Net::HTTP::Post, "/traits/#{URI.encode(trait)}/values", {}, payload)
+  end
+
+  def delete_traits_values(trait, value)
+    req(logger, @access_token, Net::HTTP::Delete, "/traits/#{URI.encode(trait)}/values/#{URI.encode(value)}")
+  end
+
+  def delete_traits(trait)
+    req(logger, @access_token, Net::HTTP::Delete, "/traits/#{URI.encode(trait)}")
+  end
+
+  private
+
+  def validate_payload(payload)
+    key_types = {
+      id: String,
+      name: String,
+      roles: Array,
+      lookups: Array,
+      keywords: Array,
+    }
+    payload.each do |k, v|
+      raise Error.new("#{k.to_s} in request body must be #{key_types[k].to_s} type") unless key_types[k] == v.class
     end
-  rescue Interrupt => _exp
-    puts
   end
 
-  private :run_actions_
+  def req(logger, access_token, meth_class, path, params={}, payload={})
+    uri = URI(WIT_API_HOST + path)
+    uri.query = URI.encode_www_form(params)
+
+    logger.debug("#{meth_class} #{uri}")
+
+    request = meth_class.new(uri)
+    request['authorization'] = 'Bearer ' + access_token
+    request['accept'] = 'application/vnd.wit.' + WIT_API_VERSION + '+json'
+    request.add_field 'Content-Type', 'application/json'
+    request.body = payload.to_json
+
+    Net::HTTP.start(uri.host, uri.port, {:use_ssl => uri.scheme == 'https'}) do |http|
+      rsp = http.request(request)
+      if rsp.code.to_i != 200
+        raise Error.new("HTTP error code=#{rsp.code}")
+      end
+      json = JSON.parse(rsp.body)
+      if json.is_a?(Hash) and json.has_key?('error')
+        raise Error.new("Wit responded with an error: #{json['error']}")
+      end
+      logger.debug("#{meth_class} #{uri} #{json}")
+      json
+    end
+  end
 end

data/wit.gemspec

@@ -1,7 +1,8 @@
+# Copyright (c) Facebook, Inc. and its affiliates. All Rights Reserved.
+
 Gem::Specification.new do |s|
   s.name = 'wit'
-  s.version = '3.4.0'
-  s.date = Date.today.to_s
+  s.version = '7.0.0'
   s.summary = 'Ruby SDK for Wit.ai'
   s.description = 'Ruby SDK for Wit.ai'
   s.authors = ['The Wit Team']

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: wit
 version: !ruby/object:Gem::Version
-  version: 3.4.0
+  version: 7.0.0
 platform: ruby
 authors:
 - The Wit Team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-23 00:00:00.000000000 Z
+date: 2020-05-27 00:00:00.000000000 Z
 dependencies: []
 description: Ruby SDK for Wit.ai
 email: help@wit.ai
@@ -16,14 +16,19 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/ISSUE_TEMPLATE.md"
 - ".gitignore"
 - CHANGES.md
+- CODE_OF_CONDUCT.md
+- CONTRIBUTING.md
 - Gemfile
 - LICENSE
 - README.md
+- examples/basic.rb
+- examples/celebrities.rb
 - examples/joke.rb
-- examples/quickstart.rb
-- examples/template.rb
+- examples/wit-example-celebrities.zip
+- examples/wit-example-joke-bot.zip
 - lib/wit.rb
 - wit.gemspec
 homepage: https://wit.ai
@@ -45,8 +50,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 3.1.3
 signing_key: 
 specification_version: 4
 summary: Ruby SDK for Wit.ai

data/examples/quickstart.rb

@@ -1,37 +0,0 @@
-require 'wit'
-
-# Quickstart example
-# See https://wit.ai/l5t/Quickstart
-
-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
-  val = entities[entity][0]['value']
-  return nil if val.nil?
-  return val.is_a?(Hash) ? val['value'] : val
-end
-
-actions = {
-  :say => -> (session_id, context, msg) {
-    p msg
-  },
-  :merge => -> (session_id, context, entities, msg) {
-    loc = first_entity_value entities, 'location'
-    context['loc'] = loc unless loc.nil?
-    return context
-  },
-  :error => -> (session_id, context, error) {
-    p error.message
-  },
-  :'fetch-weather' => -> (session_id, context) {
-    context['forecast'] = 'sunny'
-    return context
-  },
-}
-client = Wit.new access_token, actions
-client.interactive

data/examples/template.rb

@@ -1,19 +0,0 @@
-require 'wit'
-
-access_token = 'YOUR_ACCESS_TOKEN'
-
-actions = {
-  :say => -> (session_id, context, msg) {
-    p msg
-  },
-  :merge => -> (session_id, context, entities, msg) {
-    return context
-  },
-  :error => -> (session_id, context, error) {
-    p error.message
-  },
-}
-client = Wit.new access_token, actions
-
-session_id = 'my-user-id-42'
-client.run_actions session_id, 'your message', {}