wit_ai 7.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b8aff10821a6cd3d9f6e3c3c41c25c9473b8c0e29c499c85b527d9de713bd98c
+  data.tar.gz: 5cb36e2fd49330c661f44da94fa6530bf608602721fc651ce403ccacceb64277
+SHA512:
+  metadata.gz: 3379043b960510e9e446ad20f22ac74eab790f36a10e51886aaadf57bc4ca9c9b8771154417e2cfc07d6c971afe33277fa816717a6f3a0707b363efe67fe4e1f
+  data.tar.gz: 4c7951e8a4f07e880ef781100bfa2703c45d2402891cf04a67506362fed89dbaef0d470e78ad7eb3f1c2dadd6f56e725eb3339cd5a7f1dcc8228db8ae2b6167e

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/.gitignore

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

data/CHANGES.md

@@ -0,0 +1,105 @@
+## 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
+
+- bumped default API version from `20160330` to `20160516`
+
+## v3.3.1
+
+- fixed recursive call when running actions
+- throws an exception if context passed is not a Hash
+
+## 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
+- better error message
+
+## v3.0
+
+Bot Engine integration
+
+### breaking
+
+- the `message` API is wrapped around a `Wit` class, and doesn't take the token as first parameter
+
+## v2.0
+
+Rewrite in pure Ruby
+
+### breaking
+
+- audio recording and streaming have been removed because:
+  - many people only needed access to the HTTP API, and audio recording did not make sense for server-side use cases
+  - dependent on platform, choice best left to developers
+  - forced us to maintain native bindings as opposed to a pure Pythonic library
+- we renamed the functions to match the HTTP API more closely
+  - `.text_query(string, access_token)` becomes `.message(access_token, string)`
+- all functions now return a Ruby dict instead of a JSON string

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/Gemfile

@@ -0,0 +1 @@
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+/**
+* Copyright (c) 2014, Wit.ai, Inc. All rights reserved.
+*
+* You are hereby granted a non-exclusive, worldwide, royalty-free license to
+* use, copy, modify, and distribute this software in source code or binary
+* form for use in connection with the web services and APIs provided by
+* Wit.ai.
+*
+* As with any software that integrates with the Wit.ai platform, your use
+* of this software is subject to the Wit.ai Terms of Service
+* [https://wit.ai/terms]. This copyright notice shall be included in all
+* copies or substantial portions of the software.
+*
+* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
+* THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+* FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
+* DEALINGS IN THE SOFTWARE.
+*
+*/

data/README.md

