Merge branch 'feature/131-cheer,host,raid-events' into feature/129-streamelements-connector

Author: hlxid

src/main/java/org/codeoverflow/chatoverflow/api/io/dto/stat/stream/Cheer.java

@@ -0,0 +1,58 @@
+package org.codeoverflow.chatoverflow.api.io.dto.stat.stream;
+
+import org.codeoverflow.chatoverflow.api.io.dto.User;
+
+import java.time.OffsetDateTime;
+
+/**
+ * A user has cheered some bits to your stream
+ */
+public class Cheer<T extends User> {
+    private final T cheerer;
+    private final int amount;
+    private final String cheerMessage;
+    private final OffsetDateTime time;
+
+    public Cheer(T cheerer, int amount, String cheerMessage, OffsetDateTime time) {
+        this.cheerer = cheerer;
+        this.amount = amount;
+        this.cheerMessage = cheerMessage;
+        this.time = time;
+    }
+
+    /**
+     * Get the user object of the person that has cheered
+     *
+     * @return the cheerer
+     */
+    public T getCheerer() {
+        return cheerer;
+    }
+
+    /**
+     * Get how much the user cheered in twitch bits
+     *
+     * @return amount of cheered bits e.g. 100
+     */
+    public int getAmount() {
+        return amount;
+    }
+
+    /**
+     * Get the message with which the user has cheered
+     *
+     * @return the cheer message
+     */
+    public String getMessage() {
+        return cheerMessage;
+    }
+
+    /**
+     * Get the time when the cheer was made
+     *
+     * @return cheer time
+     */
+    public OffsetDateTime getTime() {
+        return time;
+    }
+}

src/main/java/org/codeoverflow/chatoverflow/api/io/dto/stat/stream/Host.java

@@ -0,0 +1,58 @@
+package org.codeoverflow.chatoverflow.api.io.dto.stat.stream;
+
+import org.codeoverflow.chatoverflow.api.io.dto.User;
+
+import java.time.OffsetDateTime;
+
+/**
+ * Another streamer has started hosting your stream on their channel.
+ */
+public class Host<T extends User> {
+    private final T streamer;
+    private final String message;
+    private final int viewerCount;
+    private final OffsetDateTime time;
+
+    public Host(T streamer, String message, int viewerCount, OffsetDateTime time) {
+        this.streamer = streamer;
+        this.message = message;
+        this.viewerCount = viewerCount;
+        this.time = time;
+    }
+
+    /**
+     * Get the streamer which started hosting you.
+     *
+     * @return streamer that hosts you
+     */
+    public T getStreamer() {
+        return streamer;
+    }
+
+    /**
+     * Get the message from the streamer that has started hosting you.
+     *
+     * @return the host message
+     */
+    public String getMessage() {
+        return message;
+    }
+
+    /**
+     * Get the viewer count with which the streamer is hosting you.
+     *
+     * @return the viewer count of the host
+     */
+    public int getViewerCount() {
+        return viewerCount;
+    }
+
+    /**
+     * Get the time when the streamer has started hosting you.
+     *
+     * @return host time
+     */
+    public OffsetDateTime getTime() {
+        return time;
+    }
+}

src/main/java/org/codeoverflow/chatoverflow/api/io/dto/stat/stream/Raid.java

@@ -0,0 +1,58 @@
+package org.codeoverflow.chatoverflow.api.io.dto.stat.stream;
+
+import org.codeoverflow.chatoverflow.api.io.dto.User;
+
+import java.time.OffsetDateTime;
+
+/**
+ * Another streamer has started a raid against your stream.
+ */
+public class Raid<T extends User> {
+    private final T streamer;
+    private final String message;
+    private final int viewerCount;
+    private final OffsetDateTime time;
+
+    public Raid(T streamer, String message, int viewerCount, OffsetDateTime time) {
+        this.streamer = streamer;
+        this.message = message;
+        this.viewerCount = viewerCount;
+        this.time = time;
+    }
+
+    /**
+     * Get the streamer which started the raid.
+     *
+     * @return initiating streamer
+     */
+    public T getStreamer() {
+        return streamer;
+    }
+
+    /**
+     * Get the message from the initiating streamer.
+     *
+     * @return the raid message
+     */
+    public String getMessage() {
+        return message;
+    }
+
+    /**
+     * Get the viewer count with which the streamer raids you.
+     *
+     * @return the viewer count of the raid
+     */
+    public int getViewerCount() {
+        return viewerCount;
+    }
+
+    /**
+     * Get the time when the raid has started
+     *
+     * @return raid time
+     */
+    public OffsetDateTime getTime() {
+        return time;
+    }
+}

