bot_platform 0.1.0 → 0.2.3

data/bin/cli

@@ -0,0 +1,34 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "bot_platform"
+require_relative '../lib/bot_platform/cli'
+
+def usage
+  <<-USAGE
+usage: bin/cli [bot_ruby_file]
+e.g. bin/cli ./samples/dialog_simple.rb
+  USAGE
+end
+
+def camelize(str)
+  str.split('_').map(&:capitalize).join
+end
+
+if ARGV[0].nil?
+  puts usage
+  exit(0)
+else
+  unless File.exist?(ARGV[0]) 
+    puts usage
+    exit(-1)
+  end
+  require ARGV[0]
+  base_name = File.basename(ARGV[0],'.rb')
+  instance = Object.const_get(camelize(base_name)).new
+end
+
+
+cli = BotPlatform::Cli.new instance
+cli.run

data/bot_platform.gemspec

@@ -5,11 +5,12 @@ require_relative "lib/bot_platform/version"
 Gem::Specification.new do |spec|
   spec.name          = "bot_platform"
   spec.version       = BotPlatform::VERSION
+  spec.licenses      = ['MIT']
   spec.authors       = ["Ningfeng Yang"]
   spec.email         = ["nf.yang@lifevar.com"]
 
   spec.summary       = "A ruby-based bot platform"
-  spec.description   = "simply write bot codes"
+  spec.description   = "One bot, multiple channels supported"
   spec.homepage      = "https://github.com/lifevar/bot-platform"
   spec.required_ruby_version = ">= 3.0.2"
 
@@ -17,7 +18,7 @@ Gem::Specification.new do |spec|
 
   spec.metadata["homepage_uri"] = spec.homepage
   spec.metadata["source_code_uri"] = "https://github.com/lifevar/bot-platform"
-  spec.metadata["changelog_uri"] = "https://github.com/lifevar.com/bot-platform/CHANGELOG.md"
+  spec.metadata["changelog_uri"] = "https://github.com/Lifevar/bot-platform/blob/main/CHANGELOG.md"
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.

data/docs/channels.md

@@ -0,0 +1,13 @@
+## Current Supported Channels
+
+### Pahse 1 (developing)
+- Console
+- Line Works
+
+### Phase 2 (Oct. 2021)
+- Web
+- Slack
+- Teams
+- Line
+- WeChat
+- ChatWork

data/lib/bot_platform/activity.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module BotPlatform
+  class Activity
+    attr_reader :type, :text, :content, :options, :from, :prefix, :preview_url, :resource_id, :resource_url, :channel_id
+    attr_accessor :to
+      TYPES = {
+      typing: 1, 
+      message: 2,
+      image: 3,
+      confirm: 4,
+      options: 5,
+      carousel: 6,
+      command: 7,
+      card: 9 
+    }.freeze
+
+    def initialize(type, opts={})
+      @type = type
+      @resource_id = opts[:resource_id]
+      @content = opts[:content]
+      @options = opts[:options]
+      @prefix = opts[:prefix]
+      @text = opts[:text]
+      @preview_url = opts[:preview_url]
+      @resource_url = opts[:resource_url]
+      @from = opts[:from]
+      @to = opts[:to]
+      @channel_id = opts[:channel_id]
+    end
+  end
+end

data/lib/bot_platform/adapter.rb

@@ -0,0 +1,87 @@
+# frozen_string_literal: true
+
+require 'singleton'
+require_relative 'asserts'
+module BotPlatform
+  class Adapter
+    include Asserts
+    include Singleton
+    
+
+    attr_reader :channels, :channel_map
+
+    def initialize
+      @channels = []
+      @channel_map = {}
+      channels = ENV['BOT_CHANNELS']
+      raise 'No BOT_CHANNELS found in environment variables.' if channels.nil? || channels.length == 0
+      channels.split(',').each do |ch|
+        channel = Object.const_get("BotPlatform").const_get("Channels").const_get(ch.capitalize).new
+        @channels << channel
+        @channel_map[ch] = channel
+      end
+
+    end
+
+    def send_activities(turn_context, activities)
+      assert_context_is_not_null turn_context
+      assert_activity_is_not_null activities
+      assert_activity_is_not_null activities[0]
+
+      activities.each do |activity|
+        @channel_map[turn_context.channel_id].send_activity(activity)
+      end
+    end
+
+    def update_activity(turn_context, activity, cancel_token)
+
+    end
+
+    def delete_activity(turn_context, conversation, cancel_token)
+    end
+
+    def continue_conversation(bot_id, bot_cb_handler)
+    end
+
+    def create_conversation(bot_id, channel_id, service_url, audience, bot_callback_handler, cancel_token)
+    end
+
+    def process_activity_async(claims_identity, activity, bot_callback_handler, cancel_token)
+    end
+
+    def process_activity(headers, body, &block)
+      channel = nil
+      raise 'No channel registered.' if @channels.nil? || @channels.length==0
+      @channels.each do |ch|
+        if ch.match_request(headers, body)
+          channel = ch
+          break
+        end
+        
+      end
+      raise 'No channel found' if channel.nil?
+
+      activity = channel.parse_incoming_to_activity(headers, body)
+
+      context = BotPlatform::TurnContext.new self, activity
+      block.call(context)
+    end
+
+    def run_pipeline_async(turn_context, callback, cancel_token)
+      assert_context_is_not_null(turn_context)
+
+      if turn_context.activity != nil
+        # set locale
+        # run middleware
+        # rescue custom onTurnError
+      else
+        unless callback.nil?
+          # proactive
+          callback(turn_context, cancel_token)
+        end
+      end
+    end
+
+
+  end
+end

