Merge pull request #30 from rwth-acis/develop

RocketChat channel connection

gradle.properties

@@ -1,7 +1,7 @@
-core.version=1.2.0
+core.version=1.2.2
 service.name=i5.las2peer.services.projectService
 service.class=ProjectService
-service.version=1.0.1
+service.version=1.1.0
 java.version=17
 
 las2peer_user1.name=alice

project_service/build.gradle

@@ -31,6 +31,8 @@ dependencies {
     // las2peer bundle which is not necessary in the runtime path
     // compileOnly will be moved into the lib dir afterwards
     implementation "i5:las2peer-bundle:${project.property('core.version')}"
+
+    implementation "com.konghq:unirest-java:3.13.10"
 
 }
 

project_service/src/main/java/i5/las2peer/services/projectService/ProjectService.java

@@ -30,6 +30,7 @@
 import i5.las2peer.api.persistency.EnvelopeOperationFailedException;
 import i5.las2peer.restMapper.RESTService;
 import i5.las2peer.restMapper.annotations.ServicePath;
+import i5.las2peer.services.projectService.chat.ChatManager;
 import io.swagger.annotations.Api;
 import io.swagger.annotations.ApiOperation;
 import io.swagger.annotations.ApiResponse;
@@ -189,6 +190,15 @@ public JSONObject getProjectMetadataRMI(String system, String projectName) {
 		return metadata;
 	}
 
+	public JSONObject getProjectChatInfo(String system, String projectName) {
+		Response r = this.getProjectByName(system, projectName);
+		if(r.getStatus() != 200) return null;
+		String entity = (String) r.getEntity();
+		JSONObject projectJSON = (JSONObject) JSONValue.parse(entity);
+		JSONObject chatInfo = (JSONObject) projectJSON.get("chatInfo");
+		return chatInfo;
+	}
+
 	/**
 	 * Creates a new project in the pastry storage. Therefore, the user needs to be
 	 * authorized. First, checks if a project with the given name already exists. If
@@ -286,6 +296,15 @@ public Response postProject(@PathParam("system") String system, String inputProj
 				}
 			}
 
+			// check if chat channel should be created
+			if(this.systemsConfig.isChannelCreationEnabled(system)) {
+                ChatManager chatManager = this.systemsConfig.getChatManager(system);
+                JSONObject chatInfo = chatManager.createProjectChannel(project, system);
+				if(chatInfo != null) {
+					project.setChatInfo(chatInfo);
+				}
+			}
+
 			ProjectContainer cc = new ProjectContainer();
 
 			cc.addProject(project);

project_service/src/main/java/i5/las2peer/services/projectService/chat/ChatConfig.java

@@ -0,0 +1,8 @@
+package i5.las2peer.services.projectService.chat;
+
+/**
+ * Super class for all chat configurations.
+ * Currently, only RocketChat config is implemented.
+ */
+public abstract class ChatConfig {
+}

project_service/src/main/java/i5/las2peer/services/projectService/chat/ChatManager.java

@@ -0,0 +1,20 @@
+package i5.las2peer.services.projectService.chat;
+
+import i5.las2peer.services.projectService.project.Project;
+import org.json.simple.JSONObject;
+
+/**
+ * Super class for all chat managers.
+ * Currently, only RocketChat is implemented.
+ */
+public abstract class ChatManager {
+
+    protected ChatConfig config;
+
+    public ChatManager(ChatConfig config) {
+        this.config = config;
+    }
+
+    public abstract JSONObject createProjectChannel(Project project, String systemName);
+
+}

project_service/src/main/java/i5/las2peer/services/projectService/chat/RocketChatConfig.java

@@ -0,0 +1,49 @@
+package i5.las2peer.services.projectService.chat;
+
+import org.json.simple.JSONObject;
+
+/**
+ * RocketChat instance configuration.
+ */
+public class RocketChatConfig extends ChatConfig {
+
+    /**
+     * Public url of RocketChat instance.
+     */
+    private String url;
+
+    /**
+     * Auth token of bot account that is used to make API calls.
+     */
+    private String botAuthToken;
+
+    /**
+     * User ID of bot account that is used to make API calls.
+     */
+    private String botUserId;
+
+    public RocketChatConfig(String url, String botAuthToken, String botUserId) {
+        this.url = url;
+        this.botAuthToken = botAuthToken;
+        this.botUserId = botUserId;
+    }
+
+    public static RocketChatConfig fromJSON(JSONObject config) {
+        String url = (String) config.get("url");
+        String botAuthToken = (String) config.get("botAuthToken");
+        String botUserId = (String) config.get("botUserId");
+        return new RocketChatConfig(url, botAuthToken, botUserId);
+    }
+
+    public String getUrl() {
+        return url;
+    }
+
+    public String getBotAuthToken() {
+        return botAuthToken;
+    }
+
+    public String getBotUserId() {
+        return botUserId;
+    }
+}

