wit_bot 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c493abbbb038f58cbea34d66f5922f11841580e4
-  data.tar.gz: 2a09ae8130ade22b6c5f95c03a017ed6a9987556
+  metadata.gz: 549a0b5878b37d6cad5a60ce08cf73d24e6c00f5
+  data.tar.gz: f0a17fab1335c1df10d6f1613bf82ae8e423e29b
 SHA512:
-  metadata.gz: c9fb38619aec37a9c3cca4f65ae046a8753cb7c9bc5a8d1716cfa4bc6f14fe314ec0927f0ca255f031218cb4cae3d06d801d9ceb89c1333753ba69fe7fe92db2
-  data.tar.gz: 8fe3523ab7b36bfe08cbefd181401c24ff8f6ddce7cccef214eb675a642a5ee13025cf85be5e7fcda676b31f7d4644d9cc9a26717a4c398e08c57bd8934cdb3c
+  metadata.gz: 98de64370554a72a83b26f0600512c2e80e165885b61a5238da82b7406bc0be094ed3284d597d0043cb9570eb4a1e9b02f46c44ce09abfe9e257cdd90e26388c
+  data.tar.gz: f18fddda7d520c9999b5236e1c896a8a7fb3a90b9c05d6f17ffb44840bb77dfca8df39fc5c56d9863cad30e232c9b6e1f11209204845e82900ecb1c7e0f322b9

data/examples/bot.rb

@@ -0,0 +1,20 @@
+#require 'wit_bot'
+
+require_relative '../lib/wit_bot'
+
+require_relative 'bot/bot'
+
+WitBot.configure do |c|
+  c.token = ENV['WIT_ACCESS_TOKEN'] # Create a wit bot and set the token here
+end
+
+WitBot.config
+
+conversation = WitBot::Bot::Conversation::Base.new
+
+bot = Bot.new conversation
+
+loop do
+  print 'Input: '
+  conversation.send_message gets.chomp
+end

data/examples/bot/bot.rb

@@ -0,0 +1,38 @@
+class Bot < WitBot::Bot::Base
+  intents :Test, :login, :missing_pin
+
+  protected
+
+  def on_output(message)
+    puts "Output: #{message.text}"
+  end
+
+  def on_missing_pin(message)
+    puts 'Pin used to be missing.'
+    login message.outcome
+  end
+
+  def on_login(message)
+    login message.outcome
+  end
+
+  def login(outcome)
+    if (pin_code = outcome.entities[:pin_code])
+      output "Logged you in with the pin code: #{pin_code}"
+    else
+      conversation.thread.context.state << :missing_pin
+      output 'Please include a pin code.'
+    end
+  end
+
+  def on_Test(message)
+    outcome = message.outcome
+
+    thing = outcome.entities["thing"]
+    adjective = outcome.entities["adjective"]
+
+    msg = "Yup, that #{thing || 'thing'} is #{adjective || 'a word'}."
+
+    output msg
+  end
+end

data/lib/wit_bot.rb

@@ -1,7 +1,10 @@
 require 'active_support/core_ext/hash/indifferent_access'
 require 'active_support/core_ext/module/attribute_accessors'
+require 'active_support/ordered_hash'
+require 'active_support/concern'
 require 'http'
 require 'require_all'
+require 'observer'
 
 module WitBot
   class << self

data/lib/wit_bot/bot/base.rb

@@ -0,0 +1,45 @@
+module WitBot
+  module Bot
+    class Base < WitBot::Bot::Conversation::Participant
+      def initialize(conversation)
+        super conversation
+      end
+
+      class << self
+        @@intents = []
+        def intents(*args)
+          if args.empty?
+            @@intents.map! do |intent|
+              if intent.is_a? WitBot::WitModel::Intent
+                intent
+              else
+                WitBot::WitModel::Intent.find intent
+              end
+            end
+          else
+            @@intents.concat args
+          end
+        end
+      end
+
+      def intents
+        self.class.intents
+      end
+
+      def intent_names
+        intents.map { |intent| intent.name }
+      end
+
+      def on_input(message)
+        outcome = message.outcome
+        intent = outcome.intent
+        intent_name = intent.name.to_sym
+
+        if intent_names.include? intent_name
+          method_name = "on_#{intent_name}".to_sym
+          self.send method_name, message if self.respond_to? method_name, true
+        end
+      end
+    end
+  end
+end

data/lib/wit_bot/bot/conversation/base.rb

@@ -0,0 +1,44 @@
+module WitBot
+  module Bot
+    module Conversation
+      class Base
+        include Observable
+
+        def metadata
+          thread.metadata
+        end
+
+        def thread
+          @thread ||= MessageThread.new("#{self.class.name}-#{SecureRandom.uuid}")
+        end
+
+        def messages(user: true, bot: true)
+          thread.messages_list user, bot
+        end
+
+        def send_message(text, sender=nil)
+          sender && sender.bot? ? output(text) : input(text)
+        end
+
+        def input(input)
+          message = thread.create_message input
+          message.send 1, false
+          changed
+          notify_observers :input, message
+          message
+        end
+
+        def listen_with(listener_class)
+          listener_class.new self
+        end
+
+        def output(text)
+          message = thread.create_bot_message text
+          changed
+          notify_observers :output, message
+          message
+        end
+      end
+    end
+  end
+end

