slack-smart-bot 1.9.2 → 1.10.0

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

@@ -3,14 +3,12 @@ class SlackSmartBot
   # helpadmin: `bot status`
   # helpadmin:    Displays the status of the bot
   # helpadmin:    If on master channel and admin user also it will display info about bots created
+  # helpadmin:    <https://github.com/MarioRuiz/slack-smart-bot#bot-management|more info>
   # helpadmin:
   def bot_status(dest, user)
     save_stats(__method__)
     get_bots_created()
-    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
+    if has_access?(__method__, user)
       gems_remote = `gem list slack-smart-bot --remote`
       version_remote = gems_remote.to_s().scan(/slack-smart-bot \((\d+\.\d+\.\d+)/).join
       version_message = ""

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

@@ -1,12 +1,5 @@
 class SlackSmartBot
 
-  # help: ----------------------------------------------
-  # help: `Bye Bot`
-  # help: `Bye Smart`
-  # help: `Bye NAME_OF_THE_BOT`
-  # help:    Bot stops listening to you
-  # help:    Also apart of Bye you can use _Bæ, Good Bye, Adiós, Ciao, Bless, Bless Bless, Adeu_
-  # help:
   def bye_bot(dest, from, display_name)
     if @status == :on
       save_stats(__method__)

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

@@ -0,0 +1,34 @@
+class SlackSmartBot
+
+  def delete_announcement(user, message_id)
+    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
+      end
+      found = false
+      message = ''
+      if @announcements.key?(channel) and @announcements[channel][:message_id].include?(message_id.to_i)
+        CSV.open("#{config.path}/announcements/#{channel}.csv", "w") do |csv|
+          @announcements[channel].each do |row|
+            if row[:message_id].to_i == message_id.to_i
+              message = row[:message]
+              row[:user_deleted] = user.name
+            end    
+            csv << row
+          end
+        end
+        respond "The announcement has been deleted: #{message}"
+      else
+        respond "Sorry but I didn't find the message id #{message_id}. Call `see announcements` to see the ids."
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,34 @@
+class SlackSmartBot
+
+  def delete_share(user, share_id)
+    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}/shares/#{@channels_name[channel]}.csv") and !@shares.key?(@channels_name[channel])
+        t = CSV.table("#{config.path}/shares/#{@channels_name[channel]}.csv", headers: ['share_id', 'user_deleted', 'user_created', 'date', 'time', 'type', 'to_channel', 'condition'])
+        @shares[@channels_name[channel]] = t
+      end
+      found = false
+      message = ''
+      if @shares[@channels_name[channel]][:share_id].include?(share_id.to_i)
+        CSV.open("#{config.path}/shares/#{@channels_name[channel]}.csv", "w") do |csv|
+          @shares[@channels_name[channel]].each do |row|
+            if row[:share_id].to_i == share_id.to_i
+              message = row[:condition]
+              row[:user_deleted] = user.name
+            end    
+            csv << row
+          end
+        end
+        respond "The share has been deleted: #{message}"
+      else
+        respond "Sorry but I didn't find the share id #{share_id}. Call `see shares` to see all the ids."
+      end
+
+    end
+  end
+end

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

@@ -1,21 +1,26 @@
 class SlackSmartBot
 
-  # help: ----------------------------------------------
-  # help: `Hi Bot`
-  # help: `Hi Smart`
-  # help: `Hello Bot` `Hola Bot` `Hallo Bot` `What's up Bot` `Hey Bot` `Hæ Bot`
-  # help: `Hello THE_NAME_OF_THE_BOT`
-  # help:    Bot starts listening to you
-  # help:    After that if you want to avoid a single message to be treated by the smart bot, start the message by -
-  # help:    Also apart of Hello you can use _Hallo, Hi, Hola, What's up, Hey, Hæ_
-  # help:
-  def hi_bot(user, dest, dchannel, from, display_name)
+  def hi_bot(user, dest, from, display_name)
     if @status == :on
       save_stats(__method__)
       greetings = ["Hello", "Hallo", "Hi", "Hola", "What's up", "Hey", "Hæ"].sample
       respond "#{greetings} #{display_name}", dest
