slack-smart-bot 1.9.2 → 1.10.0

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

@@ -2,31 +2,36 @@ class SlackSmartBot
 
   # to: (String) Channel name or id
   # msg: (String) message to send
-  def send_msg_channel(to, msg)
+  def send_msg_channel(to, msg, unfurl_links: true, unfurl_media: true)
     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]}|#{config[:nick]}|#{msg}~~~"
-        }
-      else  
-        if Thread.current[:on_thread]
-          client.message(channel: channel_id, text: msg, as_user: true, thread_ts: Thread.current[:thread_ts])
+      begin
+        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
-          client.message(channel: channel_id, text: msg, as_user: true)
+          @logger.fatal "Channel: #{to} not found. Message: #{msg}"
         end
-      end
-      if config[:testing] and config.on_master_bot
-        open("#{config.path}/buffer.log", "a") { |f|
-          f.puts "|#{channel_id}|#{config[:nick_id]}|#{config[:nick]}|#{msg}"
-        }
+        if config[:simulate]
+          open("#{config.path}/buffer_complete.log", "a") { |f|
+            f.puts "|#{channel_id}|#{config[:nick_id]}|#{config[:nick]}|#{msg}~~~"
+          }
+        else  
+          if Thread.current[:on_thread]
+            client.message(channel: channel_id, text: msg, as_user: true, thread_ts: Thread.current[:thread_ts], unfurl_links: unfurl_links, unfurl_media: unfurl_media)
+          else
+            client.message(channel: channel_id, text: msg, as_user: true, unfurl_links: unfurl_links, unfurl_media: unfurl_media)
+          end
+        end
+        if config[:testing] and config.on_master_bot and !@buffered
+          @buffered = true
+          open("#{config.path}/buffer.log", "a") { |f|
+            f.puts "|#{channel_id}|#{config[:nick_id]}|#{config[:nick]}|#{msg}"
+          }
+        end
+      rescue Exception => stack
+        @logger.warn stack
       end
     end
   end

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

@@ -1,43 +1,68 @@
 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]}|#{config[:nick]}|#{msg}~~~"
-          }
-        else  
-          if Thread.current[:on_thread]
-            client.message(channel: id_user, as_user: true, text: msg, thread_ts: Thread.current[:thread_ts])
+  def send_msg_user(id_user, msg='', on_thread=nil, unfurl_links: true, unfurl_media: true, blocks: [])
+    unless msg == "" and blocks.empty?
+      begin
+        on_thread = Thread.current[:on_thread] if on_thread.nil?
+        (!unfurl_links or !unfurl_media) ? web_client = true : web_client = false
+        web_client = true if !blocks.empty?
+        if id_user[0] == "D"
+          if config[:simulate]
+            open("#{config.path}/buffer_complete.log", "a") { |f|
+              f.puts "|#{id_user}|#{config[:nick_id]}|#{config[:nick]}|#{msg}~~~"
+            }
           else
-            client.message(channel: id_user, as_user: true, text: msg)
+            if web_client
+              if on_thread
+                client.web_client.chat_postMessage(channel: id_user, text: msg, blocks: blocks, as_user: true, unfurl_links: unfurl_links, unfurl_media: unfurl_media, thread_ts: Thread.current[:thread_ts])
+              else
+                client.web_client.chat_postMessage(channel: id_user, text: msg, blocks: blocks, as_user: true, unfurl_links: unfurl_links, unfurl_media: unfurl_media)
+              end
+            else
+              if on_thread
+                client.message(channel: id_user, as_user: true, text: msg, thread_ts: Thread.current[:thread_ts], unfurl_links: unfurl_links, unfurl_media: unfurl_media)
+              else
+                client.message(channel: id_user, as_user: true, text: msg, unfurl_links: unfurl_links, unfurl_media: unfurl_media)
+              end
+            end
           end
