slack-smart-bot 1.3.1 → 1.4.0

data/lib/slack/smart-bot/comm/respond_direct.rb

@@ -0,0 +1,6 @@
+class SlackSmartBot
+  def respond_direct(msg)
+    dest = Thread.current[:user].id
+    respond(msg, dest)
+  end
+end

data/lib/slack/smart-bot/comm/send_file.rb

@@ -0,0 +1,25 @@
+class SlackSmartBot
+
+  #to send a file to an user or channel
+  #send_file(dest, 'the message', "#{project_folder}/temp/logs_ptBI.log", 'message to be sent', 'text/plain', "text")
+  #send_file(dest, 'the message', "#{project_folder}/temp/example.jpeg", 'message to be sent', 'image/jpeg', "jpg")
+  def send_file(to, msg, file, title, format, type = "text")
+    if to[0] == "U" #user
+      im = client.web_client.im_open(user: to)
+      channel = im["channel"]["id"]
+    else
+      channel = to
+    end
+
+    client.web_client.files_upload(
+      channels: channel,
+      as_user: true,
+      file: Faraday::UploadIO.new(file, format),
+      title: title,
+      filename: file,
+      filetype: type,
+      initial_comment: msg,
+    )
+  end
+
+end

data/lib/slack/smart-bot/comm/send_msg_channel.rb

@@ -0,0 +1,30 @@
+class SlackSmartBot
+
+  # to: (String) Channel name or id
+  # msg: (String) message to send
+  def send_msg_channel(to, msg)
+    unless msg == ""
+      get_channels_name_and_id() unless @channels_name.key?(to) or @channels_id.key?(to)
+      if @channels_name.key?(to) #it is an id
+        channel_id = to
+      elsif @channels_id.key?(to) #it is a channel name
+        channel_id = @channels_id[to]
+      else
+        @logger.fatal "Channel: #{to} not found. Message: #{msg}"
+      end
+      if config[:simulate]
+        open("#{config.path}/buffer_complete.log", "a") { |f|
+          f.puts "|#{channel_id}|#{config[:nick_id]}|#{msg}~~~"
+        }
+      else  
+        client.message(channel: channel_id, text: msg, as_user: true)
+      end
+      if config[:testing] and config.on_master_bot
+        open("#{config.path}/buffer.log", "a") { |f|
+          f.puts "|#{channel_id}|#{config[:nick_id]}|#{msg}"
+        }
+      end
+    end
+  end
+
+end

data/lib/slack/smart-bot/comm/send_msg_user.rb

@@ -0,0 +1,37 @@
+class SlackSmartBot
+
+  #to send messages without listening for a response to users
+  def send_msg_user(id_user, msg)
+    unless msg == ""
+      if id_user[0] == "D"
+        if config[:simulate]
+          open("#{config.path}/buffer_complete.log", "a") { |f|
+            f.puts "|#{id_user}|#{config[:nick_id]}|#{msg}~~~"
+          }
+        else  
+          client.message(channel: id_user, as_user: true, text: msg)
+        end
+        if config[:testing] and config.on_master_bot
+          open("#{config.path}/buffer.log", "a") { |f|
+            f.puts "|#{id_user}|#{config[:nick_id]}|#{msg}"
+          }
+        end
+      else
+        im = client.web_client.im_open(user: id_user)
+        if config[:simulate]
+          open("#{config.path}/buffer_complete.log", "a") { |f|
+            f.puts "|#{im["channel"]["id"]}|#{config[:nick_id]}|#{msg}~~~"
+          }
+        else  
+          client.message(channel: im["channel"]["id"], as_user: true, text: msg)
+        end
+        if config[:testing] and config.on_master_bot
+          open("#{config.path}/buffer.log", "a") { |f|
+            f.puts "|#{im["channel"]["id"]}|#{config[:nick_id]}|#{msg}"
+          }
+        end
+      end
+    end
+  end
+
+end

data/lib/slack/smart-bot/commands.rb

