Merge branch 'master' of https://github.com/codeoverflow-org/chatoverflow-api

Author: strifel

build.sbt

@@ -3,7 +3,7 @@ name := "chatoverflow-api"
 lazy val sourceGenerator = TaskKey[Unit]("sourceGenerator")
 
 // Convention: majorVersion++ on api signature update (else: minorVersion ++)
-val majorVersion = 1
+val majorVersion = 2
 val minorVersion = 0
 version := s"$majorVersion.$minorVersion"
 

src/main/java/org/codeoverflow/chatoverflow/api/APIVersion.java

@@ -4,6 +4,6 @@
  * THIS CLASS IS GENERATED WHILE COMPILING. DO CHANGE THE VERSION NUMBERS IN THE APIS BUILD.SBT!
  */
 public class APIVersion {
-    public static final int MAJOR_VERSION = 1;
+    public static final int MAJOR_VERSION = 2;
     public static final int MINOR_VERSION = 0;
 }

src/main/java/org/codeoverflow/chatoverflow/api/io/dto/User.java

@@ -1,42 +1,35 @@
 package org.codeoverflow.chatoverflow.api.io.dto;
 
+/**
+ * A basic user where we only know a unique identifier and a displayed name
+ */
 public class User implements Identifiable {
-    private final String id;
+    private final String identifier;
     private final String name;
-    private final String login;
 
     public User(String name) {
-        this(name, name, "");
+        this(name, name);
     }
 
-    public User(String id, String name) {
-        this(id, name, "");
-    }
-
-    public User(String id, String name, String login) {
-        this.id = id;
+    public User(String identifier, String name) {
+        this.identifier = identifier;
         this.name = name;
-        this.login = login;
     }
 
     /**
-     * @return unique user id if available, otherwise same as user name
+     *  A unique user identifier:<br>
+     *  An id or the unique login name. May be the same as the users display name
+     *
+     * @return the unique identifier of the user
      */
     public String getId() {
-        return id;
+        return identifier;
     }
 
     /**
-     * @return user display name
+     * @return users display name
      */
-    public String getName() {
+    public String getDisplayName() {
         return name;
     }
-
-    /**
-     * @return unique user login name
-     */
-    public String getLogin() {
-        return login;
-    }
 }

src/main/java/org/codeoverflow/chatoverflow/api/io/dto/chat/ChatMessage.java

@@ -2,29 +2,30 @@
 
 import org.codeoverflow.chatoverflow.api.io.dto.Formatable;
 
+import java.time.OffsetDateTime;
 import java.util.ArrayList;
 import java.util.Collections;
 import java.util.List;
 
 /**
  * A generic message that is send in a chat
  */
-public class ChatMessage<T extends ChatMessageAuthor, U extends Channel, V extends ChatEmoticon>  implements Formatable {
+public class ChatMessage<T extends ChatMessageAuthor, U extends TextChannel, V extends ChatEmoticon>  implements Formatable {
     private final String message;
     private final T author;
-    private final Long timestamp;
+    private final OffsetDateTime time;
     private final U channel;
     private final List<V> emoticons;
 
-    public ChatMessage(T author, String message, Long timestamp, U channel) {
-        this(author, message, timestamp, channel, new ArrayList<>());
+    public ChatMessage(T author, String message, OffsetDateTime time, U channel) {
+        this(author, message, time, channel, new ArrayList<>());
     }
 
-    public ChatMessage(T author, String message, Long timestamp, U channel, List<V> emoticons) {
+    public ChatMessage(T author, String message, OffsetDateTime time, U channel, List<V> emoticons) {
         Collections.sort(emoticons);
         this.message = message;
         this.author = author;
-        this.timestamp = timestamp;
+        this.time = time;
         this.channel = channel;
         this.emoticons = emoticons;
     }
@@ -44,10 +45,10 @@ public T getAuthor() {
     }
 
     /**
-     * @return timestamp when the message was created (value in epoch millis)
+     * @return time when the message was created
      */
-    public Long getTimestamp() {
-        return timestamp;
+    public OffsetDateTime getTime() {
+        return time;
     }
 
     /**

src/main/java/org/codeoverflow/chatoverflow/api/io/dto/chat/ChatMessageAuthor.java

@@ -1,29 +1,27 @@
 package org.codeoverflow.chatoverflow.api.io.dto.chat;
 
 import org.codeoverflow.chatoverflow.api.io.dto.Formatable;
+import org.codeoverflow.chatoverflow.api.io.dto.User;
 
 /**
  * The author of a chat message
  */
-public class ChatMessageAuthor implements Formatable {
+public class ChatMessageAuthor extends User implements Formatable {
 
-    private final String displayName;
     private final String color;
 
-    public ChatMessageAuthor(String displayName, String color) {
-        this.displayName = displayName;
+    public ChatMessageAuthor(String identifier, String name, String color) {
+        super(identifier, name);
         this.color = color;
     }
 
-    public ChatMessageAuthor(String displayName) {
-        this(displayName, "#000000");
+    public ChatMessageAuthor(String identifier, String name) {
+        this(identifier, name, "#000000");
     }
 
-    /**
-     * @return the name of the author that is displayed in chat
-     */
-    public String getDisplayName() {
-        return displayName;
+    public ChatMessageAuthor(String displayName) {
+        super(displayName);
+        this.color = "#000000";
     }
 
     /**
@@ -37,22 +35,22 @@ public String getColor() {
      * @return The display name as raw string
      */
     public String toString() {
-        return displayName;
+        return getDisplayName();
     }
 
     /**
      * @return The display name in bold, formatted using HTML
      */
     @Override
     public String toHTMLString() {
-        return "<span color=\"" + color + "\"><b>" + displayName + "</b></span>";
+        return "<span color=\"" + color + "\"><b>" + getDisplayName() + "</b></span>";
     }
 
     /**
      * @return The display name in bold, formatted using markdown
      */
     @Override
     public String toMarkdownString() {
-        return "**" + displayName + "**";
+        return "**" + getDisplayName() + "**";
     }
 }

src/main/java/org/codeoverflow/chatoverflow/api/io/dto/chat/Channel.java renamed to src/main/java/org/codeoverflow/chatoverflow/api/io/dto/chat/TextChannel.java

@@ -3,10 +3,10 @@
 /**
  * A generic channel in which messages are exchanged
  */
-public class Channel {
+public class TextChannel {
     private final String name;
 
-    public Channel(String name) {
+    public TextChannel(String name) {
         this.name = name;
     }
 

src/main/java/org/codeoverflow/chatoverflow/api/io/dto/chat/discord/DiscordChatMessage.java

@@ -2,48 +2,50 @@
 
 import org.codeoverflow.chatoverflow.api.io.dto.Identifiable;
 import org.codeoverflow.chatoverflow.api.io.dto.chat.ChatMessage;
+import org.codeoverflow.chatoverflow.api.io.dto.chat.ChatMessageAuthor;
 
+import java.time.OffsetDateTime;
 import java.util.ArrayList;
 import java.util.List;
 import java.util.Optional;
 
 /**
  * A chat message that was send in a discord channel
  */
-public class DiscordChatMessage extends ChatMessage<DiscordChatMessageAuthor, DiscordChannel, DiscordChatCustomEmoticon> implements Identifiable {
+public class DiscordChatMessage extends ChatMessage<ChatMessageAuthor, DiscordTextChannel, DiscordChatCustomEmoticon> implements Identifiable {
 
     private final String id;
     private final DiscordEmbed embed;
     private final List<String> attachmentUrls;
     private final List<DiscordReaction> reactions;
 
-    public DiscordChatMessage(DiscordChatMessageAuthor author, String message, Long timestamp, DiscordChannel channel, String id) {
-        super(author, message, timestamp, channel);
+    public DiscordChatMessage(ChatMessageAuthor author, String message, OffsetDateTime time, DiscordTextChannel channel, String id) {
+        super(author, message, time, channel);
         this.id = id;
         this.embed = null;
         this.attachmentUrls = new ArrayList<>();
         reactions = new ArrayList<>();
     }
 
-    public DiscordChatMessage(DiscordChatMessageAuthor author,
+    public DiscordChatMessage(ChatMessageAuthor author,
                               String message,
-                              Long timestamp,
-                              DiscordChannel channel,
+                              OffsetDateTime time,
+                              DiscordTextChannel channel,
                               List<DiscordChatCustomEmoticon> emoticons,
                               String id) {
-        this(author, message, timestamp, channel, emoticons, null, new ArrayList<>(), new ArrayList<>(), id);
+        this(author, message, time, channel, emoticons, null, new ArrayList<>(), new ArrayList<>(), id);
     }
 
-    public DiscordChatMessage(DiscordChatMessageAuthor author,
+    public DiscordChatMessage(ChatMessageAuthor author,
                               String message,
-                              Long timestamp,
-                              DiscordChannel channel,
+                              OffsetDateTime time,
+                              DiscordTextChannel channel,
                               List<DiscordChatCustomEmoticon> emoticons,
                               DiscordEmbed embed,
                               List<String> attachmentUrls,
                               List<DiscordReaction> reactions,
                               String id) {
-        super(author, message, timestamp, channel, emoticons);
+        super(author, message, time, channel, emoticons);
         this.id = id;
         this.reactions = reactions;
         this.embed = embed;

src/main/java/org/codeoverflow/chatoverflow/api/io/dto/chat/discord/DiscordChatMessageAuthor.java

@@ -1,6 +1,7 @@
 package org.codeoverflow.chatoverflow.api.io.dto.chat.discord;
 
 import java.awt.Color;
+import java.time.OffsetDateTime;
 import java.util.*;
 
 /**
@@ -20,7 +21,7 @@ public static Builder Builder() {
     private final String description;
     private final String url;
     private final String color;
-    private final long timestamp;
+    private final OffsetDateTime time;
     private final String footerIconUrl;
     private final String footerText;
     private final String thumbnailUrl;
@@ -33,7 +34,7 @@ public static Builder Builder() {
     public DiscordEmbed(String title,
                         String description,
                         String url, String color,
-                        long timestamp,
+                        OffsetDateTime time,
                         String footerIconUrl,
                         String footerText,
                         String thumbnailUrl,
@@ -46,7 +47,7 @@ public DiscordEmbed(String title,
         this.description = description;
         this.url = url;
         this.color = color;
-        this.timestamp = timestamp;
+        this.time = time;
         this.footerIconUrl = footerIconUrl;
         this.footerText = footerText;
         this.thumbnailUrl = thumbnailUrl;
@@ -95,12 +96,12 @@ public Optional<String> getColor() {
     }
 
     /**
-     * Returns the timestamp of the embed (value in epoch millis)
+     * Returns the time of the embed (value in epoch millis)
      *
-     * @return optional container with the timestamp of the embed or an empty optional if there was none provided
+     * @return optional container with the time of the embed or an empty optional if there was none provided
      */
-    public OptionalLong getTimestamp() {
-        return timestamp < 0 ? OptionalLong.empty() : OptionalLong.of(timestamp);
+    public Optional<OffsetDateTime> getTime() {
+        return Optional.ofNullable(time);
     }
 
     /**
@@ -257,7 +258,7 @@ public static class Builder {
         private StringBuilder description = null;
         private String url = null;
         private String color = null;
-        private Long timestamp = Long.MIN_VALUE;
+        private OffsetDateTime time = null;
         private String footerIconUrl = null;
         private String footerText = null;
         private String thumbnailUrl = null;
@@ -343,17 +344,17 @@ public Builder withColor(Color color) {
         }
 
         /**
-         * Sets the timestamp of the embed.<br>
-         * If this is not set, the timestamp will not appear in the embed.
+         * Sets the time of the embed.<br>
+         * If this is not set, the time will not appear in the embed.
          * <p>
          * <b>Tip:</b><br>
-         * Get the current time with {@link Calendar#getTimeInMillis()}
+         * Get the current time with {@link OffsetDateTime#now()}
          *
-         * @param timestamp the timestamp of the embed (value in epoch millis)
-         * @return the builder after the timestamp has been set
+         * @param time the time of the embed (value in epoch millis)
+         * @return the builder after the time has been set
          */
-        public Builder withTimestamp(Long timestamp) {
-            this.timestamp = timestamp;
+        public Builder withTimestamp(OffsetDateTime time) {
+            this.time = time;
             return this;
         }
 
@@ -470,7 +471,7 @@ public DiscordEmbed build() {
                     description.toString(),
                     url,
                     color,
-                    timestamp,
+                    time,
                     footerIconUrl,
                     footerText,
                     thumbnailUrl,