summary | Various utilities available in the Slate library |
jar | kiit.common.jar |
package | kiit.common.utils |
artifact | dev.kiit:kiit-common |
sources | src/lib/kotlin/slatekit-common/src/main/kotlin/slatekit/common/utils |
example | src/lib/kotlin/slate-examples/src/main/kotlin/slatekit/examples/Example_Utils.kt |
dependency | kiit-results |
Use the following settings in gradle for installing this component.
buildscript {
// Kotlin version currently being used
ext.kotlin_version = '1.8.22'
// Reference version
ext.kiit_version = '3.1.0'
// ...
}
repositories {
// Currently stored in Git Hub Packages.
maven {
url "https://maven.pkg.github.com/slatekit/kiit"
credentials {
username = System.getenv('GIT_PACKAGES_INSTALL_ACTOR')
password = System.getenv('GIT_PACKAGES_INSTALL_TOKEN')
}
}
// ...
}
dependencies {
// Other dependencies ...
implementation "dev.kiit:kiit-common:$kiit_version"
}
// required
import kiit.common.utils.Require.requireOneOf
import kiit.common.utils.Require.requireText
import kiit.common.utils.Require.requireValidIndex
// optional
import kiit.cmds.Command
import kiit.common.data.DbConString
import kiit.common.info.ApiKey
import kiit.common.info.ApiLogin
import kiit.cmds.CommandRequest
import kiit.common.io.Uris
import kiit.results.Try
import kiit.results.Success
n/a
// Miscellaneous utilities.
// CASE 1: Api Credentials
// The ApiCredentials class provides a convenient container for most fields required to
// represent the access credentials some API such as AWS ( Amazon Web Services ) or Azure.
val awsS3 = ApiLogin("aws-s3", "ABCDEFG", "123456", "dev", "user-profile")
val twilio = ApiLogin("1-234-567-8901", "ABCEDEFG", "123456", "dev", "sms")
val sendgrid = ApiLogin("support@mystartup.com", "mystartup", "123456789", "dev", "emails")
// CASE 2: Api Keys
val devKey = ApiKey("dev1", "B8779D64-6104-4244-88B6-F81B4D2AAF5B", "dev", mapOf())
val qaKey = ApiKey("qa1", "F01718FF-0AF5-43C2-84D7-D1E2B4234644", "qa", mapOf())
// CASE 3: Guards ( Exceptions are discouraged in favor
// of functional error handling, however, there are times where
// a guard like approach to inputs is preferable
requireText("slate-kit", "Name must be supplied" )
requireOneOf( "kotlin", listOf("kotlin", "go"), "Name not valid")
requireValidIndex( 3, 4, "Index is must be 0 <= index <= 4")
// CASE 4: Db connection
val db = DbConString("com.mysql.jdbc.Driver", "jdbc:mysql://localhost/app1", "db1", "1245689")
// CASE 5: Interpret URI represetning file locations
// - user dir: user://{folder} ( user home directory for os )
// - temp dir: temp://{folder} ( temp files directory for os )
// - file dir: file://{path} ( absolution file location )
// This yeilds c:/users/{user1}/myapp1
val path1 = Uris.interpret("user://myapp1")
println(path1)