data/lib/bot_platform/asserts.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+module BotPlatform
+  module Asserts
+    def assert_is_not_empty(param)
+      raise "#{param.name} is empty" if param.nil?
+    end
+
+    def assert_dialog_id_is_valid(dialog_id)
+      raise "dialog_id is not valid" unless (dialog_id.is_a? String) && !dialog_id.empty?
+    end
+
+    def assert_dialog_context_is_valid(ctx)
+      raise "dialog context is not valid" unless !ctx.nil? && (ctx.is_a? BotPlatform::Dialogs::DialogContext)
+    end
+
+    def assert_prompt_options_is_valid(options)
+      raise "prompt options is not valid" unless !options.nil? && (options.is_a? BotPlatform::Dialogs::Prompts::PromptOptions)
+    end
+
+    def assert_dialog_set_is_valid(dialogs)
+      raise "dialogs is not valid" if dialogs.nil? || !(dialogs.is_a? Dialogs::DialogSet)
+    end
+
+    def assert_dialog_state_is_valid(state)
+      raise "dialog state is not valid" if state.nil? || !(state.is_a? Dialogs::DialogState)
+    end
+
+    def assert_dialog_is_valid(dialog)
+      raise "dialog is not valid" if dialog.nil? || !(dialog.is_a? Dialogs::Dialog)
+    end
+
+    def assert_dialog_is_uniq(hash, id)
+      raise "dialog is aready added" if !hash[id.to_sym].nil?
+    end
+
+    def assert_activity_is_not_null(activity)
+      raise "activity cannot be null" if activity.nil?
+    end
+
+    def assert_activity_type_is_not_null(type)
+      raise "activity type cannot be null" if type.nil?
+    end
+
+    def assert_turn_context_is_valid(turn_context)
+      raise "turn context is not valid" if turn_context.nil? || !(turn_context.is_a? TurnContext)
+    end
+
+    def assert_context_is_not_null(turn_context)
+      raise "turn context cannot be null" if turn_context.nil?
+    end
+
+    def assert_conversation_reference_is_not_null(conversation_ref)
+      raise "conversation reference cannot be null" if conversation_ref.nil?
+    end
+
+    def assert_activity_list_is_not_null(activities)
+      raise "activity list cannot be null" if activities.nil?
+    end
+
+    def assert_middleware_is_not_null(middleware)
+      raise "middleware cannot be null" if middleware.nil?
+    end
+
+    def assert_middleware_list_is_not_null(middlewares)
+      raise "middleware list cannot be null" if middlewares.nil?
+    end
+  end
+end

data/lib/bot_platform/boot.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module BotPlatform
+  class Boot
+    def self.set_env
+      puts "Set bot environment"
+      # initialize channels
+      BotPlatform::Adapter.instance
+
+    end
+  end
+end

data/lib/bot_platform/channels/base.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module BotPlatform
+  module Channels
+    module Base
+      class NeedImplementation < StandardError; end
+
+      def channel_id
+        raise NeedImplementation
+      end
+
+      def send_activity(activity)
+        raise NeedImplementation
+      end
+
+      def as_command(activity)
+        raise NeedImplementation
+      end
+
+      def match_request(headers,body)
+        raise NeedImplementation
+      end
+
+    end
+  end
+end

data/lib/bot_platform/channels/chatwork.rb

@@ -0,0 +1 @@
+# frozen_string_literal: true

data/lib/bot_platform/channels/console.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+module BotPlatform::Channels
+  class Console
+    include BotPlatform::Channels::Base
+
+    def channel_id
+      "console"
+    end
+
+    def key
+      "X-Bot-Platform-Bot".intern
+    end
+
+    def match_request(headers, body)
+      return false if headers.nil?
+      return !(headers[key].nil? || headers[key].empty?)
+    end
+
+    def send_activity(activity)
+      case activity.type
+      when BotPlatform::Activity::TYPES[:message] then
+        puts "bot> #{activity.text}"
+      when BotPlatform::Activity::TYPES[:carousel] then
+        puts "bot> select from the list:"
+        content = activity.content
+        content[:columns].each_with_index do |col, idx|
+          puts "#{idx+1}: #{col[:title]}(#{col[:text]}) [/#{col[:defaultAction][:data]}]"
+        end
+      when BotPlatform::Activity::TYPES[:options] then
+        puts "bot> #{activity.text}"
+        activity.options.each_with_index{|opt, idx| puts "#{idx+1}: #{opt} [/#{activity.prefix}-opt-#{idx}]"}
+      when BotPlatform::Activity::TYPES[:image] then
+        `open -a '/Applications/Google Chrome.app' #{activity.resource_url}`
+      else
+        puts "bot[debug]> activity.inspect"
+      end
+    end
+
+    def parse_incoming_to_activity(headers, body)
+      user_id = body[:bot_id] || ""
+      room_id = body[:room_id] || ""
+      activity = nil
+      cmd = as_command(headers, body)
+      if cmd
+        activity = BotPlatform::Activity.new ::BotPlatform::Activity::TYPES[:command], {from: {user_id: user_id, room_id: room_id}, text: cmd, channel_id: channel_id}
+      else
+        activity = BotPlatform::Activity.new ::BotPlatform::Activity::TYPES[:message], {from: {user_id: user_id, room_id: room_id}, text: body[:text], channel_id: channel_id}
+      end
+      
+      return activity
+    end
+
+    def as_command(headers, body)
+      return body[:cmd] if body[:type] == "cmd_back"
+      return false
+    end
+
+  end
+end

