You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@camel.apache.org by da...@apache.org on 2021/03/10 11:59:37 UTC

[camel] branch master updated: CAMEL-16328: Restore support for Slack custom server URL (#5193)

This is an automated email from the ASF dual-hosted git repository.

davsclaus pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/camel.git


The following commit(s) were added to refs/heads/master by this push:
     new 532bd0c  CAMEL-16328: Restore support for Slack custom server URL (#5193)
532bd0c is described below

commit 532bd0c39905ffbb78590769fbf933751152d915
Author: James Netherton <ja...@users.noreply.github.com>
AuthorDate: Wed Mar 10 11:59:15 2021 +0000

    CAMEL-16328: Restore support for Slack custom server URL (#5193)
---
 .../slack/SlackComponentVerifierExtension.java     |  9 +++-
 .../camel/component/slack/SlackConsumer.java       |  6 ++-
 .../camel/component/slack/SlackProducer.java       |  6 ++-
 .../camel/component/slack/helper/SlackHelper.java  | 52 ++++++++++++++++++++++
 .../camel/component/slack/SlackHelperTest.java     | 49 ++++++++++++++++++++
 5 files changed, 118 insertions(+), 4 deletions(-)

diff --git a/components/camel-slack/src/main/java/org/apache/camel/component/slack/SlackComponentVerifierExtension.java b/components/camel-slack/src/main/java/org/apache/camel/component/slack/SlackComponentVerifierExtension.java
index 6d612fb..8b1357a 100644
--- a/components/camel-slack/src/main/java/org/apache/camel/component/slack/SlackComponentVerifierExtension.java
+++ b/components/camel-slack/src/main/java/org/apache/camel/component/slack/SlackComponentVerifierExtension.java
@@ -21,12 +21,14 @@ import java.util.Map;
 
 import com.google.gson.Gson;
 import com.slack.api.Slack;
+import com.slack.api.SlackConfig;
 import com.slack.api.methods.response.conversations.ConversationsListResponse;
 import com.slack.api.model.ConversationType;
 import com.slack.api.webhook.WebhookResponse;
 import org.apache.camel.component.extension.verifier.DefaultComponentVerifierExtension;
 import org.apache.camel.component.extension.verifier.ResultBuilder;
 import org.apache.camel.component.extension.verifier.ResultErrorBuilder;
+import org.apache.camel.component.slack.helper.SlackHelper;
 import org.apache.camel.component.slack.helper.SlackMessage;
 import org.apache.camel.util.ObjectHelper;
 
@@ -73,6 +75,7 @@ public class SlackComponentVerifierExtension extends DefaultComponentVerifierExt
 
     private void verifyCredentials(ResultBuilder builder, Map<String, Object> parameters) {
         String webhookUrl = (String) parameters.get("webhookUrl");
+        String serverUrl = (String) parameters.get("serverUrl");
 
         if (ObjectHelper.isNotEmpty(webhookUrl)) {
 
@@ -82,8 +85,9 @@ public class SlackComponentVerifierExtension extends DefaultComponentVerifierExt
                 slackMessage = new SlackMessage();
                 slackMessage.setText("Test connection");
 
+                SlackConfig config = SlackHelper.createSlackConfig(serverUrl);
                 WebhookResponse response
-                        = Slack.getInstance(new CustomSlackHttpClient()).send(webhookUrl, GSON.toJson(slackMessage));
+                        = Slack.getInstance(config, new CustomSlackHttpClient()).send(webhookUrl, GSON.toJson(slackMessage));
 
                 // 2xx is OK, anything else we regard as failure
                 if (response.getCode() < 200 || response.getCode() > 299) {
@@ -101,7 +105,8 @@ public class SlackComponentVerifierExtension extends DefaultComponentVerifierExt
             String token = (String) parameters.get("token");
 
             try {
-                ConversationsListResponse response = Slack.getInstance(new CustomSlackHttpClient()).methods(token)
+                SlackConfig config = SlackHelper.createSlackConfig(serverUrl);
+                ConversationsListResponse response = Slack.getInstance(config, new CustomSlackHttpClient()).methods(token)
                         .conversationsList(req -> req
                                 .types(Collections.singletonList(ConversationType.PUBLIC_CHANNEL))
                                 .limit(1));
diff --git a/components/camel-slack/src/main/java/org/apache/camel/component/slack/SlackConsumer.java b/components/camel-slack/src/main/java/org/apache/camel/component/slack/SlackConsumer.java
index 2379803..8d97fc7 100644
--- a/components/camel-slack/src/main/java/org/apache/camel/component/slack/SlackConsumer.java
+++ b/components/camel-slack/src/main/java/org/apache/camel/component/slack/SlackConsumer.java
@@ -23,6 +23,7 @@ import java.util.List;
 import java.util.Queue;
 
 import com.slack.api.Slack;
+import com.slack.api.SlackConfig;
 import com.slack.api.methods.SlackApiException;
 import com.slack.api.methods.response.conversations.ConversationsHistoryResponse;
 import com.slack.api.methods.response.conversations.ConversationsListResponse;
@@ -32,6 +33,7 @@ import org.apache.camel.AsyncCallback;
 import org.apache.camel.Exchange;
 import org.apache.camel.Processor;
 import org.apache.camel.RuntimeCamelException;
+import org.apache.camel.component.slack.helper.SlackHelper;
 import org.apache.camel.support.ScheduledBatchPollingConsumer;
 import org.apache.camel.util.CastUtils;
 import org.apache.camel.util.ObjectHelper;
@@ -51,7 +53,9 @@ public class SlackConsumer extends ScheduledBatchPollingConsumer {
 
     @Override
     protected void doStart() throws Exception {
-        this.slack = Slack.getInstance(new CustomSlackHttpClient());
+        SlackConfig config = SlackHelper.createSlackConfig(slackEndpoint.getServerUrl());
+        CustomSlackHttpClient client = new CustomSlackHttpClient();
+        this.slack = Slack.getInstance(config, client);
         this.channelId = getChannelId(slackEndpoint.getChannel(), null);
         super.doStart();
     }
diff --git a/components/camel-slack/src/main/java/org/apache/camel/component/slack/SlackProducer.java b/components/camel-slack/src/main/java/org/apache/camel/component/slack/SlackProducer.java
index 20b8d7a..57cd41a 100644
--- a/components/camel-slack/src/main/java/org/apache/camel/component/slack/SlackProducer.java
+++ b/components/camel-slack/src/main/java/org/apache/camel/component/slack/SlackProducer.java
@@ -20,6 +20,7 @@ import java.io.IOException;
 
 import com.google.gson.Gson;
 import com.slack.api.Slack;
+import com.slack.api.SlackConfig;
 import com.slack.api.methods.SlackApiException;
 import com.slack.api.methods.response.chat.ChatPostMessageResponse;
 import com.slack.api.model.Message;
@@ -27,6 +28,7 @@ import com.slack.api.webhook.WebhookResponse;
 import org.apache.camel.AsyncCallback;
 import org.apache.camel.CamelExchangeException;
 import org.apache.camel.Exchange;
+import org.apache.camel.component.slack.helper.SlackHelper;
 import org.apache.camel.component.slack.helper.SlackMessage;
 import org.apache.camel.support.DefaultAsyncProducer;
 
@@ -44,7 +46,9 @@ public class SlackProducer extends DefaultAsyncProducer {
 
     @Override
     protected void doStart() throws Exception {
-        this.slack = Slack.getInstance(new CustomSlackHttpClient());
+        SlackConfig config = SlackHelper.createSlackConfig(slackEndpoint.getServerUrl());
+        CustomSlackHttpClient client = new CustomSlackHttpClient();
+        this.slack = Slack.getInstance(config, client);
         super.doStart();
     }
 
diff --git a/components/camel-slack/src/main/java/org/apache/camel/component/slack/helper/SlackHelper.java b/components/camel-slack/src/main/java/org/apache/camel/component/slack/helper/SlackHelper.java
new file mode 100644
index 0000000..3fef8c3
--- /dev/null
+++ b/components/camel-slack/src/main/java/org/apache/camel/component/slack/helper/SlackHelper.java
@@ -0,0 +1,52 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License.  You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.apache.camel.component.slack.helper;
+
+import com.slack.api.SlackConfig;
+import org.apache.camel.util.ObjectHelper;
+
+/**
+ * Utility methods for Slack
+ */
+public class SlackHelper {
+
+    private SlackHelper() {
+        // Utility class
+    }
+
+    /**
+     * Creates a {@link SlackConfig} instance.
+     * 
+     * @param  serverUrl The Slack server URL to use as prefix for API requests. If null or empty then the default
+     *                   SlackConfig instance is returned.
+     * @return           A new {@link SlackConfig} instance.
+     */
+    public static SlackConfig createSlackConfig(String serverUrl) {
+        SlackConfig config;
+        if (ObjectHelper.isNotEmpty(serverUrl)) {
+            config = new SlackConfig();
+            config.setAuditEndpointUrlPrefix(serverUrl);
+            config.setLegacyStatusEndpointUrlPrefix(serverUrl);
+            config.setMethodsEndpointUrlPrefix(serverUrl);
+            config.setScimEndpointUrlPrefix(serverUrl);
+            config.setStatusEndpointUrlPrefix(serverUrl);
+        } else {
+            config = SlackConfig.DEFAULT;
+        }
+        return config;
+    }
+}
diff --git a/components/camel-slack/src/test/java/org/apache/camel/component/slack/SlackHelperTest.java b/components/camel-slack/src/test/java/org/apache/camel/component/slack/SlackHelperTest.java
new file mode 100644
index 0000000..d8a21e7
--- /dev/null
+++ b/components/camel-slack/src/test/java/org/apache/camel/component/slack/SlackHelperTest.java
@@ -0,0 +1,49 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License.  You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.apache.camel.component.slack;
+
+import com.slack.api.SlackConfig;
+import org.apache.camel.component.slack.helper.SlackHelper;
+import org.junit.jupiter.api.Test;
+
+import static org.junit.jupiter.api.Assertions.assertEquals;
+
+public class SlackHelperTest {
+
+    @Test
+    public void testCreateDefaultSlackConfigForNullServerUrl() {
+        SlackConfig slackConfig = SlackHelper.createSlackConfig(null);
+        assertEquals(SlackConfig.DEFAULT, slackConfig);
+    }
+
+    @Test
+    public void testCreateDefaultSlackConfigForEmptyServerUrl() {
+        SlackConfig slackConfig = SlackHelper.createSlackConfig("");
+        assertEquals(SlackConfig.DEFAULT, slackConfig);
+    }
+
+    @Test
+    public void testCreateSlackConfigForServerUrl() {
+        String serverUrl = "http://foo.bar.com";
+        SlackConfig slackConfig = SlackHelper.createSlackConfig(serverUrl);
+        assertEquals(serverUrl, slackConfig.getAuditEndpointUrlPrefix());
+        assertEquals(serverUrl, slackConfig.getLegacyStatusEndpointUrlPrefix());
+        assertEquals(serverUrl, slackConfig.getMethodsEndpointUrlPrefix());
+        assertEquals(serverUrl, slackConfig.getScimEndpointUrlPrefix());
+        assertEquals(serverUrl, slackConfig.getStatusEndpointUrlPrefix());
+    }
+}