slack-smart-bot 1.8.1 → 1.10.0

data/lib/slack/smart-bot/commands/general/share_messages.rb

@@ -0,0 +1,58 @@
+class SlackSmartBot
+  #todo: reaction type not added yet since RTM doesn't support it. See if we can add it as an event
+  def share_messages(user, from_channel, to_channel, condition)
+    save_stats(__method__)
+    if has_access?(__method__, user)
+      #todo: add a @shared variable to control not to be shared more than once when using reactions
+      #todo: it is only possible to share if smartbot is a member in both channels and the person adding the share command also
+      if Thread.current[:typem] == :on_call or Thread.current[:typem] == :on_dm
+        respond "You can use this command only from the source channel."
+      elsif from_channel == to_channel
+        respond "You cannot share messages on the same channel than source channel."
+      else
+        channels = get_channels(types: 'public_channel')
+        channel_found = channels.detect { |c| c.name == from_channel }
+        get_channels_name_and_id() unless @channels_id.key?(to_channel)
+        channel_found = false if !@channels_id.key?(to_channel)
+        if channel_found 
+          members = get_channel_members(@channels_id[to_channel])
+          if members.include?(config.nick_id) and members.include?(user.id)
+            if condition.match?(/^\/.+\/$/)
+              type = :regexp
+            elsif condition.match?(/^".+"$/) or condition.match?(/^'.+'$/)
+              type = :text
+            else
+              type = :reaction
+            end
+            if File.exists?("#{config.path}/shares/#{from_channel}.csv")
+              t = CSV.table("#{config.path}/shares/#{from_channel}.csv", headers: ['share_id', 'user_deleted', 'user_created', 'date', 'time', 'type', 'to_channel', 'condition'])
+              @shares[from_channel] = t
+              if t.size>0
+                num = t[:share_id].max + 1
+              else
+                num = 1
+              end
+            elsif !@shares.key?(from_channel)
+              File.open("#{config.path}/shares/#{from_channel}.csv","w")
+              t = CSV.table("#{config.path}/shares/#{from_channel}.csv", headers: ['share_id', 'user_deleted', 'user_created', 'date', 'time', 'type', 'to_channel', 'condition'])
+              num = 1
+              @shares[from_channel] = t
+            else
+              num = @shares[from_channel][:share_id].max + 1
+            end
+            values = [num, '', user.name, Time.now.strftime("%Y/%m/%d"), Time.now.strftime("%H:%M"), type.to_s, to_channel, condition]
+            @shares[from_channel] << values
+            CSV.open("#{config.path}/shares/#{from_channel}.csv", "a+") do |csv|
+              csv << values
+            end
+            respond "*Share command*: id:#{num} Messages #{condition} will be shared from now on. Related commands `see shares`, `delete share ID`"
+          else
+            respond "*Share command*: The channel ##{to_channel} need to exist and the SmartBot and you have to be members."
+          end
+        else
+          respond "*Share command*: The channel <##{@channels_id[from_channel]}|#{from_channel}> has to be a public channel and the destination channel has to be a valid channel."
+        end
+      end
+    end
+  end
+end

data/lib/slack/smart-bot/commands/general/stop_using_rules.rb

@@ -1,10 +1,13 @@
 class SlackSmartBot
   # help: ----------------------------------------------
   # help: `stop using rules from CHANNEL`
+  # help: `stop using CHANNEL`
   # help:    it will stop using the rules from the specified channel.
+  # help:    <https://github.com/MarioRuiz/slack-smart-bot#using-rules-from-other-channels|more info>
   # help:
   def stop_using_rules(dest, channel, user, dchannel)
     save_stats(__method__)
+    channel.gsub!('#','') # for the case the channel name is in plain text including #
     if @channels_id.key?(channel)
       channel_id = @channels_id[channel]
     else
@@ -12,11 +15,12 @@ class SlackSmartBot
     end
 
     if dest[0] == "C" or dest[0] == "G" #channel
-      if @rules_imported.key?(user.id) and @rules_imported[user.id].key?(dchannel)
-        if @rules_imported[user.id][dchannel] != channel_id
+      if @rules_imported.key?(user.name) and @rules_imported[user.name].key?(dchannel)
+        if @rules_imported[user.name][dchannel] != channel_id
           respond "You are not using those rules.", dest
         else
-          @rules_imported[user.id].delete(dchannel)
+          @rules_imported[user.name].delete(dchannel)
+          sleep 0.5
           update_rules_imported()
           respond "You won't be using those rules from now on.", dest
 
@@ -27,11 +31,12 @@ class SlackSmartBot
         respond "You were not using those rules.", dest
       end
     else #direct message
