slack-smart-bot 1.9.1 → 1.11.0

data/lib/slack/smart-bot/commands/on_master/admin_master/publish_announcements.rb

@@ -0,0 +1,33 @@
+class SlackSmartBot
+  # helpmaster: ----------------------------------------------
+  # helpmaster: `publish announcements`
+  # helpmaster:    It will publish on all channels the announcements added by using 'add announcement' command.
+  # helpmaster:    Only works if you are on Master channel and you are a master admin user
+  # helpmaster:    The messages stored on a DM won't be published.
+  # helpmaster:    This is very convenient to be called from a *Routine* for example every weekday at 09:00.
+  # helpmaster:    <https://github.com/MarioRuiz/slack-smart-bot#announcements|more info>
+  # helpmaster: command_id: :publish_announcements
+  # helpmaster:
+  def publish_announcements(user)
+    save_stats(__method__)
+    if config.on_master_bot
+      if config.masters.include?(user.name) #admin user
+        channels = Dir.entries("#{config.path}/announcements/")
+        channels.select! {|i| i[/\.csv$/]}
+        channels.each do |channel|
+          channel.gsub!('.csv','')
+          unless channel[0]== 'D'
+            see_announcements(user, '', channel, false, true)
+            sleep 0.5 # to avoid reach ratelimit
+          end
+        end
+        react :heavy_check_mark
+
+      else
+        respond 'Only master admins on master channel can use this command.'
+      end
+    else
+      respond 'Only master admins on master channel can use this command.'
+    end
+  end
+end

data/lib/slack/smart-bot/commands/on_master/admin_master/set_general_message.rb

@@ -0,0 +1,39 @@
+class SlackSmartBot
+  # helpmaster: ----------------------------------------------
+  # helpmaster: `set general message MESSAGE`
+  # helpmaster: `set general message off`
+  # helpmaster:    The SmartBot will display the specified message after treating every command
+  # helpmaster:    Only works if you are on Master channel and you are a master admin user
+  # helpmaster:    You can add interpolation to the message you are adding
+  # helpmaster:    Examples:
+  # helpmaster:      _set general message We will be on maintenance at 12:00_
+  # helpmaster:      _set general message We will be on maintenance in #{((Time.new(2021,6,18,13,30,0)-Time.now)/60).to_i} minutes_
+  # helpmaster:      _set general message `We will be on *maintenance* at *12:00*`_
+  # helpmaster:      _set general message `:information_source: Pay attention: We will be on *maintenance* in *#{((Time.new(2021,6,18,13,30,0)-Time.now)/60).to_i} minutes*`_
+  # helpmaster:    <https://github.com/MarioRuiz/slack-smart-bot#bot-management|more info>
+  # helpmaster: command_id: :set_general_message
+  # helpmaster:
+  def set_general_message(from, status, message)
+    save_stats(__method__)
+    if config.on_master_bot
+      if config.masters.include?(from) #admin user
+        if status == 'on'
+          config.general_message = message
+          respond "General message has been set."
+        else
+          config.general_message = ''
+          respond "General message won't be displayed anymore."
+        end
+        
+        file = File.open("#{config.path}/config_tmp.status", "w")
+        file.write config.inspect
+        file.close
+    
+      else
+        respond 'Only master admins on master channel can use this command.'
+      end
+    else
+      respond 'Only master admins on master channel can use this command.'
+    end
+  end
+end

data/lib/slack/smart-bot/commands/on_master/admin_master/set_maintenance.rb

@@ -8,11 +8,18 @@ class SlackSmartBot
   # helpmaster: `turn maintenance off`
   # helpmaster:    The SmartBot will be on maintenance and responding with a generic message
   # helpmaster:    Only works if you are on Master channel and you are a master admin user
+  # helpmaster:    You can add interpolation to the message you are adding
+  # helpmaster:    Examples:
+  # helpmaster:      _set maintenance on_
+  # helpmaster:      _set maintenance on We are on maintenance. We'll be available again in #{((Time.new(2021,6,18,13,30,0)-Time.now)/60).to_i} minutes_
+  # helpmaster:      _turn maintenance on `We are on *maintenance* until *12:00*`_
+  # helpmaster:    <https://github.com/MarioRuiz/slack-smart-bot#bot-management|more info>
+  # helpmaster: command_id: :set_maintenance
   # helpmaster:
   def set_maintenance(from, status, message)
     save_stats(__method__)
     if config.on_master_bot
-      if config.admins.include?(from) #admin user
+      if config.masters.include?(from) #admin user
         if message == ''
           config.on_maintenance_message = "Sorry I'm on maintenance so I cannot attend your request."
         else
@@ -22,9 +29,11 @@ class SlackSmartBot
         if status == 'on'
           config.on_maintenance = true
           respond "From now on I'll be on maintenance status so I won't be responding accordingly."
