Merged branch master.

Author: sebinside

.gitignore

@@ -33,4 +33,7 @@ project/plugins/project/
 /bin/
 /lib/
 /deploy/
-/wiki/
+/wiki/
+
+# Plugin Data
+data/

build.sbt

@@ -57,6 +57,12 @@ libraryDependencies ++= Seq(
 // Google GSON
 libraryDependencies += "com.google.code.gson" % "gson" % "2.8.5"
 
+// JDA
+resolvers += "jcenter-bintray" at "http://jcenter.bintray.com"
+libraryDependencies += "net.dv8tion" % "JDA" % "4.ALPHA.0_82"
+
+//Serial Communication
+libraryDependencies += "com.fazecast" % "jSerialComm" % "[2.0.0,3.0.0)"
 
 // ---------------------------------------------------------------------------------------------------------------------
 // PLUGIN FRAMEWORK DEFINITIONS

src/main/scala/org/codeoverflow/chatoverflow/configuration/ConfigurationService.scala

@@ -1,6 +1,6 @@
 package org.codeoverflow.chatoverflow.configuration
 
-import java.io.File
+import java.io.{File, PrintWriter}
 
 import org.codeoverflow.chatoverflow.WithLogger
 import org.codeoverflow.chatoverflow.api.io
@@ -10,7 +10,7 @@ import org.codeoverflow.chatoverflow.framework.PluginFramework
 import org.codeoverflow.chatoverflow.instance.PluginInstanceRegistry
 import org.codeoverflow.chatoverflow.registry.TypeRegistry
 
-import scala.xml.{Elem, Node}
+import scala.xml.{Elem, Node, PrettyPrinter}
 
 /**
   * The configuration service provides methods to work with serialized state information.
@@ -153,7 +153,9 @@ class ConfigurationService(val configFilePath: String) extends WithLogger {
     * Saves the xml content to the config xml.
     */
   private def saveXML(xmlContent: Node): Unit = {
-    xml.XML.save(configFilePath, xmlContent)
+    val writer = new PrintWriter(configFilePath)
+    writer.print(new PrettyPrinter(120, 2).format(xmlContent))
+    writer.close()
     logger info "Saved config file."
   }
 

src/main/scala/org/codeoverflow/chatoverflow/connector/Connector.scala

@@ -1,10 +1,12 @@
 package org.codeoverflow.chatoverflow.connector
 
+
 import akka.actor.{Actor, ActorRef, ActorSystem, Props}
 import akka.pattern.ask
 import akka.util.Timeout
 import org.codeoverflow.chatoverflow.WithLogger
 import org.codeoverflow.chatoverflow.configuration.Credentials
+import org.codeoverflow.chatoverflow.connector.actor.ActorMessage
 
 import scala.concurrent.duration._
 import scala.concurrent.{Await, TimeoutException}
@@ -16,7 +18,7 @@ import scala.reflect.ClassTag
   * @param sourceIdentifier the unique source identifier (e.g. a login name), the connector should work with
   */
 abstract class Connector(val sourceIdentifier: String) extends WithLogger {
-  private[this] val actorSystem = ActorSystem(s"${getUniqueTypeString.replace('.', '-')}")
+  private[this] val actorSystem: ActorSystem = ActorSystem(s"${getUniqueTypeString.replace('.', '-')}")
   private val connectorSourceAndType = s"connector '$sourceIdentifier' of type '$getUniqueTypeString'"
   protected var credentials: Option[Credentials] = None
   protected var requiredCredentialKeys: List[String]
@@ -68,8 +70,8 @@ abstract class Connector(val sourceIdentifier: String) extends WithLogger {
 
     // Check if running
     if (running) {
-      logger warn s"Unable to start $connectorSourceAndType. Already running!"
-      false
+      logger info s"Unable to start $connectorSourceAndType. Already running!"
+      true
     } else {
 
       // Check if credentials object exists
@@ -94,6 +96,7 @@ abstract class Connector(val sourceIdentifier: String) extends WithLogger {
 
           if (start()) {
             logger info s"Started $connectorSourceAndType."
+            running = true
             true
           } else {
             logger warn s"Failed starting $connectorSourceAndType."
@@ -149,7 +152,7 @@ abstract class Connector(val sourceIdentifier: String) extends WithLogger {
     * @tparam T result type of the actor answer
     * @return the answer of the actor if he answers in time. else: None
     */
-  def askActor[T](actor: ActorRef, timeOutInSeconds: Int, message: Any): Option[T] = {
+  def askActor[T](actor: ActorRef, timeOutInSeconds: Int, message: ActorMessage): Option[T] = {
     implicit val timeout: Timeout = Timeout(timeOutInSeconds seconds)
     val future = actor ? message
     try {
@@ -167,4 +170,25 @@ abstract class Connector(val sourceIdentifier: String) extends WithLogger {
     */
   protected def createActor[T <: Actor : ClassTag](): ActorRef =
     actorSystem.actorOf(Props(implicitly[ClassTag[T]].runtimeClass))
+
+  implicit def toRichActorRef(actorRef: ActorRef): RichActorRef = new RichActorRef(actorRef)
+
+  class RichActorRef(actorRef: ActorRef) {
+
+    /**
+      * Syntactic sugar for the askActor()-function. Works like this:
+      * <code>anActor.??[String](5) {
+      * // message goes here
+      * }</code>
+      *
+      * @param timeOutInSeconds the timeout to calculate, request, ... for the actor
+      * @param message          some message to pass to the actor. Can be anything.
+      * @tparam T result type of the actor answer
+      * @return the answer of the actor if he answers in time. else: None
+      */
+    def ??[T](timeOutInSeconds: Int)(message: ActorMessage): Option[T] = {
+      askActor[T](actorRef, timeOutInSeconds, message)
+    }
+  }
+
 }

src/main/scala/org/codeoverflow/chatoverflow/connector/actor/ActorMessage.scala

@@ -0,0 +1,3 @@
+package org.codeoverflow.chatoverflow.connector.actor
+
+trait ActorMessage

src/main/scala/org/codeoverflow/chatoverflow/connector/actor/FileSystemActor.scala

@@ -1,9 +1,10 @@
 package org.codeoverflow.chatoverflow.connector.actor
 
-import java.io.PrintWriter
+import java.io.{File, PrintWriter}
 import java.nio.file.Paths
 
 import akka.actor.Actor
+import org.codeoverflow.chatoverflow.connector.actor.FileSystemActor.{CreateDirectory, LoadFile, SaveFile}
 
 import scala.io.Source
 
@@ -12,8 +13,14 @@ import scala.io.Source
   */
 class FileSystemActor extends Actor {
 
-  // TODO: Subject of change?
-  private val resourceFilePath = "src/main/resources"
+  // TODO: Should be an startup option in the CLI
+  private val dataFilePath = "data"
+
+  // Create data folder if non existent
+  private val dataFolder = new File(dataFilePath)
+  if (!dataFolder.exists()) {
+    dataFolder.mkdir()
+  }
 
   /**
     * Receives either LoadFile or SaveFile object, acts accordingly.
@@ -23,19 +30,25 @@ class FileSystemActor extends Actor {
   override def receive: Receive = {
     case LoadFile(pathInResources) =>
       try {
-        sender ! Some(Source.fromFile(s"$resourceFilePath${fixPath(pathInResources)}").mkString)
+        sender ! Some(Source.fromFile(s"$dataFilePath${fixPath(pathInResources)}").mkString)
       } catch {
         case _: Exception => None
       }
     case SaveFile(pathInResources, content) =>
       try {
-        val writer = new PrintWriter(s"$resourceFilePath${fixPath(pathInResources)}")
+        val writer = new PrintWriter(s"$dataFilePath${fixPath(pathInResources)}")
         writer.write(content)
         writer.close()
         sender ! true
       } catch {
         case _: Exception => sender ! false
       }
+    case CreateDirectory(folderName) =>
+      try {
+        sender ! new File(s"$dataFilePath${fixPath(folderName)}").mkdir()
+      } catch {
+        case _: Exception => sender ! false
+      }
   }
 
   private def fixPath(path: String): String = {
@@ -44,17 +57,28 @@ class FileSystemActor extends Actor {
   }
 }
 
-/**
-  * Send a LoadFile-object to the FileSystemActor to load a specific file.
-  *
-  * @param pathInResources the relative Path in the resource folder
-  */
-case class LoadFile(pathInResources: String)
+object FileSystemActor {
 
-/**
-  * Send a SaveFile-object to the FileSystemActor to save a file with given content.
-  *
-  * @param pathInResources the relative Path in the resource folder
-  * @param content         the content to save
-  */
-case class SaveFile(pathInResources: String, content: String)
+  /**
+    * Send a LoadFile-object to the FileSystemActor to load a specific file.
+    *
+    * @param pathInResources the relative Path in the resource folder
+    */
+  case class LoadFile(pathInResources: String) extends ActorMessage
+
+  /**
+    * Send a SaveFile-object to the FileSystemActor to save a file with given content.
+    *
+    * @param pathInResources the relative Path in the resource folder
+    * @param content         the content to save
+    */
+  case class SaveFile(pathInResources: String, content: String) extends ActorMessage
+
+  /**
+    * Send a CreateDirectory-object to the FileSystemActor to create a new sub directory.
+    *
+    * @param folderName the folder name. Note: Parent folder has to exist!
+    */
+  case class CreateDirectory(folderName: String) extends ActorMessage
+
+}

src/main/scala/org/codeoverflow/chatoverflow/connector/actor/HttpActor.scala

@@ -5,6 +5,7 @@ import org.apache.http.client.methods.HttpGet
 import org.apache.http.client.utils.URIBuilder
 import org.apache.http.impl.client.HttpClientBuilder
 import org.apache.http.util.EntityUtils
+import org.codeoverflow.chatoverflow.connector.actor.HttpActor.GetRequest
 
 /**
   * The HttpActor can be used to handle http requests.
@@ -39,13 +40,17 @@ class HttpActor extends Actor {
   }
 }
 
-/**
-  * A get request consists of a URI at least. Http (e.g. header) settings and query parameters are optional.
-  *
-  * @param uri         the web address incl. the protocol you want to request
-  * @param settings    a function manipulating the generated HttpGet-Element, e.g. by adding header-entries
-  * @param queryParams the query params as sequence of key-value-tuple
-  */
-case class GetRequest(uri: String,
-                      settings: HttpGet => HttpGet = httpGet => httpGet,
-                      queryParams: Seq[(String, String)] = Seq[(String, String)]())
+object HttpActor {
+
+  /**
+    * A get request consists of a URI at least. Http (e.g. header) settings and query parameters are optional.
+    *
+    * @param uri         the web address incl. the protocol you want to request
+    * @param settings    a function manipulating the generated HttpGet-Element, e.g. by adding header-entries
+    * @param queryParams the query params as sequence of key-value-tuple
+    */
+  case class GetRequest(uri: String,
+                        settings: HttpGet => HttpGet = httpGet => httpGet,
+                        queryParams: Seq[(String, String)] = Seq[(String, String)]()) extends ActorMessage
+
+}

src/main/scala/org/codeoverflow/chatoverflow/connector/actor/JsonActor.scala

@@ -1,30 +1,38 @@
 package org.codeoverflow.chatoverflow.connector.actor
 
 import akka.actor.Actor
-import com.google.gson.{JsonObject, JsonParser}
+import org.codeoverflow.chatoverflow.connector.actor.JsonActor.ParseJSON
+import org.json4s._
+import org.json4s.jackson.JsonMethods._
 
 /**
-  * The JSON Actor uses Google GSON to parse serialized json and enable traversing.
+  * The JSON Actor uses json4s to parse serialized json and enable traversing.
   */
 class JsonActor extends Actor {
-  val parser = new JsonParser
+
+  // TODO: Implement proper functionality with json4s. This is not more than a proof of concept
+  // TODO: Test, when reflection kicks in to allow the most functionality without an actor call
 
   /**
     * Receives a ParseJSON Object to start parsing.
     *
     * @return the desired values, can be any type
     */
   override def receive: Receive = {
-    case ParseJSON(json, parse) =>
-      val rootObject = parser.parse(json).getAsJsonObject
-      parse(rootObject)
+    case ParseJSON(json, parseMethod) =>
+      val rootObject = parse(json)
+      sender ! parseMethod(rootObject)
   }
 }
 
-/**
-  * Send a ParseJSON-object to start parsing. The traversal is custom.
-  *
-  * @param json  the serialized json string
-  * @param parse a function what should happen with the parsed json. Return type is any
-  */
-case class ParseJSON(json: String, parse: JsonObject => Any)
+object JsonActor {
+
+  /**
+    * Send a ParseJSON-object to start parsing. The traversal is custom.
+    *
+    * @param json        the serialized json string
+    * @param parseMethod a function what should happen with the parsed json. Return type is any
+    */
+  case class ParseJSON(json: String, parseMethod: JValue => Any) extends ActorMessage
+
+}

src/main/scala/org/codeoverflow/chatoverflow/connector/actor/PrivilegedActor.scala

@@ -1,6 +1,7 @@
 package org.codeoverflow.chatoverflow.connector.actor
 
 import akka.actor.Actor
+import org.codeoverflow.chatoverflow.connector.actor.PrivilegedActor.Privileged
 
 /**
   * The privileged actor is the most general idea of an actor to handle privileged actions.
@@ -18,10 +19,14 @@ class PrivilegedActor extends Actor {
   }
 }
 
-/**
-  * Send a Privileged-ojbect to the PrivilegedActor to get the function executed with the given args.
-  *
-  * @param function a function of type T => Any
-  * @param args     the args for the function of type T
-  */
-case class Privileged(function: Any => Any, args: Any)
+object PrivilegedActor {
+
+  /**
+    * Send a Privileged-ojbect to the PrivilegedActor to get the function executed with the given args.
+    *
+    * @param function a function of type T => Any
+    * @param args     the args for the function of type T
+    */
+  case class Privileged(function: Any => Any, args: Any) extends ActorMessage
+
+}