Merge pull request #63 from jwdeveloper/develop-1.5.0

Develop 1.5.0

Author: jwdeveloper

API/src/main/java/io/github/jwdeveloper/tiktok/data/events/TikTokCommentEvent.java

@@ -47,11 +47,23 @@ public class TikTokCommentEvent extends TikTokHeaderEvent {
 
     public TikTokCommentEvent(WebcastChatMessage msg) {
         super(msg.getCommon());
-        user = User.map(msg.getUser(),msg.getUserIdentity());
+        user = User.map(msg.getUser(), msg.getUserIdentity());
         text = msg.getContent();
         visibleToSender = msg.getVisibleToSender();
         getUserLanguage = msg.getContentLanguage();
         mentionedUser = User.map(msg.getAtUser());
         pictures = msg.getEmotesListList().stream().map(e -> Picture.map(e.getEmote().getImage())).toList();
     }
+
+
+    public static TikTokCommentEvent of(String userName, String message) {
+        var builder = WebcastChatMessage.newBuilder();
+        builder.setUser(io.github.jwdeveloper.tiktok.messages.data.User.newBuilder()
+                .setNickname(userName)
+                .build());
+        builder.setContentLanguage("en");
+        builder.setVisibleToSender(true);
+        builder.setContent(message);
+        return new TikTokCommentEvent(builder.build());
+    }
 }

API/src/main/java/io/github/jwdeveloper/tiktok/data/events/TikTokSubscribeEvent.java

@@ -36,10 +36,10 @@
  */
 @Getter
 @EventMeta(eventType = EventType.Message)
