Adding closures to route leg. (#1250)

Co-authored-by: Seth Bourget <seth@cafesilencio.net>

Author: Seth Bourget

services-directions-models/src/main/java/com/mapbox/api/directions/v5/models/Closure.java

@@ -0,0 +1,100 @@
+package com.mapbox.api.directions.v5.models;
+
+import androidx.annotation.Nullable;
+
+import com.google.auto.value.AutoValue;
+import com.google.gson.Gson;
+import com.google.gson.GsonBuilder;
+import com.google.gson.TypeAdapter;
+import com.google.gson.annotations.SerializedName;
+import com.mapbox.api.directions.v5.DirectionsAdapterFactory;
+
+/**
+ * An object indicating the geometry indexes defining a road closure.
+ */
+@AutoValue
+public abstract class Closure extends DirectionsJsonObject {
+
+  /**
+   * Closure's geometry index start point.
+   */
+  @Nullable
+  @SerializedName("geometry_index_start")
+  public abstract Integer geometryIndexStart();
+
+  /**
+   * Closure's geometry index end point.
+   */
+  @Nullable
+  @SerializedName("geometry_index_end")
+  public abstract Integer geometryIndexEnd();
+
+  /**
+   * Create a new instance of this class by using the {@link Closure.Builder} class.
+   *
+   * @return this classes {@link Closure.Builder} for creating a new instance
+   */
+  public static Closure.Builder builder() {
+    return new AutoValue_Closure.Builder();
+  }
+
+  /**
+   * Convert the current {@link Closure} to its builder holding the currently assigned
+   * values. This allows you to modify a single property and then rebuild the object resulting in
+   * an updated and modified {@link Closure}.
+   *
+   * @return a {@link Closure.Builder} with the same values set to match the ones
+   *    defined in this {@link Closure}
+   */
+  public abstract Closure.Builder toBuilder();
+
+  /**
+   * Gson type adapter for parsing Gson to this class.
+   *
+   * @param gson the built {@link Gson} object
+   * @return the type adapter for this class
+   */
+  public static TypeAdapter<Closure> typeAdapter(Gson gson) {
+    return new AutoValue_Closure.GsonTypeAdapter(gson);
+  }
+
+  /**
+   * Create a new instance of this class by passing in a formatted valid JSON String.
+   *
+   * @param json a formatted valid JSON string defining an Incident
+   * @return a new instance of this class defined by the values passed in the method
+   */
+  public static Closure fromJson(String json) {
+    GsonBuilder gson = new GsonBuilder();
+    gson.registerTypeAdapterFactory(DirectionsAdapterFactory.create());
+    return gson.create().fromJson(json, Closure.class);
+  }
+
+  /**
+   * This builder can be used to set the values describing the {@link Closure}.
+   */
+  @AutoValue.Builder
+  public abstract static class Builder {
+
+    /**
+     * Closure's geometry index start point.
+     *
+     * @param geometryIndexStart start index
+     */
+    public abstract Builder geometryIndexStart(@Nullable Integer geometryIndexStart);
+
+    /**
+     * Closure's geometry index end point.
+     *
+     * @param geometryIndexEnd end index
+     */
+    public abstract Builder geometryIndexEnd(@Nullable Integer geometryIndexEnd);
+
+    /**
+     * Build a new {@link Closure} object.
+     *
+     * @return a new {@link Closure} using the provided values in this builder
+     */
+    public abstract Closure build();
+  }
+}

services-directions-models/src/main/java/com/mapbox/api/directions/v5/models/RouteLeg.java

@@ -104,6 +104,14 @@ public static Builder builder() {
   @Nullable
   public abstract LegAnnotation annotation();
 
+  /**
+   * A list of closures that occur on this leg.
+   *
+   * @return a list of {@link Incident}
+   */
+  @Nullable
+  public abstract List<Closure> closures();
+
   /**
    * Convert the current {@link RouteLeg} to its builder holding the currently assigned
    * values. This allows you to modify a single property and then rebuild the object resulting in
@@ -226,6 +234,14 @@ public abstract static class Builder {
      */
     public abstract Builder annotation(@Nullable LegAnnotation annotation);
 
+    /**
+     * A list of closures that occur on this leg.
+     *
+     * @param closures a list of {@link Closure}
+     * @return this builder for chaining options together
+     */
+    public abstract Builder closures(@Nullable List<Closure> closures);
+
     /**
      * Build a new {@link RouteLeg} object.
      *

services-directions-models/src/test/java/com/mapbox/api/directions/v5/models/ClosureTest.java

@@ -0,0 +1,52 @@
+package com.mapbox.api.directions.v5.models;
+
+import com.mapbox.core.TestUtils;
+import org.junit.Test;
+
+import static org.junit.Assert.assertEquals;
+import static org.junit.Assert.assertNotNull;
+
+public class ClosureTest extends TestUtils {
+
+    @Test
+    public void sanity(){
+        assertNotNull(getDefault());
+    }
+
+    private Closure getDefault() {
+        return Closure.builder()
+                .geometryIndexStart(3)
+                .geometryIndexEnd(5)
+                .build();
+    }
+
+    @Test
+    public void testSerializableObject() throws Exception {
+        Closure closure = Closure.builder()
+                .geometryIndexStart(3)
+                .geometryIndexEnd(5)
+                .build();
+        byte[] serialized = TestUtils.serialize(closure);
+        assertEquals(closure, deserialize(serialized, Closure.class));
+    }
+
+    @Test
+    public void testSerializableFromJson(){
+        String json = "{\"geometry_index_start\":3,\"geometry_index_end\":5}";
+
+        Closure fromJson = Closure.fromJson(json);
+
+        assertNotNull(fromJson);
+        assertEquals(3L, fromJson.geometryIndexStart().longValue());
+        assertEquals(5L, fromJson.geometryIndexEnd().longValue());
+    }
+
+    @Test
+    public void testFullRoute() throws Exception {
+        String json = loadJsonFixture("directions_v5-with-closure_precision_6.json");
+        DirectionsRoute response = DirectionsRoute.fromJson(json);
+
+        assertEquals(13L, response.legs().get(0).closures().get(0).geometryIndexStart().longValue());
+        assertEquals(21L, response.legs().get(0).closures().get(0).geometryIndexEnd().longValue());
+    }
+}

services-directions-models/src/test/java/com/mapbox/api/directions/v5/models/RouteLegTest.java

@@ -75,6 +75,8 @@ public void testToFromJson1() {
 
     List<Incident> incidents = new ArrayList<>();
 
+    List<Closure> closures = new ArrayList<>();
+
     LegAnnotation annotation = LegAnnotation.builder()
       .congestion(new ArrayList<String>())
       .distance(distanceList)
@@ -89,6 +91,7 @@ public void testToFromJson1() {
       .duration(14.3)
       .steps(steps)
       .incidents(incidents)
+      .closures(closures)
       .summary("")
       .build();
 
@@ -105,20 +108,24 @@ public void testFromJson() {
       + "\"duration\": 14.3,"
       + "\"summary\": \"route summary\","
       + "\"admins\": [{ \"iso_3166_1_alpha3\": \"USA\", \"iso_3166_1\": \"US\" }],"
-      + "\"incidents\": [{ \"id\": \"15985415522454461962\" }]"
-      + "}";
+      + "\"incidents\": [{ \"id\": \"15985415522454461962\" }],"
+      + "\"closures\": [{ \"geometry_index_start\": 1,\"geometry_index_end\": 4}]}";
     List<Admin> admins = new ArrayList<>();
     admins.add(Admin.builder().countryCode("US").countryCodeAlpha3("USA").build());
 
     List<Incident> incidents = new ArrayList<>();
     incidents.add(Incident.builder().id("15985415522454461962").build());
 
+    List<Closure> closures = new ArrayList<>();
+    closures.add(Closure.builder().geometryIndexStart(1).geometryIndexEnd(4).build());
+
     RouteLeg routeLeg = RouteLeg.builder()
       .distance(53.4)
       .duration(14.3)
       .summary("route summary")
       .admins(admins)
       .incidents(incidents)
+      .closures(closures)
       .build();
 
     RouteLeg routeLegFromJson = RouteLeg.fromJson(routeLegJsonString);