@@ -0,0 +1,25 @@
+require_relative "commands/general/hi_bot"
+require_relative "commands/general/bye_bot"
+require_relative "commands/general/bot_help"
+require_relative "commands/on_bot/ruby_code"
+require_relative "commands/general/use_rules"
+require_relative "commands/general/stop_using_rules"
+require_relative "commands/on_master/admin_master/exit_bot"
+require_relative "commands/on_master/admin_master/notify_message"
+require_relative "commands/on_master/admin/kill_bot_on_channel"
+require_relative "commands/on_master/create_bot"
+require_relative "commands/on_bot/admin/add_routine"
+require_relative "commands/on_bot/admin/start_bot"
+require_relative "commands/on_bot/admin/pause_bot"
+require_relative "commands/on_bot/admin/remove_routine"
+require_relative "commands/on_bot/admin/run_routine"
+require_relative "commands/on_bot/admin/pause_routine"
+require_relative "commands/on_bot/admin/start_routine"
+require_relative "commands/on_bot/admin/see_routines"
+require_relative "commands/on_bot/admin/extend_rules"
+require_relative "commands/on_bot/admin/stop_using_rules_on"
+require_relative "commands/general/bot_status"
+require_relative "commands/on_bot/add_shortcut"
+require_relative "commands/on_bot/delete_shortcut"
+require_relative "commands/on_bot/see_shortcuts"
+require_relative "commands/on_extended/bot_rules"

data/lib/slack/smart-bot/commands/on_bot/admin/pause_bot.rb

@@ -11,6 +11,7 @@ class SlackSmartBot
       respond "This bot is paused from now on. You can start it again: start this bot", dest
       respond "zZzzzzZzzzzZZZZZZzzzzzzzz", dest
       @status = :paused
+      @bots_created[@channel_id][:status] = :paused
       unless config.on_master_bot
         send_msg_channel config.master_channel, "Changed status on #{config.channel} to :paused"
       end

data/lib/slack/smart-bot/commands/on_bot/admin/start_bot.rb

@@ -10,6 +10,7 @@ class SlackSmartBot
     if config.admins.include?(from) #admin user
       respond "This bot is running and listening from now on. You can pause again: pause this bot", dest
       @status = :on
+      @bots_created[@channel_id][:status] = :on
       unless config.on_master_bot
         send_msg_channel config.master_channel, "Changed status on #{config.channel} to :on"
       end

data/lib/slack/smart-bot/listen.rb

@@ -5,7 +5,7 @@ class SlackSmartBot
     get_bots_created()
       @buffer_complete = [] unless defined?(@buffer_complete)
       b = File.read("#{config.path}/buffer_complete.log")
-      result = b.scan(/^\|(\w+)\|(\w+)\|([^$]+)\$\$\$/m)
+      result = b.scan(/^\|(\w+)\|(\w+)\|([^~]+)~~~/m)
       result.delete(nil)
       new_messages = result[@buffer_complete.size..-1]
       unless new_messages.nil? or new_messages.empty?
@@ -22,7 +22,6 @@ class SlackSmartBot
   end
 
   def listen
-    @salutations = [config[:nick], "<@#{config[:nick_id]}>", "bot", "smart"]
     @pings = []
     get_bots_created()
 

data/lib/slack/smart-bot/process.rb

@@ -1,29 +1,3 @@
-require_relative "commands/general/hi_bot"
-require_relative "commands/general/bye_bot"
-require_relative "commands/general/bot_help"
-require_relative "commands/on_bot/ruby_code"
-require_relative "commands/general/use_rules"
-require_relative "commands/general/stop_using_rules"
-require_relative "commands/on_master/admin_master/exit_bot"
-require_relative "commands/on_master/admin_master/notify_message"
-require_relative "commands/on_master/admin/kill_bot_on_channel"
-require_relative "commands/on_master/create_bot"
-require_relative "commands/on_bot/admin/add_routine"
-require_relative "commands/on_bot/admin/start_bot"
-require_relative "commands/on_bot/admin/pause_bot"
-require_relative "commands/on_bot/admin/remove_routine"
-require_relative "commands/on_bot/admin/run_routine"
-require_relative "commands/on_bot/admin/pause_routine"
-require_relative "commands/on_bot/admin/start_routine"
-require_relative "commands/on_bot/admin/see_routines"
-require_relative "commands/on_bot/admin/extend_rules"
-require_relative "commands/on_bot/admin/stop_using_rules_on"
-require_relative "commands/general/bot_status"
-require_relative "commands/on_bot/add_shortcut"
-require_relative "commands/on_bot/delete_shortcut"
-require_relative "commands/on_bot/see_shortcuts"
-require_relative "commands/on_extended/bot_rules"
-
 class SlackSmartBot
   def process(user, command, dest, dchannel, rules_file, typem, files)
     from = user.name

