Merge pull request #487 from kazuki-ma/ManageAudienceClient

NON-ISSUE Split ManageAudienceClient from LineMessagingClient.

Author: kazuki-ma

line-bot-api-client/src/integrationTest/java/com/linecorp/bot/client/ManageAudienceClientFactory.java

@@ -0,0 +1,46 @@
+/*
+ * 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.client;
+
+import java.net.URI;
+
+import com.fasterxml.jackson.databind.DeserializationFeature;
+import com.fasterxml.jackson.databind.ObjectMapper;
+
+import com.linecorp.bot.model.objectmapper.ModelObjectMapper;
+
+import retrofit2.Retrofit;
+import retrofit2.converter.jackson.JacksonConverterFactory;
+
+public class ManageAudienceClientFactory {
+    public static ManageAudienceClient create(IntegrationTestSettings settings) {
+        ObjectMapper objectMapper = ModelObjectMapper
+                .createNewObjectMapper()
+                .configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES,
+                           settings.isFailOnUnknownProperties());
+
+        Retrofit.Builder retrofitBuilder = new Retrofit.Builder()
+                .addConverterFactory(JacksonConverterFactory.create(objectMapper));
+
+        return ManageAudienceClient
+                .builder()
+                .channelToken(settings.getToken())
+                .apiEndPoint(URI.create(settings.getEndpoint()))
+                .retrofitBuilder(retrofitBuilder)
+                .build();
+    }
+}

line-bot-api-client/src/integrationTest/java/com/linecorp/bot/client/ManageAudienceIntegrationTest.java

@@ -48,13 +48,13 @@
 
 @Slf4j
 public class ManageAudienceIntegrationTest {
-    private LineMessagingClient target;
+    private ManageAudienceClient target;
     private IntegrationTestSettings settings;
 
     @Before
     public void setUp() throws IOException {
         settings = IntegrationTestSettingsLoader.load();
-        target = LineMessagingClientFactory.create(settings);
+        target = ManageAudienceClientFactory.create(settings);
     }
 
     @Test

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

@@ -26,20 +26,6 @@
 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.manageaudience.AudienceGroupCreateRoute;
-import com.linecorp.bot.model.manageaudience.AudienceGroupStatus;
-import com.linecorp.bot.model.manageaudience.request.AddAudienceToAudienceGroupRequest;
-import com.linecorp.bot.model.manageaudience.request.CreateAudienceGroupRequest;
-import com.linecorp.bot.model.manageaudience.request.CreateClickBasedAudienceGroupRequest;
-import com.linecorp.bot.model.manageaudience.request.CreateImpBasedAudienceGroupRequest;
-import com.linecorp.bot.model.manageaudience.request.UpdateAudienceGroupAuthorityLevelRequest;
-import com.linecorp.bot.model.manageaudience.request.UpdateAudienceGroupDescriptionRequest;
-import com.linecorp.bot.model.manageaudience.response.CreateAudienceGroupResponse;
-import com.linecorp.bot.model.manageaudience.response.CreateClickBasedAudienceGroupResponse;
-import com.linecorp.bot.model.manageaudience.response.CreateImpBasedAudienceGroupResponse;
-import com.linecorp.bot.model.manageaudience.response.GetAudienceDataResponse;
-import com.linecorp.bot.model.manageaudience.response.GetAudienceGroupAuthorityLevelResponse;
-import com.linecorp.bot.model.manageaudience.response.GetAudienceGroupsResponse;
 import com.linecorp.bot.model.profile.MembersIdsResponse;
 import com.linecorp.bot.model.profile.UserProfileResponse;
 import com.linecorp.bot.model.response.BotApiResponse;
@@ -56,8 +42,6 @@
 import com.linecorp.bot.model.richmenu.RichMenuListResponse;
 import com.linecorp.bot.model.richmenu.RichMenuResponse;
 
-import retrofit2.http.Body;
-
 public interface LineMessagingClient {
     /**
      * Reply to messages from users.
@@ -152,7 +136,7 @@ public interface LineMessagingClient {
      * retrieved by this operation does not include the number of messages sent from LINE@ Manager.
      *
      * @param date Date the messages were sent. The format should be {@code yyyyMMdd} (for Example:
-     *             {@literal "20191231"}) and the timezone should be UTC+9.
+     *         {@literal "20191231"}) and the timezone should be UTC+9.
      */
     CompletableFuture<NumberOfMessagesResponse> getNumberOfSentReplyMessages(String date);
 
