slack-smart-bot 0.9.4 → 0.9.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4f525626c08342efb47771ac63104863aee616dfe45b428f09c48be94d855cd0
-  data.tar.gz: 8cf17f028da036a7b15c418b13a5e7f8011bb3359b15b8a1d02c88e6962cb379
+  metadata.gz: ce07df2e804e969dd1b1b290444c144e4ebcc753eb438584f2106a21080db797
+  data.tar.gz: cd7ed3bc70ed721a7e8661a664c8875ff148a643fedf5e594f5bb624273d7645
 SHA512:
-  metadata.gz: 4f6b5afdcfc4cfc199e272a4f0723865d4e68dd9e4242d73d88a3f8d4051575aca028bf53215b0261243743b00f7f467842f484f423daa2a0407cb69ccde59ed
-  data.tar.gz: c652cdad1b97ab090131f9baf3a9f5f4f6796a8a751052285f38329a390fc8d601dc4170acaefc18479593e8359724212d17cc2b589e1fcabe68103b15d87e81
+  metadata.gz: 65f819cb1c85ef79445d096db1964b8986acb3d227b0ba1aa01d0af9af89d665b48e054a770af47f14bb61aac26e4cf5cf1dd32295d0f650181c0027af0a89fd
+  data.tar.gz: 01ba1e3085060d40267a492170d099739f61f61a64ad2ef2868c502366ca1d10c07c7059cd86da0addd71fc9c07f028087c852a7cf2d086363ee0eb41084e3b5

data/README.md

@@ -8,6 +8,23 @@ 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.
 