+          save_status :off, :maintenance_on, config.on_maintenance_message
         else
           config.on_maintenance = false
           respond "From now on I won't be on maintenance. Everything is back to normal!"
+          save_status :on, :maintenance_off, config.on_maintenance_message
         end
         
         file = File.open("#{config.path}/config_tmp.status", "w")

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

@@ -2,18 +2,21 @@ class SlackSmartBot
   # helpmaster: ----------------------------------------------
   # helpmaster: `create bot on CHANNEL_NAME`
   # helpmaster: `create cloud bot on CHANNEL_NAME`
-  # helpmaster:    creates a new bot on the channel specified
-  # helpmaster:    it will work only if you are on Master channel
-  # helpmaster:    the admins will be the master admins, the creator of the bot and the creator of the channel
-  # helpmaster:    follow the instructions in case creating cloud bots
+  # helpmaster: `create silent bot on CHANNEL_NAME`
+  # helpmaster:    Creates a new bot on the channel specified
+  # helpmaster:    It will work only if you are on Master channel
+  # helpmaster:    The admins will be the master admins, the creator of the bot and the creator of the channel
+  # helpmaster:    Follow the instructions in case creating cloud bots
+  # helpmaster:    In case 'silent' won't display the Bot initialization message on the CHANNEL_NAME
+  # helpmaster:    <https://github.com/MarioRuiz/slack-smart-bot#bot-management|more info>
+  # helpmaster: command_id: :create_bot
   # helpmaster:
-  def create_bot(dest, user, cloud, channel)
+  def create_bot(dest, user, type, channel)
+    cloud = type.include?('cloud')
+    silent = type.include?('silent')
     save_stats(__method__)
     from = user.name
-    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)
       if config.on_master_bot
         get_channels_name_and_id() unless @channels_name.keys.include?(channel) or @channels_id.keys.include?(channel)
         channel_id = nil
@@ -25,6 +28,7 @@ class SlackSmartBot
         end
         #todo: add pagination for case more than 1000 channels on the workspace
         channels = get_channels()
+        channel = @channels_name[channel] if @channels_name.key?(channel)
         channel_found = channels.detect { |c| c.name == channel }
         members = get_channel_members(@channels_id[channel]) unless channel_found.nil?
 
@@ -40,32 +44,40 @@ class SlackSmartBot
           if channel_id != config[:channel]
             begin
               rules_file = "slack-smart-bot_rules_#{channel_id}_#{from.gsub(" ", "_")}.rb"
-              if defined?(RULES_FOLDER)
+              if defined?(RULES_FOLDER) # consider removing RULES_FOLDER since we are not using it anywhere else
                 rules_file = RULES_FOLDER + rules_file
                 general_rules_file = RULES_FOLDER + 'general_rules.rb'
+                general_commands_file = RULES_FOLDER + 'general_commands.rb'
               else
                 Dir.mkdir("#{config.path}/rules") unless Dir.exist?("#{config.path}/rules")
                 Dir.mkdir("#{config.path}/rules/#{channel_id}") unless Dir.exist?("#{config.path}/rules/#{channel_id}")
                 rules_file = "/rules/#{channel_id}/" + rules_file
                 general_rules_file = "/rules/general_rules.rb"
+                general_commands_file = "/rules/general_commands.rb"
               end
               default_rules = (__FILE__).gsub(/slack\/smart-bot\/commands\/on_master\/create_bot\.rb$/, "slack-smart-bot_rules.rb")
               default_general_rules = (__FILE__).gsub(/slack\/smart-bot\/commands\/on_master\/create_bot\.rb$/, "slack-smart-bot_general_rules.rb")
+              default_general_commands = (__FILE__).gsub(/slack\/smart-bot\/commands\/on_master\/create_bot\.rb$/, "slack-smart-bot_general_commands.rb")
               
               File.delete(config.path + rules_file) if File.exist?(config.path + rules_file)
               FileUtils.copy_file(default_rules, config.path + rules_file) unless File.exist?(config.path + rules_file)
               FileUtils.copy_file(default_general_rules, config.path + general_rules_file) unless File.exist?(config.path + general_rules_file)
+              FileUtils.copy_file(default_general_commands, config.path + general_commands_file) unless File.exist?(config.path + general_commands_file)
               admin_users = Array.new()
-              creator_info = get_user_info(channel_found.creator)
-              admin_users = [from, creator_info.user.name] + config.masters
+              creator_info = @users.select{|u| u.id == channel_found.creator or (u.key?(:enterprise_user) and u.enterprise_user.id == channel_found.creator)}[-1]
+              if creator_info.nil? or creator_info.empty? or creator_info.user.nil?
+                admin_users = [from] + config.masters
+              else
+                admin_users = [from, creator_info.user.name] + config.masters
+              end
               admin_users.uniq!
