lita-wit 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d738b1713071dc4020098e21eb2432215b9df56a
-  data.tar.gz: 0a001dc11e33eadec21eef5ceecf6e7b457205a5
+  metadata.gz: 2a6396a10176ffd117f4288900d89f9e721e08ba
+  data.tar.gz: 513bdf40c3b8d6913ad28272280d6df24e0c1bd5
 SHA512:
-  metadata.gz: 608f03e1c4076e7d938b640720e50fc03d0afd6f6bf813b84dc8b947ffc27fb198225a45f7b654e0cbd8741cf8bbe105e7ee6d387a0350e02b78f205e18206ad
-  data.tar.gz: 3650ecd01bbdaa00b25f3aae1f66df928414ef9b9e1b03989461b78fc8bb395f7789b7e3910b13787cff638c780a9f6b5a9111892e8a3c750ee29542554d00da
+  metadata.gz: b094722f4f49fec03c6640024265b1249fb7aba044c44c118d47be43d00f34ccd35b46dae80989408df8a9220b781e99c9cb046442bf9e49be20a1a615af61dc
+  data.tar.gz: a5f15301b5966e2cb334028cdf301bd1f657ba5b01d02a4f7a836c40878949f57cb7002d4cc89ae21390d6666a819a75627ea4d686c550290e5ee28fb1831b8c

data/README.md

@@ -24,3 +24,8 @@ config.wit_token = token-here
 ## Usage
 
 Rock!