+# Table of Contents
+
+- [Installation and configuration](#installation-and-configuration)
+- [Usage](#usage)
+  * [creating the MASTER BOT](#creating-the-master-bot)
+  * [How to access the smart bot](#how-to-access-the-smart-bot)
+  * [Available commands even when the bot is not listening to you](#available-commands-even-when-the-bot-is-not-listening-to-you)
+  * [Available commands only when listening to you or on demand or in a private conversation with the Smart Bot](#available-commands-only-when-listening-to-you-or-on-demand-or-in-a-private-conversation-with-the-smart-bot)
+  * [Available commands from channels without a Smart Bot](#available-commands-from-channels-without-a-smart-bot)
+  * [Creating cloud bots](#creating-cloud-bots)
+  * [Tips](#tips)
+    + [Send a file](#send-a-file)
+    + [Download a file](#download-a-file)
+- [Contributing](#contributing)
+- [License](#license)
+
+
 ## Installation and configuration
 
     $ gem install slack-smart-bot
@@ -330,6 +347,30 @@ The new cloud bot will be managed by your Master Bot like the others, closing, p
 
 This is very useful when you need to run certain processes on a different environment for example on a Windows machine while your Master Bot is on Ubuntu.
 
+### Tips
+
+#### Send a file
+
+```ruby
+    send_file(to, msg, filepath, title, format, type = "text")
+    send_file(dest, 'the message', "#{project_folder}/temp/logs_ptBI.log", 'title', 'text/plain', "text")
+    send_file(dest, 'the message', "#{project_folder}/temp/example.jpeg", 'title', 'image/jpeg', "jpg")
+```
+
+#### Download a file
+
+When uploading a file the message added to 'Add a message about the file' will be the command treated by the bot rule. Then in your rules file:
+
+```ruby
+    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]}" })
+        res = http.get(files[0].url_private_download, save_data: './tmp/')
+        # if you want to directly access to the content use: `res.data`
+      end
+```
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/marioruiz/slack-smart-bot.

data/lib/slack-smart-bot.rb

@@ -209,7 +209,9 @@ class SlackSmartBot
       end
       #todo: sometimes data.user is nil, check the problem.
       @logger.warn "!dest is nil. user: #{data.user}, channel: #{data.channel}, message: #{data.text}" if dest.nil?
-      
+      if !data.files.nil? and data.files.size == 1 and data.text.to_s == '' and data.files[0].filetype == "ruby"
+        data.text = 'ruby'
+      end 
       typem = :dont_treat
       if !dest.nil? and !data.text.nil? and !data.text.to_s.match?(/^\s*$/)
         if data.text.match(/^<@#{config[:nick_id]}>\s(on\s)?<#(\w+)\|(.+)>\s*:?\s*(.*)/im)
@@ -252,7 +254,6 @@ class SlackSmartBot
           end
         end
       end
-      
       unless typem == :dont_treat
         begin
           command = data.text
@@ -271,7 +272,8 @@ class SlackSmartBot
              (command.match?(/^(ruby|code)\s*$/) or (command.match?(/^\s*$/) and data.files[0].filetype == "ruby") or
               (typem==:on_call and data.files[0].filetype == "ruby"))
             res = Faraday.new("https://files.slack.com", headers: { "Authorization" => "Bearer #{config[:token]}" }).get(data.files[0].url_private)
-            command = "#{command} ruby #{res.body.to_s.force_encoding("UTF-8")}"
+            command += " ruby" if command!='ruby'
+            command = "#{command} #{res.body.to_s.force_encoding("UTF-8")}"
           end
 
           if typem == :on_call
@@ -291,7 +293,7 @@ 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)
+              res = 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
@@ -299,20 +301,20 @@ class SlackSmartBot
           elsif @questions.keys.include?(user_info.user.name)
             #todo: @questions key should be the id not the name. change it everywhere
             dest = data.channel
-            res = process_first(user_info.user, command, dest, @channel_id, typem)
+            res = process_first(user_info.user, command, dest, @channel_id, typem, data.files)
 
           elsif 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)
+            res = process_first(user_info.user, command, dest, @channel_id, typem, data.files)
 
           elsif !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)
+            res = 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)
+            res = process_first(user_info.user, command, dest, data.channel, typem, data.files)
             # if @botname on #channel_rules: do something
           end
         rescue Exception => stack
@@ -325,7 +327,7 @@ class SlackSmartBot
     client.start!
   end
 
-  def process_first(user, text, dest, dchannel, typem)
+  def process_first(user, text, dest, dchannel, typem, files)
     nick = user.name
     rules_file = ""
 
@@ -467,7 +469,11 @@ class SlackSmartBot
                 if defined?(rules)
                   command[0] = "" if command[0] == "!"
                   command.gsub!(/^@\w+:*\s*/, "")
-                  rules(user, command, processed, dest)
+                  if method(:rules).arity == 4
+                    rules(user, command, processed, dest)
+                  else
+                    rules(user, command, processed, dest, files)
+                  end
                 else
                   @logger.warn "It seems like rules method is not defined"
                 end
@@ -492,6 +498,11 @@ class SlackSmartBot
                   command[0] = "" if command[0] == "!"
                   command.gsub!(/^@\w+:*\s*/, "")
                   rules(user, command, processed, dest)
+                  if method(:rules).arity == 4
+                    rules(user, command, processed, dest)
+                  else
+                    rules(user, command, processed, dest, files)
+                  end
                 else
                   @logger.warn "It seems like rules method is not defined"
                 end

data/lib/slack-smart-bot_rules.rb

@@ -42,7 +42,7 @@ end
 # help:       `@NAME_OF_BOT THE_COMMAND`
 # help:       `NAME_OF_BOT THE_COMMAND`
 # help:
-def rules(user, command, processed, dest)
+def rules(user, command, processed, dest, files=[])
   from = user.name
   display_name = user.profile.display_name
 
@@ -107,6 +107,13 @@ def rules(user, command, processed, dest)
         respond "#{display_name}: #{stderr}", dest
       end
 
+    # Example downloading a file from slack  
+    #  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.get(files[0].url_private_download, save_data: './tmp/')
+    #  end
+
     # Examples sending a file to slack:
     #   send_file(to, msg, filepath, title, format, type = "text")
     #   send_file(dest, 'the message', "#{project_folder}/temp/logs_ptBI.log", 'title', 'text/plain', "text")

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: slack-smart-bot
 version: !ruby/object:Gem::Version
-  version: 0.9.4
+  version: 0.9.5
 platform: ruby
 authors:
 - Mario Ruiz
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-08-29 00:00:00.000000000 Z
+date: 2019-09-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: slack-ruby-client
@@ -30,6 +30,26 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.14.4
+- !ruby/object:Gem::Dependency
+  name: nice_http
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.7.19
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.7.19
 - !ruby/object:Gem::Dependency
   name: async-websocket
   requirement: !ruby/object:Gem::Requirement