com.highmobility.hmkitfleet.network.Requests.kt Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of hmkit-fleet Show documentation
hmkit-fleet
The newest version!
/*
 * The MIT License
 *
 * Copyright (c) 2023- High-Mobility GmbH (https://high-mobility.com)
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */
package com.highmobility.hmkitfleet.network

import kotlinx.serialization.encodeToString
import kotlinx.serialization.json.Json
import kotlinx.serialization.json.JsonArray
import kotlinx.serialization.json.JsonElement
import kotlinx.serialization.json.JsonObject
import kotlinx.serialization.json.decodeFromJsonElement
import kotlinx.serialization.json.jsonPrimitive
import okhttp3.MediaType.Companion.toMediaType
import okhttp3.OkHttpClient
import okhttp3.Request
import okhttp3.Response
import okio.Buffer
import org.slf4j.Logger

internal open class Requests(
  val client: OkHttpClient,
  val logger: Logger,
  val baseUrl: String,
) {
  val mediaType = "application/json; charset=utf-8".toMediaType()

  protected val jsonIg = Json {
    ignoreUnknownKeys = true
  }

  private val jsonIgPr = Json {
    ignoreUnknownKeys = true
    prettyPrint = true
  }

  // note: inline functions are not shown in coverage
  @Suppress("TooGenericExceptionCaught")
  inline fun  tryParseResponse(
    response: Response,
    expectedResponseCode: Int,
    block: (body: String) -> (com.highmobility.hmkitfleet.network.Response)
  ): com.highmobility.hmkitfleet.network.Response {
    val responseBody = printResponse(response)

    return try {
      if (response.code == expectedResponseCode) {
        block(responseBody)
      } else {
        parseError(responseBody)
      }
    } catch (e: Exception) {
      val detail = e.message.toString()
      Response(null, genericError(detail))
    }
  }

  fun printRequest(request: Request) {
    // parse into json, so can log it out with pretty print
    val body = request.bodyAsString()
    var bodyInPrettyPrint = ""
    if (!body.isNullOrBlank()) {
      val jsonElement = jsonIgPr.decodeFromString(body)
      bodyInPrettyPrint = jsonIgPr.encodeToString(jsonElement)
    }

    logger.debug(
      "sending ${request.method} ${request.url}:" +
          "\nheaders: ${request.headers}" +
          "body: $bodyInPrettyPrint"
    )
  }

  fun printResponse(response: Response): String {
    val body = response.body?.string()
    logger.debug("${response.request.url} response:\n${response.code}: $body")
    return body!!
  }

  fun  parseError(responseBody: String): com.highmobility.hmkitfleet.network.Response {
    val json = jsonIg.parseToJsonElement(responseBody)

    return if (json is JsonObject) {
      // there are 3 error formats
      val errors = json["errors"] as? JsonArray
      parseErrorsArray(errors, json)
    } else if (json is JsonArray && json.size > 0) {
      val error = jsonIg.decodeFromJsonElement(json.first())
      Response(null, error)
    } else {
      Response(null, genericError("Unknown server response"))
    }
  }

  private fun  parseErrorsArray(
    errors: JsonArray?,
    json: JsonObject
  ): com.highmobility.hmkitfleet.network.Response = if (errors != null && errors.size > 0) {
    val error =
      jsonIg.decodeFromJsonElement(errors.first())
    Response(null, error)
  } else {
    val error = Error(
      json["error"]?.jsonPrimitive?.content ?: "Unknown server response",
      json["error_description"]?.jsonPrimitive?.content
    )

    Response(null, error)
  }
}

internal fun Request.bodyAsString(): String? {
  if (this.body == null) return null
  val buffer = Buffer()
  this.body?.writeTo(buffer)
  return buffer.readUtf8()
}

internal fun genericError(detail: String? = null): Error {
  val genericError = Error("Unknown server response", detail)
  return genericError
}