slack-smart-bot 1.8.1 → 1.10.0

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

@@ -7,8 +7,10 @@ class SlackSmartBot
   # help: `add sc for all NAME: COMMAND`
   # help: `shortcut NAME: COMMAND`
   # help: `shortcut for all NAME: COMMAND`
+  # help: `add global sc for all NAME: COMMAND`
   # help:    It will add a shortcut that will execute the command we supply.
   # help:    In case we supply 'for all' then the shorcut will be available for everybody
+  # help:    If 'global' or 'generic' supplied and in Master channel then the shortcut will be available in all Bot channels.
   # help:    If you want to use a shortcut as a inline shortcut inside a command you can do it by adding a $ fex: _!run tests $cust1_
   # help:    Example:
   # help:        _add shortcut for all Spanish account: code require 'iso/iban'; 10.times {puts ISO::IBAN.random('ES')}_
@@ -16,52 +18,79 @@ class SlackSmartBot
   # help:        _sc spanish account_
   # help:        _shortcut Spanish Account_
   # help:        _Spanish Account_
+  # help:    <https://github.com/MarioRuiz/slack-smart-bot#shortcuts|more info>
   # help:
-  def add_shortcut(dest, user, typem, for_all, shortcut_name, command, command_to_run)
+  def add_shortcut(dest, user, typem, for_all, shortcut_name, command, command_to_run, 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
-        @shortcuts[from] = Hash.new() unless @shortcuts.keys.include?(from)
-
-        found_other = false
-        if for_all.to_s != ""
-          @shortcuts.each { |sck, scv|
-            if sck != :all and sck != from and scv.key?(shortcut_name)
-              found_other = true
+      if has_access?(__method__, user)
+        if global 
+          if !config.on_master_bot or typem != :on_master
+            respond "It is only possible to add global shortcuts from Master channel"
+          else
+            @shortcuts_global[from] = Hash.new() unless @shortcuts_global.keys.include?(from)
+            found_other = false
+            if for_all.to_s != ""
+              @shortcuts_global.each { |sck, scv|
+                if sck != :all and sck != from and scv.key?(shortcut_name)
+                  found_other = true
+                end
+              }
             end
-          }
-        end
-        if !config.admins.include?(from) and @shortcuts[:all].include?(shortcut_name) and !@shortcuts[from].include?(shortcut_name)
-          respond "Only the creator of the shortcut can modify it", dest
-        elsif found_other
-          respond "You cannot create a shortcut for all with the same name than other user is using", dest
-        elsif !@shortcuts[from].include?(shortcut_name)
-          #new shortcut
-          @shortcuts[from][shortcut_name] = command_to_run
-          @shortcuts[:all][shortcut_name] = command_to_run if for_all.to_s != ""
-          update_shortcuts_file()
-          respond "shortcut added", dest
+            if @shortcuts_global[:all].include?(shortcut_name) or @shortcuts_global[from].include?(shortcut_name)
+              respond "Global shortcut name already in use. Please use another shortcut name."
+            elsif found_other
+              respond "You cannot create a global shortcut for all with the same name than other user is using."
+            elsif !@shortcuts_global[from].include?(shortcut_name)
+              #new shortcut
+              @shortcuts_global[from][shortcut_name] = command_to_run
+              @shortcuts_global[:all][shortcut_name] = command_to_run if for_all.to_s != ""
+              update_shortcuts_file()
+              respond "global shortcut added"
+            else
+              respond "Not possible to add the global shortcut" #todo: check if this is ever gonna be the case
+            end            
+          end
         else
-          #are you sure? to avoid overwriting existing
-          unless @questions.keys.include?(from)
-            ask("The shortcut already exists, are you sure you want to overwrite it?", command, from, dest)
+          @shortcuts[from] = Hash.new() unless @shortcuts.keys.include?(from)
+
+          found_other = false
+          if for_all.to_s != ""
+            @shortcuts.each { |sck, scv|
+              if sck != :all and sck != from and scv.key?(shortcut_name)
+                found_other = true
+              end
+            }
+          end
+          if !config.admins.include?(from) and @shortcuts[:all].include?(shortcut_name) and !@shortcuts[from].include?(shortcut_name)
+            respond "Only the creator of the shortcut can modify it", dest
+          elsif found_other
+            respond "You cannot create a shortcut for all with the same name than other user is using", dest
+          elsif !@shortcuts[from].include?(shortcut_name)
+            #new shortcut
+            @shortcuts[from][shortcut_name] = command_to_run
+            @shortcuts[:all][shortcut_name] = command_to_run if for_all.to_s != ""
+            update_shortcuts_file()
+            respond "shortcut added", dest
           else
-            case @questions[from]
-            when /^(yes|yep)/i
-              @shortcuts[from][shortcut_name] = command_to_run
-              @shortcuts[:all][shortcut_name] = command_to_run if for_all.to_s != ""
-              update_shortcuts_file()
-              respond "shortcut added", dest
-              @questions.delete(from)
-            when /^no/i
-              respond "ok, I won't add it", dest
-              @questions.delete(from)
+            #are you sure? to avoid overwriting existing
+            if answer.empty?
+              ask("The shortcut already exists, are you sure you want to overwrite it?", command, from, dest)
             else
-              ask "I don't understand, yes or no?", command, from, dest
+              case answer
+              when /^(yes|yep)/i
+                @shortcuts[from][shortcut_name] = command_to_run
+                @shortcuts[:all][shortcut_name] = command_to_run if for_all.to_s != ""
+                update_shortcuts_file()
+                respond "shortcut added", dest
+                answer_delete(from)
+              when /^no/i
+                respond "ok, I won't add it", dest
+                answer_delete(from)
+              else
+                ask "I don't understand, yes or no?", command, from, dest
+              end
             end
           end
         end

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

@@ -1,31 +1,42 @@
 class SlackSmartBot
   # helpadmin: ----------------------------------------------
   # helpadmin: `add routine NAME every NUMBER PERIOD COMMAND`
+  # helpadmin: `add routine NAME every NUMBER PERIOD #CHANNEL COMMAND`
   # helpadmin: `add routine NAME every NUMBER PERIOD`
+  # helpadmin: `add bgroutine NAME every NUMBER PERIOD`
   # helpadmin: `add silent routine NAME every NUMBER PERIOD`
+  # helpadmin: `add silent bgroutine NAME every NUMBER PERIOD`
   # helpadmin: `create routine NAME every NUMBER PERIOD`
   # helpadmin: `add routine NAME at TIME COMMAND`
+  # helpadmin: `add routine NAME at TIME #CHANNEL COMMAND`
   # helpadmin: `add routine NAME on DAYWEEK at TIME COMMAND`
+  # helpadmin: `add routine NAME on DAYWEEK at TIME #CHANNEL COMMAND`
   # helpadmin: `add routine NAME at TIME`
   # helpadmin: `add silent routine NAME at TIME`
   # helpadmin: `create routine NAME at TIME`
   # helpadmin:    It will execute the command/rule supplied. Only for Admin and Master Admins.
   # helpadmin:    If no COMMAND supplied, then it will be necessary to attach a file with the code to be run and add this command as message to the file. ONLY for MASTER ADMINS.
+  # helpadmin:    In case *bgroutine* then the results of the run won't be published. To see the results call: `see result routine NAME`
   # helpadmin:    In case *silent* provided then when executed will be only displayed if the routine returns a message
   # helpadmin:    NAME: one word to identify the routine
   # helpadmin:    NUMBER: Integer
   # helpadmin:    PERIOD: days, d, hours, h, minutes, mins, min, m, seconds, secs, sec, s
   # helpadmin:    TIME: time at format HH:MM:SS
-  # helpadmin:    DAYWEEK: Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday. And their plurals.
+  # helpadmin:    DAYWEEK: Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday. And their plurals. Also possible to be used 'weekdays' and 'weekends'
+  # helpadmin:    #CHANNEL: the destination channel where the results will be published. If not supplied then the bot channel by default or a DM if the command is run from a DM.
   # helpadmin:    COMMAND: any valid smart bot command or rule
+  # helpadmin:    It is possible to add a script directly. Only master admins can do it.
   # helpadmin:    Examples:
-  # helpadmin:      _add routine example every 30s ruby puts 'a'_
-  # helpadmin:      _add routine example every 3 days ruby puts 'a'_
-  # helpadmin:      _add routine example at 17:05 ruby puts 'a'_
-  # helpadmin:      _create silent routine every 12 hours !Run customer tests_
-  # helpadmin:      _add routine example on Mondays at 05:00 !run customer tests_
+  # helpadmin:      _add routine example every 30s !ruby puts 'a'_
+  # helpadmin:      _add bgroutine example every 3 days !ruby puts 'a'_
+  # helpadmin:      _add routine example at 17:05 !ruby puts 'a'_
+  # helpadmin:      _create silent routine Example every 12 hours !Run customer tests_
+  # helpadmin:      _add bgroutine example on Mondays at 05:00 !run customer tests_
+  # helpadmin:      _add routine example on Tuesdays at 09:00 #SREChannel !run db cleanup_
+  # helpadmin:      _add routine example on weekdays at 22:00 suggest command_
+  # helpadmin:    <https://github.com/MarioRuiz/slack-smart-bot#routines|more info>
   # helpadmin:
-  def add_routine(dest, from, user, name, type, number_time, period, command_to_run, files, silent)
+  def add_routine(dest, from, user, name, type, number_time, period, command_to_run, files, silent, channel, routine_type)
     save_stats(__method__)
     if files.nil? or files.size == 0 or (files.size > 0 and config.masters.include?(from))
       if config.admins.include?(from)
@@ -56,8 +67,9 @@ class SlackSmartBot
               every = "#{number_time} seconds"
               every_in_seconds = number_time.to_i
             else # time
-              if type != 'at'
+              if type != 'at' and type!='weekday' and type!='weekend'
                 dayweek = type.downcase
+
                 days = ['sunday','monday','tuesday','wednesday','thursday','friday','saturday']
                 incr = days.index(dayweek) - Time.now.wday
                 if incr < 0 
@@ -67,6 +79,14 @@ class SlackSmartBot
                 end
                 days = incr/(24*60*60)
                 every_in_seconds = 7 * 24 * 60 * 60 # one week
+              elsif type=='weekend'
+                dayweek = type.downcase
+                days = 0
+                every_in_seconds = 24 * 60 * 60 # one day
+              elsif type=='weekday'
+                dayweek = type.downcase
+                days = 0
+                every_in_seconds = 24 * 60 * 60 # one day
               else
                 days = 0
                 every_in_seconds = 24 * 60 * 60 # one day
@@ -90,20 +110,35 @@ class SlackSmartBot
               if files[0].filetype == "ruby" and files[0].name.scan(/[^\.]+(\.\w+$)/).join == ''
                 file_path += ".rb"
               end
-              http = NiceHttp.new(host: "https://files.slack.com", headers: { "Authorization" => "Bearer #{config[:token]}" }, log_headers: :partial)
-              http.get(files[0].url_private_download, save_data: file_path)
+              if files[0].key?(:content)
+                File.open(file_path, 'w') do |f| 
+                  f.write files[0].content
+                end
+              else
+                http = NiceHttp.new(host: "https://files.slack.com", headers: { "Authorization" => "Bearer #{config[:token]}" }, log_headers: :partial)
+                http.get(files[0].url_private_download, save_data: file_path)
+              end
               system("chmod +x #{file_path}")
             end
-
+            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
+    
+            channel_id = dest if channel_id.to_s == ''
             @routines[@channel_id] = {} unless @routines.key?(@channel_id)
             @routines[@channel_id][name] = { channel_name: config.channel, creator: from, creator_id: user.id, status: :on,
                                              every: every, every_in_seconds: every_in_seconds, at: at, dayweek: dayweek, file_path: file_path, 
                                              command: command_to_run.to_s.strip, silent: silent,
-                                             next_run: next_run.to_s, dest: dest, last_run: "", last_elapsed: "", 
-                                             running: false }
+                                             next_run: next_run.to_s, dest: channel_id, last_run: "", last_elapsed: "", 
+                                             running: false, routine_type: routine_type}
             update_routines
             respond "Added routine *`#{name}`* to the channel", dest
