slack-smart-bot 1.14.0 → 1.14.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fef5b10f464c14059a0c350c44e0bbb86c7c92db0f60a05516982c79e4764159
-  data.tar.gz: 5fa566a1f3198e1021a5a1f3ae6759e0814eeafa394e7acad2117bf0661d2cfe
+  metadata.gz: bab245674cac897b9bc248f749a80b8d83c0654bb8abdaa1ca985211995df834
+  data.tar.gz: c22b08d76ee508e7f7a1f5a5a294722ff0cf10e5ddb7a88fdcfca2ac05489510
 SHA512:
-  metadata.gz: 2a73bdd8c22589f205997f00723e15b791805430b4c614f33ea0abe32dee48fc5c6e9f8b7bd0709eb35376e133e40389c12e5efc7e0f5b8f871553cfe9f0b4f3
-  data.tar.gz: a98455b32e704fb57a84c6df1df523f0967a8499bf1c61bbda079f951b9f4b854e65f02395f2b85743e93ef05eb9ac505a57f452af9b0399ea362982392ac9ab
+  metadata.gz: d89f157f6e1cc1ebe762eef538b427c33610d18aeb47a0383cf17e8a18c18f7498a523bef74b4a1b8e61b455e60407fe5169ecafb0810aec813011c1b4d63f6c
+  data.tar.gz: 3d3eeab66e48f7289bb9dc194e38f943d95a57447419f6db66afcdea22c24d23c1f6cc9a5b391290c60f35642520e88b6110fcb2a72efdcf4188a9900ceadc92

data/README.md

@@ -231,28 +231,16 @@ To run a command on demand and add the response on a thread:
   **_`^THE_COMMAND`_**  
   **_`!!THE_COMMAND`_**
 
-Examples run a command on demand:
->**_Peter>_** `!ruby puts Time.now`  
->**_Smart-Bot>_** `2019-10-23 12:43:42 +0000`
+Examples run a command on demand:  
 
->**_Peter>_** `@smart-bot echo Example`  
->**_Smart-Bot>_** `Example`
+<img src="img/commands_on_demand.png" width="500">  
 
->**_Peter>_** `smart-bot see shortcuts`  
->**_Smart-Bot>_** `Available shortcuts for Peter:`  
->`Spanish account: ruby require 'iso/iban'; 10.times {puts ISO::IBAN.random('ES')}`  
->**_Peter>_** `!!echo Example`  
->. . . . . . . . .**_Smart-Bot>_** `Example`  
->**_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. 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`_**
 
-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:  
+
+<img src="img/commands_on_external_call.png" width="400">  
 
 Examples on DM:
 >**_Peter>_** `#sales show report from India`
@@ -260,14 +248,8 @@ Examples on DM:
 
 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:
->**_Peter>_** ``-!This text won't be treated but this one yes `ruby puts 'a'` and also this one `ruby puts 'b'` ``  
->**_Smart-Bot>_** `a`  
->**_Smart-Bot>_** `b`
-
->**_Peter>_** ``-^This text won't be treated but this one yes `ruby puts 'a'` and also this one `ruby puts 'b'` ``  
->. . . . . . . . .**_Smart-Bot>_** `a`  
->. . . . . . . . .**_Smart-Bot>_** `b`
+Examples:  
+<img src="img/commands_inline.png" width="500">  
 
 
 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.
@@ -287,10 +269,9 @@ To show only the specific rules of the Smart Bot defined on the rules file: **_`
 
 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`  
-    `repeats SOMETHING`
+Example:  
+<img src="img/command_bot_help_echo.png" width="250">  
+
 
 When you call a command that is not recognized, you will get suggestions from the Smart Bot.
 
@@ -368,15 +349,17 @@ Also you can always call the Smart Bot from any channel, even from channels with
 
 You can run Ruby code by using the command: **_`ruby THE_CODE`_**. 
 
-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]}`  
+Example:  
+<img src="img/command_ruby.png" width="650">  
+
 
 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
 > for all users
 
+[![SmartBot REPLs](https://img.youtube.com/vi/URMI3BdD7J8/0.jpg)](https://www.youtube.com/watch?v=URMI3BdD7J8)  
+
 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` 
@@ -406,28 +389,16 @@ Examples:
   _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`  
+Running Example:  
+<img src="img/command_repl1.png" width="650">  
+
+<img src="img/command_repl2.png" width="650">  
+
+
+Runnning on demand the repl we created:  
+
+<img src="img/command_run_repl.png" width="400">  
+
 
 You can run repls and supply parameters to the repl that will be executed on the same session just before the repl. [More info](https://github.com/MarioRuiz/slack-smart-bot/issues/60)  
 Example:
@@ -456,13 +427,11 @@ If you have for example a rule like this: **_`run tests on customers android app
 From that moment you will be able to run the command: **_`run tca`_**
 
 That shortcut will be available for you, in case you want to make it available for everybody on the channel: 
