Add optimization endpoint

Author: Pygmalion69

ors-client/src/androidTest/java/org/nitri/ors/OptimizationInstrumentedTest.kt

@@ -0,0 +1,70 @@
+package org.nitri.ors
+
+import android.content.Context
+import androidx.test.core.app.ApplicationProvider
+import androidx.test.ext.junit.runners.AndroidJUnit4
+import kotlinx.coroutines.runBlocking
+import org.junit.Assert.assertNotNull
+import org.junit.Assert.assertTrue
+import org.junit.Test
+import org.junit.runner.RunWith
+import org.nitri.ors.client.OpenRouteServiceClient
+import org.nitri.ors.model.optimization.Job
+import org.nitri.ors.model.optimization.Vehicle
+import org.nitri.ors.repository.OptimizationRepository
+
+@RunWith(AndroidJUnit4::class)
+class OptimizationInstrumentedTest {
+
+    private fun createRepository(context: Context): OptimizationRepository {
+        val apiKey = context.getString(R.string.ors_api_key)
+        val api = OpenRouteServiceClient.create(apiKey, context)
+        return OptimizationRepository(api)
+    }
+
+    @Test
+    fun testOptimization_successful() = runBlocking {
+        val context = ApplicationProvider.getApplicationContext<Context>()
+        val repository = createRepository(context)
+
+        // Simple scenario in/near Heidelberg, Germany
+        val vehicle = Vehicle(
+            id = 1,
+            profile = "driving-car",
+            // Start and end at/near Heidelberg castle parking
+            start = listOf(8.6910, 49.4100),
+            end = listOf(8.6910, 49.4100)
+        )
+
+        val jobs = listOf(
+            Job(
+                id = 101,
+                location = listOf(8.681495, 49.41461) // Heidelberg center
+            ),
+            Job(
+                id = 102,
+                location = listOf(8.687872, 49.420318) // Nearby point
+            )
+        )
+
+        val response = repository.getOptimization(
+            vehicles = listOf(vehicle),
+            jobs = jobs
+        )
+
+        // Basic assertions
+        assertNotNull("Optimization response should not be null", response)
+        assertNotNull("Summary should be present", response.summary)
+        assertTrue("Routes list should be present", response.routes != null)
+        assertTrue("Routes should not be empty for solvable small case", response.routes.isNotEmpty())
+
+        val firstRoute = response.routes.first()
+        assertTrue("Route steps should not be empty", firstRoute.steps.isNotEmpty())
+        // Code is typically 0 for success in VROOM-like APIs; ensure non-negative as a safe check
+        assertTrue("Response code should be non-negative", response.code >= 0)
+
+        // Optional additional sanity checks
+        assertTrue("Total duration should be >= 0", response.summary.duration >= 0)
+        assertTrue("Total service should be >= 0", response.summary.service >= 0)
+    }
+}

ors-client/src/main/java/org/nitri/ors/api/OpenRouteServiceApi.kt

@@ -8,6 +8,8 @@ import org.nitri.ors.model.isochrones.IsochronesRequest
 import org.nitri.ors.model.isochrones.IsochronesResponse
 import org.nitri.ors.model.matrix.MatrixRequest
 import org.nitri.ors.model.matrix.MatrixResponse
+import org.nitri.ors.model.optimization.OptimizationRequest
+import org.nitri.ors.model.optimization.OptimizationResponse
 import org.nitri.ors.model.pois.PoisGeoJsonResponse
 import org.nitri.ors.model.pois.PoisRequest
 import org.nitri.ors.model.route.GeoJsonRouteResponse
@@ -117,4 +119,12 @@ interface OpenRouteServiceApi {
     suspend fun getPois(
         @Body request: PoisRequest
     ): PoisGeoJsonResponse
+
+    // Optimization
+
+    @POST("optimization")
+    suspend fun getOptimization(
+        @Body request: OptimizationRequest
+    ): OptimizationResponse
+
 }

ors-client/src/main/java/org/nitri/ors/client/OpenRouteServiceClient.kt

@@ -45,9 +45,9 @@ object OpenRouteServiceClient {
         val retrofit = Retrofit.Builder()
             .baseUrl("https://api.openrouteservice.org/")
             .client(client)
-            // Support both application/json and application/geo+json content types
-            .addConverterFactory(json.asConverterFactory("application/geo+json".toMediaType()))
+            // Prefer application/json for requests; also support application/geo+json responses
             .addConverterFactory(json.asConverterFactory("application/json".toMediaType()))
+            .addConverterFactory(json.asConverterFactory("application/geo+json".toMediaType()))
             .build()
 
         return retrofit.create()

ors-client/src/main/java/org/nitri/ors/repository/OptimizationRepository.kt

@@ -0,0 +1,46 @@
+package org.nitri.ors.repository
+
+import kotlinx.serialization.json.JsonElement
+import org.nitri.ors.api.OpenRouteServiceApi
+import org.nitri.ors.model.optimization.CustomMatrix
+import org.nitri.ors.model.optimization.Job
+import org.nitri.ors.model.optimization.OptimizationRequest
+import org.nitri.ors.model.optimization.OptimizationResponse
+import org.nitri.ors.model.optimization.Shipment
+import org.nitri.ors.model.optimization.Vehicle
+
+/**
+ * Repository for the OpenRouteService Optimization endpoint.
+ *
+ * This is a thin wrapper around the Retrofit API, similar to other repositories
+ * in this package. The repository builds the OptimizationRequest from the
+ * provided arguments.
+ */
+class OptimizationRepository(private val api: OpenRouteServiceApi) {
+
+    /**
+     * Calls the ORS Optimization endpoint with provided arguments and builds the request.
+     *
+     * @param vehicles Required list of vehicles.
+     * @param jobs Optional list of jobs.
+     * @param shipments Optional list of shipments.
+     * @param matrices Optional custom matrices keyed by profile.
+     * @param options Optional free-form options.
+     */
+    suspend fun getOptimization(
+        vehicles: List<Vehicle>,
+        jobs: List<Job>? = null,
+        shipments: List<Shipment>? = null,
+        matrices: Map<String, CustomMatrix>? = null,
+        options: Map<String, JsonElement>? = null
+    ): OptimizationResponse {
+        val request = OptimizationRequest(
+            jobs = jobs,
+            shipments = shipments,
+            vehicles = vehicles,
+            matrices = matrices,
+            options = options
+        )
+        return api.getOptimization(request)
+    }
+}