Add Tipeeestream event input (See: codeoverflow-org/chatoverflow#43)

Author: J0B10

src/main/java/org/codeoverflow/chatoverflow/api/io/dto/event/Event.java

@@ -0,0 +1,70 @@
+package org.codeoverflow.chatoverflow.api.io.dto.stat.stream;
+
+import org.codeoverflow.chatoverflow.api.io.dto.User;
+
+import java.time.OffsetDateTime;
+import java.util.Currency;
+
+/**
+ * A user donated some money for your stream
+ */
+public class Donation<T extends User> {
+    private final T donor;
+    private final float amount;
+    private final Currency currency;
+    private final OffsetDateTime time;
+
+    public Donation(T donor, float amount, Currency currency, OffsetDateTime time) {
+        this.donor = donor;
+        this.amount = amount;
+        this.currency = currency;
+        this.time = time;
+    }
+
+    /**
+     * Get the user object of the person that donated
+     *
+     * @return the donor
+     */
+    public T getDonor() {
+        return donor;
+    }
+
+    /**
+     * Get how much the user donated
+     *
+     * @return amount of donated money
+     */
+    public float getAmount() {
+        return amount;
+    }
+
+    /**
+     * Get the currency used for this transaction
+     *
+     * @return currency object
+     */
+    public Currency getCurrency() {
+        return currency;
+    }
+
+    /**
+     * Get a formatted string how much the user donated.
+     * <br>
+     * <b>Example:</b>  {@code € 70.02}
+     *
+     * @return formatted donation amount
+     */
+    public String getFormattedAmount() {
+        return String.format("%s %,.2f", currency.getSymbol(), amount);
+    }
+
+    /**
+     * Get the time when the donation was made
+     *
+     * @return donation time
+     */
+    public OffsetDateTime getTime() {
+        return time;
+    }
+}

src/main/java/org/codeoverflow/chatoverflow/api/io/dto/event/tipeeestream/TipeeeStreamDonation.java

@@ -0,0 +1,37 @@
+package org.codeoverflow.chatoverflow.api.io.dto.stat.stream;
+
+import org.codeoverflow.chatoverflow.api.io.dto.User;
+
+import java.time.OffsetDateTime;
+
+/**
+ * A user started following the stream
+ */
+public class Follow<T extends User> {
+
+    private final T follower;
+    private final OffsetDateTime time;
+
+    public Follow(T follower, OffsetDateTime time) {
+        this.follower = follower;
+        this.time = time;
+    }
+
+    /**
+     * Get the user object of the person that started following
+     *
+     * @return the follower
+     */
+    public T getFollower() {
+        return follower;
+    }
+
+    /**
+     * Get the time when the user started following
+     *
+     * @return follow start time
+     */
+    public OffsetDateTime getTime() {
+        return time;
+    }
+}

src/main/java/org/codeoverflow/chatoverflow/api/io/dto/event/tipeeestream/TipeeeStreamEvent.java

@@ -0,0 +1,44 @@
+package org.codeoverflow.chatoverflow.api.io.dto.stat.stream;
+
+import org.codeoverflow.chatoverflow.api.io.dto.User;
+
+import java.time.OffsetDateTime;
+
+public class Subscription<T extends User> {
+    private final T subscriber;
+    private final OffsetDateTime time;
+    private final int resub;
+
+    public Subscription(T subscriber, int resub, OffsetDateTime time) {
+        this.subscriber = subscriber;
+        this.time = time;
+        this.resub = resub;
+    }
+
+    /**
+     * Get the user object of the person that started following
+     *
+     * @return the subscriber
+     */
+    public T getSubscriber() {
+        return subscriber;
+    }
+
+    /**
+     * Returns how often that user has subscribed
+     *
+     * @return how often a user resubbed
+     */
+    public int getResub() {
+        return resub;
+    }
+
+    /**
+     * Get the time when the user started following
+     *
+     * @return follow start time
+     */
+    public OffsetDateTime getTime() {
+        return time;
+    }
+}

src/main/java/org/codeoverflow/chatoverflow/api/io/dto/event/tipeeestream/TipeeeStreamFollow.java

@@ -0,0 +1,26 @@
+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.Donation;
+
+import java.time.OffsetDateTime;
+import java.util.Currency;
+
+public class TipeeestreamDonation extends Donation<User> {
+
+    private final String donationMessage;
+
+    public TipeeestreamDonation(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/event/tipeeestream/TipeeeStreamSubscription.java

@@ -0,0 +1,25 @@
+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.Follow;
+
+import java.time.OffsetDateTime;
+
+public class TipeeestreamFollow extends Follow<User> {
+
+    private final TipeeestreamProvider provider;
+
+    public TipeeestreamFollow(User follower, OffsetDateTime time, TipeeestreamProvider provider) {
+        super(follower, time);
+        this.provider = provider;
+    }
+
+    /**
+     * Get the service over which this follow was made
+     *
+     * @return the provider of this follow
+     */
+    public TipeeestreamProvider getProvider() {
+        return provider;
+    }
+}

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

@@ -0,0 +1,27 @@
+package org.codeoverflow.chatoverflow.api.io.dto.stat.stream.tipeeestream;
+
+import java.util.Arrays;
+
+/**
+ * A provider service to which tipeeestream is connected (like youtoube or twitch)
+ */
+public enum TipeeestreamProvider {
+    TWITCH,
+    YOUTUBE,
+    UNKNOWN;
+    //Currently we have no dataset to test the less popular providers, therefore they are grouped under UNKNOWN
+
+    @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 {@link #UNKNOWN}
+     */
+    public static TipeeestreamProvider parse(String provider) {
+        return Arrays.stream(values()).filter(p -> p.toString().equals(provider.trim().toLowerCase())).findAny().orElse(UNKNOWN);
+    }
+}