-Example:
->**_Peter>_** `!add shortcut for all spanish bank account: ruby require 'iso/iban'; 3.times {puts ISO::IBAN.random('ES')}`  
->**_Smart-Bot>_** `shortcut added`  
->**_John>_** `!spanish bank account`  
->**_Smart-Bot>_** `ES4664553191352006861448`  
-`ES4799209592433480943244`  
-`ES8888795057132445752702`  
+
+Example:  
+
+<img src="img/command_add_sc.png" width="650">  
+
 
 In case you want to use a shortcut as a inline shortcut inside a command you can do it by adding a $:
 Example:
@@ -491,7 +460,9 @@ Examples:
 >**_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`_**
+To see the announcements of the channel: **_`see announcements`_**, **_`see COLOR announcements`_**, **_`see EMOJI announcements`_** and to delete a particular announcement: **_`delete announcement ID`_**  
+
+<img src="img/command_see_announcements.png" width="650">  
 
 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.
 
@@ -521,7 +492,9 @@ Examples:
 >**_Peter>_** `who is not on vacation?`  
 >**_Peter>_** `who is on vacation? #SalesChannel`  
 >**_Peter>_** `who is on :working-from-home:`  
->**_Peter>_** `who is available?`
+>**_Peter>_** `who is available?`  
+
+<img src="img/command_see_statuses.png" width="400">  
 
 ### Routines
 > for admins
@@ -556,7 +529,7 @@ Other routine commands:
 ### Loops
 > for all users
 
-You can run any command or rule on a loop by using:  
+You can run *any command* or rule on a loop by using:  
 **_`for NUMBER times every NUMBER minutes COMMAND`_**  
 **_`for NUMBER times every NUMBER seconds COMMAND`_**  
 Maximum number of times to be used: 24. Minimum every 10 seconds. Maximum every 60 minutes.  
@@ -569,6 +542,8 @@ Examples:
 >**_`quit loop 1`_**  
 >**_`stop iterator 12`_**  
 
+<img src="img/command_loop.png" width="500">  
+
 ### Control who has access to a command
 > for admins
 
@@ -646,6 +621,8 @@ Examples:
 ### Teams
 > for all users
 