src/main/java/org/codeoverflow/chatoverflow/api/io/dto/stat/stream/Subscription.java

@@ -8,11 +8,17 @@ public class Subscription<T extends User> {
     private final T subscriber;
     private final OffsetDateTime time;
     private final int resub;
+    private final SubscriptionTier tier;
+    private final boolean gifted;
+    private final T donor;
 
-    public Subscription(T subscriber, int resub, OffsetDateTime time) {
+    public Subscription(T subscriber, OffsetDateTime time, int resub, SubscriptionTier tier, boolean gifted, T donor) {
         this.subscriber = subscriber;
         this.time = time;
         this.resub = resub;
+        this.tier = tier;
+        this.gifted = gifted;
+        this.donor = donor;
     }
 
     /**
@@ -24,6 +30,15 @@ public T getSubscriber() {
         return subscriber;
     }
 
+    /**
+     * Get the time when the user has subscribed
+     *
+     * @return subscription time
+     */
+    public OffsetDateTime getTime() {
+        return time;
+    }
+
     /**
      * Returns how often that user has subscribed
      *
@@ -34,11 +49,29 @@ public int getResub() {
     }
 
     /**
-     * Get the time when the user started following
+     * Returns the tier of the subscription {@link SubscriptionTier}.
      *
-     * @return follow start time
+     * @return the subscription tier
      */
-    public OffsetDateTime getTime() {
-        return time;
+    public SubscriptionTier getTier() {
+        return tier;
+    }
+
+    /**
+     * Returns if the subscription was gifted by someone else or not
+     *
+     * @return it the subscription was gifted
+     */
+    public boolean isGifted() {
+        return gifted;
+    }
+
+    /**
+     * Returns the donor of the subscription if it was gifted.
+     *
+     * @return the donor of the subscription
+     */
+    public T getDonor() {
+        return donor;
     }
 }

src/main/java/org/codeoverflow/chatoverflow/api/io/dto/stat/stream/SubscriptionTier.java

@@ -0,0 +1,43 @@
+package org.codeoverflow.chatoverflow.api.io.dto.stat.stream;
+
+import java.util.Arrays;
+
+/**
+ * Represents the tier of a {@link Subscription}.
+ */
+public enum SubscriptionTier {
+    PRIME, // Free for the user, same as a tier 1 for the streamer.
+    TIER1, // 4.99
+    TIER2, // 9.99
+    TIER3, // 24.99
+    UNKNOWN;
+
+    /**
+     * Converts the tier to a string, e.g. {@link #TIER1} is "tier 1", {@link #PRIME} is "prime" and
+     * {@link #UNKNOWN} is "unknown".
+     *
+     * @return the tier formatted as a string.
+     */
+    @Override
+    public String toString() {
+        switch (this) {
+            case PRIME: return "prime";
+            case TIER1: return "tier 1";
+            case TIER2: return "tier 2";
+            case TIER3: return "tier 3";
+            default: return "unknown";
+        }
+    }
+
+    /**
+     * Parse the tier from a string
+     *
+     * @param tier the tier of the subscription. 0 is prime, 1 is tier 1 and so on.
+     * @return the subscription-tier represented by the passed number or {@link #UNKNOWN}.
+     */
+    public static SubscriptionTier parse(int tier) {
+        return Arrays.stream(values())
+                .filter(e -> e.ordinal() == tier)
+                .findAny().orElse(UNKNOWN);
+    }
+}

src/main/java/org/codeoverflow/chatoverflow/api/io/dto/stat/stream/tipeeestream/TipeeestreamCheer.java

@@ -0,0 +1,12 @@
+package org.codeoverflow.chatoverflow.api.io.dto.stat.stream.tipeeestream;
+
+import org.codeoverflow.chatoverflow.api.io.dto.User;
+import org.codeoverflow.chatoverflow.api.io.dto.stat.stream.Cheer;
+
+import java.time.OffsetDateTime;
+
+public class TipeeestreamCheer extends Cheer<User> {
+    public TipeeestreamCheer(User cheerer, int amount, String cheerMessage, OffsetDateTime time) {
+        super(cheerer, amount, cheerMessage, time);
+    }
+}

src/main/java/org/codeoverflow/chatoverflow/api/io/dto/stat/stream/tipeeestream/TipeeestreamHost.java

@@ -0,0 +1,12 @@
+package org.codeoverflow.chatoverflow.api.io.dto.stat.stream.tipeeestream;
+
+import org.codeoverflow.chatoverflow.api.io.dto.User;
+import org.codeoverflow.chatoverflow.api.io.dto.stat.stream.Host;
+
+import java.time.OffsetDateTime;
+
+public class TipeeestreamHost extends Host<User> {
+    public TipeeestreamHost(User streamer, String message, int viewerCount, OffsetDateTime time) {
+        super(streamer, message, viewerCount, time);
+    }
+}

src/main/java/org/codeoverflow/chatoverflow/api/io/dto/stat/stream/tipeeestream/TipeeestreamRaid.java

@@ -0,0 +1,12 @@
+package org.codeoverflow.chatoverflow.api.io.dto.stat.stream.tipeeestream;
+
+import org.codeoverflow.chatoverflow.api.io.dto.User;
+import org.codeoverflow.chatoverflow.api.io.dto.stat.stream.Raid;
+
+import java.time.OffsetDateTime;
+
+public class TipeeestreamRaid extends Raid<User> {
+    public TipeeestreamRaid(User streamer, String message, int viewerCount, OffsetDateTime time) {
+        super(streamer, message, viewerCount, time);
+    }
+}

src/main/java/org/codeoverflow/chatoverflow/api/io/dto/stat/stream/tipeeestream/TipeeestreamSubscription.java

@@ -2,15 +2,16 @@
 
 import org.codeoverflow.chatoverflow.api.io.dto.User;
 import org.codeoverflow.chatoverflow.api.io.dto.stat.stream.Subscription;
+import org.codeoverflow.chatoverflow.api.io.dto.stat.stream.SubscriptionTier;
 
 import java.time.OffsetDateTime;
 
 public class TipeeestreamSubscription extends Subscription<User> {
 
     private final TipeeestreamProvider provider;
 
-    public TipeeestreamSubscription(User subscriber, int resub, OffsetDateTime time, TipeeestreamProvider provider) {
-        super(subscriber, resub, time);
+    public TipeeestreamSubscription(User subscriber, OffsetDateTime time, int resub, SubscriptionTier tier, boolean gifted, User donor, TipeeestreamProvider provider) {
+        super(subscriber, time, resub, tier, gifted, donor);
         this.provider = provider;
     }
 

src/main/java/org/codeoverflow/chatoverflow/api/io/event/stream/CheerEvent.java

@@ -0,0 +1,24 @@
+package org.codeoverflow.chatoverflow.api.io.event.stream;
+
+import org.codeoverflow.chatoverflow.api.io.dto.stat.stream.Cheer;
+
+/**
+ * Generic event for cheers
+ */
+public abstract class CheerEvent<T extends Cheer> {
+
+    private final T info;
+
+    protected CheerEvent(T cheerInfo) {
+        this.info = cheerInfo;
+    }
+
+    /**
+     * Get the Cheer object that contains all information about that cheer
+     *
+     * @return all info about that cheer
+     */
+    public T getInfo() {
+        return info;
+    }
+}

src/main/java/org/codeoverflow/chatoverflow/api/io/event/stream/HostEvent.java

@@ -0,0 +1,24 @@
+package org.codeoverflow.chatoverflow.api.io.event.stream;
+
+import org.codeoverflow.chatoverflow.api.io.dto.stat.stream.Host;
+
+/**
+ * Generic event for hosts
+ */
+public abstract class HostEvent<T extends Host> {
+
+    private final T info;
+
+    protected HostEvent(T cheerInfo) {
+        this.info = cheerInfo;
+    }
+
+    /**
+     * Get the Host object that contains all information about that host
+     *
+     * @return all info about that host
+     */
+    public T getInfo() {
+        return info;
+    }
+}