-        end
-        if config[:testing] and config.on_master_bot
-          open("#{config.path}/buffer.log", "a") { |f|
-            f.puts "|#{id_user}|#{config[:nick_id]}|#{config[:nick]}|#{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]}|#{config[:nick]}|#{msg}~~~"
-          }
-        else  
-          if Thread.current[:on_thread]
-            client.message(channel: im["channel"]["id"], as_user: true, text: msg, thread_ts: Thread.current[:thread_ts])
-          else
-            client.message(channel: im["channel"]["id"], as_user: true, text: msg)
+          if config[:testing] and config.on_master_bot and !@buffered
+            @buffered = true
+            open("#{config.path}/buffer.log", "a") { |f|
+              f.puts "|#{id_user}|#{config[:nick_id]}|#{config[:nick]}|#{msg}#{blocks.join}"
+            }
+          end
+        else
+          if config[:simulate]
+            open("#{config.path}/buffer_complete.log", "a") { |f|
+              f.puts "|#{DIRECT[id_user.to_sym].ubot}|#{config[:nick_id]}|#{config[:nick]}|#{msg}#{blocks.join}~~~"
+            }
+          else  
+            im = client.web_client.conversations_open(users: id_user)
+            if web_client
+              if on_thread
+                client.web_client.chat_postMessage(channel: im["channel"]["id"], text: msg, blocks: blocks, as_user: true, unfurl_links: unfurl_links, unfurl_media: unfurl_media, thread_ts: Thread.current[:thread_ts])
+              else
+                client.web_client.chat_postMessage(channel: im["channel"]["id"], text: msg, blocks: blocks, as_user: true, unfurl_links: unfurl_links, unfurl_media: unfurl_media)
+              end
+            else
+              if on_thread
+                client.message(channel: im["channel"]["id"], as_user: true, text: msg, thread_ts: Thread.current[:thread_ts], unfurl_links: unfurl_links, unfurl_media: unfurl_media)
+              else
+                client.message(channel: im["channel"]["id"], as_user: true, text: msg, unfurl_links: unfurl_links, unfurl_media: unfurl_media)
+              end
+            end
+          end
+          if config[:testing] and config.on_master_bot and !@buffered
+            @buffered = true
+            open("#{config.path}/buffer.log", "a") { |f|
+              f.puts "|#{im["channel"]["id"]}|#{config[:nick_id]}|#{config[:nick]}|#{msg}#{blocks.join}"
+            }
           end
         end
-        if config[:testing] and config.on_master_bot
-          open("#{config.path}/buffer.log", "a") { |f|
-            f.puts "|#{im["channel"]["id"]}|#{config[:nick_id]}|#{config[:nick]}|#{msg}"
-          }
-        end
+      rescue Exception => stack
+        @logger.warn stack
       end
     end
   end

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

@@ -3,27 +3,31 @@ class SlackSmartBot
   # unreact(:thumbsup)
   # ts: can be true, false or a specific ts
   def unreact(emoji, ts=false)
-    if ts.is_a?(TrueClass) or ts.is_a?(FalseClass)
-      parent = ts
-      ts = nil
-    else
-      parent = false
-    end
-    if ts.nil?
-      if parent or Thread.current[:ts].to_s == ''
-        ts = Thread.current[:thread_ts]
+    begin
+      if ts.is_a?(TrueClass) or ts.is_a?(FalseClass)
+        parent = ts
+        ts = nil
       else
-        ts = Thread.current[:ts]
+        parent = false
       end
-    end
-    if ts.nil?
-      @logger.warn 'unreact method no ts supplied'
-    else
-      begin
-        client.web_client.reactions_remove(channel: Thread.current[:dest], name: emoji, timestamp: ts) unless config.simulate
-      rescue Exception => stack
-        @logger.warn stack
+      if ts.nil?
+        if parent or Thread.current[:ts].to_s == ''
+          ts = Thread.current[:thread_ts]
+        else
+          ts = Thread.current[:ts]
+        end
+      end
+      if ts.nil?
+        @logger.warn 'unreact method no ts supplied'
+      else
+        begin
+          client.web_client.reactions_remove(channel: Thread.current[:dest], name: emoji, timestamp: ts) unless config.simulate
+        rescue Exception => stack
+          @logger.warn stack
+        end
       end
+    rescue Exception => stack
+      @logger.warn stack
     end
   end
 end

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

@@ -1,5 +1,6 @@
 require_relative 'comm/ask'
 require_relative 'comm/dont_understand'
+require_relative 'comm/respond_thread'
 require_relative 'comm/respond_direct'
 require_relative 'comm/respond'
 require_relative 'comm/send_file'
@@ -8,6 +9,7 @@ require_relative 'comm/send_msg_user'
 require_relative 'comm/react'
 require_relative 'comm/unreact'
 require_relative 'comm/get_user_info'
+require_relative 'comm/get_users'
 require_relative 'comm/event_hello'
 require_relative 'comm/get_channel_members'
 require_relative 'comm/get_channels'

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