data/lib/bot_platform/channels/facebook.rb

@@ -0,0 +1 @@
+# frozen_string_literal: true

data/lib/bot_platform/channels/line.rb

@@ -0,0 +1 @@
+# frozen_string_literal: true

data/lib/bot_platform/channels/lineworks.rb

@@ -0,0 +1,102 @@
+# frozen_string_literal: true
+
+module BotPlatform::Channels
+  class Lineworks
+    include Base
+
+    def initialize
+      @queue = []
+      @api_uri = URI.parse("https://apis.worksmobile.com/r/#{ENV['LINE_API_ID']}/message/v1/bot/#{ENV['BOT_NO']}/message/push")
+      @headers = {
+        "Content-type": "application/json",
+        "consumerKey": ENV['LINE_SERVER_CONSUMER_KEY'],
+        "Authorization": ENV['LINE_SERVER_TOKEN']
+      }
+    end
+
+    def channel_id
+      "lineworks"
+    end
+
+    def parse_incoming_to_activity(headers, body)
+      puts "Headers: #{headers.inspect}"
+      puts "body: #{body.inspect}"
+      user_id = body["source"]["accountId"] || ""
+      room_id = body["source"]["roomId"] || ""
+      activity = nil
+      if cmd = as_command(headers, body)
+        activity = ChatBot::Activity.new ::ChatBot::Activity::TYPES[:command], {from: {user_id: user_id, room_id: room_id}, text: cmd, channel_id: channel_id}
+      elsif body["type"] == "message" && body["content"]["type"] == "image"
+        activity = ChatBot::Activity.new ::ChatBot::Activity::TYPES[:image], {from: {user_id: user_id, room_id: room_id}, resource_id: body["content"]["resourceId"], channel_id: channel_id}
+      else
+        activity = ChatBot::Activity.new ::ChatBot::Activity::TYPES[:message], {from: {user_id: user_id, room_id: room_id}, text: body["content"]["text"], channel_id: channel_id}
+      end
+      puts "parse_incoming_to_activity activity:#{activity.to_json}"
+      
+      return activity
+    end
+
+    def send_activity(activity)
+      http = Net::HTTP.new(@api_uri.host, @api_uri.port)
+      http.use_ssl = true
+      http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+
+      content = {}
+      if !activity.to[:room_id].blank?
+        content["roomId"] = activity.to[:room_id]
+      else
+        content["accountId"] = activity.to[:user_id]
+      end
+      case activity.type
+      when ChatBot::Activity::TYPES[:message] then
+        content["content"] = {
+              "type": "text",
+              "text": activity.text
+        }
+      when ChatBot::Activity::TYPES[:image] then
+        content["content"] = {
+              "type": "image",
+              "previewUrl": activity.preview_url,
+              "resourceUrl": activity.resource_url,
+        }
+      when ChatBot::Activity::TYPES[:confirm] then
+        content["content"] = {
+          "type": "button_template",
+          "contentText": activity.text,
+          "actions": [
+            { "type":"message", "label": "はい", "postback": "#{activity.prefix}-yes"}, 
+            { "type":"message", "label": "いいえ","postback":"#{activity.prefix}-no"}
+          ]
+        }
+      when ChatBot::Activity::TYPES[:options] then
+        content["content"] = {
+          "type": "button_template",
+          "contentText": activity.text,
+          "actions": activity.options.map{|opt| {"type":"message", "label":opt, "postback": "#{activity.prefix}-opt-#{opt}"}}
+        }
+      when ChatBot::Activity::TYPES[:carousel] then
+        content["content"] = activity.content
+      else
+      end
+
+      http.start do
+        req = Net::HTTP::Post.new(@api_uri.path)
+        req.initialize_http_header(@headers)
+        req.body = content.to_json
+        http.request(req)
+      end
+    end
+
+    def match_request(headers, body)
+      return !headers["X-Works-Signature"].blank?
+    end
+
+    private
+
+    def as_command(headers, body)
+      return body["data"] if body["type"] == "postback"
+      return body["content"]["postback"] if body["type"] == "message" && !body["content"]["postback"].blank?
+      return false
+    end
+  end
+end