ref: revert the webhook remove (#49)

* ref: revert the webhook remove

* fix: test fix

* input validation

* step.yml update

.gitignore

@@ -1 +1,2 @@
-.bitrise*
+.bitrise*
+.gows.user.yml

README.md

@@ -84,4 +84,4 @@ You can share your Step or step version with the [bitrise CLI](https://github.co
 ## Trigger a new release
 
 - __merge every code changes__ to the `master` branch
-- __push the new version tag__ to the `master` branch
+- __push the new version tag__ to the `master` branch

bitrise.yml

@@ -1,4 +1,4 @@
-format_version: 6
+format_version: 5
 default_step_lib_source: https://github.com/bitrise-io/bitrise-steplib.git
 
 app:
@@ -33,7 +33,7 @@ workflows:
         title: On Success - without channel
         is_skippable: false
         inputs:
-        - api_token: $SLACK_API_TOKEN
+        - webhook_url: $SLACK_WEBHOOK_URL
         - channel: ""
         - from_username: step-dev-test
         - message: On Success test - without channel param
@@ -55,7 +55,7 @@ workflows:
         title: On Success - with an image / gif
         is_skippable: false
         inputs:
-        - api_token: $SLACK_API_TOKEN
+        - webhook_url: $SLACK_WEBHOOK_URL
         - channel: $SLACK_CHANNEL
         - from_username: step-dev-test
         - message: |
@@ -78,6 +78,7 @@ workflows:
         title: Should escape backslash+n as newline char
         is_skippable: false
         inputs:
+        - webhook_url: $SLACK_WEBHOOK_URL
         - api_token: $SLACK_API_TOKEN
         - channel: $SLACK_CHANNEL
         - from_username: step-dev-test
@@ -92,6 +93,7 @@ workflows:
         title: On Error
         is_skippable: false
         inputs:
+        - webhook_url: $SLACK_WEBHOOK_URL
         - api_token: $SLACK_API_TOKEN
         - channel: $SLACK_CHANNEL
         - from_username_on_error: step-dev-test-ON-ERROR
@@ -101,6 +103,7 @@ workflows:
     - path::./:
         is_skippable: false
         inputs:
+        - webhook_url: $SLACK_WEBHOOK_URL
         - api_token: $SLACK_API_TOKEN
         - channel: no-channel-like-this
   missing-webhook-url-test:

gows.yml

@@ -0,0 +1 @@
+package_name: github.com/bitrise-io/steps-slack-message

main.go

@@ -19,7 +19,8 @@ type Config struct {
 	Debug bool `env:"is_debug_mode,opt[yes,no]"`
 
 	// Message
-	APIToken         stepconf.Secret `env:"api_token,required"`
+	WebhookURL       stepconf.Secret `env:"webhook_url"`
+	APIToken         stepconf.Secret `env:"api_token"`
 	Channel          string          `env:"channel"`
 	ChannelOnError   string          `env:"channel_on_error"`
 	Text             string          `env:"text"`
@@ -54,8 +55,6 @@ type Config struct {
 	Buttons         string `env:"buttons"`
 }
 
-const messageURL = "https://slack.com/api/chat.postMessage"
-
 // success is true if the build is successful, false otherwise.
 var success = os.Getenv("BITRISE_BUILD_STATUS") == "0"
 
@@ -110,9 +109,17 @@ func postMessage(conf Config, msg Message) error {
 	}
 	log.Debugf("Request to Slack: %s\n", b)
 
-	req, err := http.NewRequest("POST", messageURL, bytes.NewReader(b))
+	url := string(conf.WebhookURL)
+	if string(conf.APIToken) != "" {
+		url = "https://slack.com/api/chat.postMessage"
+	}
+
+	req, err := http.NewRequest("POST", url, bytes.NewReader(b))
 	req.Header.Add("Content-Type", "application/json; charset=utf-8")
-	req.Header.Add("Authorization", "Bearer "+string(conf.APIToken))
+
+	if string(conf.APIToken) != "" {
+		req.Header.Add("Authorization", "Bearer "+string(conf.APIToken))
+	}
 
 	client := &http.Client{}
 
@@ -138,6 +145,17 @@ func postMessage(conf Config, msg Message) error {
 	return nil
 }
 
+func validate(conf Config) error {
+	if conf.APIToken == "" && conf.WebhookURL == "" {
+		return fmt.Errorf("Both API Token and WebhookURL is empty. You need to provide one of them. If you want to use incoming webhooks provide the webhook url. I you want to use a bot to send a message provide the bot API token")
+	}
+
+	if conf.APIToken != "" && conf.WebhookURL != "" {
+		log.Warnf("Both API Token and WebhookURL is provided. Using the webhook url")
+	}
+	return nil
+}
+
 func main() {
 	var conf Config
 	if err := stepconf.Parse(&conf); err != nil {
@@ -147,6 +165,11 @@ func main() {
 	stepconf.Print(conf)
 	log.SetEnableDebugLog(conf.Debug)
 
+	if err := validate(conf); err != nil {
+		log.Errorf("Error: %s\n", err)
+		os.Exit(1)
+	}
+
 	msg := newMessage(conf)
 	if err := postMessage(conf, msg); err != nil {
 		log.Errorf("Error: %s", err)

step.sh

@@ -0,0 +1,13 @@
+#!/bin/bash
+set -e
+THIS_SCRIPT_DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
+
+go_package_name="github.com/bitrise-io/steps-slack-message"
+full_package_path="${THIS_SCRIPT_DIR}/go/src/${go_package_name}"
+mkdir -p "${full_package_path}"
+
+rsync -avh --quiet "${THIS_SCRIPT_DIR}/" "${full_package_path}/"
+
+export GOPATH="${THIS_SCRIPT_DIR}/go"
+export GO15VENDOREXPERIMENT=1
+go run "${full_package_path}/main.go"

step.yml

@@ -4,7 +4,11 @@ summary: Send a [Slack](https://slack.com/) message to a channel or group.
 description: |
   Send a [Slack](https://slack.com/) message to a channel or group.
 
-  You have to create a bot with an API token at https://my.slack.com/apps/manage/custom-integrations
+  You can either setup a **bot user with API token** or setup **Incoming WebHook integration**.
+
+  To register an **Incoming WebHook integration** visit: https://api.slack.com/incoming-webhooks
+
+  To setup a **bot with an API token** visit: https://api.slack.com/bot-users
 
   *Don't forget to enable this Step to **Always run** if
   you want to get notified about failed builds as well!*
@@ -25,7 +29,6 @@ deps:
 toolkit:
   go:
     package_name: github.com/bitrise-io/steps-slack-message
-
 inputs:
   - is_debug_mode: "no"
     opts:
@@ -38,10 +41,23 @@ inputs:
       - "no"
 
 # Message inputs
+  - webhook_url:
+    opts:
+      title: "Slack Webhook URL (Webhook or API token is required)"
+      description: |
+         **Either webhook\_url or api\_token input is required.**
+
+         To register an **Incoming WebHook integration** visit: https://api.slack.com/incoming-webhooks
+      is_required: false
+      is_sensitive: true
   - api_token: 
     opts:
-      title: Slack API token for your Bot
-      is_required: true
+      title: "Slack API token (Webhook or API token is required)"
+      description: |
+         **Either webhook\_url or api\_token input is required.**
+         
+         To setup a **bot with an API token** visit: https://api.slack.com/bot-users
+      is_required: false
       is_sensitive: true
   - channel:
     opts: