Merge pull request #14 from SimpliRoute/FEATURE-DEV423-new_osrm_client

Feature dev423 new osrm client

Author: IvanDanSantos

build.gradle

@@ -18,6 +18,11 @@ dependencies {
     compile 'com.squareup.okhttp3:okhttp:3.12.0'
     compile group: 'com.google.code.gson', name: 'gson', version: '2.7'
     implementation 'com.google.guava:guava:28.1-jre'
+    implementation 'com.fasterxml.jackson.core:jackson-databind:2.12.5'
+
+    compileOnly 'org.projectlombok:lombok:1.18.22'
+    annotationProcessor 'org.projectlombok:lombok:1.18.22'
 
     testCompile group: 'junit', name: 'junit', version: '4.12'
+    testImplementation 'org.projectlombok:lombok:1.18.22'
 }

src/main/java/com/osrm/client/CostMatrices.java

@@ -0,0 +1,11 @@
+package com.osrm.client;
+
+import lombok.Getter;
+import lombok.Setter;
+
+@Getter
+@Setter
+public class CostMatrices {
+  private CostMatrix timeMatrix;
+  private CostMatrix distanceMatrix;
+}

…java/com/osrm/client/DistanceMatrix.java …ain/java/com/osrm/client/CostMatrix.javasrc/main/java/com/osrm/client/DistanceMatrix.java renamed to src/main/java/com/osrm/client/CostMatrix.java src/main/java/com/osrm/client/DistanceMatrix.java renamed to src/main/java/com/osrm/client/CostMatrix.java

@@ -1,35 +1,35 @@
 package com.osrm.client;
 
+import lombok.Getter;
+import lombok.Setter;
+
 import java.util.ArrayList;
 import java.util.List;
 
-public class DistanceMatrix {
+@Getter
+@Setter
+public class CostMatrix {
     private int[][] matrix;
 
-    public DistanceMatrix(int size) {
-        this.matrix = new int[size][size];
+    public double getValueAtCoord(int x, int y) {
+        return this.matrix[x][y];
     }
-
     public void setValueAtCoord(int x, int y, int value) {
         this.matrix[x][y] = value;
     }
 
-    public int getValueAtCoord(int x, int y) {
-        return this.matrix[x][y];
-    }
-
     public List<List<Float>> asList() {
         List<List<Float>> list =  new ArrayList<>();
         for (int x = 0; x < matrix.length; x++) {
             List<Float> row = new ArrayList<>();
             for (int y = 0; y < matrix.length; y++) {
-                Float distance = Float.MAX_VALUE;
+                float cost = Float.MAX_VALUE;
                 try {
-                    distance = Double.valueOf(matrix[x][y]).floatValue();
+                    cost = Double.valueOf(matrix[x][y]).floatValue();
                 } catch (NumberFormatException e) {
                     e.printStackTrace();
                 }
-                row.add(distance);
+                row.add(cost);
             }
             list.add(row);
         }

src/main/java/com/osrm/client/CostService.java

@@ -0,0 +1,8 @@
+package com.osrm.client;
+
+import com.osrm.client.request.CostMatricesRequest;
+
+
+public interface CostService {
+  CostMatrices getCostMatrices(CostMatricesRequest request);
+}

src/main/java/com/osrm/client/DistanceMatrixResponseException.java

@@ -1,37 +1,45 @@
 package com.osrm.client;
+import com.osrm.client.exception.EmptyUrlException;
+import com.osrm.client.request.CostMatricesRequest;
+import com.osrm.client.request.GeoLocation;
+
 import java.util.List;
 import java.util.ArrayList;
 
 public class Main {
     public static void main(String[] args) throws EmptyUrlException {
 
         try {
-            OSRMClient client = new OSRMClient("http://localhost:8008");
+            OSRMClient client = new OSRMClient("http://0.0.0.0:8080");
             List<GeoLocation> locations = new ArrayList<>();
 
-            GeoLocation geo1 = new GeoLocation(-33.416943, -70.60952);
-            GeoLocation geo2 = new GeoLocation(-33.416943, -70.60952);
-            GeoLocation geo3 = new GeoLocation(-33.4445755, -70.6404943);
-            GeoLocation geo4 = new GeoLocation(-33.4457167, -70.61926449999999);
+            GeoLocation geo1 = new GeoLocation(42.5434488, 1.4949332);
+            GeoLocation geo2 = new GeoLocation(42.5434488, 1.395);
 
             locations.add(geo1);
             locations.add(geo2);
-            locations.add(geo3);
-            locations.add(geo4);
 
             // low fmv
             double speedRate = 2;
-            String country = "CL";
+            String country = "AD";
 
             // token
-            String token = "None";
+            String token = "Token TUTOKEN";
 
             String profile = "car";
 
-            OSRMDistanceResponse response = client.getDistanceMatrix(locations, speedRate, country, token, profile,
-                                                                     null);
+            CostMatricesRequest request = CostMatricesRequest.builder()
+                    .speedRate(speedRate)
+                    .country(country)
+                    .locations(locations)
+                    .token(token)
+                    .profile(profile)
+                    .returnDistanceMatrix(true)
+                    .build();
+
+            CostMatrices matrices = client.getCostMatrices(request);
 
-            System.out.println(response);
+            System.out.println(matrices);
         }catch (Exception e){
             e.printStackTrace();
             System.out.println("End with errors.");

src/main/java/com/osrm/client/DistanceResponse.java

@@ -1,11 +1,16 @@
 package com.osrm.client;
 
-import java.io.UnsupportedEncodingException;
-import java.net.URLEncoder;
-import java.nio.charset.StandardCharsets;
+import com.fasterxml.jackson.databind.ObjectMapper;
+
 import java.util.ArrayList;
 import java.util.List;
+import java.util.Map;
 import java.util.concurrent.TimeUnit;
+
+import com.osrm.client.exception.EmptyUrlException;
+import com.osrm.client.exception.OSRMClientException;
+import com.osrm.client.request.CostMatricesRequest;
+import com.osrm.client.request.GeoLocation;
 import okhttp3.MediaType;
 import okhttp3.OkHttpClient;
 import okhttp3.OkHttpClient.Builder;
@@ -14,21 +19,20 @@
 import okhttp3.Response;
 
 
-public class OSRMClient {
+public class OSRMClient implements CostService {
   private final String uri;
+  private static final String ENDPOINT_V2_TABLE = "/v2/table/";
 
   public OSRMClient(String uri) throws EmptyUrlException {
-    if (uri != null || !uri.isEmpty()) {
-      this.uri = uri;
-    } else {
+    if (!stringHasValue(uri)) {
       throw new EmptyUrlException("OSRMClient Constructor requires a OSRM http url");
     }
-  }
 
+    this.uri = uri;
+  }
 
-  public OSRMDistanceResponse getDistanceMatrix(List<GeoLocation> locations, double speedRate, String country,
-                                                String token, String profile,
-                                                String startTime) throws OptimizationDistanceMatrixException {
+  @Override
+  public CostMatrices getCostMatrices(CostMatricesRequest request) {
     Builder requestBuilder = new Builder();
 
     requestBuilder.readTimeout(900000, TimeUnit.MILLISECONDS);
@@ -40,73 +44,50 @@ public OSRMDistanceResponse getDistanceMatrix(List<GeoLocation> locations, doubl
 
     List<String> locationsCollection = new ArrayList<>();
 
-
-    for (GeoLocation geoloc : locations) {
-      locationsCollection.add(geoloc.getLatLongString());
+    for (GeoLocation geolocation : request.getLocations()) {
+      locationsCollection.add(geolocation.getLatLongString());
     }
 
     String paramsString = String.join("&loc=", locationsCollection);
 
-    paramsString += "&speedRate=" + speedRate;
-    paramsString += "&country=" + country;
-    paramsString += encodeStartTime(startTime);
+    paramsString = addParamString(paramsString, "speedRate", Double.toString(request.getSpeedRate()));
+    paramsString = addParamString(paramsString, "country", request.getCountry());
+    paramsString = addParamString(paramsString, "start_time", request.getStartTime());
+    paramsString = addParamString(paramsString, "vehicleSubType", request.getVehicleSubType());
+    paramsString = addParamString(paramsString, "restriction", request.getRestrictionOption());
 
-    RequestBody body = RequestBody.create(mediaType, "loc=" + paramsString);
+    final String metricsParam = request.isReturnDistanceMatrix() ? "time,distance" : "time";
 
-    Request request = new Request.Builder()
-        .url(this.uri + "/table/" + profile)
-        .post(body)
-        .addHeader("Content-Type", "application/x-www-form-urlencoded")
-        .addHeader("Authorization", token)
-        .build();
+    paramsString = addParamString(paramsString, "metrics", metricsParam);
 
-    Response response;
-    try {
-      response = client.newCall(request).execute();
-      if (response.isSuccessful()) {
-        return OSRMDistanceResponse.fromJSON(response.body().string());
-      }
-    } catch (Exception e) {
-      System.out.print(e.getMessage());
-      throw new OptimizationDistanceMatrixException("Error while connecting to OSRM Server");
+    for (Map.Entry<String, Object> paramEntry : request.getCustomParameters().entrySet()) {
+      paramsString = addParamString(paramsString, paramEntry.getKey(), paramEntry.getValue().toString());
     }
 
-    UnsuccessfulResponse unsuccessfulResponse = this.getUnsuccessfulResponse(response);
-    if (unsuccessfulResponse != null && unsuccessfulResponse.getMessage() != null) {
-      throw new DistanceMatrixResponseException("OSRM Error: " + unsuccessfulResponse.getMessage());
-    }
+    RequestBody body = RequestBody.create(mediaType, "loc=" + paramsString);
 
-    throw new DistanceMatrixResponseException("OSRM Error: " + response);
-  }
+    Request osrmRequest = new Request.Builder()
+            .url(this.uri + ENDPOINT_V2_TABLE + request.getProfile())
+            .post(body)
+            .addHeader("Content-Type", "application/x-www-form-urlencoded")
+            .addHeader("Authorization", request.getToken())
+            .build();
 
-  private String encodeStartTime(String startTime) {
-    String paramsString = "";
-    if (startTime == null || startTime.isEmpty()) {
-      return paramsString;
-    }
     try {
-      String encodedStartTime = URLEncoder.encode(startTime, StandardCharsets.UTF_8.toString());
-      paramsString += "&start_time=" + encodedStartTime;
-    } catch (Exception e){
-      throw new OptimizationDistanceMatrixException("Error while encoding startTime parameter");
-    }
-    return paramsString;
-  }
+      Response response = client.newCall(osrmRequest).execute();
 
-  private UnsuccessfulResponse getUnsuccessfulResponse(Response response){
-    try {
-      if (response.body() != null) {
-                  String bodyResponse = response.body().string();
-        UnsuccessfulResponse    unsuccessfulResponse = UnsuccessfulResponse.fromJSON(bodyResponse);
-        if(unsuccessfulResponse.getMessage() == null){
-          return new UnsuccessfulResponse(bodyResponse,String.valueOf(response.code()),"");
-        }
-      }
+      ObjectMapper mapper = new ObjectMapper();
+      return mapper.readValue(response.body().string(), CostMatrices.class);
     } catch (Exception e) {
-      System.out.print("Error getUnsuccessfulResponse.fromJSON: " + e.getMessage());
-                  }
-    return null;
+      throw new OSRMClientException("Error while connecting to OSRM Server");
+    }
   }
 
+  private String addParamString(String paramString, String key, String value) {
+    return stringHasValue(value) ? paramString.concat("&" + key + "=" + value) : paramString;
+  }
 
+  private boolean stringHasValue(String string) {
+    return (string != null) && (!string.equals(""));
+  }
 }