Adam/remove retrofit (#602)

* Update OpenAPI config to use Okhttp instead of Retrofit

* Generate new OkHttp based code for REST API

* Exclude the whole /restapi directory from detekt

* Use new services without the Retrofit dependencies

Author: AdamGrzybkowski

build-logic/convention/src/main/kotlin/GravatarOpenApiGeneratorConventionPlugin.kt

@@ -23,12 +23,13 @@ class GravatarOpenApiGeneratorConventionPlugin : Plugin<Project> {
                 // Set the generation configuration options
                 configOptions.set(
                     mapOf(
-                        "library" to "jvm-retrofit2",
+                        "library" to "jvm-okhttp4",
                         "serializationLibrary" to "moshi",
                         "groupId" to "com.gravatar",
                         "packageName" to "com.gravatar.restapi",
                         "useCoroutines" to "true",
                         "moshiCodeGen" to "true",
+                        "supportAndroidApiLevel25AndBelow" to "true",
                     ),
                 )
                 importMappings.set(
@@ -49,6 +50,8 @@ class GravatarOpenApiGeneratorConventionPlugin : Plugin<Project> {
                     mapOf(
                         "apis" to "",
                         "models" to "",
+                        "supportingFiles" to "ApiClient.kt,ApiAbstractions.kt,Serializer.kt,ApiResponse.kt," +
+                            "Serializer.kt,PartConfig.kt,RequestConfig.kt,RequestMethod.kt,URIAdapter.kt",
                     ),
                 )
             }

config/detekt/detekt.yml

@@ -9,14 +9,12 @@ complexity:
   LongParameterList:
     ignoreDefaultParameters: true
     ignoreAnnotated: ['Inject', 'Composable']
-    excludes: [ '**/restapi/models/**' ]
   LongMethod:
     ignoreAnnotated: ['Composable']
   TooManyFunctions:
     active: false
   CyclomaticComplexMethod:
     ignoreSimpleWhenEntries: true
-    excludes: [ '**/restapi/models/**' ]
 
 coroutines:
   GlobalCoroutineUsage:
@@ -27,7 +25,6 @@ naming:
     ignoreAnnotated: ['Composable']
   FunctionParameterNaming:
     active: true
-    excludes: [ '**/restapi/**' ]
 
 style:
   DataClassShouldBeImmutable:
@@ -48,7 +45,6 @@ style:
   MaxLineLength:
     active: true
     maxLineLength: 120
-    excludes: [ '**/api/**', '**/restapi/**' ]
     excludePackageStatements: true
     excludeImportStatements: true
     excludeCommentStatements: false
@@ -57,7 +53,7 @@ style:
 comments:
   UndocumentedPublicClass:
     active: true
-    excludes: [ '**/test/**', '**/androidTest/**', '**/demoapp/**', '**/restapi/models/**', '**/uitestutils/**' ]
+    excludes: [ '**/test/**', '**/androidTest/**', '**/demoapp/**', '**/uitestutils/**' ]
     searchInNestedClass: true
     searchInInnerClass: true
     searchInInnerObject: true
@@ -68,16 +64,16 @@ comments:
     # Ignore Jetpack Compose functions annotated with @Preview
     ignoreAnnotated:
       - 'Preview'
-    excludes: [ '**/test/**', '**/androidTest/**', '**/demoapp/**', '**/restapi/models/**', '**/uitestutils/**' ]
+    excludes: [ '**/test/**', '**/androidTest/**', '**/demoapp/**', '**/uitestutils/**' ]
     searchProtectedFunction: false
   UndocumentedPublicProperty:
     active: true
     # TODO - Remove the explicit exclusion of Email.kt once we implement the new REST API
-    excludes: [ '**/test/**', '**/androidTest/**', '**/demoapp/**', '**/restapi/models/**', '**/uitestutils/**' ]
+    excludes: [ '**/test/**', '**/androidTest/**', '**/demoapp/**', '**/uitestutils/**' ]
     searchProtectedProperty: false
   OutdatedDocumentation:
     active: true
-    excludes: [ '**/test/**', '**/androidTest/**', '**/demoapp/**', '**/restapi/models/**', '**/restapi/apis/**' ]
+    excludes: [ '**/test/**', '**/androidTest/**', '**/demoapp/**' ]
     matchTypeParameters: true
     matchDeclarationsOrder: true
     allowParamOnConstructorProperties: false

gradle/libs.versions.toml

@@ -70,6 +70,7 @@ kotlinx-coroutines-test = { group = "org.jetbrains.kotlinx", name = "kotlinx-cor
 mockk-agent = { group = "io.mockk", name = "mockk-agent", version.ref = "mockk" }
 mockk-android = { group = "io.mockk", name = "mockk-android", version.ref = "mockk" }
 mockwebserver = { group = "com.squareup.okhttp3", name = "mockwebserver", version.ref = "mockwebserver" }
+moshi = { group = "com.squareup.moshi", name = "moshi", version.ref = "moshi" }
 moshi-kotlin-codegen = { group = "com.squareup.moshi", name = "moshi-kotlin-codegen", version.ref = "moshi" }
 okhttp = { group = "com.squareup.okhttp3", name = "okhttp", version.ref = "okhttp" }
 retrofit = { group = "com.squareup.retrofit2", name = "retrofit", version.ref = "retrofit" }

gravatar/build.gradle.kts

@@ -32,12 +32,17 @@ android {
             }
         }
     }
+
+    detekt {
+        tasks.withType<io.gitlab.arturbosch.detekt.Detekt>().configureEach {
+            exclude("**/restapi/**") // Specify the directory to exclude
+        }
+    }
 }
 
 dependencies {
     api(libs.okhttp)
-    implementation(libs.retrofit)
-    implementation(libs.retrofit.moshi.converter)
+    implementation(libs.moshi)
     implementation(libs.kotlinx.coroutines)
     ksp(libs.moshi.kotlin.codegen)
 

gravatar/openapi/api-gravatar.json

@@ -967,14 +967,14 @@
               "schema": {
                 "type": "object",
                 "properties": {
-                  "data": {
+                  "image": {
                     "type": "string",
                     "format": "binary",
                     "description": "The avatar image file"
                   }
                 },
                 "required": [
-                  "data"
+                  "image"
                 ]
               }
             }

gravatar/openapi/templates/infrastructure/ApiAbstractions.kt.mustache

@@ -0,0 +1,23 @@
+package {{packageName}}.infrastructure
+
+internal typealias MultiValueMap = MutableMap<String,List<String>>
+
+internal fun collectionDelimiter(collectionFormat: String): String = when(collectionFormat) {
+    "csv" -> ","
+    "tsv" -> "\t"
+    "pipe" -> "|"
+    "space" -> " "
+    else -> ""
+}
+
+internal val defaultMultiValueConverter: (item: Any?) -> String = { item -> "$item" }
+
+internal fun <T : Any?> toMultiValue(items: Array<T>, collectionFormat: String, map: (item: T) -> String = defaultMultiValueConverter): List<String>
+        = toMultiValue(items.asIterable(), collectionFormat, map)
+
+internal fun <T : Any?> toMultiValue(items: Iterable<T>, collectionFormat: String, map: (item: T) -> String = defaultMultiValueConverter): List<String> {
+    return when(collectionFormat) {
+        "multi" -> items.map(map)
+        else -> listOf(items.joinToString(separator = collectionDelimiter(collectionFormat), transform = map))
+    }
+}

gravatar/openapi/templates/infrastructure/PartConfig.kt.mustache

@@ -0,0 +1,11 @@
+package {{packageName}}.infrastructure
+
+/**
+ * Defines a config object for a given part of a multi-part request.
+ * NOTE: Headers is a Map<String,String> because rfc2616 defines
+ *       multi-valued headers as csv-only.
+ */
+internal data class PartConfig<T>(
+    val headers: MutableMap<String, String> = mutableMapOf(),
+    val body: T? = null
+)

gravatar/openapi/templates/infrastructure/RequestConfig.kt.mustache

@@ -0,0 +1,19 @@
+package {{packageName}}.infrastructure
+
+/**
+ * Defines a config object for a given request.
+ * NOTE: This object doesn't include 'body' because it
+ *       allows for caching of the constructed object
+ *       for many request definitions.
+ * NOTE: Headers is a Map<String,String> because rfc2616 defines
+ *       multi-valued headers as csv-only.
+ */
+internal data class RequestConfig<T>(
+    val method: RequestMethod,
+    val path: String,
+    val headers: MutableMap<String, String> = mutableMapOf(),
+    val params: MutableMap<String, Any> = mutableMapOf(),
+    val query: MutableMap<String, List<String>> = mutableMapOf(),
+    val requiresAuthentication: Boolean,
+    val body: T? = null
+)

gravatar/openapi/templates/infrastructure/RequestMethod.kt.mustache

@@ -0,0 +1,8 @@
+package {{packageName}}.infrastructure
+
+/**
+ * Provides enumerated HTTP verbs
+ */
+internal enum class RequestMethod {
+    GET, DELETE, HEAD, OPTIONS, PATCH, POST, PUT
+}

gravatar/openapi/templates/jvm-common/infrastructure/Serializer.kt.mustache

@@ -0,0 +1,30 @@
+package {{packageName}}.infrastructure
+
+{{#moshi}}
+import com.squareup.moshi.Moshi
+{{#enumUnknownDefaultCase}}
+import com.squareup.moshi.adapters.EnumJsonAdapter
+{{/enumUnknownDefaultCase}}
+{{^moshiCodeGen}}
+import com.squareup.moshi.kotlin.reflect.KotlinJsonAdapterFactory
+{{/moshiCodeGen}}
+{{/moshi}}
+
+internal object Serializer {
+{{#moshi}}
+    @JvmStatic
+    internal val moshiBuilder: Moshi.Builder = Moshi.Builder()
+        .add(URIAdapter())
+        {{^moshiCodeGen}}
+        .add(KotlinJsonAdapterFactory())
+        {{/moshiCodeGen}}
+
+    @JvmStatic
+    internal val moshi: Moshi by lazy {
+{{#enumUnknownDefaultCase}}
+        SerializerHelper.addEnumUnknownDefaultCase(moshiBuilder)
+{{/enumUnknownDefaultCase}}
+        moshiBuilder.build()
+    }
+{{/moshi}}
+}