@@ -161,7 +145,7 @@ public interface LineMessagingClient {
      * retrieved by this operation does not include the number of messages sent from LINE@ Manager.
      *
      * @param date Date the messages were sent. The format should be {@code yyyyMMdd} (for Example:
-     *             {@literal "20191231"}) and the timezone should be UTC+9.
+     *         {@literal "20191231"}) and the timezone should be UTC+9.
      */
     CompletableFuture<NumberOfMessagesResponse> getNumberOfSentPushMessages(String date);
 
@@ -170,7 +154,7 @@ public interface LineMessagingClient {
      * retrieved by this operation does not include the number of messages sent from LINE@ Manager.
      *
      * @param date Date the messages were sent. The format should be {@code yyyyMMdd} (for Example:
-     *             {@literal "20191231"}) and the timezone should be UTC+9.
+     *         {@literal "20191231"}) and the timezone should be UTC+9.
      */
     CompletableFuture<NumberOfMessagesResponse> getNumberOfSentMulticastMessages(String date);
 
@@ -183,7 +167,7 @@ public interface LineMessagingClient {
      * Migration of LINE@ accounts</a>.
      *
      * @param date Date the messages were sent. The format should be {@code yyyyMMdd} (for Example:
-     *             {@literal "20191231"}) and the timezone should be UTC+9.
+     *         {@literal "20191231"}) and the timezone should be UTC+9.
      */
     CompletableFuture<NumberOfMessagesResponse> getNumberOfSentBroadcastMessages(String date);
 
