Support 2020 June update. (#550)

tokuhirom · web-flow · commit 15dddbf7f915 · 2020-07-16T12:05:12.000+09:00
- Get group summary - Get members in group count - Get members in room count - Close #538
diff --git a/line-bot-api-client/src/main/java/com/linecorp/bot/client/LineMessagingClient.java b/line-bot-api-client/src/main/java/com/linecorp/bot/client/LineMessagingClient.java
@@ -26,6 +26,8 @@
 import com.linecorp.bot.model.ReplyMessage;
 import com.linecorp.bot.model.event.source.GroupSource;
 import com.linecorp.bot.model.event.source.RoomSource;
+import com.linecorp.bot.model.group.GroupMemberCountResponse;
+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.response.BotApiResponse;
@@ -42,6 +44,7 @@
 import com.linecorp.bot.model.richmenu.RichMenuIdResponse;
 import com.linecorp.bot.model.richmenu.RichMenuListResponse;
 import com.linecorp.bot.model.richmenu.RichMenuResponse;
+import com.linecorp.bot.model.room.RoomMemberCountResponse;
 
 public interface LineMessagingClient {
     /**
@@ -229,6 +232,27 @@ public interface LineMessagingClient {
      */
     CompletableFuture<BotApiResponse> leaveRoom(String roomId);
 
+    /**
+     * Get group summary.
+     *
+     * @see <a href="https://developers.line.biz/en/reference/messaging-api/#group">//developers.line.biz/en/reference/messaging-api/#group</a>
+     */
+    CompletableFuture<GroupSummaryResponse> getGroupSummary(String groupId);
+
+    /**
+     * Get members in group count.
+     *
+     * @see <a href="https://developers.line.biz/en/reference/messaging-api/#get-members-group-count">//developers.line.biz/en/reference/messaging-api/#get-members-group-count</a>
+     */
+    CompletableFuture<GroupMemberCountResponse> getGroupMemberCount(String groupId);
+
+    /**
+     * Get members in room count.
+     *
+     * @see <a href="https://developers.line.biz/en/reference/messaging-api/#get-members-room-count">//developers.line.biz/en/reference/messaging-api/#get-members-room-count</a>
+     */
+    CompletableFuture<RoomMemberCountResponse> getRoomMemberCount(String roomId);
+
     /**
      * Get a rich menu.
      *
diff --git a/line-bot-api-client/src/main/java/com/linecorp/bot/client/LineMessagingClientImpl.java b/line-bot-api-client/src/main/java/com/linecorp/bot/client/LineMessagingClientImpl.java
@@ -27,6 +27,8 @@
 import com.linecorp.bot.model.Narrowcast;
 import com.linecorp.bot.model.PushMessage;
 import com.linecorp.bot.model.ReplyMessage;
+import com.linecorp.bot.model.group.GroupMemberCountResponse;
+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.response.BotApiResponse;
@@ -45,6 +47,7 @@
 import com.linecorp.bot.model.richmenu.RichMenuIdResponse;
 import com.linecorp.bot.model.richmenu.RichMenuListResponse;
 import com.linecorp.bot.model.richmenu.RichMenuResponse;
+import com.linecorp.bot.model.room.RoomMemberCountResponse;
 
 import lombok.AllArgsConstructor;
 import lombok.extern.slf4j.Slf4j;
@@ -177,6 +180,21 @@ public CompletableFuture<BotApiResponse> leaveRoom(final String roomId) {
         return toBotApiResponseFuture(retrofitImpl.leaveRoom(roomId));
     }
 
+    @Override
+    public CompletableFuture<GroupSummaryResponse> getGroupSummary(final String groupId) {
+        return toFuture(retrofitImpl.getGroupSummary(groupId));
+    }
+
+    @Override
+    public CompletableFuture<GroupMemberCountResponse> getGroupMemberCount(String groupId) {
+        return toFuture(retrofitImpl.getGroupMemberCount(groupId));
+    }
+
+    @Override
+    public CompletableFuture<RoomMemberCountResponse> getRoomMemberCount(String roomId) {
+        return toFuture(retrofitImpl.getRoomMemberCount(roomId));
+    }
+
     @Override
     public CompletableFuture<RichMenuResponse> getRichMenu(final String richMenuId) {
         return toFuture(retrofitImpl.getRichMenu(richMenuId));
diff --git a/line-bot-api-client/src/main/java/com/linecorp/bot/client/LineMessagingService.java b/line-bot-api-client/src/main/java/com/linecorp/bot/client/LineMessagingService.java
@@ -23,6 +23,8 @@
 import com.linecorp.bot.model.Narrowcast;
 import com.linecorp.bot.model.PushMessage;
 import com.linecorp.bot.model.ReplyMessage;
+import com.linecorp.bot.model.group.GroupMemberCountResponse;
+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.response.GetMessageEventResponse;
@@ -40,6 +42,7 @@
 import com.linecorp.bot.model.richmenu.RichMenuIdResponse;
 import com.linecorp.bot.model.richmenu.RichMenuListResponse;
 import com.linecorp.bot.model.richmenu.RichMenuResponse;
+import com.linecorp.bot.model.room.RoomMemberCountResponse;
 
 import retrofit2.Call;
 import retrofit2.http.Body;
@@ -214,6 +217,24 @@ Call<MembersIdsResponse> getMembersIds(
     @POST("v2/bot/room/{roomId}/leave")
     Call<BotApiResponseBody> leaveRoom(@Path("roomId") String roomId);
 
+    /**
+     * Get group summary.
+     */
+    @GET("v2/bot/group/{groupId}/summary")
+    Call<GroupSummaryResponse> getGroupSummary(@Path("groupId") String groupId);
+
+    /**
+     * Get members in group count.
+     */
+    @GET("v2/bot/group/{groupId}/members/count")
+    Call<GroupMemberCountResponse> getGroupMemberCount(@Path("groupId") String groupId);
+
+    /**
+     * Get members in room count.
+     */
+    @GET("v2/bot/room/{roomId}/members/count")
+    Call<RoomMemberCountResponse> getRoomMemberCount(@Path("roomId") String roomId);
+
     /**
      * Method for Retrofit.
      *
diff --git a/line-bot-api-client/src/test/java/com/linecorp/bot/client/LineMessagingClientImplTest.java b/line-bot-api-client/src/test/java/com/linecorp/bot/client/LineMessagingClientImplTest.java
@@ -44,6 +44,8 @@
 import com.linecorp.bot.model.Narrowcast;
 import com.linecorp.bot.model.PushMessage;
 import com.linecorp.bot.model.ReplyMessage;
+import com.linecorp.bot.model.group.GroupMemberCountResponse;
+import com.linecorp.bot.model.group.GroupSummaryResponse;
 import com.linecorp.bot.model.message.TextMessage;
 import com.linecorp.bot.model.narrowcast.Filter;
 import com.linecorp.bot.model.narrowcast.filter.GenderDemographicFilter;
@@ -66,6 +68,7 @@
 import com.linecorp.bot.model.richmenu.RichMenuIdResponse;
 import com.linecorp.bot.model.richmenu.RichMenuListResponse;
 import com.linecorp.bot.model.richmenu.RichMenuResponse;
+import com.linecorp.bot.model.room.RoomMemberCountResponse;
 
 import okhttp3.Headers;
 import okhttp3.Request;
@@ -361,6 +364,59 @@ public void leaveRoomTest() throws Exception {
         assertThat(botApiResponse).isEqualTo(BOT_API_SUCCESS_RESPONSE);
     }
 
+    @Test
+    public void getGroupSummary() throws Exception {
+        GroupSummaryResponse dummyResponse = GroupSummaryResponse
+                .builder()
+                .build();
+        whenCall(retrofitMock.getGroupSummary(any()),
+                 dummyResponse);
+
+        // Do
+        GroupSummaryResponse got = target.getGroupSummary("GGGGGGGGGGGGGGGGGG")
+                                         .get();
+
+        // Verify
+        verify(retrofitMock, only()).getGroupSummary("GGGGGGGGGGGGGGGGGG");
+        assertThat(got).isEqualTo(dummyResponse);
+    }
+
+    @Test
+    public void getGroupMemberCount() throws Exception {
+        GroupMemberCountResponse dummyResponse = GroupMemberCountResponse
+                .builder()
+                .count(3L)
+                .build();
+        whenCall(retrofitMock.getGroupMemberCount(any()),
+                 dummyResponse);
+
+        // Do
+        GroupMemberCountResponse got = target.getGroupMemberCount("GGGGGGGGGGGGGGGGGG")
+                                             .get();
+
+        // Verify
+        verify(retrofitMock, only()).getGroupMemberCount("GGGGGGGGGGGGGGGGGG");
+        assertThat(got).isEqualTo(dummyResponse);
+    }
+
+    @Test
+    public void getRoomMemberCount() throws Exception {
+        RoomMemberCountResponse dummyResponse = RoomMemberCountResponse
+                .builder()
+                .count(3L)
+                .build();
+        whenCall(retrofitMock.getRoomMemberCount(any()),
+                 dummyResponse);
+
+        // Do
+        RoomMemberCountResponse got = target.getRoomMemberCount("GGGGGGGGGGGGGGGGGG")
+                                            .get();
+
+        // Verify
+        verify(retrofitMock, only()).getRoomMemberCount("GGGGGGGGGGGGGGGGGG");
+        assertThat(got).isEqualTo(dummyResponse);
+    }
+
     @Test
     public void getRichMenuTest() throws Exception {
         final RichMenuResponse richMenuReference = new RichMenuResponse(null, null, false, null, null, null);
diff --git a/line-bot-model/src/main/java/com/linecorp/bot/model/group/GroupMemberCountResponse.java b/line-bot-model/src/main/java/com/linecorp/bot/model/group/GroupMemberCountResponse.java
@@ -0,0 +1,40 @@
+/*
+ * 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.group;
+
+import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
+import com.fasterxml.jackson.databind.annotation.JsonPOJOBuilder;
+
+import com.linecorp.bot.model.group.GroupMemberCountResponse.GroupMemberCountResponseBuilder;
+
+import lombok.Builder;
+import lombok.Value;
+
+@Value
+@Builder
+@JsonDeserialize(builder = GroupMemberCountResponseBuilder.class)
+public class GroupMemberCountResponse {
+    /**
+     * The count of members in the room. The number returned excludes the LINE Official Account.
+     */
+    long count;
+
+    @JsonPOJOBuilder(withPrefix = "")
+    public static class GroupMemberCountResponseBuilder {
+        // Filled by lombok
+    }
+}
diff --git a/line-bot-model/src/main/java/com/linecorp/bot/model/group/GroupSummaryResponse.java b/line-bot-model/src/main/java/com/linecorp/bot/model/group/GroupSummaryResponse.java
@@ -0,0 +1,52 @@
+/*
+ * 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.group;
+
+import java.net.URL;
+
+import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
+import com.fasterxml.jackson.databind.annotation.JsonPOJOBuilder;
+
+import com.linecorp.bot.model.group.GroupSummaryResponse.GroupSummaryResponseBuilder;
+
+import lombok.Builder;
+import lombok.Value;
+
+@Value
+@Builder
+@JsonDeserialize(builder = GroupSummaryResponseBuilder.class)
+public class GroupSummaryResponse {
+    /**
+     * Group ID.
+     */
+    String groupId;
+
+    /**
+     * Group name.
+     */
+    String groupName;
+
+    /**
+     * Group icon URL.
+     */
+    URL pictureUrl;
+
+    @JsonPOJOBuilder(withPrefix = "")
+    public static class GroupSummaryResponseBuilder {
+        // Filled by lombok
+    }
+}
diff --git a/line-bot-model/src/main/java/com/linecorp/bot/model/room/RoomMemberCountResponse.java b/line-bot-model/src/main/java/com/linecorp/bot/model/room/RoomMemberCountResponse.java
@@ -0,0 +1,40 @@
+/*
+ * 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.room;
+
+import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
+import com.fasterxml.jackson.databind.annotation.JsonPOJOBuilder;
+
+import com.linecorp.bot.model.room.RoomMemberCountResponse.RoomMemberCountResponseBuilder;
+
+import lombok.Builder;
+import lombok.Value;
+
+@Value
+@Builder
+@JsonDeserialize(builder = RoomMemberCountResponseBuilder.class)
+public class RoomMemberCountResponse {
+    /**
+     * The count of members in the room. The number returned excludes the LINE Official Account.
+     */
+    long count;
+
+    @JsonPOJOBuilder(withPrefix = "")
+    public static class RoomMemberCountResponseBuilder {
+        // Filled by lombok
+    }
+}
diff --git a/sample-spring-boot-kitchensink/src/main/java/com/example/bot/spring/KitchenSinkController.java b/sample-spring-boot-kitchensink/src/main/java/com/example/bot/spring/KitchenSinkController.java
@@ -67,6 +67,8 @@
 import com.linecorp.bot.model.event.source.GroupSource;
 import com.linecorp.bot.model.event.source.RoomSource;
 import com.linecorp.bot.model.event.source.Source;
