Use chat.postMessage API for posting a message #60

Chikashi-Kato · 2019-07-03T07:52:30Z

Add a logic to use chat.postMessage API to post a message to Slack if webhook_url is not set.
Now, webhook_url is deprecated and is not set in the interactive setup mode (--setup).
This is a backward compatible change and slacktee is still use and prioritize webhook_url if it's set.

This PR should fix issue #56.

…l is not set. Also, deprecated webhook_url.

slacktee.sh

vipulgagrani · 2019-07-03T17:12:21Z

README.md

-For more details about tokens, visit [Slack's API page](https://api.slack.com/).
+In order to retrieve the bot token, you need to add a bot into your workspace through [Slack App Directory](https://cks-world.slack.com/apps/A0F7YS25R-bots).
+Once you add a bot, you can find 'API Token' in the configuration page of the bot.
+


Maybe I would word it in steps. coz its either or. so the comment can say:
You would need an authentication token for the bot. It could be generated in 2 ways

(Preferred way) Follow steps listed in creating a Slack App.
Next, create a bot user for your app and give the following 3 permissions to your app - chat:write:bot, files:write:user and bot. More information about the permission scopes can be found at permission scopes

Add a bot into your workspace through Slack App Directory. You can now find 'API Token' in the configuration page of the bot.

Wow, great suggestion! I will update README!

connorjclark · 2019-07-03T18:06:20Z

slacktee.sh

@@ -22,8 +22,8 @@
 # ----------
 # Default Configuration
 # ----------
-webhook_url=""       # Incoming Webhooks integration URL
-token=""             # The user's API authentication token, only used for file uploads or streaming
+webhook_url=""       # Incoming Webhooks integration URL. Old way to interact with Slack. (Deprecated)


Could we log a deprecation message to stderr if webhook_url is set?

Ah! Good idea! Let me implement it :)

Implemented!

connorjclark · 2019-07-03T18:13:35Z

slacktee.sh

@@ -203,7 +203,8 @@ function send_message()
 					\"icon_url\": \"$icon_url\" $parseMode}"

 				post_result=$(curl -H "Authorization: Bearer $token" -H 'Content-type: application/json; charset=utf-8' -X POST -d "$json" https://slack.com/api/chat.postMessage 2> /dev/null)
-				if [ $? != 0 ]; then
+				post_ok="$(echo "$post_result" | awk 'match($0, /"ok":([^,}]+)/) {print substr($0, RSTART+5, RLENGTH-5)}')"


Starting to wonder if we are tying our hands in complexity with using only shell scripts here. I understand the goal is to keep slacktee as cross-platform as possible, but consider:

python (well, at least python 2) is included in the majority of OSes by default (although with a few exceptions re: BSD. Do we have users running slacktee w/o python installed? Do we know?)

We are using bash, not sh. Are we using any bash extensions that aren't cross-platform? I've no idea.

If we've got all this complex shell script, I just want to make sure we are truly gaining something (cross-platform) that is actually needed (do our users need this)? I'm afraid there's like, 2 or 3 people in the world that understand this script :)

We could potentially do a binary with go, that is built per distro. Any dependencies can be baked in (static binary).

Ah, I see now.

I would hesitate to use golang for this, just because it seems making a CLI tool in Python would be simpler, and more people could easily contribute.

But I do like the idea of installing missing deps (ie: python) w/ Ansible if missing. However, I think that might make integrating the script harder? right now you just drop the shell file on any system you want - idk how Ansible works, would it be that simple?

I might be too stubborn but I would like to avoid using other languages in slacktee.
slacktee is intentionally written in the shell script for the simple installation and the better portability. I agree python is now available in majority of OSes by default, but some people are using slacktee in bare minimum environments (see #37 and #57) and I cannot imaging that they are happily installing python just for using slacktee.

With regard to point 2, I'm not sure if we are using non-cross-platfrom bash extensions. In my understanding, we are currently using [[ ]] which is not available in sh for using regex in the if condition. Some OS like alpine doesn't have bash by default and using sh might be better for the portability.
If we drop the support of conditional formatting, we may be able to make slacktee a sh script ;)

If we drop the support of conditional formatting, we may be able to make slacktee a sh script ;)

The opposite intention of my comment :P

To be more extreme, I wonder if there is a way to transpile a restrictive subset of some higher level language into a POSIX compliant sh script. Basically, I think it'd be awesome to have an easier language to develop in, but keep the awesome portability you want to uphold. An idea for another day :)

To be clear, I am not opposing to implement slacktee functionalities in other languages.
If we start another project which is implementing slacktee in different languages (e.g. slacktee-python and slacktee-go), I would love to contribute!

connorjclark · 2019-07-03T18:15:26Z

lgtm. left one nit re: deprecation, and one comment for broader discussion on complexity.

jimsmith · 2019-07-03T18:17:03Z

tbh this shell script has grown organically and should be massively simplified with say Ansible (IMHO)

connorjclark · 2019-07-03T18:20:15Z

Could you explain that a bit? AFAIU, Ansible is a tool for deployment configuration - do you think it'd be better for a script than something like Python? Not sure I understand :)

Chikashi-Kato · 2019-07-03T18:20:21Z

@jimsmith I would like to understand your opinion more deeply.
I agree that this script has now so many features and the implementation of the script is complicated.
How can we simplify the implementation of this script with Ansible?

jimsmith · 2019-07-03T18:25:41Z

Python example
https://www.accadius.com/send-message-slack-python-program/

Ansible example
https://docs.ansible.com/ansible/latest/modules/slack_module.html

https://www.linkedin.com/pulse/posting-slack-using-ansible-tariq-siddiqui/

I started off with this script years back but as it grew complexity I switched quickly to Ansible and for python lovers there is the above example.

No need to do complex condition statements :)

