NickKalar/LMS-APIs
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Initial files and some experimenting

Browse Source
This commit is contained in:
Nick Kalar
2025-07-29 20:52:21 -04:00
parent dffb2efeed
commit 954dc97dbd
29 changed files with 1057 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

43
.gitignore vendored
View File

@@ -24,4 +24,45 @@ hs_err_pid*
replay_pid* replay_pid*
# Kotlin Gradle plugin data, see https://kotlinlang.org/docs/whatsnew20.html#new-directory-for-kotlin-data-in-gradle-projects # Kotlin Gradle plugin data, see https://kotlinlang.org/docs/whatsnew20.html#new-directory-for-kotlin-data-in-gradle-projects
.kotlin/ .kotlin/
.gradle
build/
!gradle/wrapper/gradle-wrapper.jar
!**/src/main/**/build/
!**/src/test/**/build/
### STS ###
.apt_generated
.classpath
.factorypath
.project
.settings
.springBeans
.sts4-cache
bin/
!**/src/main/**/bin/
!**/src/test/**/bin/
### IntelliJ IDEA ###
.idea
*.iws
*.iml
*.ipr
out/
!**/src/main/**/out/
!**/src/test/**/out/
### NetBeans ###
/nbproject/private/
/nbbuild/
/dist/
/nbdist/
/.nb-gradle/
### VS Code ###
.vscode/
### Secrets ###
local.properties
application.yaml

61
README.md
View File

