Merge pull request #325 from imasahiro/issue324

Supports Link/Unlink rich menu to/from multiple users

Author: Junpei Koyama

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

@@ -16,6 +16,7 @@
 
 package com.linecorp.bot.client;
 
+import java.util.List;
 import java.util.concurrent.CompletableFuture;
 
 import com.linecorp.bot.model.Multicast;
@@ -208,13 +209,29 @@ CompletableFuture<MembersIdsResponse> getRoomMembersIds(
      */
     CompletableFuture<BotApiResponse> linkRichMenuIdToUser(String userId, String richMenuId);
 
+    /**
+     * Link rich menu to users.
+     *
+     * @see <a href="https://developers.line.biz/en/reference/messaging-api/#link-rich-menu-to-users">
+     *     Link rich menu to multiple users</a>
+     */
+    CompletableFuture<BotApiResponse> linkRichMenuIdToUsers(List<String> userIds, String richMenuId);
+
     /**
      * Unlink rich menu from user.
      *
      * @see <a href="https://developers.line.me/en/docs/messaging-api/reference/#unlink-rich-menu-from-user">//developers.line.me/en/docs/messaging-api/reference/#unlink-rich-menu-from-user</a>
      */
     CompletableFuture<BotApiResponse> unlinkRichMenuIdFromUser(String userId);
 
+    /**
+     * Unlink rich menu from users.
+     *
+     * @see <a href="https://developers.line.biz/en/reference/messaging-api/#unlink-rich-menu-from-users">
+     *     Unlink rich menu to multiple users</a>
+     */
+    CompletableFuture<BotApiResponse> unlinkRichMenuIdFromUsers(List<String> userIds);
+
     /**
      * Download rich menu image.
      *

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

@@ -18,6 +18,7 @@
 
 import static java.util.Collections.emptyList;
 
+import java.util.List;
 import java.util.concurrent.CompletableFuture;
 import java.util.function.Function;
 
@@ -31,6 +32,8 @@
 import com.linecorp.bot.model.response.IssueLinkTokenResponse;
 import com.linecorp.bot.model.response.NumberOfMessagesResponse;
 import com.linecorp.bot.model.richmenu.RichMenu;
+import com.linecorp.bot.model.richmenu.RichMenuBlukLinkRequest;
+import com.linecorp.bot.model.richmenu.RichMenuBlukUnlinkRequest;
 import com.linecorp.bot.model.richmenu.RichMenuIdResponse;
 import com.linecorp.bot.model.richmenu.RichMenuListResponse;
 import com.linecorp.bot.model.richmenu.RichMenuResponse;
@@ -159,11 +162,26 @@ public CompletableFuture<BotApiResponse> linkRichMenuIdToUser(
         return toBotApiFuture(retrofitImpl.linkRichMenuToUser(userId, richMenuId));
     }
 
+    @Override
+    public CompletableFuture<BotApiResponse> linkRichMenuIdToUsers(List<String> userIds, String richMenuId) {
+        return toBotApiFuture(retrofitImpl.linkRichMenuToUsers(RichMenuBlukLinkRequest.builder()
+                                                                                      .richMenuId(richMenuId)
+                                                                                      .userIds(userIds)
+                                                                                      .build()));
+    }
+
     @Override
     public CompletableFuture<BotApiResponse> unlinkRichMenuIdFromUser(final String userId) {
         return toBotApiFuture(retrofitImpl.unlinkRichMenuIdFromUser(userId));
     }
 
+    @Override
+    public CompletableFuture<BotApiResponse> unlinkRichMenuIdFromUsers(List<String> userIds) {
+        return toBotApiFuture(retrofitImpl.unlinkRichMenuIdFromUsers(RichMenuBlukUnlinkRequest.builder()
+                                                                                              .userIds(userIds)
+                                                                                              .build()));
+    }
+
     @Override
     public CompletableFuture<MessageContentResponse> getRichMenuImage(final String richMenuId) {
         return toMessageContentResponseFuture(retrofitImpl.getRichMenuImage(richMenuId));

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

@@ -16,6 +16,8 @@
 
 package com.linecorp.bot.client;
 
+import java.util.List;
+
 import com.linecorp.bot.model.Multicast;
 import com.linecorp.bot.model.PushMessage;
 import com.linecorp.bot.model.ReplyMessage;
@@ -25,6 +27,8 @@
 import com.linecorp.bot.model.response.IssueLinkTokenResponse;
 import com.linecorp.bot.model.response.NumberOfMessagesResponse;
 import com.linecorp.bot.model.richmenu.RichMenu;
+import com.linecorp.bot.model.richmenu.RichMenuBlukLinkRequest;
+import com.linecorp.bot.model.richmenu.RichMenuBlukUnlinkRequest;
 import com.linecorp.bot.model.richmenu.RichMenuIdResponse;
 import com.linecorp.bot.model.richmenu.RichMenuListResponse;
 import com.linecorp.bot.model.richmenu.RichMenuResponse;
@@ -198,6 +202,14 @@ Call<Void> linkRichMenuToUser(
             @Path("userId") String userId,
             @Path("richMenuId") String richMenuId);
 
+    /**
+     * Method for Retrofit.
+     *
+     * @see LineMessagingClient#linkRichMenuIdToUsers(List, String)
+     */
+    @POST("v2/bot/richmenu/bulk/link")
+    Call<Void> linkRichMenuToUsers(@Body RichMenuBlukLinkRequest request);
+
     /**
      * Method for Retrofit.
      *
@@ -206,6 +218,14 @@ Call<Void> linkRichMenuToUser(
     @DELETE("v2/bot/user/{userId}/richmenu")
     Call<Void> unlinkRichMenuIdFromUser(@Path("userId") String userId);
 
+    /**
+     * Method for Retrofit.
+     *
+     * @see LineMessagingClient#unlinkRichMenuIdFromUser(String)
+     */
+    @DELETE("v2/bot/richmenu/bulk/unlink")
+    Call<Void> unlinkRichMenuIdFromUsers(@Body RichMenuBlukUnlinkRequest request);
+
     /**
      * Method for Retrofit.
      *

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

@@ -26,6 +26,7 @@
 import static org.mockito.Mockito.when;
 
 import java.io.IOException;
+import java.util.Collections;
 
 import org.junit.Rule;
 import org.junit.Test;
@@ -47,6 +48,8 @@
 import com.linecorp.bot.model.response.NumberOfMessagesResponse;
 import com.linecorp.bot.model.response.NumberOfMessagesResponse.Status;
 import com.linecorp.bot.model.richmenu.RichMenu;
+import com.linecorp.bot.model.richmenu.RichMenuBlukLinkRequest;
+import com.linecorp.bot.model.richmenu.RichMenuBlukUnlinkRequest;
 import com.linecorp.bot.model.richmenu.RichMenuIdResponse;
 import com.linecorp.bot.model.richmenu.RichMenuListResponse;
 import com.linecorp.bot.model.richmenu.RichMenuResponse;
@@ -299,7 +302,6 @@ public void getRichMenuIdOfUserTest() throws Exception {
         // Verify
         verify(retrofitMock, only()).getRichMenuIdOfUser("ID");
         assertThat(richMenuIdResponse).isEqualTo(RICH_MENU_ID_RESPONSE);
-
     }
 
     @Test
@@ -313,11 +315,27 @@ public void linkRichMenuToUserTest() throws Exception {
         // Verify
         verify(retrofitMock, only()).linkRichMenuToUser("USER_ID", "RICH_MENU_ID");
         assertThat(botApiResponse).isEqualTo(BOT_API_SUCCESS_RESPONSE);
+    }
+
+    @Test
+    public void linkRichMenuToUsers() {
+        whenCall(retrofitMock.linkRichMenuToUsers(any()), null);
 
+        // Do
+        final BotApiResponse botApiResponse = target.linkRichMenuIdToUsers(Collections.singletonList("USER_ID"),
+                                                                           "RICH_MENU_ID")
+                                                    .join();
+
+        // Verify
+        verify(retrofitMock, only()).linkRichMenuToUsers(RichMenuBlukLinkRequest.builder()
+                                                                                .richMenuId("RICH_MENU_ID")
+                                                                                .userId("USER_ID")
+                                                                                .build());
+        assertThat(botApiResponse).isEqualTo(BOT_API_SUCCESS_RESPONSE);
     }
 
     @Test
-    public void unlinkRichMenuIdToUserTest() throws Exception {
+    public void unlinkRichMenuIdFromUser() throws Exception {
         whenCall(retrofitMock.unlinkRichMenuIdFromUser(any()),
                  null);
 
@@ -327,7 +345,21 @@ public void unlinkRichMenuIdToUserTest() throws Exception {
         // Verify
         verify(retrofitMock, only()).unlinkRichMenuIdFromUser("ID");
         assertThat(botApiResponse).isEqualTo(BOT_API_SUCCESS_RESPONSE);
+    }
+
+    @Test
+    public void unlinkRichMenuIdFromUsers() throws Exception {
+        whenCall(retrofitMock.unlinkRichMenuIdFromUsers(any()),
+                 null);
 
+        // Do
+        final BotApiResponse botApiResponse = target.unlinkRichMenuIdFromUsers(Collections.singletonList("ID"))
+                                                    .join();
+
+        // Verify
+        verify(retrofitMock, only()).unlinkRichMenuIdFromUsers(
+                RichMenuBlukUnlinkRequest.builder().userId("ID").build());
+        assertThat(botApiResponse).isEqualTo(BOT_API_SUCCESS_RESPONSE);
     }
 
     @Test

line-bot-model/src/main/java/com/linecorp/bot/model/richmenu/RichMenuBlukLinkRequest.java

@@ -0,0 +1,31 @@
+/*
+ * Copyright 2019 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.richmenu;
+
+import java.util.List;
+
+import lombok.Builder;
+import lombok.Singular;
+import lombok.Value;
+
+@Value
+@Builder
+public class RichMenuBlukLinkRequest {
+    String richMenuId;
+    @Singular
+    List<String> userIds;
+}

line-bot-model/src/main/java/com/linecorp/bot/model/richmenu/RichMenuBlukUnlinkRequest.java

@@ -0,0 +1,30 @@
+/*
+ * Copyright 2019 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.richmenu;
+
+import java.util.List;
+
+import lombok.Builder;
+import lombok.Singular;
+import lombok.Value;
+
+@Value
+@Builder
+public class RichMenuBlukUnlinkRequest {
+    @Singular
+    List<String> userIds;
+}