Extracted a HttpClient interface

Author: sjahreis

kotlin-http-client/kotlin-http-client-api/src/main/kotlin/com/linkedplanet/kotlinhttpclient/api/http/BaseHttpClient.kt

@@ -30,35 +30,9 @@ import java.nio.charset.StandardCharsets
 
 val GSON: Gson = GsonBuilder().create()
 
-abstract class BaseHttpClient {
+abstract class BaseHttpClient : HttpClient {
 
-    abstract suspend fun executeRestCall(
-        method: String,
-        path: String,
-        params: Map<String, String>,
-        body: String?,
-        contentType: String?,
-        headers: Map<String, String> = emptyMap()
-    ): Either<HttpDomainError, HttpResponse<String>>
-
-    abstract suspend fun executeDownload(
-        method: String,
-        path: String,
-        params: Map<String, String>,
-        body: String?,
-        contentType: String?
-    ): Either<DomainError, HttpResponse<ByteArray>>
-
-    abstract suspend fun executeUpload(
-        method: String,
-        url: String,
-        params: Map<String, String>,
-        mimeType: String,
-        filename: String,
-        byteArray: ByteArray
-    ): Either<HttpDomainError, HttpResponse<ByteArray>>
-
-    suspend fun <T> executeRest(
+    override suspend fun <T> executeRest(
         method: String,
         path: String,
         params: Map<String, String>,
@@ -73,7 +47,7 @@ abstract class BaseHttpClient {
             )
         }
 
-    suspend fun <T> executeRestList(
+    override suspend fun <T> executeRestList(
         method: String,
         path: String,
         params: Map<String, String>,
@@ -88,7 +62,7 @@ abstract class BaseHttpClient {
             )
         }
 
-    suspend fun <T> executeGet(
+    override suspend fun <T> executeGet(
         path: String,
         params: Map<String, String>,
         returnType: Type
@@ -100,7 +74,7 @@ abstract class BaseHttpClient {
             )
         }
 
-    suspend fun <T> executeGetReturnList(
+    override suspend fun <T> executeGetReturnList(
         path: String,
         params: Map<String, String>,
         returnType: Type
@@ -112,13 +86,13 @@ abstract class BaseHttpClient {
             )
         }
 
-    suspend fun executeGetCall(
+    override suspend fun executeGetCall(
         path: String,
         params: Map<String, String>
     ): Either<HttpDomainError, HttpResponse<String>> =
         executeRestCall("GET", path, params, null, null)
 
-    fun encodeParams(map: Map<String, String>): String {
+    override fun encodeParams(map: Map<String, String>): String {
         return map.map { it.key + "=" + doEncoding(it.value) }.joinToString("&")
     }
 

kotlin-http-client/kotlin-http-client-api/src/main/kotlin/com/linkedplanet/kotlinhttpclient/api/http/HttpClient.kt

@@ -0,0 +1,71 @@
+package com.linkedplanet.kotlinhttpclient.api.http
+
+import arrow.core.Either
+import com.linkedplanet.kotlinhttpclient.error.DomainError
+import com.linkedplanet.kotlinhttpclient.error.HttpDomainError
+import java.lang.reflect.Type
+
+interface HttpClient {
+    suspend fun executeRestCall(
+        method: String,
+        path: String,
+        params: Map<String, String>,
+        body: String?,
+        contentType: String?,
+        headers: Map<String, String> = emptyMap()
+    ): Either<HttpDomainError, HttpResponse<String>>
+
+    suspend fun executeDownload(
+        method: String,
+        path: String,
+        params: Map<String, String>,
+        body: String?,
+        contentType: String?
+    ): Either<DomainError, HttpResponse<ByteArray>>
+
+    suspend fun executeUpload(
+        method: String,
+        url: String,
+        params: Map<String, String>,
+        mimeType: String,
+        filename: String,
+        byteArray: ByteArray
+    ): Either<HttpDomainError, HttpResponse<ByteArray>>
+
+    suspend fun <T> executeRest(
+        method: String,
+        path: String,
+        params: Map<String, String>,
+        body: String?,
+        contentType: String?,
+        returnType: Type
+    ): Either<HttpDomainError, HttpResponse<T?>>
+
+    suspend fun <T> executeRestList(
+        method: String,
+        path: String,
+        params: Map<String, String>,
+        body: String?,
+        contentType: String?,
+        returnType: Type
+    ): Either<HttpDomainError, HttpResponse<List<T>>>
+
+    suspend fun <T> executeGet(
+        path: String,
+        params: Map<String, String>,
+        returnType: Type
+    ): Either<HttpDomainError, HttpResponse<T?>>
+
+    suspend fun <T> executeGetReturnList(
+        path: String,
+        params: Map<String, String>,
+        returnType: Type
+    ): Either<HttpDomainError, HttpResponse<List<T>?>>
+
+    suspend fun executeGetCall(
+        path: String,
+        params: Map<String, String>
+    ): Either<HttpDomainError, HttpResponse<String>>
+
+    fun encodeParams(map: Map<String, String>): String
+}

kotlin-insight-client/kotlin-insight-client-http/src/main/kotlin/com/linkedplanet/kotlininsightclient/http/HttpInsightClientContext.kt

@@ -19,6 +19,6 @@
  */
 package com.linkedplanet.kotlininsightclient.http
 
-import com.linkedplanet.kotlinhttpclient.api.http.BaseHttpClient
+import com.linkedplanet.kotlinhttpclient.api.http.HttpClient
 
-class HttpInsightClientContext(val baseUrl: String, val httpClient: BaseHttpClient)
+class HttpInsightClientContext(val baseUrl: String, val httpClient: HttpClient)

kotlin-jira-client/kotlin-jira-client-http/src/main/kotlin/com/linkedplanet/kotlinjiraclient/http/HttpJiraClientContext.kt

@@ -7,9 +7,9 @@
  * 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
- * 
+ *
  *      http://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.
@@ -19,6 +19,6 @@
  */
 package com.linkedplanet.kotlinjiraclient.http
 
-import com.linkedplanet.kotlinhttpclient.api.http.BaseHttpClient
+import com.linkedplanet.kotlinhttpclient.api.http.HttpClient
 
-class HttpJiraClientContext(val baseUrl: String, val httpClient: BaseHttpClient)
+class HttpJiraClientContext(val baseUrl: String, val httpClient: HttpClient)