@@ -0,0 +1,32 @@
+class SlackSmartBot
+
+  def add_announcement(user, type, message)
+    save_stats(__method__)
+    if has_access?(__method__, user)
+      if Thread.current[:typem] == :on_call
+        channel = Thread.current[:dchannel]
+      else
+        channel = Thread.current[:dest]
+      end
+      if File.exists?("#{config.path}/announcements/#{channel}.csv") and !@announcements.key?(channel)
+        t = CSV.table("#{config.path}/announcements/#{channel}.csv", headers: ['message_id', 'user_deleted', 'user_created', 'date', 'time', 'type', 'message'])
+        @announcements[channel] = t
+        num = t[:message_id].max + 1
+      elsif !@announcements.key?(channel)
+        File.open("#{config.path}/announcements/#{channel}.csv","w")
+        t = CSV.table("#{config.path}/announcements/#{channel}.csv", headers: ['message_id', 'user_deleted', 'user_created', 'date', 'time', 'type', 'message'])
+        num = 1
+        @announcements[channel] = t
+      else
+        num = @announcements[channel][:message_id].max + 1
+      end
+      values = [num, '', user.name, Time.now.strftime("%Y/%m/%d"), Time.now.strftime("%H:%M"), type, message]
+      @announcements[channel] << values
+      CSV.open("#{config.path}/announcements/#{channel}.csv", "a+") do |csv|
+        csv << values
+      end
+      respond "The announcement has been added. (id: #{num}).\nRelated commands `see announcements`, `delete announcement ID`"
+
+    end
+  end
+end

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

@@ -1,24 +1,9 @@
 class SlackSmartBot
 
-  # help: ----------------------------------------------
-  # help: `bot help`
-  # help: `bot help COMMAND`
-  # help: `bot rules`
-  # help: `bot rules COMMAND`
-  # help: `bot help expanded`
-  # help: `bot rules expanded`
-  # help: `bot what can I do?`
-  # help:    it will display this help. For a more detailed help call `bot help expanded` or `bot rules expanded`.
-  # help:    if COMMAND supplied just help for that command
-  # help:    you can use the option 'expanded' or the alias 'extended'
-  # help:    `bot rules` will show only the specific rules for this channel.
-  # help:
-  def bot_help(user, from, dest, dchannel, specific, help_command, rules_file)
-    save_stats(__method__)
-    if config[:allow_access].key?(__method__) and !config[:allow_access][__method__].include?(user.name) and !config[:allow_access][__method__].include?(user.id) and 
-      (!user.key?(:enterprise_user) or ( user.key?(:enterprise_user) and !config[:allow_access][__method__].include?(user[:enterprise_user].id)))
-      respond "You don't have access to use this command, please contact an Admin to be able to use it: <@#{config.admins.join(">, <@")}>"
-    else
+  def bot_help(user, from, dest, dchannel, specific, help_command, rules_file, savestats=true)
+    save_stats(__method__) if savestats
+    output = []
+    if has_access?(__method__, user)
       help_found = false
 
       message = ""
@@ -28,36 +13,65 @@ class SlackSmartBot
         message_not_expanded = ''
       else
         expanded = false
-        message_not_expanded = "*If you want to see the expanded version of `bot help` or `bot rules`, please call `bot help expanded` or `bot rules expanded`*\n"
-        message_not_expanded += "*Also to get specific expanded help for a specific command or rule call `bot help COMMAND`*\n"
+        message_not_expanded = "If you want to see the *expanded* version of *`bot help`* or *`bot rules`*, please call *`bot help expanded`* or *`bot rules expanded`*\n"
+        message_not_expanded += "Also to get specific *expanded* help for a specific command or rule call *`bot help COMMAND`*\n"
       end
-
       help_message = get_help(rules_file, dest, from, specific, expanded)
-
+      commands = []
+      commands_search = []
       if help_command.to_s != ""
         help_message.gsub(/====+/,'-'*30).split(/^\s*-------*$/).each do |h|