project_service/src/main/java/i5/las2peer/services/projectService/chat/RocketChatManager.java

@@ -0,0 +1,51 @@
+package i5.las2peer.services.projectService.chat;
+
+import i5.las2peer.services.projectService.project.Project;
+import kong.unirest.HttpResponse;
+import kong.unirest.Unirest;
+import org.json.simple.JSONObject;
+import org.json.simple.JSONValue;
+
+/**
+ * ChatManager for RocketChat. Allows to create channels for las2peer projects.
+ */
+public class RocketChatManager extends ChatManager {
+
+    public RocketChatManager(ChatConfig config) {
+        super(config);
+    }
+
+    @Override
+    public JSONObject createProjectChannel(Project project, String systemName) {
+        String channelName = project.getName().replaceAll(" ", "") + "_" + systemName;
+
+        JSONObject body = new JSONObject();
+        body.put("name", channelName);
+
+        HttpResponse<String> response = Unirest.post(getConfig().getUrl() + "/api/v1/channels.create")
+                .header("X-Auth-Token", getConfig().getBotAuthToken())
+                .header("X-User-Id", getConfig().getBotUserId())
+                .header("Content-Type", "application/json")
+                .body(body.toJSONString())
+                .asString();
+
+        if(!response.isSuccess()) {
+            System.out.println("RocketChat channel creation failed with status code: " + response.getStatus());
+            return null;
+        }
+
+        JSONObject res = (JSONObject) JSONValue.parse(response.getBody());
+        JSONObject resChannel = (JSONObject) res.get("channel");
+
+        JSONObject channelInfo = new JSONObject();
+        channelInfo.put("type", "RocketChat");
+        channelInfo.put("url", getConfig().getUrl());
+        channelInfo.put("channelId", resChannel.get("_id"));
+        channelInfo.put("chatUrl", getConfig().getUrl() + "/channel/" + resChannel.get("_id"));
+        return channelInfo;
+    }
+
+    private RocketChatConfig getConfig() {
+        return (RocketChatConfig) this.config;
+    }
+}

project_service/src/main/java/i5/las2peer/services/projectService/project/Project.java

@@ -5,6 +5,7 @@
 import java.util.HashMap;
 import java.util.List;
 
+import org.json.simple.JSONArray;
 import org.json.simple.JSONValue;
 import org.json.simple.JSONObject;
 import org.json.simple.parser.ParseException;
