slack-smart-bot 1.8.2 → 1.9.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d35053e4911d77ae985b29fbd1564636eb0d078b38106601c2e126a401a03d5b
-  data.tar.gz: d5aadeedbdbe0c7a6528cbeac1f1bb0990d88cf93fdb9f0a085cf9be9ec17c2d
+  metadata.gz: 0566062f8e9af6bc724b505bc1ee0821027e93bf5302a36781a0506e66d2cdf7
+  data.tar.gz: 3d10378e17c6dc94f70784c5a68854fbdac9c4d6e752f5616728f27b7c4ab706
 SHA512:
-  metadata.gz: 19ed3708f96befda1f755358eb847facba2afaa62f6a92e08e7f68143e51659ef75ab7ef925c0d07e9a2b02072dcd02ddeda89697855363e50e84dc3f1970af6
-  data.tar.gz: d40d1ac18d32074994c2c4ed3b835b74ada4e9ff46bbb5a7122df0f18f1b44eb777a6351ddaad3dd00b8bc129dbb62aee75572b9f3fe625e4fa972add2083107
+  metadata.gz: 4cc5736de96995f20e0530a54c2f0ddf5fdc8dee3288e6f04bc938ef446b869508fc003f58b8ed030b89bdab37959aff6ca1e0d59e556df581ca0c5a2abc5b01
+  data.tar.gz: 929465da66b5ca3660b1bad1b360d7badc391d43596fcbe834a8e69f0aca3decd0b970b67dfbb063df8d77cb0c50b47d4b2b4ed84b99663719532406958b6b34

data/README.md

@@ -10,6 +10,8 @@ The main scope of this ruby gem is to be used internally in your company so team
 
 slack-smart-bot can create bots on demand, create shortcuts, run ruby code... just on a chat channel, you can access it just from your mobile phone if you want and run those tests you forgot to run, get the results, restart a server... no limits.
 