-          if h.match?(/[`_]#{help_command}/i)
-            respond h, dest
+          if h.match?(/[`_]#{help_command}/i) or h.match?(/^\s*command_id:\s+:#{help_command.gsub(' ', '_')}\s*$/)
+            output << h
             help_found = true
+            commands << h
+          elsif !h.match?(/\A\s*\*/) and !h.match?(/\A\s*=+/) #to avoid general messages for bot help *General commands...*
+            all_found = true
+            help_command.to_s.split(' ') do |hc|
+              unless hc.match?(/^\s*\z/)
+                if !h.match?(/#{hc}/i)
+                  all_found = false                  
+                end
+              end
+            end
+            commands_search << h if all_found
           end
         end
       else
         if Thread.current[:using_channel]!=''
           message += "*You are using rules from another channel: <##{Thread.current[:using_channel]}>. These are the specific commands for that channel:*"
         end
-        respond message, dest
+        output << message
       end
 
       if (help_command.to_s == "")
         help_message.split(/^\s*=========*$/).each do |h|
-          respond("#{"=" * 35}\n#{h}", dest) unless h.match?(/\A\s*\z/)
+          unless h.match?(/\A\s*\z/)
+            output << "#{"=" * 35}\n#{h}"
+          end
+        end
+        if Thread.current[:typem] == :on_pg or Thread.current[:typem] == :on_pub
+          if @bots_created.size>0
+            txt = "\nThese are the *SmartBots* running on this Slack workspace: *<##{@master_bot_id}>, <##{@bots_created.keys.join('>, <#')}>*\n"
+            txt += "Join one channel and call *`bot rules`* to see specific commands for that channel or *`bot help`* to see all commands for that channel.\n"
+            output << txt
+          end
         end
       else
+        if commands.size < 10 and help_command.to_s!='' and commands_search.size > 0
+          commands_search.shuffle!
+          (10-commands.size).times do |n|
+            unless commands_search[n].nil?
+              output << commands_search[n]
+              help_found = true
+            end
+          end
+        end
         unless help_found
           if specific
-            respond("I didn't find any rule starting by `#{help_command}`", dest)
+            output << "I didn't find any rule with `#{help_command}`"
           else
-            respond("I didn't find any command starting by `#{help_command}`", dest)
+            output << "I didn't find any command with `#{help_command}`"
           end
         end
       end
@@ -69,7 +83,7 @@ class SlackSmartBot
           end
         end
         if defined?(git_project) && (git_project.to_s != "") && (help_command.to_s == "")
-          respond "Git project: #{git_project}", dest
+          output << "Git project: #{git_project}"
         else
           def git_project
             ""
@@ -80,9 +94,22 @@ class SlackSmartBot
           end
         end
       elsif help_command.to_s == ""
-        respond "Slack Smart Bot Github project: https://github.com/MarioRuiz/slack-smart-bot", dest
+        output << "Slack Smart Bot Github project: https://github.com/MarioRuiz/slack-smart-bot"
+      end
+      unless expanded
+        output << message_not_expanded
+      end
+    end
+    if output.join("\n").lines.count > 50 and dest[0]!='D'
+      dest = :on_thread
+      output.unshift('Since there are many lines returned the results are returned on a thread by default.')
+    end
+    output.each do |h|
+      msg = h.gsub(/^\s*command_id:\s+:\w+\s*$/,'')
+      unless msg.match?(/\A\s*\z/)
+        respond msg, dest, unfurl_links: false, unfurl_media: false
       end
-      respond message_not_expanded unless expanded
     end
+    return output.join("\n")
   end
 end

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

@@ -28,6 +28,7 @@ class SlackSmartBot
     # help:      _bot stats #sales today_
     # help:      _bot stats #sales from 2020-01-01 monthly_
     # help:      _bot stats exclude routines masters from 2021/01/01 monthly_
+    # help:    <https://github.com/MarioRuiz/slack-smart-bot#bot-management|more info>
     # help:
     def bot_stats(dest, from_user, typem, channel_id, from, to, user, st_command, exclude_masters, exclude_routines, exclude_command, monthly, all_data)
         require 'csv'
@@ -81,16 +82,16 @@ class SlackSmartBot
                 end
     
                 if user!=''
-                    user_info = get_user_info(user)
-                    if users_id_name.key?(user_info.user.id)
-                        user_name = users_id_name[user_info.user.id]
+                    user_info = @users.select{|u| u.id == user or (u.key?(:enterprise_user) and u.enterprise_user.id == user)}[-1]
+                    if users_id_name.key?(user_info.id)
+                        user_name = users_id_name[user_info.id]
                     else
-                        user_name = user_info.user.name
+                        user_name = user_info.name
                     end
-                    if users_name_id.key?(user_info.user.name)
-                        user_id = users_name_id[user_info.user.name]
+                    if users_name_id.key?(user_info.name)
+                        user_id = users_name_id[user_info.name]
                     else
-                        user_id = user_info.user.id
+                        user_id = user_info.id
                     end
                 end
                 master_admins = config.masters.dup
@@ -105,7 +106,7 @@ class SlackSmartBot
                 end
     
                 Dir["#{config.stats_path}.*.log"].sort.each do |file|
-                    if file >= "#{config.stats_path}.#{from_file}.log" or file <= "#{config.stats_path}.#{to_file}.log"
+                    if file >= "#{config.stats_path}.#{from_file}.log" and file <= "#{config.stats_path}.#{to_file}.log"
                         CSV.foreach(file, headers: true, header_converters: :symbol, converters: :numeric) do |row|
                             row[:date] = row[:date].to_s
                             if row[:dest_channel_id].to_s[0]=='D'
@@ -125,7 +126,7 @@ class SlackSmartBot
                                 if !exclude_routines or (exclude_routines and !row[:user_name].match?(/^routine\//) )
                                     if exclude_command == '' or (exclude_command!='' and row[:command]!=exclude_command)
                                         if st_command == '' or (st_command != '' and row[:command] == st_command)
-                                            if row[:bot_channel_id] == channel_id or channel_id == ''
+                                            if row[:bot_channel_id] == channel_id or channel_id == '' or row[:dest_channel_id] == channel_id
                                                 if row[:date] >= from and row[:date] <= to
                                                     count_users[row[:user_id]] ||= 0
                                                     count_users[row[:user_id]] += 1