Events - work in progress

Author: TheLimeGlass

.gradle/4.3/fileHashes/fileHashes.bin

@@ -4,27 +4,35 @@ apply plugin: 'eclipse'
 jar.archiveName = project.name + '.jar'
 
 repositories {
-    jcenter()
+	jcenter()
 }
 
 dependencies {
 
 	//Nullable annotation
 	compile (group: 'org.eclipse.jdt', name: 'org.eclipse.jdt.annotation', version: '1.1.0')
 
+	//Reflections
+	compile (group: 'org.reflections', name: 'reflections', version: '0.9.11')
+
 	//Gson
 	compile (group: 'com.google.code.gson', name: 'gson', version: '2.8.5')
-    
-    //Reflections
-    compile (group: 'org.reflections', name: 'reflections', version: '0.9.11')
-    
-    // Configurations
-    testCompile 'org.apache.commons:commons-configuration2:2.2'
-    testCompile 'org.apache.commons:commons-lang3:3.3.2'
-    testCompile 'commons-logging:commons-logging:1.1.3'
-    testCompile 'commons-beanutils:commons-beanutils:1.9.2'
-    testCompile 'commons-codec:commons-codec:1.9'
-    testCompile 'commons-jxpath:commons-jxpath:1.3'
-    testCompile 'org.apache.commons:commons-jexl:2.1.1'
+	
+	//org.json
+	compile (group: 'org.json', name: 'json', version: '20180813')
+	
+	//Socket.IO
+	compile ('io.socket:socket.io-client:1.0.0') {
+		exclude group: 'org.json', module: 'json'
+	}
+	
+	// Configurations
+	testCompile 'org.apache.commons:commons-configuration2:2.2'
+	testCompile 'org.apache.commons:commons-lang3:3.3.2'
+	testCompile 'commons-logging:commons-logging:1.1.3'
+	testCompile 'commons-beanutils:commons-beanutils:1.9.2'
+	testCompile 'commons-codec:commons-codec:1.9'
+	testCompile 'commons-jxpath:commons-jxpath:1.3'
+	testCompile 'org.apache.commons:commons-jexl:2.1.1'
 
 }

.gradle/4.3/fileHashes/fileHashes.lock

@@ -35,6 +35,14 @@ public interface StreamElements {
 	 */
 	List<Points> getUserPoints(Collection<User> users);
 
+	/**
+	 * May only be a positive number.
+	 * 
+	 * @param points The amount of current points to set.
+	 * @param existing An existing Points instance.
+	 */
+	void setCurrentUserPoints(long points, Points... existing);
+	
 	/**
 	 * May only be a positive number.
 	 * 
@@ -75,6 +83,13 @@ public interface StreamElements {
 	 */
 	void addPoints(User user, long points);
 
+	/**
+	 * Removes a user from the points system.
+	 * 
+	 * @param user The User to set points of.
+	 */
+	void removeUserPoints(User user);
+	
 	/**
 	 * @param username The username to get points from.
 	 * @return The points of a user by string username.
@@ -87,4 +102,14 @@ public interface StreamElements {
 	 */
 	Points getUserPoints(User user);
 
+	/**
+	 * Resets all the current points.
+	 */
+	void resetCurrentPoints();
+	
+	/**
+	 * Resets the all-time points.
+	 */
+	void resetAllPoints();
+	
 }

build.gradle