data/lib/slack/smart-bot/process_first.rb

@@ -2,7 +2,6 @@ class SlackSmartBot
   def process_first(user, text, dest, dchannel, typem, files)
     nick = user.name
     rules_file = ""
-
     if typem == :on_call
       rules_file = config.rules_file
     elsif dest[0] == "C" or dest[0] == "G" # on a channel or private channel

data/lib/slack/smart-bot/treat_message.rb

@@ -71,7 +71,6 @@ class SlackSmartBot
         end
       end
     end
-
     unless typem == :dont_treat
       begin
         #todo: when changed @questions user_id then move user_info inside the ifs to avoid calling it when not necessary
@@ -146,6 +145,22 @@ class SlackSmartBot
       if !config.on_master_bot and !dest.nil? and (dest == @master_bot_id or dest[0] == "D") and
          data.text.match?(/^\s*bot\s+status\s*$/i) and @admin_users_id.include?(data.user)
         respond "ping from #{config.channel}", dest
+      elsif !config.on_master_bot and !dest.nil? and data.user == config[:nick_id] and dest == @master_bot_id
+        # to treat on other bots the status messages populated on master bot
+        case data.text
+        when /^Bot has been (closed|killed) by/i
+          sleep 2
+          get_bots_created()
+        when /^Changed status on (.+) to :(.+)/i
+          sleep 2
+          get_bots_created()
+        when /extended the rules from (.+) to be used on (.+)\.$/i
+          sleep 2
+          get_bots_created()
+        when /removed the access to the rules of (.+) from (.+)\.$/i
+          sleep 2
+          get_bots_created()
+        end
       end
     end
   end

data/lib/slack/smart-bot/utils.rb

