slack-smart-bot 1.9.2 → 1.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 974b9b2da39dd58e4e404572932ace72c5b9d1136956543ac890cf7bc91ab61e
-  data.tar.gz: a304bbeeecc5177c5014c86902c20d9682e6addfc00ab3f5ee33aeca4dba2215
+  metadata.gz: 258161d536cc6c07a7cdbf6e42a91069bc5715fb3b5807f635f4be4754ec6a36
+  data.tar.gz: 72361374be67be8b22f3dff0465fc03aa9383045d75cc68385ffa401fff8edbd
 SHA512:
-  metadata.gz: 85e6d1e343b0523b25c5c630d37fcda402a8529d2ae8a1f5473694a65e9311293b4d628bc0e9a18e3910bd68123276b30039e1a50115c97bd029db19a2a9738a
-  data.tar.gz: 90c2441764b9faceeb74d1281c19fccc84c960d4344f5822c5d50293d1de55d300d10373a60e0cf876270aced23f20686844e2cb0503dfb0a30004adeec8e27c
+  metadata.gz: 0bdaabba591af2ef6690d71212a61a170a454f58eeb8424504d743d17f1d5062db808279bd29d6719791ecac141c9c23f29964349f0c8c94fa6a738b09cac4aa
+  data.tar.gz: 50b5827289fb31fe757a6269eea9d89ee00fb8d2f81f1ed7bbcab0ccdff9114a7a7ff703e97c31fec259e2f65bde93f4b1780765a72d704966ece7d2b251c3c0

data/README.md

