lita-wit 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 74ef2a835b5e8cf0ae48c1cf5fba9d9a9f42f14e
-  data.tar.gz: dad06bc5f297bc1371d57cca1ea060e79bdc8d9f
+  metadata.gz: 50952bb8fc939112456f6b7a025624803324f07c
+  data.tar.gz: 5c5aa687530e808caf1ffaa62b776bc686f88b48
 SHA512:
-  metadata.gz: 075d1dea9e0ac23cb665cf0d5a467aedc71270aac513ec742546ad74872500293623865abc25c65b4fdcc789da6f4a0d4e728f3c76d1b54fbfc2afd1aadb0f27
-  data.tar.gz: b0bfc96bc6b0fe4f1ebf9f60619212fb2d84effe355fb15ce924f0d205f98867fdbd28c01990fb55939bf01ec8d619b323445896dd4ef5d63554f187fef99265
+  metadata.gz: 7dc53348875a94b9256aff973f5cfaa453bad08aeceef11f11f6a165beac6d139a6714acf8dd2a53f9faa906ee7ba9eb21c08ffaba0aedc67ba620a1b4becf97
+  data.tar.gz: e810f236eb31fb95c2fe9f6126ec65622d013ade71d0a366fd45ac293f5738abaf7f631ff0610dff716892bfd9a61241bd8356c227f88b70e14f198e06eb9212

data/README.md