@@ -1,337 +1,12 @@
-class SlackSmartBot
-  def update_bots_file
-    file = File.open(config.file_path.gsub(".rb", "_bots.rb"), "w")
-    bots_created = @bots_created.dup
-    bots_created.each { |k, v| 
-      v[:thread] = "" 
-    }
-    file.write bots_created.inspect
-    file.close
-  end
-
-  def get_bots_created
-    if File.exist?(config.file_path.gsub(".rb", "_bots.rb"))
-      if !defined?(@datetime_bots_created) or @datetime_bots_created != File.mtime(config.file_path.gsub(".rb", "_bots.rb"))
-        file_conf = IO.readlines(config.file_path.gsub(".rb", "_bots.rb")).join
-        if file_conf.to_s() == ""
-          @bots_created = {}
-        else
-          @bots_created = eval(file_conf)
-        end
-        @datetime_bots_created = File.mtime(config.file_path.gsub(".rb", "_bots.rb"))
-        @extended_from = {}
-        @bots_created.each do |k, v|
-          v[:extended] = [] unless v.key?(:extended)
-          v[:extended].each do |ch|
-            @extended_from[ch] = [] unless @extended_from.key?(ch)
-            @extended_from[ch] << k
-          end
-          v[:rules_file].gsub!(/^\./, '')
-        end
-      end
-    end
-  end
-
-  def update_shortcuts_file
-    file = File.open("#{config.path}/shortcuts/#{config.shortcuts_file}", "w")
-    file.write @shortcuts.inspect
-    file.close
-  end
-
-  def get_rules_imported
-    if File.exist?("#{config.path}/rules/rules_imported.rb")
-      if !defined?(@datetime_rules_imported) or @datetime_rules_imported != File.mtime("#{config.path}/rules/rules_imported.rb")        
-        @datetime_rules_imported = File.mtime("#{config.path}/rules/rules_imported.rb")
-        file_conf = IO.readlines("#{config.path}/rules/rules_imported.rb").join
-        unless file_conf.to_s() == ""
-          @rules_imported = eval(file_conf)
-        end
-      end
-    end
-  end
-  
-  def update_rules_imported
-    file = File.open("#{config.path}/rules/rules_imported.rb", "w")
-    file.write @rules_imported.inspect
-    file.close
-  end
-
-  def get_channels_name_and_id
-    #todo: add pagination for case more than 1000 channels on the workspace
-    channels = client.web_client.conversations_list(
-      types: "private_channel,public_channel",
-      limit: "1000",
-      exclude_archived: "true",
-    ).channels
-
-    @channels_id = Hash.new()
-    @channels_name = Hash.new()
-    channels.each do |ch|
-      unless ch.is_archived
-        @channels_id[ch.name] = ch.id
-        @channels_name[ch.id] = ch.name
-      end
-    end
-  end
-
-  def get_routines(channel = @channel_id)
-    if File.exist?("#{config.path}/routines/routines_#{channel}.rb")
-      file_conf = IO.readlines("#{config.path}/routines/routines_#{channel}.rb").join
-      unless file_conf.to_s() == ""
-        @routines = eval(file_conf)
-      end
-    end
-  end
-
-  def update_routines(channel = @channel_id)
-    routines = {}
-    file = File.open("#{config.path}/routines/routines_#{channel}.rb", "w")
-    @routines.each do |k,v|
-      routines[k]={}
-      v.each do |kk,vv|
-        routines[k][kk] = vv.dup
-        routines[k][kk][:thread]=""
-      end
-    end
-    file.write (routines.inspect)
-    file.close
-  end
-
-  def create_routine_thread(name)
-    t = Thread.new do
-      while @routines.key?(@channel_id) and @routines[@channel_id].key?(name)
-        @routines[@channel_id][name][:thread] = Thread.current
-        started = Time.now
-        if @status == :on and @routines[@channel_id][name][:status] == :on
-          @logger.info "Routine: #{@routines[@channel_id][name].inspect}"
-          if @routines[@channel_id][name][:file_path].match?(/\.rb$/i)
-            ruby = "ruby "
-          else
-            ruby = ""
-          end
-          @routines[@channel_id][name][:silent] = false if !@routines[@channel_id][name].key?(:silent)
-
-          if @routines[@channel_id][name][:at] == "" or
-             (@routines[@channel_id][name][:at] != "" and @routines[@channel_id][name][:running] and
-              @routines[@channel_id][name][:next_run] != "" and Time.now.to_s >= @routines[@channel_id][name][:next_run])
-            if @routines[@channel_id][name][:file_path] != ""
-              process_to_run = "#{ruby}#{Dir.pwd}#{@routines[@channel_id][name][:file_path][1..-1]}"
-              process_to_run = ("cd #{project_folder} &&" + process_to_run) if defined?(project_folder)
-
-              stdout, stderr, status = Open3.capture3(process_to_run)
-              if !@routines[@channel_id][name][:silent] or (@routines[@channel_id][name][:silent] and (stderr!='' or stdout!=''))
-                respond "routine *`#{name}`*: #{@routines[@channel_id][name][:file_path]}", @routines[@channel_id][name][:dest]
-              end
-              if stderr == ""
-                unless stdout.match?(/\A\s*\z/)
-                  respond stdout, @routines[@channel_id][name][:dest]
-                end
-              else
-                respond "#{stdout} #{stderr}", @routines[@channel_id][name][:dest]
-              end
-            else #command
-              if !@routines[@channel_id][name][:silent]
-                respond "routine *`#{name}`*: #{@routines[@channel_id][name][:command]}", @routines[@channel_id][name][:dest]
-              end
-              started = Time.now
-              data = { channel: @routines[@channel_id][name][:dest],
-                user: @routines[@channel_id][name][:creator_id],
-                text: @routines[@channel_id][name][:command],
-                files: nil }
-              treat_message(data)
-            end
-            # in case the routine was deleted while running the process
-            if !@routines.key?(@channel_id) or !@routines[@channel_id].key?(name)
-              Thread.exit
-            end
-            @routines[@channel_id][name][:last_run] = started.to_s
-          end
-          if @routines[@channel_id][name][:last_run] == "" and @routines[@channel_id][name][:next_run] != "" #for the first create_routine of one routine with at
-            elapsed = 0
-            require "time"
-            every_in_seconds = Time.parse(@routines[@channel_id][name][:next_run]) - Time.now
-          elsif @routines[@channel_id][name][:at] != "" #coming from start after pause for 'at'
-            if started.strftime("%H:%M:%S") < @routines[@channel_id][name][:at]
-              nt = @routines[@channel_id][name][:at].split(":")
-              next_run = Time.new(started.year, started.month, started.day, nt[0], nt[1], nt[2])
-            else
-              next_run = started + (24 * 60 * 60) # one more day
-              nt = @routines[@channel_id][name][:at].split(":")
-              next_run = Time.new(next_run.year, next_run.month, next_run.day, nt[0], nt[1], nt[2])
-            end
-            @routines[@channel_id][name][:next_run] = next_run.to_s
-            elapsed = 0
-            every_in_seconds = next_run - started
-          else
-            every_in_seconds = @routines[@channel_id][name][:every_in_seconds]
-            elapsed = Time.now - started
-            @routines[@channel_id][name][:last_elapsed] = elapsed
-            @routines[@channel_id][name][:next_run] = (started + every_in_seconds).to_s
-          end
-          @routines[@channel_id][name][:running] = true
-          @routines[@channel_id][name][:sleeping] = (every_in_seconds - elapsed).ceil
-          update_routines()
-          sleep(@routines[@channel_id][name][:sleeping]) unless elapsed > every_in_seconds
-        else
-          sleep 30
-        end
-      end
-    end
-  end
-
-  def build_help(path)
-    help_message = {}
-    Dir["#{path}/*"].each do |t|
-      if Dir.exist?(t)
-        help_message[t.scan(/\/(\w+)$/).join.to_sym] = build_help(t)
-      else
-        help_message[t.scan(/\/(\w+)\.rb$/).join.to_sym] = IO.readlines(t).join.scan(/#\s*help\s*\w*:(.*)/).join("\n")
-      end
-    end
-    return help_message
-  end
-
-  def remove_hash_keys(hash, key)
-    newh = Hash.new
-    hash.each do |k, v|
-      unless k == key
-        if v.is_a?(String)
-          newh[k] = v
-        else
-          newh[k] = remove_hash_keys(v, key)
-        end
-      end
-    end
-    return newh
-  end
-
-  def get_help(rules_file, dest, from, only_rules = false)
-    order = {
-      general: [:hi_bot, :bye_bot, :bot_help, :bot_status, :use_rules, :stop_using_rules],
-      on_bot: [:ruby_code, :add_shortcut, :delete_shortcut, :see_shortcuts],
-      on_bot_admin: [:extend_rules, :stop_using_rules_on, :start_bot, :pause_bot, :add_routine,
-                     :see_routines, :start_routine, :pause_routine, :remove_routine, :run_routine],
-    }
-    # user_type: :admin, :user, :admin_master
-    if config.masters.include?(from)
-      user_type = :admin_master
-    elsif config.admins.include?(from)
-      user_type = :admin
-    else
-      user_type = :user
-    end
-    # channel_type: :bot, :master_bot, :direct, :extended, :external
-    if dest[0] == "D"
-      channel_type = :direct
-    elsif config.on_master_bot
-      channel_type = :master_bot
-    elsif @channel_id != dest
-      channel_type = :extended
-    else
-      channel_type = :bot
-    end
-
-    @help_messages ||= build_help("#{__dir__}/commands")
-    if only_rules
-      help = {}
-    else
-      help = @help_messages.deep_copy
-    end
-    if rules_file != ""
-      help[:rules_file] = IO.readlines(config.path+rules_file).join.scan(/#\s*help\s*\w*:(.*)/i).join("\n")
-    end
-
-    help = remove_hash_keys(help, :admin_master) unless user_type == :admin_master
-    help = remove_hash_keys(help, :admin) unless user_type == :admin or user_type == :admin_master
-    help = remove_hash_keys(help, :on_master) unless channel_type == :master_bot
-    help = remove_hash_keys(help, :on_extended) unless channel_type == :extended
-    help = remove_hash_keys(help, :on_dm) unless channel_type == :direct
-    txt = ""
-    if channel_type == :bot or channel_type == :master_bot
-      txt += "===================================
-      For the Smart Bot start listening to you say *hi bot*
-      To run a command on demand even when the Smart Bot is not listening to you:
-            *!THE_COMMAND*
-            *@NAME_OF_BOT THE_COMMAND*
-            *NAME_OF_BOT THE_COMMAND*\n"
-    end
-    if channel_type == :direct
-      txt += "===================================
-      When on a private conversation with the Smart Bot, I'm always listening to you.\n"
-    end
-    unless channel_type == :master_bot or channel_type == :extended
-      txt += "===================================
-      *Commands from Channels without a bot:*
-      ----------------------------------------------
-      `@BOT_NAME on #CHANNEL_NAME COMMAND`
-      `@BOT_NAME #CHANNEL_NAME COMMAND`
-        It will run the supplied command using the rules on the channel supplied.
-        You need to join the specified channel to be able to use those rules.
-        Also you can use this command to call another bot from a channel with a running bot.
-
-      The commands you will be able to use from a channel without a bot: 
-      *bot rules*, *ruby CODE*, *add shortcut NAME: COMMAND*, *delete shortcut NAME*, *see shortcuts*, *shortcut NAME*
-      *And all the specific rules of the Channel*\n"
-    end
-
-    if help.key?(:general)
-      unless channel_type == :direct
-        txt += "===================================
-        *General commands even when the Smart Bot is not listening to you:*\n"
-      end
-      order.general.each do |o|
-        txt += help.general[o]
-      end
-      if channel_type == :master_bot
-        txt += help.on_master.create_bot
-      end
-    end
-
-    if help.key?(:on_bot)
-      unless channel_type == :direct
-        txt += "===================================
-        *General commands only when the Smart Bot is listening to you or on demand:*\n"
-      end
-      order.on_bot.each do |o|
-        txt += help.on_bot[o]
-      end
-    end
-
-    if help.key?(:on_bot) and help.on_bot.key?(:admin)
-      txt += "===================================
-        *Admin commands:*\n"
-      txt += "\n\n"
-      order.on_bot_admin.each do |o|
-        txt += help.on_bot.admin[o]
-      end
-      if help.key?(:on_master) and help.on_master.key?(:admin)
-        help.on_master.admin.each do |k, v|
-          txt += v if v.is_a?(String)
-        end
-      end
-    end
-
-    if help.key?(:on_master) and help.on_master.key?(:admin_master)
-      txt += "===================================
-      *Master Admin commands:*\n"
-      help.on_master.admin_master.each do |k, v|
-        txt += v if v.is_a?(String)
-      end
-    end
-
-    if help.key?(:on_bot) and help.on_bot.key?(:admin_master) and help.on_bot.admin_master.size > 0
-      txt += "===================================
-      *Master Admin commands:*\n"
-    end
-
-    if help.key?(:rules_file)
-      @logger.info channel_type if config.testing
-      if channel_type == :extended or channel_type == :direct
-        @logger.info help.rules_file if config.testing
-        help.rules_file = help.rules_file.gsub(/^\s*\*These are specific commands.+NAME_OF_BOT THE_COMMAND`\s*$/im, "")
-      end
-      txt += help.rules_file
-    end
-    return txt
-  end
-end
+require_relative 'utils/build_help'
+require_relative 'utils/create_routine_thread'
+require_relative 'utils/get_bots_created'
+require_relative 'utils/get_channels_name_and_id'
+require_relative 'utils/get_help'
+require_relative 'utils/get_routines'
+require_relative 'utils/get_rules_imported'
+require_relative 'utils/remove_hash_keys'
+require_relative 'utils/update_bots_file'
+require_relative 'utils/update_routines'
+require_relative 'utils/update_rules_imported'
+require_relative 'utils/update_shortcuts_file'