@@ -0,0 +1,225 @@
+# wit-ruby
+
+`wit-ruby` is the Ruby SDK for [Wit.ai](http://wit.ai).
+
+## Install
+
+From RubyGems:
+```bash
+gem install wit
+```
+
+From source:
+```bash
+git clone https://github.com/wit-ai/wit-ruby
+gem build wit.gemspec
+gem install wit-*.gem
+```
+
+## Quickstart
+
+Run in your terminal:
+
+```bash
+ruby examples/basic.rb <your_token>
+```
+
+See the `examples` folder for more examples.
+
+## API
+
+### Overview
+
+`wit-ruby` provides a Wit class with the following methods:
+* `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 a `Hash` with the following symbol keys:
+* `:access_token` - the access token of your Wit instance
+
+A minimal example looks like this:
+```ruby
+require 'wit'
+
+client = Wit.new(access_token: access_token)
+client.message('set an alarm tomorrow at 7am')
+```
+
+### Create new App Using the Access Token
+
+Creates new app using the server token.
+See [POST /apps](https://wit.ai/docs/http/20200513#post__apps_link).
+
+```ruby
+new_app_payload = {name: "new-app-1", lang: "en", private: true}
+# set_new_app_token will make the client use the new app's token.
+# that flag is set to false by default.
+client.create_new_app(new_app_payload, set_new_app_token = true)
+```
+
+### Train the app programatically using '/utterances'
+
+Trains and annotates an utterance or more.
+See [POST /utterances](https://wit.ai/docs/http/20200513#post__utterances_link).
+
+```ruby
+# you have to create the intent and entity before using any of them.
+utterance_payload = {
+  text: "I want to fly to china",
+  intent: "flight_request",
+  entities: [
+    {
+      "entity": "wit$location:to",
+      "start": 17,
+      "end": 22,
+      "body": "china",
+      "entities": []
+    }
+  ],
+  traits: []
+}
+
+# utterance payload can be a list of utterances or a single one
+client.post_utterances(utterance_payload)
+```
+
+### .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
+rsp = client.message('what is the weather in London?')
+puts("Yay, got Wit.ai response: #{rsp}")
+```
+
+### .interactive()
+
+Starts an interactive conversation with your bot.
+
+Example:
+```ruby
+client.interactive
+```
+
+### CRUD operations for intents
+`payload` in the parameters is a hash containing API arguments.
+
+#### .get_intents()
+Returns a list of available intents for the app.
+See [GET /intents](https://wit.ai/docs/http/20200513#get__intents_link).
+
+#### .get_intent(intent)
+Returns all available information about an intent.
+See [GET /intents/:intent](https://wit.ai/docs/http/20200513#get__intents__intent_link).
+
+#### .post_intents(payload)
+Creates a new intent.
+See [POST /intents](https://wit.ai/docs/http/20200513#post__intents_link).
+
+#### .delete_intents(intent)
+Permanently deletes the intent.
+See [DELETE /intents/:intent](https://wit.ai/docs/http/20200513#delete__intents__intent_link).
+
+### CRUD operations for entities
+`payload` in the parameters is a hash containing API arguments.
+
+#### .get_entities()
+Returns a list of available entities for the app.  
+See [GET /entities](https://wit.ai/docs/http/20200513#get--entities-link)
+
+#### .post_entities(payload)
+Creates a new entity with the given attributes.  
+See [POST /entities](https://wit.ai/docs/http/20200513#post--entities-link)
+
+#### .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)
+
+#### .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)
+
+#### .delete_entities(entity)
+Permanently removes the entity.  
+See [DELETE /entities/:entity](https://wit.ai/docs/http/20200513#delete--entities-:entity-link)
+
+#### .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)
+
+#### .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)
+
+#### 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).
+
+
+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

@@ -0,0 +1,58 @@
+# 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
+
+# Joke example
+# See https://wit.ai/aleka/wit-example-joke-bot/
+
+def first_value(obj, key)
+  return nil unless obj.has_key? key
+  val = obj[key][0]['value']
+  return nil if val.nil?
+  return val
+end
+
+$all_jokes = {
+  'chuck' => [
+    'Chuck Norris counted to infinity - twice.',
+    'Death once had a near-Chuck Norris experience.',
+  ],
+  'tech' => [
+    'Did you hear about the two antennas that got married? The ceremony was long and boring, but the reception was great!',
+    'Why do geeks mistake Halloween and Christmas? Because Oct 31 === Dec 25.',
+  ],
+  'default' => [
+    'Why was the Math book sad? Because it had so many problems.',
+  ],
+}
+
+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
+
+client = Wit.new(access_token: access_token)
+client.interactive(method(:handle_message))

data/lib/wit.rb

@@ -0,0 +1,229 @@
+# Copyright (c) Facebook, Inc. and its affiliates. All Rights Reserved.
+
+require 'json'
+require 'logger'
+require 'net/http'
+require 'securerandom'
+
+class Wit
+  class Error < StandardError; 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 initialize(opts = {})
+    @access_token = opts[:access_token]
+
+    if opts[:logger]
+      @logger = opts[:logger]
+    end
+  end
+
+  def logger
+    @logger ||= begin
+      x = Logger.new(STDOUT)
+      x.level = Logger::INFO
+      x
+    end
+  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
+
+  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 create_new_app(payload, set_new_app_token = false)
+    response = req(logger, @access_token, Net::HTTP::Post, "/apps", {}, payload)
+    @access_token = response['access_token'] if set_new_app_token
+    return response
+  end
+
+  def post_utterances(payload)
+    payload = [payload] if payload.is_a? Hash
+
+    payload.each do |utterance|
+      unless utterance[:entities].empty?
+        utterance[:entities] = validate_entities utterance[:entities]
+      end
+      validate_payload utterance
+    end
+    req(logger, @access_token, Net::HTTP::Post, "/utterances", {}, payload)
+  end
+
+  def get_intents
+    req(logger, @access_token, Net::HTTP::Get, "/intents")
+  end
+
+  def get_intent(intent)
+    req(logger, @access_token, Net::HTTP::Get, "/intents/#{URI.encode(intent)}")
+  end
+
+  def post_intents(payload)
+    req(logger, @access_token, Net::HTTP::Post, "/intents", {}, payload)
+  end
+
+  def delete_intents(intent)
+    req(logger, @access_token, Net::HTTP::Delete, "/intents/#{URI.encode(intent)}")
+  end
+
+  def get_entities
+    req(logger, @access_token, Net::HTTP::Get, "/entities")
+  end
+
+  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
+
+  def get_entity(entity)
+    req(logger, @access_token, Net::HTTP::Get, "/entities/#{URI.encode(entity)}")
+  end
+
+  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 delete_entities(entity)
+    req(logger, @access_token, Net::HTTP::Delete, "/entities/#{URI.encode(entity)}")
+  end
+
+  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
+
+  def delete_entities_keywords(entity, keyword)
+    req(logger, @access_token, Net::HTTP::Delete, "/entities/#{URI.encode(entity)}/keywords/#{URI.encode(keyword)}")
+  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,
+      keyword: String,
+      synonyms: Array,
+      text: String,
+      intent: String,
+      entities: Array,
+      traits: 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
+  end
+
+  def validate_entities(entities)
+    entity_keys = {
+      entity: String,
+      start: Integer,
+      end: Integer,
+      body: String,
+      entities: Array
+    }
+    entities.each do |entity|
+      entity = entity.map {|k, v| [(k.to_sym rescue k), v]}.to_h.reject{ |k| !entity_keys.keys.include?(k) }
+      entity.each do |k, v|
+        if k == :entities && !v.empty?
+          validate_entities(v)
+        end
+        raise Error.new("#{k.to_s} in entities body must be #{entity_keys[k].to_s} type") unless entity_keys[k] == v.class
+      end
+    end
+
+    return entities
+  end
+
+  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)
+      json = JSON.parse(rsp.body)
+      if rsp.code.to_i != 200
+        error_msg = (json.is_a?(Hash) and json.has_key?('error')) ?  json['error'] : json
+        raise Error.new("Wit responded with an error: #{error_msg}")
+      end
+      logger.debug("#{meth_class} #{uri} #{json}")
+      json
+    end
+  end
+end

data/wit.gemspec

@@ -0,0 +1,16 @@
+# Copyright (c) Facebook, Inc. and its affiliates. All Rights Reserved.
+
+Gem::Specification.new do |s|
+  s.name = 'wit_ai'
+  s.version = '7.0.0'
+  s.summary = 'Ruby SDK for Wit.ai'
+  s.description = 'Ruby SDK for Wit.ai'
+  s.authors = ['The Wit Team']
+  s.email = 'help@wit.ai'
+  s.homepage = 'https://wit.ai'
+  s.license = 'GPL-2.0'
+  s.platform = Gem::Platform::RUBY
+  s.required_ruby_version = '>= 1.9.3'
+  s.require_paths = ['lib']
+  s.files = `git ls-files`.split("\n")
+end

metadata

@@ -0,0 +1,57 @@
+--- !ruby/object:Gem::Specification
+name: wit_ai
+version: !ruby/object:Gem::Version
+  version: 7.0.0
+platform: ruby
+authors:
+- The Wit Team
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-07-15 00:00:00.000000000 Z
+dependencies: []
+description: Ruby SDK for Wit.ai
+email: help@wit.ai
+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/wit-example-celebrities.zip
+- examples/wit-example-joke-bot.zip
+- lib/wit.rb
+- wit.gemspec
+homepage: https://wit.ai
+licenses:
+- GPL-2.0
+metadata: {}
+post_install_message:
+rdoc_options: []
+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: []
+rubygems_version: 3.2.3
+signing_key:
+specification_version: 4
+summary: Ruby SDK for Wit.ai
+test_files: []