-      if @rules_imported.key?(user.id) and @rules_imported[user.id].key?(user.id)
-        if @rules_imported[user.id][user.id] != channel_id
+      if @rules_imported.key?(user.name) and @rules_imported[user.name].key?(user.name)
+        if @rules_imported[user.name][user.name] != channel_id
           respond "You are not using those rules.", dest
         else
-          @rules_imported[user.id].delete(user.id)
+          @rules_imported[user.name].delete(user.name)
+          sleep 0.5
           update_rules_imported()
           respond "You won't be using those rules from now on.", dest
 

data/lib/slack/smart-bot/commands/general/suggest_command.rb

@@ -0,0 +1,30 @@
+class SlackSmartBot
+
+  # help: ----------------------------------------------
+  # help: `suggest command`
+  # help: `random command`
+  # help: `command suggestion`
+  # help: `suggest rule`
+  # help: `random rule`
+  # help: `rule suggestion`
+  # help:    it will display the help content for a random command.
+  # help:    if used 'rule' then it will display a random rule.
+  # help:    if used 'command' it will show any kind of command or rule.
+  # help:
+  def suggest_command(from, dest, dchannel, specific, rules_file)
+    save_stats(__method__)
+    help_message = get_help(rules_file, dest, from, specific, true, descriptions: false, only_normal_user: true)
+    commands = help_message.gsub(/====+/,'-'*30).split(/^\s*-------*$/).flatten
+    commands.reject!{|c| c.match?(/These are specific commands for this bot on this/i) || c.match?(/\A\s*\z/)}
+    @last_suggested_commands ||= []
+    @last_suggested_commands.shift if @last_suggested_commands.size >=5
+    command = ''
+    begin 
+      command = commands.sample
+    end until !@last_suggested_commands.include?(command) or commands.size <= 5
+    @last_suggested_commands << command
+    message = "*Command suggestion*:\n#{command}"
+    respond message, dest, unfurl_links: false, unfurl_media: false
+  end
+
+end

data/lib/slack/smart-bot/commands/general/use_rules.rb

@@ -6,26 +6,22 @@ class SlackSmartBot
   # help: `use CHANNEL`
   # help:    it will use the rules from the specified channel.
   # help:    you need to be part of that channel to be able to use the rules.
+  # help:    <https://github.com/MarioRuiz/slack-smart-bot#using-rules-from-other-channels|more info>
   # help:
   def use_rules(dest, channel, user, dchannel)
     save_stats(__method__)
     get_bots_created()
-    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)
       #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.gsub!('#','') # for the case the channel name is in plain text including #
+      channel = @channels_name[channel] if @channels_name.key?(channel)
       channel_found = channels.detect { |c| c.name == channel }
-      members = client.web_client.conversations_members(channel: @channels_id[channel]).members unless channel_found.nil?
+      get_channels_name_and_id() unless @channels_id.key?(channel)
+      members = get_channel_members(@channels_id[channel]) unless channel_found.nil? or !@channels_id.key?(channel)
 
-      if channel_found.nil?
-        respond "The channel you are trying to use doesn't exist", dest
+      if channel_found.nil? or !@channels_id.key?(channel)
+        respond "The channel you are trying to use doesn't exist or cannot be found.", dest
       elsif channel_found.name == config.master_channel
         respond "You cannot use the rules from Master Channel on any other channel.", dest
       elsif !@bots_created.key?(@channels_id[channel])
@@ -34,12 +30,13 @@ class SlackSmartBot
         respond "The bot in that channel is not :on", dest
       else
         if user.id == channel_found.creator or members.include?(user.id)
-          @rules_imported[user.id] = {} unless @rules_imported.key?(user.id)
+          @rules_imported[user.name] = {} unless @rules_imported.key?(user.name)
           if dest[0] == "C" or dest[0] == "G" #todo: take in consideration bots that are not master
-            @rules_imported[user.id][dchannel] = channel_found.id
+            @rules_imported[user.name][dchannel] = channel_found.id
           else
-            @rules_imported[user.id][user.id] = channel_found.id
+            @rules_imported[user.name][user.name] = channel_found.id
           end
+          sleep 0.5
           update_rules_imported()
           respond "I'm using now the rules from <##{channel_found.id}>", dest
 

data/lib/slack/smart-bot/commands/general/whats_new.rb

