wit 1.0.6 → 2.0.0

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    MzY1NWI4ODFiMzhkMTNhMzA4NjEwYTQ3MDQwOGI4MjMwNWViYjE1Mw==
-  data.tar.gz: !binary |-
-    OTRjZTg4MGVhYWJkYzUzNTZkMTFhNDc0NzE3ZDA4ZGM1MjJlYmMyNw==
+SHA1:
+  metadata.gz: fb6fd4fd673c2e0a4788d1f843d316fa925a7afd
+  data.tar.gz: f86c64544a7dd61b3b1f232c3a9a9e48e590d38b
 SHA512:
-  metadata.gz: !binary |-
-    NDQ3MjgwMjQ3YmViMGRlMTY4OGVlMTVmMmRkZTkwZTE1ODdjNDExYWIyMjkw
-    YTc5YzVjODc3NTk4MDNlMjkyM2IwN2QyNjk3ZDg3Y2M1ZWI0MjFhZDg3ZTUx
-    OWEyYTNiZmM0YzA0ODFiNTAzMDZlZDhmYmE4NjczYmE2MWJmYmM=
-  data.tar.gz: !binary |-
-    MWZkZGI0Y2Q4NjQ0OTZjOTZlZTNkMjg0YzYyYjgyYWU1Yzc2ODg1ZmIxMDVm
-    NGFlNDQxNzU1ZDI5OGY3MzkwMGYzNzVjYmQ0ZjExODA2ZWFlYmI0OTU3MTky
-    MzU5N2RlYTIwMDNhNGI2YjZiNGFjNDcyNjQzZjc3NzNiNGFiODY=
+  metadata.gz: f4de22f57f076e5946c600e45a2cd09e8fbe222bbe5ff6215bcdd7bb978e51a6224ca5f74bfe5a7013c37085d093c1b393aa8d34305c7635b55753ba2f6fd41c
+  data.tar.gz: aa5003e437f4716b8961d0d58f42449a3ce490bc09b7c891a144e1bd605bf55e206162f111422221b786533a97651a1d756100ea7a5325b0b6ad1d413f43ec06

data/.gitignore

@@ -0,0 +1,3 @@
+*.gem
+*.swo
+*.swp

data/CHANGES.md

