slack-smart-bot 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: de799c58ed76d6aa417063653fd81b62fea79ff9b6abdb1bfcfe0f3b8ce2c93f
-  data.tar.gz: 198a2cca055c64070970f342d62714e3b02cf4258928fa62c729c81d5b1e7867
+  metadata.gz: e640de80df6bea5fc531eff1e1e08d4032018b15be712262851779f04028f642
+  data.tar.gz: d3e361a01f6fedd4447a7874c3b8960b24ba18b716a4e1c1c3c83ee90a77d67b
 SHA512:
-  metadata.gz: afb02011c7533c06ac196a69ab086186b56946a1d0bb34c4496b0902ef765681d1923169a5238ce14a08ab37fce1d077e6215e0a0716a7cb5a9e622fcedc184e
-  data.tar.gz: 828c7d015b06bcc8ddf601d84218407ced11fe3a7f40526f9dcc4d39dacba582fef35b02258eb9463df7a4bbd8ca17820d560642e004a52fb5a51442497d0492
+  metadata.gz: ae2e4b9e6dd3180a5b73ae91d4e6b07de9696ffc0a7502342810938414ea9680b3fd7135a9df9046fb33917405fe6f902b7cb65269f6cd47bba7c3304dd16aa4
+  data.tar.gz: d8bb4daf48b2788d4824ae0103edf1e6382896269e561a97d9c9076769e028bd4a6ebaa8a70d4ab13c38825149e68f492c8747de45ef96a51226b1c7509b443b

data/README.md

@@ -47,7 +47,7 @@ MASTER_USERS=["mario"]
 require 'slack-smart-bot'
 
 settings = {
-    nick: 'my_smart_bot', # the smart bot name
+    nick: 'smart-bot', # the smart bot name
     token: 'xxxxxxxxxxxxxxxxxx' # the API Slack token
 }
 
@@ -171,10 +171,27 @@ Another way to run a command/rule is by asking *on demand*. In this case it is n
 To run a command on demand:  
   **_`!THE_COMMAND`_**  
   **_`@NAME_OF_BOT THE_COMMAND`_**  
-  **_`NAME_OF_BOT THE_COMMAND`_**
+  **_`NAME_OF_BOT THE_COMMAND`_**  
+
+Examples run a command on demand:
+>**_Peter>_** `!ruby puts Time.now`  
+>**_Smart-Bot>_** `2019-10-23 12:43:42 +0000`
+
+>**_Peter>_** `@smart-bot echo Example`  
+>**_Smart-Bot>_** `Example`
+
+>**_Peter>_** `smart-bot see shortcuts`  
+>**_Smart-Bot>_** `Available shortcuts for Peter:`  
+>`Spanish account: ruby require 'iso/iban'; 10.times {puts ISO::IBAN.random('ES')}`
 
 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.
 
+Example:
+>**_Peter>_** `@smart-bot on #the_channel ruby puts Time.now`  
+>**_Smart-Bot>_** `2019-10-23 12:43:42 +0000`
+
+
+
 ### 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.
 
@@ -182,6 +199,12 @@ If you want to search just for a specific command: **_`bot help COMMAND`_**
 
 To show only the specific rules of the Smart Bot defined on the rules file: **_`bot rules`_** or **_`bot rules COMMAND`_**
 
+Example:
+>**_Peter>_** `bot help echo`  
+>**_Smart-Bot>_** `echo SOMETHING`  
+    `repeats SOMETHING`
+
+
 ### 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.
 
@@ -206,14 +229,18 @@ From that moment everybody part of that channel will be able to run the specific
 To stop allowing it: **_`stop using rules on CHANNEL`_**
 
 ### Using rules from other channels
-To be able to access the rules from other channel, first of all you need to be a member of that channel. Then on a private conversation with the Smart Bot or from another bot channel: **_`use rules from CHANNEL`_**
+To be able to access the rules from other channel or from a direct conversation with the bot, first of all you need to be a member of that channel. Then on a direct conversation with the Smart Bot or from another bot channel: **_`use rules from CHANNEL`_**
 
 When you want to stop using those rules with the bot: **_`stop using rules from CHANNEL`_**
 
 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.
 
 ### Running Ruby code on a conversation
-You can run Ruby code by using the command: **_`ruby THE_CODE`_**. For example: **_`!ruby require 'json'; res=[]; 20.times {res<<rand(100)}; my_json={result: res}; puts my_json.to_json`_**
+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]}`  
 
 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.
 
@@ -231,7 +258,14 @@ 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: **_`add shortcut for all Spanish account: ruby require 'iso/iban'; 10.times {puts ISO::IBAN.random('ES')}`_**
+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`  
+>**_Peter>_** `!spanish bank account`  
+>**_Smart-Bot>_** `ES4664553191352006861448`  
+`ES4799209592433480943244`  
+`ES8888795057132445752702`  
 
 To see available shortcuts: **_`see shortcuts`_** and to delete a particular shortcut: **_`delete shortcut NAME`_**
 
@@ -239,8 +273,8 @@ To see available shortcuts: **_`see shortcuts`_** and to delete a particular sho
 To add specific commands to be run automatically every certain amount of time or a specific time: **_`add routine NAME every NUMBER PERIOD COMMAND`_** or **_`add routine NAME at TIME COMMAND`_**
 
 Examples:  
-        **_`add routine run_tests every 3h run tests on customers`_**  
-        **_`add routine clean_db at 17:05 clean customers temp db`_**  
+>**_`add routine run_tests every 3h run tests on customers`_**  
+>**_`add routine clean_db at 17:05 clean customers temp db`_**  
 
 Also instead of adding a Command to be executed, you can attach a file, then the routine will be created and the attached file will be executed on the criteria specified. Only Master Admins are allowed to use it this way.
 

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

@@ -129,7 +129,7 @@ class SlackSmartBot
       when /^bot\s+rules\s*(.+)?$/i
         help_command = $1
         bot_rules(dest, help_command, typem, rules_file, from)
-      when /^\s*(add\s)?shortcut\s(for\sall)?\s*(.+)\s*:\s*(.+)/i, /^(add\s)sc\s(for\sall)?\s*(.+)\s*:\s*(.+)/i
+      when /^\s*(add\s)?shortcut\s(for\sall)?\s*([^:]+)\s*:\s*(.+)/i, /^(add\s)sc\s(for\sall)?\s*([^:]+)\s*:\s*(.+)/i
         for_all = $2
         shortcut_name = $3.to_s.downcase
         command_to_run = $4

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: slack-smart-bot
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors:
 - Mario Ruiz