Add initial StreamElements implementation

Author: hlxid

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

@@ -0,0 +1,28 @@
+package org.codeoverflow.chatoverflow.api.io.dto.stat.stream.streamelements;
+
+import org.codeoverflow.chatoverflow.api.io.dto.User;
+import org.codeoverflow.chatoverflow.api.io.dto.stat.stream.Donation;
+
+import java.time.OffsetDateTime;
+import java.util.Currency;
+
+/**
+ * A donation for the streamer at StreamElements
+ */
+public class StreamElementsDonation extends Donation<User> {
+    private final String donationMessage;
+
+    public StreamElementsDonation(User donor, float amount, Currency currency, OffsetDateTime time, String donationMessage) {
+        super(donor, amount, currency, time);
+        this.donationMessage = donationMessage;
+    }
+
+    /**
+     * Get the message that a user included in his donation
+     *
+     * @return the donation message
+     */
+    public String getDonationMessage() {
+        return donationMessage;
+    }
+}

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

@@ -0,0 +1,23 @@
+package org.codeoverflow.chatoverflow.api.io.dto.stat.stream.streamelements;
+
+import org.codeoverflow.chatoverflow.api.io.dto.User;
+import org.codeoverflow.chatoverflow.api.io.dto.stat.stream.Follow;
+
+import java.time.OffsetDateTime;
+
+/**
+ * A follow that is reported by StreamElements.
+ */
+public class StreamElementsFollow extends Follow<User> {
+
+    private final StreamElementsProvider provider;
+
+    public StreamElementsFollow(User follower, OffsetDateTime time, StreamElementsProvider provider) {
+        super(follower, time);
+        this.provider = provider;
+    }
+
+    public StreamElementsProvider getProvider() {
+        return provider;
+    }
+}

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

@@ -0,0 +1,27 @@
+package org.codeoverflow.chatoverflow.api.io.dto.stat.stream.streamelements;
+
+
+import java.util.Arrays;
+
+/**
+ * The streaming provider from which a StreamElements event is originated. Either Twitch or Youtube.
+ */
+public enum StreamElementsProvider {
+    // StreamElements only supports Twitch and Youtube
+    TWITCH,
+    YOUTUBE;
+
+    @Override
+    public String toString() {
+        return name().toLowerCase();
+    }
+
+    /**
+     * Parse the provider from a string
+     * @param provider string with the providers name
+     * @return the provider for that string or null, if it doesn't exists.
+     */
+    public static StreamElementsProvider parse(String provider) {
+        return Arrays.stream(values()).filter(p -> p.toString().equals(provider.trim().toLowerCase())).findAny().orElse(null);
+    }
+}

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

@@ -0,0 +1,29 @@
+package org.codeoverflow.chatoverflow.api.io.dto.stat.stream.streamelements;
+
+import org.codeoverflow.chatoverflow.api.io.dto.User;
+import org.codeoverflow.chatoverflow.api.io.dto.stat.stream.Subscription;
+
+import java.time.OffsetDateTime;
+
+/**
+ * A subscription to the channel of the streamer that is reported by StreamElements.
+ */
+public class StreamElementsSubscription extends Subscription<User> {
+
+    private final StreamElementsProvider provider;
+    private final boolean gifted;
+
+    public StreamElementsSubscription(User subscriber, int resub, OffsetDateTime time, StreamElementsProvider provider, boolean gifted) {
+        super(subscriber, resub, time);
+        this.provider = provider;
+        this.gifted = gifted;
+    }
+
+    public StreamElementsProvider getProvider() {
+        return provider;
+    }
+
+    public boolean isGifted() {
+        return gifted;
+    }
+}

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

@@ -0,0 +1,13 @@
+package org.codeoverflow.chatoverflow.api.io.event.stream.streamelements;
+
+import org.codeoverflow.chatoverflow.api.io.dto.stat.stream.streamelements.StreamElementsDonation;
+import org.codeoverflow.chatoverflow.api.io.event.stream.DonationEvent;
+
+/**
+ * A event that is triggered if a user donates on StreamElements.
+ */
+public class StreamElementsDonationEvent extends DonationEvent<StreamElementsDonation> implements StreamElementsEvent {
+    public StreamElementsDonationEvent(StreamElementsDonation donationInfo) {
+        super(donationInfo);
+    }
+}

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

@@ -0,0 +1,9 @@
+package org.codeoverflow.chatoverflow.api.io.event.stream.streamelements;
+
+import org.codeoverflow.chatoverflow.api.io.event.Event;
+
+/**
+ * Common interface between all StreamElements events.
+ */
+public interface StreamElementsEvent extends Event {
+}

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

@@ -0,0 +1,13 @@
+package org.codeoverflow.chatoverflow.api.io.event.stream.streamelements;
+
+import org.codeoverflow.chatoverflow.api.io.dto.stat.stream.streamelements.StreamElementsFollow;
+import org.codeoverflow.chatoverflow.api.io.event.stream.FollowEvent;
+
+/**
+ * Event that is triggered by StreamElements if a user starts following your channel.
+ */
+public class StreamElementsFollowEvent extends FollowEvent<StreamElementsFollow> implements StreamElementsEvent {
+    public StreamElementsFollowEvent(StreamElementsFollow info) {
+        super(info);
+    }
+}

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