+[![SmartBot Teams](https://img.youtube.com/vi/u8B4aGDXH9M/0.jpg)](https://www.youtube.com/watch?v=u8B4aGDXH9M)  
+
 You can add, update, see, ping and delete teams. When calling `see TEAM_NAME team` the availability of the members will be displayed.  
 `add team TEAM_NAME PROPERTIES` will add a team with the info supplied. In case it is supplied a channel with type 'members' the members of that channel would be considered members of the team.  
 
@@ -703,8 +680,12 @@ Examples:
 >**_`sales team memo 4 Put it on hold until tests for Apple feature are finished`_**  
 >**_`sales team memo 7`_**  
 
+<img src="img/command_see_team.png" width="650">  
+
+
 Other team commands: **_`delete team TEAM_NAME`_**, **_`delete memo ID from team TEAM_NAME`_**, **_`set STATUS on memo ID TEAM_NAME team`_**, **_`see MEMO_TYPE from TEAM_NAME team TOPIC`_**  
 
+
 ### Time off management
 > for all users
 
@@ -736,7 +717,7 @@ settings = {
 
 When calling `see my time off` on a DM will display a calendar of the year with the days off, including public holidays  
 
-<img src="img/my_timeoff.png" width="650">
+<img src="img/command_my_timeoff.png" width="750">
 
 Other 'time off' commands: **_`remove time off ID`_**, **_`see my time off`_**, **_`see vacations @USER`_**, **_`time off team NAME`_**, **_`set public holidays to COUNTRY/REGION`_**    
 
@@ -754,7 +735,7 @@ ai: {
                access_token: 'OPENAI_ACCESS_TOKEN',
               organization_id: 'OPENAI_ORGANIZATION_ID',
               gpt_model: 'gpt-3.5-turbo',
-              whisper_model : 'whisper-1',
+              whisper_model: 'whisper-1',
               image_size: '256x256'
   }
 }

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

@@ -116,6 +116,7 @@ class SlackSmartBot
     end
     output.each do |h|
       msg = h.gsub(/^\s*command_id:\s+:\w+\s*$/,'')
+      msg.gsub!(/^\s*>.+$/,'') if help_command.to_s != ''
       unless msg.match?(/\A\s*\z/)
         respond msg, dest, unfurl_links: false, unfurl_media: false
       end

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

@@ -86,6 +86,7 @@ class SlackSmartBot
             bye_bot(dest, user.name, display_name)
 
           # help: ----------------------------------------------
+          # help: >*<https://github.com/MarioRuiz/slack-smart-bot#announcements|ANNOUNCEMENTS>*
           # help: `add announcement MESSAGE`
           # help: `add red announcement MESSAGE`
           # help: `add green announcement MESSAGE`
@@ -162,6 +163,7 @@ class SlackSmartBot
 
 
           # help: ----------------------------------------------
+          # help: >*<https://github.com/MarioRuiz/slack-smart-bot#share-messages|SHARE MESSAGES>*
           # help: `share messages /REGEXP/ on #CHANNEL`
           # help: `share messages "TEXT" on #CHANNEL`
           # xhelp: `share messages :EMOJI: on #CHANNEL`
@@ -395,6 +397,7 @@ class SlackSmartBot
           end
 
           # help: ----------------------------------------------
+          # help: >*<https://github.com/MarioRuiz/slack-smart-bot#teams|TEAMS>*
           # help: `add team TEAM_NAME members #TEAM_CHANNEL CHANNEL_TYPE #CHANNEL1 #CHANNEL99 : INFO`
           # help: `add team TEAM_NAME MEMBER_TYPE @USER1 @USER99 CHANNEL_TYPE #CHANNEL1 #CHANNEL99 : INFO`
           # help: `add team TEAM_NAME MEMBER_TYPE1 @USER1 @USER99 MEMBER_TYPE99 @USER1 @USER99 CHANNEL_TYPE1 #CHANNEL1 #CHANNEL99 CHANNEL_TYPE99 #CHANNEL1 #CHANNEL99 : INFO`
@@ -662,6 +665,7 @@ class SlackSmartBot
           see_memos_team(user, type: type, name: name, topic: topic)
 
           # help: ----------------------------------------------
+          # help: >*<https://github.com/MarioRuiz/slack-smart-bot#time-off-management|TIME OFF MANAGEMENT>*
           # help: `add vacation from YYYY/MM/DD to YYYY/MM/DD`
           # help: `add vacation YYYY/MM/DD`
           # help: `add sick from YYYY/MM/DD to YYYY/MM/DD`
@@ -826,6 +830,7 @@ class SlackSmartBot
           personal_settings(user, settings_type, settings_id, settings_value)
 
         # help: ----------------------------------------------
+        # help: >*<https://github.com/MarioRuiz/slack-smart-bot#openai|OpenAI>*
         # help: `?w`
         # help: `?w PROMPT`
         # help:     OpenAI: It will transcribe the audio file attached and performed the PROMPT indicated if supplied.

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

@@ -1,6 +1,7 @@
 class SlackSmartBot
 
   # help: ----------------------------------------------
+  # help: >*<https://github.com/MarioRuiz/slack-smart-bot#shortcuts|SHORTCUTS>*
   # help: `add shortcut NAME: COMMAND`
   # help: `add sc NAME: COMMAND`
   # help: `add shortcut for all NAME: COMMAND`
@@ -26,6 +27,7 @@ class SlackSmartBot
     unless typem == :on_extended
       from = user.name
       if has_access?(__method__, user)
+        shortcut_name.strip!
         if global 
           if !config.on_master_bot or typem != :on_master
             respond "It is only possible to add global shortcuts from Master channel"

data/lib/slack/smart-bot/commands/on_bot/admin/add_routine.rb

@@ -1,5 +1,6 @@
 class SlackSmartBot
   # helpadmin: ----------------------------------------------
+  # helpadmin: >*<https://github.com/MarioRuiz/slack-smart-bot#routines|ROUTINES>*
   # helpadmin: `add routine NAME every NUMBER PERIOD COMMAND`
   # helpadmin: `add routine NAME every NUMBER PERIOD #CHANNEL COMMAND`
   # helpadmin: `add routine NAME every NUMBER PERIOD`

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

@@ -14,8 +14,8 @@ class SlackSmartBot
     unless typem == :on_extended
       from = user.name
       if has_access?(__method__, user)
-        deleted = false
-
+        deleted = false        
+        shortcut.strip!
         if global
           if !config.on_master_bot or typem != :on_master
             respond "It is only possible to delete global shortcuts from Master channel"

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

@@ -1,5 +1,6 @@
 class SlackSmartBot
   # help: ----------------------------------------------
+  # help: >*<https://github.com/MarioRuiz/slack-smart-bot#repl|REPLs>*
   # help: `repl`
   # help: `live`
   # help: `irb`

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

@@ -79,6 +79,7 @@ class SlackSmartBot
         end
         output.each do |h|
           msg = h.gsub(/^\s*command_id:\s+:\w+\s*$/,'')
+          msg.gsub!(/^\s*>.+$/,'') if help_command.to_s != ''
           unless msg.match?(/\A\s*\z/)
             respond msg, dest, unfurl_links: false, unfurl_media: false
           end

data/whats_new.txt

@@ -1,4 +1,4 @@
-*Version 1.14.0* Released 2023-Apr-13
+*Version 1.14.1* Released 2023-Apr-13
 
 *For General users*
 - `team TEAM_NAME memo ID MESSAGE`, `TEAM_NAME team memo ID MESSAGE` It will add a comment to the memo ID specified on the team specified. (<https://github.com/MarioRuiz/slack-smart-bot/issues/95|#95>).

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: slack-smart-bot
 version: !ruby/object:Gem::Version
-  version: 1.14.0
+  version: 1.14.2
 platform: ruby
 authors:
 - Mario Ruiz
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-04-13 00:00:00.000000000 Z
+date: 2023-04-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: slack-ruby-client
@@ -65,6 +65,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.7.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -72,6 +75,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.7.0
 - !ruby/object:Gem::Dependency
   name: nice_hash
   requirement: !ruby/object:Gem::Requirement