Add OAuth2 example

.gitignore

@@ -3,6 +3,8 @@ target/
 *.class
 *.log
 
+.idea/
+
 .bloop/
 .metals/
 .bsp/

DEV.md

@@ -25,4 +25,10 @@ git push origin $VERSION
 
 # TODOs
 
-- cookies ?
+- cookies ?
+- adapt query params to requests lib
+- add Docker / Watchtower example
+
+
+
+

README.md

@@ -1,12 +1,14 @@
 
 # Sharaf
 
+Simple, intuitive, batteries-included HTTP library.
+
 ## Why sharaf?
 
-**Simplicity and ease of use** is the main focus of sharaf.  
+Simplicity and ease of use is the main focus of sharaf.  
 
 It is built on top of [undertow](https://undertow.io/).  
-This means you can use some awesome libraries built for undertow, like [pac4j](https://github.com/pac4j/undertow-pac4j) for security and similar.  
+This means you can use awesome libraries built for undertow, like [pac4j](https://github.com/pac4j/undertow-pac4j) for security and similar.  
 Also, you can use undertow's lower level API, to use WebSockets for example.
 
 Sharaf bundles a set of libraries:
@@ -15,8 +17,14 @@ Sharaf bundles a set of libraries:
 - [formson](./formson) for forms
 - [validson](./formson) for validation
 - [hepek-components](https://github.com/sake92/hepek) for HTML (with [scalatags](https://github.com/com-lihaoyi/scalatags))
-
-There are a bunch of [examples](./examples) to get you started.
+- [requests](https://github.com/com-lihaoyi/requests-scala) for firing HTTP requests
+
+## Examples
+- handling [json](examples/json)
+- handling [form data](examples/form)
+- rendering [html](examples/html) and serving static files
+- implementation of [todobackend.com](examples/todo) featuring CORS handling
+- [OAuth2 login](examples/oauth2) with [Pac4J library](https://www.pac4j.org/)
 
 ## Misc
 

build.sc

@@ -11,7 +11,8 @@ object sharaf extends SharafPublishModule {
   def ivyDeps = Agg(
     ivy"io.undertow:undertow-core:2.3.7.Final",
     ivy"ba.sake::tupson:0.7.0",
-    ivy"ba.sake::hepek-components:0.13.0"
+    ivy"ba.sake::hepek-components:0.13.0",
+    ivy"com.lihaoyi::requests:0.8.0"
   )
 
   def moduleDeps = Seq(querson, formson)
@@ -25,6 +26,8 @@ object querson extends SharafPublishModule {
 
   def moduleDeps = Seq(validson)
 
+  def pomSettings = super.pomSettings().copy(description = "Simple query params library")
+
   def ivyDeps = Agg(
     ivy"com.lihaoyi::fastparse:3.0.1"
   )
@@ -38,11 +41,12 @@ object formson extends SharafPublishModule {
 
   def moduleDeps = Seq(validson)
 
+  def pomSettings = super.pomSettings().copy(description = "Simple form binding library")
+
   object test extends ScalaTests with SharafTestModule
 
   def ivyDeps = Agg(
-    ivy"com.lihaoyi::fastparse:3.0.1",
-    ivy"com.lihaoyi::requests:0.8.0" // TODO move to a separate module
+    ivy"com.lihaoyi::fastparse:3.0.1"
   )
 }
 
@@ -54,6 +58,8 @@ object validson extends SharafPublishModule {
     ivy"com.lihaoyi::sourcecode::0.3.0"
   )
 
+  def pomSettings = super.pomSettings().copy(description = "Simple validation library")
+
   object test extends ScalaTests with SharafTestModule
 }
 
@@ -104,4 +110,17 @@ object examples extends mill.Module {
     def moduleDeps = Seq(sharaf)
     object test extends ScalaTests with SharafTestModule
   }
+  object oauth2 extends SharafCommonModule {
+    def moduleDeps = Seq(sharaf)
+    def ivyDeps = Agg(
+      ivy"ch.qos.logback:logback-classic:1.4.6",
+      ivy"org.pac4j:undertow-pac4j:5.0.1",
+      ivy"org.pac4j:pac4j-oauth:5.7.0"
+    )
+    object test extends ScalaTests with SharafTestModule {
+      def ivyDeps = super.ivyDeps() ++ Agg(
+        ivy"no.nav.security:mock-oauth2-server:0.5.10"
+      )
+    }
+  }
 }

examples/form/src/Main.scala

@@ -11,7 +11,7 @@ import ba.sake.validson.*
 
 @main def main: Unit = {
 
-  val server = FormApiServer(8181).server
+  val server = FormApiModule(8181).server
   server.start()
 
   val serverInfo = server.getListenerInfo().get(0)
@@ -20,7 +20,7 @@ import ba.sake.validson.*
 
 }
 
-class FormApiServer(port: Int) {
+class FormApiModule(port: Int) {
   private val routes: Routes = { case POST() -> Path("form") =>
     val req = Request.current.bodyForm[CreateCustomerForm].validateOrThrow
     val fileAsString = Files.readString(req.file)

examples/form/test/src/FormApiSuite.scala

@@ -1,19 +1,17 @@
 package demo
 
-import scala.util.Random
-import io.undertow.Undertow
 import ba.sake.formson.*
 import ba.sake.tupson.*
-import ba.sake.sharaf.Resource
+import ba.sake.sharaf.*
 
 class FormApiSuite extends munit.FunSuite {
 
-  override def munitFixtures = List(serverFixture)
+  override def munitFixtures = List(moduleFixture)
 
   test("customer can be created") {
 
-    val server = serverFixture()
-    val serverInfo = server.getListenerInfo().get(0)
+    val module = moduleFixture()
+    val serverInfo = module.server.getListenerInfo().get(0)
     val baseUrl = s"${serverInfo.getProtcol}:/${serverInfo.getAddress}"
 
     val exampleFile =
@@ -23,39 +21,26 @@ class FormApiSuite extends munit.FunSuite {
       CreateCustomerForm("Meho", exampleFile, CreateAddressForm("street123ž"), List("hobby1", "hobby2"))
     val res = requests.post(
       s"$baseUrl/form",
-      data = formData2RequestsMultipart(reqBody.toFormDataMap())
+      data = reqBody.toFormDataMap().toRequestsMultipart()
     )
 
     assertEquals(res.statusCode, 200)
-    assertEquals(res.headers("content-type"), Seq("application/json")) // it returns JSON content..
     val resBody = res.text.parseJson[CreateCustomerResponse]
     // this tests utf-8 encoding too :)
     assertEquals(resBody.street, "street123ž")
     assertEquals(resBody.fileContents, "This is a text file :)")
   }
 
-  // TODO extract into a separate requests-integration module
-  private def formData2RequestsMultipart(formDataMap: FormDataMap) = {
-    val multiItems = formDataMap.flatMap { case (key, values) =>
-      values.map {
-        case FormValue.Str(value)       => requests.MultiItem(key, value)
-        case FormValue.File(value)      => requests.MultiItem(key, value, value.getFileName.toString)
-        case FormValue.ByteArray(value) => requests.MultiItem(key, value)
-      }
-    }
-    requests.MultiPart(
-      multiItems.toSeq*
-    )
-  }
+  val moduleFixture = new Fixture[FormApiModule]("FormApiModule") {
+    private var module: FormApiModule = _
+
+    def apply() = module
 
-  val serverFixture = new Fixture[Undertow]("JsonApiServer") {
-    private var underlyingServer: Undertow = _
-    def apply() = underlyingServer
     override def beforeEach(context: BeforeEach): Unit =
-      underlyingServer = FormApiServer(Random.between(1_024, 65_535)).server
-      underlyingServer.start()
+      module = FormApiModule(SharafUtils.getFreePort())
+      module.server.start()
     override def afterEach(context: AfterEach): Unit =
-      underlyingServer.stop
+      module.server.stop()
   }
 
 }

examples/html/src/Main.scala

@@ -10,11 +10,12 @@ import scalatags.Text.all._
 @main def main: Unit = {
 
   val routes: Routes = {
-    case GET() -> Path("html") =>
-      Response.withBody(MyPage)
-    case GET() -> Path("scala.png") =>
-      val resource = Resource.fromClassPath("static/scala.png")
+    case GET() -> Path("images", imageName) =>
+      val resource = Resource.fromClassPath(s"static/images/$imageName")
       Response.withBodyOpt(resource, "NotFound")
+
+    case GET() -> Path() =>
+      Response.withBody(MyPage)
   }
 
   val server = Undertow
@@ -33,7 +34,7 @@ import scalatags.Text.all._
 
 val MyPage = new HtmlPage {
   override def bodyContent: Frag = div(
-    "oppppppp",
-    img(src := "scala.png")
+    "Hello sharaf!",
+    img(src := "images/scala.png")
   )
 }

examples/json/src/Main.scala

@@ -3,24 +3,23 @@ package demo
 import java.util.UUID
 import io.undertow.Undertow
 
-import ba.sake.tupson.*
 import ba.sake.sharaf.*
 import ba.sake.sharaf.routing.*
 import ba.sake.sharaf.handlers.*
-import ba.sake.querson.*
+import ba.sake.tupson.*
 import ba.sake.validson.*
 
 @main def main: Unit = {
 
-  val server = JsonApiServer(8181).server
+  val server = JsonApiModule(8181).server
   server.start()
 
   val serverInfo = server.getListenerInfo().get(0)
   val url = s"${serverInfo.getProtcol}:/${serverInfo.getAddress}"
-  println(s"Started JsonApiServer at $url")
+  println(s"Started HTTP server at $url")
 }
 
-class JsonApiServer(port: Int) {
+class JsonApiModule(port: Int) {
 
   private var db = Seq.empty[CustomerRes]
 
@@ -47,5 +46,3 @@ class JsonApiServer(port: Int) {
     .setHandler(ErrorHandler(RoutesHandler(routes), ErrorMapper.json))
     .build()
 }
-
-case class UserQuery(name: Set[String]) derives QueryStringRW

examples/json/src/requests.scala

@@ -2,6 +2,7 @@ package demo
 
 import ba.sake.tupson.JsonRW
 import ba.sake.validson.*
+import ba.sake.querson.QueryStringRW
 
 case class CreateCustomerReq private (name: String, address: CreateAddressReq) derives JsonRW
 
@@ -23,3 +24,5 @@ object CreateAddressReq:
     .derived[CreateAddressReq]
     .and(_.street, !_.isBlank, "must not be blank")
     .and(_.street, _.length >= 3, "must be >= 3")
+
+case class UserQuery(name: Set[String]) derives QueryStringRW

examples/json/test/src/JsonApiSuite.scala

@@ -1,19 +1,18 @@
 package demo
 
-import ba.sake.querson.*
-import ba.sake.tupson.*
-import scala.util.Random
-import io.undertow.Undertow
 import ba.sake.sharaf.handlers.ProblemDetails
 import ba.sake.sharaf.handlers.ArgumentProblem
+import ba.sake.sharaf.SharafUtils
+import ba.sake.querson.*
+import ba.sake.tupson.*
 
 class JsonApiSuite extends munit.FunSuite {
 
-  override def munitFixtures = List(serverFixture)
+  override def munitFixtures = List(moduleFixture)
 
   test("customers can be created and fetched") {
-    val server = serverFixture()
-    val serverInfo = server.getListenerInfo().get(0)
+    val module = moduleFixture()
+    val serverInfo = module.server.getListenerInfo().get(0)
     val baseUrl = s"${serverInfo.getProtcol}:/${serverInfo.getAddress}"
 
     // first GET -> empty
@@ -80,8 +79,8 @@ class JsonApiSuite extends munit.FunSuite {
   }
 
   test("400 BadRequest when body not valid") {
-    val server = serverFixture()
-    val serverInfo = server.getListenerInfo().get(0)
+    val module = moduleFixture()
+    val serverInfo = module.server.getListenerInfo().get(0)
     val baseUrl = s"${serverInfo.getProtcol}:/${serverInfo.getAddress}"
 
     // blank name not allowed
@@ -118,14 +117,17 @@ class JsonApiSuite extends munit.FunSuite {
 
   }
 
-  val serverFixture = new Fixture[Undertow]("JsonApiServer") {
-    private var underlyingServer: Undertow = _
-    def apply() = underlyingServer
+  val moduleFixture = new Fixture[JsonApiModule]("JsonApiModule") {
+    private var module: JsonApiModule = _
+
+    def apply() = module
+
     override def beforeEach(context: BeforeEach): Unit =
-      underlyingServer = JsonApiServer(Random.between(1_024, 65_535)).server
-      underlyingServer.start()
+      module = JsonApiModule(SharafUtils.getFreePort())
+      module.server.start()
+
     override def afterEach(context: AfterEach): Unit =
-      underlyingServer.stop
+      module.server.stop()
   }
 
 }