wit 0.0.1 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a6ac091647ac82d9f4f086d6daaed555c0af3686
-  data.tar.gz: c74219501fe69d424acbea861836c73bab6b960c
+  metadata.gz: 5677b3c1a4a9686259219e06b8e3674bf59f317f
+  data.tar.gz: 5e9c34e7d8de94a6789caaa0ce4b44e7f374783a
 SHA512:
-  metadata.gz: 6cf30a3a98cae7ab9b2c0f3ca281b2dc057eb95d8e9eb386fcd08b5d345b9002222b733cb69241a09e105fa3640a8f22796436453e3e75ec965145aa54f47c66
-  data.tar.gz: 52eb5fd930b44c1e51d8883af5107299938a8091c6e7ed539fff0e2a310b3d49dc5902c476a16debe4fd19888807d4d0c5589e14aa8dd49a5506263de2e1167f
+  metadata.gz: e10573aebfd4aed8cb7e6b72bb07b99b381d6bdc79e8159c553e8c39e900195c67677c04ef1ad86685983971983368cdc42bc3ff51eb9c981115f28a65c73c88
+  data.tar.gz: 17ebe06ed1b9f53319edcf40691152150b3c8827be63318b56edf826f504cdfc8be12d763db87106033bd69b889c80b06d6a0c1aedd84947cd4dcc3d5d447710

data/ext/wit/extconf.rb

@@ -0,0 +1,36 @@
+require "mkmf"
+
+PATH = File.expand_path(File.dirname(__FILE__))
+
+abort "missing Cargo (http://crates.io)" unless system("cargo")
+
+if not File.exist?(PATH + '/libwit')
+	p "Cloning libwit repository..."
+	abort "unable to clone libwit repository" unless system("git clone https://github.com/wit-ai/libwit.git", :chdir=> PATH)
+	p "Updating libwit..."
+	abort "unable to update libwit repository" unless system("git pull", :chdir=> PATH + "/libwit")
+end
+if not (File.exist?(PATH + '/libwit/include/libwit.a') and File.exist?(PATH + '/libwit/lib/wit.h'))
+	p "Compiling libwit..."
+	abort "could not build libwit" unless system("./build_c.sh;", :chdir=> PATH + "/libwit")
+end
+
+LIBDIR = RbConfig::CONFIG['libdir']
+INCLUDEDIR = RbConfig::CONFIG['includedir']
+HEADER_DIRS = [
+	PATH + '/libwit/include',
+	INCLUDEDIR
+]
+LIB_DIRS = [
+	PATH + '/libwit/lib',
+	LIBDIR
+]
+
+$LOCAL_LIBS = '-lwit -lsox -lcurl'
+
+dir_config 'wit', HEADER_DIRS, LIB_DIRS
+
+abort "missing wit.h" unless have_header "wit.h"
+abort "missing libwit" unless have_library "wit", "wit_init"
+
+create_makefile "wit"

data/ext/wit/wit.c

@@ -0,0 +1,153 @@
+#include <ruby.h>
+#include <ruby/thread.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);
+	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);
+}

metadata

@@ -1,137 +1,27 @@
 --- !ruby/object:Gem::Specification
 name: wit
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 1.0.1
 platform: ruby
 authors:
-- Justin Workman
+- Julien Odent
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-15 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: multi_json
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 1.8.2
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 1.8.2
-- !ruby/object:Gem::Dependency
-  name: rest-client
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 1.6.7
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 1.6.7
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '1.3'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '1.3'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: redcarpet
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 2.14.1
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 2.14.1
-- !ruby/object:Gem::Dependency
-  name: yard
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-description: A Ruby wrapper for the Wit HTTP API, a natural language processing interface.
-email:
-- xtagon@gmail.com
+date: 2014-09-30 00:00:00.000000000 Z
+dependencies: []
+description: Ruby SDK for Wit.AI
+email: julien@wit.ai
 executables: []
