slack-smart-bot 1.1.2 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e95f2ae2ff93b7b14be4183854b013429cb80d330637540d378d803f81f4de1a
-  data.tar.gz: d2fec7504227143986243386a573677de783aefac8ea23d5212d3a407ff5aade
+  metadata.gz: b75a6cea93322f420ba6e0bf6938609a600d889c4788f0e51e4929a075578d15
+  data.tar.gz: 8d3c0476510dd29d2dfac41eabfceb77f9d604100704815c775c3888002ef35c
 SHA512:
-  metadata.gz: 52cee63935fe5d5ea229d4c09a78353e8b2da14c6f21a797e16f8aa580bb484f328d998c28a605bc44618236aa10fa668e372b55dc03ab27a9fdf57e28b3fda4
-  data.tar.gz: 469207f67515b2dab8a451a281bdc316b6482e59469359c60da2b675c5a6e3a10336e29f8421f35c3670927f11c1e0a839aeee0cda3c5c09c3e82264d5300217
+  metadata.gz: 946fbf6bca9a5a704b0b7d1d46e12faeb25e6f7f44e99d867d5a28b07cc2441bac0d93e17d3cdae3f081b4acc8b59092b89b2903fcc9eec6282b84b383d6fb8f
+  data.tar.gz: c976933c3b0bbb67e9ba86778b2068ff75dd42a7470a1ba48bb08f49ae70415907f560a5454cb3835526732d6a8d3e47b80e68c404d017577428d6f6a791d4ff

data/README.md

@@ -204,6 +204,23 @@ Example:
 >**_Smart-Bot>_** `echo SOMETHING`  
     `repeats SOMETHING`
 
+When you call a command that is not recognized, you will get suggestions from the Smart Bot.
+
+Remember when you add code to your rules you need to specify the help that will be displayed when using `bot help`, `bot rules`
+
+For the examples use _ and for the rules `. This is a good example of a Help supplied on rules source code:
+
+```ruby
+# help: `run TYPE tests on LOCATION`
+# help: `execute TYPE tests on LOCATION`
+# help:     run the specified tests on the indicated location
+# help:       TYPE: api, ui, smoke, load
+# help:       LOCATION: customers, db1..db10, global
+# help:  Examples:
+# help:     _run api tests on customers_
+# help:     _run ui tests on customers_
+# help:     _execute smoke tests on db1_
+```
 
 ### Bot Management
 To create a new bot on a channel, run on MASTER CHANNEL: **_`create bot on CHANNEL`_**. The admins of this new bot on that channel will be the MASTER ADMINS, the creator of the bot and the creator of that channel. It will create a new rules file linked to this new bot.
@@ -272,9 +289,12 @@ To see available shortcuts: **_`see shortcuts`_** and to delete a particular sho
 ### Routines
 To add specific commands to be run automatically every certain amount of time or a specific time: **_`add routine NAME every NUMBER PERIOD COMMAND`_** or **_`add routine NAME at TIME COMMAND`_**
 
+If you want to hide the routine executions use `add silent routine`. It won't show the routine name when executing.
+
 Examples:  
->**_`add routine run_tests every 3h run tests on customers`_**  
->**_`add routine clean_db at 17:05 clean customers temp db`_**  
+>**_`add routine run_tests every 3h !run tests on customers`_**  
+>**_`add routine clean_db at 17:05 !clean customers temp db`_**  
+>**_`add silent routine clean_db at 17:05 !clean customers temp db`_**  
 
 Also instead of adding a Command to be executed, you can attach a file, then the routine will be created and the attached file will be executed on the criteria specified. Only Master Admins are allowed to use it this way.
 

data/lib/slack-smart-bot.rb

@@ -8,6 +8,7 @@ require "fileutils"
 require "open3"
 require "nice_http"
 require "nice_hash"
+require 'cgi'
 
 require_relative "slack/smart-bot/comm"
 require_relative "slack/smart-bot/listen"
@@ -94,7 +95,6 @@ class SlackSmartBot
 
     logfile = File.basename(config.rules_file.gsub("_rules_", "_logs_"), ".rb") + ".log"
     @logger = Logger.new("#{config.path}/logs/#{logfile}")
-    @logger.info ARGV.inspect #Jal
 
     config_log = config.dup
     config_log.delete(:token)

data/lib/slack-smart-bot_rules.rb

@@ -41,7 +41,8 @@ def rules(user, command, processed, dest, files = [], rules_file = "")
     # help: ----------------------------------------------
     # help: `echo SOMETHING`
     # help:     repeats SOMETHING
-    # help:
+    # help:  Examples:
+    # help:     _echo I am the Smart Bot_
     when /^echo\s(.+)/i
       respond $1
 

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

@@ -113,14 +113,14 @@ class SlackSmartBot
       end
       if config[:simulate]
         open("#{config.path}/buffer_complete.log", "a") { |f|
-          f.puts "|#{to}|#{config[:nick_id]}|#{msg}$$$"
+          f.puts "|#{channel_id}|#{config[:nick_id]}|#{msg}$$$"
         }
       else  
         client.message(channel: channel_id, text: msg, as_user: true)
       end
       if config[:testing] and config.on_master_bot
         open("#{config.path}/buffer.log", "a") { |f|
-          f.puts "|#{to}|#{config[:nick_id]}|#{msg}"
+          f.puts "|#{channel_id}|#{config[:nick_id]}|#{msg}"
         }
       end
     end

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

@@ -2,12 +2,15 @@ class SlackSmartBot
   # helpadmin: ----------------------------------------------
   # helpadmin: `add routine NAME every NUMBER PERIOD COMMAND`
   # helpadmin: `add routine NAME every NUMBER PERIOD`
+  # helpadmin: `add silent routine NAME every NUMBER PERIOD`
   # helpadmin: `create routine NAME every NUMBER PERIOD`
   # helpadmin: `add routine NAME at TIME 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 supplied. Only for Admin and Master Admins.