-            create_routine_thread(name)
+            create_routine_thread(name, @routines[@channel_id][name])
           end
         end
       else

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

@@ -4,6 +4,7 @@ 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:
   def extend_rules(dest, user, from, channel, typem)
     save_stats(__method__)
@@ -14,15 +15,12 @@ class SlackSmartBot
         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 = client.web_client.conversations_list(
-          types: "private_channel,public_channel",
-          limit: "1000",
-          exclude_archived: "true",
-        ).channels
+        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()
-        members = client.web_client.conversations_members(channel: @channels_id[channel]).members unless channel_found.nil?
+        members = get_channel_members(@channels_id[channel]) unless channel_found.nil?
         get_bots_created()
         channels_in_use = []
         @bots_created.each do |k, v|
@@ -39,7 +37,7 @@ class SlackSmartBot
         elsif !members.include?(user.id)
           respond "You need to join that channel first", dest
         elsif !members.include?(config[:nick_id])
-          respond "You need to add first to the channel the smart bot user: #{config[:nick]}", dest
+          respond "You need to add first to the channel the smart bot user: <@#{config[:nick_id]}>", dest
         else
           channels_in_use.each do |channel_in_use|
             respond "The rules from channel <##{@channels_id[channel_in_use]}> are already in use on that channel", dest

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

