Change type of URL field to URI

imasahiro · imasahiro · commit 076d06f16b41 · 2019-08-29T18:15:01.000+09:00
Fixes #306
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
@@ -26,6 +26,7 @@
 import static org.mockito.Mockito.when;
 
 import java.io.IOException;
+import java.net.URI;
 import java.util.Collections;
 
 import org.junit.Rule;
@@ -235,7 +236,8 @@ public void getNumberOfSentBroadcastMessages() {
     @Test
     public void getProfileTest() throws Exception {
         final UserProfileResponse mockUserProfileResponse =
-                new UserProfileResponse("displayName", "userId", "pictureUrl", "statusMessage");
+                new UserProfileResponse("displayName", "userId",
+                                        URI.create("http://pictureUrl/"), "statusMessage");
         whenCall(retrofitMock.getProfile(any()),
                  mockUserProfileResponse);
 
@@ -250,7 +252,8 @@ public void getProfileTest() throws Exception {
     @Test
     public void getProfileOfGroupMemberTest() throws Exception {
         final UserProfileResponse mockUserProfileResponse =
-                new UserProfileResponse("displayName", "userId", "pictureUrl", null);
+                new UserProfileResponse("displayName", "userId",
+                                        URI.create("http://pictureUrl"), null);
         whenCall(retrofitMock.getMemberProfile(any(), any(), any()),
                  mockUserProfileResponse);
 
diff --git a/line-bot-api-client/src/test/java/com/linecorp/bot/client/LineMessagingClientImplWiremockTest.java b/line-bot-api-client/src/test/java/com/linecorp/bot/client/LineMessagingClientImplWiremockTest.java
@@ -19,6 +19,7 @@
 import static org.assertj.core.api.Assertions.assertThat;
 import static org.hamcrest.CoreMatchers.isA;
 
+import java.net.URI;
 import java.util.concurrent.ExecutionException;
 
 import org.hamcrest.CustomTypeSafeMatcher;
@@ -145,7 +146,7 @@ public void relativeRequestTest() throws Exception {
 
         final UserProfileResponse profileResponseMock =
                 new UserProfileResponse("name", "userId",
-                                        "https://line.me/picture_url",
+                                        URI.create("https://line.me/picture_url"),
                                         "Status message");
 
         mockWebServer.enqueue(new MockResponse()
diff --git a/line-bot-api-client/src/test/java/com/linecorp/bot/client/LineMessagingClientTest.java b/line-bot-api-client/src/test/java/com/linecorp/bot/client/LineMessagingClientTest.java
@@ -18,6 +18,8 @@
 
 import static org.assertj.core.api.Assertions.assertThat;
 
+import java.net.URI;
+
 import org.junit.After;
 import org.junit.Before;
 import org.junit.Test;
@@ -61,7 +63,7 @@ public void tearDown() throws Exception {
     public void relativeRequestTest() throws Exception {
         final UserProfileResponse profileResponseMock =
                 new UserProfileResponse("name", "userId",
-                                        "https://line.me/picture_url",
+                                        URI.create("https://line.me/picture_url"),
                                         "Status message");
 
         mockWebServer.enqueue(new MockResponse()
diff --git a/line-bot-model/src/main/java/com/linecorp/bot/model/action/URIAction.java b/line-bot-model/src/main/java/com/linecorp/bot/model/action/URIAction.java
@@ -48,7 +48,7 @@ public class URIAction implements Action {
      *
      * <p>Available values are: http, https, tel
      */
-    private final String uri;
+    private final URI uri;
 
     /**
      * URI that opened on LINE desktop clients when the action is performed. If this property is set,
@@ -59,7 +59,7 @@ public class URIAction implements Action {
     @JsonCreator
     public URIAction(
             @JsonProperty("label") String label,
-            @JsonProperty("uri") String uri,
+            @JsonProperty("uri") URI uri,
             @JsonProperty("altUri") AltUri altUri) {
         this.label = label;
         this.uri = uri;
diff --git a/line-bot-model/src/main/java/com/linecorp/bot/model/event/message/ContentProvider.java b/line-bot-model/src/main/java/com/linecorp/bot/model/event/message/ContentProvider.java
@@ -16,6 +16,8 @@
 
 package com.linecorp.bot.model.event.message;
 
+import java.net.URI;
+
 import com.fasterxml.jackson.annotation.JsonCreator;
 import com.fasterxml.jackson.annotation.JsonIgnore;
 import com.fasterxml.jackson.annotation.JsonProperty;
@@ -39,17 +41,17 @@ public class ContentProvider {
     /**
      * URL of the resource. Only included when {@link #type} is {@link #EXTERNAL}.
      */
-    private final String originalContentUrl;
+    private final URI originalContentUrl;
 
     /**
      * URL of the preview resource. Only included when {@link #type} is {@link #EXTERNAL}.
      */
-    private final String previewImageUrl;
+    private final URI previewImageUrl;
 
     @JsonCreator
     public ContentProvider(@JsonProperty("type") String type,
-                           @JsonProperty("originalContentUrl") String originalContentUrl,
-                           @JsonProperty("previewImageUrl") String previewImageUrl) {
+                           @JsonProperty("originalContentUrl") URI originalContentUrl,
+                           @JsonProperty("previewImageUrl") URI previewImageUrl) {
         this.type = type;
         this.originalContentUrl = originalContentUrl;
         this.previewImageUrl = previewImageUrl;
diff --git a/line-bot-model/src/main/java/com/linecorp/bot/model/message/AudioMessage.java b/line-bot-model/src/main/java/com/linecorp/bot/model/message/AudioMessage.java
@@ -16,6 +16,8 @@
 
 package com.linecorp.bot.model.message;
 
+import java.net.URI;
+
 import com.fasterxml.jackson.annotation.JsonTypeName;
 import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
 import com.fasterxml.jackson.databind.annotation.JsonPOJOBuilder;
@@ -43,7 +45,7 @@ public class AudioMessage implements Message {
      * <li>Max 10 MB</li>
      * </ul>
      */
-    private final String originalContentUrl;
+    private final URI originalContentUrl;
 
     /**
      * Length of audio file (milliseconds).
@@ -57,7 +59,7 @@ public class AudioMessage implements Message {
      *
      * <p>If you want use {@link QuickReply}, please use {@link #builder()} instead.
      */
-    public AudioMessage(final String originalContentUrl, final Integer duration) {
+    public AudioMessage(final URI originalContentUrl, final Integer duration) {
         this(originalContentUrl, duration, null);
     }
 
diff --git a/line-bot-model/src/main/java/com/linecorp/bot/model/message/ImageMessage.java b/line-bot-model/src/main/java/com/linecorp/bot/model/message/ImageMessage.java
@@ -16,6 +16,8 @@
 
 package com.linecorp.bot.model.message;
 
+import java.net.URI;
+
 import com.fasterxml.jackson.annotation.JsonTypeName;
 import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
 import com.fasterxml.jackson.databind.annotation.JsonPOJOBuilder;
@@ -36,16 +38,16 @@
 @JsonTypeName("image")
 @JsonDeserialize(builder = ImageMessage.ImageMessageBuilder.class)
 public class ImageMessage implements Message {
-    private final String originalContentUrl;
-    private final String previewImageUrl;
+    private final URI originalContentUrl;
+    private final URI previewImageUrl;
     private final QuickReply quickReply;
 
     /**
      * Constructor without {@link #quickReply} parameter.
      *
      * <p>If you want use {@link QuickReply}, please use {@link #builder()} instead.
      */
-    public ImageMessage(final String originalContentUrl, final String previewImageUrl) {
+    public ImageMessage(final URI originalContentUrl, final URI previewImageUrl) {
         this(originalContentUrl, previewImageUrl, null);
     }
 
diff --git a/line-bot-model/src/main/java/com/linecorp/bot/model/message/ImagemapMessage.java b/line-bot-model/src/main/java/com/linecorp/bot/model/message/ImagemapMessage.java
@@ -16,6 +16,7 @@
 
 package com.linecorp.bot.model.message;
 
+import java.net.URI;
 import java.util.List;
 
 import com.fasterxml.jackson.annotation.JsonTypeName;
@@ -49,7 +50,7 @@ public class ImagemapMessage implements Message {
      * <li>HTTPS required</li>
      * </ul>
      */
-    private final String baseUrl;
+    private final URI baseUrl;
 
     /**
      * Alternative text.
@@ -78,7 +79,7 @@ public class ImagemapMessage implements Message {
      */
     @Deprecated
     public ImagemapMessage(
-            final String baseUrl,
+            final URI baseUrl,
             final String altText,
             final ImagemapBaseSize imagemapBaseSize,
             final List<ImagemapAction> actions,
@@ -92,7 +93,7 @@ public ImagemapMessage(
      */
     @Deprecated
     public ImagemapMessage(
-            final String baseUrl,
+            final URI baseUrl,
             final String altText,
             final ImagemapBaseSize imagemapBaseSize,
             final List<ImagemapAction> actions) {
diff --git a/line-bot-model/src/main/java/com/linecorp/bot/model/message/VideoMessage.java b/line-bot-model/src/main/java/com/linecorp/bot/model/message/VideoMessage.java
@@ -16,6 +16,8 @@
 
 package com.linecorp.bot.model.message;
 
+import java.net.URI;
+
 import com.fasterxml.jackson.annotation.JsonTypeName;
 import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
 import com.fasterxml.jackson.databind.annotation.JsonPOJOBuilder;
@@ -45,7 +47,7 @@ public class VideoMessage implements Message {
      * </ul>
      */
     @NonNull
-    private final String originalContentUrl;
+    private final URI originalContentUrl;
 
     /**
      * URL of preview image.
@@ -58,7 +60,7 @@ public class VideoMessage implements Message {
      * </ul>
      */
     @NonNull
-    private final String previewImageUrl;
+    private final URI previewImageUrl;
 
     private final QuickReply quickReply;
 
@@ -67,7 +69,7 @@ public class VideoMessage implements Message {
      *
      * <p>If you want use {@link QuickReply}, please use {@link #builder()} instead.
      */
-    public VideoMessage(final String originalContentUrl, final String previewImageUrl) {
+    public VideoMessage(final URI originalContentUrl, final URI previewImageUrl) {
         this(originalContentUrl, previewImageUrl, null);
     }
 
diff --git a/line-bot-model/src/main/java/com/linecorp/bot/model/message/flex/component/Image.java b/line-bot-model/src/main/java/com/linecorp/bot/model/message/flex/component/Image.java
@@ -16,6 +16,7 @@
 
 package com.linecorp.bot.model.message.flex.component;
 
+import java.net.URI;
 import java.text.DecimalFormat;
 
 import com.fasterxml.jackson.annotation.JsonCreator;
@@ -99,7 +100,7 @@ public enum ImageAspectMode {
 
     private final Integer flex;
 
-    private final String url;
+    private final URI url;
 
     private final ImageSize size;
 
@@ -130,7 +131,7 @@ public enum ImageAspectMode {
     @JsonCreator
     public Image(
             @JsonProperty("flex") Integer flex,
-            @JsonProperty("url") String url,
+            @JsonProperty("url") URI url,
             @JsonProperty("size") ImageSize size,
             @JsonProperty("aspectRatio") String aspectRatio,
             @JsonProperty("aspectMode") ImageAspectMode aspectMode,
diff --git a/line-bot-model/src/main/java/com/linecorp/bot/model/message/template/ButtonsTemplate.java b/line-bot-model/src/main/java/com/linecorp/bot/model/message/template/ButtonsTemplate.java
@@ -16,6 +16,7 @@
 
 package com.linecorp.bot.model.message.template;
 
+import java.net.URI;
 import java.util.Collections;
 import java.util.List;
 
@@ -50,7 +51,7 @@ public class ButtonsTemplate implements Template {
      * <li>Max: 1 MB</li>
      * </ul>
      */
-    private final String thumbnailImageUrl;
+    private final URI thumbnailImageUrl;
 
     /**
      * Aspect ratio of the image.
@@ -126,7 +127,7 @@ public class ButtonsTemplate implements Template {
      */
     @JsonCreator
     public ButtonsTemplate(
-            @JsonProperty("thumbnailImageUrl") String thumbnailImageUrl,
+            @JsonProperty("thumbnailImageUrl") URI thumbnailImageUrl,
             @JsonProperty("title") String title,
             @JsonProperty("text") String text,
             @JsonProperty("actions") List<Action> actions) {
diff --git a/line-bot-model/src/main/java/com/linecorp/bot/model/message/template/CarouselColumn.java b/line-bot-model/src/main/java/com/linecorp/bot/model/message/template/CarouselColumn.java
@@ -16,6 +16,7 @@
 
 package com.linecorp.bot.model.message.template;
 
+import java.net.URI;
 import java.util.Collections;
 import java.util.List;
 
@@ -49,7 +50,7 @@ public class CarouselColumn {
      * <li>Max: 1 MB</li>
      * </ul>
      */
-    private final String thumbnailImageUrl;
+    private final URI thumbnailImageUrl;
 
     /**
      * Background color of image.
@@ -92,7 +93,7 @@ public class CarouselColumn {
      */
     @JsonCreator
     public CarouselColumn(
-            @JsonProperty("thumbnailImageUrl") String thumbnailImageUrl,
+            @JsonProperty("thumbnailImageUrl") URI thumbnailImageUrl,
             @JsonProperty("title") String title,
             @JsonProperty("text") String text,
             @JsonProperty("actions") List<Action> actions) {
diff --git a/line-bot-model/src/main/java/com/linecorp/bot/model/message/template/ImageCarouselColumn.java b/line-bot-model/src/main/java/com/linecorp/bot/model/message/template/ImageCarouselColumn.java
@@ -16,6 +16,8 @@
 
 package com.linecorp.bot.model.message.template;
 
+import java.net.URI;
+
 import com.fasterxml.jackson.annotation.JsonCreator;
 import com.fasterxml.jackson.annotation.JsonProperty;
 
@@ -39,17 +41,16 @@ public class ImageCarouselColumn {
      * <li>Max: 1 MB</li>
      * </ul>
      */
-    private final String imageUrl;
+    private final URI imageUrl;
 
     /**
      * Action when tapped.
      */
     private final Action action;
 
     @JsonCreator
-    public ImageCarouselColumn(
-            @JsonProperty("imageUrl") String imageUrl,
-            @JsonProperty("action") Action action) {
+    public ImageCarouselColumn(@JsonProperty("imageUrl") URI imageUrl,
+                               @JsonProperty("action") Action action) {
         this.imageUrl = imageUrl;
         this.action = action;
     }
diff --git a/line-bot-model/src/main/java/com/linecorp/bot/model/profile/UserProfileResponse.java b/line-bot-model/src/main/java/com/linecorp/bot/model/profile/UserProfileResponse.java
@@ -16,6 +16,9 @@
 
 package com.linecorp.bot.model.profile;
 
+import java.net.URI;
+
+import com.fasterxml.jackson.annotation.JsonCreator;
 import com.fasterxml.jackson.annotation.JsonProperty;
 
 import lombok.Value;
@@ -38,17 +41,18 @@ public class UserProfileResponse {
     /**
      * Image URL.
      */
-    private final String pictureUrl;
+    private final URI pictureUrl;
 
     /**
      * Status message.
      */
     private final String statusMessage;
 
+    @JsonCreator
     public UserProfileResponse(
             @JsonProperty("displayName") String displayName,
             @JsonProperty("userId") String userId,
-            @JsonProperty("pictureUrl") String pictureUrl,
+            @JsonProperty("pictureUrl") URI pictureUrl,
             @JsonProperty("statusMessage") String statusMessage) {
         this.displayName = displayName;
         this.userId = userId;
diff --git a/line-bot-model/src/test/java/com/linecorp/bot/model/event/CallbackRequestTest.java b/line-bot-model/src/test/java/com/linecorp/bot/model/event/CallbackRequestTest.java
@@ -20,6 +20,7 @@
 
 import java.io.IOException;
 import java.io.InputStream;
+import java.net.URI;
 import java.nio.charset.StandardCharsets;
 import java.time.Instant;
 import java.util.stream.Collectors;
@@ -124,8 +125,8 @@ public void testImage() throws IOException {
             assertThat(image.getId()).isEqualTo("325708");
             assertThat(image.getContentProvider()).isEqualTo(
                     new ContentProvider("external",
-                                        "https://example.com/original.jpg",
-                                        "https://example.com/preview.jpg"));
+                                        URI.create("https://example.com/original.jpg"),
+                                        URI.create(("https://example.com/preview.jpg"))));
         });
     }
 
diff --git a/line-bot-model/src/test/java/com/linecorp/bot/model/message/ExampleFlexMessageSupplier.java b/line-bot-model/src/test/java/com/linecorp/bot/model/message/ExampleFlexMessageSupplier.java
diff --git a/line-bot-model/src/test/java/com/linecorp/bot/model/message/ImagemapMessageTest.java b/line-bot-model/src/test/java/com/linecorp/bot/model/message/ImagemapMessageTest.java
diff --git a/line-bot-model/src/test/java/com/linecorp/bot/model/message/MessageJsonReconstructionTest.java b/line-bot-model/src/test/java/com/linecorp/bot/model/message/MessageJsonReconstructionTest.java
diff --git a/line-bot-model/src/test/java/com/linecorp/bot/model/message/imagemap/ImagemapMessageWithVideoTest.java b/line-bot-model/src/test/java/com/linecorp/bot/model/message/imagemap/ImagemapMessageWithVideoTest.java
diff --git a/line-bot-model/src/test/java/com/linecorp/bot/model/profile/ProfileResponseTest.java b/line-bot-model/src/test/java/com/linecorp/bot/model/profile/ProfileResponseTest.java
diff --git a/sample-spring-boot-kitchensink/src/main/java/com/example/bot/spring/ExampleFlexMessageSupplier.java b/sample-spring-boot-kitchensink/src/main/java/com/example/bot/spring/ExampleFlexMessageSupplier.java
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