data/lib/wit_bot/bot/conversation/participant.rb

@@ -0,0 +1,28 @@
+module WitBot
+  module Bot
+    module Conversation
+      class Participant
+        attr_reader :conversation
+
+        def initialize(conversation)
+          @conversation = conversation
+          @conversation.add_observer self
+        end
+        def bot?
+          true
+        end
+        def output(text)
+          @conversation.send_message text, self
+        end
+        def update(type, message)
+          case type
+            when :input
+              self.on_input message if self.respond_to? :on_input, true
+            when :output
+              self.on_output message if self.respond_to? :on_output, true
+          end
+        end
+      end
+    end
+  end
+end

data/lib/wit_bot/bot/models/message.rb

@@ -0,0 +1,12 @@
+module WitBot
+  module Bot
+    class Message < WitBot::Message
+      def bot?
+        true
+      end
+      def send
+        throw "You can't send a bot message."
+      end
+    end
+  end
+end

data/lib/wit_bot/models/context.rb

@@ -1,7 +1,11 @@
 module WitBot
   class Context
-    attr_accessor :state, :reference_time, :location
-    attr_writer :hash, :entities
+    attr_accessor :reference_time, :location
+    attr_writer :hash, :entities, :state
+
+    def state
+      @state ||= []
+    end
 
     def empty?
       as_json.empty?
@@ -13,7 +17,7 @@ module WitBot
 
     def as_json
       h = {}
-      h[:state] = state if state
+      h[:state] = state if state && !state.empty?
       h[:reference_time] = reference_time.iso8601 if reference_time
       h[:entities] = entities if @entities
       h[:location] = location if location

data/lib/wit_bot/models/message.rb

@@ -11,6 +11,10 @@ module WitBot
       @outcomes = @_outcomes = nil
     end
 
+    def bot?
+      false
+    end
+
     def params(p=nil)
       params = {
         q: text,
@@ -25,7 +29,7 @@ module WitBot
       response = MessageRequest.new.request(self, n)
 
       @sent = true
-      message.thread.reset_context unless keep_context
+      thread.reset_context unless keep_context
 
       @_text = response['_text']
       @_outcomes = response['outcomes']

data/lib/wit_bot/models/message_thread.rb

@@ -1,22 +1,31 @@
 module WitBot
   class MessageThread
-    attr_reader :id, :messages
+    attr_accessor :metadata
+
+    attr_reader :id, :messages, :bot_messages
 
     def initialize(id=SecureRandom.uuid)
       @id = id
-      @messages = {}
+      @messages = ActiveSupport::OrderedHash.new
+      @bot_messages = ActiveSupport::OrderedHash.new
     end
 
     def message(id)
       messages[id]
     end
 
-    def messages_list
-      messages.values
+    def messages_list(user: true, bot: false)
+      bot_messages = bot ? @bot_messages.values : []
+      user_messages = user ? @messages.values : []
+      bot_messages + user_messages
     end
 
     def create_message(text, id=SecureRandom.uuid)
-      WitBot::Message.new self, text, id: id
+      @messages[id] = WitBot::Message.new self, text, id: id
+    end
+
+    def create_bot_message(text, id=SecureRandom.uuid)
+      @bot_messages[id] = WitBot::Bot::Message.new self, text, id: id
     end
 
     def context

data/lib/wit_bot/models/outcome.rb

@@ -19,7 +19,7 @@ module WitBot
 
         entities[role] = data
         entities
-      end
+      end.with_indifferent_access
 
       raise LowConfidenceError self if i == 0 && low_confidence?
     end

data/lib/wit_bot/models/wit/entity/entity_model.rb

@@ -1,7 +1,7 @@
 module WitBot
   class EntityModel
     attr_accessor :others
-    attr_reader :entity, :role, :raw
+    attr_reader :entity, :role, :raw, :value
 
     def initialize(entity, role, raw)
       @entity = entity
@@ -10,12 +10,16 @@ module WitBot
 
       @value = case @raw[:type].to_sym
                when :value
-
+                 @raw[:value].to_s
                else
                  @raw[:value]
                end
 
       @others = []
     end
+
+    def to_s
+      value.to_s
+    end
   end
 end

data/lib/wit_bot/version.rb

@@ -1,3 +1,3 @@
 module WitBot
-  VERSION = '0.1.2'
+  VERSION = '0.2.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: wit_bot
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - Ben (@penne12_)
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-03-14 00:00:00.000000000 Z
+date: 2016-03-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -206,9 +206,15 @@ files:
 - bin/console
 - bin/setup
 - bin/wit
+- examples/bot.rb
+- examples/bot/bot.rb
 - examples/simple.rb
 - examples/thread.rb
 - lib/wit_bot.rb
+- lib/wit_bot/bot/base.rb
+- lib/wit_bot/bot/conversation/base.rb
+- lib/wit_bot/bot/conversation/participant.rb
+- lib/wit_bot/bot/models/message.rb
 - lib/wit_bot/configuration.rb
 - lib/wit_bot/errors/low_confidence_error.rb
 - lib/wit_bot/errors/wit_bot_error.rb