@@ -1,2 +1,61 @@
# LMS-APIs # LMS-APIs
CRUD APIs used to interface between the frontend web applications and all backend services
This project was created using the [Ktor Project Generator](https://start.ktor.io).
Here are some useful links to get you started:
- [Ktor Documentation](https://ktor.io/docs/home.html)
- [Ktor GitHub page](https://github.com/ktorio/ktor)
- The [Ktor Slack chat](https://app.slack.com/client/T09229ZC6/C0A974TJ9). You'll need
to [request an invite](https://surveys.jetbrains.com/s3/kotlin-slack-sign-up) to join.
## Features
Here's a list of features included in this project:
| Name | Description |
|------------------------------------------------------------------------|------------------------------------------------------------------------------------|
| [Default Headers](https://start.ktor.io/p/default-headers) | Adds a default set of headers to HTTP responses |
| [Routing](https://start.ktor.io/p/routing) | Provides a structured routing DSL |
| [Swagger](https://start.ktor.io/p/swagger) | Serves Swagger UI for your project |
| [Authentication](https://start.ktor.io/p/auth) | Provides extension point for handling the Authorization header |
| [Authentication JWT](https://start.ktor.io/p/auth-jwt) | Handles JSON Web Token (JWT) bearer authentication scheme |
| [Content Negotiation](https://start.ktor.io/p/content-negotiation) | Provides automatic content conversion according to Content-Type and Accept headers |
| [kotlinx.serialization](https://start.ktor.io/p/kotlinx-serialization) | Handles JSON serialization using kotlinx.serialization library |
| [Postgres](https://start.ktor.io/p/postgres) | Adds Postgres database to your application |
## Required Files
### src/main/resources/application.yaml
Required fields:
ktor:
application:
modules:
-codes.kalar.ApplicationKt.module
deployment:
port: 8080
postgres:
url: "jdbc:postgresql://<url to database>"
user: <username>
password: <password>
## Building & Running
To build or run the project, use one of the following tasks:
| Task | Description |
|-------------------------------|----------------------------------------------------------------------|
| `./gradlew test` | Run the tests |
| `./gradlew build` | Build everything |
| `buildFatJar` | Build an executable JAR of the server with all dependencies included |
| `buildImage` | Build the docker image to use with the fat JAR |
| `publishImageToLocalRegistry` | Publish the docker image locally |
| `run` | Run the server |
| `runDocker` | Run using the local docker image |
If the server starts successfully, you'll see the following output:
```
2024-12-04 14:32:45.584 [main] INFO Application - Application started in 0.303 seconds.
2024-12-04 14:32:45.682 [main] INFO Application - Responding at http://0.0.0.0:8080
```

41
build.gradle.kts Normal file
View File

@@ -0,0 +1,41 @@
val h2_version: String by project
val kotlin_version: String by project
val logback_version: String by project
val postgres_version: String by project
plugins {
kotlin("jvm") version "2.1.10"
id("io.ktor.plugin") version "3.2.2"
id("org.jetbrains.kotlin.plugin.serialization") version "2.1.10"
}
group = "codes.kalar"
version = "0.0.1"
application {
mainClass = "io.ktor.server.netty.EngineMain"
}
repositories {
mavenCentral()
}
dependencies {
implementation("io.ktor:ktor-server-default-headers")
implementation("io.ktor:ktor-server-core")
implementation("io.ktor:ktor-server-swagger")
implementation("io.ktor:ktor-server-auth")
implementation("io.ktor:ktor-server-auth-jwt")
implementation("io.ktor:ktor-server-content-negotiation")
implementation("io.ktor:ktor-serialization-kotlinx-json")
implementation("org.postgresql:postgresql:$postgres_version")
implementation("com.h2database:h2:$h2_version")
implementation("io.ktor:ktor-server-netty")
implementation("ch.qos.logback:logback-classic:$logback_version")
implementation("io.ktor:ktor-server-config-yaml")
implementation("com.google.cloud:google-cloud-secretmanager:2.68.0")
testImplementation("io.ktor:ktor-server-test-host")
testImplementation("org.jetbrains.kotlin:kotlin-test-junit:$kotlin_version")
}

7
gradle.properties Normal file
View File

@@ -0,0 +1,7 @@
kotlin.code.style=official
h2_version=2.3.232
kotlin_version=2.1.10
ktor_version=3.2.2
logback_version=1.4.14
postgres_version=42.7.7
jwt_domain=jwtDomain

BIN
gradle/wrapper/gradle-wrapper.jar vendored Normal file
View File

Binary file not shown.

7
gradle/wrapper/gradle-wrapper.properties vendored Normal file
View File

@@ -0,0 +1,7 @@
distributionBase=GRADLE_USER_HOME
distributionPath=wrapper/dists
distributionUrl=https\://services.gradle.org/distributions/gradle-8.14.3-bin.zip
networkTimeout=10000
validateDistributionUrl=true
zipStoreBase=GRADLE_USER_HOME
zipStorePath=wrapper/dists

251
gradlew vendored Executable file
View File

@@ -0,0 +1,251 @@
#!/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.
#
# SPDX-License-Identifier: Apache-2.0
#
##############################################################################
#
# 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/HEAD/platforms/jvm/plugins-application/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
# This is normally unused
# shellcheck disable=SC2034
APP_BASE_NAME=${0##*/}
# Discard cd standard output in case $CDPATH is set (https://github.com/gradle/gradle/issues/25036)
APP_HOME=$( cd -P "${APP_HOME:-./}" > /dev/null && printf '%s\n' "$PWD" ) || exit
# 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="\\\"\\\""
# 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
if ! command -v java >/dev/null 2>&1
then
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
fi
# Increase the maximum file descriptors if we can.
if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then
case $MAX_FD in #(
max*)
# In POSIX sh, ulimit -H is undefined. That's why the result is checked to see if it worked.
# shellcheck disable=SC2039,SC3045
MAX_FD=$( ulimit -H -n ) ||
warn "Could not query maximum file descriptor limit"
esac
case $MAX_FD in #(
'' | soft) :;; #(
*)
# In POSIX sh, ulimit -n is undefined. That's why the result is checked to see if it worked.
# shellcheck disable=SC2039,SC3045
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
# 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"'
# Collect all arguments for the java command:
# * DEFAULT_JVM_OPTS, JAVA_OPTS, and optsEnvironmentVar are not allowed to contain shell fragments,
# and any embedded shellness will be escaped.
# * For example: A user cannot expect ${Hostname} to be expanded, as it is an environment variable and will be
# treated as '${Hostname}' itself on the command line.
set -- \
"-Dorg.gradle.appname=$APP_BASE_NAME" \
-classpath "$CLASSPATH" \
-jar "$APP_HOME/gradle/wrapper/gradle-wrapper.jar" \
"$@"
# Stop when "xargs" is not available.
if ! command -v xargs >/dev/null 2>&1
then
die "xargs is not available"
fi
# 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" "$@"

94
gradlew.bat vendored Normal file
View File

@@ -0,0 +1,94 @@
@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
@rem SPDX-License-Identifier: Apache-2.0
@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=.
@rem This is normally unused
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% equ 0 goto execute
echo. 1>&2
echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 1>&2
echo. 1>&2
echo Please set the JAVA_HOME variable in your environment to match the 1>&2
echo location of your Java installation. 1>&2
goto fail
:findJavaFromJavaHome
set JAVA_HOME=%JAVA_HOME:"=%
set JAVA_EXE=%JAVA_HOME%/bin/java.exe
if exist "%JAVA_EXE%" goto execute
echo. 1>&2
echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% 1>&2
echo. 1>&2
echo Please set the JAVA_HOME variable in your environment to match the 1>&2
echo location of your Java installation. 1>&2
goto fail
:execute
@rem Setup the command line
set CLASSPATH=
@rem Execute Gradle
"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" -jar "%APP_HOME%\gradle\wrapper\gradle-wrapper.jar" %*
:end
@rem End local scope for the variables with windows NT shell
if %ERRORLEVEL% equ 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!
set EXIT_CODE=%ERRORLEVEL%
if %EXIT_CODE% equ 0 set EXIT_CODE=1
if not ""=="%GRADLE_EXIT_CONSOLE%" exit %EXIT_CODE%
exit /b %EXIT_CODE%
:mainEnd
if "%OS%"=="Windows_NT" endlocal
:omega

18
settings.gradle.kts Normal file
View File

@@ -0,0 +1,18 @@
dependencyResolutionManagement {
repositories {
mavenCentral()
}
versionCatalogs {
create("awssdk") {
from("aws.sdk.kotlin:version-catalog:1.5.4")
}
}
}
plugins {
// Apply the foojay-resolver plugin to allow automatic download of JDKs.
id("org.gradle.toolchains.foojay-resolver-convention") version "0.8.0"
}
rootProject.name = "LMS-APIs"

15
src/main/kotlin/Application.kt Normal file
View File

@@ -0,0 +1,15 @@
package codes.kalar
import io.ktor.server.application.*
fun main(args: Array<String>) {
io.ktor.server.netty.EngineMain.main(args)
}
fun Application.module() {
configureHTTP()
configureSecurity()
configureSerialization()
configureDatabases()
configureRouting()
}

74
src/main/kotlin/CitySchema.kt Normal file
View File

@@ -0,0 +1,74 @@
package codes.kalar
import kotlinx.coroutines.*
import kotlinx.serialization.Serializable
import java.sql.Connection
import java.sql.Statement
@Serializable
data class City(val name: String, val population: Int)
class CityService(private val connection: Connection) {
companion object {
private const val CREATE_TABLE_CITIES =
"CREATE TABLE CITIES (ID SERIAL PRIMARY KEY, NAME VARCHAR(255), POPULATION INT);"
private const val SELECT_CITY_BY_ID = "SELECT name, population FROM cities WHERE id = ?"
private const val INSERT_CITY = "INSERT INTO cities (name, population) VALUES (?, ?)"
private const val UPDATE_CITY = "UPDATE cities SET name = ?, population = ? WHERE id = ?"
private const val DELETE_CITY = "DELETE FROM cities WHERE id = ?"
}
init {
val statement = connection.createStatement()
statement.executeUpdate(CREATE_TABLE_CITIES)
}
private var newCityId = 0
// Create new city
suspend fun create(city: City): Int = withContext(Dispatchers.IO) {
val statement = connection.prepareStatement(INSERT_CITY, Statement.RETURN_GENERATED_KEYS)
statement.setString(1, city.name)
statement.setInt(2, city.population)
statement.executeUpdate()
val generatedKeys = statement.generatedKeys
if (generatedKeys.next()) {
return@withContext generatedKeys.getInt(1)
} else {
throw Exception("Unable to retrieve the id of the newly inserted city")
}
}
// Read a city
suspend fun read(id: Int): City = withContext(Dispatchers.IO) {
val statement = connection.prepareStatement(SELECT_CITY_BY_ID)
statement.setInt(1, id)
val resultSet = statement.executeQuery()
if (resultSet.next()) {
val name = resultSet.getString("name")
val population = resultSet.getInt("population")
return@withContext City(name, population)
} else {
throw Exception("Record not found")
}
}
// Update a city
suspend fun update(id: Int, city: City) = withContext(Dispatchers.IO) {
val statement = connection.prepareStatement(UPDATE_CITY)
statement.setString(1, city.name)
statement.setInt(2, city.population)
statement.setInt(3, id)
statement.executeUpdate()
}
// Delete a city
suspend fun delete(id: Int) = withContext(Dispatchers.IO) {
val statement = connection.prepareStatement(DELETE_CITY)
statement.setInt(1, id)
statement.executeUpdate()
}
}

71
src/main/kotlin/Databases.kt Normal file
View File

@@ -0,0 +1,71 @@
package codes.kalar
import com.auth0.jwt.JWT
import com.auth0.jwt.algorithms.Algorithm
import io.ktor.http.*
import io.ktor.serialization.kotlinx.json.*
import io.ktor.server.application.*
import io.ktor.server.auth.*
import io.ktor.server.auth.jwt.*
import io.ktor.server.plugins.contentnegotiation.*
import io.ktor.server.plugins.defaultheaders.*
import io.ktor.server.plugins.swagger.*
import io.ktor.server.request.*
import io.ktor.server.response.*
import io.ktor.server.routing.*
import java.sql.Connection
import java.sql.DriverManager
fun Application.configureDatabases() {
val dbConnection: Connection = connectToPostgres()
routing {
get("/database") {
var title = mutableListOf<String>()
// FUZZY SEARCH!!!!
val statement = dbConnection.prepareStatement("SELECT title FROM collection_item WHERE levenshtein(title, ?) <= 10 LIMIT 20")
statement.setString(1, "An Absolutely Remarkable Thing")
val resultSet = statement.executeQuery()
while (resultSet.next()) {
title.addLast(resultSet.getString("title") + "\n")
}
call.respond(title.toString() ?: "No data found")
}
}
}
/**
* Makes a connection to a Postgres database.
*
* In order to connect to your running Postgres process,
* please specify the following parameters in your configuration file:
* - postgres.url -- Url of your running database process.
* - postgres.user -- Username for database connection
* - postgres.password -- Password for database connection
*
* If you don't have a database process running yet, you may need to [download]((https://www.postgresql.org/download/))
* and install Postgres and follow the instructions [here](https://postgresapp.com/).
* Then, you would be able to edit your url, which is usually "jdbc:postgresql://host:port/database", as well as
* user and password values.
*
*
* @param embedded -- if [true] defaults to an embedded database for tests that runs locally in the same process.
* In this case you don't have to provide any parameters in configuration file, and you don't have to run a process.
*
* @return [Connection] that represent connection to the database. Please, don't forget to close this connection when
* your application shuts down by calling [Connection.close]
* */
fun Application.connectToPostgres(embedded: Boolean = false): Connection {
Class.forName("org.postgresql.Driver")
if (embedded) {
log.info("Using embedded H2 database for testing; replace this flag to use postgres")
return DriverManager.getConnection("jdbc:h2:mem:test;DB_CLOSE_DELAY=-1", "root", "")
} else {
val url = environment.config.property("postgres.url").getString()
log.info("Connecting to postgres database at $url")
val user = environment.config.property("postgres.user").getString()
val password = environment.config.property("postgres.password").getString()
return DriverManager.getConnection(url, user, password)
}
}

26
src/main/kotlin/HTTP.kt Normal file
View File

@@ -0,0 +1,26 @@
package codes.kalar
import com.auth0.jwt.JWT
import com.auth0.jwt.algorithms.Algorithm
import io.ktor.http.*
import io.ktor.serialization.kotlinx.json.*
import io.ktor.server.application.*
import io.ktor.server.auth.*
import io.ktor.server.auth.jwt.*
import io.ktor.server.plugins.contentnegotiation.*
import io.ktor.server.plugins.defaultheaders.*
import io.ktor.server.plugins.swagger.*
import io.ktor.server.request.*
import io.ktor.server.response.*
import io.ktor.server.routing.*
import java.sql.Connection
import java.sql.DriverManager
fun Application.configureHTTP() {
install(DefaultHeaders) {
header("X-Engine", "Ktor") // will send this header with each response
}
routing {
swaggerUI(path = "openapi")
}
}

74
src/main/kotlin/Routing.kt Normal file
View File

@@ -0,0 +1,74 @@
package codes.kalar
import com.auth0.jwt.JWT
import com.auth0.jwt.algorithms.Algorithm
import io.ktor.http.*
import io.ktor.serialization.kotlinx.json.*
import io.ktor.server.application.*
import io.ktor.server.auth.*
import io.ktor.server.auth.jwt.*
import io.ktor.server.plugins.contentnegotiation.*
import io.ktor.server.plugins.defaultheaders.*
import io.ktor.server.plugins.swagger.*
import io.ktor.server.request.*
import io.ktor.server.response.*
import io.ktor.server.routing.*
import java.sql.Connection
import java.sql.DriverManager
fun Application.configureRouting() {
routing {
get("/") {
call.respondText("Hello World!")
}
get("/patron") {
if (call.request.queryParameters.isEmpty()) {
call.respond(HttpStatusCode.BadRequest, "Invalid parameters")
}
else {
call.respondText("Hello, ${call.request.queryParameters["patron"]}")
}
}
post("/patron") {
call.respondText("Patron is posted")
}
delete("/patron") {
call.respondText("Do you have permissions?")
}
get("/libraries") {
call.respondText("Libraries are neat!")
}
post("/libraries") {
call.respondText("Library is posted")
}
delete("/libraries/{id}") {
call.respondText("We hate to see you go!")
}
get("/items") {
call.respondText("I'll search for that book!")
}
post("/items") {
call.respondText("Somebody got back from Barnes & Noble!")
}
delete("/items/{id}") {
call.respondText(":(")
}
get("/libraries/{libraryId}/items/{itemId}") {
call.respondText("You asked for ${call.parameters["itemId"]} from ${call.parameters["libraryId"]}")
}
get("/authenticate") {
call.respondText(System.getenv("JWT_DOMAIN") ?: "Ain't life a bitch?")
}
}
}

43
src/main/kotlin/Security.kt Normal file
View File

@@ -0,0 +1,43 @@
package codes.kalar
import java.io.File
import java.util.Properties
import com.auth0.jwt.JWT
import com.auth0.jwt.algorithms.Algorithm
import io.ktor.http.*
import io.ktor.serialization.kotlinx.json.*
import io.ktor.server.application.*
import io.ktor.server.auth.*
import io.ktor.server.auth.jwt.*
import io.ktor.server.plugins.contentnegotiation.*
import io.ktor.server.plugins.defaultheaders.*
import io.ktor.server.plugins.swagger.*
import io.ktor.server.request.*
import io.ktor.server.response.*
import io.ktor.server.routing.*
import java.sql.Connection
import java.sql.DriverManager
fun Application.configureSecurity() {
// Please read the jwt property from the config file if you are using EngineMain
val jwtAudience = environment.config.property("jwt.audience").toString()
val jwtDomain = environment.config.property("jwt.domain").toString()
val jwtRealm = "ktor sample app"
val jwtSecret = environment.config.property("jwt.secret").toString()
authentication {
jwt {
realm = jwtRealm
verifier(
JWT
.require(Algorithm.HMAC256(jwtSecret))
.withAudience(jwtAudience)
.withIssuer(jwtDomain)
.build()
)
validate { credential ->
if (credential.payload.audience.contains(jwtAudience)) JWTPrincipal(credential.payload) else null
}
}
}
}

25
src/main/kotlin/Serialization.kt Normal file
View File

@@ -0,0 +1,25 @@
package codes.kalar
import com.auth0.jwt.JWT
import com.auth0.jwt.algorithms.Algorithm
import io.ktor.http.*
import io.ktor.serialization.kotlinx.json.*
import io.ktor.server.application.*
import io.ktor.server.auth.*
import io.ktor.server.auth.jwt.*
import io.ktor.server.plugins.contentnegotiation.*
import io.ktor.server.plugins.defaultheaders.*
import io.ktor.server.plugins.swagger.*
import io.ktor.server.request.*
import io.ktor.server.response.*
import io.ktor.server.routing.*
import java.sql.Connection
import java.sql.DriverManager
fun Application.configureSerialization() {
routing {
get("/json/kotlinx-serialization") {
call.respond(mapOf("hello" to "world"))
}
}
}

11
src/main/kotlin/model/CheckedOutItem.kt Normal file
View File

@@ -0,0 +1,11 @@
package codes.kalar.model
import kotlinx.serialization.Serializable
@Serializable
data class CheckedOutItem(
val id: Long,
val itemId: Long,
val patronId: Long,
val dueDate: String,
)

27
src/main/kotlin/model/CollectionItem.kt Normal file
View File

@@ -0,0 +1,27 @@
package codes.kalar.model
import kotlinx.serialization.Serializable
@Serializable
data class CollectionItem(
val id: Long,
val title: String?,
val author: String?,
val publisher: String?,
val publishingDate: String?,
val locNumber: String?,
val deweyDecimalNumber: String?,
val isbn: Int?,
val sortTitle: String?,
val format: String?,
val language: String?,
val pageCount: Int?,
val category: String?,
val description: String?,
val priceInCents: Int?,
val coverImageUri: String?,
val isCheckedIn: Boolean,
val isArchived: Boolean,
val isLost: Boolean,
val lostDate: String?,
)

12
src/main/kotlin/model/LateItem.kt Normal file
View File

@@ -0,0 +1,12 @@
package codes.kalar.model
import kotlinx.serialization.Serializable
@Serializable
data class LateItem(
val id: Long,
val itemId: Long,
val patronId: Long,
val dueDate: String,
var freeInCents: Int,
)

10
src/main/kotlin/model/Library.kt Normal file
View File

@@ -0,0 +1,10 @@
package codes.kalar.model
import kotlinx.serialization.Serializable
@Serializable
data class Library(
val id: Long,
val name: String,
val address: String,
)

10
src/main/kotlin/model/LibraryCollection.kt Normal file
View File

@@ -0,0 +1,10 @@
package codes.kalar.model
import kotlinx.serialization.Serializable
@Serializable
data class LibraryCollection(
val id: Long,
val libraryId: Long,
val itemId: Long,
)

12
src/main/kotlin/model/LostItem.kt Normal file
View File

@@ -0,0 +1,12 @@
package codes.kalar.model
import kotlinx.serialization.Serializable
@Serializable
data class LostItem(
val id: Long,
val itemId: Long,
val patronId: Long,
val dueDate: String,
val costInCents: Int,
)

11
src/main/kotlin/model/OnHoldItem.kt Normal file
View File

@@ -0,0 +1,11 @@
package codes.kalar.model
import kotlinx.serialization.Serializable
@Serializable
data class OnHoldItem(
val id: Long,
val itemId: Long,
val patronId: Long,
val holdReleaseDate: String,
)

14
src/main/kotlin/model/Patron.kt Normal file
View File

@@ -0,0 +1,14 @@
package codes.kalar.model
import kotlinx.serialization.Serializable
@Serializable
data class Patron(
val id: Long,
val name: String,
val hasGoodStanding: Boolean,
val feeTotal: Long,
val isArchived: Boolean,
val lastLogin: String?,
val password: String?,
)

11
src/main/kotlin/model/Staff.kt Normal file
View File

@@ -0,0 +1,11 @@
package codes.kalar.model
import kotlinx.serialization.Serializable
@Serializable
data class Staff(
val id: Long,
val name: String,
val password: String?,
val isArchived: Boolean,
)

35
src/main/kotlin/service/CollectionItemService.kt Normal file
View File

@@ -0,0 +1,35 @@
package codes.kalar.service
import codes.kalar.model.CollectionItem
import kotlinx.coroutines.*
import kotlinx.serialization.Serializable
import java.sql.Connection
import java.sql.Statement
class CollectionItemService(private val connection: Connection) {
var pageOfItems = mutableListOf<CollectionItem>()
companion object {
// TODO add create table statement
private const val CREATE_COLLECTION_ITEMS_TABLE = "CREATE TABLE IF NOT EXISTS collection_items ("
private const val SELECT_ITEM_BY_TITLE = "SELECT * FROM collection_items WHERE title = ? limit 10"
private const val INSERT_ITEM = "INSERT INTO collection_items (name, population) VALUES (?, ?)"
private const val UPDATE_ITEM = "UPDATE collection_items SET name = ?, population = ? WHERE id = ?"
private const val DELETE_ITEM = "DELETE FROM collection_items WHERE id = ?"
}
init {
val statement = connection.createStatement()
val tables = connection.metaData.getTables(null, "public", "collection_items", arrayOf("TABLE"))
if (!tables.next()) {
statement.executeUpdate(CREATE_COLLECTION_ITEMS_TABLE)
}
}
suspend fun create(collectionItem: CollectionItem) {}
suspend fun read(collectionItem: CollectionItem) {}
suspend fun update(collectionItem: CollectionItem) {}
suspend fun delete(collectionItem: CollectionItem) {}
}

12
src/main/resources/logback.xml Normal file
View File

@@ -0,0 +1,12 @@
<configuration>
<appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
<encoder>
<pattern>%d{YYYY-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</pattern>
</encoder>
</appender>
<root level="INFO">
<appender-ref ref="STDOUT"/>
</root>
<logger name="org.eclipse.jetty" level="INFO"/>
<logger name="io.netty" level="INFO"/>
</configuration>

23
src/main/resources/openapi/documentation.yaml Normal file
View File

@@ -0,0 +1,23 @@
openapi: "3.0.3"
info:
title: "Application API"
description: "Application API"
version: "1.0.0"
servers:
- url: "http://0.0.0.0:8080"
paths:
/:
get:
description: "Hello World!"
responses:
"200":
description: "OK"
content:
text/plain:
schema:
type: "string"
examples:
Example#1:
value: "Hello World!"
components:
schemas: { }

21
src/test/kotlin/ApplicationTest.kt Normal file
View File

@@ -0,0 +1,21 @@
package codes.kalar
import io.ktor.client.request.*
import io.ktor.http.*
import io.ktor.server.testing.*
import kotlin.test.Test
import kotlin.test.assertEquals
class ApplicationTest {
@Test
fun testRoot() = testApplication {
application {
module()
}
client.get("/").apply {
assertEquals(HttpStatusCode.OK, status)
}
}
}