slack-smart-bot 1.9.1 → 1.11.0

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

@@ -4,17 +4,20 @@ class SlackSmartBot
   # helpadmin: `extend rules to CHANNEL_NAME`
   # helpadmin: `use rules on CHANNEL_NAME`
   # helpadmin:    It will allow to use the specific rules from this channel on the CHANNEL_NAME
+  # helpadmin:    <https://github.com/MarioRuiz/slack-smart-bot#extending-rules-to-other-channels|more info>
+  # helpadmin: command_id: :extend_rules
   # helpadmin:
   def extend_rules(dest, user, from, channel, typem)
     save_stats(__method__)
     unless typem == :on_extended
       if config.on_master_bot
         respond "You cannot use the rules from Master Channel on any other channel.", dest
-      elsif !config.admins.include?(from) #not admin
+      elsif !is_admin? #not admin
         respond "Only admins can extend the rules. Admins on this channel: #{config.admins}", dest
       else
         #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 }
         get_channels_name_and_id()

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

@@ -5,18 +5,21 @@ class SlackSmartBot
   # helpadmin: `pause this bot`
   # helpadmin:    the bot will pause so it will listen only to admin commands
   # helpadmin:    You can use this command only if you are an admin user
+  # helpadmin:    <https://github.com/MarioRuiz/slack-smart-bot#bot-management|more info>
+  # helpadmin: command_id: :pause_bot
   # helpadmin:
   def pause_bot(dest, from)
     save_stats(__method__)
-    if config.admins.include?(from) #admin user
+    if is_admin?
       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
-      update_bots_file()
       unless config.on_master_bot
+        @bots_created[@channel_id][:status] = :paused 
+        update_bots_file()
         send_msg_channel config.master_channel, "Changed status on #{config.channel} to :paused"
       end
+      save_status :off, :paused, 'The admin paused this bot'
     else
       respond "Only admin users can put me on pause", dest
     end

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

@@ -6,10 +6,12 @@ class SlackSmartBot
   # helpadmin:    NAME: one word to identify the routine
   # helpadmin:    Examples:
   # helpadmin:      _pause routine example_
+  # helpadmin:    <https://github.com/MarioRuiz/slack-smart-bot#routines|more info>
+  # helpadmin: command_id: :pause_routine
   # helpadmin:
   def pause_routine(dest, from, name)
     save_stats(__method__)
-    if config.admins.include?(from) #admin user
+    if is_admin?
       if !config.on_master_bot and dest[0] == "D"
         respond "It's only possible to pause routines from MASTER channel from a direct message with the bot.", dest
       elsif @routines.key?(@channel_id) and @routines[@channel_id].key?(name)

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

@@ -9,13 +9,13 @@ class SlackSmartBot
   # helpadmin:    NAME: one word to identify the routine
   # helpadmin:    Examples:
   # helpadmin:      _kill routine example_
+  # helpadmin:    <https://github.com/MarioRuiz/slack-smart-bot#routines|more info>
+  # helpadmin: command_id: :remove_routine
   # helpadmin:
   def remove_routine(dest, from, name)
     save_stats(__method__)
-    if config.admins.include?(from) #admin user
-      if !config.on_master_bot and dest[0] == "D"
-        respond "It's only possible to remove routines from MASTER channel from a direct message with the bot.", dest
-      elsif @routines.key?(@channel_id) and @routines[@channel_id].key?(name)
+    if is_admin?
+      if @routines.key?(@channel_id) and @routines[@channel_id].key?(name)
         @routines[@channel_id][name][:thread].exit
         @routines[@channel_id].delete(name)
         update_routines()

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

@@ -8,14 +8,17 @@ class SlackSmartBot
   # helpadmin:    NAME: one word to identify the routine
   # helpadmin:    Examples:
   # helpadmin:      _run routine example_
+  # helpadmin:    <https://github.com/MarioRuiz/slack-smart-bot#routines|more info>
+  # helpadmin: command_id: :run_routine
   # helpadmin:
 
   def run_routine(dest, from, name)
     save_stats(__method__)
