From 475fe5e4ad8207ebcaff9511be15c64f2f5079c6 Mon Sep 17 00:00:00 2001
From: Vit DeBacco <vdebacco@gmail.com>
Date: Mon, 16 Nov 2020 23:03:33 -0500
Subject: [PATCH] feat: ktor, kodein, exposed implementation

This commit adds the Ktor, Kodein, Exposed implementation.
---
 ktor-kodein-exposed/README.md | 56 +++++++++++++++++++++++++++++++++++
 1 file changed, 56 insertions(+)
 create mode 100644 ktor-kodein-exposed/README.md

diff --git a/ktor-kodein-exposed/README.md b/ktor-kodein-exposed/README.md
new file mode 100644
index 0000000..83a9d04
--- /dev/null
+++ b/ktor-kodein-exposed/README.md
@@ -0,0 +1,56 @@
+# ktor-kodein-exposed
+This project is a sample service using [ktor](https://ktor.io/) (with Netty) and 
+[Exposed](https://github.com/JetBrains/Exposed) ORM. [Kodein](https://kodein.org/di/) is leveraged for  
+dependency injection. The ultimate goal is to incorporate a similar sample service into 
+[cautious-engine](https://github.com/vitdebacco/cautious-engine) to test the performance of various frameworks.
+
+This project was initialized with IntelliJ's Ktor plugin. 
+
+### Build and Run
+1. `docker-compose up`
+2. `./gradlew run`
+
+### cURL Requests (w/ jq)
+#### Create
+To create an Offering, you must supply `name`, `tasting_notes`, `description`, `url`, and `roaster_name`.
+```
+curl -X POST 'http://localhost:8080/api/v1/offerings' -H 'Content-Type: application/json' -d '{                                                                            130 ↵
+  "name": "Ethiopia Kochere & Yirgacheffe Jabanto",
+  "tasting_notes": "Blueberry, Chocolate, Honey",
+  "description": "The Jabanto group formed in 2017, after changes in the Ethiopian coffee policy permitted smallholder farmers to be able to directly export and sell their coffees. The group has worked hard to build an enterprising business from scratch and their commitment to careful harvesting and processing each year results in some of our favorite offerings. This year’s production of Jabanto Natural Sundried tastes like blueberry, chocolate, and honey.",
+  "url": "https://counterculturecoffee.com/shop/coffee/jabanto-natural-sundried",
+  "roaster_name": "Counter Culture Coffee"
+}' | jq
+```
+
+#### Get All
+```
+curl 'http://localhost:8080/api/v1/offerings' | jq
+```
+
+#### Get By ID
+```
+curl 'http://localhost:8080/api/v1/offerings/{id}' | jq
+```
+
+#### Update
+Only `description` is updatable.
+```
+curl -X PUT 'http://localhost:8080/api/v1/offerings/{id}' -H 'Content-Type: application/json' -d '{ "description":"Updated Description" }' | jq
+```
+
+#### Delete
+```
+curl -X DELETE 'http://localhost:8080/api/v1/offerings/{id}' | jq
+```
+
+### Helpful Links
+The following were helpful in putting this together.
+
+[Ktor](https://ktor.io/)
+
+[Kotlin with Ktor](https://www.baeldung.com/kotlin-ktor)
+
+[Tutorial: Simple Kotlin REST API with Ktor, Exposed and Kodein](https://stefangaller.at/app-development/kotlin/ktor-rest-api-exposed/)
+
+