-              @logger.info "ruby #{config.file_path} \"#{channel}\" \"#{admin_users.join(",")}\" \"#{rules_file}\" on"
+              @logger.info "BOT_SILENT=#{silent} ruby #{config.file_path} \"#{channel}\" \"#{admin_users.join(",")}\" \"#{rules_file}\" on"
           
               if cloud
                 respond "Copy the bot folder to your cloud location and run `ruby #{config.file} \"#{channel}\" \"#{admin_users.join(",")}\" \"#{rules_file}\" on&`", dest
               else
                 t = Thread.new do
-                  `BOT_SILENT=false ruby #{config.file_path} \"#{channel}\" \"#{admin_users.join(",")}\" \"#{rules_file}\" on`
+                  `BOT_SILENT=#{silent} ruby #{config.file_path} \"#{channel}\" \"#{admin_users.join(",")}\" \"#{rules_file}\" on`
                 end
               end
               @bots_created[channel_id] = {
@@ -80,6 +92,8 @@ class SlackSmartBot
                 cloud: cloud,
                 thread: t,
               }
+              @bots_created[channel_id].silent = true if silent
+
               respond "The bot has been created on channel: #{channel}. Rules file: #{File.basename rules_file}. Admins: #{admin_users.join(", ")}", dest
               update_bots_file()
             rescue Exception => stack

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

@@ -0,0 +1,41 @@
+class SlackSmartBot
+  # helpmaster: ----------------------------------------------
+  # helpmaster: `where is smartbot?`
+  # helpmaster: `which channels smartbot?`
+  # helpmaster: `where is a member smartbot?`
+  # helpmaster:    It will list all channels where the smartbot is a member.
+  # helpmaster: command_id: :where_smartbot
+  # helpmaster:
+  def where_smartbot(user)
+    #todo: add tests
+    save_stats(__method__)
+    if has_access?(__method__, user)
+      channels = get_channels(bot_is_in: true)
+      message = []
+      extended = @bots_created.values.extended.flatten
+      channels.each do |c|
+        type = ''
+        unless c.id[0] == "D"
+            if @bots_created.key?(c.id)
+                type = '_`(SmartBot)`_'
+            elsif c.id == @master_bot_id
+                type = '_`(Master)`_'
+            elsif extended.include?(c.name)
+                @bots_created.each do |bot,values|
+                    if values.extended.include?(c.name)
+                        type += "_`(Extended from ##{values.channel_name})`_ "
+                    end
+                end
+            end
+          if c.is_private?
+            message << "#{c.id}: *##{c.name}* #{type}"
+          else
+            message << "#{c.id}: *<##{c.id}>* #{type}"
+          end
+        end
+      end
+      message.sort!
+      respond "*<@#{config.nick_id}> is a member of:*\n\n#{message.join("\n")}"
+    end
+  end
+end

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

@@ -1,34 +1,65 @@
-require_relative "commands/general/whats_new"
 require_relative "commands/general/hi_bot"
 require_relative "commands/general/bye_bot"
 require_relative "commands/general/bot_help"
+require_relative "commands/on_bot/general/suggest_command"
 require_relative "commands/on_bot/ruby_code"
 require_relative "commands/on_bot/repl"
 require_relative "commands/on_bot/get_repl"
 require_relative "commands/on_bot/run_repl"
 require_relative "commands/on_bot/delete_repl"
 require_relative "commands/on_bot/see_repls"
-require_relative "commands/general/use_rules"
-require_relative "commands/general/stop_using_rules"
+require_relative "commands/on_bot/general/whats_new"
+require_relative "commands/on_bot/general/use_rules"
+require_relative "commands/on_bot/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_master/where_smartbot"
 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/see_result_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/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"
 require_relative "commands/on_bot/admin_master/get_bot_logs"
-require_relative "commands/general/bot_stats"
+require_relative "commands/on_bot/admin_master/send_message"
+require_relative "commands/on_bot/admin_master/delete_message"
+require_relative "commands/on_bot/admin_master/react_to"
+require_relative "commands/on_bot/general/bot_stats"
+require_relative "commands/on_bot/general/leaderboard"
+require_relative "commands/general/add_announcement"
+require_relative "commands/general/delete_announcement"
+require_relative "commands/general/see_announcements"
+require_relative "commands/general/see_statuses"
+require_relative "commands/general/see_favorite_commands"
+require_relative "commands/on_master/admin_master/publish_announcements"
 require_relative "commands/on_master/admin_master/set_maintenance"