@@ -58,6 +59,8 @@ public class Project implements Serializable {
 	 */
 	private HashMap<String, String> memberGitHubUsernames;
 
+	private JSONObject chatInfo = new JSONObject();
+
 	/**
 	 * Creates a project object from the given JSON string. This constructor should
 	 * be used before storing new projects.
@@ -152,6 +155,7 @@ public JSONObject toJSONObject() {
 		if(this.gitHubProjectConnected()) {
 			jsonProject.put("gitHubProject", this.connectedGitHubProject.toJSONObject());
 		}
+		jsonProject.put("chatInfo", this.chatInfo);
 
 		return jsonProject;
 	}
@@ -286,4 +290,8 @@ public boolean removeNonGroupMembersGitHubAccess(String system, String[] groupMe
 		}
 		return changed;
 	}
+
+	public void setChatInfo(JSONObject chatInfo) {
+		this.chatInfo = chatInfo;
+	}
 }

project_service/src/main/java/i5/las2peer/services/projectService/util/ProjectServiceSystem.java

@@ -1,5 +1,8 @@
 package i5.las2peer.services.projectService.util;
 
+import i5.las2peer.services.projectService.chat.ChatManager;
+import i5.las2peer.services.projectService.chat.RocketChatConfig;
+import i5.las2peer.services.projectService.chat.RocketChatManager;
 import org.json.simple.JSONObject;
 
 import i5.las2peer.services.projectService.ProjectService;
@@ -18,6 +21,8 @@ public class ProjectServiceSystem {
 	private static final String JSON_KEY_GITHUB_PROJECTS_ENABLED = "gitHubProjectsEnabled";
     private static final String JSON_KEY_GITHUB_ORGANIZATION = "gitHubOrganization";
     private static final String JSON_KEY_GITHUB_PERSONAL_ACCESS_TOKEN = "gitHubPersonalAccessToken";
+
+	private static final String JSON_KEY_ROCKET_CHAT_CONFIG = "rocketchat";
 
 	/**
 	 * Name of the system. Example: SBF
@@ -53,6 +58,8 @@ public class ProjectServiceSystem {
 	 * to create new GitHub projects in the used GitHub organization.
 	 */
 	private String gitHubPersonalAccessToken;
+
+	private RocketChatConfig rocketChatConfig = null;
 
 	public ProjectServiceSystem(String systemName, JSONObject systemJSON) {
 		this.name = systemName;
@@ -75,6 +82,10 @@ public ProjectServiceSystem(String systemName, JSONObject systemJSON) {
 			this.gitHubPersonalAccessToken = (String) systemJSON.get(JSON_KEY_GITHUB_PERSONAL_ACCESS_TOKEN);
 		}
 
+		if(systemJSON.containsKey(JSON_KEY_ROCKET_CHAT_CONFIG)) {
+			this.rocketChatConfig = RocketChatConfig.fromJSON((JSONObject) systemJSON.get(JSON_KEY_ROCKET_CHAT_CONFIG));
+		}
+
 		this.eventListenerService = (String) systemJSON.getOrDefault(JSON_KEY_EVENT_LISTENER_SERVICE, null);
 	}
 
@@ -106,4 +117,16 @@ public String getGitHubOrganization() {
 	public String getGitHubPersonalAccessToken() {
 		return this.gitHubPersonalAccessToken;
 	}
+
+	public RocketChatConfig getRocketChatConfig() {
+		return rocketChatConfig;
+	}
+
+	public boolean isChannelCreationEnabled() {
+		return this.rocketChatConfig != null;
+	}
+
+	public ChatManager getChatManager() {
+		return new RocketChatManager(this.rocketChatConfig);
+	}
 }

project_service/src/main/java/i5/las2peer/services/projectService/util/SystemsConfig.java

@@ -3,6 +3,8 @@
 import java.util.ArrayList;
 import java.util.HashMap;
 import java.util.List;
+
+import i5.las2peer.services.projectService.chat.ChatManager;
 import org.json.simple.JSONObject;
 
 import i5.las2peer.services.projectService.ProjectService;
@@ -91,4 +93,18 @@ public String getGitHubPATBySystem(String systemName) {
 		}
 		return null;
 	}
+
+	public boolean isChannelCreationEnabled(String systemName) {
+		for(ProjectServiceSystem system : this.systems) {
+			if(system.getName().equals(systemName)) return system.isChannelCreationEnabled();
+		}
+		return false;
+	}
+
+	public ChatManager getChatManager(String systemName) {
+		for(ProjectServiceSystem system : this.systems) {
+			if(system.getName().equals(systemName)) return system.getChatManager();
+		}
+		return null;
+	}
 }

project_service/src/test/java/i5/las2peer/services/projectService/chat/RocketChatConfigTest.java

@@ -0,0 +1,26 @@
+package i5.las2peer.services.projectService.chat;
+
+import org.json.simple.JSONObject;
+import org.junit.Test;
+
+import static org.junit.Assert.*;
+
+public class RocketChatConfigTest {
+
+    private static String url = "http://url.com";
+    private static String botAuthToken = "token";
+    private static String botUserId = "id";
+
+    @Test
+    public void fromJSONTest() {
+        JSONObject configJSON = new JSONObject();
+        configJSON.put("url", url);
+        configJSON.put("botAuthToken", botAuthToken);
+        configJSON.put("botUserId", botUserId);
+
+        RocketChatConfig chatConfig = RocketChatConfig.fromJSON(configJSON);
+        assertEquals(chatConfig.getUrl(), url);
+        assertEquals(chatConfig.getBotAuthToken(), botAuthToken);
+        assertEquals(chatConfig.getBotUserId(), botUserId);
+    }
+}