diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 97f1413..047a734 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -77,3 +77,35 @@ jobs: with: api-level: ${{ matrix.api-level }} script: ./gradlew connectedCheck + + examples: + runs-on: ubuntu-latest + env: + MOMENTO_API_KEY: ${{ secrets.ALPHA_TEST_AUTH_TOKEN }} + + steps: + - name: Checkout project + uses: actions/checkout@v4 + + - name: Set up JDK 17 + uses: actions/setup-java@v4 + with: + java-version: 17 + distribution: 'corretto' + + - name: Run doc examples + id: validation + run: | + cd examples + ./gradlew docExamples readmeExample cheatSheetExample basic + + - name: Send CI failure mail + if: ${{ steps.validation.outcome == 'failure' }} + uses: momentohq/standards-and-practices/github-actions/error-email-action@gh-actions-v1 + with: + username: ${{secrets.MOMENTO_ROBOT_GMAIL_USERNAME}} + password: ${{secrets.MOMENTO_ROBOT_GMAIL_PASSWORD}} + + - name: Flag Job Failure + if: ${{ steps.validation.outcome == 'failure' }} + run: exit 1 diff --git a/.github/workflows/on-push-to-main-branch.yml b/.github/workflows/on-push-to-main-branch.yml index 019ad1b..8c98d49 100644 --- a/.github/workflows/on-push-to-main-branch.yml +++ b/.github/workflows/on-push-to-main-branch.yml @@ -16,8 +16,8 @@ jobs: - name: Generate README uses: momentohq/standards-and-practices/github-actions/generate-and-commit-oss-readme@gh-actions-v2 with: - project_status: incubating - project_stability: alpha + project_status: official + project_stability: beta project_type: sdk sdk_language: Kotlin dev_docs_slug: kotlin diff --git a/README.template.md b/README.template.md index d77ca0c..eb3284e 100644 --- a/README.template.md +++ b/README.template.md @@ -2,33 +2,23 @@ ## Packages -The Kotlin SDK is available on the Sonatype Central snapshots repo: +The Kotlin SDK is available on Maven Central: ### Gradle ```kotlin -repositories { - maven("https://s01.oss.sonatype.org/content/repositories/snapshots/") -} - dependencies { - implementation("software.momento.kotlin:sdk:0.1.0-SNAPSHOT") + implementation("software.momento.kotlin:sdk:0.1.3") } ``` ### Maven ```xml - - sonatype-snapshots - Sonatype Snapshots - https://s01.oss.sonatype.org/content/repositories/snapshots/ - - software.momento.kotlin sdk - 0.1.0-SNAPSHOT + 0.1.3 ``` diff --git a/examples/.gitignore b/examples/.gitignore new file mode 100644 index 0000000..b63da45 --- /dev/null +++ b/examples/.gitignore @@ -0,0 +1,42 @@ +.gradle +build/ +!gradle/wrapper/gradle-wrapper.jar +!**/src/main/**/build/ +!**/src/test/**/build/ + +### IntelliJ IDEA ### +.idea/modules.xml +.idea/jarRepositories.xml +.idea/compiler.xml +.idea/libraries/ +*.iws +*.iml +*.ipr +out/ +!**/src/main/**/out/ +!**/src/test/**/out/ + +### Eclipse ### +.apt_generated +.classpath +.factorypath +.project +.settings +.springBeans +.sts4-cache +bin/ +!**/src/main/**/bin/ +!**/src/test/**/bin/ + +### NetBeans ### +/nbproject/private/ +/nbbuild/ +/dist/ +/nbdist/ +/.nb-gradle/ + +### VS Code ### +.vscode/ + +### Mac OS ### +.DS_Store \ No newline at end of file diff --git a/examples/README.md b/examples/README.md new file mode 100644 index 0000000..776ede0 --- /dev/null +++ b/examples/README.md @@ -0,0 +1,15 @@ +# Kotlin Client SDK + +
+ +## Running the Examples + +- You do not need gradle to be installed +- JDK 11 or above is required to run the example +- To get started with Momento you will need a Momento API key. You can get one from the + [Momento Console](https://console.gomomento.com). + +### Basic +```bash +MOMENTO_API_KEY= ./gradlew basic +``` diff --git a/examples/build.gradle.kts b/examples/build.gradle.kts new file mode 100644 index 0000000..9595d53 --- /dev/null +++ b/examples/build.gradle.kts @@ -0,0 +1,43 @@ +plugins { + kotlin("jvm") version "1.9.22" +} + +group = "software.momento.kotlin" +version = "1.0-SNAPSHOT" + +repositories { + mavenCentral() +} + +dependencies { + implementation("software.momento.kotlin:sdk:0.1.3") + implementation("org.jetbrains.kotlinx:kotlinx-coroutines-core:1.7.3") +} + +kotlin { + jvmToolchain(8) +} + +tasks.register("basic") { + description = "Run the basic example" + classpath = sourceSets["main"].runtimeClasspath + mainClass = "software.momento.example.BasicExampleKt" +} + +tasks.register("docExamples") { + description = "Run the doc examples" + classpath = sourceSets["main"].runtimeClasspath + mainClass = "software.momento.example.doc_examples.DocExamplesKt" +} + +tasks.register("readmeExample") { + description = "Run the readme example" + classpath = sourceSets["main"].runtimeClasspath + mainClass = "software.momento.example.doc_examples.ReadmeExampleKt" +} + +tasks.register("cheatSheetExample") { + description = "Run the cheat sheet example" + classpath = sourceSets["main"].runtimeClasspath + mainClass = "software.momento.example.doc_examples.CheatSheetKt" +} diff --git a/examples/gradle.properties b/examples/gradle.properties new file mode 100644 index 0000000..7fc6f1f --- /dev/null +++ b/examples/gradle.properties @@ -0,0 +1 @@ +kotlin.code.style=official diff --git a/examples/gradle/wrapper/gradle-wrapper.jar b/examples/gradle/wrapper/gradle-wrapper.jar new file mode 100644 index 0000000..249e583 Binary files /dev/null and b/examples/gradle/wrapper/gradle-wrapper.jar differ diff --git a/examples/gradle/wrapper/gradle-wrapper.properties b/examples/gradle/wrapper/gradle-wrapper.properties new file mode 100644 index 0000000..06febab --- /dev/null +++ b/examples/gradle/wrapper/gradle-wrapper.properties @@ -0,0 +1,5 @@ +distributionBase=GRADLE_USER_HOME +distributionPath=wrapper/dists +distributionUrl=https\://services.gradle.org/distributions/gradle-8.2-bin.zip +zipStoreBase=GRADLE_USER_HOME +zipStorePath=wrapper/dists \ No newline at end of file diff --git a/examples/gradlew b/examples/gradlew new file mode 100755 index 0000000..1b6c787 --- /dev/null +++ b/examples/gradlew @@ -0,0 +1,234 @@ +#!/bin/sh + +# +# Copyright © 2015-2021 the original authors. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# + +############################################################################## +# +# Gradle start up script for POSIX generated by Gradle. +# +# Important for running: +# +# (1) You need a POSIX-compliant shell to run this script. If your /bin/sh is +# noncompliant, but you have some other compliant shell such as ksh or +# bash, then to run this script, type that shell name before the whole +# command line, like: +# +# ksh Gradle +# +# Busybox and similar reduced shells will NOT work, because this script +# requires all of these POSIX shell features: +# * functions; +# * expansions «$var», «${var}», «${var:-default}», «${var+SET}», +# «${var#prefix}», «${var%suffix}», and «$( cmd )»; +# * compound commands having a testable exit status, especially «case»; +# * various built-in commands including «command», «set», and «ulimit». +# +# Important for patching: +# +# (2) This script targets any POSIX shell, so it avoids extensions provided +# by Bash, Ksh, etc; in particular arrays are avoided. +# +# The "traditional" practice of packing multiple parameters into a +# space-separated string is a well documented source of bugs and security +# problems, so this is (mostly) avoided, by progressively accumulating +# options in "$@", and eventually passing that to Java. +# +# Where the inherited environment variables (DEFAULT_JVM_OPTS, JAVA_OPTS, +# and GRADLE_OPTS) rely on word-splitting, this is performed explicitly; +# see the in-line comments for details. +# +# There are tweaks for specific operating systems such as AIX, CygWin, +# Darwin, MinGW, and NonStop. +# +# (3) This script is generated from the Groovy template +# https://github.com/gradle/gradle/blob/master/subprojects/plugins/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt +# within the Gradle project. +# +# You can find Gradle at https://github.com/gradle/gradle/. +# +############################################################################## + +# Attempt to set APP_HOME + +# Resolve links: $0 may be a link +app_path=$0 + +# Need this for daisy-chained symlinks. +while + APP_HOME=${app_path%"${app_path##*/}"} # leaves a trailing /; empty if no leading path + [ -h "$app_path" ] +do + ls=$( ls -ld "$app_path" ) + link=${ls#*' -> '} + case $link in #( + /*) app_path=$link ;; #( + *) app_path=$APP_HOME$link ;; + esac +done + +APP_HOME=$( cd "${APP_HOME:-./}" && pwd -P ) || exit + +APP_NAME="Gradle" +APP_BASE_NAME=${0##*/} + +# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"' + +# Use the maximum available, or set MAX_FD != -1 to use that value. +MAX_FD=maximum + +warn () { + echo "$*" +} >&2 + +die () { + echo + echo "$*" + echo + exit 1 +} >&2 + +# OS specific support (must be 'true' or 'false'). +cygwin=false +msys=false +darwin=false +nonstop=false +case "$( uname )" in #( + CYGWIN* ) cygwin=true ;; #( + Darwin* ) darwin=true ;; #( + MSYS* | MINGW* ) msys=true ;; #( + NONSTOP* ) nonstop=true ;; +esac + +CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar + + +# Determine the Java command to use to start the JVM. +if [ -n "$JAVA_HOME" ] ; then + if [ -x "$JAVA_HOME/jre/sh/java" ] ; then + # IBM's JDK on AIX uses strange locations for the executables + JAVACMD=$JAVA_HOME/jre/sh/java + else + JAVACMD=$JAVA_HOME/bin/java + fi + if [ ! -x "$JAVACMD" ] ; then + die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." + fi +else + JAVACMD=java + which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." +fi + +# Increase the maximum file descriptors if we can. +if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then + case $MAX_FD in #( + max*) + MAX_FD=$( ulimit -H -n ) || + warn "Could not query maximum file descriptor limit" + esac + case $MAX_FD in #( + '' | soft) :;; #( + *) + ulimit -n "$MAX_FD" || + warn "Could not set maximum file descriptor limit to $MAX_FD" + esac +fi + +# Collect all arguments for the java command, stacking in reverse order: +# * args from the command line +# * the main class name +# * -classpath +# * -D...appname settings +# * --module-path (only if needed) +# * DEFAULT_JVM_OPTS, JAVA_OPTS, and GRADLE_OPTS environment variables. + +# For Cygwin or MSYS, switch paths to Windows format before running java +if "$cygwin" || "$msys" ; then + APP_HOME=$( cygpath --path --mixed "$APP_HOME" ) + CLASSPATH=$( cygpath --path --mixed "$CLASSPATH" ) + + JAVACMD=$( cygpath --unix "$JAVACMD" ) + + # Now convert the arguments - kludge to limit ourselves to /bin/sh + for arg do + if + case $arg in #( + -*) false ;; # don't mess with options #( + /?*) t=${arg#/} t=/${t%%/*} # looks like a POSIX filepath + [ -e "$t" ] ;; #( + *) false ;; + esac + then + arg=$( cygpath --path --ignore --mixed "$arg" ) + fi + # Roll the args list around exactly as many times as the number of + # args, so each arg winds up back in the position where it started, but + # possibly modified. + # + # NB: a `for` loop captures its iteration list before it begins, so + # changing the positional parameters here affects neither the number of + # iterations, nor the values presented in `arg`. + shift # remove old arg + set -- "$@" "$arg" # push replacement arg + done +fi + +# Collect all arguments for the java command; +# * $DEFAULT_JVM_OPTS, $JAVA_OPTS, and $GRADLE_OPTS can contain fragments of +# shell script including quotes and variable substitutions, so put them in +# double quotes to make sure that they get re-expanded; and +# * put everything else in single quotes, so that it's not re-expanded. + +set -- \ + "-Dorg.gradle.appname=$APP_BASE_NAME" \ + -classpath "$CLASSPATH" \ + org.gradle.wrapper.GradleWrapperMain \ + "$@" + +# Use "xargs" to parse quoted args. +# +# With -n1 it outputs one arg per line, with the quotes and backslashes removed. +# +# In Bash we could simply go: +# +# readarray ARGS < <( xargs -n1 <<<"$var" ) && +# set -- "${ARGS[@]}" "$@" +# +# but POSIX shell has neither arrays nor command substitution, so instead we +# post-process each arg (as a line of input to sed) to backslash-escape any +# character that might be a shell metacharacter, then use eval to reverse +# that process (while maintaining the separation between arguments), and wrap +# the whole thing up as a single "set" statement. +# +# This will of course break if any of these variables contains a newline or +# an unmatched quote. +# + +eval "set -- $( + printf '%s\n' "$DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS" | + xargs -n1 | + sed ' s~[^-[:alnum:]+,./:=@_]~\\&~g; ' | + tr '\n' ' ' + )" '"$@"' + +exec "$JAVACMD" "$@" diff --git a/examples/gradlew.bat b/examples/gradlew.bat new file mode 100644 index 0000000..107acd3 --- /dev/null +++ b/examples/gradlew.bat @@ -0,0 +1,89 @@ +@rem +@rem Copyright 2015 the original author or authors. +@rem +@rem Licensed under the Apache License, Version 2.0 (the "License"); +@rem you may not use this file except in compliance with the License. +@rem You may obtain a copy of the License at +@rem +@rem https://www.apache.org/licenses/LICENSE-2.0 +@rem +@rem Unless required by applicable law or agreed to in writing, software +@rem distributed under the License is distributed on an "AS IS" BASIS, +@rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +@rem See the License for the specific language governing permissions and +@rem limitations under the License. +@rem + +@if "%DEBUG%" == "" @echo off +@rem ########################################################################## +@rem +@rem Gradle startup script for Windows +@rem +@rem ########################################################################## + +@rem Set local scope for the variables with windows NT shell +if "%OS%"=="Windows_NT" setlocal + +set DIRNAME=%~dp0 +if "%DIRNAME%" == "" set DIRNAME=. +set APP_BASE_NAME=%~n0 +set APP_HOME=%DIRNAME% + +@rem Resolve any "." and ".." in APP_HOME to make it shorter. +for %%i in ("%APP_HOME%") do set APP_HOME=%%~fi + +@rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m" + +@rem Find java.exe +if defined JAVA_HOME goto findJavaFromJavaHome + +set JAVA_EXE=java.exe +%JAVA_EXE% -version >NUL 2>&1 +if "%ERRORLEVEL%" == "0" goto execute + +echo. +echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. +echo. +echo Please set the JAVA_HOME variable in your environment to match the +echo location of your Java installation. + +goto fail + +:findJavaFromJavaHome +set JAVA_HOME=%JAVA_HOME:"=% +set JAVA_EXE=%JAVA_HOME%/bin/java.exe + +if exist "%JAVA_EXE%" goto execute + +echo. +echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% +echo. +echo Please set the JAVA_HOME variable in your environment to match the +echo location of your Java installation. + +goto fail + +:execute +@rem Setup the command line + +set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar + + +@rem Execute Gradle +"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %* + +:end +@rem End local scope for the variables with windows NT shell +if "%ERRORLEVEL%"=="0" goto mainEnd + +:fail +rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of +rem the _cmd.exe /c_ return code! +if not "" == "%GRADLE_EXIT_CONSOLE%" exit 1 +exit /b 1 + +:mainEnd +if "%OS%"=="Windows_NT" endlocal + +:omega diff --git a/examples/settings.gradle.kts b/examples/settings.gradle.kts new file mode 100644 index 0000000..26d28d7 --- /dev/null +++ b/examples/settings.gradle.kts @@ -0,0 +1,12 @@ +pluginManagement { + repositories { + mavenCentral() + gradlePluginPortal() + } +} + +plugins { + id("org.gradle.toolchains.foojay-resolver-convention") version "0.5.0" +} + +rootProject.name = "examples" \ No newline at end of file diff --git a/examples/src/main/kotlin/software/momento/example/BasicExample.kt b/examples/src/main/kotlin/software/momento/example/BasicExample.kt new file mode 100644 index 0000000..9bc358a --- /dev/null +++ b/examples/src/main/kotlin/software/momento/example/BasicExample.kt @@ -0,0 +1,72 @@ +package software.momento.example + +import kotlinx.coroutines.runBlocking +import software.momento.kotlin.sdk.CacheClient +import software.momento.kotlin.sdk.auth.CredentialProvider +import software.momento.kotlin.sdk.config.Configurations +import software.momento.kotlin.sdk.responses.cache.GetResponse +import software.momento.kotlin.sdk.responses.cache.control.CacheCreateResponse +import software.momento.kotlin.sdk.responses.cache.control.CacheListResponse +import kotlin.time.Duration.Companion.seconds + + +private val cacheName = "cache" +private val key = "key" +private val value = "value" + +fun main() = runBlocking { + printStartBanner() + + CacheClient( + CredentialProvider.fromEnvVar("MOMENTO_API_KEY"), Configurations.Laptop.latest, 60.seconds + ).use { client -> + println("Creating cache '$cacheName'") + when (val response = client.createCache(cacheName)) { + is CacheCreateResponse.Success -> println("Cache '$cacheName' created") + is CacheCreateResponse.AlreadyExists -> println("Cache '$cacheName' already exists") + is CacheCreateResponse.Error -> { + println("An error occurred while attempting to create cache 'test-cache': ${response.errorCode}") + println(response.message) + } + } + + println("Listing caches:") + when (val response: CacheListResponse = client.listCaches()) { + is CacheListResponse.Success -> { + val caches: String = response.caches.joinToString("\n") { cacheInfo -> cacheInfo.name } + println(caches) + } + + is CacheListResponse.Error -> { + println("An error occurred while attempting to list caches: ${response.errorCode}") + println(response.message) + } + } + + println("setting key '$key', value '$value'") + client.set(cacheName, key, value) + + println("getting value for key '$key'") + when (val response = client.get(cacheName, key)) { + is GetResponse.Hit -> println("Hit: ${response.value}") + is GetResponse.Miss -> println("Miss") + is GetResponse.Error -> { + println("An error occurred while attempting to get '$key': ${response.errorCode}") + println(response.message) + } + } + } + printEndBanner() +} + +private fun printStartBanner() { + println("******************************************************************") + println("Basic Example Start") + println("******************************************************************") +} + +private fun printEndBanner() { + println("******************************************************************") + println("Basic Example End") + println("******************************************************************") +} diff --git a/examples/src/main/kotlin/software/momento/example/doc_examples/CheatSheet.kt b/examples/src/main/kotlin/software/momento/example/doc_examples/CheatSheet.kt new file mode 100644 index 0000000..a210270 --- /dev/null +++ b/examples/src/main/kotlin/software/momento/example/doc_examples/CheatSheet.kt @@ -0,0 +1,18 @@ +package software.momento.example.doc_examples + +import kotlinx.coroutines.runBlocking +import software.momento.kotlin.sdk.CacheClient +import software.momento.kotlin.sdk.auth.CredentialProvider +import software.momento.kotlin.sdk.config.Configurations +import software.momento.kotlin.sdk.responses.cache.GetResponse +import kotlin.time.Duration.Companion.seconds + +fun main() = runBlocking { + CacheClient( + CredentialProvider.fromEnvVar("MOMENTO_API_KEY"), + Configurations.Laptop.latest, + 60.seconds + ).use { client -> + //... + } +} diff --git a/examples/src/main/kotlin/software/momento/example/doc_examples/DocExamples.kt b/examples/src/main/kotlin/software/momento/example/doc_examples/DocExamples.kt new file mode 100644 index 0000000..55fe944 --- /dev/null +++ b/examples/src/main/kotlin/software/momento/example/doc_examples/DocExamples.kt @@ -0,0 +1,230 @@ +package software.momento.example.doc_examples + +import kotlinx.coroutines.coroutineScope +import kotlinx.coroutines.launch +import kotlinx.coroutines.runBlocking +import kotlinx.coroutines.withTimeoutOrNull +import software.momento.kotlin.sdk.CacheClient +import software.momento.kotlin.sdk.TopicClient +import software.momento.kotlin.sdk.auth.CredentialProvider +import software.momento.kotlin.sdk.config.Configurations +import software.momento.kotlin.sdk.config.TopicConfigurations +import software.momento.kotlin.sdk.responses.cache.DeleteResponse +import software.momento.kotlin.sdk.responses.cache.GetResponse +import software.momento.kotlin.sdk.responses.cache.SetResponse +import software.momento.kotlin.sdk.responses.cache.control.CacheCreateResponse +import software.momento.kotlin.sdk.responses.cache.control.CacheDeleteResponse +import software.momento.kotlin.sdk.responses.cache.control.CacheListResponse +import software.momento.kotlin.sdk.responses.topic.TopicMessage +import software.momento.kotlin.sdk.responses.topic.TopicPublishResponse +import software.momento.kotlin.sdk.responses.topic.TopicSubscribeResponse +import kotlin.time.Duration.Companion.seconds + +const val FAKE_V1_API_KEY = + "eyJhcGlfa2V5IjogImV5SjBlWEFpT2lKS1YxUWlMQ0poYkdjaU9pSklVekkxTmlKOS5leUpwYzNNaU9pSlBibXhwYm1VZ1NsZFVJRUoxYVd4a1pY" + + "SWlMQ0pwWVhRaU9qRTJOemd6TURVNE1USXNJbVY0Y0NJNk5EZzJOVFV4TlRReE1pd2lZWFZrSWpvaUlpd2ljM1ZpSWpvaWFuSnZZMnRs" + + "ZEVCbGVHRnRjR3hsTG1OdmJTSjkuOEl5OHE4NExzci1EM1lDb19IUDRkLXhqSGRUOFVDSXV2QVljeGhGTXl6OCIsICJlbmRwb2ludCI6" + + "ICJ0ZXN0Lm1vbWVudG9ocS5jb20ifQo=" + +suspend fun retrieveAuthTokenFromYourSecretsManager(): String { + return FAKE_V1_API_KEY +} + +suspend fun example_API_CredentialProviderFromEnvVar() { + CredentialProvider.fromEnvVar("MOMENTO_API_KEY") +} + +suspend fun example_API_CredentialProviderFromString() { + val authToken = retrieveAuthTokenFromYourSecretsManager() + CredentialProvider.fromString(authToken) +} + +suspend fun example_API_ConfigurationLaptop() { + Configurations.Laptop.latest +} + +suspend fun example_API_ConfigurationInRegionLatest() { + Configurations.InRegion.latest +} + +suspend fun example_API_ConfigurationLowLatency() { + Configurations.InRegion.LowLatency.latest +} + +suspend fun example_API_InstantiateCacheClient() { + CacheClient( + CredentialProvider.fromEnvVar("MOMENTO_API_KEY"), Configurations.Laptop.latest, 60.seconds + ).use { cacheClient -> + //... + } +} + +suspend fun example_API_ErrorHandlingHitMiss(cacheClient: CacheClient) { + when (val response = cacheClient.get("test-cache", "test-key")) { + is GetResponse.Hit -> println("Retrieved value for key 'test-key': ${response.value}") + is GetResponse.Miss -> println("Key 'test-key' was not found in cache 'test-cache'") + is GetResponse.Error -> throw RuntimeException( + "An error occurred while attempting to get key 'test-key' from cache 'test-cache': ${response.errorCode}", + response + ) + } +} + +suspend fun example_API_ErrorHandlingSuccess(cacheClient: CacheClient) { + when (val response = cacheClient.set("test-cache", "test-key", "test-value")) { + is SetResponse.Success -> println("Key 'test-key' stored successfully") + is SetResponse.Error -> throw RuntimeException( + "An error occurred while attempting to store key 'test-key' in cache 'test-cache': ${response.errorCode}", + response + ) + } +} + +suspend fun example_API_CreateCache(cacheClient: CacheClient) { + when (val response = cacheClient.createCache("test-cache")) { + is CacheCreateResponse.Success -> println("Cache 'test-cache' created") + is CacheCreateResponse.AlreadyExists -> println("Cache 'test-cache' already exists") + is CacheCreateResponse.Error -> throw RuntimeException( + "An error occurred while attempting to create cache 'test-cache': ${response.errorCode}", response + ) + } +} + +suspend fun example_API_DeleteCache(cacheClient: CacheClient) { + when (val response = cacheClient.deleteCache("test-cache")) { + is CacheDeleteResponse.Success -> println("Cache 'test-cache' deleted") + is CacheDeleteResponse.Error -> throw RuntimeException( + "An error occurred while attempting to delete cache 'test-cache': ${response.errorCode}", response + ) + } +} + +suspend fun example_API_ListCaches(cacheClient: CacheClient) { + when (val response: CacheListResponse = cacheClient.listCaches()) { + is CacheListResponse.Success -> { + val caches: String = response.caches.joinToString("\n") { cacheInfo -> cacheInfo.name } + println("Caches:\n$caches") + } + + is CacheListResponse.Error -> throw RuntimeException( + "An error occurred while attempting to list caches: ${response.errorCode}", response + ) + } +} + +suspend fun example_API_Set(cacheClient: CacheClient) { + when (val response = cacheClient.set("test-cache", "test-key", "test-value")) { + is SetResponse.Success -> println("Key 'test-key' stored successfully") + is SetResponse.Error -> throw RuntimeException( + "An error occurred while attempting to store key 'test-key' in cache 'test-cache': ${response.errorCode}", + response + ) + } +} + +suspend fun example_API_Get(cacheClient: CacheClient) { + when (val response = cacheClient.get("test-cache", "test-key")) { + is GetResponse.Hit -> println("Retrieved value for key 'test-key': ${response.value}") + is GetResponse.Miss -> println("Key 'test-key' was not found in cache 'test-cache'") + is GetResponse.Error -> throw RuntimeException( + "An error occurred while attempting to get key 'test-key' from cache 'test-cache': ${response.errorCode}", + response + ) + } +} + +suspend fun example_API_Delete(cacheClient: CacheClient) { + when (val response = cacheClient.delete("test-cache", "test-key")) { + is DeleteResponse.Success -> println("Key 'test-key' deleted successfully") + is DeleteResponse.Error -> throw RuntimeException( + "An error occurred while attempting to delete key 'test-key' from cache 'test-cache': ${response.errorCode}", + response + ) + } +} + +suspend fun example_API_InstantiateTopicClient() { + TopicClient( + CredentialProvider.fromEnvVar("MOMENTO_API_KEY"), TopicConfigurations.Laptop.latest + ).use { topicClient -> + //... + } +} + +suspend fun example_API_TopicSubscribe(topicClient: TopicClient) { + when (val response = topicClient.subscribe("test-cache", "test-topic")) { + is TopicSubscribeResponse.Subscription -> coroutineScope { + launch { + withTimeoutOrNull(2000) { + response.collect { item -> + when (item) { + is TopicMessage.Text -> println("Received text message: ${item.value}") + is TopicMessage.Binary -> println("Received binary message: ${item.value}") + is TopicMessage.Error -> throw RuntimeException( + "An error occurred reading messages from topic 'test-topic': ${item.errorCode}", item + ) + } + } + } + } + } + + is TopicSubscribeResponse.Error -> throw RuntimeException( + "An error occurred while attempting to subscribe to topic 'test-topic': ${response.errorCode}", response + ) + } +} + +suspend fun example_API_TopicPublish(topicClient: TopicClient) { + when (val response = topicClient.publish("test-cache", "test-topic", "test-message")) { + is TopicPublishResponse.Success -> println("Message published successfully") + is TopicPublishResponse.Error -> throw RuntimeException( + "An error occurred while attempting to publish message to topic 'test-topic': ${response.errorCode}", + response + ) + } +} + +fun main() = runBlocking { + example_API_CredentialProviderFromEnvVar() + example_API_CredentialProviderFromString() + example_API_ConfigurationLaptop() + example_API_ConfigurationInRegionLatest() + example_API_ConfigurationLowLatency() + + example_API_InstantiateCacheClient() + + CacheClient( + CredentialProvider.fromEnvVar("MOMENTO_API_KEY"), Configurations.Laptop.latest, 60.seconds + ).use { cacheClient -> + try { + example_API_ErrorHandlingHitMiss(cacheClient) + } catch (e: Exception) { + println("Hit/Miss error handling succeeded") + println(e.message) + } + try { + example_API_ErrorHandlingSuccess(cacheClient) + } catch (e: Exception) { + println("Success error handling succeeded") + println(e.message) + } + + example_API_CreateCache(cacheClient) + example_API_DeleteCache(cacheClient) + example_API_CreateCache(cacheClient) + example_API_ListCaches(cacheClient) + + example_API_Set(cacheClient) + example_API_Get(cacheClient) + example_API_Delete(cacheClient) + } + + example_API_InstantiateTopicClient() + TopicClient( + CredentialProvider.fromEnvVar("MOMENTO_API_KEY"), TopicConfigurations.Laptop.latest + ).use { topicClient -> + example_API_TopicSubscribe(topicClient) + example_API_TopicPublish(topicClient) + } +}