sinbotra 0.1.6 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4b234ddd78053ba74b469a2f9286d152c6f51f43
-  data.tar.gz: 362c8ab94b8d5a24eb2a7209e03e05aa149ee326
+  metadata.gz: 978fcbcaca2a3766c1a7b655713a30cdff701d70
+  data.tar.gz: 58df78433260eb468f01632274f292c947955f62
 SHA512:
-  metadata.gz: 201c51423d49bd568f511aacc4659496f51e465b34a80a05252e4ca3df64c67931742d05c753f6da96b17b6653e986e6dd37e84cf6efcecd0fc64150b7fa5eed
-  data.tar.gz: 8bccd900765a669141fd285fd83275488a4d11825c585a68e5e335564168e4c627966f90be852c2d5a45466285deb134d83500aad61afbebfe5a456f11f54af4
+  metadata.gz: 1e5aaeaf20e279e5c4f47063ba10267cb0ed98955608c1af215a0f16768eba80a25f200793887eb8b0f1b0fc6a6a07ab391d1f2e0e16bfa7c703ab7014cce767
+  data.tar.gz: 3a5202cc1d82c29e0258b570644b27d7a9d1d3e20451d50cac4b020c985ecd3c6b32be9ab382f817feab2cf5c805aedd01abe4362e0e49cbd29cb9e9e9718a18

data/.gitignore

@@ -10,3 +10,4 @@
 
 .env*
 .DS_Store
+tags

data/README.md

