NAVAND-836: add RouteOptions#suppressVoiceInstructionLocalNames

Author: dzinad

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

@@ -932,6 +932,20 @@ public List<String> paymentMethodsList() {
     return ParseUtils.parseToStrings(paymentMethods(), ",");
   }
 
+  /*
+   * If true, steps.voiceInstructions will omit any named maneuever points along the route
+   * (e.g. street name, intersection name, JCT, IC) when the language parameter does not match
+   * the default language(s) for that region. For example, if the `language` parameter is `de`
+   * and a user is routing in France, a user would hear "turn left" instead of "turn
+   * left onto Champs Elysee".
+   *
+   * @return boolean representing the `suppressVoiceInstructionLocalNames` value
+   */
+  @SuppressWarnings("checkstyle:javadocmethod")
+  @SerializedName("suppress_voice_instruction_local_names")
+  @Nullable
+  public abstract Boolean suppressVoiceInstructionLocalNames();
+
   /**
    * Gson type adapter for parsing Gson to this class.
    *
@@ -1069,6 +1083,11 @@ public URL toUrl(@NonNull String accessToken) {
     appendQueryParameter(sb, "waypoints_per_route", waypointsPerRoute());
     appendQueryParameter(sb, "metadata", metadata());
     appendQueryParameter(sb, "payment_methods", paymentMethods());
+    appendQueryParameter(
+      sb,
+      "suppress_voice_instruction_local_names",
+      suppressVoiceInstructionLocalNames()
+    );
 
     Map<String, SerializableJsonElement> unrecognized = unrecognized();
     if (unrecognized != null) {
@@ -2091,6 +2110,23 @@ public Builder snappingIncludeStaticClosuresList(
     @NonNull
     public abstract Builder metadata(@Nullable Boolean metadata);
 
+    /*
+     * If true, steps.voiceInstructions will omit any named maneuever points along the route
+     * (e.g. street name, intersection name, JCT, IC) when the language parameter does not match
+     * the default language(s) for that region. For example, if the `language` parameter is `de`
+     * and a user is routing in France, a user would hear "turn left" instead of "turn
+     * left onto Champs Elysee".
+     *
+     * @param suppressVoiceInstructionLocalNames boolean representing
+     *                                           the `suppressVoiceInstructionLocalNames` value
+     * @return this builder
+     */
+    @SuppressWarnings("checkstyle:javadocmethod")
+    @NonNull
+    public abstract Builder suppressVoiceInstructionLocalNames(
+      @Nullable Boolean suppressVoiceInstructionLocalNames
+    );
+
     /**
      * Use this method to add request parameters,
      * which are not present in the model yet but are supported on the Directions API,

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

@@ -38,7 +38,7 @@ public class RouteOptionsTest extends TestUtils {
    */
   private static final String ROUTE_OPTIONS_JSON = "route_options_v5.json";
   private static final String ROUTE_OPTIONS_URL =
-    "https://api.mapbox.com/directions/v5/mapbox/driving/-122.4003312,37.7736941;-122.4187529,37.7689715;-122.4255172,37.7775835?access_token=pk.token&geometries=polyline6&alternatives=false&overview=full&radiuses=%3Bunlimited%3B5.1&steps=true&avoid_maneuver_radius=200.0&bearings=0%2C90%3B90%2C0%3B&layers=-42%3B%3B0&continue_straight=false&annotations=congestion%2Cdistance%2Cduration&language=ru&roundabout_exits=false&voice_instructions=true&banner_instructions=true&voice_units=metric&exclude=toll%2Cferry%2Cpoint%2811.0+-22.0%29&include=hot%2Chov2&approaches=%3Bcurb%3B&waypoints=0%3B1%3B2&waypoint_names=%3BSerangoon+Garden+Market+%26+Food+Centre%3BFunky+%26nAmE*&waypoint_targets=%3B12.2%2C21.2%3B&enable_refresh=true&walking_speed=5.11&walkway_bias=-0.2&alley_bias=0.75&snapping_include_closures=%3Bfalse%3Btrue&snapping_include_static_closures=true%3B%3Bfalse&arrive_by=2021-01-01%27T%2701%3A01&depart_at=2021-02-02%27T%2702%3A02&max_height=1.5&max_width=1.4&max_weight=2.9&compute_toll_cost=true&waypoints_per_route=true&metadata=true&payment_methods=general";
+    "https://api.mapbox.com/directions/v5/mapbox/driving/-122.4003312,37.7736941;-122.4187529,37.7689715;-122.4255172,37.7775835?access_token=pk.token&geometries=polyline6&alternatives=false&overview=full&radiuses=%3Bunlimited%3B5.1&steps=true&avoid_maneuver_radius=200.0&bearings=0%2C90%3B90%2C0%3B&layers=-42%3B%3B0&continue_straight=false&annotations=congestion%2Cdistance%2Cduration&language=ru&roundabout_exits=false&voice_instructions=true&banner_instructions=true&voice_units=metric&exclude=toll%2Cferry%2Cpoint%2811.0+-22.0%29&include=hot%2Chov2&approaches=%3Bcurb%3B&waypoints=0%3B1%3B2&waypoint_names=%3BSerangoon+Garden+Market+%26+Food+Centre%3BFunky+%26nAmE*&waypoint_targets=%3B12.2%2C21.2%3B&enable_refresh=true&walking_speed=5.11&walkway_bias=-0.2&alley_bias=0.75&snapping_include_closures=%3Bfalse%3Btrue&snapping_include_static_closures=true%3B%3Bfalse&arrive_by=2021-01-01%27T%2701%3A01&depart_at=2021-02-02%27T%2702%3A02&max_height=1.5&max_width=1.4&max_weight=2.9&compute_toll_cost=true&waypoints_per_route=true&metadata=true&payment_methods=general&suppress_voice_instruction_local_names=true";
   private static final String ACCESS_TOKEN = "pk.token";
 
   private final String optionsJson = loadJsonFixture(ROUTE_OPTIONS_JSON);
