auth support

Author: Kamil-Lontkowski

modules/openapi-generator/src/main/resources/scala-sttp4-jsoniter/api.mustache

@@ -14,27 +14,43 @@ import sttp.model.Method
 
 {{#operations}}
 object {{classname}}:
-  def apply(baseUrl: String = "{{{basePath}}}") = new {{classname}}(baseUrl)
+  def apply(baseUrl: String = "{{{basePath}}}"): {{classname}}[{{invokerPackage}}.Authorization.NoAuthorization.type] = {{classname}}(baseUrl, {{invokerPackage}}.Authorization.NoAuthorization)
+  def withBasicAuth(baseUrl: String, username: String, password: String): {{classname}}[{{invokerPackage}}.Authorization.BasicAuth] =
+    {{classname}}(baseUrl, {{invokerPackage}}.Authorization.BasicAuth(username, password))
+
+  def withApiKeyAuth(baseUrl: String, apiKey: String): {{classname}}[{{invokerPackage}}.Authorization.ApiKey] =
+    {{classname}}(baseUrl, {{invokerPackage}}.Authorization.ApiKey(apiKey))
+
+  def withBearerTokenAuth(baseUrl: String, token: String): {{classname}}[{{invokerPackage}}.Authorization.BearerToken] =
+    {{classname}}(baseUrl, {{invokerPackage}}.Authorization.BearerToken(token))
+
+case class {{classname}}[Auth <: {{invokerPackage}}.Authorization] private (baseUrl: String, authConfig: {{invokerPackage}}.Authorization):
+  def withBasicAuth(username: String, password: String): {{classname}}[{{invokerPackage}}.Authorization.BasicAuth] =
+    copy(authConfig = {{invokerPackage}}.Authorization.BasicAuth(username, password))
+
+  def withApiKeyAuth(apiKey: String): {{classname}}[{{invokerPackage}}.Authorization.ApiKey] =
+    copy(authConfig = {{invokerPackage}}.Authorization.ApiKey(apiKey))
+
+  def withNoAuth: {{classname}}[{{invokerPackage}}.Authorization.NoAuthorization.type] =
+    copy(authConfig = {{invokerPackage}}.Authorization.NoAuthorization)
+
+  def withBearerTokenAuth(token: String): {{classname}}[{{invokerPackage}}.Authorization.BearerToken] =
+    copy(authConfig = {{invokerPackage}}.Authorization.BearerToken(token))
 
-class {{classname}}(baseUrl: String):
 {{#operation}}
 {{#javadocRenderer}}
 {{>javadoc}}
 {{/javadocRenderer}}
   def {{operationId}}{{>methodParameters}}: sttp.client4.Request[{{#separateErrorChannel}}Either[ResponseException[String], {{>operationReturnType}}]{{/separateErrorChannel}}{{^separateErrorChannel}}{{>operationReturnType}}{{/separateErrorChannel}}] =
     val requestURL =
       uri"$baseUrl{{{path}}}"{{#queryParams}}
-        .addParams(FormSerializable.serialize("{{baseName}}", {{{paramName}}}{{#style}}, FormStyleFormat.{{style.toUpperCase}}{{/style}}{{^style}}, FormStyleFormat.FORM{{/style}}, {{isExplode}}): _*){{/queryParams}}{{#isApiKey}}{{#isKeyInQuery}}
-        .addParams("{{keyParamName}}" -> apiKey.value){{/isKeyInQuery}}{{/isApiKey}}
+        .addParams(FormSerializable.serialize("{{baseName}}", {{{paramName}}}{{#style}}, FormStyleFormat.{{style.toUpperCase}}{{/style}}{{^style}}, FormStyleFormat.FORM{{/style}}, {{isExplode}}): _*){{/queryParams}}
 
     basicRequest
       .method(Method.{{httpMethod.toUpperCase}}, requestURL)
       .contentType({{#consumes.0}}"{{{mediaType}}}"{{/consumes.0}}{{^consumes}}"application/json"{{/consumes}}){{#headerParams}}
-      .header({{>paramCreation}}){{/headerParams}}{{#authMethods}}{{#isBasic}}{{#isBasicBasic}}
-      .auth.basic(username, password){{/isBasicBasic}}{{#isBasicBearer}}
-      .auth.bearer(bearerToken){{/isBasicBearer}}{{/isBasic}}{{#isApiKey}}{{#isKeyInHeader}}
-      .header("{{keyParamName}}", apiKey){{/isKeyInHeader}}{{#isKeyInCookie}}
-      .cookie("{{keyParamName}}", apiKey){{/isKeyInCookie}}{{/isApiKey}}{{/authMethods}}{{#formParams.0}}{{^isMultipart}}
+      .header({{>paramCreation}}){{/headerParams}}{{#authMethods}}
+      .auth(authConfig{{#isApiKey}}, {{invokerPackage}}.{{#isKeyInQuery}}QUERY{{/isKeyInQuery}}{{#isKeyInHeader}}HEADER{{/isKeyInHeader}}{{#isKeyInCookie}}COOKIE{{/isKeyInCookie}}, "{{keyParamName}}"{{/isApiKey}}){{/authMethods}}{{#formParams.0}}{{^isMultipart}}
       .body({{#formParams}}
         {{>paramFormCreation}}{{^-last}} ++ {{/-last}}{{/formParams}},
         "utf-8"

modules/openapi-generator/src/main/resources/scala-sttp4-jsoniter/helpers.mustache

@@ -5,6 +5,18 @@ import scala.deriving.*
 import scala.compiletime.*
 import java.io.File
 
+enum ApiKeyLocation:
+  case HEADER
+  case COOKIE
+  case QUERY
+  case NOAPIKEY
+
+enum Authorization:
+  case NoAuthorization
+  case BasicAuth(username: String, password: String)
+  case ApiKey(apiKey: String)
+  case BearerToken(token: String)
+
 enum FormStyleFormat:
   case FORM
   case SPACEDELIMITED
@@ -126,4 +138,16 @@ object Helpers:
     def fileBody(file: Option[File] | File): sttp.client4.Request[?] =
       file match
         case f: File => request.body(f)
-        case f: Option[File] => f.map(request.body(_)).getOrElse(request)
+        case f: Option[File] => f.map(request.body(_)).getOrElse(request)
+
+    def auth(authConfig: Authorization, location: ApiKeyLocation = ApiKeyLocation.NOAPIKEY, keyParamName: String = ""): sttp.client4.Request[?] =
+      // multiple calls to auth with the same config are not idempotent only for APIKey with COOKIE and QUERY - that's why we have NOAPIKEY as default
+      authConfig match
+        case Authorization.NoAuthorization => request
+        case Authorization.BasicAuth(username, password) => request.auth.basic(username, password)
+        case Authorization.BearerToken(token) => request.auth.bearer(token)
+        case Authorization.ApiKey(apiKey) =>location match
+          case ApiKeyLocation.HEADER => request.header(keyParamName, apiKey)
+          case ApiKeyLocation.COOKIE => request.cookie(keyParamName, apiKey)
+          case ApiKeyLocation.QUERY => request.copy(uri = request.uri.addParam(keyParamName, apiKey))
+          case ApiKeyLocation.NOAPIKEY => request  // since it can be called multiple times in request (when there are for example 2 auth methods) we want to make this call idempotent

modules/openapi-generator/src/main/resources/scala-sttp4-jsoniter/methodParameters.mustache

@@ -1 +1 @@
-{{#authMethods.0}}({{#authMethods}}{{#isApiKey}}apiKey: String{{/isApiKey}}{{#isBasic}}{{#isBasicBasic}}username: String, password: String{{/isBasicBasic}}{{#isBasicBearer}}bearerToken: String{{/isBasicBearer}}{{/isBasic}}{{^-last}}, {{/-last}}{{/authMethods}}){{/authMethods.0}}{{#allParams.0}}({{#allParams}}{{paramName}}: {{#required}}{{dataType}}{{/required}}{{^required}}{{#isContainer}}{{dataType}}{{/isContainer}}{{^isContainer}}Option[{{dataType}}]{{/isContainer}}{{/required}}{{^defaultValue}}{{^required}}{{^isContainer}} = scala.None{{/isContainer}}{{/required}}{{/defaultValue}}{{^-last}}, {{/-last}}{{/allParams}}){{/allParams.0}}
+{{#allParams.0}}({{#allParams}}{{paramName}}: {{#required}}{{dataType}}{{/required}}{{^required}}{{#isContainer}}{{dataType}}{{/isContainer}}{{^isContainer}}Option[{{dataType}}]{{/isContainer}}{{/required}}{{^defaultValue}}{{^required}}{{^isContainer}} = scala.None{{/isContainer}}{{/required}}{{/defaultValue}}{{^-last}}, {{/-last}}{{/allParams}}){{/allParams.0}}{{#authMethods.0}}(using Auth <:< {{#authMethods}}{{#isApiKey}}{{invokerPackage}}.Authorization.ApiKey{{/isApiKey}}{{#isBasic}}{{#isBasicBasic}}{{invokerPackage}}.Authorization.BasicAuth{{/isBasicBasic}}{{#isBasicBearer}}{{invokerPackage}}.Authorization.BearerToken{{/isBasicBearer}}{{/isBasic}}{{^-last}} | {{/-last}}{{/authMethods}}){{/authMethods.0}}