+
+## Thanks Go To
+
+[Tom Beynon](https://github.com/tombeynon) - Great handler for Cleverbot [lita-ai](https://github.com/tombeynon/lita-ai)
+

data/lib/lita/handlers/wit.rb

@@ -1,7 +1,30 @@
 module Lita
   module Handlers
     class Wit < Handler
-      # insert handler code here
+      on :unhandled_message, :handle
+      config :server_access_token, type: String, required: true
+
+      def initialize(robot)
+        super
+        @bickle = Lita::Utils::Bickle.new(robot)
+        @client = Lita::Services::WitClient.new(robot)
+      end
+
+      def handle(payload)
+        message = payload[:message]
+        return unless @bickle.you_talking_to_me?(message)
+        respond(message)
+      end
+
+      private
+
+      def respond(message)
+        @client.run_actions session_id, message
+      end
+
+      def session_id
+        'unique-1234'
+      end
 
       Lita.register_handler(self)
     end

data/lib/lita/services/wit_client.rb

@@ -0,0 +1,48 @@
+module Lita
+  module Services
+    class WitClient
+
+      def initialize(robot)
+        @robot = robot
+        token = @robot.config.handlers.wit.server_access_token
+        @wit = ::Wit.new token, actions
+      end
+
+      def run_actions(session_id, message, context={}, max_steps=DEFAULT_MAX_STEPS)
+        @source = message.source
+        stripped = Lita::Utils::AliasStripper.strip(@robot, message)
+        @wit.run_actions(session_id, stripped.body, context, max_steps)
+      end
+
+      private
+
+      def actions
+        {
+          :say => -> (session_id, context, msg) {
+            @robot.send_message(@source, msg)
+          },
+          :merge => -> (session_id, context, entities, msg) {
+            pipe(context, entities, 'intent', 'intent')
+            pipe(context, entities, 'location', 'loc')
+            context
+          },
+          :error => -> (session_id, context, error) {
+            # Required, but is never ever called
+          },
+        }
+      end
+
+      def first_entity_value(entities, entity)
+        return nil unless entities.has_key? entity
+        val = entities[entity][0]['value']
+        return nil if val.nil?
+        val.is_a?(Hash) ? val['value'] : val
+      end
+
+      def pipe(context, entities, input, output)
+        e = first_entity_value entities, input
+        context[output] = e unless e.nil?
+      end
+    end
+  end
+end

data/lib/lita/utils/alias_stripper.rb

@@ -0,0 +1,10 @@
+module Lita
+  module Utils
+    class AliasStripper
+      def self.strip(robot, message)
+        body = message.body.sub(/#{Aliases.values(robot).join('|')}/i, '').strip
+        Message.new(robot, body, message.source)
+      end
+    end
+  end
+end

data/lib/lita/utils/aliases.rb

@@ -0,0 +1,9 @@
+module Lita
+  module Utils
+    class Aliases
+      def self.values(robot)
+        [robot.mention_name, robot.alias].map { |a| a unless a == '' }.compact
+      end
+    end
+  end
+end

data/lib/lita/utils/bickle.rb

@@ -0,0 +1,14 @@
+module Lita
+  module Utils
+    class Bickle
+
+      def initialize(robot)
+        @robot = robot
+      end
+
+      def you_talking_to_me?(message)
+        message.command? || message.body =~ /#{Aliases.values(@robot).join('|')}/i
+      end
+    end
+  end
+end

data/lib/lita-wit.rb

@@ -1,12 +1,17 @@
-require "lita"
+require 'lita'
+require 'wit'
 
 Lita.load_locales Dir[File.expand_path(
-  File.join("..", "..", "locales", "*.yml"), __FILE__
+  File.join('..', '..', 'locales', '*.yml'), __FILE__
 )]
 
-require "lita/handlers/wit"
+require 'lita/handlers/wit'
+require 'lita/utils/bickle'
+require 'lita/utils/aliases'
+require 'lita/utils/alias_stripper'
+require 'lita/services/wit_client'
 
 Lita::Handlers::Wit.template_root File.expand_path(
-  File.join("..", "..", "templates"),
- __FILE__
+  File.join('..', '..', 'templates'),
+  __FILE__
 )

data/lita-wit.gemspec

@@ -1,9 +1,9 @@
 Gem::Specification.new do |spec|
   spec.name          = "lita-wit"
-  spec.version       = "0.0.1"
+  spec.version       = "0.1.0"
   spec.authors       = ["Damien Bastin"]
   spec.email         = ["damien.bastin@gmail.com"]
-  spec.description   = "A Lita handler for Wit"
+  spec.description   = "A Lita handler for Wit."
   spec.summary       = "Receive structured intentions from unstructured sentences using a Lita bot and Wit."
   spec.homepage      = "https://github.com/dbastin/lita-wit"
   spec.license       = "MIT"
@@ -15,6 +15,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_runtime_dependency "lita", ">= 4.7"
+  spec.add_runtime_dependency "wit", ">= 3.3.1"
 
   spec.add_development_dependency "bundler", ">= 1.3"
   spec.add_development_dependency "pry-byebug"
@@ -23,4 +24,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rspec", ">= 3.0.0"
   spec.add_development_dependency "simplecov"
   spec.add_development_dependency "coveralls"
+  spec.add_development_dependency "webmock"
+  spec.add_development_dependency "vcr"
 end

data/spec/lita/handlers/wit_spec.rb

@@ -1,4 +1,48 @@
-require "spec_helper"
+require 'spec_helper'
 
 describe Lita::Handlers::Wit, lita_handler: true do
+
+  describe 'handling unhandled_message' do
+    let(:source) { double(:source) }
+
+    context 'unhandled directed at lita' do
+      it 'handles something' do
+        expect_any_instance_of(::Wit).to receive(:run_actions).with(SESSION_ID, 'Hi', {}, DEFAULT_MAX_STEPS) {
+          robot.send_message(source, 'Howdy')
+        }
+        send_message('Hi Lita')
+        expect(replies.last).to eq('Howdy')
+      end
+
+      it 'recognizes aliases' do
+        expect_any_instance_of(::Wit).to receive(:run_actions).with(SESSION_ID, 'Hi', {}, DEFAULT_MAX_STEPS) {
+          robot.send_message(source, 'Hiya')
+        }
+        robot.alias = 'Rita'
+        send_message('Hi Rita')
+        expect(replies.last).to eq('Hiya')
+      end
+    end
+
+    context 'unhandled not directed at lita' do
+      it 'ignores the message' do
+        send_message('Hi')
+        expect(replies.last).to be_nil
+      end
+    end
+  end
+
+  describe 'handle' do
+    let(:source) { double(:source) }
+    let(:message) { double(:message, body: 'Hello', command?: true, source: source) }
+
+    context 'commanding lita' do
+      it 'calls wit.ai and responds to source' do
+        VCR.use_cassette('wit greeting') do
+          expect(subject.robot).to receive(:send_message).with(source, 'Hi. Ask me about the weather. Anywhere. Go on!')
+          subject.handle(message: message)
+        end
+      end
+    end
+  end
 end

data/spec/lita_config.rb

@@ -0,0 +1,8 @@
+Lita.configure do |config|
+  config.robot.name = 'Lita'
+  config.robot.log_level = :info
+  config.robot.adapter = :shell
+
+  # https://wit.ai/dbastin/Lita... Fork it!
+  config.handlers.wit.server_access_token = '72XXMP6VAKG2SAPLTXVQS6H5PBLVQIJW'
+end

data/spec/spec_helper.rb

@@ -1,6 +1,6 @@
-require "simplecov"
+require 'simplecov'
 
-require "coveralls"
+require 'coveralls'
 Coveralls.wear!
 
 SimpleCov.start 'rails' do
@@ -12,9 +12,24 @@ SimpleCov.start 'rails' do
   add_filter '/spec/'
 end
 
-require "lita-wit"
-require "lita/rspec"
+require 'lita-wit'
+Wit.logger.level = Logger::WARN
+
+require 'lita/rspec'
+require 'lita_config'
 
 # A compatibility mode is provided for older plugins upgrading from Lita 3. Since this plugin
 # was generated with Lita 4, the compatibility mode should be left disabled.
 Lita.version_3_compatibility_mode = false
+
+require 'vcr'
+require 'webmock/rspec'
+
+VCR.configure do |config|
+  config.cassette_library_dir = 'spec/support/vcr_cassettes'
+  config.ignore_localhost = true
+  config.hook_into :webmock
+  config.configure_rspec_metadata!
+end
+
+SESSION_ID = 'unique-1234'

data/spec/support/vcr_cassettes/wit_greeting.yml

@@ -0,0 +1,138 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://api.wit.ai/converse?q=Hello&session_id=unique-1234
+    body:
+      encoding: UTF-8
+      string: "{}"
+    headers:
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - application/vnd.wit.20160330+json
+      User-Agent:
+      - Ruby
+      Host:
+      - api.wit.ai
+      Authorization:
+      - Bearer 72XXMP6VAKG2SAPLTXVQS6H5PBLVQIJW
+      Content-Type:
+      - application/json
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Server:
+      - nginx/1.8.0
+      Date:
+      - Thu, 28 Apr 2016 15:14:39 GMT
+      Content-Type:
+      - application/json
+      Content-Length:
+      - '118'
+      Connection:
+      - keep-alive
+    body:
+      encoding: UTF-8
+      string: |-
+        {
+          "confidence" : 1,
+          "type" : "merge",
+          "entities" : {
+            "intent" : [ {
+              "value" : "greeting"
+            } ]
+          }
+        }
+    http_version: 
+  recorded_at: Thu, 28 Apr 2016 15:14:39 GMT
+- request:
+    method: post
+    uri: https://api.wit.ai/converse?session_id=unique-1234
+    body:
+      encoding: UTF-8
+      string: '{"intent":"greeting"}'
+    headers:
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - application/vnd.wit.20160330+json
+      User-Agent:
+      - Ruby
+      Host:
+      - api.wit.ai
+      Authorization:
+      - Bearer 72XXMP6VAKG2SAPLTXVQS6H5PBLVQIJW
+      Content-Type:
+      - application/json
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Server:
+      - nginx/1.8.0
+      Date:
+      - Thu, 28 Apr 2016 15:14:40 GMT
+      Content-Type:
+      - application/json
+      Content-Length:
+      - '117'
+      Connection:
+      - keep-alive
+    body:
+      encoding: UTF-8
+      string: |-
+        {
+          "confidence" : 0.5878773927688599,
+          "type" : "msg",
+          "msg" : "Hi. Ask me about the weather. Anywhere. Go on!"
+        }
+    http_version: 
+  recorded_at: Thu, 28 Apr 2016 15:14:40 GMT
+- request:
+    method: post
+    uri: https://api.wit.ai/converse?session_id=unique-1234
+    body:
+      encoding: UTF-8
+      string: '{"intent":"greeting"}'
+    headers:
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - application/vnd.wit.20160330+json
+      User-Agent:
+      - Ruby
+      Host:
+      - api.wit.ai
+      Authorization:
+      - Bearer 72XXMP6VAKG2SAPLTXVQS6H5PBLVQIJW
+      Content-Type:
+      - application/json
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Server:
+      - nginx/1.8.0
+      Date:
+      - Thu, 28 Apr 2016 15:14:41 GMT
+      Content-Type:
+      - application/json
+      Content-Length:
+      - '58'
+      Connection:
+      - keep-alive
+    body:
+      encoding: UTF-8
+      string: |-
+        {
+          "confidence" : 0.9979153275489807,
+          "type" : "stop"
+        }
+    http_version: 
+  recorded_at: Thu, 28 Apr 2016 15:14:41 GMT
+recorded_with: VCR 3.0.1

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lita-wit
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Damien Bastin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-22 00:00:00.000000000 Z
+date: 2016-04-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: lita
@@ -24,6 +24,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '4.7'
+- !ruby/object:Gem::Dependency
+  name: wit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.3.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.3.1
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -122,7 +136,35 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: A Lita handler for Wit
+- !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'
+- !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'
+description: A Lita handler for Wit.
 email:
 - damien.bastin@gmail.com
 executables: []
@@ -137,10 +179,17 @@ files:
 - Rakefile
 - lib/lita-wit.rb
 - lib/lita/handlers/wit.rb
+- lib/lita/services/wit_client.rb
+- lib/lita/utils/alias_stripper.rb
+- lib/lita/utils/aliases.rb
+- lib/lita/utils/bickle.rb
 - lita-wit.gemspec
 - locales/en.yml
 - spec/lita/handlers/wit_spec.rb
+- spec/lita_config.rb
 - spec/spec_helper.rb
+- spec/support/vcr_cassettes/.gitkeep
+- spec/support/vcr_cassettes/wit_greeting.yml
 - templates/.gitkeep
 homepage: https://github.com/dbastin/lita-wit
 licenses:
@@ -170,4 +219,7 @@ summary: Receive structured intentions from unstructured sentences using a Lita
   and Wit.
 test_files:
 - spec/lita/handlers/wit_spec.rb
+- spec/lita_config.rb
 - spec/spec_helper.rb
+- spec/support/vcr_cassettes/.gitkeep
+- spec/support/vcr_cassettes/wit_greeting.yml