Merge pull request #38 from highmobility/static-data

add static data request

CHANGELOG.md

@@ -2,6 +2,12 @@
 
 This is the changelog for v2 releases. See v0/v1 releases in appropriate branches.
 
+## [2.1.0] - 2024-4-23
+
+### Added
+
+- Vehicle static data request
+
 ## [2.0.4] - 2024-3-14
 
 ### Added

gradle.properties

@@ -1,2 +1,2 @@
-version=2.0.4
+version=2.1.0
 kotlin.code.style=official

gradle/deploy-ossrh.gradle

@@ -37,7 +37,7 @@ def deployGitUrl="https://github.com/highmobility/hmkit-fleet"
 def deployGroupId="com.high-mobility"
 def deployLicenseName="MIT"
 def deployLicenseUrl="https://opensource.org/licenses/MIT"
-def deployId=name
+def deployId="hmkit-fleet"
 
 def isAndroid = project.plugins.findPlugin("com.android.library")
 

hmkit-fleet/src/main/kotlin/com/highmobility/hmkitfleet/HMKitFleet.kt

@@ -135,12 +135,28 @@ class HMKitFleet constructor(
     koin.get<ClearanceRequests>().deleteClearance(vin)
   }
 
+  /**
+   * Get vehicle status JSON string from the [Vehicle Data API](https://docs.high-mobility.com/api-references/code-references/vehicle-data/reference/v1/)
+   *
+   * Read more in the [Vehicle Data API Tutorial](https://docs.high-mobility.com/guides/getting-started/rest/)
+   */
   fun getVehicleState(
     vin: String
   ): CompletableFuture<Response<String>> = scope.future {
     koin.get<VehicleDataRequests>().getVehicleStatus(vin)
   }
 
