release(1.2.2): Add Author Request Schema

Author: gmitch215

src/main/kotlin/io/codemc/api/database/database.kt

@@ -54,6 +54,8 @@ fun connect(): Database {
     return database
 }
 
+// Users
+
 /**
  * Adds a user to the database.
  * @param username The username of the jenkins user
@@ -134,4 +136,90 @@ fun removeUser(
 fun removeAllUsers() = transaction(database) {
     if (!Users.exists()) return@transaction 0
     Users.deleteAll()
+}
+
+// Requests
+
+/**
+ * Adds a request to the database.
+ * @param messageId The unique ID of the request according to Discord
+ * @param userId The unique ID of the Discord user
+ * @param githubName The GitHub username of the user
+ * @param repoName The name of the repository
+ * @return The result of the `INSERT` statement
+ */
+fun createRequest(
+    messageId: Long,
+    userId: Long,
+    githubName: String,
+    repoName: String
+) = transaction(database) {
+    SchemaUtils.create(Requests)
+
+    return@transaction Requests.insert { row ->
+        row[Requests.messageId] = messageId
+        row[Requests.userId] = userId
+        row[Requests.githubName] = githubName
+        row[Requests.repoName] = repoName
+    }
+}
+
+/**
+ * Gets a [Request] by its unique ID.
+ * @param messageId The unique ID to lookup
+ * @return The request mapped to the unique ID, or `null` if not found
+ */
+fun getRequest(
+    messageId: Long
+): Request? = transaction(database) {
+    if (!Requests.exists()) return@transaction null
+
+    return@transaction Requests.selectAll().where { Requests.messageId eq messageId }
+        .map { row -> Request(row[Requests.messageId], row[Requests.userId], row[Requests.githubName], row[Requests.repoName]) }
+        .firstOrNull()
+}
+
+/**
+ * Checks if a request exists by its unique ID.
+ * @param messageId The unique ID to lookup
+ * @return `true` if the request exists, `false` otherwise
+ */
+fun requestExists(
+    messageId: Long
+): Boolean = transaction(database) {
+    if (!Requests.exists()) return@transaction false
+
+    return@transaction Requests.selectAll().where { Requests.messageId eq messageId }.count() > 0
+}
+
+/**
+ * Gets all requests currently linked in the database.
+ * @return All requests in the database
+ */
+fun getAllRequests(): List<Request> = transaction(database) {
+    if (!Requests.exists()) return@transaction emptyList()
+
+    return@transaction Requests.selectAll()
+        .map { row -> Request(row[Requests.messageId], row[Requests.userId], row[Requests.githubName], row[Requests.repoName]) }
+}
+
+/**
+ * Removes a request from the database.
+ * @param messageId The unique ID of the request to remove
+ * @return `1` if removed, else `0`
+ */
+fun removeRequest(
+    messageId: Long
+) = transaction(database) {
+    if (!Requests.exists()) return@transaction 0
+    return@transaction Requests.deleteWhere { Requests.messageId eq messageId }
+}
+
+/**
+ * Removes all requests from the database.
+ * @return The count of deleted requests
+ */
+fun removeAllRequests() = transaction(database) {
+    if (!Requests.exists()) return@transaction 0
+    return@transaction Requests.deleteAll()
 }

src/main/kotlin/io/codemc/api/database/schema.kt

@@ -30,4 +30,42 @@ object Users : Table() {
 data class User(
     val username: String,
     val discord: Long
+)
+
+/**
+ * Represents the `requests` SQL table.
+ */
+object Requests : Table() {
+    /**
+     * The `message_id` column, representing the unique ID of the request according to Discord.
+     */
+    val messageId: Column<Long> = long("message_id").uniqueIndex()
+    /**
+     * The `user_id` column, representing the unique ID of the Discord user.
+     */
+    val userId: Column<Long> = long("user_id")
+    /**
+     * The `github_name` column, representing the GitHub username of the user.
+     */
+    val githubName: Column<String> = varchar("github_name", 39)
+    /**
+     * The `repo_name` column, representing the name of the repository.
+     */
+    val repoName: Column<String> = varchar("repo_name", 39)
+
+    override val primaryKey = PrimaryKey(messageId)
+}
+
+/**
+ * Represents a request in the database.
+ * @property messageId The unique ID of the request according to Discord.
+ * @property userId The unique ID of the Discord user.
+ * @property githubName The GitHub username of the user.
+ * @property repoName The name of the repository.
+ */
+data class Request(
+    val messageId: Long,
+    val userId: Long,
+    val githubName: String,
+    val repoName: String
 )

src/test/kotlin/io/codemc/api/database/TestDatabase.kt

@@ -88,7 +88,7 @@ class TestDatabase {
     }
 
     @Test
-    fun testAll() {
+    fun testAllUsers() {
         val users = listOf(
             "TestUser",
             "TestUser2",
@@ -106,4 +106,74 @@ class TestDatabase {
         users.forEach { removeUser(it) }
     }
 
+    @Test
+    fun testCreateRequest() {
+        val messageId = 123456789L
+        val userId = 987654321L
+        val githubName = "MyAuthor"
+        val repoName = "MyRepo"
+
+        createRequest(messageId, userId, githubName, repoName)
+
+        val r = getRequest(messageId)
+        assertNotNull(r)
+        assertEquals(userId, r?.userId)
+        assertEquals(githubName, r?.githubName)
+        assertEquals(repoName, r?.repoName)
+
+        removeRequest(messageId)
+    }
+
+    @Test
+    fun testRemoveRequest() {
+        val messageId = 123456789L
+        val userId = 987654321L
+        val githubName = "MyAuthor"
+        val repoName = "MyRepo"
+
+        createRequest(messageId, userId, githubName, repoName)
+        assertNotNull(getRequest(messageId))
+
+        removeRequest(messageId)
+        assertNull(getRequest(messageId))
+    }
+
+    @Test
+    fun testRemoveAllRequests() {
+        val requests = listOf(
+            123456789L,
+            987654321L,
+            123L,
+            456L
+        )
+
+        requests.forEach { createRequest(it, 0L, "Test", "Test") }
+        requests.forEach { assertNotNull(getRequest(it)) }
+
+        removeAllRequests()
+
+        requests.forEach { assertNull(getRequest(it)) }
+    }
+
+    @Test
+    fun testMultipleRequests() {
+        val requests = listOf(
+            123456789L,
+            987654321L,
+            123L,
+            456L
+        )
+
+        requests.forEachIndexed { index, l -> createRequest(l, index.toLong(), "Test", "Test") }
+        requests.forEachIndexed { index, l ->
+            val r = getRequest(l)
+            assertNotNull(r)
+            assertEquals(index.toLong(), r?.userId)
+            assertEquals("Test", r?.githubName)
+            assertEquals("Test", r?.repoName)
+        }
+
+        requests.forEach { removeRequest(it) }
+    }
+
 }