Add voiceLocale to DirectionsRoute and update test fixtures (#804)

* Add voiceLocale to DirectionsRoute and update test fixtures

* Change voiceLocale to voiceLanguage

Author: danesfeder

Makefile

@@ -102,6 +102,10 @@ directions-fixtures:
 	curl "https://api.mapbox.com/directions/v5/mapbox/driving/-77.04014240930304,38.91313201360546;-77.04573453985853,38.90725177816208.json?steps=true&overview=full&geometries=polyline6&roundabout_exits=true&voice_instructions=true&banner_instructions=true&access_token=$(MAPBOX_ACCESS_TOKEN)" \
     		-o services-directions/src/test/resources/directions_v5_voice_banner.json
 
+	# Directions: voice announcements invalid locale
+	curl "https://api.mapbox.com/directions/v5/mapbox/driving/-77.04014240930304,38.91313201360546;-77.04573453985853,38.90725177816208.json?steps=true&overview=full&geometries=polyline6&roundabout_exits=true&voice_instructions=true&language=he&access_token=$(MAPBOX_ACCESS_TOKEN)" \
+    		-o services-directions/src/test/resources/directions_v5_voice_invalid.json
+
 	# Directions: No route found
 	curl "https://api.mapbox.com/directions/v5/mapbox/driving/149.72227,-37.59764;170.72975,-42.96489.json?steps=true&overview=full&geometries=polyline6&roundabout_exits=true&voice_instructions=true&banner_instructions=true&access_token=$(MAPBOX_ACCESS_TOKEN)" \
 	  		-o services-directions/src/test/resources/directions_v5_no_route.json

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

@@ -123,6 +123,18 @@ public static DirectionsRoute fromJson(String json) {
   @Nullable
   public abstract RouteOptions routeOptions();
 
+
+  /**
+   * String of the language to be used for voice instructions.  Defaults to en, and
+   * can be any accepted instruction language.
+   *
+   * @return String compatible with voice instructions, null otherwise
+   * @since 3.1.0
+   */
+  @Nullable
+  @SerializedName("voiceLocale")
+  public abstract String voiceLanguage();
+
   /**
    * Convert the current {@link DirectionsRoute} to its builder holding the currently assigned
    * values. This allows you to modify a single property and then rebuild the object resulting in
@@ -219,6 +231,16 @@ public abstract static class Builder {
      */
     public abstract Builder routeOptions(@Nullable RouteOptions routeOptions);
 
+    /**
+     * String of the language to be used for voice instructions.  Defaults to en, and
+     * can be any accepted instruction language.
+     *
+     * @param voiceLanguage String compatible with voice instructions, null otherwise
+     * @return this builder for chaining options together
+     * @since 3.1.0
+     */
+    public abstract Builder voiceLanguage(@Nullable String voiceLanguage);
+
     /**
      * Build a new {@link DirectionsRoute} object.
      *

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

@@ -1,13 +1,19 @@
 package com.mapbox.api.directions.v5.models;
 
-import static org.junit.Assert.assertEquals;
-import static org.junit.Assert.assertNotNull;
-
 import com.mapbox.core.TestUtils;
+
 import org.junit.Test;
 
+import static org.junit.Assert.assertEquals;
+import static org.junit.Assert.assertNotNull;
+import static org.junit.Assert.assertNull;
+
 public class DirectionsRouteTest extends TestUtils {
 
+  private static final String DIRECTIONS_V5_VOICE_BANNER_FIXTURE = "directions_v5_voice_banner.json";
+  private static final String DIRECTIONS_V5_VOICE_INVALID_FIXTURE = "directions_v5_voice_invalid.json";
+  private static final int FIRST_ROUTE = 0;
+
   @Test
   public void sanity() throws Exception {
     DirectionsRoute route = DirectionsRoute.builder()
@@ -22,4 +28,26 @@ public void testSerializable() throws Exception {
     byte[] serialized = TestUtils.serialize(route);
     assertEquals(route, deserialize(serialized, DirectionsRoute.class));
   }
+
+  @Test
+  public void directionsRoute_doesReturnVoiceLocale() throws Exception {
+    String json = loadJsonFixture(DIRECTIONS_V5_VOICE_BANNER_FIXTURE);
+    DirectionsResponse response = DirectionsResponse.fromJson(json);
+    DirectionsRoute route = response.routes().get(FIRST_ROUTE);
+
+    String voiceLanguage = route.voiceLanguage();
+
+    assertEquals("en-US", voiceLanguage);
+  }
+
+  @Test
+  public void directionsRouteWithInvalidLanguage_doesReturnNullVoiceLanguage() throws Exception {
+    String json = loadJsonFixture(DIRECTIONS_V5_VOICE_INVALID_FIXTURE);
+    DirectionsResponse response = DirectionsResponse.fromJson(json);
+    DirectionsRoute route = response.routes().get(FIRST_ROUTE);
+
+    String voiceLanguage = route.voiceLanguage();
+
+    assertNull(voiceLanguage);
+  }
 }

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

@@ -1 +1 @@
-{"routes":[{"geometry":"yjzbFfcygVV?vA?P@NAzAa@VGX`BRbAF\\@`@?P","legs":[{"summary":"Infinite Loop, Mariani Avenue","weight":77.2,"duration":66.4,"steps":[{"intersections":[{"out":0,"entry":[true],"bearings":[180],"location":[-122.03076,37.331808]},{"out":1,"in":0,"entry":[false,true,true],"bearings":[0,180,270],"location":[-122.03076,37.331686]},{"out":1,"in":0,"entry":[false,true,true],"bearings":[0,165,270],"location":[-122.030765,37.331157]}],"driving_side":"right","geometry":"yjzbFfcygVV?vA?P@NAzAa@VG","mode":"driving","maneuver":{"bearing_after":180,"bearing_before":0,"location":[-122.03076,37.331808],"modifier":"left","type":"depart","instruction":"Head south on Infinite Loop"},"weight":52.8,"duration":42.1,"name":"Infinite Loop","distance":148,"voiceInstructions":[{"distanceAlongGeometry":148,"announcement":"Head south on Infinite Loop, then turn right onto Mariani Avenue","ssmlAnnouncement":"<speak><amazon:effect name=\"drc\"><prosody rate=\"1.08\">Head south on Infinite Loop, then turn right onto Mariani Avenue</prosody></amazon:effect></speak>"},{"distanceAlongGeometry":52.7,"announcement":"Turn right onto Mariani Avenue, then you will arrive at your destination","ssmlAnnouncement":"<speak><amazon:effect name=\"drc\"><prosody rate=\"1.08\">Turn right onto Mariani Avenue, then you will arrive at your destination</prosody></amazon:effect></speak>"}],"bannerInstructions":[{"distanceAlongGeometry":148,"primary":{"type":"turn","modifier":"right","components":[{"text":"Mariani Avenue","type":"text","abbr":"Mariani Ave","abbr_priority":0}],"text":"Mariani Avenue"},"secondary":null}]},{"intersections":[{"out":1,"in":2,"entry":[true,true,false],"bearings":[90,255,345],"location":[-122.03055,37.3305]}],"driving_side":"right","geometry":"sbzbF|aygVX`BRbAF\\@`@?P","mode":"driving","maneuver":{"bearing_after":250,"bearing_before":163,"location":[-122.03055,37.3305],"modifier":"right","type":"end of road","instruction":"Turn right onto Mariani Avenue"},"weight":24.4,"duration":24.3,"name":"Mariani Avenue","distance":114.5,"voiceInstructions":[{"distanceAlongGeometry":14.1,"announcement":"You have arrived at your destination","ssmlAnnouncement":"<speak><amazon:effect name=\"drc\"><prosody rate=\"1.08\">You have arrived at your destination</prosody></amazon:effect></speak>"}],"bannerInstructions":[{"distanceAlongGeometry":114.5,"primary":{"type":"arrive","modifier":"straight","components":[{"text":"You will arrive","type":"text"}],"text":"You will arrive"},"secondary":{"type":"arrive","modifier":"straight","components":[{"text":"Mariani Avenue","type":"text","abbr":"Mariani Ave","abbr_priority":0}],"text":"Mariani Avenue"}},{"distanceAlongGeometry":15,"primary":{"type":"arrive","modifier":"straight","components":[{"text":"You have arrived","type":"text"}],"text":"You have arrived"},"secondary":{"type":"arrive","modifier":"straight","components":[{"text":"Mariani Avenue","type":"text","abbr":"Mariani Ave","abbr_priority":0}],"text":"Mariani Avenue"}}]},{"intersections":[{"in":0,"entry":[true],"bearings":[90],"location":[-122.031787,37.330217]}],"driving_side":"right","geometry":"{`zbFtiygV","mode":"driving","maneuver":{"bearing_after":0,"bearing_before":270,"location":[-122.031787,37.330217],"type":"arrive","instruction":"You have arrived at your destination"},"weight":0,"duration":0,"name":"Mariani Avenue","distance":0,"voiceInstructions":[],"bannerInstructions":[]}],"distance":262.5}],"weight_name":"routability","weight":77.2,"duration":66.4,"distance":262.5,"voiceLocale":"en-US"}],"waypoints":[{"name":"Infinite Loop","location":[-122.03076,37.331808]},{"name":"Mariani Avenue","location":[-122.031787,37.330217]}],"code":"Ok","uuid":"cjfe60xo206wx42pbqmyydvfy"}
+{"routes":[{"geometry":"yjzbFfcygVV?vA?P@NAzAa@VGX`BRbAF\\@`@?P","legs":[{"summary":"Infinite Loop, Mariani Avenue","weight":78.8,"duration":68,"steps":[{"intersections":[{"out":0,"entry":[true],"bearings":[180],"location":[-122.03076,37.331808]},{"out":1,"in":0,"entry":[false,true,true],"bearings":[0,180,270],"location":[-122.03076,37.331686]},{"out":1,"in":0,"entry":[false,true,true],"bearings":[0,165,270],"location":[-122.030765,37.331157]}],"driving_side":"right","geometry":"yjzbFfcygVV?vA?P@NAzAa@VG","mode":"driving","maneuver":{"bearing_after":180,"bearing_before":0,"location":[-122.03076,37.331808],"modifier":"left","type":"depart","instruction":"Head south on Infinite Loop"},"weight":52.8,"duration":42.1,"name":"Infinite Loop","distance":148,"voiceInstructions":[{"distanceAlongGeometry":148,"announcement":"Head south on Infinite Loop, then turn right onto Mariani Avenue","ssmlAnnouncement":"<speak><amazon:effect name=\"drc\"><prosody rate=\"1.08\">Head south on Infinite Loop, then turn right onto Mariani Avenue</prosody></amazon:effect></speak>"},{"distanceAlongGeometry":52.7,"announcement":"Turn right onto Mariani Avenue, then you will arrive at your destination","ssmlAnnouncement":"<speak><amazon:effect name=\"drc\"><prosody rate=\"1.08\">Turn right onto Mariani Avenue, then you will arrive at your destination</prosody></amazon:effect></speak>"}],"bannerInstructions":[{"distanceAlongGeometry":148,"primary":{"text":"Mariani Avenue","components":[{"text":"Mariani Avenue","type":"text","abbr":"Mariani Ave","abbr_priority":0}],"type":"turn","modifier":"right"},"secondary":null}]},{"intersections":[{"out":1,"in":2,"entry":[true,true,false],"bearings":[90,255,345],"location":[-122.03055,37.3305]}],"driving_side":"right","geometry":"sbzbF|aygVX`BRbAF\\@`@?P","mode":"driving","maneuver":{"bearing_after":250,"bearing_before":163,"location":[-122.03055,37.3305],"modifier":"right","type":"end of road","instruction":"Turn right onto Mariani Avenue"},"weight":26,"duration":25.9,"name":"Mariani Avenue","distance":114.5,"voiceInstructions":[{"distanceAlongGeometry":13.3,"announcement":"You have arrived at your destination","ssmlAnnouncement":"<speak><amazon:effect name=\"drc\"><prosody rate=\"1.08\">You have arrived at your destination</prosody></amazon:effect></speak>"}],"bannerInstructions":[{"distanceAlongGeometry":114.5,"primary":{"text":"You will arrive","components":[{"text":"You will arrive","type":"text"}],"type":"arrive","modifier":"straight"},"secondary":null},{"distanceAlongGeometry":15,"primary":{"text":"You have arrived","components":[{"text":"You have arrived","type":"text"}],"type":"arrive","modifier":"straight"},"secondary":null}]},{"intersections":[{"in":0,"entry":[true],"bearings":[90],"location":[-122.031787,37.330217]}],"driving_side":"right","geometry":"{`zbFtiygV","mode":"driving","maneuver":{"bearing_after":0,"bearing_before":270,"location":[-122.031787,37.330217],"type":"arrive","instruction":"You have arrived at your destination"},"weight":0,"duration":0,"name":"Mariani Avenue","distance":0,"voiceInstructions":[],"bannerInstructions":[]}],"distance":262.5}],"weight_name":"routability","weight":78.8,"duration":68,"distance":262.5,"voiceLocale":"en-US"}],"waypoints":[{"name":"Infinite Loop","location":[-122.03076,37.331808]},{"name":"Mariani Avenue","location":[-122.031787,37.330217]}],"code":"Ok","uuid":"cjge5fi1506sr3vpcd19wufgh"}

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

@@ -1 +1 @@
-{"routes":[{"geometry":"ejnlFdvfuMeAeAIg@FgAGw@]{@YU]OU]G[?yA","legs":[{"summary":"New Hampshire Avenue Northwest, Dupont Circle NW","weight":129.6,"duration":104.4,"steps":[{"intersections":[{"out":0,"entry":[true],"bearings":[36],"location":[-77.044347,38.908673]},{"out":1,"in":2,"entry":[false,true,false],"bearings":[15,60,210],"location":[-77.044059,38.908982]}],"driving_side":"right","geometry":"ejnlFdvfuM}@y@GKEOCK?KAG","mode":"driving","maneuver":{"bearing_after":36,"bearing_before":0,"location":[-77.044347,38.908673],"type":"depart","instruction":"Head northeast on New Hampshire Avenue Northwest"},"weight":35.2,"duration":34.7,"name":"New Hampshire Avenue Northwest","distance":71.5},{"intersections":[{"out":0,"in":1,"entry":[true,false,false],"bearings":[105,270,300],"location":[-77.043755,38.909076]},{"out":0,"in":3,"entry":[true,true,true,false],"bearings":[105,120,135,285],"location":[-77.043591,38.909037]},{"out":0,"in":2,"entry":[true,false,false],"bearings":[45,195,225],"location":[-77.042939,38.909165]},{"out":0,"in":2,"entry":[true,true,false,false],"bearings":[30,75,210,255],"location":[-77.042775,38.909307]},{"out":1,"in":3,"entry":[true,true,false,false,true],"bearings":[15,45,135,195,345],"location":[-77.042669,38.909502]},{"out":0,"in":1,"entry":[true,false,false],"bearings":[90,255,300],"location":[-77.042382,38.909646]}],"driving_side":"right","geometry":"wlnlFnrfuMBK@I@K@I?I?I?I?GAI?ICIAGAICICGCGEGAECCCECCCCECCCGEGEGCECGAKKEGCICICQ?yA","mode":"driving","maneuver":{"exit":3,"bearing_after":111,"bearing_before":84,"location":[-77.043755,38.909076],"modifier":"slight right","type":"roundabout","instruction":"Enter the traffic circle and take the 3rd exit onto P Street Northwest"},"weight":94.4,"duration":69.7,"name":"P Street Northwest","distance":189.9},{"intersections":[{"in":0,"entry":[true],"bearings":[270],"location":[-77.041926,38.909646]}],"driving_side":"right","geometry":"ipnlF`gfuM","mode":"driving","maneuver":{"bearing_after":0,"bearing_before":90,"location":[-77.041926,38.909646],"type":"arrive","instruction":"You have arrived at your destination"},"weight":0,"duration":0,"name":"P Street Northwest","distance":0}],"distance":261.4}],"weight_name":"routability","weight":129.6,"duration":104.4,"distance":261.4}],"waypoints":[{"name":"New Hampshire Avenue Northwest","location":[-77.044347,38.908673]},{"name":"P Street Northwest","location":[-77.041926,38.909646]}],"code":"Ok","uuid":"cjfe60wqh055u4epbgoj7irfc"}
+{"routes":[{"geometry":"ejnlFdvfuM}@y@M[E_@JaAGm@Kc@[g@YSa@KGQIe@?yA","legs":[{"summary":"Dupont Circle Northwest, P Street Northwest","weight":122.6,"duration":90.9,"steps":[{"intersections":[{"out":0,"entry":[true],"bearings":[36],"location":[-77.044347,38.908673]},{"out":1,"in":2,"entry":[false,true,false],"bearings":[15,60,210],"location":[-77.044059,38.908982]}],"driving_side":"right","geometry":"ejnlFdvfuM}@y@GKEOCK?KAG","mode":"driving","maneuver":{"bearing_after":36,"bearing_before":0,"location":[-77.044347,38.908673],"type":"depart","instruction":"Head northeast on New Hampshire Avenue Northwest"},"weight":20.8,"duration":16.4,"name":"New Hampshire Avenue Northwest","distance":71.5},{"intersections":[{"out":0,"in":1,"entry":[true,false,false],"bearings":[105,255,300],"location":[-77.043755,38.909076]},{"out":0,"in":2,"entry":[true,true,false],"bearings":[90,150,285],"location":[-77.043518,38.909023]},{"out":0,"in":2,"entry":[true,true,false],"bearings":[90,120,270],"location":[-77.043427,38.909023]},{"out":0,"in":2,"entry":[true,false,false],"bearings":[45,195,225],"location":[-77.042939,38.909165]},{"out":0,"in":2,"entry":[true,true,false,false],"bearings":[30,90,210,255],"location":[-77.042775,38.909307]},{"out":0,"in":2,"entry":[true,false,false,true],"bearings":[15,135,195,345],"location":[-77.04267,38.909501]},{"out":1,"in":2,"entry":[true,true,false],"bearings":[15,75,180],"location":[-77.042655,38.909562]},{"out":0,"in":1,"entry":[true,false,false],"bearings":[90,255,300],"location":[-77.042382,38.909646]}],"driving_side":"right","geometry":"wlnlFnrfuMBKFc@?QCc@CIAGAICICGCGEGAECCCECCCCECCCGEGEGCECGAGAC?GQAICICQ?yA","mode":"driving","maneuver":{"exit":5,"bearing_after":111,"bearing_before":77,"location":[-77.043755,38.909076],"modifier":"slight right","type":"roundabout","instruction":"Enter the traffic circle and take the 5th exit onto P Street Northwest"},"weight":101.8,"duration":74.5,"name":"P Street Northwest","distance":191.8},{"intersections":[{"in":0,"entry":[true],"bearings":[270],"location":[-77.041926,38.909646]}],"driving_side":"right","geometry":"ipnlF`gfuM","mode":"driving","maneuver":{"bearing_after":0,"bearing_before":90,"location":[-77.041926,38.909646],"type":"arrive","instruction":"You have arrived at your destination"},"weight":0,"duration":0,"name":"P Street Northwest","distance":0}],"distance":263.4}],"weight_name":"routability","weight":122.6,"duration":90.9,"distance":263.4}],"waypoints":[{"name":"New Hampshire Avenue Northwest","location":[-77.044347,38.908673]},{"name":"P Street Northwest","location":[-77.041926,38.909646]}],"code":"Ok","uuid":"cjge5fh9l07x84ime4edkubph"}