Set webhook URL Close (#592)

Close #582

Author: tokuhirom

line-bot-api-client/src/main/java/com/linecorp/bot/client/LineMessagingClient.java

@@ -30,6 +30,7 @@
 import com.linecorp.bot.model.group.GroupSummaryResponse;
 import com.linecorp.bot.model.profile.MembersIdsResponse;
 import com.linecorp.bot.model.profile.UserProfileResponse;
+import com.linecorp.bot.model.request.SetWebhookEndpointRequest;
 import com.linecorp.bot.model.request.TestWebhookEndpointRequest;
 import com.linecorp.bot.model.response.BotApiResponse;
 import com.linecorp.bot.model.response.BotInfoResponse;
@@ -42,6 +43,7 @@
 import com.linecorp.bot.model.response.NarrowcastProgressResponse;
 import com.linecorp.bot.model.response.NumberOfMessagesResponse;
 import com.linecorp.bot.model.response.QuotaConsumptionResponse;
+import com.linecorp.bot.model.response.SetWebhookEndpointResponse;
 import com.linecorp.bot.model.response.TestWebhookEndpointResponse;
 import com.linecorp.bot.model.response.demographics.GetFriendsDemographicsResponse;
 import com.linecorp.bot.model.richmenu.RichMenu;
@@ -388,6 +390,13 @@ public interface LineMessagingClient {
      */
     CompletableFuture<GetWebhookEndpointResponse> getWebhookEndpoint();
 
+    /**
+     * Sets webhook endpoint URL.
+     *
+     * @see <a href="https://developers.line.biz/en/reference/messaging-api/#set-webhook-endpoint-url">Set webhook URL</a>
+     */
+    CompletableFuture<SetWebhookEndpointResponse> setWebhookEndpoint(SetWebhookEndpointRequest request);
+
     /**
      * Tests webhook endpoint.
      *

line-bot-api-client/src/main/java/com/linecorp/bot/client/LineMessagingClientImpl.java

@@ -31,6 +31,7 @@
 import com.linecorp.bot.model.group.GroupSummaryResponse;
 import com.linecorp.bot.model.profile.MembersIdsResponse;
 import com.linecorp.bot.model.profile.UserProfileResponse;
+import com.linecorp.bot.model.request.SetWebhookEndpointRequest;
 import com.linecorp.bot.model.request.TestWebhookEndpointRequest;
 import com.linecorp.bot.model.response.BotApiResponse;
 import com.linecorp.bot.model.response.BotInfoResponse;
@@ -43,6 +44,7 @@
 import com.linecorp.bot.model.response.NarrowcastProgressResponse;
 import com.linecorp.bot.model.response.NumberOfMessagesResponse;
 import com.linecorp.bot.model.response.QuotaConsumptionResponse;
+import com.linecorp.bot.model.response.SetWebhookEndpointResponse;
 import com.linecorp.bot.model.response.TestWebhookEndpointResponse;
 import com.linecorp.bot.model.response.demographics.GetFriendsDemographicsResponse;
 import com.linecorp.bot.model.richmenu.RichMenu;
@@ -293,6 +295,11 @@ public CompletableFuture<GetWebhookEndpointResponse> getWebhookEndpoint() {
         return toFuture(retrofitImpl.getWebhookEndpoint());
     }
 
+    @Override
+    public CompletableFuture<SetWebhookEndpointResponse> setWebhookEndpoint(SetWebhookEndpointRequest request) {
+        return toFuture(retrofitImpl.setWebhookEndpoint(request));
+    }
+
     @Override
     public CompletableFuture<TestWebhookEndpointResponse> testWebhookEndpoint(
             TestWebhookEndpointRequest request) {

line-bot-api-client/src/main/java/com/linecorp/bot/client/LineMessagingService.java

@@ -27,6 +27,7 @@
 import com.linecorp.bot.model.group.GroupSummaryResponse;
 import com.linecorp.bot.model.profile.MembersIdsResponse;
 import com.linecorp.bot.model.profile.UserProfileResponse;
+import com.linecorp.bot.model.request.SetWebhookEndpointRequest;
 import com.linecorp.bot.model.request.TestWebhookEndpointRequest;
 import com.linecorp.bot.model.response.BotInfoResponse;
 import com.linecorp.bot.model.response.GetMessageEventResponse;
@@ -38,6 +39,7 @@
 import com.linecorp.bot.model.response.NarrowcastProgressResponse;
 import com.linecorp.bot.model.response.NumberOfMessagesResponse;
 import com.linecorp.bot.model.response.QuotaConsumptionResponse;
+import com.linecorp.bot.model.response.SetWebhookEndpointResponse;
 import com.linecorp.bot.model.response.TestWebhookEndpointResponse;
 import com.linecorp.bot.model.response.demographics.GetFriendsDemographicsResponse;
 import com.linecorp.bot.model.richmenu.RichMenu;
@@ -54,6 +56,7 @@
 import retrofit2.http.GET;
 import retrofit2.http.Header;
 import retrofit2.http.POST;
+import retrofit2.http.PUT;
 import retrofit2.http.Path;
 import retrofit2.http.Query;
 
@@ -389,6 +392,9 @@ Call<Void> linkRichMenuToUser(
     @GET("v2/bot/channel/webhook/endpoint")
     Call<GetWebhookEndpointResponse> getWebhookEndpoint();
 
+    @PUT("v2/bot/channel/webhook/endpoint")
+    Call<SetWebhookEndpointResponse> setWebhookEndpoint(@Body SetWebhookEndpointRequest request);
+
     @POST("v2/bot/channel/webhook/test")
     Call<TestWebhookEndpointResponse> testWebhookEndpoint(@Body TestWebhookEndpointRequest request);
 }

line-bot-api-client/src/test/java/com/linecorp/bot/client/LineMessagingClientImplTest.java

@@ -55,6 +55,7 @@
 import com.linecorp.bot.model.narrowcast.filter.GenderDemographicFilter.Gender;
 import com.linecorp.bot.model.profile.MembersIdsResponse;
 import com.linecorp.bot.model.profile.UserProfileResponse;
+import com.linecorp.bot.model.request.SetWebhookEndpointRequest;
 import com.linecorp.bot.model.request.TestWebhookEndpointRequest;
 import com.linecorp.bot.model.response.BotApiResponse;
 import com.linecorp.bot.model.response.BotInfoResponse;
@@ -68,6 +69,7 @@
 import com.linecorp.bot.model.response.NarrowcastProgressResponse.Phase;
 import com.linecorp.bot.model.response.NumberOfMessagesResponse;
 import com.linecorp.bot.model.response.QuotaConsumptionResponse;
+import com.linecorp.bot.model.response.SetWebhookEndpointResponse;
 import com.linecorp.bot.model.response.TestWebhookEndpointResponse;
 import com.linecorp.bot.model.richmenu.RichMenu;
 import com.linecorp.bot.model.richmenu.RichMenuBulkLinkRequest;
@@ -680,6 +682,21 @@ public void getWebhookEndpoint() throws Exception {
         assertThat(actual).isEqualTo(response);
     }
 
+    @Test
+    public void setWebhookEndpoint() throws Exception {
+        final SetWebhookEndpointResponse response = SetWebhookEndpointResponse
+                .builder()
+                .build();
+        final SetWebhookEndpointRequest request = SetWebhookEndpointRequest
+                .builder()
+                .endpoint(URI.create("http://example.com/my/great/endpoint"))
+                .build();
+        whenCall(retrofitMock.setWebhookEndpoint(request), response);
+        final SetWebhookEndpointResponse actual = target.setWebhookEndpoint(request).get();
+        verify(retrofitMock, only()).setWebhookEndpoint(request);
+        assertThat(actual).isEqualTo(response);
+    }
+
     @Test
     public void testWebhookEndpoint() throws Exception {
         final TestWebhookEndpointResponse response = TestWebhookEndpointResponse

line-bot-model/src/main/java/com/linecorp/bot/model/request/SetWebhookEndpointRequest.java

@@ -0,0 +1,41 @@
+/*
+ * Copyright 2020 LINE Corporation
+ *
+ * LINE Corporation 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 com.linecorp.bot.model.request;
+
+import java.net.URI;
+
+import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
+import com.fasterxml.jackson.databind.annotation.JsonPOJOBuilder;
+
+import com.linecorp.bot.model.request.SetWebhookEndpointRequest.SetWebhookEndpointRequestBuilder;
+
+import lombok.Builder;
+import lombok.Value;
+
+@Value
+@Builder
+@JsonDeserialize(builder = SetWebhookEndpointRequestBuilder.class)
+public class SetWebhookEndpointRequest {
+    /**
+     * A valid webhook URL.
+     */
+    URI endpoint;
+
+    @JsonPOJOBuilder(withPrefix = "")
+    public static class SetWebhookEndpointRequestBuilder {
+    }
+}

line-bot-model/src/main/java/com/linecorp/bot/model/response/SetWebhookEndpointResponse.java

@@ -0,0 +1,35 @@
+/*
+ * Copyright 2020 LINE Corporation
+ *
+ * LINE Corporation 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 com.linecorp.bot.model.response;
+
+import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
+import com.fasterxml.jackson.databind.annotation.JsonPOJOBuilder;
+
+import com.linecorp.bot.model.response.SetWebhookEndpointResponse.SetWebhookEndpointResponseBuilder;
+
+import lombok.Builder;
+import lombok.Value;
+
+@Value
+@Builder
+@JsonDeserialize(builder = SetWebhookEndpointResponseBuilder.class)
+public class SetWebhookEndpointResponse {
+
+    @JsonPOJOBuilder(withPrefix = "")
+    public static class SetWebhookEndpointResponseBuilder {
+    }
+}

sample-manage-audience/src/main/java/com/linecorp/bot/messagingapidemoapp/controller/BotController.java

@@ -28,10 +28,12 @@
 
 import com.linecorp.bot.client.LineMessagingClient;
 import com.linecorp.bot.client.exception.NotFoundException;
+import com.linecorp.bot.model.request.SetWebhookEndpointRequest;
 import com.linecorp.bot.model.request.TestWebhookEndpointRequest;
 import com.linecorp.bot.model.request.TestWebhookEndpointRequest.TestWebhookEndpointRequestBuilder;
 import com.linecorp.bot.model.response.BotInfoResponse;
 import com.linecorp.bot.model.response.GetWebhookEndpointResponse;
+import com.linecorp.bot.model.response.SetWebhookEndpointResponse;
 import com.linecorp.bot.model.response.TestWebhookEndpointResponse;
 
 import lombok.AllArgsConstructor;
@@ -63,9 +65,22 @@ public String webhook(Model model) throws InterruptedException, ExecutionExcepti
         return "bot/get_webhook";
     }
 
+    @PostMapping("/bot/set_webhook")
+    public String setWebhook(Model model,
+                             @RequestParam("url") URI uri) {
+        SetWebhookEndpointRequest request = SetWebhookEndpointRequest.builder()
+                                                                     .endpoint(uri)
+                                                                     .build();
+        SetWebhookEndpointResponse response = client.setWebhookEndpoint(
+                request
+        ).join();
+        model.addAttribute("response", response);
+        return "redirect:/bot/webhook";
+    }
+
     @PostMapping("/bot/test_webhook")
     public String testWebhook(Model model,
-                              @RequestParam("url") URI uri) throws InterruptedException, ExecutionException {
+                              @RequestParam(value = "url", required = false) URI uri) {
         TestWebhookEndpointRequestBuilder builder = TestWebhookEndpointRequest.builder();
         if (uri != null) {
             builder.endpoint(uri);

sample-manage-audience/src/main/resources/templates/bot/get_webhook.ftlh

@@ -20,6 +20,18 @@
         </table>
     </#if>
 
+    <h2>Set webhook</h2>
+    <form action="/bot/set_webhook" method="post">
+        <table>
+            <tr>
+                <th><label for="webhookTestUrl">URL</label></th>
+                <td><input id="webhookTestUrl" type="url" name="url" required>
+                    <button type="submit">Set</button>
+                </td>
+            </tr>
+        </table>
+    </form>
+
     <h2>Test webhook</h2>
     <form method="post" action="/bot/test_webhook">
         <table>