-    if config.admins.include?(from) #admin user
+    if is_admin?
       if !config.on_master_bot and dest[0] == "D"
         respond "It's only possible to run routines from MASTER channel from a direct message with the bot.", dest
       elsif @routines.key?(@channel_id) and @routines[@channel_id].key?(name)
+        File.delete "#{config.path}/routines/#{@channel_id}/#{name}_output.txt" if File.exist?("#{config.path}/routines/#{@channel_id}/#{name}_output.txt")
         if @routines[@channel_id][name][:file_path] != ""
           if @routines[@channel_id][name][:file_path].match?(/\.rb$/i)
             ruby = "ruby "
@@ -40,7 +43,10 @@ class SlackSmartBot
           treat_message({ channel: @routines[@channel_id][name][:dest],
                          user: @routines[@channel_id][name][:creator_id],
                          text: @routines[@channel_id][name][:command],
-                         files: nil })
+                         files: nil,
+                         routine_name: name, 
+                         routine_type: @routines[@channel_id][name][:routine_type],
+                         routine: true })
         end
         @routines[@channel_id][name][:last_elapsed] = (Time.now - started)
         @routines[@channel_id][name][:last_run] = started.to_s

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

@@ -0,0 +1,33 @@
+class SlackSmartBot
+
+  # helpadmin: ----------------------------------------------
+  # helpadmin: `see routine result NAME`
+  # helpadmin: `see result routine NAME`
+  # helpadmin: `result routine NAME`
+  # helpadmin:    It will display the last result of the routine run.
+  # helpadmin:    You can use this command only if you are an admin user
+  # helpadmin:    NAME: one word to identify the routine
+  # helpadmin:    Examples:
+  # helpadmin:      _see routine result example_
+  # helpadmin:    <https://github.com/MarioRuiz/slack-smart-bot#routines|more info>
+  # helpadmin: command_id: :see_result_routine
+  # helpadmin:
+  def see_result_routine(dest, from, name)
+    save_stats(__method__)
+    if is_admin?
+      if @routines.key?(@channel_id) and @routines[@channel_id].key?(name)
+        if File.exist?("#{config.path}/routines/#{@channel_id}/#{name}_output.txt")
+          msg = "*Results from routine run #{File.mtime("#{config.path}/routines/#{@channel_id}/#{name}_output.txt")}*\n"
+          msg += File.read("#{config.path}/routines/#{@channel_id}/#{name}_output.txt")
+          respond msg, dest
+        else
+          respond "The routine *`#{name}`* doesn't have any result yet.", dest
+        end
+      else
+        respond "There isn't a routine with that name: *`#{name}`*.\nCall `see routines` to see added routines", dest
+      end
+    else
+      respond "Only admin users can see the routines results", dest
+    end
+  end
+end

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

@@ -5,29 +5,31 @@ class SlackSmartBot
   # helpadmin:    It will show the routines of the channel
   # helpadmin:    In case of `all` and on the master channel, it will show all the routines from all channels
   # helpadmin:    You can use this command only if you are an admin user
+  # helpadmin:    <https://github.com/MarioRuiz/slack-smart-bot#routines|more info>
+  # helpadmin: command_id: :see_routines
   # helpadmin:
   def see_routines(dest, from, user, all)
     save_stats(__method__)
-    if config.admins.include?(from) #admin user
+    if is_admin?
       if all
         routines = {}
         if config.on_master_bot
-          Dir["#{config.path}/routines/routines_*.rb"].each do |rout|
-            file_conf = IO.readlines(rout).join
-            unless file_conf.to_s() == ""
-              routines.merge!(eval(file_conf))
+          Dir["#{config.path}/routines/routines_*.yaml"].each do |rout|
+            routine = YAML.load(File.read(rout))
+            unless routine.is_a?(FalseClass)
+              routines.merge!(routine)
             end
           end
         else
           respond "To see all routines on all channels you need to run the command on the master channel.\nI'll display only the routines on this channel.", dest
-          routines = @routines.dup
+          routines = @routines
         end
       else