@@ -7,12 +7,14 @@ This is a [Lita](https://www.lita.io) handler to converse with [Wit.ai](https://
 
 Using Lita and Wit.ai, you can easily create text or voice based bots that humans can chat with on their preferred messaging platform.
 
-Something like this Slack snippet...
+Something like this little Slack snippet...
 
 ![Example of a conversation with Lita](https://raw.github.com/dbastin/lita-wit/master/example.png)
 
-This above snippet is a conversation with a publically accessible pre-configured Wit.ai chatbot - https://wit.ai/dbastin/Lita.
-As you can guess, Wit.ai not only enables your robot to understand humans, it also helps you discover their unforeseen needs.
+The above snippet is a conversation with a Lita bot configured with a Slack adapter and this lita-wit handler.
+This lita-wit handler is conversing with a publically accessible pre-configured Wit.ai chatbot - https://wit.ai/dbastin/Lita.
+
+Once you get it up and running, you'll see that Wit.ai not only enables your robot to understand humans, it also helps you discover their unforeseen needs. It's all very clever.
 
 ## Installation
 
@@ -24,14 +26,18 @@ gem "lita-wit"
 
 ## Configuration
 
-You'll need to add the Wit.ai API server access token.
+You'll need to add the Wit.ai API server access token. Please sign up and fork the pre-configured Wit.ai bot.
+You can configure the callback actions the robot performs by specifying a different `actions_class`
 
 ``` ruby
 Lita.configure do |config|
   # config... config... config...
 
-  # https://wit.ai/dbastin/Lita... Fork it!
+  # https://wit.ai/dbastin/Lita... (fork it!)
   config.handlers.wit.server_access_token = '72XXMP6VAKG2SAPLTXVQS6H5PBLVQIJW'
+
+  # default actions are in this class... (specify your own if you like)
+  config.handlers.wit.actions_class = Lita::Actions::Weather
 end
 ```
 
@@ -53,3 +59,6 @@ Your robot's name will be stripped from the message we send to Wit.ai
 
 [Tom Beynon](https://github.com/tombeynon) - Great handler for Cleverbot [lita-ai](https://github.com/tombeynon/lita-ai)
 
+## License
+
+[MIT](http://opensource.org/licenses/MIT)

data/lib/lita/actions/base.rb

@@ -0,0 +1,17 @@
+module Lita
+  module Actions
+    class Base
+      def initialize(robot)
+        @robot = robot
+      end
+
+      def actions(source)
+        {
+          :error => -> (session_id, context, error) {
+            # Required, but is never ever called
+          }
+        }
+      end
+    end
+  end
+end

data/lib/lita/actions/weather.rb

@@ -0,0 +1,19 @@
+module Lita
+  module Actions
+    class Weather < Base
+
+      def actions(source)
+        super.merge({
+          :say => -> (session_id, context, msg) {
+            @robot.send_message(source, msg)
+          },
+          :merge => -> (session_id, context, entities, msg) {
+            Utils::ContextPiper.pipe(context, entities, 'intent', 'intent')
+            Utils::ContextPiper.pipe(context, entities, 'location', 'loc')
+            context
+          }
+        })
+      end
+    end
+  end
+end

data/lib/lita/handlers/wit.rb

@@ -3,11 +3,12 @@ module Lita
     class Wit < Handler
       on :unhandled_message, :handle
       config :server_access_token, type: String, required: true
+      config :actions_class, type: Class, required: true
 
       def initialize(robot)
         super
-        @bickle = Lita::Utils::Bickle.new(robot)
-        @client = Lita::Services::WitClient.new(robot)
+        @bickle = Utils::Bickle.new(robot)
+        @client = Services::WitClient.new(robot)
       end
 
       def handle(payload)

data/lib/lita/services/wit_client.rb

@@ -4,45 +4,16 @@ module Lita
 
       def initialize(robot)
         @robot = robot
-        token = @robot.config.handlers.wit.server_access_token
-        @wit = ::Wit.new token, actions
+        @token = robot.config.handlers.wit.server_access_token
+        @actions_class = robot.config.handlers.wit.actions_class
       end
 
       def run_actions(session_id, message, context={}, max_steps=DEFAULT_MAX_STEPS)
-        @source = message.source
-        stripped = Lita::Utils::AliasStripper.strip(@robot, message)
+        actions = @actions_class.new(@robot).actions(message.source)
+        @wit = ::Wit.new(@token, actions)
+        stripped = 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/context_piper.rb

@@ -0,0 +1,10 @@
+module Lita
+  module Utils
+    class ContextPiper
+      def self.pipe(context, entities, input, output)
+        e = EntitiesNavigator.first_value(entities, input)
+        context[output] = e unless e.nil?
+      end
+    end
+  end
+end

data/lib/lita/utils/entities_navigator.rb

@@ -0,0 +1,12 @@
+module Lita
+  module Utils
+    class EntitiesNavigator
+      def self.first_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
+    end
+  end
+end

data/lib/lita-wit.rb

@@ -9,7 +9,11 @@ require 'lita/handlers/wit'
 require 'lita/utils/bickle'
 require 'lita/utils/aliases'
 require 'lita/utils/alias_stripper'
+require 'lita/utils/context_piper'
+require 'lita/utils/entities_navigator'
 require 'lita/services/wit_client'
+require 'lita/actions/base'
+require 'lita/actions/weather'
 
 Lita::Handlers::Wit.template_root File.expand_path(
   File.join('..', '..', 'templates'),

data/lita-wit.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |spec|
   spec.name          = 'lita-wit'
-  spec.version       = '0.1.1'
+  spec.version       = '0.1.2'
   spec.authors       = ['Damien Bastin']
   spec.email         = ['damien.bastin@gmail.com']
   spec.description   = 'A Lita handler for Wit.'

data/spec/lita_config.rb

@@ -3,6 +3,9 @@ Lita.configure do |config|
   config.robot.log_level = :info
   config.robot.adapter = :shell
 
-  # https://wit.ai/dbastin/Lita... Fork it!
+  # https://wit.ai/dbastin/Lita... (fork it!)
   config.handlers.wit.server_access_token = '72XXMP6VAKG2SAPLTXVQS6H5PBLVQIJW'
+
+  # default actions are in this class... (specify your own if you like)
+  config.handlers.wit.actions_class = Lita::Actions::Weather
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lita-wit
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Damien Bastin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-28 00:00:00.000000000 Z
+date: 2016-05-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: lita
@@ -179,11 +179,15 @@ files:
 - Rakefile
 - example.png
 - lib/lita-wit.rb
+- lib/lita/actions/base.rb
+- lib/lita/actions/weather.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
+- lib/lita/utils/context_piper.rb
+- lib/lita/utils/entities_navigator.rb
 - lita-wit.gemspec
 - locales/en.yml
 - spec/lita/handlers/wit_spec.rb