@@ -350,6 +350,13 @@ public void computeTollCostIsValid_fromJson() {
     assertEquals(true, options.computeTollCost());
   }
 
+  @Test
+  public void suppressVoiceInstructionLocalNamesIsValid_fromJson() {
+    RouteOptions options = RouteOptions.fromJson(optionsJson);
+
+    assertEquals(true, options.suppressVoiceInstructionLocalNames());
+  }
+
   @Test
   public void waypointsPerRouteAreValid_fromJson() {
     RouteOptions routeOptions = RouteOptions.fromJson(optionsJson);
@@ -364,6 +371,13 @@ public void defaultTollCost() {
     assertNull(options.computeTollCost());
   }
 
+  @Test
+  public void defaultSuppressVoiceInstructionLocalNames() {
+    RouteOptions options = defaultRouteOptions();
+
+    assertNull(options.suppressVoiceInstructionLocalNames());
+  }
+
   @Test
   public void defaultWaypointsPerRoute() {
     RouteOptions options = defaultRouteOptions();
@@ -1102,6 +1116,7 @@ private RouteOptions routeOptions() {
       .computeTollCost(true)
       .waypointsPerRoute(true)
       .paymentMethods(DirectionsCriteria.PAYMENT_METHOD_GENERAL)
+      .suppressVoiceInstructionLocalNames(true)
       .build();
   }
 
@@ -1209,6 +1224,7 @@ private RouteOptions routeOptionsList() {
       .metadata(true)
       .computeTollCost(true)
       .waypointsPerRoute(true)
+      .suppressVoiceInstructionLocalNames(true)
       .paymentMethodsList(Arrays.asList(DirectionsCriteria.PAYMENT_METHOD_GENERAL))
       .build();
   }

services-directions-models/src/test/resources/route_options_v5.json

@@ -38,5 +38,6 @@
   "metadata": true,
   "waypoints_per_route": true,
   "compute_toll_cost": true,
-  "payment_methods": "general"
+  "payment_methods": "general",
+  "suppress_voice_instruction_local_names": true
 }

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

@@ -103,7 +103,8 @@ Call<DirectionsResponse> getCall(
     @Query("compute_toll_cost") Boolean computeTollCost,
     @Query("waypoints_per_route") Boolean waypointsPerRoute,
     @Query("metadata") Boolean metadata,
-    @Query("payment_methods") String paymentMethods
+    @Query("payment_methods") String paymentMethods,
+    @Query("suppress_voice_instruction_local_names") Boolean suppressVoiceInstructionLocalNames
   );
 
   /**
@@ -193,6 +194,7 @@ Call<DirectionsResponse> postCall(
     @Field("compute_toll_cost") Boolean computeTollCost,
     @Field("waypoints_per_route") Boolean waypointsPerRoute,
     @Field("metadata") Boolean metadata,
-    @Field("payment_methods") String paymentMethods
+    @Field("payment_methods") String paymentMethods,
+    @Field("suppress_voice_instruction_local_names") Boolean suppressVoiceInstructionLocalNames
   );
 }

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

@@ -112,7 +112,8 @@ private Call<DirectionsResponse> get() {
       routeOptions().computeTollCost(),
       routeOptions().waypointsPerRoute(),
       routeOptions().metadata(),
-      routeOptions().paymentMethods()
+      routeOptions().paymentMethods(),
+      routeOptions().suppressVoiceInstructionLocalNames()
     );
   }
 
@@ -158,7 +159,8 @@ private Call<DirectionsResponse> post() {
       routeOptions().computeTollCost(),
       routeOptions().waypointsPerRoute(),
       routeOptions().metadata(),
-      routeOptions().paymentMethods()
+      routeOptions().paymentMethods(),
+      routeOptions().suppressVoiceInstructionLocalNames()
     );
   }
 

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

@@ -732,6 +732,17 @@ public void computeTollCost() throws Exception {
             mapboxDirections.cloneCall().request().url().queryParameter("compute_toll_cost"));
   }
 
+  @Test
+  public void suppressVoiceInstructionLocalNames() throws Exception {
+    MapboxDirections mapboxDirections = MapboxDirections.builder()
+      .accessToken("token")
+      .routeOptions(routeOptions.toBuilder().baseUrl(mockUrl.toString()).build())
+      .build();
+
+    assertEquals("true",
+      mapboxDirections.cloneCall().request().url().queryParameter("suppress_voice_instruction_local_names"));
+  }
+
   @Test
   public void waypointsPerRoute() throws Exception {
     MapboxDirections mapboxDirections = MapboxDirections.builder()

services-directions/src/test/resources/route_options_v5.json

@@ -38,5 +38,6 @@
   "compute_toll_cost": true,
   "waypoints_per_route": true,
   "metadata": true,
-  "payment_methods": "general,etcx"
+  "payment_methods": "general,etcx",
+  "suppress_voice_instruction_local_names": true
 }