+      if Thread.current[:typem] == :on_pub or Thread.current[:typem] == :on_pg
+        respond "You are on a channel where the SmartBot is just a member. You can only run general bot commands.\nCall `bot help` to see the commands you can use."
+      elsif Thread.current[:typem] == :on_extended
+        message = ["You are on an extended channel from <##{@channel_id}> so you can use all specific commands from that channel just adding !, !! or ^ before the command."]
+        message << "Call `bot help` to see the commands you can use."
+        respond message.join("\n")
+      elsif Thread.current[:typem] == :on_dm and Thread.current[:using_channel] == ''
+        respond "To start using the rules from a Bot channel call `use #CHANNEL`.\nAvailable SmartBots: <##{@bots_created.keys.join('>, <#')}>\nIf you want to call just one command from a specific channel: `#CHANNEL COMMAND`"
+      else
+        respond "You are on <##{@channel_id}> SmartBot channel. Call `bot help` to see all commands you can use or `bot rules` just to see the specific commands for this Bot channel."
+      end
       if Thread.current[:using_channel]!=''
-        respond "You are using specific rules for channel: <##{Thread.current[:using_channel]}>", dest
+        message = ["You are using rules from <##{Thread.current[:using_channel]}>"]
+        message << "If you want to change bot channel rules call `use #CHANNEL` or `stop using rules from <##{Thread.current[:using_channel]}>` to stop using rules from this channel."
+        message << "You can call a command from any other channel by calling `#CHANNEL COMMAND`" if Thread.current[:typem] == :on_dm
+        respond message.join("\n")
       end
       @listening[from] = {} unless @listening.key?(from)
       if Thread.current[:on_thread]

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