+  # 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 *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
@@ -17,8 +20,9 @@ class SlackSmartBot
   # 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:
-  def add_routine(dest, from, user, name, type, number_time, period, command_to_run, files)
+  def add_routine(dest, from, user, name, type, number_time, period, command_to_run, files, silent)
     if files.nil? or files.size == 0 or (files.size > 0 and config.masters.include?(from))
       if config.admins.include?(from)
         if @routines.key?(@channel_id) && @routines[@channel_id].key?(name)
@@ -70,8 +74,10 @@ class SlackSmartBot
 
             @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, file_path: file_path, command: command_to_run.to_s.strip,
-                                             next_run: next_run.to_s, dest: dest, last_run: "", last_elapsed: "", running: false }
+                                             every: every, every_in_seconds: every_in_seconds, at: at, 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 }
             update_routines
             respond "Added routine *`#{name}`* to the channel", dest
             create_routine_thread(name)

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

@@ -11,15 +11,12 @@ class SlackSmartBot
   # helpadmin:      _kill routine example_
   # helpadmin:
   def remove_routine(dest, from, name)
-    @logger.info "Start:#{Time.now}"
     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)
         @routines[@channel_id].delete(name)
-        @logger.info "Cont:#{Time.now}"
         update_routines()
-        @logger.info "end:#{Time.now}"
         respond "The routine *`#{name}`* has been removed.", dest
       else
         respond "There isn't a routine with that name: *`#{name}`*.\nCall `see routines` to see added routines", dest
@@ -27,6 +24,5 @@ class SlackSmartBot
     else
       respond "Only admin users can delete routines", dest
     end
-    @logger.info "fin:#{Time.now}"
   end
 end

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

@@ -48,6 +48,7 @@ class SlackSmartBot
             msg << "\tTime consumed on last run: #{v[:last_elapsed]}" unless v[:command] !=''
             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]
             respond msg.join("\n"), dest
           end
         end

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

@@ -86,14 +86,15 @@ class SlackSmartBot
       when /^\s*kill\sbot\son\s<#C\w+\|(.+)>\s*$/i, /^kill\sbot\son\s(.+)\s*$/i
         channel = $1
         kill_bot_on_channel(dest, from, channel)
-      when /^\s*(add|create)\s+routine\s+(\w+)\s+(every)\s+(\d+)\s*(days|hours|minutes|seconds|mins|min|secs|sec|d|h|m|s)\s*(\s.+)?\s*$/i,
-           /^\s*(add|create)\s+routine\s+(\w+)\s+(at)\s+(\d+:\d+:?\d+?)\s*()(\s.+)?\s*$/i
-        name = $2.downcase
-        type = $3
-        number_time = $4
-        period = $5
-        command_to_run = $6
-        add_routine(dest, from, user, name, type, number_time, period, command_to_run, files)
+      when /^\s*(add|create)\s+(silent\s+)?routine\s+(\w+)\s+(every)\s+(\d+)\s*(days|hours|minutes|seconds|mins|min|secs|sec|d|h|m|s)\s*(\s.+)?\s*$/i,
+           /^\s*(add|create)\s+(silent\s+)?routine\s+(\w+)\s+(at)\s+(\d+:\d+:?\d+?)\s*()(\s.+)?\s*$/i
+        silent = $2.to_s!=''
+        name = $3.downcase
+        type = $4
+        number_time = $5
+        period = $6
+        command_to_run = $7
+        add_routine(dest, from, user, name, type, number_time, period, command_to_run, files, silent)
       when /^\s*(kill|delete|remove)\s+routine\s+(\w+)\s*$/i
         name = $2.downcase
         remove_routine(dest, from, name)

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