-extensions: []
+extensions:
+- ext/wit/extconf.rb
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rspec
-- .yardopts
-- CHANGES.md
-- Gemfile
-- LICENSE.txt
-- README.md
-- Rakefile
-- lib/wit.rb
-- lib/wit/client.rb
-- lib/wit/version.rb
-- spec/spec_helper.rb
-- spec/wit/version_spec.rb
-- wit.gemspec
-homepage: 
+- ext/wit/extconf.rb
+- ext/wit/wit.c
+homepage: http://wit.ai
 licenses:
-- MIT
+- EPL-1.0
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -139,21 +29,18 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 2.4.2
 signing_key: 
 specification_version: 4
-summary: A Ruby wrapper for the Wit HTTP API.
-test_files:
-- spec/spec_helper.rb
-- spec/wit/version_spec.rb
-has_rdoc: 
+summary: Ruby SDK for Wit
+test_files: []

data/.gitignore

@@ -1,17 +0,0 @@
-*.gem
-*.rbc
-.bundle
-.config
-.yardoc
-Gemfile.lock
-InstalledFiles
-_yardoc
-coverage
-doc/
-lib/bundler/man
-pkg
-rdoc
-spec/reports
-test/tmp
-test/version_tmp
-tmp

data/.rspec

@@ -1,2 +0,0 @@
---color
---format progress

data/.yardopts

@@ -1,4 +0,0 @@
--
-CHANGES.md
-LICENSE.txt
-README.md

data/CHANGES.md

@@ -1,6 +0,0 @@
-Wit Gem Changes
-===============
-
-## v0.0.1 - *2013-10-14*
-
-- First version, implementing the one API method: `message`.

data/Gemfile

@@ -1,3 +0,0 @@
-source 'https://rubygems.org'
-
-gemspec

data/LICENSE.txt

@@ -1,22 +0,0 @@
-Copyright (c) 2013 Justin Workman
-
-MIT License
-
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-"Software"), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
-
-The above copyright notice and this permission 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

@@ -1,75 +0,0 @@
-Wit Ruby Gem
-============
-
-This is an unnoficial Ruby wrapper for the [Wit HTTP API][1]. Wit turns natural
-language into structured data, this gem lets you use the Wit API from your Ruby
-app, provided you have a developer's access token.
-
-## Installation
-
-Add this line to your application's Gemfile:
-
-``` ruby
-gem 'wit'
-```
-
-And then execute:
-
-``` shell
-$ bundle
-```
-
-Or install it yourself as:
-
-``` shell
-$ gem install wit
-```
-
-## Usage
-
-At time of writing, the only API method is `message`.
-
-``` ruby
-require 'wit'
-
-wit = Wit::Client.new '<Your API Key>'
-puts wit.message("I need a bud right now")
-```
-
-A JSON Hash will be returned, like so:
-
-``` json
-{
-  "msg_id": "d953bd6c-c620-4dae-a3fc-7634b4330073",
-  "msg_body": "i need a bud right now!",
-  "outcome": {
-    "intent": "grab_me_something",
-    "entities": {
-      "object_to_grab": {
-        "value": "beer",
-        "start": 9,
-        "end": 12,
-        "body": "bud"
-      }
-    },
-    "confidence": 0.6310633902098893
-  }
-}
-```
-
-## Contributing
-
-1. Fork it
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request
-
-## License
-
-Copyright © 2013 [Justin Workman](mailto:xtagon@gmail.com)
-
-MIT License, see LICENSE.txt
-
-
-[1]: https://wit.ai/docs/api

data/Rakefile

@@ -1,8 +0,0 @@
-require 'bundler/gem_tasks'
-require 'rspec/core/rake_task'
-require 'yard'
-
-RSpec::Core::RakeTask.new :spec
-YARD::Rake::YardocTask.new :doc
-
-task default: :spec

data/lib/wit.rb

@@ -1,2 +0,0 @@
-require 'wit/version'
-require 'wit/client'