@@ -5,6 +5,7 @@ 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:
   def pause_bot(dest, from)
     save_stats(__method__)
@@ -12,10 +13,12 @@ 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
+        @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,6 +6,7 @@ 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:
   def pause_routine(dest, from, name)
     save_stats(__method__)

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

@@ -9,13 +9,12 @@ 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:
   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 @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,6 +8,7 @@ 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:
 
   def run_routine(dest, from, name)
@@ -16,6 +17,7 @@ class SlackSmartBot
       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.exists?("#{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 +42,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,32 @@
+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:
+  def see_result_routine(dest, from, name)
+    save_stats(__method__)
+    if config.admins.include?(from) #admin user
+      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,6 +5,7 @@ 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:
   def see_routines(dest, from, user, all)
     save_stats(__method__)
@@ -23,8 +24,8 @@ class SlackSmartBot
           routines = @routines.dup
         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
+        if @rules_imported.key?(user.name) and @rules_imported[user.name].key?(user.name) and dest[0] == "D"
+          file_conf = IO.readlines("#{config.path}/routines/routines_#{@rules_imported[user.name][user.name]}.rb").join
           routines = eval(file_conf)
         else
           routines = @routines.dup
@@ -38,8 +39,14 @@ class SlackSmartBot
           respond "Routines on channel *#{rout_ch.get_values(:channel_name).values.flatten.uniq[0]}*", dest
           rout_ch.each do |k, v|
             msg = []
-            ch != v[:dest] ? directm = " (*DM to #{v[:creator]}*)" : directm = ""
-            msg << "*`#{k}`*#{directm}"
+            if v[:dest][0] == 'D'
+              extram = " (*DM to #{v[:creator]}*)"
+            elsif v[:dest] != ch
+              extram = " (*publish on <##{v[:dest]}>*)"
+            else
+              extram = ''
+            end
+            msg << "*`#{k}`*#{extram}"
             msg << "\tCreator: #{v[:creator]}"
             msg << "\tStatus: #{v[:status]}"
             msg << "\tEvery: #{v[:every]}" unless v[:every] == ""
@@ -51,6 +58,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,16 +5,19 @@ 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:
   def start_bot(dest, from)
     save_stats(__method__)
     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
+        @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