@@ -7,6 +7,7 @@ public final class StreamElementsBuilder {
 
 	private String token, accountID;
 	private int timeout = 20 * 1000;
+	private Class<?>[] listeners;
 
 	/**
 	 * For those whom love keeping clean methods per line.
@@ -27,6 +28,16 @@ public StreamElementsBuilder(String token, String accountID) {
 		this.token = token;
 	}
 
+	/**
+	 * Register any listeners.
+	 * If a method contains 1 parameter of an ElementsEvent and has the @EventListener annotation,
+	 * it will be called when an event happens.
+	 */
+	public StreamElementsBuilder registerListeners(Class<?>... listeners) {
+		this.listeners = listeners;
+		return this;
+	}
+	
 	/**
 	 * Set the connection timeout of the client.
 	 * Recommended to set one.
@@ -51,14 +62,23 @@ public StreamElementsBuilder withToken(String token) {
 		this.token = token;
 		return this;
 	}
-
+	
 	/**
-	 * @return The timeout defined by the client.
+	 * NOTE: These classes aren't registered until the build method has been triggered.
+	 * 
+	 * @return The classes that have been scanned and registered listeners for.
 	 */
-	public int getTimeout() {
-		return timeout;
+	public Class<?>[] getListeners() {
+		return listeners;
 	}
 
+	/**
+	 * @return The StreamElements Account ID of the client.
+	 */
+	public String getAccountID() {
+		return accountID;
+	}
+
 	/**
 	 * @return The StreamElements JWT token of the client.
 	 */
@@ -67,16 +87,17 @@ public String getToken() {
 	}
 
 	/**
-	 * @return the StreamElements Account ID of the client.
+	 * @return The timeout defined by the client.
 	 */
-	public String getAccountID() {
-		return accountID;
+	public int getTimeout() {
+		return timeout;
 	}
 
 	//TODO
 	public StreamElements build() {
-		if (token == null || accountID == null) throw new StreamElementsException("The StreamElements token or account ID was not set!");
-		return new StreamElementsClient(token, accountID, timeout);
+		if (token == null || accountID == null)
+			throw new StreamElementsException("The StreamElements token or account ID was not set!");
+		return new StreamElementsClient(token, accountID, timeout, listeners);
 	}
 
 }

src/main/java/me/limeglass/streamelements/api/StreamElements.java

@@ -0,0 +1,11 @@
+package me.limeglass.streamelements.api.annotations;
+
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+
+@Retention(RetentionPolicy.RUNTIME)
+@Target(ElementType.METHOD)
+public @interface EventListener {
+}

src/main/java/me/limeglass/streamelements/api/StreamElementsBuilder.java

@@ -0,0 +1,9 @@
+package me.limeglass.streamelements.api.events;
+
+import me.limeglass.streamelements.internals.events.ElementsEvent;
+
+public class ConnectingEvent extends ElementsEvent {
+	
+	public ConnectingEvent() {}
+	
+}

src/main/java/me/limeglass/streamelements/api/annotations/EventListener.java

@@ -0,0 +1,20 @@
+package me.limeglass.streamelements.api.events;
+
+import me.limeglass.streamelements.internals.events.ElementsEvent;
+
+public class ConnectionEvent extends ElementsEvent {
+
+	private final boolean successful;
+	
+	public ConnectionEvent(boolean successful) {
+		this.successful = successful;
+	}
+
+	/**
+	 * @return If the connection is successful.
+	 */
+	public boolean isSuccessful() {
+		return successful;
+	}
+	
+}

src/main/java/me/limeglass/streamelements/api/events/ConnectingEvent.java

@@ -4,10 +4,13 @@
 import java.util.List;
 import java.util.stream.Collectors;
 
+import io.socket.client.Socket;
 import me.limeglass.streamelements.api.StreamElements;
 import me.limeglass.streamelements.api.objects.Activity;
 import me.limeglass.streamelements.api.objects.Points;
 import me.limeglass.streamelements.api.objects.User;
+import me.limeglass.streamelements.internals.events.EventDispatcher;
+import me.limeglass.streamelements.internals.events.SocketListener;
 import me.limeglass.streamelements.internals.handlers.ElementsReaderHandler;
 import me.limeglass.streamelements.internals.handlers.ElementsRequest;
 import me.limeglass.streamelements.internals.handlers.ElementsRequest.HttpMethod;
@@ -17,20 +20,32 @@
 public class StreamElementsClient implements StreamElements {
 
 	private final String token, account;
+	private Class<?>[] listeners;
 	private final int timeout;
+	private Socket socket;
 
 	/**
 	 * The StreamElements client Constructor
 	 * 
 	 * @param token The JWT token used from StreamElements. (Found under account)
 	 * @param accountID The account ID used from StreamElements. (Found under account)
 	 */
-	public StreamElementsClient(String token, String account, int timeout) {
+	public StreamElementsClient(String token, String account, int timeout, Class<?>[] listeners) {
 		ElementsReaderHandler.load("me.limeglass.streamelements.internals.readers");
+		if (listeners != null && listeners.length > 0)
+			this.listeners = EventDispatcher.registerListeners(listeners);
+		this.socket = SocketListener.registerSocket(this);
 		this.account = account;
 		this.timeout = timeout;
 		this.token = token;
 	}
+	
+	/**
+	 * @return The classes that have been scanned and registered listeners for.
+	 */
+	public Class<?>[] getListeners() {
+		return listeners;
+	}
 
 	/**
 	 * @return the StreamElements Account ID of the client.
@@ -40,6 +55,13 @@ public String getAccountID() {
 		return account;
 	}
 
+	/**
+	 * @return The Socket.IO for realtime.streamelements.com
+	 */
+	public Socket getSocket() {
+		return socket;
+	}
+	
 	/**
 	 * @return The StreamElements JWT token of the client.
 	 */
@@ -91,6 +113,11 @@ public void setCurrentUserPoints(String username, long points) {
 		String update = "/" + (current >= points ? "-" + (current - points) : points - current);
 		ElementsRequest.makeRequest(this, PointsResponse.class, HttpMethod.PUT, ElementsEndpoints.POINTS + account + "/" + username + update);
 	}
+	
+	@Override
+	public void setCurrentUserPoints(long points, Points... existing) {
+		for (Points user : existing) setCurrentUserPoints(user.getUser(), points);
+	}
 
 	@Override
 	public void setCurrentUserPoints(User user, long points) {
@@ -117,4 +144,19 @@ public void addPoints(User user, long points) {
 		addPoints(user.getName(), points);
 	}
 
+	@Override
+	public void removeUserPoints(User user) {
+		ElementsRequest.makeRequest(this, PointsResponse.class, HttpMethod.DELETE, ElementsEndpoints.POINTS + account + "/" + user.getName());
+	}
+
+	@Override
+	public void resetCurrentPoints() {
+		ElementsRequest.makeRequest(this, PointsResponse.class, HttpMethod.DELETE, ElementsEndpoints.POINTS + account + "/reset/current");
+	}
+
+	@Override
+	public void resetAllPoints() {
+		ElementsRequest.makeRequest(this, PointsResponse.class, HttpMethod.DELETE, ElementsEndpoints.POINTS + account + "/reset/alltime");
+	}
+
 }

src/main/java/me/limeglass/streamelements/api/events/ConnectionEvent.java

@@ -0,0 +1,13 @@
+package me.limeglass.streamelements.internals.events;
+
+import io.socket.client.Socket;
+
+public class ElementsEvent {
+
+	protected static Socket socket;
+	
+	public static void setSocket(Socket s) {
+		socket = s;
+	}
+	
+}