Merge pull request #16 from icerockdev/task/WD-306

WD-306 Optimize utils with boilerplate

Author: AlexeiiShvedov

README.md

@@ -12,7 +12,7 @@ repositories {
 }
 
 // Append dependency
-implementation("com.icerockdev:web-utils:0.4.0")
+implementation("com.icerockdev:web-utils:0.5.0")
 ````
 
 ## Library usage

sample/src/main/kotlin/com/icerockdev/sample/server.kt

@@ -10,8 +10,8 @@ import com.icerockdev.api.Request
 import com.icerockdev.exception.ForbiddenException
 import com.icerockdev.exception.ServerErrorException
 import com.icerockdev.exception.ValidationException
-import com.icerockdev.util.QueryParser
-import com.icerockdev.util.receiveQuery
+import com.icerockdev.api.request.QueryParser
+import com.icerockdev.api.request.receiveQuery
 import com.icerockdev.webserver.*
 import com.icerockdev.webserver.log.JsonDataLogger
 import com.icerockdev.webserver.log.JsonSecret

web-utils/build.gradle.kts

@@ -13,7 +13,7 @@ apply(plugin = "java")
 apply(plugin = "kotlin")
 
 group = "com.icerockdev"
-version = "0.4.0"
+version = "0.5.0"
 
 val sourcesJar by tasks.registering(Jar::class) {
     classifier = "sources"

web-utils/src/main/kotlin/com/icerockdev/api/request/Pagination.kt

@@ -0,0 +1,28 @@
+/*
+ * Copyright 2020 IceRock MAG Inc. Use of this source code is governed by the Apache 2.0 license.
+ */
+
+package com.icerockdev.api.request
+
+import io.ktor.application.ApplicationCall
+
+class Pagination(
+    val limit: Int = 10,
+    val offset: Int = 0,
+    val sortBy: String = "id",
+    val orderBy: String = "DESC"
+)
+
+fun ApplicationCall.getRequestPagination(
+    limit: Int = 10,
+    offset: Int = 0,
+    sortBy: String = "id",
+    orderBy: String = "DESC"
+): Pagination {
+    return Pagination(
+        limit = this.parameters["limit"]?.toInt() ?: limit,
+        offset = this.parameters["offset"]?.toInt() ?: offset,
+        sortBy = this.parameters["sortBy"] ?: sortBy,
+        orderBy = this.parameters["orderBy"] ?: orderBy
+    )
+}

web-utils/src/main/kotlin/com/icerockdev/api/request/Parameters.kt

@@ -0,0 +1,20 @@
+package com.icerockdev.api.request
+
+import io.ktor.http.Parameters
+
+fun Parameters.parseFilters(): HashMap<String, String> {
+    val parameters = this
+    val filters: HashMap<String, String> = hashMapOf()
+    parameters.entries().forEach {
+        if (it.key.contains("filters.")) {
+            val key = it.key.substringAfter(".").toUpperCase()
+            val value = parameters[it.key]
+
+            if (value != null) {
+                filters[key] = value
+            }
+        }
+    }
+
+    return filters
+}

web-utils/src/main/kotlin/com/icerockdev/util/QueryParser.kt renamed to web-utils/src/main/kotlin/com/icerockdev/api/request/QueryParser.kt

@@ -2,7 +2,7 @@
  * Copyright 2020 IceRock MAG Inc. Use of this source code is governed by the Apache 2.0 license.
  */
 
-package com.icerockdev.util
+package com.icerockdev.api.request
 
 import com.fasterxml.jackson.databind.ObjectMapper
 import com.fasterxml.jackson.module.kotlin.jacksonObjectMapper
@@ -90,4 +90,4 @@ inline fun <reified T> ApplicationCall.receiveQueryOrNull(): T? {
     } catch (e : IllegalArgumentException) {
         null
     }
-}
+}

web-utils/src/main/kotlin/com/icerockdev/util/CheckNetwork.kt

@@ -0,0 +1,30 @@
+package com.icerockdev.util
+
+import org.slf4j.LoggerFactory
+import java.net.InetSocketAddress
+import java.net.Socket
+
+object CheckNetwork {
+    private val logger = LoggerFactory.getLogger(CheckNetwork::class.java)
+
+    fun isTcpPortAvailable(host: String, port: Int, timeoutMs: Int): Boolean {
+        return try {
+            Socket().use { socket ->
+                socket.reuseAddress = true;
+                socket.connect(InetSocketAddress(host, port), timeoutMs)
+            }
+            true
+        } catch (ex: Exception) {
+            false
+        }
+    }
+
+    fun awaitService(host: String, port: Int, checkIntervalMs: Long = 1000L) {
+        logger.info("Await connection. Host: $host, Port: $port")
+        while (!isTcpPortAvailable(host, port, 1000)) {
+            Thread.sleep(checkIntervalMs)
+        }
+        logger.info("Connection ready. Host: $host, Port: $port")
+    }
+}
+

