Add cheers to the api and to tipeeestream

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/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/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/tipeeestream/TipeeestreamCheerEvent.java

@@ -0,0 +1,13 @@
+package org.codeoverflow.chatoverflow.api.io.event.stream.tipeeestream;
+
+import org.codeoverflow.chatoverflow.api.io.dto.stat.stream.tipeeestream.TipeeestreamCheer;
+import org.codeoverflow.chatoverflow.api.io.event.stream.CheerEvent;
+
+/**
+ * Event that is triggered by tipeeestream if a user cheers on the stream.
+ */
+public class TipeeestreamCheerEvent extends CheerEvent<TipeeestreamCheer> implements TipeeestreamEvent {
+    public TipeeestreamCheerEvent(TipeeestreamCheer donationInfo) {
+        super(donationInfo);
+    }
+}

src/main/java/org/codeoverflow/chatoverflow/api/io/input/event/TipeeestreamEventInput.java

@@ -1,10 +1,7 @@
 package org.codeoverflow.chatoverflow.api.io.input.event;
 
 import org.codeoverflow.chatoverflow.api.IsRequirement;
-import org.codeoverflow.chatoverflow.api.io.event.stream.tipeeestream.TipeeestreamDonationEvent;
-import org.codeoverflow.chatoverflow.api.io.event.stream.tipeeestream.TipeeestreamEvent;
-import org.codeoverflow.chatoverflow.api.io.event.stream.tipeeestream.TipeeestreamFollowEvent;
-import org.codeoverflow.chatoverflow.api.io.event.stream.tipeeestream.TipeeestreamSubscriptionEvent;
+import org.codeoverflow.chatoverflow.api.io.event.stream.tipeeestream.*;
 
 import java.util.function.Consumer;
 
@@ -37,4 +34,13 @@ default void registerFollowEventHandler(Consumer<TipeeestreamFollowEvent> eventH
     default void registerDonationEventHandler(Consumer<TipeeestreamDonationEvent> eventHandler) {
         registerEventHandler(eventHandler, TipeeestreamDonationEvent.class);
     }
+
+    /**
+     * Register an event handler that listens to all {@link TipeeestreamCheerEvent}
+     *
+     * @param eventHandler consumer that receives the Events
+     */
+    default void registerCheerEventHandler(Consumer<TipeeestreamCheerEvent> eventHandler) {
+        registerEventHandler(eventHandler, TipeeestreamCheerEvent.class);
+    }
 }