@@ -0,0 +1,200 @@
+class SlackSmartBot
+    # help: ----------------------------------------------
+    # help: `leaderboard`
+    # help: `ranking`
+    # help: `podium`
+    # help: `leaderboard from YYYY/MM/DD`
+    # help: `leaderboard from YYYY/MM/DD to YYYY/MM/DD`
+    # help: `leaderboard PERIOD`
+    # help:    It will present some useful information about the use of the SmartBot in the period specified.
+    # help:    If no 'from' and 'to' specified then it will be considered 'last week'
+    # help:    PERIOD: today, yesterday, last week, this week, last month, this month, last year, this year
+    # help:    The results will exclude master admins and routines.
+    # help:    For a more detailed data use the command `bot stats`
+    # help:    Examples:
+    # help:      _leaderboard_
+    # help:      _podium from 2021/05/01_
+    # help:      _leaderboard from 2021/05/01 to 2021/05/31_
+    # help:      _ranking today_
+    # help:    <https://github.com/MarioRuiz/slack-smart-bot#bot-management|more info>
+    # help: 
+    
+    def leaderboard(from, to, period)
+        exclude_masters = true
+        exclude_routines = true
+        require 'csv'
+        if config.stats
+            message = []
+        else
+            message = ["You need to set stats to true to generate the stats when running the bot instance."]
+        end
+        save_stats(__method__)
+        if !File.exist?("#{config.stats_path}.#{Time.now.strftime("%Y-%m")}.log")
+            message<<'No stats'
+        else
+            if period == ''
+                message << "*Leaderboard SmartBot <##@channel_id> from #{from} to #{to}*\n"
+            else
+                message << "*Leaderboard SmartBot <##@channel_id> #{period}* (#{from} -> #{to})\n"
+            end
+            from_short = from
+            to_short = to
+            from_file = from[0..3] + '-' + from[5..6]
+            to_file = to[0..3] + '-' + to[5..6]
+            from+= " 00:00:00 +0000"
+            to+= " 23:59:59 +0000"
+            rows = []
+            users_id_name = {}
+            users_name_id = {}
+            count_users = {}
+            count_channels_dest = {}
+            count_commands_uniq_user = {}
+
+            # to translate global and enterprise users since sometimes was returning different names/ids
+            if from[0..3]=='2020' # this was an issue only on that period
+                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"
+                        CSV.foreach(file, headers: true, header_converters: :symbol, converters: :numeric) do |row|
+                            unless users_id_name.key?(row[:user_id])
+                                users_id_name[row[:user_id]] = row[:user_name]
+                            end
+                            unless users_name_id.key?(row[:user_name])
+                                users_name_id[row[:user_name]] = row[:user_id]
+                            end
+    
+                        end
+                    end
+                end
+            end
+
+            master_admins = config.masters.dup
+            if users_id_name.size > 0
+                config.masters.each do |u|
+                    if users_id_name.key?(u)
+                        master_admins << users_id_name[u]
+                    elsif users_name_id.key?(u)
+                        master_admins << users_name_id[u]
+                    end
+                end
+            end
+
+            Dir["#{config.stats_path}.*.log"].sort.each do |file|
+                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'
+                            row[:dest_channel] = 'DM'
+                        elsif row[:dest_channel].to_s == ''
+                            row[:dest_channel] = row[:dest_channel_id]
+                        end
+                        if users_name_id.size > 0
+                            row[:user_name] = users_id_name[row[:user_id]]
+                            row[:user_id] = users_name_id[row[:user_name]]
+                        else
+                            users_id_name[row[:user_id]] ||= row[:user_name]
+                        end
+                        if !exclude_masters or (exclude_masters and !master_admins.include?(row[:user_name]) and 
+                                                !master_admins.include?(row[:user_id]) and
+                                                !@master_admin_users_id.include?(row[:user_id]))
+                            if !exclude_routines or (exclude_routines and !row[:user_name].match?(/^routine\//) )
+                                if row[:bot_channel_id] == @channel_id
+                                    if row[:date] >= from and row[:date] <= to
+                                        count_users[row[:user_id]] ||= 0
+                                        count_users[row[:user_id]] += 1
+                                        rows << row.to_h
+                                        count_channels_dest[row[:dest_channel]] ||= 0
+                                        count_channels_dest[row[:dest_channel]] += 1
+                                        count_commands_uniq_user[row[:user_id]] ||= []
+                                        count_commands_uniq_user[row[:user_id]] << row[:command] unless count_commands_uniq_user[row[:user_id]].include?(row[:command])
+                                    end
+                                end
+                            end
+                        end
+                    end
+                end
+            end
+
+            total = rows.size
+
+            if total > 0
+
+                users = rows.user_id.uniq.sort
+                count_user = {}
+                users.each do |user|
+                    count = rows.count {|h| h.user_id==user}
+                    count_user[user] = count
+                end
+                mtc = nil
+                mtu = []
+                i = 0
+                count_user.sort_by {|k,v| -v}.each do |user, count|
+                    if i >= 3
+                        break
+                    elsif mtc.nil? or mtc == count or i < 3
+                        mtu << "*<@#{users_id_name[user]}>* (#{count})"
+                        mtc = count
+                    else 
+                        break
+                    end
+                    i+=1
+                end
+                message << "\t :boom: Users that called more commands: \n\t\t\t\t#{mtu.join("\n\t\t\t\t")}"
+
+                mtc = nil
+                mtu = []
+                i = 0
+                count_commands_uniq_user.sort_by {|k,v| -v.size}.each do |user, cmds|
+                    if i >= 3
+                        break
+                    elsif mtc.nil? or mtc == cmds.size or i < 3
+                        mtu << "*<@#{users_id_name[user]}>* (#{cmds.size})"
+                        mtc = cmds.size
+                    else 
+                        break
+                    end
+                    i+=1
+                end
+                message << "\t :stethoscope: Users that called more different commands: \n\t\t\t\t#{mtu.join("\n\t\t\t\t")}"
+                
+                commands_attachment = []
+
+                commands = rows.command.uniq.sort
+                count_command = {}
+                commands.each do |command|
+                    count = rows.count {|h| h.command==command}
+                    count_command[command] = count
+                end
+                
+                mtu = []
+                count_command.sort_by {|k,v| -v}[0..2].each do |command, count|
+                    mtu << "*`#{command.gsub('_',' ')}`* (#{count})"
+                end
+                message << "\t :four_leaf_clover: Most used commands: \n\t\t\t\t#{mtu.join("\n\t\t\t\t")}"
+
+                count_channels_dest = count_channels_dest.sort_by(&:last).reverse.to_h
+                count_channels_dest.keys[0..0].each do |ch|
+                    if ch=='DM'
+                        message << "\t :star: Most used channel: *DM* (#{(count_channels_dest[ch].to_f*100/total).round(2)}%)"
+                    else
+                        message << "\t :star: Most used channel: *<##{@channels_id[ch]}>* (#{(count_channels_dest[ch].to_f*100/total).round(2)}%)"
+                    end
+                end
+                
+                types = rows.type_message.uniq.sort
+                count_type = {}
+                types.each do |type|
+                    count = rows.count {|h| h.type_message==type}
+                    count_type[type] = count
+                end
+                
+                count_type.sort_by {|k,v| -v}[0..0].each do |type, count|
+                    message << "\t :house_with_garden: Most calls came from *#{type}* (#{(count.to_f*100/total).round(2)}%)"
+                end
+            else
+                message << 'No data yet'
+            end
+        end
+        respond "#{message.join("\n")}"
+
+    end
+end

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

@@ -0,0 +1,113 @@
+class SlackSmartBot
+
+  def see_announcements(user, type, channel, mention=false, publish=false)
+    save_stats(__method__)
+    typem = Thread.current[:typem]
+    general_message = "\nRelated commands `add announcement MESSAGE`, `delete announcement ID`"
+    if channel == ''
+      if typem == :on_call
+        channel = Thread.current[:dchannel]
+      else
+        channel = Thread.current[:dest]
+      end
+    end
+    if publish
+      dest = channel
+    else
+      dest = Thread.current[:dest]
+    end
+    
+    if type == 'all'
+      if config.masters.include?(user.name) and typem==:on_dm
+        channels = Dir.entries("#{config.path}/announcements/")
+        channels.select! {|i| i[/\.csv$/]}
+      else
+        channels = []
+        respond "Only master admins on a DM with the SmarBot can call this command.", dest
+      end
+    elsif typem == :on_dm and channel == Thread.current[:dest]
+      channels = [channel, @channel_id]
+    else
+      channels = [channel]
+    end
+    channels.each do |channel|
+      channel.gsub!('.csv','')
+      if channel[0]== 'D'
+        channel_id = channel
+      else
+        get_channels_name_and_id() unless @channels_name.keys.include?(channel) or @channels_id.keys.include?(channel)
+        channel_id = nil
+        if @channels_name.key?(channel) #it is an id
+          channel_id = channel
+          channel = @channels_name[channel_id]
+        elsif @channels_id.key?(channel) #it is a channel name
+          channel_id = @channels_id[channel]
+        end
+      end
+      if has_access?(__method__, user)
+        if (channel_id!=Thread.current[:dest] and config.masters.include?(user.name) and typem==:on_dm) or publish
+          see_announcements_on_demand = true
+        else
+          see_announcements_on_demand = false
+        end
+        if channel_id == Thread.current[:dest] or see_announcements_on_demand or publish #master admin user or publish_announcements
+          if File.exists?("#{config.path}/announcements/#{channel_id}.csv") and (!@announcements.key?(channel_id) or see_announcements_on_demand) # to force to have the last version that maybe was updated by other SmartBot in case of demand
+            t = CSV.table("#{config.path}/announcements/#{channel_id}.csv", headers: ['message_id', 'user_deleted', 'user_created', 'date', 'time', 'type', 'message'])
+            @announcements[channel_id] = t
+          end
+          if @announcements.key?(channel_id)
+            message = []
+            @announcements[channel_id].each do |m|
+              if m[:user_deleted] == '' and (type == 'all' or type == '' or type==m[:type])
+                if m[:type].match?(/:\w+:/)
+                  emoji = m[:type]
+                elsif m[:type] == 'white'
+                  emoji = ':white_square:'
+                else
+                  emoji = ":large_#{m[:type]}_square:"
+                end
+                if mention
+                  user_created = "<@#{m[:user_created]}>"
+                else
+                  user_created = m[:user_created]
+                end
+                if type == 'all' and channel_id[0]=='D'
+                  message << "\t#{m[:message_id]} #{emoji} *_#{m[:date]}_* #{m[:time]} *:* \t*private*"
+                else
+                  message << "\t#{m[:message_id]} #{emoji} *_#{m[:date]}_* #{m[:time]} #{"#{user_created} " unless channel_id[0]=='D'}*:* \t#{m[:message]}"
+                end
+              end
+            end
+            if message.size > 0
+              if channel_id[0]=='D'
+                if type == 'all'
+                  message.unshift("*Private messages stored on DM with the SmartBot and <@#{@announcements[channel_id][:user_created][0]}>*")
+                else
+                  message.unshift("*Private messages stored on your DM with the SmartBot*")
+                end
+              else
+                message.unshift("*Announcements for channel <##{channel_id}>*")
+              end
+              message << general_message
+              respond message.join("\n"), dest
+            else
+              if typem == :on_dm and channel_id[0]=='D'
+                respond("There are no #{type} announcements#{general_message}", dest) unless type == 'all'
+              else
+                respond("There are no #{type} announcements for <##{channel_id}>#{general_message}", dest) unless publish or type == 'all' or (typem==:on_dm and channel_id[0]!='D' and !see_announcements_on_demand)
+              end
+            end
+          else
+            if typem == :on_dm and channel_id[0]=='D'
+              respond("There are no announcements#{general_message}", dest) unless type == 'all'
+            else
+              respond("There are no announcements for <##{channel_id}>#{general_message}", dest) unless publish or type == 'all' or (typem==:on_dm and channel_id[0]!='D' and !see_announcements_on_demand)
+            end
+          end
+        else
+          respond "Go to <##{channel_id}> and call the command from there.", dest
+        end
+      end
+    end
+  end
+end