wit 7.0.0 → 7.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1a15b6f521d5b67b3c2d512e1ea9262ef4b1e39109e22eb9822a10aabe8e7b34
-  data.tar.gz: 6fd43d27a1edc8ccba793c45ca0fac4e90f9c27d265b3a105135e1bfb85b707e
+  metadata.gz: 94c89f68746b71c5af51cd31f5479780820a01ec01401adc6234dfcab54460d6
+  data.tar.gz: e364ac9ca54797c85bd098279e4add1360b4c3e1a63e1f5ddf2f7ac94dd1411d
 SHA512:
-  metadata.gz: eed12472514c8efdcbf6716b637aed58820dd98c437703566c027a10b57dca54877011d02dbc173e326aad8f7fa6a7d6c28ca499161070a73b913e73d840b650
-  data.tar.gz: 6d6f64a64117a9fd39ba9eb6074e3b7dc17bad80e48382930ea21f4584b2a1c96b5289df4ffdc6623ab8691d10c4af515f112551fd8e787184dec83e8fa01091
+  metadata.gz: fbe3df4df740ddbdae3bb8c021de7d4caf4d280454a85ac2ad07e45e49018b265e86e9a94f0da7c7b69760e5942d2f7fd47103dd58ea5a7430bc43ab93ab0121
+  data.tar.gz: c934ff92d4d252af1dcf57b6582612b0ea229d9d441a4507efeffa1d7a7749af07819ee36ccd7dbe55f85906c7973f30aecf08bad5120c8a7fa05293e873717b

data/CHANGES.md

@@ -1,3 +1,6 @@
+## v7.0.1
+- Updating encode function to encode more special characters that could be passed in when constructing a request URL.
+
 ## 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.

data/README.md

@@ -47,6 +47,44 @@ 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).

data/lib/wit.rb

@@ -1,5 +1,6 @@
 # Copyright (c) Facebook, Inc. and its affiliates. All Rights Reserved.
 
+require 'cgi'
 require 'json'
 require 'logger'
 require 'net/http'
@@ -59,12 +60,30 @@ class Wit
     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)}")
+    req(logger, @access_token, Net::HTTP::Get, "/intents/#{CGI::escape(intent)}")
   end
 
   def post_intents(payload)
@@ -72,7 +91,7 @@ class Wit
   end
 
   def delete_intents(intent)
-    req(logger, @access_token, Net::HTTP::Delete, "/intents/#{URI.encode(intent)}")
+    req(logger, @access_token, Net::HTTP::Delete, "/intents/#{CGI::escape(intent)}")
   end
 
   def get_entities
@@ -86,37 +105,37 @@ class Wit
   end
 
   def get_entity(entity)
-    req(logger, @access_token, Net::HTTP::Get, "/entities/#{URI.encode(entity)}")
+    req(logger, @access_token, Net::HTTP::Get, "/entities/#{CGI::escape(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)
+    req(logger, @access_token, Net::HTTP::Put, "/entities/#{CGI::escape(entity)}", {}, payload)
   end
 
   def delete_entities(entity)
-    req(logger, @access_token, Net::HTTP::Delete, "/entities/#{URI.encode(entity)}")
+    req(logger, @access_token, Net::HTTP::Delete, "/entities/#{CGI::escape(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)
+    req(logger, @access_token, Net::HTTP::Post, "/entities/#{CGI::escape(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)}")
+    req(logger, @access_token, Net::HTTP::Delete, "/entities/#{CGI::escape(entity)}/keywords/#{CGI::escape(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)
+    req(logger,@access_token, Net::HTTP::Post, "/entities/#{CGI::escape(entity)}/keywords/#{CGI::escape(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)}")
+    req(logger,@access_token, Net::HTTP::Delete, "/entities/#{CGI::escape(entity)}/keywords/#{CGI::escape(keyword)}/synonyms/#{CGI::escape(synonym)}")
   end
 
   def get_traits
@@ -124,7 +143,7 @@ class Wit
   end
 
   def get_trait(trait)
-    req(logger, @access_token, Net::HTTP::Get, "/traits/#{URI.encode(trait)}")
+    req(logger, @access_token, Net::HTTP::Get, "/traits/#{CGI::escape(trait)}")
   end
 
   def post_traits(payload)
@@ -132,15 +151,15 @@ class Wit
   end
 
   def post_traits_values(trait, payload)
-    req(logger, @access_token, Net::HTTP::Post, "/traits/#{URI.encode(trait)}/values", {}, payload)
+    req(logger, @access_token, Net::HTTP::Post, "/traits/#{CGI::escape(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)}")
+    req(logger, @access_token, Net::HTTP::Delete, "/traits/#{CGI::escape(trait)}/values/#{CGI::escape(value)}")
   end
 
   def delete_traits(trait)
-    req(logger, @access_token, Net::HTTP::Delete, "/traits/#{URI.encode(trait)}")
+    req(logger, @access_token, Net::HTTP::Delete, "/traits/#{CGI::escape(trait)}")
   end
 
   private
@@ -152,12 +171,37 @@ class Wit
       roles: Array,
       lookups: Array,
       keywords: 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)
@@ -172,12 +216,10 @@ class Wit
 
     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']}")
+      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

data/wit.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |s|
   s.name = 'wit'
-  s.version = '7.0.0'
+  s.version = '7.0.1'
   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: 7.0.0
+  version: 7.0.1
 platform: ruby
 authors:
 - The Wit Team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-05-27 00:00:00.000000000 Z
+date: 2022-05-10 00:00:00.000000000 Z
 dependencies: []
 description: Ruby SDK for Wit.ai
 email: help@wit.ai
@@ -50,7 +50,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.3
+rubygems_version: 3.0.3.1
 signing_key: 
 specification_version: 4
 summary: Ruby SDK for Wit.ai