Merge branch 'actor-dev'

Author: sebinside

build.sbt

@@ -53,11 +53,8 @@ libraryDependencies ++= Seq(
   //"com.typesafe.akka" %% "akka-testkit" % "2.5.18" % Test
 )
 
-// Akka Actors
-libraryDependencies ++= Seq(
-  "com.typesafe.akka" %% "akka-actor" % "2.5.18",
-  //"com.typesafe.akka" %% "akka-testkit" % "2.5.18" % Test
-)
+// https://mvnrepository.com/artifact/com.google.code.gson/gson
+libraryDependencies += "com.google.code.gson" % "gson" % "2.8.5"
 
 
 // ---------------------------------------------------------------------------------------------------------------------

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

@@ -1,7 +1,60 @@
 package org.codeoverflow.chatoverflow.connector.actor
 
+import java.io.PrintWriter
+import java.nio.file.Paths
+
 import akka.actor.Actor
 
+import scala.io.Source
+
+/**
+  * The file system actor provides simple utility methods to read and write files.
+  */
 class FileSystemActor extends Actor {
-  override def receive: Receive = ???
+
+  // TODO: Subject of change?
+  private val resourceFilePath = "src/main/resources"
+
+  /**
+    * Receives either LoadFile or SaveFile object, acts accordingly.
+    *
+    * @return a loaded file or a boolean if the saving process was successful
+    */
+  override def receive: Receive = {
+    case LoadFile(pathInResources) =>
+      try {
+        sender ! Some(Source.fromFile(s"$resourceFilePath${fixPath(pathInResources)}").mkString)
+      } catch {
+        case _: Exception => None
+      }
+    case SaveFile(pathInResources, content) =>
+      try {
+        val writer = new PrintWriter(s"$resourceFilePath${fixPath(pathInResources)}")
+        writer.write(content)
+        writer.close()
+        sender ! true
+      } catch {
+        case _: Exception => sender ! false
+      }
+  }
+
+  private def fixPath(path: String): String = {
+    val fixedPath = Paths.get("/", path).normalize()
+    fixedPath.toString
+  }
 }
+
+/**
+  * 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)
+
+/**
+  * 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)

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

@@ -1,7 +1,51 @@
 package org.codeoverflow.chatoverflow.connector.actor
 
 import akka.actor.Actor
+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
 
+/**
+  * The HttpActor can be used to handle http requests.
+  */
 class HttpActor extends Actor {
-  override def receive: Receive = ???
+  private val client = HttpClientBuilder.create.build
+
+  /**
+    * Send a GetRequest-Object to perform a http get request.
+    *
+    * @return the http request answer as some string or none
+    */
+  override def receive: Receive = {
+    case GetRequest(uri, settings, queryParams) =>
+      try {
+        var httpGet = new HttpGet(uri)
+        httpGet = settings(httpGet)
+
+        val urlBuilder = new URIBuilder(httpGet.getURI)
+        queryParams.foreach(param => urlBuilder.addParameter(param._1, param._2))
+        httpGet.setURI(urlBuilder.build())
+
+        val entity = client.execute(httpGet).getEntity
+        if (entity != null) {
+          sender ! Some(EntityUtils.toString(entity, "UTF-8"))
+        } else {
+          sender ! None
+        }
+      } catch {
+        case _: Exception => None
+      }
+  }
 }
+
+/**
+  * 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)]())

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

@@ -1,7 +1,30 @@
 package org.codeoverflow.chatoverflow.connector.actor
 
 import akka.actor.Actor
+import com.google.gson.{JsonObject, JsonParser}
 
+/**
+  * The JSON Actor uses Google GSON to parse serialized json and enable traversing.
+  */
 class JsonActor extends Actor {
-  override def receive: Receive = ???
+  val parser = new JsonParser
+
+  /**
+    * 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)
+  }
 }
+
+/**
+  * 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)

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

@@ -8,12 +8,20 @@ import akka.actor.Actor
   */
 class PrivilegedActor extends Actor {
   /**
-    * Handles any function to call. Takes a tuple of any argument and any function and the arguments to pass.
-    * Example: <code>((aNumber: Int) => s"I got: $aNumber", 42)</code>
+    * Handles any function to call. Takes a Privileged containing any function and the arguments to pass.
+    * Example: <code>Privileged((aNumber: Int) => s"I got: $aNumber", 42)</code>
     *
     * @return the result type of the function, specified in the message. Can be anything.
     */
   override def receive: Receive = {
-    case message: (((Any) => Any), Any) => sender ! message._1(message._2)
+    case Privileged(function, args) => sender ! function(args)
   }
 }
+
+/**
+  * 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)