+  /**
+   * Get the static information about a vehicle. Static data can include the vehicle's brand, equipment and more.
+   *
+   * Read more in the [Static Data API Tutorial](https://docs.high-mobility.com/guides/getting-started/static-data-api/)
+   */
+  fun getVehicleStaticData(
+    vin: String
+  ): CompletableFuture<Response<String>> = scope.future {
+    koin.get<VehicleDataRequests>().getStaticData(vin)
+  }
+
   /**
    * The Fleet SDK environment.
    *

hmkit-fleet/src/main/kotlin/com/highmobility/hmkitfleet/network/VehicleDataRequests.kt

@@ -62,4 +62,28 @@ internal class VehicleDataRequests(
       Response(responseBody, null)
     }
   }
+
+  suspend fun getStaticData(
+    vin: String,
+  ): Response<String> {
+    val authToken = accessTokenRequests.getAccessToken()
+
+    if (authToken.error != null) return Response(null, authToken.error)
+
+    val request = Request.Builder()
+      .url("$baseUrl/vehicle-static-data/$vin")
+      .header("Content-Type", "application/json")
+      .header("Authorization", "Bearer ${authToken.response?.accessToken}")
+      .get()
+      .build()
+
+    printRequest(request)
+
+    val call = client.newCall(request)
+    val response = call.await()
+
+    return tryParseResponse(response, HttpURLConnection.HTTP_OK) { responseBody ->
+      Response(responseBody, null)
+    }
+  }
 }

hmkit-fleet/src/test/kotlin/com/highmobility/hmkitfleet/HMKitFleetTest.kt

@@ -41,6 +41,7 @@ import kotlinx.coroutines.runBlocking
 import kotlinx.coroutines.test.runTest
 import kotlinx.serialization.json.Json
 import kotlinx.serialization.json.JsonObject
+import kotlinx.serialization.json.jsonObject
 import kotlinx.serialization.json.jsonPrimitive
 import okhttp3.mockwebserver.MockResponse
 import okhttp3.mockwebserver.MockWebServer
@@ -145,6 +146,40 @@ class HMKitFleetTest : BaseTest() {
     assertTrue(json["vin"]?.jsonPrimitive?.content == "vin1")
   }
 
+  @Test
+  fun getVehicleStaticData() = runTest {
+    coEvery {
+      vehicleDataRequests.getStaticData("vin1")
+    } returns Response(
+      """
+        {
+          "manufacturer": {
+              "brand": "Jeep",
+              "sub_model": "80th Anniversary Plug-In Hybrid 4WD",
+              "type_group_name": "Compass",
+              "model": "Compass (M7)(2020->)",
+              "sales_description": "Compass 1.3 Plug-In Hybrid (EURO 6d) 80th Annivers"
+          },
+          "equipment": {
+              "series_equipment": [
+                  {
+                      "description": "airbag driver side/passenger side",
+                      "positions": [],
+                      "manufacturer_id": null
+                  }
+              ]
+          }
+      }
+      """.trimIndent(),
+      null
+    )
+
+    val hmkit = HMKitFleet(oauthCredentials)
+    val staticData = hmkit.getVehicleStaticData("vin1").get()
+    val json = Json.decodeFromString<JsonObject>(staticData.response ?: "")
+    assertTrue(json["manufacturer"]?.jsonObject?.get("brand")?.jsonPrimitive?.content == "Jeep")
+  }
+
   @Test
   fun canSetCustomWebUrl() {
     stopKoin()

hmkit-fleet/src/test/kotlin/com/highmobility/hmkitfleet/network/VehicleDataRequestsTest.kt

@@ -74,18 +74,18 @@ internal class VehicleDataRequestsTest : BaseTest() {
   )
 
   @Test
-  fun getSuccess() {
+  fun vehicleStatusSuccess() {
     successResponses.forEach {
       val responseJson = it
 
       val mockResponse = MockResponse().setResponseCode(HttpURLConnection.HTTP_OK).setBody(responseJson)
 
       mockWebServer.enqueue(mockResponse)
       val mockUrl = mockWebServer.url("").toString()
-      val webService = VehicleDataRequests(client, mockLogger, mockUrl, accessTokenRequests)
+      val requests = VehicleDataRequests(client, mockLogger, mockUrl, accessTokenRequests)
 
       val response = runBlocking {
-        webService.getVehicleStatus(testVin)
+        requests.getVehicleStatus(testVin)
       }
 
       coVerify { accessTokenRequests.getAccessToken() }
@@ -103,31 +103,91 @@ internal class VehicleDataRequestsTest : BaseTest() {
   }
 
   @Test
-  fun authTokenError() = runBlocking {
+  fun vehicleStatusAuthTokenError() = runBlocking {
     testAuthTokenErrorReturned(mockWebServer, accessTokenRequests) { mockUrl ->
-      val webService = VehicleDataRequests(client, mockLogger, mockUrl, accessTokenRequests)
-      webService.getVehicleStatus(
+      val requests = VehicleDataRequests(client, mockLogger, mockUrl, accessTokenRequests)
+      requests.getVehicleStatus(
         testVin,
       )
     }
   }
 
   @Test
-  fun requestClearanceErrorResponse() = runBlocking {
+  fun vehicleStatusErrorResponse() = runBlocking {
     testErrorResponseReturned(mockWebServer) { mockUrl ->
-      val webService = VehicleDataRequests(client, mockLogger, mockUrl, accessTokenRequests)
+      val requests = VehicleDataRequests(client, mockLogger, mockUrl, accessTokenRequests)
 
-      webService.getVehicleStatus(
+      requests.getVehicleStatus(
         testVin,
       )
     }
   }
 
   @Test
-  fun requestClearanceUnknownResponse() = runBlocking {
+  fun vehicleStatusUnknownResponse() = runBlocking {
     testForUnknownResponseGenericErrorReturned(mockWebServer) { mockUrl ->
-      val webService = VehicleDataRequests(client, mockLogger, mockUrl, accessTokenRequests)
-      webService.getVehicleStatus(
+      val requests = VehicleDataRequests(client, mockLogger, mockUrl, accessTokenRequests)
+      requests.getVehicleStatus(
+        testVin,
+      )
+    }
+  }
+
+  @Test
+  fun vehicleStaticDataSuccess() {
+    successResponses.forEach {
+      val responseJson = it
+
+      val mockResponse = MockResponse().setResponseCode(HttpURLConnection.HTTP_OK).setBody(responseJson)
+
+      mockWebServer.enqueue(mockResponse)
+      val mockUrl = mockWebServer.url("").toString()
+      val requests = VehicleDataRequests(client, mockLogger, mockUrl, accessTokenRequests)
+
+      val response = runBlocking {
+        requests.getStaticData(testVin)
+      }
+
+      coVerify { accessTokenRequests.getAccessToken() }
+
+      val recordedRequest: RecordedRequest = mockWebServer.takeRequest()
+      assertTrue(recordedRequest.path!!.endsWith("/vehicle-static-data/$testVin"))
+
+      // verify request
+      assertTrue(recordedRequest.headers["Authorization"] == "Bearer ${authToken.accessToken}")
+
+      // verify response
+      val status = response.response!!
+      assertTrue(status == responseJson)
+    }
+  }
+
+  @Test
+  fun vehicleStaticDataAuthTokenError() = runBlocking {
+    testAuthTokenErrorReturned(mockWebServer, accessTokenRequests) { mockUrl ->
+      val requests = VehicleDataRequests(client, mockLogger, mockUrl, accessTokenRequests)
+      requests.getStaticData(
+        testVin,
+      )
+    }
+  }
+
+  @Test
+  fun vehicleStaticDataErrorResponse() = runBlocking {
+    testErrorResponseReturned(mockWebServer) { mockUrl ->
+      val requests = VehicleDataRequests(client, mockLogger, mockUrl, accessTokenRequests)
+
+      requests.getStaticData(
+        testVin,
+      )
+    }
+  }
+
+  @Test
+  fun vehicleStaticDataUnknownResponse() = runBlocking {
+    testForUnknownResponseGenericErrorReturned(mockWebServer) { mockUrl ->
+      val requests = VehicleDataRequests(client, mockLogger, mockUrl, accessTokenRequests)
+      requests.getStaticData(
         testVin,
       )
     }