@@ -39,3 +39,129 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/[USERN
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
 
+## New API!
+
+You take an incoming message
+
+Create a user out of the sender and a bot out of the user
+
+You tell the bot to handle the message
+
+It checks if the user is in a conversation
+
+If YES then handle the current conversation step. On step end, increase conversation step or end convo
+
+If NO then cycle through handlers
+
+If still nothing, answer with default if it exists
+
+If still not, use default I don't understandj
+
+
+```ruby
+class BurpeeBot < Sinbotra::Bot
+  listeners onboard:       /hi|hello/,
+            start_workout: /start|begin/
+
+  default_listener :default
+
+  conversations onboarding:    OnboardingConversation,
+                start_workout: StartWorkoutConversation
+
+  actions start_workout: StartWorkoutAction
+
+  def onboard(msg, user)
+    bot.say(user, "Hello #{user.name}")
+    start_conversation(:onboarding)
+  end
+
+  def start_workout(msg, user)
+  end
+
+  def default(msg, user)
+  end
+end
+
+BurpeeBot.perform_action(:start_workout, args)
+
+class StartWorkoutAction
+  def call(bot, args={})
+    athletes = Athlete::Repo.find_fresh
+    athletes.each do |athlete|
+      bot.send_text(athlete.fb_id, "Time to work out!!!")
+    end
+  end
+end
+
+class Sinbotra::Conversation
+  class << self
+    attr_reader :step_names
+    def steps(*all_steps)
+      @step_names = all_steps
+    end
+  end
+
+  attr_reader :current_user
+  attr_reader :step_num
+
+  def initialize(user, bot)
+    @current_user = user
+    @step_num = 0
+    @active   = true
+    @steps    = self.class.step_names
+  end
+
+  def next_step!
+    @step_num += 1
+    if @step_num == @steps.size
+      end_conversation!
+    end
+  end
+
+  def say(txt)
+    STDOUT.puts(txt)
+  end
+
+  def end_conversation!
+    @step_num = -1
+    @active   = false
+  end
+
+  def active?; @active; end
+end
+
+class OnboardingConversation
+  include Sinbotra::Conversation
+
+  steps :ask_name, :ask_age, :ask_fitness_level, :all_good
+
+  def ask_name(msg)
+    say("Hello, what is your name?")
+    # I have access to current_user
+    next_step!
+  end
+
+  def ask_age(msg, bot)
+    say("Great, your name is #{msg.text}")
+    say("How old are you?")
+    next_step!
+  end
+
+  def ask_fitness_level(msg, bot)
+    say("Great, your #{msg.text} years old.")
+    say("What's your fitness level?")
+    next_step!
+  end
+
+  def all_good(msg, bot)
+    say("Great, your fitness level is #{msg.text}.")
+    say("We have everything we need!")
+    end_conversation!
+  end
+end
+
+class Bot::User
+  attr_reader :id, :current_converation
+end
+
+```

data/lib/sinbotra.rb

@@ -6,7 +6,13 @@ require "sinbotra/config"
 
 # Require sinbotra framework
 require "sinbotra/version"
-require "sinbotra/bot"
+require "sinbotra/message_store"
+require "sinbotra/message_handler"
+require "sinbotra/bot/redis_store"
+require "sinbotra/bot/user"
+require "sinbotra/bot/user_store"
+require "sinbotra/bot/user_repo"
+require "sinbotra/bot/conversation"
 require "sinbotra/messenger"
 
 module Sinbotra

data/lib/sinbotra/bot.rb

@@ -1,7 +1,8 @@
-require "sinbotra/bot/conversation"
-require "sinbotra/bot/conversation_repo"
+require "sinbotra/bot/redis_store"
 require "sinbotra/bot/user"
+require "sinbotra/bot/user_store"
 require "sinbotra/bot/user_repo"
+require "sinbotra/bot/conversation"
 
 require "sucker_punch"
 
@@ -25,7 +26,9 @@ module Sinbotra
       def receive(provider, msg)
         handler = @handlers[provider.to_sym]
         Sinbotra::Config.logger.debug("MESSAGE DEBUG:\n" + msg.inspect) if ENV["DEBUG"]
-        handler.handle_message(msg)
+        user = Sinbotra::User.from_message(msg)
+        bot = handler.new(user)
+        bot.handle_message(msg)
       end
 
       def handle_action(action_name, provider, handler, opts={})
@@ -35,10 +38,9 @@ module Sinbotra
 
     include SuckerPunch::Job
 
-    def perform(provider, msg)
-      # THis needs to be done elsewhere
-      msg["entry"].first["messaging"].each do |m|
-        Sinbotra::Bot.receive(provider, m)
+    def perform(provider, msgs)
+      msgs.each do |msg|
+        Sinbotra::Bot.receive(provider, msg)
       end
     end
   end

data/lib/sinbotra/bot/conversation.rb

@@ -1,86 +1,85 @@
 class Sinbotra::Bot
   class Conversation
-    Step = Struct.new(:id, :callback)
+    class << self
+      attr_reader :_steps
 
-    attr_reader :id
-    attr_reader :steps
+      private
 
-    def initialize(id, store={})
-      @id           = id
-      @steps        = []
-      @store        = store
-      update_current_step(0)
-      store!(:is_active, false)
+      def steps(*_steps)
+        @_steps = _steps
+      end
     end
 
-    def start
-      store!(:is_active, true)
+    def initialize(bot, platform)
+      @bot          = bot
+      @current_user = bot.current_user
+      @message      = bot.message
+      @platform     = platform
     end
 
-    def active?
-      recall(:is_active)
+    def start
+      run_step!(current_user.conversation.step, message)
     end
 
-    def current_step
-      recall(:_current_step)
+    def continue_dialogue
+      run_step!(current_user.conversation.step, message)
     end
 
-    def step(id, &blk)
-      @steps << Step.new(id, blk)
-    end
+    private
 
-    def store!(k, v)
-      @store[k] = v
-    end
+    attr_reader :current_user
+    attr_reader :message
+    attr_reader :platform
 
-    def recall(k)
-      @store[k]
+    def start_conversation(convo_id)
+      @bot.start_conversation(convo_id)
     end
 
-    def say(text)
-      puts text
+    def has_conversation?(intent)
+      @bot.has_conversation(intent)
     end
 
-    def skip_to_next_step!
-      puts "NOOP skip_to_next_step!"
+    def get_intent(msg)
+      @bot.get_intent(msg)
     end
 
-    def next_step!
-      new_step = current_step + 1
-      update_current_step(new_step)
-      done! if completed_last_step?
-    end
+    def steps; self.class._steps; end
 
-    def next_step_now!(bot)
-      next_step!
-      perform_current_step(bot)
-    end
+    def step(n) steps[n]; end
 
-    def repeat_step!
-      puts "Repeating conversation step. Nothing to do here."
+    def step_count; steps.size; end
+
+    def run_step!(step_number, message)
+      send(step(step_number), message)
     end
 
-    def done!
-      update_current_step(0)
-      store!(:is_active, false)
+    def skip_to_next_step!
+      next_step!
     end
 
-    def perform_current_step(bot)
-      current_action.(bot)
+    def has_steps?
+      current_user.conversation.step < step_count - 1
     end
 
-    private
+    def next_step!
+      has_steps? ? current_user.next_step! : done!
+    end
 
-    def completed_last_step?
-      current_step == @steps.size
+    def next_step_now!
+      if has_steps?
+        current_user.next_step!
+        run_step!(current_user.conversation.step, message)
+      else
+        raise ArgumentError, "We're out of steps, shouldn't be skipping: #{self}"
+      end
     end
 
-    def update_current_step(n)
-      store!(:_current_step, n)
+    def repeat_step!
+      # do nothing, leave state the same
     end
 
-    def current_action
-      @steps[current_step].callback
+    def done!
+      current_user.end_conversation!
     end
   end
 end

data/lib/sinbotra/bot/redis_store.rb

@@ -0,0 +1,20 @@
+class Sinbotra::Bot
+  class RedisStore
+    def get(id)
+      res = $redis.get(make_key(id))
+      Marshal.load(res) unless res.nil?
+    end
+    alias_method :[], :get
+
+    def set(id, obj)
+      raw = Marshal.dump(obj)
+      $redis.set(make_key(id), raw)
+    end
+    alias_method :[]=, :set
+
+    def make_key(id)
+      raise NotImplementedError, "make_key needs to be implemented by children"
+    end
+  end
+end
+

data/lib/sinbotra/bot/user.rb

@@ -1,59 +1,22 @@
 require "securerandom"
-require "sinbotra/bot/default_message_history"
 
 class Sinbotra::Bot
   class User
-    attr_reader :id
-    attr_reader :session_id
-    attr_reader :current_message
-    attr_reader :conversations
-    attr_reader :history
-
-    def initialize(id, history=Sinbotra::Bot::DefaultMessageHistory.new)
-      @id            = id
-      @history       = history
-      @session_id    = nil
-      @conversations = []
-      start_session
-    end
-
-    def handle_message(msg)
-      @current_message = msg
-      history.add_message(msg)
-    end
-
-    # Sessions
+    Conversation = Struct.new(:id, :step)
 
-    def logged_in?() !@session_id.nil? end
-
-    # remove user while not removing history
-    def destroy
-      end_session
-    end
-
-    # Conversations
-
-    def start_conversation(convo)
-      conversations.unshift(convo)
-      convo.start
-    end
-
-    def in_conversation?
-      !current_conversation.nil?
-    end
+    attr_reader :id
+    attr_reader :conversation
 
-    def current_conversation
-      conversations.find { |c| c.active? }
+    def initialize(id)
+      @id = id
     end
 
-    private
-
-    def start_session
-      @session_id = SecureRandom.uuid
+    def end_conversation
+      @conversation = nil
     end
 
-    def end_session
-      @session_id = nil
+    def update_conversation(id, step)
+      @conversation = Conversation.new(id, step)
     end
   end
 end

data/lib/sinbotra/bot/user_repo.rb

@@ -1,22 +1,48 @@
 class Sinbotra::Bot
   class UserRepo
     class << self
-      def connect
-        @users ||= {}
+      def connect(store=UserStore.new)
+        @users ||= store
       end
 
-      def find_or_create(user_class, id)
+      def find_or_create(id)
         user = @users[id]
         if user.nil?
-          user = user_class.new(id)
-          @users[id] = user
+          user = create(id)
         end
         user
       end
 
+      def create(id)
+        user = Sinbotra::Bot::User.new(id)
+        update(user)
+        user
+      end
+
+      def next_step!(user)
+        step = user.conversation.step + 1
+        update_conversation(user, user.conversation.id, step)
+      end
+
+      def start_conversation(user_id, convo_id)
+        user = find_or_create(user_id)
+        user = update_conversation(user: user, convo_id: convo_id, step: 0)
+        user
+      end
+
+      def update_conversation(user:, convo_id:, step:)
+        user.update_conversation(convo_id, step)
+        update(user)
+        user
+      end
+
+      def update(user)
+        @users[user.id] = user
+      end
+
       def messages(id)
-        user = @users[id]
-        user.history.all
+        # Get messages from message store
+        $logger.debug("WIP user messages retrieval")
       end
     end
   end