@@ -0,0 +1,13 @@
+## 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/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,41 @@
+# wit-ruby
+
+`wit-ruby` is a Ruby client to easily use the [Wit.ai](http://wit.ai) HTTP API.
+
+## Install
+
+```bash
+gem install wit
+```
+
+## Usage
+
+```ruby
+require 'wit'
+p Wit.message('MY_ACCESS_TOKEN', 'turn on the lights in the kitchen')
+```
+
+See below for more examples.
+
+## Install from source
+
+```bash
+git clone https://github.com/wit-ai/wit-ruby
+gem build wit.gemspec
+gem install wit-*.gem
+```
+
+## API
+
+```ruby
+require 'wit'
+
+access_token = 'MY_ACCESS_TOKEN'
+
+# GET /message to extract intent and entities from user request
+p Wit.message(access_token, 'turn on the lights in the kitchen')
+```
+
+## Thanks
+
+Thanks to [Justin Workman](http://github.com/xtagon) for releasing a first version in October 2013. We really appreciate!

data/lib/wit.rb

@@ -0,0 +1,37 @@
+module Wit
+  require 'json'
+  require 'net/http'
+
+  WIT_API_HOST = ENV['WIT_URL'] || 'https://api.wit.ai'
+
+  class WitException < Exception
+  end
+
+  def self.req(access_token, meth_class, path, params)
+    uri = URI(WIT_API_HOST + path)
+    uri.query = URI.encode_www_form(params)
+
+    req = meth_class.new(uri)
+    req['authorization'] = 'Bearer ' + access_token
+    req['accept'] = 'application/vnd.wit.20160330+json'
+
+    Net::HTTP.start(
+      uri.host, uri.port, :use_ssl => uri.scheme == 'https'
+    ) do |http|
+      rsp = http.request(req)
+      if rsp.code.to_i > 200
+        raise WitException.new('HTTP error code=' + rsp.code)
+      end
+
+      JSON.parse(rsp.body)
+    end
+  end
+
+  def self.message(access_token, msg)
+    params = {}
+    if msg
+      params[:q] = msg
+    end
+    req(access_token, Net::HTTP::Get, '/message', params)
+  end
+end

data/wit.gemspec

@@ -0,0 +1,15 @@
+Gem::Specification.new do |s|
+	s.name = 'wit'
+	s.version = '2.0.0'
+	s.date = '2014-12-05'
+	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

@@ -1,27 +1,28 @@
 --- !ruby/object:Gem::Specification
 name: wit
 version: !ruby/object:Gem::Version
-  version: 1.0.6
+  version: 2.0.0
 platform: ruby
 authors:
-- Julien Odent
+- The Wit Team
 autorequire: 
 bindir: bin
 cert_chain: []
 date: 2014-12-05 00:00:00.000000000 Z
 dependencies: []
-description: Ruby SDK for Wit.AI
-email: julien@wit.ai
+description: Ruby SDK for Wit.ai
+email: help@wit.ai
 executables: []
-extensions:
-- ext/wit/extconf.rb
+extensions: []
 extra_rdoc_files: []
 files:
-- ext/wit/extconf.rb
-- ext/wit/extconf.rb_
-- ext/wit/libwit/include/wit.h
-- ext/wit/wit.c
-homepage: http://wit.ai
+- .gitignore
+- CHANGES.md
+- LICENSE
+- README.md
+- lib/wit.rb
+- wit.gemspec
+homepage: https://wit.ai
 licenses:
 - GPL-2.0
 metadata: {}
@@ -31,18 +32,18 @@ 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.2.2
+rubygems_version: 2.0.14.1
 signing_key: 
 specification_version: 4
-summary: Ruby SDK for Wit
+summary: Ruby SDK for Wit.ai
 test_files: []

data/ext/wit/extconf.rb

@@ -1,68 +0,0 @@
-require "mkmf"
-require 'open-uri'
-require 'fileutils'
-
-PATH = File.expand_path(File.dirname(__FILE__))
-
-LIBDIR = RbConfig::CONFIG['libdir']
-INCLUDEDIR = RbConfig::CONFIG['includedir']
-HEADER_DIRS = [
-	"#{PATH}/libwit/include",
-	INCLUDEDIR
-]
-LIB_DIRS = [
-	"#{PATH}/libwit/lib",
-	LIBDIR
-]
-
-if RUBY_PLATFORM.include? 'arm'
-	LIBWIT_FILE = 'libwit-armv6.a'
-elsif RUBY_PLATFORM.include? '64'
-	if RUBY_PLATFORM.include? 'darwin'
-		LIBWIT_FILE = 'libwit-64-darwin.a'
-	else
-		LIBWIT_FILE = 'libwit-64-linux.a'
-	end
-else
-	LIBWIT_FILE = 'libwit-32-linux.a'
-end
-LIBWIT_PATH = "#{PATH}/libwit/lib/libwit.a"
-
-if !File.file?(LIBWIT_PATH)
-	puts "Fetching libwit..."
-	dir = File.dirname(LIBWIT_PATH)
-	unless File.directory?(dir)
-		FileUtils.mkdir_p(dir)
-	end
-	open(LIBWIT_PATH, 'wb') do |file|
-		total = nil
-		file << open("https://github.com/wit-ai/libwit/releases/download/1.1.2/#{LIBWIT_FILE}",
-		  :content_length_proc => lambda {|t|
-		  	total = t
-		  	print "0/#{total} bytes downloaded"
-		  	STDOUT.flush
-		  },
-		  :progress_proc => lambda {|s|
-		  	print "\r#{s}/#{total} bytes downloaded"
-		  	STDOUT.flush
-		  }).read
-	end
-	STDOUT.print(" done\n")
-end
-
-if RUBY_PLATFORM.include? 'darwin'
-	libs = ['wit', 'ssl', 'crypto', 'z', 'sox', 'System', 'pthread', 'c', 'm']
-else
-	libs = ['wit', 'rt', 'sox', 'ssl', 'crypto', 'dl', 'pthread', 'rt', 'gcc_s', 'pthread', 'c', 'm']
-end
-
-$LOCAL_LIBS = '-l' + libs.join(' -l')
-
-dir_config 'wit', HEADER_DIRS, LIB_DIRS
-
-for lib in libs
-	abort "Error: missing #{lib}" unless have_library lib
-end
-abort 'Error: missing wit.h' unless have_header 'wit.h'
-
-create_makefile 'wit'

data/ext/wit/extconf.rb_

@@ -1,39 +0,0 @@
-require "mkmf"
-
-PATH = File.expand_path(File.dirname(__FILE__))
-
-LIBDIR = RbConfig::CONFIG['libdir']
-INCLUDEDIR = RbConfig::CONFIG['includedir']
-HEADER_DIRS = [
-	PATH + '/libwit/include',
-	INCLUDEDIR
-]
-LIB_DIRS = [
-	PATH + '/libwit/lib',
-	LIBDIR
-]
-
-if RUBY_PLATFORM.include? "arm"
-	LIBWIT_FILE = "libwit-armv6.a"
-elsif RUBY_PLATFORM.include? "64"
-	if RUBY_PLATFORM.include? "darwin"
-		LIBWIT_FILE = "libwit-64-darwin.a"
-	else
-		LIBWIT_FILE = "libwit-64-linux.a"
-	end
-else
-	LIBWIT_FILE = "libwit-32-linux.a"
-end
-
-abort "unable to retrieve libwit" unless system('curl -Ss -L -o libwit.a https://github.com/wit-ai/libwit/releases/download/1.1.1/' + LIBWIT_FILE, :chdir=> PATH + '/libwit/lib')
-
-$LOCAL_LIBS = '-lwit -lsox -lcurl'
-
-dir_config 'wit', HEADER_DIRS, LIB_DIRS
-
-abort "missing sox" unless have_library "sox"
-abort "missing curl" unless have_library "curl"
-abort "missing wit.h" unless have_header "wit.h"
-abort "missing libwit" unless have_library "wit"
-
-create_makefile "wit"

data/ext/wit/libwit/include/wit.h

@@ -1,81 +0,0 @@
-#ifndef WIT_H
-#define WIT_H
-
-#include <stdlib.h>
-
-struct wit_context;
-typedef void (*wit_resp_callback)(char *);
-
-/**
- * Initialize the resources for audio recording and Wit API requests.
- * This function returns a context object used by all the other functions
- * in the library.
- * The resources can be released using wit_close.
- */
-struct wit_context *wit_init(const char *device_opt, unsigned int verbosity);
-
-/**
- * Release the resources allocated by wit_init.
- * The context object should not be used for any other purpose after this function
- * has been called.
- */
-void wit_close(struct wit_context *context);
-
-/**
- * Send a text query to the Wit instance identified by the access_token.
- * This function is blocking, and returns the response from the Wit instance.
- */
-char *wit_text_query(struct wit_context *context, const char *text, const char *access_token);
-
-/**
- * Send a text query to the Wit instance identified by the access_token.
- * This function is non-blocking. When a response is received from the Wit instance, the
- * given callback is called with the response given as an argument.
- */
-void wit_text_query_async(struct wit_context *context, const char *text, const char *access_token, wit_resp_callback cb);
-
-/**
- * Send a voice query to the Wit instance identified by the access_token.
- * This function is blocking, and returns the response from the Wit instance.
- *
- * The function attempts to automatically detect when the user stops speaking. If this
- * fails, the wit_voice_query_stop or wit_voice_query_stop_async functions below can
- * be used to trigger the end of the request and receive the response.
- */
-char *wit_voice_query_auto(struct wit_context *context, const char *access_token);
-
-/**
- * Send a voice query to the Wit instance identified by the access_token.
- * This function is non-blocking. When a response is received from the Wit instance, the
- * given callback is called with the response given as an argument.
- *
- * The function attempts to automatically detect when the user stops speaking. If this
- * fails, the wit_voice_query_stop or wit_voice_query_stop_async functions below can
- * be used to trigger the end of the request and receive the response.
- */
-void wit_voice_query_auto_async(struct wit_context *context, const char *access_token, wit_resp_callback cb);
-
-/**
- * Send a voice query to the Wit instance identified by the access_token.
- * This function returns immediately: the recording session stops only when either
- * wit_voice_query_stop or wit_voice_query_stop_async is called. No end-of-speech
- * detection is performed.
- */
-void wit_voice_query_start(struct wit_context *context, const char *access_token);
-
-/**
- * Stop the ongoing recording session and receive the response.
- * This function is blocking, and returns the response from the Wit instance.
- * This function has no effect if there is no ongoing recording session.
- */
-char *wit_voice_query_stop(struct wit_context *context);
-
-/**
- * Stop the ongoing recording session and receive the response.
- * This function is non-blocking. When a response is received from the Wit instance, the
- * given callback is called with the response given as an argument.
- * This function has no effect if there is no ongoing recording session.
- */
-void wit_voice_query_stop_async(struct wit_context *context, wit_resp_callback cb);
-
-#endif

data/ext/wit/wit.c

@@ -1,152 +0,0 @@
-#include <ruby.h>
-#include "wit.h"
-
-struct wit_context *context;
-static VALUE e_WitError;
-static VALUE rb_cb;
-
-static VALUE libwit_init(int argc, VALUE *argv, VALUE obj) {
-	const char *device_opt = NULL;
-	VALUE device = Qnil;
-	rb_scan_args(argc, argv, "01", &device);
-	if (device != Qnil) {
-		Check_Type(device, T_STRING);
-		device_opt = StringValuePtr(device);
-	}
-	context = wit_init(device_opt, 4);
-	return Qnil;
-}
-
-static VALUE libwit_close(VALUE obj) {
-	if (context != NULL) {
-		wit_close(context);
-	}
-	return Qnil;
-}
-
-static VALUE libwit_text_query(VALUE obj, VALUE text, VALUE access_token) {
-	const char *resp;
-	if (context == NULL)
-		rb_raise(e_WitError, "Wit context uninitialized (did you call Wit.init?)");
-	Check_Type(text, T_STRING);
-	Check_Type(access_token, T_STRING);
-	VALUE str = Qnil;
-	resp = wit_text_query(context, StringValuePtr(text), StringValuePtr(access_token));
-	if (resp != NULL)
-		str = rb_str_new2(resp);
-	xfree((char *)resp);
-	return str;
-}
-
-static VALUE libwit_voice_query_start(VALUE obj, VALUE access_token) {
-	if (context == NULL)
-		rb_raise(e_WitError, "Wit context uninitialized (did you call Wit.init?)");
-	Check_Type(access_token, T_STRING);
-	wit_voice_query_start(context, StringValuePtr(access_token));
-	return Qnil;
-}
-
-static VALUE libwit_voice_query_stop(VALUE obj) {
-	const char *resp;
-	if (context == NULL)
-		rb_raise(e_WitError, "Wit context uninitialized (did you call Wit.init?)");
-	VALUE str = Qnil;
-	resp = wit_voice_query_stop(context);
-	if (resp != NULL)
-		str = rb_str_new2(resp);
-	xfree((char *)resp);
-	return str;
-}
-
-static VALUE libwit_voice_query_auto(VALUE obj, VALUE access_token)
-{
-	const char *resp;
-	if (context == NULL)
-		rb_raise(e_WitError, "Wit context uninitialized (did you call Wit.init?)");
-	Check_Type(access_token, T_STRING);
-	VALUE str = Qnil;
-	resp = wit_voice_query_auto(context, StringValuePtr(access_token));
-	if (resp != NULL)
-		str = rb_str_new2(resp);
-	xfree((char *)resp);
-	return str;
-}
-
-static VALUE thread_wrapper_proc(void *args) {
-	VALUE str = Qnil;
-        if ((char *) args != NULL)
-		str = rb_str_new2((char *) args);
-	xfree(args);
-	rb_funcall(rb_cb, rb_intern("call"), 1, str);
-	return Qnil;
-}
-
-static VALUE thread_wrapper_meth(void *args) {
-	VALUE str = Qnil;
-	if ((char *) args != NULL)
-		str = rb_str_new2((char *) args);
-	xfree(args);
-	rb_funcall(rb_class_of(rb_cb), rb_to_id(rb_cb), 1, str);
-	return Qnil;
-}
-
-void my_wit_resp_callback(char *res) {
-	if (rb_cb == Qnil)
-		rb_raise(rb_eRuntimeError, "callback is nil");
-	if (rb_class_of(rb_cb) == rb_cProc)
-		rb_thread_create(thread_wrapper_proc, (char *)res);
-	else if (rb_class_of(rb_cb) == rb_cSymbol)
-		rb_thread_create(thread_wrapper_meth, (char *)res);
-	else
-		rb_raise(rb_eTypeError, "expected Proc or Symbol callback");
-}
-
-static VALUE libwit_text_query_async(VALUE obj, VALUE text, VALUE access_token, VALUE callback)
-{
-	if (context == NULL)
-		rb_raise(e_WitError, "Wit context uninitialized (did you call Wit.init?)");
-	Check_Type(text, T_STRING);
-	Check_Type(access_token, T_STRING);
-	if (rb_class_of(callback) != rb_cSymbol && rb_class_of(callback) != rb_cProc)
-		rb_raise(rb_eTypeError, "expected Proc or Symbol callback");
-	rb_cb = callback;
-	wit_text_query_async(context, StringValuePtr(text), StringValuePtr(access_token), my_wit_resp_callback);
-	return Qnil;
-}
-
-static VALUE libwit_voice_query_stop_async(VALUE obj, VALUE callback)
-{
-	if (context == NULL)
-		rb_raise(e_WitError, "Wit context uninitialized (did you call Wit.init?)");
-	if (rb_class_of(callback) != rb_cSymbol && rb_class_of(callback) != rb_cProc)
-		rb_raise(rb_eTypeError, "expected Proc or Symbol callback");
-	rb_cb = callback;
-	wit_voice_query_stop_async(context, my_wit_resp_callback);
-	return Qnil;
-}
-
-static VALUE libwit_voice_query_auto_async(VALUE obj, VALUE access_token, VALUE callback)
-{
-	if (context == NULL)
-		rb_raise(e_WitError, "Wit context uninitialized (did you call Wit.init?)");
-	Check_Type(access_token, T_STRING);
-	if (rb_class_of(callback) != rb_cSymbol && rb_class_of(callback) != rb_cProc)
-		rb_raise(rb_eTypeError, "expected Proc or Symbol callback");
-	rb_cb = callback;
-	wit_voice_query_auto_async(context, StringValuePtr(access_token), my_wit_resp_callback);
-	return Qnil;
-}
-
-void Init_wit(void) {
-	VALUE wit_module = rb_define_module("Wit");
-	e_WitError = rb_define_class_under(wit_module, "Wit error", rb_eStandardError);
-	rb_define_module_function(wit_module, "init", libwit_init, -1);
-	rb_define_module_function(wit_module, "close", libwit_close, 0);
-	rb_define_module_function(wit_module, "text_query", libwit_text_query, 2);
-	rb_define_module_function(wit_module, "voice_query_start", libwit_voice_query_start, 1);
-	rb_define_module_function(wit_module, "voice_query_stop", libwit_voice_query_stop, 0);
-	rb_define_module_function(wit_module, "voice_query_auto", libwit_voice_query_auto, 1);
-	rb_define_module_function(wit_module, "text_query_async", libwit_text_query_async, 3);
-	rb_define_module_function(wit_module, "voice_query_stop_async", libwit_voice_query_stop_async, 1);
-	rb_define_module_function(wit_module, "voice_query_auto_async", libwit_voice_query_auto_async, 2);
-}