+![](slack.png)
+
 # Table of Contents
 
 - [Installation and configuration](#installation-and-configuration)
@@ -114,12 +116,12 @@ def rules(user, command, processed, dest)
     # help:   it will sleep the bot for 10 seconds
     # help:
     when /^go\sto\ssleep/i
-      unless @questions.keys.include?(from)
+      if answer.empty?
         ask "do you want me to take a siesta?"
       else
-        case @questions[from]
+        case answer
           when /yes/i, /yep/i, /sure/i
-            @questions.delete(from)
+            answer_delete
             respond "I'll be sleeping for 10 secs... just for you"
             respond "zZzzzzzZZZZZZzzzzzzz!"
             react :sleeping
@@ -127,11 +129,11 @@ def rules(user, command, processed, dest)
             unreact :sleeping
             react :sunny
           when /no/i, /nope/i, /cancel/i
-            @questions.delete(from)
+            answer_delete
             respond "Thanks, I'm happy to be awake"
           else
             respond "I don't understand"
-            ask "are you sure do you want me to sleep? (yes or no)"
+            ask "are you sure you want me to sleep? (yes or no)"
         end
       end
 
@@ -201,7 +203,7 @@ 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.
+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.
 
 Example:
 >**_Peter>_** `@smart-bot on #the_channel ruby puts Time.now`  
@@ -221,9 +223,9 @@ Examples:
 >. . . . . . . . .**_Smart-Bot>_** `b`
 
 ### 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.
+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.
 
-If you want to search just for a specific command: **_`bot help COMMAND`_**
+If you want to search just for a specific command: **_`bot help COMMAND`_** It will display expanded explanations for the command.
 
 To show only the specific rules of the Smart Bot defined on the rules file: **_`bot rules`_** or **_`bot rules COMMAND`_**
 
@@ -239,6 +241,7 @@ Remember when you add code to your rules you need to specify the help that will
 For the examples use _ and for the rules `. This is a good example of a Help supplied on rules source code:
 
 ```ruby
+# help: ----------------------------------------------
 # help: `run TYPE tests on LOCATION`
 # help: `execute TYPE tests on LOCATION`
 # help:     run the specified tests on the indicated location
@@ -250,6 +253,8 @@ For the examples use _ and for the rules `. This is a good example of a Help sup
 # help:     _execute smoke tests on db1_
 ```
 
+To see what's new just call `What's new`
+
 ### 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.
 
@@ -259,9 +264,11 @@ If you want to pause a bot, from the channel of the bot: **_`pause bot`_**. To s
 
 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 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. 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.
 
 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.
 
@@ -309,7 +316,7 @@ If you declare on your rules file a method called `project_folder` returning the
 
 By default it will be automatically loaded the gems: `string_pattern`, `nice_hash` and `nice_http`
 
-To pre-execute some ruby when starting the session add the code to `.smart-bot-repl` file on the project root folder defined on `project_folder`
+To pre-execute some ruby when starting the session add the code to `.smart-bot-repl` file on the project root folder defined on `project_folder`. Then that file will be always executed before the REPL started or created. In that case if we want to avoid to run that file before the REPL we can do it adding the word 'clean' before the command `clean repl`.
 
 If you want to see the methods of a class or module you created use `ls TheModuleOrClass`
 
@@ -367,7 +374,7 @@ That shortcut will be available for you, in case you want to make it available f
 Example:
 >**_Peter>_** `!add shortcut for all spanish bank account: ruby require 'iso/iban'; 3.times {puts ISO::IBAN.random('ES')}`  
 >**_Smart-Bot>_** `shortcut added`  
->**_Peter>_** `!spanish bank account`  
+>**_John>_** `!spanish bank account`  
 >**_Smart-Bot>_** `ES4664553191352006861448`  
 `ES4799209592433480943244`  
 `ES8888795057132445752702`  

data/lib/slack-smart-bot.rb

@@ -41,6 +41,8 @@ class SlackSmartBot
     config[:simulate] = false unless config.key?(:simulate)
     config[:stats] = false unless config.key?(:stats)
     config[:allow_access] = Hash.new unless config.key?(:allow_access)
+    config[:on_maintenance] = false unless config.key?(:on_maintenance)
+    config[:on_maintenance_message] = "Sorry I'm on maintenance so I cannot attend your request." unless config.key?(:on_maintenance_message)
 
     if config.path.to_s!='' and config.file.to_s==''
       config.file = File.basename($0)
@@ -89,7 +91,7 @@ class SlackSmartBot
       config.on_master_bot = false
     end
 
-    if !config.key?(:token) or config.token.to_s == ''
+    if (!config.key?(:token) or config.token.to_s == '') and !config.simulate
       abort "You need to supply a valid token key on the settings. key: :token"
     elsif !config.key?(:masters) or !config.masters.is_a?(Array) or config.masters.size == 0
       abort "You need to supply a masters array on the settings containing the user names of the master admins. key: :masters"
@@ -104,7 +106,8 @@ class SlackSmartBot
     logfile = File.basename(config.rules_file.gsub("_rules_", "_logs_"), ".rb") + ".log"
     config.log_file = logfile
     @logger = Logger.new("#{config.path}/logs/#{logfile}")
-
+    @last_respond = Time.now
+    
     config_log = config.dup
     config_log.delete(:token)
     @logger.info "Initializing bot: #{config_log.inspect}"
@@ -114,15 +117,21 @@ class SlackSmartBot
 
     self.config = config
 
-    Slack.configure do |conf|
-      conf.token = config[:token]
+    unless config.simulate and config.key?(:client)
+      Slack.configure do |conf|
+        conf.token = config[:token]
+      end
     end
     restarts = 0
     created = false
     while restarts < 200 and !created
       begin
         @logger.info "Connecting #{config_log.inspect}"
-        self.client = Slack::RealTime::Client.new(start_method: :rtm_connect)
+        if config.simulate and config.key?(:client)
+          self.client = config.client
+        else
+          self.client = Slack::RealTime::Client.new(start_method: :rtm_connect)
+        end
         created = true
       rescue Exception => e
         restarts += 1
@@ -143,6 +152,8 @@ class SlackSmartBot
     @bots_created = Hash.new()
     @shortcuts = Hash.new()
     @shortcuts[:all] = Hash.new()
+    @shortcuts_global = Hash.new()
+    @shortcuts_global[:all] = Hash.new()
     @rules_imported = Hash.new()
     @routines = Hash.new()
     @repls = Hash.new()
@@ -153,6 +164,12 @@ class SlackSmartBot
         @shortcuts = eval(file_sc)
       end
     end
+    if File.exist?("#{config.path}/shortcuts/shortcuts_global.rb")
+      file_sc = IO.readlines("#{config.path}/shortcuts/shortcuts_global.rb").join
+      unless file_sc.to_s() == ""
+        @shortcuts_global = eval(file_sc)
+      end
+    end
 
     get_routines()
     get_repls()
@@ -181,7 +198,7 @@ class SlackSmartBot
       @admin_users_id = []
       @master_admin_users_id = []
       config.admins.each do |au|
-        user_info = client.web_client.users_info(user: "@#{au}")
+        user_info = get_user_info("@#{au}")
         @admin_users_id << user_info.user.id
         if config.masters.include?(au)
           @master_admin_users_id << user_info.user.id
@@ -189,7 +206,7 @@ class SlackSmartBot
         sleep 1
       end
       (config.masters-config.admins).each do |au|
-        user_info = client.web_client.users_info(user: "@#{au}")
+        user_info = get_user_info("@#{au}")
         @master_admin_users_id << user_info.user.id
         sleep 1
       end
@@ -197,38 +214,21 @@ class SlackSmartBot
       @logger.fatal "TooManyRequestsError"
       abort("TooManyRequestsError please re run the bot and be sure of executing first: killall ruby")
     rescue Exception => stack
+      pp stack if config.testing
       abort("The admin user specified on settings: #{config.admins.join(", ")}, doesn't exist on Slack. Execution aborted")
     end
 
-    client.on :hello do
-      m = "Successfully connected, welcome '#{client.self.name}' to the '#{client.team.name}' team at https://#{client.team.domain}.slack.com."
-      puts m
-      @logger.info m
-      config.nick = client.self.name
-      config.nick_id = client.self.id
-      @salutations = [config[:nick], "<@#{config[:nick_id]}>", "bot", "smart"]
-
-      gems_remote = `gem list slack-smart-bot --remote`
-      version_remote = gems_remote.to_s().scan(/slack-smart-bot \((\d+\.\d+\.\d+)/).join
-      version_message = ""
-      if version_remote != VERSION
-        version_message = ". There is a new available version: #{version_remote}."
-      end
-      if !config[:silent] or ENV['BOT_SILENT'].to_s == 'false'
-        ENV['BOT_SILENT'] = 'true' if config[:silent] == 'true' 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)
-          end
-        end
+    if config.simulate and config.key?(:client)
+      event_hello()
+    else
+      client.on :hello do
+        event_hello()
       end
     end
 
     @status = config.status_init
     @questions = Hash.new()
+    @answer = Hash.new()
     @repl_sessions = Hash.new()
     @channels_id = Hash.new()
     @channels_name = Hash.new()
@@ -253,20 +253,19 @@ class SlackSmartBot
           end
         end
       end
+    else
+      client.on :close do |_data|
+        m = "Connection closing, exiting. #{Time.now}"
+        @logger.info m
+        @logger.info _data
+      end
+  
+      client.on :closed do |_data|
+        m = "Connection has been disconnected. #{Time.now}"
+        @logger.info m
+        @logger.info _data
+      end
     end
-
-    client.on :close do |_data|
-      m = "Connection closing, exiting. #{Time.now}"
-      @logger.info m
-      @logger.info _data
-    end
-
-    client.on :closed do |_data|
-      m = "Connection has been disconnected. #{Time.now}"
-      @logger.info m
-      @logger.info _data
-    end
-
     self
   end
 

data/lib/slack-smart-bot_rules.rb

@@ -2,7 +2,7 @@
 #path to the project folder
 # for example "#{`eval echo ~$USER`.chop}/projects/the_project"
 def project_folder()
-  "#{`eval echo ~$USER`.chop}/"
+  "#{Dir.pwd}/"
 end
 
 #link to the project
@@ -50,12 +50,12 @@ def rules(user, command, processed, dest, files = [], rules_file = "")
         # help:
       when /^go\sto\ssleep/i
         save_stats :go_to_sleep
-        unless @questions.keys.include?(from)
+        if answer.empty?
           ask "do you want me to take a siesta?"
         else
-          case @questions[from]
+          case answer
           when /yes/i, /yep/i, /sure/i
-            @questions.delete(from)
+            answer_delete
             respond "I'll be sleeping for 5 secs... just for you"
             respond "zZzzzzzZZZZZZzzzzzzz!"
             react :sleeping
@@ -63,11 +63,11 @@ def rules(user, command, processed, dest, files = [], rules_file = "")
             unreact :sleeping
             react :sunny
           when /no/i, /nope/i, /cancel/i
-            @questions.delete(from)
+            answer_delete
             respond "Thanks, I'm happy to be awake"
           else
             respond "I don't understand"
-            ask "are you sure do you want me to sleep? (yes or no)"
+            ask "are you sure you want me to sleep? (yes or no)"
           end
         end
 

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

@@ -6,4 +6,8 @@ require_relative 'comm/send_file'
 require_relative 'comm/send_msg_channel'
 require_relative 'comm/send_msg_user'
 require_relative 'comm/react'
-require_relative 'comm/unreact'
+require_relative 'comm/unreact'
+require_relative 'comm/get_user_info'
+require_relative 'comm/event_hello'
+require_relative 'comm/get_channel_members'
+require_relative 'comm/get_channels'

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

@@ -16,7 +16,7 @@ class SlackSmartBot
     if dest.nil?
       if config[:simulate]
         open("#{config.path}/buffer_complete.log", "a") { |f|
-          f.puts "|#{@channel_id}|#{config[:nick_id]}|#{message}~~~"
+          f.puts "|#{@channel_id}|#{config[:nick_id]}|#{config[:nick]}|#{message}~~~"
         }
       else  
         if Thread.current[:on_thread]
@@ -27,13 +27,13 @@ class SlackSmartBot
       end
       if config[:testing] and config.on_master_bot
         open("#{config.path}/buffer.log", "a") { |f|
-          f.puts "|#{@channel_id}|#{config[:nick_id]}|#{message}"
+          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]}|#{message}~~~"
+          f.puts "|#{dest}|#{config[:nick_id]}|#{config[:nick]}|#{message}~~~"
         }
       else  
         if Thread.current[:on_thread]
@@ -44,13 +44,20 @@ class SlackSmartBot
       end
       if config[:testing] and config.on_master_bot
         open("#{config.path}/buffer.log", "a") { |f|
-          f.puts "|#{dest}|#{config[:nick_id]}|#{message}"
+          f.puts "|#{dest}|#{config[:nick_id]}|#{config[:nick]}|#{message}"
         }
       end
     elsif dest[0] == "D" #private message
       send_msg_user(dest, message)
     end
-    @questions[to] = context
+    if Thread.current[:on_thread]
+      qdest = Thread.current[:thread_ts]
+    else
+      qdest = dest
+    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

@@ -10,7 +10,7 @@ class SlackSmartBot
     if typem==:on_extended
       get_bots_created()
     end
-    text = get_help(rules_file, dest, user.name, typem==:on_extended)
+    text = get_help(rules_file, dest, user.name, typem==:on_extended, true)
 
     ff = text.scan(/\s*`\s*([^`]+)\s*`\s*/i).flatten
     ff.delete("!THE_COMMAND")

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

@@ -0,0 +1,30 @@
+class SlackSmartBot
+  def event_hello()
+    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
+      @logger.info m
+      config.nick = client.self.name
+      config.nick_id = client.self.id
+    end
+    @salutations = [config[:nick], "<@#{config[:nick_id]}>", "bot", "smart"]
+
+    gems_remote = `gem list slack-smart-bot --remote`
+    version_remote = gems_remote.to_s().scan(/slack-smart-bot \((\d+\.\d+\.\d+)/).join
+    version_message = ""
+    if Gem::Version.new(version_remote) > Gem::Version.new(VERSION)
+      version_message = ". There is a new available version: #{version_remote}."
+    end
+    if (!config[:silent] or ENV['BOT_SILENT'].to_s == 'false') and !config.simulate
+      ENV['BOT_SILENT'] = 'true' if config[:silent] == 'true' 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)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,8 @@
+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
+    end
+
+end

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

@@ -0,0 +1,20 @@
+def get_channels(bot_is_in: false)
+    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
+    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        
+        end
+    end
+end