+require_relative "commands/on_master/admin_master/set_general_message"
+require_relative "commands/general_bot_commands"
+require_relative "commands/general/share_messages"
+require_relative "commands/general/see_shares"
+require_relative "commands/general/delete_share"
+require_relative "commands/general/see_admins"
+require_relative "commands/general/add_admin"
+require_relative "commands/general/remove_admin"
+require_relative "commands/general/see_command_ids"
+require_relative "commands/general/poster"
+require_relative "commands/general/see_access"
+require_relative "commands/general/allow_access"
+require_relative "commands/general/deny_access"
+require_relative "commands/general/add_team"
+require_relative "commands/general/see_teams"
+require_relative "commands/general/update_team"
+require_relative "commands/general/ping_team"
+require_relative "commands/general/delete_team"

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

@@ -1,44 +1,42 @@
 class SlackSmartBot
   def listen_simulate
-    @salutations = [config[:nick], "<@#{config[:nick_id]}>", "bot", "smart"]
+    @salutations = [config[:nick], "<@#{config[:nick_id]}>", "bot", "smart", "smartbot", "smart-bot", "smart bot"]
     @pings = []
     @last_activity_check = Time.now
     get_bots_created()
-      @buffer_complete = [] unless defined?(@buffer_complete)
-      b = File.read("#{config.path}/buffer_complete.log")
-      result = b.scan(/^\|(\w+)\|(\w+)\|(\w+)\|([^~]+)~~~/m)
-      result.delete(nil)
-      new_messages = result[@buffer_complete.size..-1]
-      unless new_messages.nil? or new_messages.empty?
-        @buffer_complete = result
-        new_messages.each do |message|
-          channel = message[0].strip
-          user = message[1].strip
-          user_name = message[2].strip
-          command = message[3].to_s.strip
-          # take in consideration that on simulation we are treating all messages even those that are not populated on real cases like when the message is not populated to the specific bot connection when message is sent with the bot          
-          @logger.info "treat message: #{message}" if config.testing
-
-
-          if command.match?(/^\s*\-!!/) or command.match?(/^\s*\-\^/)
-            command.scan(/`([^`]+)`/).flatten.each do |cmd|
-              if cmd.to_s!=''
-                cmd = "^#{cmd}"
-                treat_message({channel: channel, user: user, text: cmd, user_name: user_name}, false)
-              end
+    @buffer_complete = [] unless defined?(@buffer_complete)
+    b = File.read("#{config.path}/buffer_complete.log")
+    result = b.scan(/^\|(\w+)\|(\w+)\|(\w+)\|([^~]+)~~~/m)
+    result.delete(nil)
+    new_messages = result[@buffer_complete.size..-1]
+    unless new_messages.nil? or new_messages.empty?
+      @buffer_complete = result
+      new_messages.each do |message|
+        channel = message[0].strip
+        user = message[1].strip
+        user_name = message[2].strip
+        command = message[3].to_s.strip
+        # take in consideration that on simulation we are treating all messages even those that are not populated on real cases like when the message is not populated to the specific bot connection when message is sent with the bot
+        @logger.info "treat message: #{message}" if config.testing
+        if command.match?(/^\s*\-!!/) or command.match?(/^\s*\-\^/)
+          command.scan(/`([^`]+)`/).flatten.each do |cmd|
+            if cmd.to_s != ""
+              cmd = "^#{cmd}"
+              treat_message({ channel: channel, user: user, text: cmd, user_name: user_name }, false)
             end
-          elsif command.match?(/^\s*\-!/)
-            command.scan(/`([^`]+)`/).flatten.each do |cmd|
-              if cmd.to_s!=''
-                cmd = "!#{cmd}"
-                treat_message({channel: channel, user: user, text: cmd, user_name: user_name}, false)
-              end
+          end
+        elsif command.match?(/^\s*\-!/)
+          command.scan(/`([^`]+)`/).flatten.each do |cmd|
+            if cmd.to_s != ""
+              cmd = "!#{cmd}"
+              treat_message({ channel: channel, user: user, text: cmd, user_name: user_name }, false)
             end
-          else
-            treat_message({channel: channel, user: user, text: command, user_name: user_name})
           end
+        else
+          treat_message({ channel: channel, user: user, text: command, user_name: user_name })
         end
       end
+    end
   end
 
   def listen
@@ -50,7 +48,7 @@ class SlackSmartBot
       unless data.user == "USLACKBOT" or data.text.nil?
         if data.text.match?(/^\s*\-!!/) or data.text.match?(/^\s*\-\^/)
           data.text.scan(/`([^`]+)`/).flatten.each do |cmd|
-            if cmd.to_s!=''
+            if cmd.to_s != ""
               datao = data.dup
               datao.text = "^#{cmd}"
               treat_message(datao, false)
@@ -58,7 +56,7 @@ class SlackSmartBot
           end
         elsif data.text.match?(/^\s*\-!/)
           data.text.scan(/`([^`]+)`/).flatten.each do |cmd|
-            if cmd.to_s!=''
+            if cmd.to_s != ""
               datao = data.dup
               datao.text = "!#{cmd}"
               treat_message(datao, false)