+import com.linecorp.bot.model.group.GroupMemberCountResponse;
+import com.linecorp.bot.model.group.GroupSummaryResponse;
 import com.linecorp.bot.model.message.AudioMessage;
 import com.linecorp.bot.model.message.ImageMessage;
 import com.linecorp.bot.model.message.ImagemapMessage;
@@ -90,6 +92,7 @@
 import com.linecorp.bot.model.message.template.ImageCarouselColumn;
 import com.linecorp.bot.model.message.template.ImageCarouselTemplate;
 import com.linecorp.bot.model.response.BotApiResponse;
+import com.linecorp.bot.model.room.RoomMemberCountResponse;
 import com.linecorp.bot.spring.boot.annotation.EventMapping;
 import com.linecorp.bot.spring.boot.annotation.LineMessageHandler;
 
@@ -373,6 +376,44 @@ private void handleTextContent(String replyToken, Event event, TextMessageConten
                 }
                 break;
             }
+            case "group_summary": {
+                Source source = event.getSource();
+                if (source instanceof GroupSource) {
+                    GroupSummaryResponse groupSummary = lineMessagingClient.getGroupSummary(
+                            ((GroupSource) source).getGroupId()).get();
+                    this.replyText(replyToken, "Group summary: " + groupSummary);
+                } else {
+                    this.replyText(replyToken, "You can't use 'group_summary' command for "
+                                               + source);
+                }
+                break;
+            }
+            case "group_member_count": {
+                Source source = event.getSource();
+                if (source instanceof GroupSource) {
+                    GroupMemberCountResponse groupMemberCountResponse = lineMessagingClient.getGroupMemberCount(
+                            ((GroupSource) source).getGroupId()).get();
+                    this.replyText(replyToken, "Group member count: "
+                                               + groupMemberCountResponse.getCount());
+                } else {
+                    this.replyText(replyToken, "You can't use 'group_member_count' command  for "
+                                               + source);
+                }
+                break;
+            }
+            case "room_member_count": {
+                Source source = event.getSource();
+                if (source instanceof RoomSource) {
+                    RoomMemberCountResponse roomMemberCountResponse = lineMessagingClient.getRoomMemberCount(
+                            ((RoomSource) source).getRoomId()).get();
+                    this.replyText(replyToken, "Room member count: "
+                                               + roomMemberCountResponse.getCount());
+                } else {
+                    this.replyText(replyToken, "You can't use 'room_member_count' command  for "
+                                               + source);
+                }
+                break;
+            }
             case "confirm": {
                 ConfirmTemplate confirmTemplate = new ConfirmTemplate(
                         "Do it?",