@@ -0,0 +1,13 @@
+package org.codeoverflow.chatoverflow.api.io.event.stream.streamelements;
+
+import org.codeoverflow.chatoverflow.api.io.dto.stat.stream.streamelements.StreamElementsSubscription;
+import org.codeoverflow.chatoverflow.api.io.event.stream.SubscriptionEvent;
+
+/**
+ * A event that is triggered by StreamElements if a users subscribes your channel.
+ */
+public class StreamElementsSubscriptionEvent extends SubscriptionEvent<StreamElementsSubscription> implements StreamElementsEvent {
+    public StreamElementsSubscriptionEvent(StreamElementsSubscription info) {
+        super(info);
+    }
+}

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

@@ -0,0 +1,43 @@
+package org.codeoverflow.chatoverflow.api.io.input.event;
+
+import org.codeoverflow.chatoverflow.api.IsRequirement;
+import org.codeoverflow.chatoverflow.api.io.event.stream.streamelements.StreamElementsDonationEvent;
+import org.codeoverflow.chatoverflow.api.io.event.stream.streamelements.StreamElementsEvent;
+import org.codeoverflow.chatoverflow.api.io.event.stream.streamelements.StreamElementsFollowEvent;
+import org.codeoverflow.chatoverflow.api.io.event.stream.streamelements.StreamElementsSubscriptionEvent;
+
+import java.util.function.Consumer;
+
+/**
+ * A Input which allows you to add event handlers for various StreamElements related events like donations.
+ */
+@IsRequirement(requires = "access to the StreamElements api", methodName = "streamElements")
+public interface StreamElementsEventInput extends EventInput<StreamElementsEvent> {
+
+    /**
+     * Register an event handler that listens to all {@link StreamElementsSubscriptionEvent}
+     *
+     * @param eventHandler consumer that receives the Events
+     */
+    default void registerSubscriptionEventHandler(Consumer<StreamElementsSubscriptionEvent> eventHandler) {
+        registerEventHandler(eventHandler, StreamElementsSubscriptionEvent.class);
+    }
+
+    /**
+     * Register an event handler that listens to all {@link StreamElementsFollowEvent}
+     *
+     * @param eventHandler consumer that receives the Events
+     */
+    default void registerFollowEventHandler(Consumer<StreamElementsFollowEvent> eventHandler) {
+        registerEventHandler(eventHandler, StreamElementsFollowEvent.class);
+    }
+
+    /**
+     * Register an event handler that listens to all {@link StreamElementsDonationEvent}
+     *
+     * @param eventHandler consumer that receives the Events
+     */
+    default void registerDonationEventHandler(Consumer<StreamElementsDonationEvent> eventHandler) {
+        registerEventHandler(eventHandler, StreamElementsDonationEvent.class);
+    }
+}

src/main/java/org/codeoverflow/chatoverflow/api/plugin/configuration/Input.java

@@ -7,6 +7,7 @@
 import org.codeoverflow.chatoverflow.api.io.input.SerialInput;
 import org.codeoverflow.chatoverflow.api.io.input.chat.DiscordChatInput;
 import org.codeoverflow.chatoverflow.api.io.input.chat.TwitchChatInput;
+import org.codeoverflow.chatoverflow.api.io.input.event.StreamElementsEventInput;
 import org.codeoverflow.chatoverflow.api.io.input.event.TipeeestreamEventInput;
 
 // THIS FILE IS GENERATED WHILE COMPILING. DO NOT CHANGE ANYTHING HERE!
@@ -132,6 +133,28 @@ public Requirement<TwitchChatInput> twitchChat(String uniqueRequirementId) {
         return requirements.requireInput(uniqueRequirementId, "Twitch Chat", false, TwitchChatInput.class);
     }
 
+    /**
+     * Requires a access to the StreamElements api which has to be specified by the user.
+     *
+     * @param uniqueRequirementId a plugin unique identifier which is stored for your plugin
+     * @param displayName         a string to display to the user while setting your requirement
+     * @param isOptional          true if this requirement is optional, false if mandatory
+     * @return the requirement object. Use the get() method only at runtime!
+     */
+    public Requirement<StreamElementsEventInput> streamElements(String uniqueRequirementId, String displayName, boolean isOptional) {
+        return requirements.requireInput(uniqueRequirementId, displayName, isOptional, StreamElementsEventInput.class);
+    }
+
+    /**
+     * Requires a access to the StreamElements api which has to be specified by the user.
+     *
+     * @param uniqueRequirementId a plugin unique identifier which is stored for your plugin
+     * @return the requirement object. Use the get() method only at runtime!
+     */
+    public Requirement<StreamElementsEventInput> streamElements(String uniqueRequirementId) {
+        return requirements.requireInput(uniqueRequirementId, "Stream Elements Event", false, StreamElementsEventInput.class);
+    }
+
     /**
      * Requires a login for the TipeeeStream api which has to be specified by the user.
      *