@@ -27,8 +27,12 @@ slack-smart-bot can create bots on demand, create shortcuts, run ruby code... ju
     + [REPL](#repl)
   * [Sending notifications](#sending-notifications)
   * [Shortcuts](#shortcuts)
+  * [Announcements](#announcements)
+  * [Share Messages](#share-messages)
+  * [See Statuses](#see-statuses)
   * [Routines](#routines)
   * [Limit who has access to a command](#limit-who-has-access-to-a-command)
+  * [See favorite commands](#see-favorite-commands)
   * [Tips](#tips)
     + [Send a file](#send-a-file)
     + [Download a file](#download-a-file)
@@ -81,7 +85,9 @@ You can get one by any of these options:
 - *[Legacy API Token](https://api.slack.com/custom-integrations/legacy-tokens)*. 
 
 
-*Remember to invite the smart bot to the channels where they will be accessible before creating the bot*
+*Remember to invite the smart bot to the channels where they will be accessible before creating the bot*  
+
+SmartBot will notify about SmartBot status changes or any SmartBot incident if defined the status_channel in settings file and the channel exists. By default: smartbot-status  
 
 ## Usage
 
@@ -158,6 +164,21 @@ def rules(user, command, processed, dest)
       
       unreact :runner
 
+    # Example sending blocks. More info: https://api.slack.com/block-kit
+    # help: It will return the info about who is the admin
+    when /\AWho is the admin\?\z/i
+         my_blocks = [
+           { type: "context",
+             elements:
+               [
+                 { type: "plain_text", :text=>"\tAdmin: " },
+                 { type: "image", image_url: "https://avatars.slack-edge.com/2021-03-23/182815_e54abb1dd_24.jpg", alt_text: "mario" },
+                 { type: "mrkdwn", text: " *Mario Ruiz* (marior)  " }
+               ]
+           }
+         ]
+         respond blocks: my_blocks
+
     else
       unless processed
         dont_understand()
@@ -168,6 +189,7 @@ end
 
 Also you can add general rules that will be available on all Smart Bot channels to `./rules/general_rules.rb`
 
+If you have commands that want to make them available everywhere the Smart Bot is a member then add those commands to `./rules/general_commands.rb`. 
 
 ### How to access the Smart Bot
 You can access the bot directly on the MASTER CHANNEL, on a secondary channel where the bot is running and directly by opening a private chat with the bot, in this case the conversation will be just between you and the bot.
@@ -184,7 +206,7 @@ To run a command on demand:
   **_`!THE_COMMAND`_**  
   **_`@NAME_OF_BOT THE_COMMAND`_**  
   **_`NAME_OF_BOT THE_COMMAND`_**  
-To run a command on demand and add the respond on a thread:  
+To run a command on demand and add the response on a thread:  
   **_`^THE_COMMAND`_**  
   **_`!!THE_COMMAND`_**
 
@@ -203,14 +225,18 @@ Examples run a command on demand:
 >**_Peter>_** `^echo Example`  
 >. . . . . . . . .**_Smart-Bot>_** `Example`
 
-Also you can always call the Smart Bot from any channel, even from channels without a running Smart Bot. You can use the External Call on Demand: **_`@NAME_OF_BOT on #CHANNEL_NAME COMMAND`_**. In this case you will call the bot on #CHANNEL_NAME. You can supply more than one channel then all the bots will respond.
+Also you can always call the Smart Bot from any channel, even from channels without a running Smart Bot. You can use the External Call on Demand: **_`@NAME_OF_BOT on #CHANNEL_NAME COMMAND`_**. In this case you will call the bot on #CHANNEL_NAME. You can supply more than one channel then all the bots will respond. In case you are in a private conversation with the Smart Bot (DM) then you can use directly:  **_`#CHANNEL_NAME COMMAND`_** or **_`on #CHANNEL_NAME COMMAND`_**
 
-Example:
+Examples:
 >**_Peter>_** `@smart-bot on #the_channel ruby puts Time.now`  
 >**_Smart-Bot>_** `2019-10-23 12:43:42 +0000`  
 >**_Peter>_** `@smart-bot on #the_channel ^ruby puts Time.now`  
 >. . . . . . . . .**_Smart-Bot>_** `2019-10-23 12:43:42 +0000`
 
+Examples on DM:
+>**_Peter>_** `#sales show report from India`
+>**_Peter>_** `on #sales notify clients`
+
 If you want the Smart Bot just listen to part of the message you send, add the commands you want using '`' and start the line with '-!', '-!!' or '-^'
 
 Examples:
@@ -222,6 +248,13 @@ Examples:
 >. . . . . . . . .**_Smart-Bot>_** `a`  
 >. . . . . . . . .**_Smart-Bot>_** `b`
 
+
+All the commands specified on `./rules/general_commands.rb` will be accessible from any channel where the Smart Bot is present, without the necessity to call it with !, !!, ^ or on demand.
+
+Examples:
+>**_Peter>_** `Thanks smartbot`  
+>**_Smart-Bot>_** `You're very welcome`  
+
 ### Bot Help
 To get a full list of all commands and rules for a specific Smart Bot: **_`bot help`_**. It will show only the specific available commands for the user requesting. By default it will display only a short version of the bot help, call **_`bot help expanded`_** to get a expanded version of all commands.
 
@@ -229,6 +262,8 @@ If you want to search just for a specific command: **_`bot help COMMAND`_** It w
 
 To show only the specific rules of the Smart Bot defined on the rules file: **_`bot rules`_** or **_`bot rules COMMAND`_**
 
+Also you can call `suggest command` or `random command` and SmartBot will return the help content for a random command.
+
 Example:
 >**_Peter>_** `bot help echo`  
 >**_Smart-Bot>_** `echo SOMETHING`  
@@ -266,9 +301,11 @@ To see the status of the bots, on the MASTER CHANNEL: **_`bot status`_**
 
 If you need it you can set the SmartBot on maintenance mode by running: **_`set maintenance on`_**. A message to be displayed can be added if not the default message will be used. Run **_`set maintenance off`_** when you want the SmartBot to be running in normal conditions again.
 
+To display a general message after every command use: `set general message MESSAGE`. Use `set general message off` to stop displaying it.
+
 To close the Master Bot, run on MASTER CHANNEL: **_`exit bot`_**
 
-If you are a Master Admin on a Direct Message with the Smart Bot you can call the **_`bot stats`_** and get use stats of the users. You need to set to `true` the `stats` settings when initializing the Smart Bot. As a normal user you will get your own stats when calling **_`bot stats`_**. Take a look at `bot help bot stats` for more info.
+If you are a Master Admin on a Direct Message with the Smart Bot you can call the **_`bot stats`_** and get use stats of the users. You need to set to `true` the `stats` settings when initializing the Smart Bot. As a normal user you will get your own stats when calling **_`bot stats`_**. Take a look at `bot help bot stats` for more info. Also you can call **_`leaderboard`_** to get some useful information about the use of the SmartBot.
 
 You can also get the bot logs of the bot channel you are using by calling `get bot logs`. You need to be a Master Admin user on a DM with the Smart Bot.
 
@@ -298,7 +335,7 @@ Example:
 >**_Peter>_** `!ruby require 'json'; res=[]; 20.times {res.push rand(100)}; my_json={result: res}; puts my_json.to_json`  
 >**_Smart-Bot>_** `{"result":[63,66,35,83,44,40,72,25,59,73,75,54,56,91,19,6,68,1,25,3]}`  
 
-Also it is possible to attach a Ruby file and the Smart Bot will run and post the output. You need to select Ruby as file format.
+Also it is possible to attach a Ruby file and the Smart Bot will run and post the output. You need to select Ruby as file format. Or if you prefer it you can call the `ruby` command and on the same message supply a code block.
 
 #### REPL
 Easily starts a REPL session so you will be able to create a script directly from the slack conversation. You will be able to share the REPL so they can run it or see the content.
@@ -392,19 +429,63 @@ Example:
 
 To see available shortcuts: **_`see shortcuts`_** and to delete a particular shortcut: **_`delete shortcut NAME`_**
 
+### Announcements
+You can add any announcement on any channel where the SmartBot is a member by using **_`add COLOR announcement MESSAGE`_** or **_`add EMOJI announcement MESSAGE`_**.
+
+It will store the message on the announcement list labeled with the color/emoji specified, white by default. Possible colors white, green, yellow and red. Aliases for announcement: statement, declaration, message.
+
+Examples:
+>**_Peter>_** `add green announcement :heavy_check_mark: All customer services are *up* and running`
+>**_Peter>_** `add red message Customers db is down :x:`
+>**_Peter>_** `add yellow statement Don't access the linux server without VPN`
+>**_Peter>_** `add announcement Party will start at 20:00 :tada:`
+>**_Peter>_** `add :heavy_exclamation_mark: message Pay attention all DB are on maintenance until 20:00 GMT`
+
+To see the announcements of the channel: **_`see announcements`_**, **_`see COLOR announcements`_**, **_`see EMOJI announcements`_** and to delete a particular announcement: **_`delete announcement ID`_**
+
+If you are a master admin and you are on master channel then you can call **_`publish announcements`_** that will publish the announcements on all channels. The messages stored on a DM won't be published. This is very convenient to be called from a *Routine* for example every weekday at 09:00.
+
+### Share messages
+You can automatically share any new message that is posted on the channel and meet the specified criteria by using **_`share messages /REGEXP/ on #CHANNEL`_** or **_`share messages "TEXT" on #CHANNEL`_**.
+
+This command is only available in public channels. The user adding the Share and the SmartBot need to be a member of both channels.
+
+Examples:
+>**_Peter>_** `share messages /(last\s+|previous\s+)?sales\s+results\s+/ on #sales`
+>**_Peter>_** `share messages "share post" on #announcements`
+
+To see the shares of the channel: **_`see shares`_** and to delete a particular share: **_`delete share ID`_**
+
+### See statuses
+To see a list of statuses of the members in the channel you can call `see statuses`, `who is on vacation?`, `who is not on vacation?`, `who is on EMOJI`, `who is on EMOJI #CHANNEL`
+
+You need to be a member of the channel to be able to get this info.
+
+Examples:
+>**_Peter>_** `see statuses`
+>**_Peter>_** `who is on vacation?`
+>**_Peter>_** `who is not on vacation?`
+>**_Peter>_** `who is on vacation? #SalesChannel`
+>**_Peter>_** `who is on :working-from-home:`
+
 ### 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`_**. Also just before the command you can supply the channel where you want to publish the results, if not channel supplied then it would be the SmartBot Channel or on the DM if the command is run from there. Remember the SmartBot needs to have access to the channel where you want to publish.
 
+In case you create a *bgroutine* instead of a normal *routine* then the results of the run won't be published.
+
 If you want to hide the routine executions use `add silent routine`. It won't show the routine name when executing.
 
+To see the last result of the execution you can call `see result routine NAME`
+
 Examples:  
 >**_`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`_**  
+>**_`add bgroutine clean_db at 17:05 !clean customers temp db`_**  
+>**_`add silent bgroutine clean_db at 17:05 !clean customers temp db`_**  
 >**_`add routine clean_custdb on Mondays at 05:00 !clean customers db`_**  
 >**_`add routine clean_custdb on Tuesdays at 09:00 #SREChannel !clean customers db`_**  
+>**_`add silent routine suggestions on weekdays at 09:00 suggest command`_**
 
-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.
+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. Also you can supply a script adding \`\`\`the code\`\`\` and specifying on the routine name the extension that will have. Only Master Admins are allowed to add files or scripts.
 
 Other routine commands:
 * **_`pause routine NAME`_**
@@ -412,6 +493,7 @@ Other routine commands:
 * **_`remove routine NAME`_**
 * **_`run routine NAME`_**
 * **_`see routines`_**
+* **_`see result routine NAME`_**
 
 ### Limit who has access to a command
 
@@ -437,10 +519,26 @@ If you want to change who has access to a certain command without restarting the
 config.allow_access.repl = ['marioruiz', 'samcooke']
 ```
 
-These are the commands that are possible to be limited:
+These are the commands that are possible to be limited plus all your SmartBot rules:
+
+`bot_help, bot_rules, bot_status, use_rules, add_shortcut, delete_shortcut, repl, run_repl, get_repl, delete_repl, see_repls, ruby_code, see_shortcuts, create_bot, add_announcement, delete_announcement, see_announcements`
 
-`bot_help, bot_rules, bot_status, use_rules, add_shortcut, delete_shortcut, repl, run_repl, get_repl, delete_repl, see_repls, ruby_code, see_shortcuts, create_bot`
+To check from a rule if the user has access to it:
 
+```ruby
+if has_access?(:your_command_id)
+end
+```
+
+### See favorite commands
+
+It will display the favorite commands in that channel. 
+
+Examples:  
+>**_`see favorite commands`_**  
+>**_`favorite commands`_**  
+>**_`my favourite commands`_**  
+>**_`most used commands`_**  
 
 ### Tips
 

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

@@ -3,61 +3,67 @@ class SlackSmartBot
   #context: previous message
   #to: user that should answer
   def ask(question, context = nil, to = nil, dest = nil)
-    if dest.nil? and Thread.current.key?(:dest)
-      dest = Thread.current[:dest]
-    end
-    if to.nil?
-      to = Thread.current[:user].name
-    end
-    if context.nil?
-      context = Thread.current[:command]
-    end
-    message = "#{to}: #{question}"
-    if dest.nil?
-      if config[:simulate]
-        open("#{config.path}/buffer_complete.log", "a") { |f|
-          f.puts "|#{@channel_id}|#{config[:nick_id]}|#{config[:nick]}|#{message}~~~"
-        }
-      else  
-        if Thread.current[:on_thread]
-          client.message(channel: @channel_id, text: message, as_user: true, thread_ts: Thread.current[:thread_ts])
-        else
-          client.message(channel: @channel_id, text: message, as_user: true)
-        end
+    begin
+      if dest.nil? and Thread.current.key?(:dest)
+        dest = Thread.current[:dest]
+      end
+      if to.nil?
+        to = Thread.current[:user].name
       end
-      if config[:testing] and config.on_master_bot
-        open("#{config.path}/buffer.log", "a") { |f|
-          f.puts "|#{@channel_id}|#{config[:nick_id]}|#{config[:nick]}|#{message}"
-        }
+      if context.nil?
+        context = Thread.current[:command]
       end
-    elsif dest[0] == "C" or dest[0] == "G" # channel
-      if config[:simulate]
-        open("#{config.path}/buffer_complete.log", "a") { |f|
-          f.puts "|#{dest}|#{config[:nick_id]}|#{config[:nick]}|#{message}~~~"
-        }
-      else  
-        if Thread.current[:on_thread]
-          client.message(channel: dest, text: message, as_user: true, thread_ts: Thread.current[:thread_ts])
-        else
-          client.message(channel: dest, text: message, as_user: true)
+      message = "#{to}: #{question}"
+      if dest.nil?
+        if config[:simulate]
+          open("#{config.path}/buffer_complete.log", "a") { |f|
+            f.puts "|#{@channel_id}|#{config[:nick_id]}|#{config[:nick]}|#{message}~~~"
+          }
+        else  
+          if Thread.current[:on_thread]
+            client.message(channel: @channel_id, text: message, as_user: true, thread_ts: Thread.current[:thread_ts])
+          else
+            client.message(channel: @channel_id, text: message, as_user: true)
+          end
         end
+        if config[:testing] and config.on_master_bot and !@buffered
+          @buffered = true
+          open("#{config.path}/buffer.log", "a") { |f|
+            f.puts "|#{@channel_id}|#{config[:nick_id]}|#{config[:nick]}|#{message}"
+          }
+        end
+      elsif dest[0] == "C" or dest[0] == "G" # channel
+        if config[:simulate]
+          open("#{config.path}/buffer_complete.log", "a") { |f|
+            f.puts "|#{dest}|#{config[:nick_id]}|#{config[:nick]}|#{message}~~~"
+          }
+        else  
+          if Thread.current[:on_thread]
+            client.message(channel: dest, text: message, as_user: true, thread_ts: Thread.current[:thread_ts])
+          else
+            client.message(channel: dest, text: message, as_user: true)
+          end
+        end
+        if config[:testing] and config.on_master_bot and !@buffered
+          @buffered = true
+          open("#{config.path}/buffer.log", "a") { |f|
+            f.puts "|#{dest}|#{config[:nick_id]}|#{config[:nick]}|#{message}"
+          }
+        end
+      elsif dest[0] == "D" #private message
+        send_msg_user(dest, message)
       end
-      if config[:testing] and config.on_master_bot
-        open("#{config.path}/buffer.log", "a") { |f|
-          f.puts "|#{dest}|#{config[:nick_id]}|#{config[:nick]}|#{message}"
-        }
+      if Thread.current[:on_thread]
+        qdest = Thread.current[:thread_ts]
+      else
+        qdest = dest
       end
-    elsif dest[0] == "D" #private message
-      send_msg_user(dest, message)
-    end
-    if Thread.current[:on_thread]
-      qdest = Thread.current[:thread_ts]
-    else
-      qdest = dest
+      @answer[to] = {} unless @answer.key?(to)
+      @answer[to][qdest] = context
+      @questions[to] = context # to be backwards compatible #todo remove it when 2.0
+    rescue Exception => stack
+      @logger.warn stack
     end
-    @answer[to] = {} unless @answer.key?(to)
-    @answer[to][qdest] = context
-    @questions[to] = context # to be backwards compatible #todo remove it when 2.0
   end
 
 end

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

@@ -50,7 +50,7 @@ class SlackSmartBot
       end
     else
       message = ''
-      message = "\nTake in consideration when on external calls, not all the commands are availalbe." if typem==:on_call
+      message = "\nTake in consideration when on external calls, not all the commands are available." if typem==:on_call
       if res_final.empty?
         resp = answer.sample
         respond "#{user.profile.display_name}, #{resp}#{message}", dest

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

@@ -3,11 +3,13 @@ class SlackSmartBot
     unless config.simulate
       m = "Successfully connected, welcome '#{client.self.name}' to the '#{client.team.name}' team at https://#{client.team.domain}.slack.com."
       puts m
+      save_status :on, :connected, m
+
       @logger.info m
       config.nick = client.self.name
       config.nick_id = client.self.id
     end
-    @salutations = [config[:nick], "<@#{config[:nick_id]}>", "bot", "smart"]
+    @salutations = [config[:nick], "<@#{config[:nick_id]}>", "@#{config[:nick]}", "bot", "smart", "smartbot", "smart-bot", "smart bot"]
 
     gems_remote = `gem list slack-smart-bot --remote`
     version_remote = gems_remote.to_s().scan(/slack-smart-bot \((\d+\.\d+\.\d+)/).join
@@ -16,13 +18,15 @@ class SlackSmartBot
       version_message = ". There is a new available version: #{version_remote}."
     end
     if (!config[:silent] or ENV['BOT_SILENT'].to_s == 'false') and !config.simulate
+      unless ENV['BOT_SILENT']=='true'
+        respond "Smart Bot started v#{VERSION}#{version_message}\nIf you want to know what I can do for you: `bot help`.\n`bot rules` if you want to display just the specific rules of this channel.\nYou can talk to me privately if you prefer it."
+      end
       ENV['BOT_SILENT'] = 'true' if config[:silent] and ENV['BOT_SILENT'].to_s != 'true'
-      respond "Smart Bot started v#{VERSION}#{version_message}\nIf you want to know what I can do for you: `bot help`.\n`bot rules` if you want to display just the specific rules of this channel.\nYou can talk to me privately if you prefer it."
     end
     @routines.each do |ch, rout|
       rout.each do |k, v|
         if !v[:running] and v[:channel_name] == config.channel
-          create_routine_thread(k)
+          create_routine_thread(k, v)
         end
       end
     end

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

@@ -1,8 +1,13 @@
+#todo: add pagination for case more than 1000 members in the channel
 def get_channel_members(channel_id)
-    if config.simulate and config.key?(:client)
-        client.web_client.conversations_members[channel_id.to_sym].members
-    else
-        client.web_client.conversations_members(channel: channel_id).members
+    begin
+        if config.simulate and config.key?(:client)
+            client.web_client.conversations_members[channel_id.to_sym].members
+        else
+            client.web_client.conversations_members(channel: channel_id, limit: 1000).members
+        end
+    rescue Exception => stack
+        @logger.warn stack
     end
 
 end

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

@@ -1,20 +1,35 @@
-def get_channels(bot_is_in: false)
+def get_channels(bot_is_in: false, types: 'private_channel,public_channel')
+  begin
     if config.simulate and config.key?(:client)
-        if bot_is_in
-            client.web_client.conversations_members.reject {|r,v| !v.members.include?(config.nick_id)}.values
-        else
-           client.web_client.conversations_members.values
-        end
+      if bot_is_in
+        client.web_client.conversations_members.reject { |r, v| !v.members.include?(config.nick_id) }.values
+      else
+        client.web_client.conversations_members.values
+      end
     else
-        if bot_is_in
-            client.web_client.users_conversations(exclude_archived: true, limit: 100, types: "im, public_channel,private_channel").channels
-        else
-            #todo: add pagination for case more than 1000 channels on the workspace
-            client.web_client.conversations_list(
-            types: "private_channel,public_channel",
-            limit: "1000",
-            exclude_archived: "true",
-            ).channels        
+      if bot_is_in
+        client.web_client.users_conversations(exclude_archived: true, limit: 1000, types: "im, public_channel,private_channel").channels
+      else
+        resp = client.web_client.conversations_list(types: types, limit: "600", exclude_archived: "true")
+        channels = resp.channels
+        begin
+          while resp.response_metadata.next_cursor.to_s != ""
+            resp = client.web_client.conversations_list(
+              cursor: resp.response_metadata.next_cursor.to_s,
+              types: types,
+              limit: "600",
+              exclude_archived: "true",
+            )
+            channels += resp.channels
+          end
+        rescue Exception => stack
+          @logger.warn stack
         end
+        return channels
+      end
     end
-end
+  rescue Exception => stack
+    @logger.warn stack
+    return []
+  end
+end