data/lib/wit/client.rb

@@ -1,53 +0,0 @@
-module Wit
-	# Represents a connection to the Wit HTTP API
-	class Client
-		require 'multi_json'
-		require 'rest_client'
-
-		# The Wit API's base URL
-		API_ENDPOINT = 'https://api.wit.ai'
-
-		# @param [String] access_token Your unique Wit developer's access token
-		# @param [String] expected_version The Wit API version you wish to use ("YYYYMMDD").
-		#   Not passing this version parameter will use the newest version of the API.
-		def initialize(access_token, expected_version = nil)
-			unless expected_version.nil? || expected_version =~ /\d/
-				raise ArgumentError "expected_version must be nil or 'YYYYMMDD' date format"
-			end
-
-			@access_token = access_token
-			@expected_version = expected_version
-		end
-
-		# @note See the official Wit API documentation for details on what these parameters mean.
-		#
-		# @param [String] q User's query
-		# @param [String] context JSON representation of the user's context
-		# @param [String] meta JSON representation of any information you want to
-		#   attach to this request through its life cycle in Wit.
-		#
-		# @return [Hash] The API's JSON response as a Hash
-		def message(q, context = nil, meta = nil)
-			params = {q: q, context: context, meta: meta}
-			headers = default_headers.merge(params: params)
-			response = api['message'].get(headers)
-			MultiJson.load(response)
-		end
-
-		private
-
-		def default_headers
-			unless @default_headers
-				@default_headers = {Authorization: "Bearer #{@access_token}"}
-				unless @expected_version.nil?
-					@default_headers.merge!(Accept: "application/vnd.wit.#{@expected_version}")
-				end
-			end
-			@default_headers
-		end
-
-		def api
-			@api ||= RestClient::Resource.new API_ENDPOINT
-		end
-	end
-end

data/lib/wit/version.rb

@@ -1,4 +0,0 @@
-module Wit
-	# The version of the currently loaded Wit gem
-	VERSION = '0.0.1'
-end

data/spec/spec_helper.rb

@@ -1,13 +0,0 @@
-require 'wit'
-
-RSpec.configure do |config|
-	config.treat_symbols_as_metadata_keys_with_true_values = true
-	config.run_all_when_everything_filtered = true
-	config.filter_run :focus
-
-	# Run specs in random order to surface order dependencies. If you find an
-	# order dependency and want to debug it, you can fix the order by providing
-	# the seed, which is printed after each run.
-	#     --seed 1234
-	config.order = 'random'
-end

data/spec/wit/version_spec.rb

@@ -1,5 +0,0 @@
-require 'spec_helper'
-
-describe Wit::VERSION do
-	it('is a valid version string') { should =~ /\A\d+\.\d+\.\d+(-\w+)?\Z/ }
-end

data/wit.gemspec

@@ -1,27 +0,0 @@
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'wit/version'
-
-Gem::Specification.new do |spec|
-	spec.name          = 'wit'
-	spec.version       = Wit::VERSION
-	spec.authors       = ['Justin Workman']
-	spec.email         = ['xtagon@gmail.com']
-	spec.summary       = 'A Ruby wrapper for the Wit HTTP API.'
-	spec.description   = 'A Ruby wrapper for the Wit HTTP API, a natural language processing interface.'
-	spec.license       = 'MIT'
-
-	spec.files         = `git ls-files`.split($/)
-	spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
-	spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-	spec.require_paths = ["lib"]
-
-	spec.add_runtime_dependency 'multi_json', '~> 1.8.2'
-	spec.add_runtime_dependency 'rest-client', '~> 1.6.7'
-
-	spec.add_development_dependency 'bundler', '~> 1.3'
-	spec.add_development_dependency 'rake'
-	spec.add_development_dependency 'redcarpet'
-	spec.add_development_dependency 'rspec', '~> 2.14.1'
-	spec.add_development_dependency 'yard'
-end