Added max_width and max_height to Directions API params (#1283)

Author: n-frolov

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

@@ -638,6 +638,30 @@ public List<Boolean> snappingIncludeClosuresList() {
   @Nullable
   public abstract String departAt();
 
+  /**
+   * The max vehicle height in meters. If this parameter is provided, the Directions API will
+   * compute a route that includes only roads with a height limit greater than or equal to the max
+   * vehicle height. max_height must be between 0 and 10 meters. The default value is 1.6 meters.
+   * <p>
+   * Available for {@link DirectionsCriteria#PROFILE_DRIVING_TRAFFIC} and
+   * {@link DirectionsCriteria#PROFILE_DRIVING}.
+   */
+  @SerializedName("max_height")
+  @Nullable
+  public abstract Double maxHeight();
+
+  /**
+   * The max vehicle width in meters. If this parameter is provided, the Directions API will
+   * compute a route that includes only roads with a width limit greater than or equal to the max
+   * vehicle width. max_width must be between 0 and 10 meters. The default value is 1.9 meters.
+   * <p>
+   * Available for {@link DirectionsCriteria#PROFILE_DRIVING_TRAFFIC} and
+   * {@link DirectionsCriteria#PROFILE_DRIVING}.
+   */
+  @SerializedName("max_width")
+  @Nullable
+  public abstract Double maxWidth();
+
   /**
    * Whether the routes should be refreshable via the directions refresh API.
    * <p>
@@ -1420,6 +1444,34 @@ public Builder snappingIncludeClosuresList(@Nullable List<Boolean> snappingClosu
     @NonNull
     public abstract Builder departAt(@Nullable String departAt);
 
+    /**
+     * The max vehicle height in meters. If this parameter is provided, the Directions API will
+     * compute a route that includes only roads with a height limit greater than or equal to the max
+     * vehicle height. The default value is 1.6 meters.
+     * <p>
+     * Available for {@link DirectionsCriteria#PROFILE_DRIVING_TRAFFIC} and
+     * {@link DirectionsCriteria#PROFILE_DRIVING}.
+     *
+     * @param maxHeight max vehicle height, in meters. Must be between 0 and 10.
+     * @return this builder
+     */
+    @NonNull
+    public abstract Builder maxHeight(@Nullable @FloatRange(from = 0, to = 10) Double maxHeight);
+
+    /**
+     * The max vehicle width in meters. If this parameter is provided, the Directions API will
+     * compute a route that includes only roads with a width limit greater than or equal to the max
+     * vehicle width. The default value is 1.9 meters.
+     * <p>
+     * Available for {@link DirectionsCriteria#PROFILE_DRIVING_TRAFFIC} and
+     * {@link DirectionsCriteria#PROFILE_DRIVING}.
+     *
+     * @param maxWidth max vehicle width, in meters. Must be between 0 and 10.
+     * @return this builder
+     */
+    @NonNull
+    public abstract Builder maxWidth(@Nullable @FloatRange(from = 0, to = 10) Double maxWidth);
+
     /**
      * Whether the routes should be refreshable via the directions refresh API.
      * <p>

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

@@ -244,6 +244,20 @@ public void departAtIsValid_fromJson() {
     assertEquals("2021-02-02'T'02:02", options.departAt());
   }
 
+  @Test
+  public void maxHeightIsValid_fromJson() {
+    RouteOptions options = RouteOptions.fromJson(optionsJson);
+
+    assertEquals(1.5, options.maxHeight(), 0.000001);
+  }
+
+  @Test
+  public void maxWidthIsValid_fromJson() {
+    RouteOptions options = RouteOptions.fromJson(optionsJson);
+
+    assertEquals(1.4, options.maxWidth(), 0.000001);
+  }
+
   @Test
   public void enableRefreshIsValid_fromJson() {
     RouteOptions options = RouteOptions.fromJson(optionsJson);
@@ -308,6 +322,8 @@ private RouteOptions routeOptions() {
       .walkwayBias(-0.2)
       .arriveBy("2021-01-01'T'01:01")
       .departAt("2021-02-02'T'02:02")
+      .maxHeight(1.5)
+      .maxWidth(1.4)
       .snappingIncludeClosures(";false;true")
       .user(DirectionsCriteria.PROFILE_DEFAULT_USER)
       .enableRefresh(true)
@@ -379,6 +395,8 @@ private RouteOptions routeOptionsList() {
       .walkwayBias(-0.2)
       .arriveBy("2021-01-01'T'01:01")
       .departAt("2021-02-02'T'02:02")
+      .maxHeight(1.5)
+      .maxWidth(1.4)
       .snappingIncludeClosuresList(new ArrayList<Boolean>() {{
         add(null);
         add(false);

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

@@ -27,6 +27,8 @@
   "walkway_bias": -0.2,
   "arrive_by": "2021-01-01'T'01:01",
   "depart_at": "2021-02-02'T'02:02",
+  "max_height": 1.5,
+  "max_width": 1.4,
   "enable_refresh": true,
   "metadata": true
 }

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

@@ -50,6 +50,8 @@ interface DirectionsService {
    * @param snappingIncludeClosures {@link RouteOptions#snappingIncludeClosures()}
    * @param arriveBy                {@link RouteOptions#arriveBy()}
    * @param departAt                {@link RouteOptions#departAt()}
+   * @param maxHeight               {@link RouteOptions#maxHeight()}
+   * @param maxWidth                {@link RouteOptions#maxWidth()}
    * @param metadata                {@link RouteOptions#metadata()}
    * @return the {@link DirectionsResponse} in a Call wrapper
    */
@@ -85,6 +87,8 @@ Call<DirectionsResponse> getCall(
     @Query("snapping_include_closures") String snappingIncludeClosures,
     @Query("arrive_by") String arriveBy,
     @Query("depart_at") String departAt,
+    @Query("max_height") Double maxHeight,
+    @Query("max_width") Double maxWidth,
     @Query("metadata") Boolean metadata
   );
 
@@ -121,6 +125,8 @@ Call<DirectionsResponse> getCall(
    * @param snappingIncludeClosures {@link RouteOptions#snappingIncludeClosures()}
    * @param arriveBy                {@link RouteOptions#arriveBy()}
    * @param departAt                {@link RouteOptions#departAt()}
+   * @param maxHeight               {@link RouteOptions#maxHeight()}
+   * @param maxWidth                {@link RouteOptions#maxWidth()}
    * @param metadata                {@link RouteOptions#metadata()}
    * @return the {@link DirectionsResponse} in a Call wrapper
    */
@@ -157,6 +163,8 @@ Call<DirectionsResponse> postCall(
     @Field("snapping_include_closures") String snappingIncludeClosures,
     @Field("arrive_by") String arriveBy,
     @Field("depart_at") String departAt,
+    @Field("max_height") Double maxHeight,
+    @Field("max_width") Double maxWidth,
     @Field("metadata") Boolean metadata
   );
 }

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

@@ -105,6 +105,8 @@ private Call<DirectionsResponse> get() {
       routeOptions().snappingIncludeClosures(),
       routeOptions().arriveBy(),
       routeOptions().departAt(),
+      routeOptions().maxHeight(),
+      routeOptions().maxWidth(),
       routeOptions().metadata()
     );
   }
@@ -141,6 +143,8 @@ private Call<DirectionsResponse> post() {
       routeOptions().snappingIncludeClosures(),
       routeOptions().arriveBy(),
       routeOptions().departAt(),
+      routeOptions().maxHeight(),
+      routeOptions().maxWidth(),
       routeOptions().metadata()
     );
   }

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

@@ -730,6 +730,28 @@ public void depart_at() throws Exception {
       mapboxDirections.cloneCall().request().url().queryParameter("depart_at"));
   }
 
+  @Test
+  public void max_height() throws Exception {
+    MapboxDirections mapboxDirections = MapboxDirections.builder()
+            .accessToken("token")
+            .routeOptions(routeOptions.toBuilder().baseUrl(mockUrl.toString()).build())
+            .build();
+
+    assertEquals("1.5",
+            mapboxDirections.cloneCall().request().url().queryParameter("max_height"));
+  }
+
+  @Test
+  public void max_width() throws Exception {
+    MapboxDirections mapboxDirections = MapboxDirections.builder()
+            .accessToken("token")
+            .routeOptions(routeOptions.toBuilder().baseUrl(mockUrl.toString()).build())
+            .build();
+
+    assertEquals("1.4",
+            mapboxDirections.cloneCall().request().url().queryParameter("max_width"));
+  }
+
   @Test
   public void enable_refresh() throws Exception {
     MapboxDirections mapboxDirections = MapboxDirections.builder()

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

@@ -27,6 +27,8 @@
   "walkway_bias": -0.2,
   "arrive_by": "2021-01-01'T'01:01",
   "depart_at": "2021-02-02'T'02:02",
+  "max_height": 1.5,
+  "max_width": 1.4,
   "enable_refresh": true,
   "metadata": true
 }