connorjclark · 2019-07-03T18:34:18Z

Interesting! The Ansible approach seems great for when you know before-hand exactly the type of messages you want to send to Slack. If seems to offer a great way to configure message templates. But with slacktee, the use case seems a bit different. It's tacked onto the end of just about any command, and is used more adhoc in scripts/crons.

Or perhaps there's a way to create these ansible configs programmatically, and let them do the heavy lifting? But at that point, I wonder if just leveraging (for example) the Python Slack SDK would provide the same ease.

Use chat.postMessage API for posting a message to Slack if webhook_ur…

7f4f957

…l is not set. Also, deprecated webhook_url.

Chikashi-Kato added this to the 1.4 (Use Slack API instead of Custom Integration) milestone Jul 3, 2019

Chikashi-Kato self-assigned this Jul 3, 2019

siosphere reviewed Jul 3, 2019

View reviewed changes

slacktee.sh Outdated Show resolved Hide resolved

Add a deprecated warning to the error message

ae6bf00

vipulgagrani approved these changes Jul 3, 2019

View reviewed changes

vipulgagrani reviewed Jul 3, 2019

View reviewed changes

connorjclark reviewed Jul 3, 2019

View reviewed changes

connorjclark approved these changes Jul 3, 2019

View reviewed changes

ch-ckato added 2 commits July 3, 2019 12:41

Show deprecation warning if webhook_url is set

9885892

Improve the setup instructions in README

443ca75

Chikashi-Kato merged commit 1fdf6c1 into master Jul 4, 2019

Chikashi-Kato deleted the 56-use-token-for-posting-messages branch July 4, 2019 02:13

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Use chat.postMessage API for posting a message #60

Use chat.postMessage API for posting a message #60

Chikashi-Kato commented Jul 3, 2019

vipulgagrani Jul 3, 2019

Chikashi-Kato Jul 3, 2019

Chikashi-Kato Jul 3, 2019

connorjclark Jul 3, 2019

Chikashi-Kato Jul 3, 2019

Chikashi-Kato Jul 3, 2019

connorjclark Jul 3, 2019

siosphere Jul 3, 2019

connorjclark Jul 3, 2019

Chikashi-Kato Jul 3, 2019 •

edited

Loading

connorjclark Jul 3, 2019

Chikashi-Kato Jul 3, 2019 •

edited

Loading

connorjclark commented Jul 3, 2019

jimsmith commented Jul 3, 2019

connorjclark commented Jul 3, 2019

Chikashi-Kato commented Jul 3, 2019

jimsmith commented Jul 3, 2019 •

edited

Loading

connorjclark commented Jul 3, 2019 •

edited

Loading

Use chat.postMessage API for posting a message #60

Use chat.postMessage API for posting a message #60

Conversation

Chikashi-Kato commented Jul 3, 2019

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Chikashi-Kato Jul 3, 2019 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Chikashi-Kato Jul 3, 2019 • edited Loading

Choose a reason for hiding this comment

connorjclark commented Jul 3, 2019

jimsmith commented Jul 3, 2019

connorjclark commented Jul 3, 2019

Chikashi-Kato commented Jul 3, 2019

jimsmith commented Jul 3, 2019 • edited Loading

connorjclark commented Jul 3, 2019 • edited Loading

Chikashi-Kato Jul 3, 2019 •

edited

Loading

Chikashi-Kato Jul 3, 2019 •

edited

Loading

jimsmith commented Jul 3, 2019 •

edited

Loading

connorjclark commented Jul 3, 2019 •

edited

Loading