-        if @rules_imported.key?(user.id) and @rules_imported[user.id].key?(user.id) and dest[0] == "D"
-          file_conf = IO.readlines("#{config.path}/routines/routines_#{@rules_imported[user.id][user.id]}.rb").join
-          routines = eval(file_conf)
+        if @rules_imported.key?(user.name) and @rules_imported[user.name].key?(user.name) and dest[0] == "D"
+          routines = YAML.load(File.read("#{config.path}/routines/routines_#{@rules_imported[user.name][user.name]}.yaml"))
+          routines = {} if routines.is_a?(FalseClass)
         else
-          routines = @routines.dup
+          routines = @routines
         end
       end
 
@@ -57,6 +59,7 @@ class SlackSmartBot
             msg << "\tCommand: #{v[:command]}" unless v[:command].to_s.strip == ''
             msg << "\tFile: #{v[:file_path]}" unless v[:file_path] == ''
             msg << "\tSilent: #{v[:silent]}" unless !v[:silent]
+            msg << "\tType: #{v[:routine_type]}" if v[:routine_type].to_s == 'bgroutine'
             respond msg.join("\n"), dest
           end
         end

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

@@ -5,17 +5,20 @@ class SlackSmartBot
   # helpadmin: `start this bot`
   # helpadmin:    the bot will start to listen
   # helpadmin:    You can use this command only if you are an admin user
+  # helpadmin:    <https://github.com/MarioRuiz/slack-smart-bot#bot-management|more info>
+  # helpadmin: command_id: :start_bot
   # helpadmin:
   def start_bot(dest, from)
     save_stats(__method__)
-    if config.admins.include?(from) #admin user
+    if is_admin?
       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
-      update_bots_file()
       unless config.on_master_bot
+        @bots_created[@channel_id][:status] = :on
+        update_bots_file()
         send_msg_channel config.master_channel, "Changed status on #{config.channel} to :on"
       end
+      save_status :on, :started, 'The admin started this bot'
     else
       respond "Only admin users can change my status", dest
     end

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

@@ -7,11 +7,13 @@ class SlackSmartBot
   # helpadmin:    NAME: one word to identify the routine
   # helpadmin:    Examples:
   # helpadmin:      _start routine example_
+  # helpadmin:    <https://github.com/MarioRuiz/slack-smart-bot#routines|more info>
+  # helpadmin: command_id: :start_routine
   # helpadmin:
 
   def start_routine(dest, from, name)
     save_stats(__method__)
-    if config.admins.include?(from) #admin user
+    if is_admin?
       if !config.on_master_bot and dest[0] == "D"
         respond "It's only possible to start routines from MASTER channel from a direct message with the bot.", dest
       elsif @routines.key?(@channel_id) and @routines[@channel_id].key?(name)

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

@@ -3,15 +3,18 @@ class SlackSmartBot
   # helpadmin: ----------------------------------------------
   # helpadmin: `stop using rules on CHANNEL_NAME`
   # helpadmin:    it will stop using the extended rules on the specified channel.
+  # helpadmin:    <https://github.com/MarioRuiz/slack-smart-bot#extending-rules-to-other-channels|more info>
+  # helpadmin: command_id: :stop_using_rules_on
   # helpadmin:
 
   def stop_using_rules_on(dest, user, from, channel, typem)
     save_stats(__method__)
     unless typem == :on_extended
-      if !config.admins.include?(from) #not admin
+      if !is_admin?
         respond "Only admins can extend or stop using the rules. Admins on this channel: #{config.admins}", dest
       else
         get_bots_created()
+        channel = @channels_name[channel] if @channels_name.key?(channel)
         if @bots_created[@channel_id][:extended].include?(channel)
           @bots_created[@channel_id][:extended].delete(channel)
           update_bots_file()

data/lib/slack/smart-bot/commands/on_bot/admin_master/delete_message.rb