@@ -1,5 +1,6 @@
 class SlackSmartBot
   def treat_message(data)
+    data.text = CGI.unescapeHTML(data.text)
     if config[:testing] and config.on_master_bot
       open("#{config.path}/buffer.log", "a") { |f|
         f.puts "|#{data.channel}|#{data.user}|#{data.text}"
@@ -109,21 +110,21 @@ class SlackSmartBot
           elsif @status != :on
             respond "The bot in that channel is not :on", dest
           elsif data.user == channel_found.creator or members.include?(data.user)
-            res = process_first(user_info.user, command, dest, channel_rules, typem, data.files)
+            process_first(user_info.user, command, dest, channel_rules, typem, data.files)
           else
             respond "You need to join the channel <##{channel_found.id}> to be able to use the rules.", dest
           end
         elsif config.on_master_bot and typem == :on_extended and
               command.size > 0 and command[0] != "-"
           # to run ruby only from the master bot for the case more than one extended
-          res = process_first(user_info.user, command, dest, @channel_id, typem, data.files)
+          process_first(user_info.user, command, dest, @channel_id, typem, data.files)
         elsif !config.on_master_bot and @bots_created[@channel_id].key?(:extended) and
               @bots_created[@channel_id][:extended].include?(@channels_name[data.channel]) and
               command.size > 0 and command[0] != "-"
-          res = process_first(user_info.user, command, dest, @channel_id, typem, data.files)
+          process_first(user_info.user, command, dest, @channel_id, typem, data.files)
         elsif (dest[0] == "D" or @channel_id == data.channel or data.user == config[:nick_id]) and
               command.size > 0 and command[0] != "-"
-          res = process_first(user_info.user, command, dest, data.channel, typem, data.files)
+          process_first(user_info.user, command, dest, data.channel, typem, data.files)
           # if @botname on #channel_rules: do something
         end
       rescue Exception => stack

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

@@ -83,6 +83,8 @@ class SlackSmartBot
           else
             ruby = ""
           end
+          @routines[@channel_id][name][:silent] = false if !@routines[@channel_id][name].key?(:silent)
+
           if @routines[@channel_id][name][:at] == "" or
              (@routines[@channel_id][name][:at] != "" and @routines[@channel_id][name][:running] and
               @routines[@channel_id][name][:next_run] != "" and Time.now.to_s >= @routines[@channel_id][name][:next_run])
@@ -91,20 +93,26 @@ class SlackSmartBot
               process_to_run = ("cd #{project_folder} &&" + process_to_run) if defined?(project_folder)
 
               stdout, stderr, status = Open3.capture3(process_to_run)
+              if !@routines[@channel_id][name][:silent] or (@routines[@channel_id][name][:silent] and (stderr!='' or stdout!=''))
+                respond "routine *`#{name}`*: #{@routines[@channel_id][name][:file_path]}", @routines[@channel_id][name][:dest]
+              end
               if stderr == ""
                 unless stdout.match?(/\A\s*\z/)
-                  respond "routine *`#{name}`*: #{stdout}", @routines[@channel_id][name][:dest]
+                  respond stdout, @routines[@channel_id][name][:dest]
                 end
               else
-                respond "routine *`#{name}`*: #{stdout} #{stderr}", @routines[@channel_id][name][:dest]
+                respond "#{stdout} #{stderr}", @routines[@channel_id][name][:dest]
               end
             else #command
-              respond "routine *`#{name}`*: #{@routines[@channel_id][name][:command]}", @routines[@channel_id][name][:dest]
+              if !@routines[@channel_id][name][:silent]
+                respond "routine *`#{name}`*: #{@routines[@channel_id][name][:command]}", @routines[@channel_id][name][:dest]
+              end
               started = Time.now
-              treat_message({ channel: @routines[@channel_id][name][:dest],
-                             user: @routines[@channel_id][name][:creator_id],
-                             text: @routines[@channel_id][name][:command],
-                             files: nil })
+              data = { channel: @routines[@channel_id][name][:dest],
+                user: @routines[@channel_id][name][:creator_id],
+                text: @routines[@channel_id][name][:command],
+                files: nil }
+              treat_message(data)
             end
             # in case the routine was deleted while running the process
             if !@routines.key?(@channel_id) or !@routines[@channel_id].key?(name)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: slack-smart-bot
 version: !ruby/object:Gem::Version
-  version: 1.1.2
+  version: 1.2.0
 platform: ruby
 authors:
 - Mario Ruiz
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-10-29 00:00:00.000000000 Z
+date: 2019-11-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: slack-ruby-client