updated readme; added rest_api_server start automation; fixed service name conflict

Author: BlvckBytes

README.md

@@ -33,7 +33,21 @@ To compile, use [compile.sh](socket_server/compile.sh). A named and detached scr
 
 ## Rest-API Server
 
-To be described and implemented.
+Currently available endpoints:
+
+```
+POST /sms
+{
+  "recipient": string,
+  "message": string
+}
+```
+
+```
+GET /health
+```
+
+To compile, use [compile.sh](rest_api_server/compile.sh). A named and detached screen that also logs to a uniquely named file can be created using [start.sh](rest_api_server/start.sh). The [ensure_running.sh](rest_api_server/ensure_running.sh) script checks periodically whether the named screen is up, and if it isn't, it calls said start script. The [ensure_running.service](rest_api_server/ensure_running.service) is a `systemd`-service, which makes sure that [ensure_running.sh](rest_api_server/ensure_running.sh) is up at all times. This service can be installed by making use of [install_service.sh](rest_api_server/install_service.sh).
 
 ## My Setup
 

rest_api_server/.gitignore

@@ -0,0 +1 @@
+server.jar

rest_api_server/compile.sh

@@ -0,0 +1,5 @@
+#!/bin/bash
+cd sim-modem-api
+./gradlew bootJar
+cp build/libs/*.jar ../server.jar
+cd ..

rest_api_server/ensure_running.service

@@ -0,0 +1,11 @@
+[Unit]
+Description=Infinite loop rest_api_server screen watcher
+
+[Service]
+User=blvckbytes
+Type=simple
+ExecStart=/home/blvckbytes/sim-modem-api/rest_api_server/ensure_running.sh
+Restart=always
+
+[Install]
+WantedBy=default.target

rest_api_server/ensure_running.sh

@@ -0,0 +1,15 @@
+#!/bin/bash
+while true
+do
+  /usr/bin/screen -S sim_modem_rest_api_server -Q select . 2>&1 > /dev/null
+
+  # Non-zero exit code means that there was no such screen
+  if [[ "`echo $?`" != "0" ]]
+  then
+    /home/blvckbytes/sim-modem-api/rest_api_server/start.sh
+    echo "Started rest api server"
+  fi
+
+  echo sleeping
+  sleep 5
+done

rest_api_server/install_service.sh

@@ -0,0 +1,4 @@
+#!/bin/bash
+sudo cp ensure_running.service /etc/systemd/system/rest_api_server_ensure_running.service
+sudo systemctl enable rest_api_server_ensure_running.service
+sudo systemctl start rest_api_server_ensure_running.service

rest_api_server/sim-modem-api/src/main/kotlin/me/blvckbytes/simmodemapi/rest/SimModemCommandDto.kt

@@ -1,21 +1,19 @@
 package me.blvckbytes.simmodemapi.rest
 
-import com.fasterxml.jackson.annotation.JsonFormat
 import me.blvckbytes.simmodemapi.modem.SimModemResponse
 import java.time.LocalDateTime
 
 class SimModemCommandDto(
   val command: String,
   val response: String,
   val timeoutMs: Int,
-//  @field:JsonFormat(pattern="yyyy-MM-dd HH:mm:ss")
   val commandSentStamp: LocalDateTime,
-//  @field:JsonFormat(pattern="yyyy-MM-dd HH:mm:ss")
   val responseReceivedStamp: LocalDateTime
 ) {
   companion object {
     fun fromModel(model: SimModemResponse, commandGenerator: CommandGeneratorPort): SimModemCommandDto {
       return SimModemCommandDto(
+        // TODO: Also substitute non printable characters
         commandGenerator.trimControlCharacters(model.command.command),
         commandGenerator.trimControlCharacters(model.content),
         model.command.timeoutMs,

rest_api_server/sim-modem-api/src/main/resources/application.properties

@@ -2,3 +2,4 @@ socket-server.host=192.168.1.49
 socket-server.port=8080
 socket-server.heartbeat-period-ms=2000
 socket-server.heartbeat-sentinel=<heartbeat>
+server.port=8090

rest_api_server/start.sh

@@ -0,0 +1,3 @@
+#!/bin/bash
+basepath=/home/blvckbytes/sim-modem-api/rest_api_server
+/usr/bin/screen -m -d -S sim_modem_rest_api_server -L -Logfile $basepath/`date +"%Y-%m-%d-%H-%M-%S-%N"`.txt java -jar $basepath/server.jar

socket_server/install_service.sh

@@ -1,4 +1,4 @@
 #!/bin/bash
-sudo cp ensure_running.service /etc/systemd/system/
-sudo systemctl enable ensure_running.service
-sudo systemctl start ensure_running.service
+sudo cp ensure_running.service /etc/systemd/system/socket_server_ensure_running.service
+sudo systemctl enable socket_server_ensure_running.service
+sudo systemctl start socket_server_ensure_running.service