@@ -0,0 +1,25 @@
+class SlackSmartBot
+
+    # helpadmin: ----------------------------------------------
+    # helpadmin: `delete message URL`
+    # helpadmin:    It will delete the SmartBot message supplied
+    # helpadmin:    You can use this command only if you are a Master admin user and if you are in a private conversation with the bot
+    # helpadmin: command_id: :delete_message
+    # helpadmin:
+    def delete_message(from, typem, url)
+      save_stats(__method__)
+      channel, ts = url.scan(/\/archives\/(\w+)\/(\w\d+)/)[0]
+      if config.masters.include?(from) and typem==:on_dm and !channel.nil? #master admin user
+        ts = "#{ts[0..-7]}.#{ts[-6..-1]}"
+        succ = delete(channel, ts)
+        if succ
+          react :heavy_check_mark
+        else
+          react :x
+        end
+      else
+        respond "Only master admin users on a private conversation with the SmartBot can delete SmartBot messages"
+      end
+    end
+end
+  

data/lib/slack/smart-bot/commands/on_bot/admin_master/get_bot_logs.rb

@@ -4,6 +4,7 @@ class SlackSmartBot
     # helpadmin: `get bot logs`
     # helpadmin:    To see the bot logs
     # helpadmin:    You can use this command only if you are a Master admin user and if you are in a private conversation with the bot
+    # helpadmin: command_id: :get_bot_logs
     # helpadmin:
     def get_bot_logs(dest, from, typem)
       save_stats(__method__)

data/lib/slack/smart-bot/commands/on_bot/admin_master/react_to.rb

@@ -0,0 +1,34 @@
+class SlackSmartBot
+
+    # helpadmin: ----------------------------------------------
+    # helpadmin: `react to #CHANNEL_NAME THREAD_ID EMOJIS`
+    # helpadmin: `react to URL EMOJIS`
+    # helpadmin:    It will send the specified reactions as SmartBot
+    # helpadmin:    You can use this command only if you are a Master admin user and if you are in a private conversation with the bot
+    # helpadmin:     Examples:
+    # helpadmin:       _react to #sales 1622550707.012100 :thumbsup:_
+    # helpadmin:       _react to #sales p1622550707012100 :thumbsup:_
+    # helpadmin:       _react to #sales p1622550707012100 :thumbsup: :heavy_check_mark: :bathtub:_
+    # helpadmin: command_id: :react_to
+    # helpadmin:
+    def react_to(dest, from, typem, to, thread_ts, emojis)
+      save_stats(__method__)
+      if config.masters.include?(from) and typem==:on_dm #master admin user
+        succs = []
+        emojis.split(' ').each do |emoji|
+          succs << (react emoji, thread_ts, to)
+        end
+        succs.uniq!
+        if succs.size == 1 and succs[0] == true
+          react :heavy_check_mark
+        elsif succs.size == 2
+          react :exclamation
+        else
+          react :x
+        end
+      else
+        respond "Only master admin users on a private conversation with the SmartBot can send reactions as SmartBot.", dest
+      end
+    end
+end
+  

data/lib/slack/smart-bot/commands/on_bot/admin_master/send_message.rb

@@ -0,0 +1,37 @@
+class SlackSmartBot
+
+    # helpadmin: ----------------------------------------------
+    # helpadmin: `send message to @USER_NAME : MESSAGE`
+    # helpadmin: `send message to #CHANNEL_NAME : MESSAGE`
+    # helpadmin: `send message to THREAD_ID : MESSAGE`
+    # helpadmin: `send message to URL : MESSAGE`
+    # helpadmin: `send message to @USER1 @USER99 : MESSAGE`
+    # helpadmin: `send message to #CHANNEL1 #CHANNEL99 : MESSAGE`
+    # helpadmin:    It will send the specified message as SmartBot
+    # helpadmin:    You can use this command only if you are a Master admin user and if you are in a private conversation with the bot
+    # helpadmin: command_id: :send_message
+    # helpadmin:
+    def send_message(dest, from, typem, to, thread_ts, message)
+      save_stats(__method__)
+      if config.masters.include?(from) and typem==:on_dm #master admin user
+        unless Thread.current[:command_orig].to_s == ''
+          message_orig = Thread.current[:command_orig].to_s.gsub("\u00A0", " ").scan(/[^:]+\s*:\s+(.+)/im).join
+          message = message_orig unless message_orig == ''
+        end
+        succ = true
+        to.each do |t|
+          unless t.match?(/^\s*$/)
+            succ = (respond message, t, thread_ts: thread_ts, web_client: true) && succ
+          end
+        end
+        if succ
+          react :heavy_check_mark
+        else
+          react :x
+        end
+      else
+        respond "Only master admin users on a private conversation with the SmartBot can send messages as SmartBot.", dest
+      end
+    end
+end
+  

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

