NAVAND-1440: add Incident#trafficCodes (#1558)

Author: dzinad

CHANGELOG.md

@@ -3,6 +3,7 @@
 Mapbox welcomes participation and contributions from everyone.
 
 ### main
+- Added `Incident#trafficCodes`.
 
 ### v6.13.0-beta.1 - July 11, 2023
 

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

@@ -213,6 +213,15 @@ public abstract class Incident extends DirectionsJsonObject {
   @SerializedName("alertc_codes")
   public abstract List<Integer> alertcCodes();
 
+  /**
+   * Traffic codes. See {@link TrafficCodes}.
+   *
+   * @return traffic codes
+   */
+  @Nullable
+  @SerializedName("traffic_codes")
+  public abstract TrafficCodes trafficCodes();
+
   /**
    * Incident's leg-wise geometry index start point.
    */
@@ -418,6 +427,14 @@ public abstract static class Builder extends DirectionsJsonObject.Builder<Builde
     @NonNull
     public abstract Builder alertcCodes(@Nullable List<Integer> alertcCodes);
 
+    /**
+     * Traffic codes.
+     *
+     * @param trafficCodes traffic cods. See {@link TrafficCodes}.
+     */
+    @NonNull
+    public abstract Builder trafficCodes(@Nullable TrafficCodes trafficCodes);
+
     /**
      * Incident's leg-wise geometry index start point.
      *

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

@@ -0,0 +1,107 @@
+package com.mapbox.api.directions.v5.models;
+
+import androidx.annotation.NonNull;
+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;
+
+/**
+ * Holds information about traffic codes. See {@link Incident#trafficCodes()}.
+ */
+@AutoValue
+public abstract class TrafficCodes extends DirectionsJsonObject {
+
+  /**
+   * Jartic cause code value.
+   *
+   * @return jartic code cause code value
+   */
+  @Nullable
+  @SerializedName("jartic_cause_code")
+  public abstract Integer jarticCauseCode();
+
+  /**
+   * Jartic regulation code value.
+   *
+   * @return jartic regulation regulation code value
+   */
+  @Nullable
+  @SerializedName("jartic_regulation_code")
+  public abstract Integer jarticRegulationCode();
+
+  /**
+   * Create a new instance of this class by using the {@link Builder} class.
+   *
+   * @return this class's {@link Builder} for creating a new instance
+   */
+  public static Builder builder() {
+    return new AutoValue_TrafficCodes.Builder();
+  }
+
+  /**
+   * Convert the current {@link TrafficCodes} 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 TrafficCodes}.
+   *
+   * @return a {@link Builder} with the same values set to match the ones defined in this
+   * {@link TrafficCodes}
+   */
+  public abstract 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<TrafficCodes> typeAdapter(Gson gson) {
+    return new AutoValue_TrafficCodes.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 a TrafficCodes
+   * @return a new instance of this class defined by the values passed in the method
+   */
+  public static TrafficCodes fromJson(String json) {
+    GsonBuilder gson = new GsonBuilder();
+    gson.registerTypeAdapterFactory(DirectionsAdapterFactory.create());
+    return gson.create().fromJson(json, TrafficCodes.class);
+  }
+
+  /**
+   * This builder can be used to set the values describing the {@link TrafficCodes}.
+   */
+  @AutoValue.Builder
+  public abstract static class Builder extends DirectionsJsonObject.Builder<Builder> {
+
+    /**
+     * Sets jartic cause code value.
+     *
+     * @param value jartic cause code value
+     */
+    @NonNull
+    public abstract Builder jarticCauseCode(@Nullable Integer value);
+
+    /**
+     * Sets jartic regulation code value.
+     *
+     * @param value jartic regulation code value
+     */
+    @NonNull
+    public abstract Builder jarticRegulationCode(@Nullable Integer value);
+
+    /**
+     * Build a new instance of {@link TrafficCodes}.
+     *
+     * @return a new instance of {@link TrafficCodes}.
+     */
+    @NonNull
+    public abstract TrafficCodes build();
+  }
+}

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

@@ -1,10 +1,12 @@
 package com.mapbox.api.directions.v5.models;
 
 import com.google.common.collect.Lists;
+import com.google.gson.JsonPrimitive;
 import com.mapbox.core.TestUtils;
 import org.junit.Test;
 
 import java.util.ArrayList;
+import java.util.Collections;
 
 import static org.junit.Assert.*;
 
@@ -51,6 +53,11 @@ public void deserializeFromJson(){
       "501," +
       "803" +
       "]," +
+      "\"traffic_codes\": {" +
+      "\"jartic_cause_code\": 400," +
+      "\"jartic_regulation_code\": 600," +
+      "\"unknown_code\": 700" +
+      "}," +
       "\"lanes_blocked\": []," +
       "\"num_lanes_blocked\": null," +
       "\"iso_3166_1_alpha2\": US," +
@@ -75,6 +82,9 @@ public void deserializeFromJson(){
     assertEquals(fromJson.subType(), "CONSTRUCTION");
     assertEquals(fromJson.subTypeDescription(), "construction");
     assertEquals(fromJson.alertcCodes().size(), 2);
+    assertEquals(400, (int) fromJson.trafficCodes().jarticCauseCode());
+    assertEquals(600, (int) fromJson.trafficCodes().jarticRegulationCode());
+    assertEquals(700, fromJson.trafficCodes().getUnrecognizedJsonProperties().get("unknown_code").getAsInt());
     assertEquals(fromJson.geometryIndexStart().longValue(), 805L);
     assertEquals(fromJson.geometryIndexEnd().longValue(), 896L);
     assertEquals(fromJson.countryCodeAlpha2(), "US");
@@ -94,6 +104,15 @@ private Incident getFilledIncident() {
     return Incident.builder()
       .id("some_id")
       .alertcCodes(Lists.newArrayList(431, 2123, 934))
+      .trafficCodes(
+        TrafficCodes.builder()
+          .jarticCauseCode(400)
+          .jarticRegulationCode(600)
+          .unrecognizedJsonProperties(
+            Collections.singletonMap("unknown_code", new JsonPrimitive((700)))
+          )
+          .build()
+      )
       .closed(true)
       .congestion(Congestion.builder().value(10).build())
       .creationTime("2020-11-18T11:34:14Z")

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

@@ -0,0 +1,76 @@
+package com.mapbox.api.directions.v5.models;
+
+import com.google.gson.JsonPrimitive;
+import com.mapbox.core.TestUtils;
+import org.junit.Test;
+
+import java.util.Collections;
+
+import static org.junit.Assert.assertEquals;
+import static org.junit.Assert.assertNotNull;
+import static org.junit.Assert.assertNull;
+
+public class TrafficCodesTest extends TestUtils {
+
+  @Test
+  public void sanity() {
+    assertNotNull(getDefault());
+  }
+
+  @Test
+  public void serialize() throws Exception {
+    TrafficCodes trafficCodes = getFilledTrafficCodes();
+    byte[] serialized = TestUtils.serialize(trafficCodes);
+    assertEquals(trafficCodes, deserialize(serialized, TrafficCodes.class));
+  }
+
+  @Test
+  public void toAndFromJson() {
+    TrafficCodes source = getFilledTrafficCodes();
+
+    String json = source.toJson();
+    TrafficCodes serialized = TrafficCodes.fromJson(json);
+
+    assertEquals(source, serialized);
+  }
+
+  @Test
+  public void deserializeFromJson() {
+    String json = "{" +
+      "\"jartic_cause_code\": 400," +
+      "\"jartic_regulation_code\": 600," +
+      "\"unknown_code\": 700" +
+      "}";
+
+    TrafficCodes fromJson = TrafficCodes.fromJson(json);
+
+    assertNotNull(fromJson);
+    assertEquals(400, (int) fromJson.jarticCauseCode());
+    assertEquals(600, (int) fromJson.jarticRegulationCode());
+    assertEquals(700, fromJson.getUnrecognizedJsonProperties().get("unknown_code").getAsInt());
+  }
+
+  @Test
+  public void deserializeFromEmptyJson() {
+    TrafficCodes fromJson = TrafficCodes.fromJson("{}");
+
+    assertNotNull(fromJson);
+    assertNull(fromJson.jarticCauseCode());
+    assertNull(fromJson.jarticRegulationCode());
+    assertNull(fromJson.getUnrecognizedJsonProperties());
+  }
+
+  private TrafficCodes getDefault() {
+    return TrafficCodes.builder().build();
+  }
+
+  private TrafficCodes getFilledTrafficCodes() {
+    return TrafficCodes.builder()
+      .jarticCauseCode(400)
+      .jarticRegulationCode(600)
+      .unrecognizedJsonProperties(
+        Collections.singletonMap("unknown_code", new JsonPrimitive((700)))
+      )
+      .build();
+  }
+}