@@ -199,7 +183,6 @@ public interface LineMessagingClient {
      *
      * @param groupId Identifier of the group. Can be get by {@link GroupSource#getGroupId()}.
      * @param userId Identifier of the user.
-     *
      * @see <a href="https://developers.line.me/en/reference/messaging-api/#get-group-member-profile">//developers.line.me/en/reference/messaging-api/#get-group-member-profile</a>
      */
     CompletableFuture<UserProfileResponse> getGroupMemberProfile(String groupId, String userId);
@@ -209,7 +192,6 @@ public interface LineMessagingClient {
      *
      * @param roomId Identifier of the group. Can be get by {@link RoomSource#getRoomId()}.
      * @param userId Identifier of the user.
-     *
      * @see <a href="https://developers.line.me/en/reference/messaging-api/#get-room-member-profile">//developers.line.me/en/reference/messaging-api/#get-room-member-profile</a>
      */
     CompletableFuture<UserProfileResponse> getRoomMemberProfile(String roomId, String userId);
@@ -218,7 +200,6 @@ public interface LineMessagingClient {
      * Get (a part of) group member list.
      *
      * @param start nullable continuationToken which can be get {@link MembersIdsResponse#getNext()}
-     *
      * @see <a href="https://developers.line.me/en/reference/messaging-api/#get-group-member-user-ids">//developers.line.me/en/reference/messaging-api/#get-group-member-user-ids</a>
      * @see MembersIdsResponse#getNext()
      */
@@ -228,7 +209,6 @@ public interface LineMessagingClient {
      * Get (a part of) room member list.
      *
      * @param start nullable continuationToken which can be get {@link MembersIdsResponse#getNext()}
-     *
      * @see <a href="https://developers.line.me/en/reference/messaging-api/#get-room-member-user-ids">//developers.line.me/en/reference/messaging-api/#get-room-member-user-ids</a>
      * @see MembersIdsResponse#getNext()
      */
@@ -291,7 +271,7 @@ public interface LineMessagingClient {
      * 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>
+     *         Link rich menu to multiple users</a>
      */
     CompletableFuture<BotApiResponse> linkRichMenuIdToUsers(List<String> userIds, String richMenuId);
 
@@ -306,7 +286,7 @@ public interface LineMessagingClient {
      * 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>
+     *         Unlink rich menu to multiple users</a>
      */
     CompletableFuture<BotApiResponse> unlinkRichMenuIdFromUsers(List<String> userIds);
 
@@ -366,6 +346,7 @@ CompletableFuture<BotApiResponse> setRichMenuImage(
 
     /**
      * Get number of message deliveries.
+     *
      * @see LineMessagingService#getNumberOfMessageDeliveries(String)
      */
     CompletableFuture<GetNumberOfMessageDeliveriesResponse> getNumberOfMessageDeliveries(String date);
@@ -382,103 +363,6 @@ CompletableFuture<BotApiResponse> setRichMenuImage(
      */
     CompletableFuture<GetFriendsDemographicsResponse> getFriendsDemographics();
 
-    /**
-     * Creates an audience for uploading user IDs. You can create up to 1,000 audiences.
-     *
-     * @see <a href="https://developers.line.biz/en/reference/messaging-api/#create-upload-audience-group">
-     *     Create audience for uploading user IDs</a>
-     */
-    CompletableFuture<CreateAudienceGroupResponse> createAudienceGroup(CreateAudienceGroupRequest request);
-
-    /**
-     * Adds new user IDs or IFAs to an audience for uploading user IDs.
-     *
-     * @see <a href="https://developers.line.biz/en/reference/messaging-api/#update-upload-audience-group">
-     *     Add user IDs or Identifiers for Advertisers (IFAs) to an audience for uploading user IDs</a>
-     */
-    CompletableFuture<BotApiResponse> addAudienceToAudienceGroup(
-            AddAudienceToAudienceGroupRequest request);
-
-    /**
-     * Creates an audience for click-based retargeting.
-     *
-     * @see <a href="https://developers.line.biz/en/reference/messaging-api/#create-click-audience-group">
-     *     Create audience for click-based retargeting</a>
-     */
-    CompletableFuture<CreateClickBasedAudienceGroupResponse> createClickBasedAudienceGroup(
-            CreateClickBasedAudienceGroupRequest request);
-
-    /**
-     * Creates an audience for impression-based retargeting.
-     *
-     * @see <a href="https://developers.line.biz/en/reference/messaging-api/#create-imp-audience-group">
-     *     Create audience for impression-based retargeting</a>
-     */
-    CompletableFuture<CreateImpBasedAudienceGroupResponse> createImpBasedAudienceGroup(
-            CreateImpBasedAudienceGroupRequest request);
-
-    /**
-     * Renames an existing audience.
-     *
-     * @param audienceGroupId The audience ID.
-     * @see <a href="https://developers.line.biz/en/reference/messaging-api/#set-description-audience-group">
-     *     Rename an audience</a>
-     */
-    CompletableFuture<BotApiResponse> updateAudienceGroupDescription(
-            long audienceGroupId, UpdateAudienceGroupDescriptionRequest request);
-
-    /**
-     * Deletes an audience.
-     *
-     * @param audienceGroupId The audience ID.
-     * @see <a href="https://developers.line.biz/en/reference/messaging-api/#delete-audience-group">
-     *     Delete audience</a>
-     */
-    CompletableFuture<BotApiResponse> deleteAudienceGroup(long audienceGroupId);
-
-    /**
-     * Gets audience data.
-     *
-     * @param audienceGroupId The audience ID.
-     * @see <a href="https://developers.line.biz/en/reference/messaging-api/#get-audience-group">
-     *     Get audience data</a>
-     */
-    CompletableFuture<GetAudienceDataResponse> getAudienceData(long audienceGroupId);
-
-    /**
-     * Gets data for more than one audience.
-     *
-     * @param page The page to return when getting (paginated) results. Specify a value of 1 or more.
-     * @param description The name of the audience(s) to return. You can search for partial matches.
-     *                    Comparisons are case-insensitive, so the names AUDIENCE and audience are considered
-     *                    identical.
-     * @param status The audience's status.
-     * @param size The number of audiences per page. This is 20 by default.
-     *             Max: 40
-     * @see <a href="https://developers.line.biz/en/reference/messaging-api/#get-audience-groups">
-     *     Get data for multiple audiences</a>
-     */
-    CompletableFuture<GetAudienceGroupsResponse> getAudienceGroups(
-            long page, String description, AudienceGroupStatus status, Long size,
-            Boolean includesExternalPublicGroups, AudienceGroupCreateRoute createRoute);
-
-    /**
-     * Get audience group authority level.
-     *
-     * @see <a href="https://developers.line.biz/en/reference/messaging-api/#get-authority-level">
-     *     Get authority level</a>
-     */
-    CompletableFuture<GetAudienceGroupAuthorityLevelResponse> getAudienceGroupAuthorityLevel();
-
-    /**
-     * Update audience group authority level.
-     *
-     * @see <a href="https://developers.line.biz/en/reference/messaging-api/#change-authority-level">
-     *     Change authority level</a>
-     */
-    CompletableFuture<BotApiResponse> updateAudienceGroupAuthorityLevel(
-            @Body UpdateAudienceGroupAuthorityLevelRequest request);
-
     static LineMessagingClientBuilder builder(String channelToken) {
         return builder(FixedChannelTokenSupplier.of(channelToken));
     }

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

@@ -27,20 +27,6 @@
 import com.linecorp.bot.model.Narrowcast;
 import com.linecorp.bot.model.PushMessage;
 import com.linecorp.bot.model.ReplyMessage;
-import com.linecorp.bot.model.manageaudience.AudienceGroupCreateRoute;
-import com.linecorp.bot.model.manageaudience.AudienceGroupStatus;
-import com.linecorp.bot.model.manageaudience.request.AddAudienceToAudienceGroupRequest;
-import com.linecorp.bot.model.manageaudience.request.CreateAudienceGroupRequest;
-import com.linecorp.bot.model.manageaudience.request.CreateClickBasedAudienceGroupRequest;
-import com.linecorp.bot.model.manageaudience.request.CreateImpBasedAudienceGroupRequest;
-import com.linecorp.bot.model.manageaudience.request.UpdateAudienceGroupAuthorityLevelRequest;
-import com.linecorp.bot.model.manageaudience.request.UpdateAudienceGroupDescriptionRequest;
-import com.linecorp.bot.model.manageaudience.response.CreateAudienceGroupResponse;
-import com.linecorp.bot.model.manageaudience.response.CreateClickBasedAudienceGroupResponse;
-import com.linecorp.bot.model.manageaudience.response.CreateImpBasedAudienceGroupResponse;
-import com.linecorp.bot.model.manageaudience.response.GetAudienceDataResponse;
-import com.linecorp.bot.model.manageaudience.response.GetAudienceGroupAuthorityLevelResponse;
-import com.linecorp.bot.model.manageaudience.response.GetAudienceGroupsResponse;
 import com.linecorp.bot.model.profile.MembersIdsResponse;
 import com.linecorp.bot.model.profile.UserProfileResponse;
 import com.linecorp.bot.model.response.BotApiResponse;
@@ -64,7 +50,6 @@
 import retrofit2.Call;
 import retrofit2.Callback;
 import retrofit2.Response;
-import retrofit2.http.Body;
 
 /**
  * Proxy implementation of {@link LineMessagingClient} to hind internal implementation.
@@ -290,66 +275,6 @@ public CompletableFuture<GetNumberOfFollowersResponse> getNumberOfFollowers(Stri
         return toFuture(retrofitImpl.getNumberOfFollowers(date));
     }
 
-    @Override
-    public CompletableFuture<CreateAudienceGroupResponse> createAudienceGroup(
-            CreateAudienceGroupRequest request) {
-        return toFuture(retrofitImpl.createAudienceGroup(request));
-    }
-
-    @Override
-    public CompletableFuture<BotApiResponse> addAudienceToAudienceGroup(
-            AddAudienceToAudienceGroupRequest request) {
-        return toBotApiFuture(retrofitImpl.addAudienceToAudienceGroup(request));
-    }
-
-    @Override
-    public CompletableFuture<CreateClickBasedAudienceGroupResponse> createClickBasedAudienceGroup(
-            CreateClickBasedAudienceGroupRequest request) {
-        return toFuture(retrofitImpl.createClickBasedAudienceGroup(request));
-    }
-
-    @Override
-    public CompletableFuture<CreateImpBasedAudienceGroupResponse> createImpBasedAudienceGroup(
-            CreateImpBasedAudienceGroupRequest request) {
-        return toFuture(retrofitImpl.createImpBasedAudienceGroup(request));
-    }
-
-    @Override
-    public CompletableFuture<BotApiResponse> updateAudienceGroupDescription(
-            long audienceGroupId, UpdateAudienceGroupDescriptionRequest request) {
-        return toBotApiFuture(retrofitImpl.updateAudienceGroupDescription(audienceGroupId, request));
-    }
-
-    @Override
-    public CompletableFuture<BotApiResponse> deleteAudienceGroup(long audienceGroupId) {
-        return toBotApiFuture(retrofitImpl.deleteAudienceGroup(audienceGroupId));
-    }
-
-    @Override
-    public CompletableFuture<GetAudienceGroupsResponse> getAudienceGroups(
-            long page, String description, AudienceGroupStatus status, Long size,
-            Boolean includesExternalPublicGroups, AudienceGroupCreateRoute createRoute) {
-        return toFuture(retrofitImpl.getAudienceGroups(
-                page, description, status, size,
-                includesExternalPublicGroups, createRoute));
-    }
-
-    @Override
-    public CompletableFuture<GetAudienceDataResponse> getAudienceData(long audienceGroupId) {
-        return toFuture(retrofitImpl.getAudienceData(audienceGroupId));
-    }
-
-    @Override
-    public CompletableFuture<GetAudienceGroupAuthorityLevelResponse> getAudienceGroupAuthorityLevel() {
-        return toFuture(retrofitImpl.getAudienceGroupAuthorityLevel());
-    }
-
-    @Override
-    public CompletableFuture<BotApiResponse> updateAudienceGroupAuthorityLevel(
-            @Body UpdateAudienceGroupAuthorityLevelRequest request) {
-        return toBotApiFuture(retrofitImpl.updateAudienceGroupAuthorityLevel(request));
-    }
-
     // TODO: Extract this method.
     static <T> CompletableFuture<T> toFuture(Call<T> callToWrap) {
         final CallbackAdaptor<T> completableFuture = new CallbackAdaptor<>();