wit-ruby 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 65f38b09d6036ef26cebf939021a5de5dbf069b4
-  data.tar.gz: 8e710c72d4a80c6bf6dba6bae98063185480459f
+  metadata.gz: ac3ac77f6ced1ee1c8fd03093b35d4746c81c30e
+  data.tar.gz: 0cb58a138f3bb3d08ff07f51ae406fd332893c48
 SHA512:
-  metadata.gz: 5f78942fae930ab0a8808a94ead5ea91ffa76d569bc732f9fe7cf5dba9c3e6ae0f5057802d1bd3879b438a5c1ad7586372988221166525b66537c8742cadad21
-  data.tar.gz: 42e0286fb7f1521113b287a659ae6229edf15f9c2dd4a6803cf42e95c9dc4c8aab886844e2afa8d4eaba336b94fc2d2dabbe46c8c916a4e5dcb59fb086370958
+  metadata.gz: 9b69a88dd619449ba409d51905b584260c8362e322329c87085f9bec41cc003a018fed95f7681a0a8f2d2d56f501d03ee9f6daa8056a19ca3d8703f865004995
+  data.tar.gz: 7f32a52883faf74eaa789a93d27f626e9b1357c56df9b0c57522d396be8a10f167f8481fe2ab5dd42e0547572cdc1f22225b00381d8e9a50b52f9788c4a75eda

data/README.md

@@ -3,11 +3,88 @@ wit-ruby
 
 [![Gem Version](https://badge.fury.io/rb/wit-ruby.png)](http://badge.fury.io/rb/wit-ruby)
 
+Easy interface for interacting with the [Wit.ai](http://wit.ai) natural language parsing API.
+
+This project will expand as the Wit.ai API expands, but as it stands there's a single endpoint. You can hit this
+endpoint easily with `Wit.message([your message])`, which uses Wit.ai to convert that phrase or sentence into an object
+with an intent, and entities if any are available.
+
+You will need to create a Wit.ai account and begin training it.
+
 ## Installation
 
+```ruby
+gem 'wit-ruby', '>= 0.0.2'
+```
+
+You'll need to set an environment variable named `WIT_TOKEN` or specify your token with `Wit.token = [your token]`.
+
+```shell
+export WIT_TOKEN=[your token]
+```
+
 
 ## Usage
 
+```ruby
+result = Wit.message('Hi')
+result.intent # will be Hello with the default Wit instance.
+result.confidence # will be relatively low initially.
+result.entities # will be {}, but if there are entities the can accessed as [:name] or .name
+```
+
+### Result properties/methods
+
+<dl>
+
+<dt> raw </dt><dd>
+Raw response hash (parsed JSON)
+</dd>
+
+<dt> msgId </dt><dd>
+The unique message id provided back from Wit.
+</dd>
+
+<dt> msgBody </dt><dd>
+The original message sent.
+</dd>
+
+<dt> intent </dt><dd>
+The intent, as determined by Wit.
+</dd>
+
+<dt> confidence </dt><dd>
+The confidence level that Wit determined.
+</dd>
+
+<dt> entities </dt><dd>
+Hash of entities, which contain the value, and the start/end position within msgBody.
+</dd>
+
+</dl>
+
+### Entity properties/methods
+
+<dl>
+
+<dt> value </dt><dd>
+The value as determined by Wit (might not be the same as body).
+</dd>
+
+<dt> start </dt><dd>
+The start position index from msgBody.
+</dd>
+
+<dt> end </dt><dd>
+The end position index from msgBody.
+</dd>
+
+<dt> body </dt><dd>
+The actual value as specified in msgBody.
+</dd>
+
+</dl>
+
 
 ## License
 

data/lib/wit/version.rb

@@ -1,3 +1,3 @@
 module Wit
-  VERSION = '0.0.1'
+  VERSION = '0.0.2'
 end

data/lib/wit/wit.rb

@@ -1,30 +1,37 @@
-require 'net/http'
+require 'faraday'
 require 'json'
+require 'ostruct'
 
 module Wit
 
-  TOKEN = ENV['WIT_TOKEN']
+  class << self
+    attr_accessor :token
 
-  def self.message(message = '')
-    uri = URI("https://api.wit.ai/message?q=#{URI.escape(message)}")
-    http = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) do |http|
-      req = Net::HTTP::Get.new(uri)
-      req['Authorization'] = "Bearer #{TOKEN}"
-      http.request(req)
+    def token
+      @token || ENV['WIT_TOKEN']
     end
+  end
 
-    if http.is_a?(Net::HTTPUnauthorized)
-      raise Unauthorized, "incorrect token set for Wit::TOKEN set an env for WIT_TOKEN or set Wit::TOKEN manually"
+  def self.message(message = '')
+    response = connection.get do |req|
+      req.headers['Authorization'] = "Bearer #{token}"
+      req.url '/message', q: message
     end
 
-    if http.is_a?(Net::HTTPSuccess)
-      return Response.new(JSON.parse(http.body))
+    case response.status
+    when 200 then return Result.new JSON.parse(response.body)
+    when 401 then raise Unauthorized, "incorrect token set for Wit.token set an env for WIT_TOKEN or set Wit::TOKEN manually"
+    else raise BadResponse, "response code: #{response.status}"
     end
+  end
 
-    false
+  def self.connection
+    @connection ||= Faraday.new url: 'https://api.wit.ai' do |faraday|
+      faraday.adapter Faraday.default_adapter
+    end
   end
 
-  class Response
+  class Result
 
     attr_reader :raw, :msg_id, :msg_body, :intent, :confidence, :entities
 
@@ -34,26 +41,25 @@ module Wit
       @msg_body = hash['msg_body']
       @intent = hash['outcome']['intent']
       @confidence = hash['outcome']['confidence']
-      @entities = {}
+      @entities = EntityCollection.new
       hash['outcome']['entities'].each do |name, entity|
-        @entities[name.to_sym] = Entity.new(entity)
+        @entities.send(:"#{name}=", Entity.new(entity))
       end
     end
 
   end
 
-  class Entity
+  class EntityCollection < OpenStruct
 
-    attr_reader :start, :end, :value, :body
-
-    def initialize(hash)
-      @start = hash['start']
-      @end = hash['end']
-      @value = hash['value']
-      @body = hash['body']
+    def [](name)
+      self.send(name)
     end
 
   end
 
+  class Entity < OpenStruct
+  end
+
   class Unauthorized < Exception; end
+  class BadResponse < Exception; end
 end

data/spec/wit/wit_spec.rb

@@ -6,10 +6,10 @@ describe Wit do
 
     it "returns the expected output" do
       res = Wit.message('deploy master foo to bar')
-      expect( res ).to be_a Wit::Response
+      expect( res ).to be_a Wit::Result
       expect( res.msg_body ).to eq 'deploy master foo to bar'
       expect( res.intent ).to eq 'deploy'
-      expect( res.entities[:branch] ).to be_a Wit::Entity
+      expect( res.entities.branch ).to be_a Wit::Entity
       expect( res.entities[:branch].value ).to eq 'master'
     end
 

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: wit-ruby
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Jeremy Jackson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-18 00:00:00.000000000 Z
-dependencies: []
+date: 2013-10-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.8.8
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.8.8
 description: A simple library for interacting with wit.ai -- will expand as the api
   does
 email: