slack-smart-bot 1.5.1 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 031aceba04e6017cd314ba2be33d0e6cee0326e74f2301ef17da4ea5e932f315
-  data.tar.gz: 3dc24d0bcf047d2cdab12f8d9dde3ee3f2b4817ce9f94264057fce54ea95f00a
+  metadata.gz: b243575f1dce8d61e387199037a62b2a1fb7eea2fb578981b1b82c18adb76393
+  data.tar.gz: 2890ce0402d1a23b2fb2f8710bd9bedc25412a9b4a9f1dc23f614f06b507f4f3
 SHA512:
-  metadata.gz: 9f067e911e6748530944a0ec7534e54bd631c3549404cd3dd8b6d9ab69c004a8af7318916f68a0bc4e74289abc5f51d9b785147fdb275bc627e46abdd714f988
-  data.tar.gz: 7cac3469e1320b94a4777c48069033b6b0e53d33f1c800b8fb0bed43b93ff4e82a03ce89ee59c158a94ad0964e76544f7a3d4c1af0091787ba6d0dfd241f7d2a
+  metadata.gz: 5d3da033e26a6660a976ae408e5620bd63a389feb8d458f68f4e52a4b6e1256be98cb80a386729e01baf269e85ecaa54e150cbb565df37246c6dbb5c8892da10
+  data.tar.gz: 4741d4dd84e4542ecf1682117ee6fb5cf2d6547070364e4cb4d882154008180191279b2691b02945bd8e5503fbc5973156a202bec45a0f8875c992dea6f3fa5c

data/README.md

@@ -22,9 +22,11 @@ slack-smart-bot can create bots on demand, create shortcuts, run ruby code... ju
   * [Extending rules to other channels](#extending-rules-to-other-channels)
   * [Using rules from other channels](#using-rules-from-other-channels)
   * [Running Ruby code on a conversation](#running-ruby-code-on-a-conversation)
+    + [REPL](#repl)
   * [Sending notifications](#sending-notifications)
   * [Shortcuts](#shortcuts)
   * [Routines](#routines)
+  * [Limit who has access to a command](#limit-who-has-access-to-a-command)
   * [Tips](#tips)
     + [Send a file](#send-a-file)
     + [Download a file](#download-a-file)
@@ -164,7 +166,7 @@ You can access the bot directly on the MASTER CHANNEL, on a secondary channel wh
 
 On a Smart Bot channel you will be able to run some of the commands just by writing a command, for example: **_`bot help`_**
 
-Some commands will be only available when the Smart Bot is listening to you. For the Smart Bot to start listening to you just say: **_`hi bot`_**. When the Smart Bot is listening to you, you can skip a message to be treated by the bot by starting the message with '-', for example: **_`- this message won't be treated`_**. When you want the Smart Bot Stop listening to you: **_`bye bot`_**. If you are on a direct conversation with the Smart Bot then it will be on *listening* mode all the time.
+Some commands will be only available when the Smart Bot is listening to you. For the Smart Bot to start listening to you just say: **_`hi bot`_**. When the Smart Bot is listening to you, you can skip a message to be treated by the bot by starting the message with '-', for example: **_`-this message won't be treated`_**. When you want the Smart Bot Stop listening to you: **_`bye bot`_**. The Smart Bot will automatically stop listening to you after 30 minutes of inactivity. If you are on a direct conversation with the Smart Bot then it will be on *listening* mode all the time.
 
 All the specific commands of the bot are specified on your rules file and can be added or changed accordingly. We usually call those commands: *rules*. Those rules are only available when the bot is listening to you.
 
@@ -285,6 +287,62 @@ Example:
 
 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.
 
+#### 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.
+
+It Will run all we write as a ruby command and will keep the session values until we finish the session sending `quit`, `exit` or `bye` 
+
+You can specify a SESSION_NAME that admits from a to Z, numbers, - and _. If no SESSION_NAME supplied it will be treated as a temporary REPL.
+If 'private' specified in the command the REPL will be accessible only by you and it will be displayed only to you when `see repls`
+
+To avoid a message to be treated when a session started, start the message with '-'.
+
+Send puts, print, p or pp if you want to print out something when using `run repl` later.
+
+If you declare on your rules file a method called `project_folder` returning the path for the project folder, the code will be executed from that folder. 
+
+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`
+
+If you want to see the methods of a class or module you created use `ls TheModuleOrClass`
+
+You can supply the Environmental Variables you need for the Session
+
+Examples:  
+  _repl CreateCustomer LOCATION=spain HOST='https://10.30.40.50:8887'_  
+  _repl CreateCustomer: "It creates a random customer for testing" LOCATION=spain HOST='https://10.30.40.50:8887'_  
+  _repl delete\_logs_  
+  _private repl random-ssn_  
+  _repl_
+
+
+Running Example:
+>**_Peter>_** `!repl Create10RandomUsers: "This is just an example"`  
+>**_Smart-Bot>_** `Session name: *Create10RandomUsers*`  
+>**_Peter>_** `http = NiceHttp.new("https://reqres.in/")`  
+>**_Smart-Bot>_** `#<NiceHttp:0x00007fc6e216e328 @host="reqres.in", @port=443...>`  
+>**_Peter>_** `request = { path: '/api/users' }`  
+>**_Smart-Bot>_** `{ :path => "/api/users" }`  
+>**_Peter>_** `request.data = { name: '1-10:L', job: 'leader|worker' }`  
+>**_Smart-Bot>_** `{ :name => "1-10:L", :job => "leader|worker" }`  
+>**_Peter>_** `request.data.generate`  
+>**_Smart-Bot>_** `{ :name => "kLam", :job => "leader" }`  
+>**_Peter>_** `10.times { http.post(request.generate) } `  
+>**_Smart-Bot>_** `10`  
+>**_Peter>_** `puts "10 Random Users Created"`  
+>**_Smart-Bot>_** `10 Random Users Created`  
+>**_Peter>_** `quit`  
+>**_Smart-Bot>_** `REPL session finished: Create10RandomUsers`  
+
+
+>**_Peter>_** `run repl Create10RandomUsers`  
+>**_Smart-Bot>_** `Running REPL Create10RandomUsers`  
+>**_Smart-Bot>_** `Create10RandomUsers: 10 Random Users Created`  
+
+
+Other REPL commands: `see repls`, `run repl SESSION_NAME ENV_VAR=value`, `get repl SESSION_NAME`, `delete repl SESSION_NAME`
+
 ### Sending notifications
 You can send notifications from MASTER CHANNEL by using **_`notify MESSAGE`_**. All Bot Channels will be notified.
 
@@ -340,6 +398,35 @@ Other routine commands:
 * **_`run routine NAME`_**
 * **_`see routines`_**
 
+### Limit who has access to a command
+
+If you want to define who has access to certain commands you can specify it on the settings when starting the Smart Bot:
+
+```ruby
+settings = {
+    # the channel that will act like the master channel, main channel
+    master_channel: 'my_master_channel',
+    masters: ["mario"], #names of the master users
+    token: 'xxxxxxxxxxxxxxxxxx', # the API Slack token
+    allow_access: {
+      repl: [ 'marioruiz', 'peterlondon', 'UMYAAS8E7F'],
+      ruby_code: [ 'marioruiz', 'UMYAAS8E7F', 'samcooke']
+    }
+}
+```
+You can use the user name or the user id.
+
+If you want to change who has access to a certain command without restarting the Smart Bot you can do it on the rules file:
+
+```ruby
+config.allow_access.repl = ['marioruiz', 'samcooke']
+```
+
+These are the commands that are possible to be limited:
+
+`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`
+
+
 ### Tips
 
 #### Send a file
@@ -358,7 +445,7 @@ When uploading a file the message added to 'Add a message about the file' will b
     when /^do something with my file/i
       if !files.nil? and files.size == 1 and files[0].filetype == 'yaml'
         require 'nice_http'
-        http = NiceHttp.new(host: "https://files.slack.com", headers: { "Authorization" => "Bearer #{config[:token]}" })
+        http = NiceHttp.new(host: "https://files.slack.com", headers: { "Authorization" => "Bearer #{config.token}" })
         res = http.get(files[0].url_private_download, save_data: './tmp/')
         # if you want to directly access to the content use: `res.data`
       end

data/lib/slack-smart-bot.rb

@@ -46,6 +46,7 @@ class SlackSmartBot
     config[:testing] = false unless config.key?(:testing)
     config[:simulate] = false unless config.key?(:simulate)
     config[:stats] = false unless config.key?(:stats)
+    config[:allow_access] = Hash.new unless config.key?(:allow_access)
 
     if config.path.to_s!='' and config.file.to_s==''
       config.file = File.basename($0)
@@ -143,13 +144,14 @@ class SlackSmartBot
       end
     end
 
-    @listening = Array.new
+    @listening = Hash.new()
 
     @bots_created = Hash.new()
     @shortcuts = Hash.new()
     @shortcuts[:all] = Hash.new()
     @rules_imported = Hash.new()
     @routines = Hash.new()
+    @repls = Hash.new()
 
     if File.exist?("#{config.path}/shortcuts/#{config.shortcuts_file}")
       file_sc = IO.readlines("#{config.path}/shortcuts/#{config.shortcuts_file}").join
@@ -159,6 +161,7 @@ class SlackSmartBot
     end
 
     get_routines()
+    get_repls()
 
     if config.on_master_bot and File.exist?(config.file_path.gsub(".rb", "_bots.rb"))
       get_bots_created()
@@ -221,6 +224,7 @@ class SlackSmartBot
 
     @status = config.status_init
     @questions = Hash.new()
+    @repl_sessions = Hash.new()
     @channels_id = Hash.new()
     @channels_name = Hash.new()
     get_channels_name_and_id()
@@ -228,6 +232,7 @@ class SlackSmartBot
     @master_bot_id = @channels_id[config.master_channel].dup
 
     get_routines()
+    get_repls()
     if @routines.key?(@channel_id)
       @routines[@channel_id].each do |k, v|
         @routines[@channel_id][k][:running] = false

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

@@ -2,6 +2,11 @@ require_relative "commands/general/hi_bot"
 require_relative "commands/general/bye_bot"
 require_relative "commands/general/bot_help"
 require_relative "commands/on_bot/ruby_code"
+require_relative "commands/on_bot/repl"
+require_relative "commands/on_bot/get_repl"
+require_relative "commands/on_bot/run_repl"
+require_relative "commands/on_bot/delete_repl"
+require_relative "commands/on_bot/see_repls"
 require_relative "commands/general/use_rules"
 require_relative "commands/general/stop_using_rules"
 require_relative "commands/on_master/admin_master/exit_bot"

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

@@ -12,59 +12,63 @@ class SlackSmartBot
   # help:
   def bot_help(user, from, dest, dchannel, specific, help_command, rules_file)
     save_stats(__method__)
-    help_found = false
+    if config[:allow_access].key?(__method__) and !config[:allow_access][__method__].include?(user.name) and !config[:allow_access][__method__].include?(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
+      help_found = false
 
-    message = ""
+      message = ""
 
-    help_message = get_help(rules_file, dest, from, specific)
+      help_message = get_help(rules_file, dest, from, specific)
 
-    if help_command.to_s != ""
-      help_message.gsub(/====+/,'-'*30).split(/^\s*-------*$/).each do |h|
-        if h.match?(/[`_]#{help_command}/i)
-          respond h, dest
-          help_found = true
+      if help_command.to_s != ""
+        help_message.gsub(/====+/,'-'*30).split(/^\s*-------*$/).each do |h|
+          if h.match?(/[`_]#{help_command}/i)
+            respond h, dest
+            help_found = true
+          end
         end
-      end
-    else
-      if Thread.current[:using_channel]!=''
-        message = "*You are using rules from another channel: <##{Thread.current[:using_channel]}>. These are the specific commands for that channel:*"
-      end
-      respond message, dest
-    end
-
-    if (help_command.to_s == "")
-      help_message.split(/^\s*=========*$/).each do |h|
-        respond("#{"=" * 35}\n#{h}", dest) unless h.match?(/\A\s*\z/)
-      end
-    else
-      unless help_found
-        if specific
-          respond("I didn't find any rule starting by `#{help_command}`", dest)
-        else
-          respond("I didn't find any command starting by `#{help_command}`", dest)
+      else
+        if Thread.current[:using_channel]!=''
+          message = "*You are using rules from another channel: <##{Thread.current[:using_channel]}>. These are the specific commands for that channel:*"
         end
+        respond message, dest
       end
-    end
 
-    if specific
-      unless rules_file.empty?
-        begin
-          eval(File.new(config.path + rules_file).read) if File.exist?(config.path + rules_file)
+      if (help_command.to_s == "")
+        help_message.split(/^\s*=========*$/).each do |h|
+          respond("#{"=" * 35}\n#{h}", dest) unless h.match?(/\A\s*\z/)
         end
-      end
-      if defined?(git_project) && (git_project.to_s != "") && (help_command.to_s == "")
-        respond "Git project: #{git_project}", dest
       else
-        def git_project
-          ""
+        unless help_found
+          if specific
+            respond("I didn't find any rule starting by `#{help_command}`", dest)
+          else
+            respond("I didn't find any command starting by `#{help_command}`", dest)
+          end
         end
+      end
+
+      if specific
+        unless rules_file.empty?
+          begin
+            eval(File.new(config.path + rules_file).read) if File.exist?(config.path + rules_file)
+          end
+        end
+        if defined?(git_project) && (git_project.to_s != "") && (help_command.to_s == "")
+          respond "Git project: #{git_project}", dest
+        else
+          def git_project
+            ""
+          end
 
-        def project_folder
-          ""
+          def project_folder
+            ""
+          end
         end
+      elsif help_command.to_s == ""
+        respond "Slack Smart Bot Github project: https://github.com/MarioRuiz/slack-smart-bot", dest
       end
-    elsif help_command.to_s == ""
-      respond "Slack Smart Bot Github project: https://github.com/MarioRuiz/slack-smart-bot", dest
     end
   end
 end

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

@@ -4,38 +4,42 @@ class SlackSmartBot
   # helpadmin:    Displays the status of the bot
   # helpadmin:    If on master channel and admin user also it will display info about bots created
   # helpadmin:
-  def bot_status(dest, from)
+  def bot_status(dest, user)
     save_stats(__method__)
     get_bots_created()
-    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
-    require "socket"
-    ip_address = Socket.ip_address_list.find { |ai| ai.ipv4? && !ai.ipv4_loopback? }.ip_address
-    respond "*#{Socket.gethostname} (#{ip_address})*\n\tStatus: #{@status}.\n\tVersion: #{VERSION}.#{version_message}\n\tRules file: #{File.basename config.rules_file}\n\tExtended: #{@bots_created[@channel_id][:extended] unless config.on_master_bot}\n\tAdmins: #{config.admins}\n\tBot time: #{Time.now}", dest
-    if @status == :on
-      respond "I'm listening to [#{@listening.join(", ")}]", dest
-      if config.on_master_bot and config.admins.include?(from)
-        sleep 5
-        @bots_created.each do |k, v|
-          msg = []
-          msg << "`#{v[:channel_name]}` (#{k}):"
-          msg << "\tcreator: #{v[:creator_name]}"
-          msg << "\tadmins: #{v[:admins]}"
-          msg << "\tstatus: #{v[:status]} #{" *(not responded)*" unless @pings.include?(v[:channel_name])}"
-          msg << "\tcreated: #{v[:created]}"
-          msg << "\trules: #{v[:rules_file]}"
-          msg << "\textended: #{v[:extended]}"
-          msg << "\tcloud: #{v[:cloud]}"
-          if config.on_master_bot and v.key?(:cloud) and v[:cloud]
-            msg << "\trunner: `ruby #{config.file} \"#{v[:channel_name]}\" \"#{v[:admins]}\" \"#{v[:rules_file]}\" on&`"
+    if config[:allow_access].key?(__method__) and !config[:allow_access][__method__].include?(user.name) and !config[:allow_access][__method__].include?(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
+      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
+      require "socket"
+      ip_address = Socket.ip_address_list.find { |ai| ai.ipv4? && !ai.ipv4_loopback? }.ip_address
+      respond "*#{Socket.gethostname} (#{ip_address})*\n\tStatus: #{@status}.\n\tVersion: #{VERSION}.#{version_message}\n\tRules file: #{File.basename config.rules_file}\n\tExtended: #{@bots_created[@channel_id][:extended] unless config.on_master_bot}\n\tAdmins: #{config.admins}\n\tBot time: #{Time.now}", dest
+      if @status == :on
+        respond "I'm listening to [#{@listening.keys.join(", ")}]", dest
+        if config.on_master_bot and config.admins.include?(user.name)
+          sleep 5
+          @bots_created.each do |k, v|
+            msg = []
+            msg << "`#{v[:channel_name]}` (#{k}):"
+            msg << "\tcreator: #{v[:creator_name]}"
+            msg << "\tadmins: #{v[:admins]}"
+            msg << "\tstatus: #{v[:status]} #{" *(not responded)*" unless @pings.include?(v[:channel_name])}"
+            msg << "\tcreated: #{v[:created]}"
+            msg << "\trules: #{v[:rules_file]}"
+            msg << "\textended: #{v[:extended]}"
+            msg << "\tcloud: #{v[:cloud]}"
+            if config.on_master_bot and v.key?(:cloud) and v[:cloud]
+              msg << "\trunner: `ruby #{config.file} \"#{v[:channel_name]}\" \"#{v[:admins]}\" \"#{v[:rules_file]}\" on&`"
+            end
+            respond msg.join("\n"), dest
           end
-          respond msg.join("\n"), dest
+          @pings = []
         end
-        @pings = []
       end
     end
   end

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

@@ -12,7 +12,15 @@ class SlackSmartBot
       save_stats(__method__)
       bye = ["Bye", "Bæ", "Good Bye", "Adiós", "Ciao", "Bless", "Bless bless", "Adeu"].sample
       respond "#{bye} #{display_name}", dest
-      @listening.delete(from)
+
+      if @listening.key?(from)
+        if Thread.current[:on_thread]
+          @listening[from].delete(Thread.current[:thread_ts])
+        else
+          @listening[from].delete(dest)
+        end
+        @listening.delete(from) if @listening[from].empty?
+      end
     end
   end
 end

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

@@ -17,7 +17,12 @@ class SlackSmartBot
       if Thread.current[:using_channel]!=''
         respond "You are using specific rules for channel: <##{Thread.current[:using_channel]}>", dest
       end
-      @listening << from unless @listening.include?(from)
+      @listening[from] = {} unless @listening.key?(from)
+      if Thread.current[:on_thread]
+        @listening[from][Thread.current[:thread_ts]] = Time.now
+      else
+        @listening[from][dest] = Time.now
+      end
     end
   end
 end

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

@@ -10,39 +10,43 @@ class SlackSmartBot
   def use_rules(dest, channel, user, dchannel)
     save_stats(__method__)
     get_bots_created()
-    #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
+    if config[:allow_access].key?(__method__) and !config[:allow_access][__method__].include?(user.name) and !config[:allow_access][__method__].include?(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
+      #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
 
-    channel_found = channels.detect { |c| c.name == channel }
-    members = client.web_client.conversations_members(channel: @channels_id[channel]).members unless channel_found.nil?
+      channel_found = channels.detect { |c| c.name == channel }
+      members = client.web_client.conversations_members(channel: @channels_id[channel]).members unless channel_found.nil?
 
-    if channel_found.nil?
-      respond "The channel you are trying to use doesn't exist", 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])
-      respond "There is no bot running on that channel.", dest
-    elsif @bots_created.key?(@channels_id[channel]) and @bots_created[@channels_id[channel]][:status] != :on
-      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)
-        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
+      if channel_found.nil?
+        respond "The channel you are trying to use doesn't exist", 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])
+        respond "There is no bot running on that channel.", dest
+      elsif @bots_created.key?(@channels_id[channel]) and @bots_created[@channels_id[channel]][:status] != :on
+        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)
+          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
+          else
+            @rules_imported[user.id][user.id] = channel_found.id
+          end
+          update_rules_imported()
+          respond "I'm using now the rules from <##{channel_found.id}>", dest
+
+          def git_project() "" end
+          def project_folder() "" end
         else
-          @rules_imported[user.id][user.id] = channel_found.id
+          respond "You need to join the channel <##{channel_found.id}> to be able to use the rules.", dest
         end
-        update_rules_imported()
-        respond "I'm using now the rules from <##{channel_found.id}>", dest
-
-        def git_project() "" end
-        def project_folder() "" end
-      else
-        respond "You need to join the channel <##{channel_found.id}> to be able to use the rules.", dest
       end
     end
   end