wit-ruby2 0.0.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6664f7034fc0a92cf6aacee77a91b8ab6da495e1
+  data.tar.gz: 2df625719fbe488b0d03b692c49b89b6de99912d
+SHA512:
+  metadata.gz: f9b0bd748340cd058f77382b1d423fc9d1b8d274fd723e44c6edd70248c554683493a624aec1f53c355d5c870fde3dd42232dd370fa27c26fddefa443a112244
+  data.tar.gz: 291690b012e58bd93d6a734360e2605e1fd1bef4ee5b0a1ea6892a4aab5e7386aa532676675da267c20aefa9825fd164e7b091d4cc04883958620172034a4621

data/.gitignore

@@ -0,0 +1,3 @@
+.ruby-version
+Gemfile.lock
+pkg

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/Gemfile

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

data/MIT.LICENSE

@@ -0,0 +1,22 @@
+Copyright 2012 Jeremy Jackson / ModeSet
+
+https://github.com/modeset/wit-ruby
+
+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

@@ -0,0 +1,49 @@
+wit-ruby2
+========
+
+Easy interface for interacting with the [Wit.ai](http://wit.ai) natural language parsing API.
+
+Initially a fork of: [wit-ruby](https://github.com/modeset/wit-ruby)
+
+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-ruby2', '>= 0.0.3'
+```
+
+## Usage
+
+```ruby
+require 'wit-ruby2'
+
+client = Wit::Client.new("WIT_TOKEN")
+
+result = client.classify_message('Hi')
+
+result.intent # will be Hello with the default Wit instance.
+result.confidence # the confidence score of the classification
+result.entities # A hash of entity types
+result.entities["location"].first.value # the value of the first location extracted
+```
+
+### Result properties/methods
+
+* *id* The unique message id provided back from Wit.
+* *text* The original message sent.
+* *intent* The intent, as determined by Wit.
+* *confidence* The confidence level that Wit determined.
+* *entities* Hash of entities, which contains an array of n extracted entities
+
+### Entity properties/methods
+
+* *value*: the value extracted by wit
+
+## License
+
+Licensed under the [MIT License](http://creativecommons.org/licenses/MIT/)

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/wit-ruby2.rb

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

data/lib/wit/client.rb

@@ -0,0 +1,30 @@
+module Wit
+  class Client
+    attr_accessor :token
+
+    def initialize(token)
+      @token = token
+    end
+
+    def classify_message(message = '')
+      response = connection.get do |req|
+        req.headers['Authorization'] = "Bearer #{token}"
+        req.url '/message', q: message
+      end
+
+      case response.status
+        when 200 then return Result.new JSON.parse(response.body)
+        when 401 then raise Unauthorized, "incorrect token"
+        else raise BadResponse, "response code: #{response.status}"
+      end
+    end
+
+    private
+
+    def connection
+      @connection ||= Faraday.new url: 'https://api.wit.ai' do |faraday|
+        faraday.adapter Faraday.default_adapter
+      end
+    end
+  end
+end

data/lib/wit/entity.rb

@@ -0,0 +1,5 @@
+class EntityCollection < OpenStruct
+  def [](name)
+    send(name.to_sym)
+  end
+end

data/lib/wit/result.rb

@@ -0,0 +1,21 @@
+module Wit
+  class Result
+    attr_reader :id, :text, :intent, :confidence, :entities
+
+    def initialize(hash)
+      @id = hash['msg_id']
+      @text = hash['_text']
+      outcomes = hash['outcomes'].first
+      if outcomes
+        @intent = outcomes['intent']
+        @confidence = outcomes['confidence']
+        @entities = {}
+        outcomes['entities'].each do |name, entity|
+          @entities[name] = entity.map do |e|
+            OpenStruct.new(e)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/wit/version.rb

@@ -0,0 +1,3 @@
+module Wit
+  VERSION = '0.0.3'
+end

data/lib/wit/wit.rb

@@ -0,0 +1,8 @@
+require 'faraday'
+require 'json'
+require 'ostruct'
+
+module Wit
+  class Unauthorized < Exception; end
+  class BadResponse < Exception; end
+end

data/spec/fixtures/vcr/bad_token.yml

@@ -0,0 +1,36 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://api.wit.ai/message?q=test
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      User-Agent:
+      - Faraday v0.9.2
+      Authorization:
+      - Bearer 1234
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+  response:
+    status:
+      code: 400
+      message: Bad Request
+    headers:
+      Server:
+      - nginx/1.8.0
+      Date:
+      - Fri, 22 Jan 2016 18:43:17 GMT
+      Content-Length:
+      - '28'
+      Connection:
+      - keep-alive
+    body:
+      encoding: UTF-8
+      string: Bad auth, check token/params
+    http_version: 
+  recorded_at: Fri, 22 Jan 2016 18:43:17 GMT
+recorded_with: VCR 3.0.1

data/spec/fixtures/vcr/empty_entities_request.yml

@@ -0,0 +1,48 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://api.wit.ai/message?q=non%20je%20n%27aime%20pas%20les%20pommes
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      User-Agent:
+      - Faraday v0.9.2
+      Authorization:
+      - Bearer <WIT_TOKEN>
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Server:
+      - nginx/1.8.0
+      Date:
+      - Fri, 22 Jan 2016 18:03:48 GMT
+      Content-Type:
+      - application/json
+      Content-Length:
+      - '245'
+      Connection:
+      - keep-alive
+    body:
+      encoding: UTF-8
+      string: |-
+        {
+          "msg_id" : "ed83fafe-62c5-43f7-9b29-fce46e8aef43",
+          "_text" : "non je n'aime pas les pommes",
+          "outcomes" : [ {
+            "_text" : "non je n'aime pas les pommes",
+            "confidence" : 0.575,
+            "intent" : "Location",
+            "entities" : { }
+          } ]
+        }
+    http_version: 
+  recorded_at: Fri, 22 Jan 2016 18:03:48 GMT
+recorded_with: VCR 3.0.1

data/spec/fixtures/vcr/happy_path.yml

@@ -0,0 +1,48 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://api.wit.ai/message?q=test
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      User-Agent:
+      - Faraday v0.9.2
+      Authorization:
+      - Bearer <WIT_TOKEN>
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Server:
+      - nginx/1.8.0
+      Date:
+      - Fri, 22 Jan 2016 18:43:17 GMT
+      Content-Type:
+      - application/json
+      Content-Length:
+      - '197'
+      Connection:
+      - keep-alive
+    body:
+      encoding: UTF-8
+      string: |-
+        {
+          "msg_id" : "b48beaf9-c4c2-4bcf-a467-d6947815d2a3",
+          "_text" : "test",
+          "outcomes" : [ {
+            "_text" : "test",
+            "confidence" : 0.575,
+            "intent" : "Location",
+            "entities" : { }
+          } ]
+        }
+    http_version: 
+  recorded_at: Fri, 22 Jan 2016 18:43:17 GMT
+recorded_with: VCR 3.0.1

data/spec/fixtures/vcr/no_token.yml

@@ -0,0 +1,36 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://api.wit.ai/message?q=test
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      User-Agent:
+      - Faraday v0.9.2
+      Authorization:
+      - Bearer
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+  response:
+    status:
+      code: 400
+      message: Bad Request
+    headers:
+      Server:
+      - nginx/1.8.0
+      Date:
+      - Fri, 22 Jan 2016 18:43:18 GMT
+      Content-Length:
+      - '28'
+      Connection:
+      - keep-alive
+    body:
+      encoding: UTF-8
+      string: Bad auth, check token/params
+    http_version: 
+  recorded_at: Fri, 22 Jan 2016 18:43:18 GMT
+recorded_with: VCR 3.0.1

data/spec/fixtures/vcr/standard_request.yml

@@ -0,0 +1,46 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://api.wit.ai/message?q=un%20bar%20pr%C3%A8s%20de%20paris?
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      User-Agent:
+      - Faraday v0.9.2
+      Authorization:
+      - Bearer <WIT_TOKEN>
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Server:
+      - nginx/1.8.0
+      Date:
+      - Fri, 22 Jan 2016 18:03:48 GMT
+      Content-Type:
+      - application/json
+      Content-Length:
+      - '350'
+      Connection:
+      - keep-alive
+    body:
+      encoding: ASCII-8BIT
+      string: !binary |-
+        ewogICJtc2dfaWQiIDogImFiODI5MDYyLTU3MWUtNGI5ZS1hOTQxLTg4YzEx
+        MjI4MjRmMSIsCiAgIl90ZXh0IiA6ICJ1biBiYXIgcHLDqHMgZGUgcGFyaXM/
+        IiwKICAib3V0Y29tZXMiIDogWyB7CiAgICAiX3RleHQiIDogInVuIGJhciBw
+        csOocyBkZSBwYXJpcz8iLAogICAgImNvbmZpZGVuY2UiIDogMC41NzUsCiAg
+        ICAiaW50ZW50IiA6ICJMb2NhdGlvbiIsCiAgICAiZW50aXRpZXMiIDogewog
+        ICAgICAibG9jYXRpb24iIDogWyB7CiAgICAgICAgInR5cGUiIDogInZhbHVl
+        IiwKICAgICAgICAidmFsdWUiIDogInBhcmlzIiwKICAgICAgICAic3VnZ2Vz
+        dGVkIiA6IHRydWUKICAgICAgfSBdCiAgICB9CiAgfSBdCn0=
+    http_version: 
+  recorded_at: Fri, 22 Jan 2016 18:03:48 GMT
+recorded_with: VCR 3.0.1

data/spec/spec_helper.rb

@@ -0,0 +1,18 @@
+require 'wit-ruby2'
+
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'vcr'
+require 'webmock/rspec'
+
+RSpec.configure do |config|
+  config.before(:suite) do
+    $token = ENV['WIT_TOKEN']
+  end
+end
+
+VCR.configure do |config|
+  config.cassette_library_dir = "spec/fixtures/vcr"
+  config.hook_into :webmock
+  config.configure_rspec_metadata!
+  config.filter_sensitive_data("<WIT_TOKEN>") { $token }
+end

data/spec/wit/client_spec.rb

@@ -0,0 +1,29 @@
+describe Wit::Client do
+
+  subject do
+    Wit::Client.new(token).classify_message("test")
+  end
+
+  let(:token) {$token}
+
+  context "happy path", vcr: {cassette_name: 'happy_path'} do
+    it "initializes a result" do
+      expect(Wit::Result).to receive(:new)
+      subject
+    end
+  end
+
+  context "bad token", vcr: {cassette_name: 'bad_token'} do
+    let(:token) {'1234'}
+    it "raises Unauthorized" do
+      expect{subject}.to raise_exception(Wit::BadResponse, "response code: 400")
+    end
+  end
+
+  context "other error", vcr: {cassette_name: 'no_token'} do
+    let(:token) {nil}
+    it "raises a BadResponse with its code" do
+      expect{subject}.to raise_exception(Wit::BadResponse, "response code: 400")
+    end
+  end
+end

data/spec/wit/result_spec.rb

@@ -0,0 +1,45 @@
+describe Wit::Result do
+  let(:text) {'un bar près de paris?'}
+
+  subject do
+    Wit::Client.new($token).classify_message(text)
+  end
+
+  context "standard request with all the type of contents", vcr: {cassette_name: 'standard_request'} do
+    it "sets the id" do
+      expect(subject.id).not_to be_nil
+    end
+
+    it "sets the text" do
+      expect(subject.text).to eq text
+    end
+
+    it "sets the intent" do
+      expect(subject.intent).to eq "Location"
+    end
+
+    it "sets the confidence" do
+      expect(subject.confidence).to be > 0
+    end
+
+    context "for each entities" do
+      let (:entities) {subject.entities}
+
+      it "contains a value" do
+        expect(entities["location"].first.value).to eq "paris"
+      end
+    end
+  end
+
+  context "request without entities", vcr: {cassette_name: 'empty_entities_request'} do
+    let(:text) {"non je n'aime pas les pommes"}
+
+    it "doesn't fail" do
+      subject
+    end
+
+    it "has an empty entities array" do
+      expect(subject.entities).to be_truthy
+    end
+  end
+end

data/spec/wit/wit_spec.rb

@@ -0,0 +1,8 @@
+describe Wit do
+  it "defines 2 exceptions classes" do
+    expect do
+      Wit::Unauthorized.new
+      Wit::BadResponse.new
+    end.not_to raise_exception
+  end
+end

data/wit-ruby2.gemspec

@@ -0,0 +1,28 @@
+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-ruby2'
+  spec.version     = Wit::VERSION
+  spec.authors     = ['Jeremy Jackson', 'Zaratan']
+  spec.email       = ['tech@hellojam.fr']
+  spec.license     = 'MIT'
+  spec.homepage    = 'https://github.com/blackbirdco/wit-ruby2'
+  spec.summary     = %Q{wit-ruby: Easy interface for wit.ai}
+  spec.description = %Q{A simple library for interacting with wit.ai -- will expand as the api does}
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  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_dependency "faraday", ">= 0.8.8"
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "vcr"
+  spec.add_development_dependency "webmock"
+end

metadata

@@ -0,0 +1,161 @@
+--- !ruby/object:Gem::Specification
+name: wit-ruby2
+version: !ruby/object:Gem::Version
+  version: 0.0.3
+platform: ruby
+authors:
+- Jeremy Jackson
+- Zaratan
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-01-22 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
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !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: rspec
+  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: vcr
+  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: webmock
+  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 simple library for interacting with wit.ai -- will expand as the api
+  does
+email:
+- tech@hellojam.fr
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- MIT.LICENSE
+- README.md
+- Rakefile
+- lib/wit-ruby2.rb
+- lib/wit/client.rb
+- lib/wit/entity.rb
+- lib/wit/result.rb
+- lib/wit/version.rb
+- lib/wit/wit.rb
+- spec/fixtures/vcr/bad_token.yml
+- spec/fixtures/vcr/empty_entities_request.yml
+- spec/fixtures/vcr/happy_path.yml
+- spec/fixtures/vcr/no_token.yml
+- spec/fixtures/vcr/standard_request.yml
+- spec/spec_helper.rb
+- spec/wit/client_spec.rb
+- spec/wit/result_spec.rb
+- spec/wit/wit_spec.rb
+- wit-ruby2.gemspec
+homepage: https://github.com/blackbirdco/wit-ruby2
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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.4.8
+signing_key: 
+specification_version: 4
+summary: 'wit-ruby: Easy interface for wit.ai'
+test_files:
+- spec/fixtures/vcr/bad_token.yml
+- spec/fixtures/vcr/empty_entities_request.yml
+- spec/fixtures/vcr/happy_path.yml
+- spec/fixtures/vcr/no_token.yml
+- spec/fixtures/vcr/standard_request.yml
+- spec/spec_helper.rb
+- spec/wit/client_spec.rb
+- spec/wit/result_spec.rb
+- spec/wit/wit_spec.rb