@@ -5,17 +5,16 @@ class SlackSmartBot
   # help: `remove repl SESSION_NAME`
   # help:     Will delete the specified REPL
   # help:     Only the creator of the REPL or an admin can delete REPLs
+  # help:     <https://github.com/MarioRuiz/slack-smart-bot#repl|more info>
+  # help: command_id: :delete_repl
   # help:
   def delete_repl(dest, user, session_name)
     #todo: add tests
     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
+    if has_access?(__method__, user)
       if @repls.key?(session_name)
         Dir.mkdir("#{config.path}/repl") unless Dir.exist?("#{config.path}/repl")
-        if config.admins.include?(user.name) or @repls[session_name].creator_name == user.name
+        if is_admin?(user.name) or @repls[session_name].creator_name == user.name
           @repls.delete(session_name)
           update_repls()
           File.rename("#{config.path}/repl/#{@channel_id}/#{session_name}.input", "#{config.path}/repl/#{@channel_id}/#{session_name}_#{Time.now.strftime("%Y%m%d%H%M%S%N")}.deleted")

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

@@ -5,27 +5,26 @@ class SlackSmartBot
   # help: `delete global sc NAME`
   # help:    It will delete the shortcut with the supplied name
   # help:    'global' or 'generic' can only be used on Master channel.
+  # help:    <https://github.com/MarioRuiz/slack-smart-bot#shortcuts|more info>
+  # help: command_id: :delete_shortcut
   # help:
 
   def delete_shortcut(dest, user, shortcut, typem, command, global)
     save_stats(__method__)
     unless typem == :on_extended
       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)
         deleted = false
 
         if global
           if !config.on_master_bot or typem != :on_master
             respond "It is only possible to delete global shortcuts from Master channel"
           else
-            if !config.admins.include?(from) and @shortcuts_global[:all].include?(shortcut) and 
+            if !is_admin?(from) and @shortcuts_global[:all].include?(shortcut) and 
               (!@shortcuts_global.key?(from) or !@shortcuts_global[from].include?(shortcut))
               respond "Only the creator of the shortcut or an admin user can delete it"
             elsif (@shortcuts_global.key?(from) and @shortcuts_global[from].keys.include?(shortcut)) or
-              (config.admins.include?(from) and @shortcuts_global[:all].include?(shortcut))
+              (is_admin?(from) and @shortcuts_global[:all].include?(shortcut))
               
               respond "global shortcut deleted!", dest
               if @shortcuts_global.key?(from) and @shortcuts_global[from].key?(shortcut)
@@ -41,11 +40,11 @@ class SlackSmartBot
             end
           end
         else
-          if !config.admins.include?(from) and @shortcuts[:all].include?(shortcut) and 
+          if !is_admin?(from) and @shortcuts[:all].include?(shortcut) and 
             (!@shortcuts.key?(from) or !@shortcuts[from].include?(shortcut))
             respond "Only the creator of the shortcut or an admin user can delete it", dest
           elsif (@shortcuts.keys.include?(from) and @shortcuts[from].keys.include?(shortcut)) or
-                (config.admins.include?(from) and @shortcuts[:all].include?(shortcut))
+                (is_admin?(from) and @shortcuts[:all].include?(shortcut))
             #are you sure? to avoid deleting by mistake
             if answer.empty?
               ask("are you sure you want to delete it?", command, from, dest)