-public class TikTokSubscribeEvent extends TikTokHeaderEvent
-{
+public class TikTokSubscribeEvent extends TikTokHeaderEvent {
     private final User user;
 
+
     public TikTokSubscribeEvent(WebcastMemberMessage msg) {
         super(msg.getCommon());
         user = User.map(msg.getUser());
@@ -52,4 +52,11 @@ public TikTokSubscribeEvent(WebcastSubNotifyMessage msg) {
         user.addAttribute(UserAttribute.Subscriber);
     }
 
+    public static TikTokSubscribeEvent of(String userName) {
+        return new TikTokSubscribeEvent(WebcastMemberMessage.newBuilder()
+                .setUser(io.github.jwdeveloper.tiktok.messages.data.User.newBuilder()
+                        .setNickname(userName)
+                        .build())
+                .build());
+    }
 }

API/src/main/java/io/github/jwdeveloper/tiktok/data/events/gift/TikTokGiftComboEvent.java

@@ -23,6 +23,7 @@
 package io.github.jwdeveloper.tiktok.data.events.gift;
 
 import io.github.jwdeveloper.tiktok.annotations.*;
+import io.github.jwdeveloper.tiktok.data.models.Picture;
 import io.github.jwdeveloper.tiktok.data.models.gifts.*;
 import io.github.jwdeveloper.tiktok.data.models.users.User;
 import io.github.jwdeveloper.tiktok.messages.webcast.WebcastGiftMessage;
@@ -32,7 +33,7 @@
 /**
  * Triggered every time gift is sent
  *
- * @see GiftSendType it has 3 states
+ * @see GiftComboStateType it has 3 states
  *
  * <p>Example when user sends gift with combo</p>
  * <p>>Combo: 1  -> comboState = GiftSendType.Begin</p>
@@ -45,10 +46,21 @@
 @EventMeta(eventType = EventType.Message)
 @Getter
 public class TikTokGiftComboEvent extends TikTokGiftEvent {
-    private final GiftSendType comboState;
+    private final GiftComboStateType comboState;
 
-    public TikTokGiftComboEvent(Gift gift, User host, WebcastGiftMessage msg, GiftSendType comboState) {
+    public TikTokGiftComboEvent(Gift gift, User host, WebcastGiftMessage msg, GiftComboStateType comboState) {
         super(gift, host, msg);
         this.comboState = comboState;
     }
+
+    public static TikTokGiftComboEvent of(Gift gift, int combo, GiftComboStateType comboState) {
+        return new TikTokGiftComboEvent(
+                gift,
+                new User(0L, "Test", new Picture("")),
+                WebcastGiftMessage
+                        .newBuilder()
+                        .setComboCount(combo)
+                        .build(),
+                comboState);
+    }
 }

API/src/main/java/io/github/jwdeveloper/tiktok/data/events/gift/TikTokGiftEvent.java

@@ -25,6 +25,7 @@
 
 import io.github.jwdeveloper.tiktok.annotations.*;
 import io.github.jwdeveloper.tiktok.data.events.common.TikTokHeaderEvent;
+import io.github.jwdeveloper.tiktok.data.models.Picture;
 import io.github.jwdeveloper.tiktok.data.models.gifts.*;
 import io.github.jwdeveloper.tiktok.data.models.users.User;
 import io.github.jwdeveloper.tiktok.messages.webcast.WebcastGiftMessage;
@@ -55,4 +56,20 @@ public TikTokGiftEvent(Gift gift, User liveHost, WebcastGiftMessage msg) {
         }
         combo = msg.getComboCount();
     }
+
+    public TikTokGiftEvent(Gift gift) {
+        this.gift = gift;
+        user = new User(0L, "sender", new Picture(""));
+        toUser = new User(0L, "receiver", new Picture(""));
+        combo = 1;
+    }
+
+
+    public static TikTokGiftEvent of(Gift gift) {
+        return new TikTokGiftEvent(gift);
+    }
+
+    public static TikTokGiftEvent of(String name, int id, int diamonds) {
+        return TikTokGiftEvent.of(new Gift(id, name, diamonds, ""));
+    }
 }

API/src/main/java/io/github/jwdeveloper/tiktok/data/events/social/TikTokFollowEvent.java

@@ -24,8 +24,10 @@
 
 import io.github.jwdeveloper.tiktok.annotations.EventMeta;
 import io.github.jwdeveloper.tiktok.annotations.EventType;
+import io.github.jwdeveloper.tiktok.data.events.TikTokSubscribeEvent;
 import io.github.jwdeveloper.tiktok.data.events.common.TikTokHeaderEvent;
 import io.github.jwdeveloper.tiktok.data.models.users.User;
+import io.github.jwdeveloper.tiktok.messages.webcast.WebcastMemberMessage;
 import io.github.jwdeveloper.tiktok.messages.webcast.WebcastSocialMessage;
 import lombok.Value;
 
@@ -45,4 +47,12 @@ public TikTokFollowEvent(WebcastSocialMessage msg) {
     totalFollowers = msg.getFollowCount();
   }
 
+    public static TikTokFollowEvent of(String userName)
+    {
+        return new TikTokFollowEvent(WebcastSocialMessage.newBuilder()
+                .setUser(io.github.jwdeveloper.tiktok.messages.data.User.newBuilder()
+                        .setNickname(userName)
+                        .build())
+                .build());
+    }
 }

API/src/main/java/io/github/jwdeveloper/tiktok/data/events/social/TikTokJoinEvent.java

@@ -26,6 +26,7 @@
 import io.github.jwdeveloper.tiktok.annotations.EventType;
 import io.github.jwdeveloper.tiktok.data.events.common.TikTokHeaderEvent;
 import io.github.jwdeveloper.tiktok.data.models.users.User;
+import io.github.jwdeveloper.tiktok.messages.webcast.WebcastLikeMessage;
 import io.github.jwdeveloper.tiktok.messages.webcast.WebcastMemberMessage;
 import io.github.jwdeveloper.tiktok.messages.webcast.WebcastSocialMessage;
 import lombok.Getter;
@@ -47,4 +48,13 @@ public TikTokJoinEvent(WebcastMemberMessage msg) {
         user = User.map(msg.getUser());
         totalUsers = msg.getMemberCount();
     }
+
+    public static TikTokJoinEvent of(String userName)
+    {
+        return new TikTokJoinEvent(WebcastMemberMessage.newBuilder()
+                .setUser(io.github.jwdeveloper.tiktok.messages.data.User.newBuilder()
+                        .setNickname(userName)
+                        .build())
+                .build());
+    }
 }

API/src/main/java/io/github/jwdeveloper/tiktok/data/events/social/TikTokLikeEvent.java

@@ -57,4 +57,15 @@ public TikTokLikeEvent(WebcastLikeMessage msg) {
         likes = msg.getCount();
         totalLikes = msg.getTotal();
     }
+
+    public static TikTokLikeEvent of(String userName, int likes)
+    {
+        return new TikTokLikeEvent(WebcastLikeMessage.newBuilder()
+                .setCount(likes)
+                .setTotal(likes)
+                .setUser(io.github.jwdeveloper.tiktok.messages.data.User.newBuilder()
+                        .setNickname(userName)
+                        .build())
+                .build());
+    }
 }

API/src/main/java/io/github/jwdeveloper/tiktok/data/models/gifts/GiftSendType.java renamed to API/src/main/java/io/github/jwdeveloper/tiktok/data/models/gifts/GiftComboStateType.java

@@ -22,17 +22,16 @@
  */
 package io.github.jwdeveloper.tiktok.data.models.gifts;
 
-public enum GiftSendType
-{
+//TODO it should be called GiftComboStateType
+public enum GiftComboStateType {
     Finished,
     Begin,
     Active;
 
-    public static GiftSendType fromNumber(long number)
-    {
+    public static GiftComboStateType fromNumber(long number) {
         return switch ((int) number) {
-            case 1, 2, 4 -> GiftSendType.Active;
-            default -> GiftSendType.Finished;
+            case 1, 2, 4 -> GiftComboStateType.Active;
+            default -> GiftComboStateType.Finished;
         };
     }
 }

API/src/main/java/io/github/jwdeveloper/tiktok/data/requests/LiveData.java

@@ -35,6 +35,7 @@ public static class Request {
     }
 
     @Data
+    @AllArgsConstructor
     public static class Response {
         private String json;
         private LiveStatus liveStatus;
@@ -45,6 +46,11 @@ public static class Response {
         private boolean ageRestricted;
         private User host;
         private LiveType liveType;
+        public Response() {
+
+        }
+
+
     }
 
     public enum LiveStatus {

API/src/main/java/io/github/jwdeveloper/tiktok/data/settings/LiveClientSettings.java

@@ -35,10 +35,20 @@ public class LiveClientSettings {
 
 
     /**
+     * TODO: give better description
+     * <p>
+     *  sets client in the offline mode, so it do not connects to TikTok servers
+     *  it makes sense to use it when you are testing client with your custom events
+     */
+    private boolean offline;
+
+    /**
+     * TODO: give better description
+     * <p>
      * Determines if gifts data is downloaded before TikTokLive starts,
      * when `false` then client.giftManager() does not contain initial gifts
      */
-    private boolean fetchGifts;
+    private boolean fetchGifts = true;
 
     /**
      * ISO-Language for Client
@@ -76,14 +86,19 @@ public class LiveClientSettings {
     private HttpClientSettings httpSettings;
 
     /**
-     *  Optional: Sometimes not every messages from chat are send to TikTokLiveJava to fix this issue you can set sessionId
-     *  documentation how to obtain sessionId https://github.com/isaackogan/TikTok-Live-Connector#send-chat-messages
+     * Interval of time in milliseconds between pings to TikTok
+     * @apiNote Min: 250 (0.25 seconds), Default: 5000 (5 seconds)
      */
+    private long pingInterval = 5000;
+
+    /**
+	 * Optional: Sometimes not every messages from chat are send to TikTokLiveJava to fix this issue you can set sessionId
+	 * @see <a href="https://github.com/isaackogan/TikTok-Live-Connector#send-chat-messages">Documentation: How to obtain sessionId</a>
+	 */
     private String sessionId;
 
     /**
      * Optional: By default roomID is fetched before connect to live, but you can set it manually
-     *
      */
     private String roomId;
 
@@ -92,8 +107,7 @@ public class LiveClientSettings {
      */
     private String apiKey;
 
-    public static LiveClientSettings createDefault()
-    {
+    public static LiveClientSettings createDefault() {
         var httpSettings = new HttpClientSettings();
         httpSettings.getParams().putAll(DefaultClientParams());
         httpSettings.getHeaders().putAll(DefaultRequestHeaders());
@@ -166,4 +180,6 @@ public static Map<String, String> DefaultRequestHeaders() {
         headers.put("Accept-Language", "en-US,en; q=0.9");
         return headers;
     }
+
+
 }