@@ -0,0 +1,19 @@
+class SlackSmartBot
+
+    # help: ----------------------------------------------
+    # help: `What's new`
+    # help:    It will display the last user changes on Slack Smart Bot
+    # help:
+    def whats_new(user, dest, dchannel, from, display_name)
+      if @status == :on
+        save_stats(__method__)
+        whats_new_file = (__FILE__).gsub(/lib\/slack\/smart-bot\/commands\/general\/whats_new\.rb$/, "whats_new.txt")
+        whats_new = File.read(whats_new_file)
+        whats_new.split(/^\-\-\-\-\-\-+$/).each do |msg|
+            respond msg
+            sleep 0.3
+        end
+      end
+    end
+  end
+  

data/lib/slack/smart-bot/commands/general_bot_commands.rb

@@ -0,0 +1,243 @@
+# add here the general commands you will be using in any channel where The SmartBot is part of. Not necessary to use ! or ^, it will answer directly.
+def general_bot_commands(user, command, dest, files = [])
+    
+  begin
+    if config.simulate
+      display_name = user.profile.display_name
+    else
+      if user.profile.display_name.to_s.match?(/\A\s*\z/)
+        user.profile.display_name = user.profile.real_name
+      end
+      display_name = user.profile.display_name
+    end
+
+    case command
+
+
+      # help: ----------------------------------------------
+      # help: `bot help`
+      # help: `bot help COMMAND`
+      # help: `bot rules`
+      # help: `bot rules COMMAND`
+      # help: `bot help expanded`
+      # help: `bot rules expanded`
+      # help: `bot what can I do?`
+      # help:    it will display this help. For a more detailed help call `bot help expanded` or `bot rules expanded`.
+      # help:    if COMMAND supplied just help for that command
+      # help:    you can use the option 'expanded' or the alias 'extended'
+      # help:    `bot rules` will show only the specific rules for this channel.
+      # help:    <https://github.com/MarioRuiz/slack-smart-bot#bot-help|more info>
+      # help:
+
+
+      # help: ----------------------------------------------
+      # help: `Hi Bot`
+      # help: `Hi Smart`
+      # help: `Hello Bot` `Hola Bot` `Hallo Bot` `What's up Bot` `Hey Bot` `Hæ Bot`
+      # help: `Hello THE_NAME_OF_THE_BOT`
+      # help:    Bot starts listening to you if you are on a Bot channel
+      # help:    After that if you want to avoid a single message to be treated by the smart bot, start the message by -
+      # help:    Also apart of Hello you can use _Hallo, Hi, Hola, What's up, Hey, Hæ_
+      # help:    <https://github.com/MarioRuiz/slack-smart-bot#how-to-access-the-smart-bot|more info>
+      # help:
+      when /\A\s*(Hello|Hallo|Hi|Hola|What's\sup|Hey|Hæ)\s+(#{@salutations.join("|")})\s*$/i
+          hi_bot(user, dest, user.name, display_name)
+
+      # help: ----------------------------------------------
+      # help: `Bye Bot`
+      # help: `Bye Smart`
+      # help: `Bye NAME_OF_THE_BOT`
+      # help:    Bot stops listening to you if you are on a Bot channel
+      # help:    Also apart of Bye you can use _Bæ, Good Bye, Adiós, Ciao, Bless, Bless Bless, Adeu_
+      # help:    <https://github.com/MarioRuiz/slack-smart-bot#how-to-access-the-smart-bot|more info>
+      # help:
+      when /\A\s*(Bye|Bæ|Good\s+Bye|Adiós|Ciao|Bless|Bless\sBless|Adeu)\s+(#{@salutations.join("|")})\s*$/i
+          bye_bot(dest, user.name, display_name)
+
+        # help: ----------------------------------------------
+        # help: `add announcement MESSAGE`
+        # help: `add red announcement MESSAGE`
+        # help: `add green announcement MESSAGE`
+        # help: `add yellow announcement MESSAGE`
+        # help: `add white announcement MESSAGE`
+        # help: `add EMOJI announcement MESSAGE`
+        # help:     It will store the message on the announcement list labeled with the color or emoji specified, white by default.
+        # help:        aliases for announcement: statement, declaration, message
+        # help:  Examples:
+        # help:     _add green announcement :heavy_check_mark: All customer services are up and running_
+        # help:     _add red declaration Customers db is down :x:_
+        # help:     _add yellow statement Don't access the linux server without VPN_
+        # help:     _add message `*Party* will start at *20:00* :tada:`_
+        # help:     _add :heavy_exclamation_mark: message Pay attention all DB are on maintenance until 20:00 GMT_
+        # help:    <https://github.com/MarioRuiz/slack-smart-bot#announcements|more info>
+        # help: 
+      when /\A\s*(add|create)\s+(red\s+|green\s+|white\s+|yellow\s+)?(announcement|statement|declaration|message)\s+(.+)\s*\z/i,
+        /\A\s*(add|create)\s+(:\w+:)\s+(announcement|statement|declaration|message)\s+(.+)\s*\z/i
+        type = $2.to_s.downcase.strip
+        type = 'white' if type == ''
+        message = $4
+        add_announcement(user, type, message)
+        
+
+        # help: ----------------------------------------------
+        # help: `delete announcement ID`
+        # help:     It will delete the message on the announcement list.
+        # help:        aliases for announcement: statement, declaration, message
+        # help:  Examples:
+        # help:     _delete announcement 24_
+        # help:     _delete message 645_
+        # help:     _delete statement 77_
+        # help:     _delete declaration 334_
+        # help:    <https://github.com/MarioRuiz/slack-smart-bot#announcements|more info>
+        # help: 
+      when /\A\s*(delete|remove)\s+(announcement|statement|declaration|message)\s+(\d+)\s*\z/i
+        message_id = $3
+        delete_announcement(user, message_id)
+
+        # help: ----------------------------------------------
+        # help: `see announcements`
+        # help: `see red announcements`
+        # help: `see green announcements`
+        # help: `see yellow announcements`
+        # help: `see white announcements`
+        # help: `see EMOJI announcements`
+        # helpmaster: `see announcements #CHANNEL`
+        # helpmaster: `see all announcements`
+        # help:     It will display the announcements for the channel.
+        # help:        aliases for announcements: statements, declarations, messages
+        # helpmaster:        In case #CHANNEL it will display the announcements for that channel. Only master admins can use it from a DM with the Smartbot.
+        # helpmaster:        In case 'all' it will display all the announcements for all channels. Only master admins can use it from a DM with the Smartbot.
+        # help:  Examples:
+        # help:     _see announcements_
+        # help:     _see white messages_
+        # help:     _see red statements_
+        # help:     _see yellow declarations_
+        # help:     _see messages_
+        # help:     _see :heavy_exclamation_mark: messages_
+        # help:    <https://github.com/MarioRuiz/slack-smart-bot#announcements|more info>
+        # help: 
+      when /\A\s*see\s+(red\s+|green\s+|white\s+|yellow\s+|:\w+:\s+)?(announcements|statements|declarations|messages)()\s*\z/i,
+        /\A\s*see\s+(all\s+)?(announcements|statements|declarations|messages)()\s*\z/i,
+        /\A\s*see\s+(red\s+|green\s+|white\s+|yellow\s+|:\w+:\s+)?(announcements|statements|declarations|messages)\s+#([\w\-]+)\s*\z/i,
+        /\A\s*see\s+(red\s+|green\s+|white\s+|yellow\s+|:\w+:\s+)?(announcements|statements|declarations|messages)\s+<#(C\w+)\|.*>\s*\z/i
+
+        type = $1.to_s.downcase.strip
+        channel = $3.to_s
+
+        see_announcements(user, type, channel)
+
+
+        # help: ----------------------------------------------
+        # help: `share messages /REGEXP/ on #CHANNEL`
+        # help: `share messages "TEXT" on #CHANNEL`
+        # xhelp: `share messages :EMOJI: on #CHANNEL`
+        # help:     It will automatically share new messages published that meet the specified criteria.
+        # xhelp:     In case :EMOJI: it will share the messages with the indicated reaction.
+        # help:     SmartBot user and user adding the share need to be members on both channels.
+        # help:     The Regexp will automatically add the parameters /im
+        # help:     Only available on public channels.
+        # help:  Examples:
+        # help:     _share messages /(last\s+|previous\s+)?sales\s+results\s+/ on #sales_
+        # help:     _share messages "share post" on #announcements_
+        # xhelp:     _share messages :tada: on #announcements_
+        # xhelp:     _share messages :moneybag: from #sales_
+        # help:    <https://github.com/MarioRuiz/slack-smart-bot#share-messages|more info>
+        # help: 
+      when /\A\s*share\s+messages\s+(\/.+\/|".+"|'.+')\s+on\s+<#\w+\|(.+)>\s*\z/i,
+        /\A\s*share\s+messages\s+(\/.+\/|".+"|'.+')\s+on\s+<#(\w+)\|>\s*\z/,
+        /\A\s*share\s+messages\s+(\/.+\/|".+"|'.+')\s+on\s+(.+)\s*\z/i
+        condition = $1
+        channel = $2
+        channel.gsub!('#','') # for the case the channel name is in plain text including #
+        channel = @channels_name[channel] if @channels_name.key?(channel)
+        channel_from = @channels_name[dest]
+        channel_to = channel
+        share_messages(user, channel_from, channel_to, condition)
+
+        # help: ----------------------------------------------
+        # help: `see shares`
+        # help:     It will display the active shares from this channel.
+        # help:    <https://github.com/MarioRuiz/slack-smart-bot#share-messages|more info>
+        # help: 
+      when /\A\s*see\s+shares\s*\z/i
+        see_shares()
+
+        # help: ----------------------------------------------
+        # help: `delete share ID`
+        # help:     It will delete the share id specified.
+        # help:  Examples:
+        # help:     _delete share 24_
+        # help:    <https://github.com/MarioRuiz/slack-smart-bot#share-messages|more info>
+        # help: 
+      when /\A\s*(delete|remove)\s+share\s+(\d+)\s*\z/i
+        share_id = $2
+        delete_share(user, share_id)
+
+        # help: ----------------------------------------------
+        # help: `see statuses`
+        # help: `see statuses #CHANNEL`
+        # help: `see status EMOJI`
+        # help: `see status EMOJI #CHANNEL`
+        # help: `see status EMOJI1 EMOJI99`
+        # help: `who is on vacation?`
+        # help: `who is on EMOJI`
+        # help: `who is on EMOJI #CHANNEL`
+        # help: `who is on EMOJI1 EMOJI99`
+        # help: `who is not on vacation?`
+        # help: `who is not on EMOJI`
+        # help:     It will display the current statuses of the members of the channel where you are calling the command or on the channel you supply.
+        # help:    <https://github.com/MarioRuiz/slack-smart-bot#see-statuses|more info>
+        # help: 
+      when /\A\s*(see|get)\s+(statuses)()\s*\z/i,
+        /\A\s*(see\s+status|get\s+status|who\s+is\s+on|who\s+is\s+not\s+on)\s+(:[\w\-\:\s]+:)\s*\??()\s*\z/i,
+        /\A\s*(who\s+is\s+on|who\s+is\s+not\s+on)\s+(vacation|holiday)\s*\??()\s*\z/i,
+        /\A\s*(see|get)\s+(statuses)\s+#([\w\-]+)\s*\z/i,
+        /\A\s*(see\s+status|get\s+status|who\s+is\s+on|who\s+is\s+not\s+on)\s+(:[\w\-\:\s]+:)\s*\??\s+#([\w\-]+)\s*\z/i,
+        /\A\s*(who\s+is\s+on|who\s+is\s+not\s+on)\s+(vacation|holiday)\s*\??\s+#([\w\-]+)\s*\z/i,
+        /\A\s*(see|get)\s+(statuses)\s+<#(C\w+)\|.+>\s*\z/i,
+        /\A\s*(see\s+status|get\s+status|who\s+is\s+on|who\s+is\s+not\s+on)\s+(:[\w\-\:\s]+:)\s*\??\s+<#(C\w+)\|.+>\s*\z/i,
+        /\A\s*(who\s+is\s+on|who\s+is\s+not\s+on)\s+(vacation|holiday)\s*\??\s+<#(C\w+)\|.+>\s*\z/i
+
+        not_on = $1.match?(/who\s+is\s+not\s+on/i)
+        type = $2.downcase
+        channel = $3.to_s
+        if type == 'statuses'
+          types = []
+        elsif type =='vacation' or type == 'holiday'
+          types = [':palm_tree:']
+        else
+          type.gsub!(' ', '')
+          type.gsub!('::',': :')
+          types = type.split(' ')
+        end
+        see_statuses(user, channel, types, dest, not_on)
+
+
+        # help: ----------------------------------------------
+        # help: `see favorite commands`
+        # help: `see my favorite commands`
+        # help: `favorite commands`
+        # help: `my favorite commands`
+        # help:     It will display the favorite commands.
+        # help:     aliases for favorite: favourite, most used, fav
+        # helpmaster:    You need to set stats to true to generate the stats when running the bot instance and get this info.
+        # help:    <https://github.com/MarioRuiz/slack-smart-bot#see-favorite-commands|more info>
+        # help: 
+      when /\A\s*(see\s+)?(my\s+)?(fav|favorite|favourite|most\s+used)\s+commands\s*\z/i
+        only_mine = $2.to_s!=''
+        see_favorite_commands(user, only_mine)
+
+    else
+      return false
+    end
+    return true
+  rescue => exception
+    if defined?(@logger)
+      @logger.fatal exception
+      respond "Unexpected error!! Please contact an admin to solve it: <@#{config.admins.join(">, <@")}>"
+    else
+      puts exception
+    end
+    return false
+  end
+end