web-utils/src/main/kotlin/com/icerockdev/util/HashUtils.kt

@@ -0,0 +1,45 @@
+package com.icerockdev.util
+
+import org.springframework.security.crypto.bcrypt.BCryptPasswordEncoder
+import java.security.MessageDigest
+
+object HashUtils {
+    fun sha512(input: String) = hashString("SHA-512", input)
+
+    fun sha256(input: String) = hashString("SHA-256", input)
+
+    fun sha1(input: String) = hashString("SHA-1", input)
+
+    fun generatePasswordHash(password: String): String {
+        return BCryptPasswordEncoder().encode(password)
+    }
+
+    fun verifyPassword(password: String, passwordHash: String): Boolean {
+        return BCryptPasswordEncoder().matches(password, passwordHash)
+    }
+
+    fun generateRandomToken(): String {
+        return sha256(System.currentTimeMillis().toString() + generateRandomString(64))
+    }
+
+    fun generateRandomCode(length: Int): String {
+        return (1..length)
+            .map { (0..9).random() }
+            .joinToString("")
+    }
+
+    fun generateRandomString(length: Int): String {
+        val charPool: List<Char> = ('a'..'z') + ('A'..'Z') + ('0'..'9')
+        return (1..length)
+            .map { charPool.random() }
+            .joinToString("")
+    }
+
+
+    private fun hashString(type: String, input: String): String {
+        return MessageDigest
+            .getInstance(type)
+            .digest(input.toByteArray())
+            .fold("", { str, it -> str + "%02x".format(it) })
+    }
+}

web-utils/src/main/kotlin/com/icerockdev/util/Pagination.kt

@@ -4,82 +4,13 @@
 
 package com.icerockdev.util
 
-import io.ktor.application.ApplicationCall
-import io.ktor.http.Parameters
 import org.joda.time.DateTime
-import org.springframework.security.crypto.bcrypt.BCryptPasswordEncoder
 import java.net.URI
-import java.security.MessageDigest
 
 fun String.toURI(): URI = URI.create(this)
 
-fun generatePasswordHash(password: String): String {
-    return BCryptPasswordEncoder().encode(password)
-}
-
-fun verifyPassword(password: String, passwordHash: String): Boolean {
-    return BCryptPasswordEncoder().matches(password, passwordHash)
-}
-
-fun generateConfirmationToken(): String {
-    val bytes = (DateTime.now().millis.toString() + random(64)).toByteArray()
-    val md = MessageDigest.getInstance("SHA-256")
-    val digest = md.digest(bytes)
-    return digest.fold("", { str, it -> str + "%02x".format(it) })
-}
-
-fun generateConfirmationCode(length: Int = 4): String {
-    return random(length)
-}
-
-private fun random(length: Int): String {
-    return (1..length)
-        .map { (0..9).random() }
-        .joinToString("")
-}
-
-fun Parameters.parseFilters(): HashMap<String, String> {
-    val parameters = this
-    val filters: HashMap<String, String> = hashMapOf()
-    parameters.entries().forEach {
-        if (it.key.contains("filters.")) {
-            val key = it.key.substringAfter(".").toUpperCase()
-            val value = parameters[it.key]
-
-            if (value != null) {
-                filters[key] = value
-            }
-        }
-    }
-
-    return filters
-}
-
 fun <E> Iterable<E>.replace(old: E, new: E) = map { if (it == old) new else it }
 
-fun ApplicationCall.getRequestPagination(
-    limit: Int = 10,
-    offset: Int = 0,
-    sortBy: String = "id",
-    orderBy: String = "DESC"
-): Pagination {
-    return Pagination(
-        limit = this.parameters["limit"]?.toInt() ?: limit,
-        offset = this.parameters["offset"]?.toInt() ?: offset,
-        sortBy = this.parameters["sortBy"] ?: sortBy,
-        orderBy = this.parameters["orderBy"] ?: orderBy
-    )
-}
-
-
-fun randomStringGenerator(length: Int): String {
-    val charPool: List<Char> = ('a'..'z') + ('A'..'Z') + ('0'..'9')
-    return (1..length)
-        .map { i -> kotlin.random.Random.nextInt(0, charPool.size) }
-        .map(charPool::get)
-        .joinToString("")
-}
-
 fun getDateTimeString(dateTime: DateTime): String {
     return dateTime.toString("yyyy-MM-dd HH:mm:ss")
 }