Merge pull request capcom6#46 from capcom6/feature/device-info-api

Device information endpoint
runemarcx · Mar 5, 2024 · 94a9a16 · 94a9a16
2 parents ede8f03 + dd1808e
commit 94a9a16
Show file tree

Hide file tree

Showing 3 changed files with 106 additions and 1 deletion.
diff --git a/app/src/main/java/me/capcom/smsgateway/modules/localserver/WebService.kt b/app/src/main/java/me/capcom/smsgateway/modules/localserver/WebService.kt
@@ -34,13 +34,15 @@ import me.capcom.smsgateway.R
 import me.capcom.smsgateway.data.entities.Message
 import me.capcom.smsgateway.domain.MessageState
 import me.capcom.smsgateway.helpers.SettingsHelper
+import me.capcom.smsgateway.modules.localserver.domain.Device
 import me.capcom.smsgateway.modules.localserver.domain.PostMessageRequest
 import me.capcom.smsgateway.modules.localserver.domain.PostMessageResponse
 import me.capcom.smsgateway.modules.messages.MessagesService
 import me.capcom.smsgateway.modules.messages.data.MessageSource
 import me.capcom.smsgateway.modules.messages.data.SendRequest
 import me.capcom.smsgateway.modules.notifications.NotificationsService
 import org.koin.android.ext.android.inject
+import java.util.Date
 import kotlin.concurrent.thread
 
 class WebService : Service() {
@@ -74,6 +76,10 @@ class WebService : Service() {
                     if (me.capcom.smsgateway.BuildConfig.DEBUG) {
                         setPrettyPrinting()
                     }
+                    // ISO_8601
+                    this.setDateFormat(
+                        "yyyy-MM-dd'T'HH:mm:ss.SSSXXX"
+                    )
                 }
             }
             install(StatusPages) {
@@ -99,6 +105,28 @@ class WebService : Service() {
                     get("/") {
                         call.respond(mapOf("status" to "ok", "model" to Build.MODEL))
                     }
+                    route("/device") {
+                        get {
+                            val firstInstallTime = packageManager.getPackageInfo(
+                                packageName,
+                                0
+                            ).firstInstallTime
+                            val deviceName = "${Build.MANUFACTURER}/${Build.PRODUCT}"
+                            val deviceId =
+                                deviceName.hashCode().toULong()
+                                    .toString(16).padStart(16, '0') + firstInstallTime.toULong()
+                                    .toString(16).padStart(16, '0')
+                            val device = Device(
+                                deviceId,
+                                deviceName,
+                                Date(firstInstallTime),
+                                Date(),
+                                Date()
+                            )
+
+                            call.respond(listOf(device))
+                        }
+                    }
                     route("/message") {
                         post {
                             val request = call.receive<PostMessageRequest>()

diff --git a/app/src/main/java/me/capcom/smsgateway/modules/localserver/domain/Device.kt b/app/src/main/java/me/capcom/smsgateway/modules/localserver/domain/Device.kt
@@ -0,0 +1,11 @@
+package me.capcom.smsgateway.modules.localserver.domain
+
+import java.util.Date
+
+data class Device(
+    val id: String,
+    val name: String,
+    val createdAt: Date,
+    val updatedAt: Date,
+    val lastSeen: Date
+)
diff --git a/docs/api/swagger.json b/docs/api/swagger.json
@@ -1,7 +1,7 @@
 {
   "openapi": "3.0.0",
   "info": {
-    "version": "1.5.0",
+    "version": "1.8.0",
     "title": "Android SMS Gateway - Integration API",
     "description": "Provides the ability to send SMS by sending requests directly to the device or through a cloud server.",
     "contact": {
@@ -121,6 +121,43 @@
           }
         ]
       }
+    },
+    "/device": {
+      "get": {
+        "summary": "Get devices",
+        "description": "Returns a list of registered devices in the account",
+        "operationId": "get-device",
+        "responses": {
+          "200": {
+            "description": "OK",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "array",
+                  "items": {
+                    "$ref": "#/components/schemas/Device"
+                  }
+                }
+              }
+            }
+          }
+        },
+        "security": [
+          {
+            "BasicAuth": []
+          }
+        ],
+        "servers": [
+          {
+            "url": "http://device-ip:8080",
+            "description": "Device"
+          },
+          {
+            "url": "https://sms.capcom.me/api/3rdparty/v1",
+            "description": "Cloud"
+          }
+        ]
+      }
     }
   },
   "tags": [
@@ -180,6 +217,35 @@
       }
     },
     "schemas": {
+      "Device": {
+        "type": "object",
+        "title": "Device",
+        "properties": {
+          "id": {
+            "type": "string",
+            "description": "ID"
+          },
+          "name": {
+            "type": "string",
+            "description": "Name"
+          },
+          "createdAt": {
+            "type": "string",
+            "description": "Created at",
+            "format": "date-time"
+          },
+          "updatedAt": {
+            "type": "string",
+            "description": "Updated at",
+            "format": "date-time"
+          },
+          "lastSeen": {
+            "type": "string",
+            "description": "Last seen date",
+            "format": "date-time"
+          }
+        }
+      },
       "Message": {
         "type": "object",
         "title": "Message",