add metadata deserializers

Author: abhishek1508

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

@@ -95,6 +95,14 @@ public static Builder builder() {
   @Nullable
   public abstract String uuid();
 
+  /**
+   * A complex data structure that provides versioning information.
+   *
+   * @return a Metadata holding versioning information
+   */
+  @Nullable
+  public abstract Metadata metadata();
+
   /**
    * Convert the current {@link DirectionsResponse} to its builder holding the currently assigned
    * values. This allows you to modify a single property and then rebuild the object resulting in
@@ -234,6 +242,14 @@ public abstract static class Builder {
      */
     public abstract Builder uuid(@Nullable String uuid);
 
+    /**
+     * A complex data structure that provides versioning information.
+     *
+     * @param metadata a Metadata holding versioning information
+     * @return this builder for chaining options together
+     */
+    public abstract Builder metadata(@Nullable Metadata metadata);
+
     abstract DirectionsResponse autoBuild();
 
     /**

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

@@ -0,0 +1,92 @@
+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;
+
+import java.util.Map;
+
+/**
+ * Object representing metadata associated with a route request.
+ */
+@AutoValue
+public abstract class Metadata extends DirectionsJsonObject {
+
+  /**
+   * Create a new instance of this class by using the {@link Metadata.Builder} class.
+   *
+   * @return {@link Metadata.Builder} for creating a new instance
+   */
+  public static Builder builder() {
+    return new AutoValue_Metadata.Builder();
+  }
+
+  /**
+   * Map containing a key/value pair of all the properties inside `map` json element including
+   * map sources, version information etc. Metadata map is generic and can give access to many
+   * different key/value pairs other than the ones specified.
+   * @return map of key/value pairs
+   */
+  @Nullable
+  @SerializedName("map")
+  public abstract Map<String, String> mapInfo();
+
+  /**
+   * Convert the current {@link Metadata} 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 Metadata}.
+   *
+   * @return a {@link Metadata.Builder} with the same values set to match the ones defined
+   *   in this {@link Metadata}
+   */
+  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<Metadata> typeAdapter(Gson gson) {
+    return new AutoValue_Metadata.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 Metadata
+   * @return a new instance of this class defined by the values passed inside this static factory
+   *   method
+   */
+  public static Metadata fromJson(String json) {
+    GsonBuilder gson = new GsonBuilder();
+    gson.registerTypeAdapterFactory(DirectionsAdapterFactory.create());
+    return gson.create().fromJson(json, Metadata.class);
+  }
+
+  /**
+   * This builder can be used to set the values describing the {@link Metadata}.
+   */
+  @AutoValue.Builder
+  public abstract static class Builder {
+
+    /**
+     * Map indicating the key/value pairs.
+     *
+     * @param mapInfo indicating the key/value pairs
+     * @return a {@link Metadata.Builder} object
+     */
+    public abstract Builder mapInfo(Map<String, String> mapInfo);
+
+    /**
+     * Build a new {@link Metadata} object.
+     *
+     * @return a new {@link Metadata} using the provided values in this builder
+     */
+    public abstract Metadata build();
+  }
+}

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

@@ -649,6 +649,16 @@ public List<Boolean> snappingIncludeClosuresList() {
   @Nullable
   public abstract Boolean enableRefresh();
 
+  /**
+   * Whether the response should contain metadata holding versioning information.
+   * <p>
+   *
+   * @return whether the response should hold metadata
+   */
+  @SerializedName("metadata")
+  @Nullable
+  public abstract Boolean metadata();
+
   /**
    * Gson type adapter for parsing Gson to this class.
    *
@@ -1421,6 +1431,16 @@ public Builder snappingIncludeClosuresList(@Nullable List<Boolean> snappingClosu
     @NonNull
     public abstract Builder enableRefresh(@Nullable Boolean enableRefresh);
 
+    /**
+     * Whether the response should contain metadata holding versioning information.
+     * <p>
+     *
+     * @param metadata whether the routes should be refreshable
+     * @return this builder
+     */
+    @NonNull
+    public abstract Builder metadata(@Nullable Boolean metadata);
+
     /**
      * Builds the object.
      *

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

@@ -251,6 +251,13 @@ public void enableRefreshIsValid_fromJson() {
     assertEquals(true, options.enableRefresh());
   }
 
+  @Test
+  public void metadataIsValid_fromJson() {
+    RouteOptions options = RouteOptions.fromJson(optionsJson);
+
+    assertEquals(true, options.metadata());
+  }
+
   @Test
   public void routeOptions_toJson() {
     RouteOptions options = routeOptions();
@@ -304,6 +311,7 @@ private RouteOptions routeOptions() {
       .snappingIncludeClosures(";false;true")
       .user(DirectionsCriteria.PROFILE_DEFAULT_USER)
       .enableRefresh(true)
+      .metadata(true)
       .build();
   }
 
@@ -378,6 +386,7 @@ private RouteOptions routeOptionsList() {
       }})
       .user(DirectionsCriteria.PROFILE_DEFAULT_USER)
       .enableRefresh(true)
+      .metadata(true)
       .build();
   }
 }

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

@@ -27,5 +27,6 @@
   "walkway_bias": -0.2,
   "arrive_by": "2021-01-01'T'01:01",
   "depart_at": "2021-02-02'T'02:02",
-  "enable_refresh": true
+  "enable_refresh": true,
+  "metadata": true
 }

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

@@ -50,6 +50,7 @@ interface DirectionsService {
    * @param snappingIncludeClosures {@link RouteOptions#snappingIncludeClosures()}
    * @param arriveBy                {@link RouteOptions#arriveBy()}
    * @param departAt                {@link RouteOptions#departAt()}
+   * @param metadata                {@link RouteOptions#metadata()}
    * @return the {@link DirectionsResponse} in a Call wrapper
    */
   @GET("directions/v5/{user}/{profile}/{coordinates}")
@@ -83,7 +84,8 @@ Call<DirectionsResponse> getCall(
     @Query("alley_bias") Double alleyBias,
     @Query("snapping_include_closures") String snappingIncludeClosures,
     @Query("arrive_by") String arriveBy,
-    @Query("depart_at") String departAt
+    @Query("depart_at") String departAt,
+    @Query("metadata") Boolean metadata
   );
 
   /**
@@ -119,6 +121,7 @@ Call<DirectionsResponse> getCall(
    * @param snappingIncludeClosures {@link RouteOptions#snappingIncludeClosures()}
    * @param arriveBy                {@link RouteOptions#arriveBy()}
    * @param departAt                {@link RouteOptions#departAt()}
+   * @param metadata                {@link RouteOptions#metadata()}
    * @return the {@link DirectionsResponse} in a Call wrapper
    */
   @FormUrlEncoded
@@ -153,6 +156,7 @@ Call<DirectionsResponse> postCall(
     @Field("alley_bias") Double alleyBias,
     @Field("snapping_include_closures") String snappingIncludeClosures,
     @Field("arrive_by") String arriveBy,
-    @Field("depart_at") String departAt
+    @Field("depart_at") String departAt,
+    @Field("metadata") Boolean metadata
   );
 }

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

@@ -104,7 +104,8 @@ private Call<DirectionsResponse> get() {
       routeOptions().alleyBias(),
       routeOptions().snappingIncludeClosures(),
       routeOptions().arriveBy(),
-      routeOptions().departAt()
+      routeOptions().departAt(),
+      routeOptions().metadata()
     );
   }
 
@@ -139,7 +140,8 @@ private Call<DirectionsResponse> post() {
       routeOptions().alleyBias(),
       routeOptions().snappingIncludeClosures(),
       routeOptions().arriveBy(),
-      routeOptions().departAt()
+      routeOptions().departAt(),
+      routeOptions().metadata()
     );
   }
 

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

@@ -135,6 +135,15 @@ public void build_walkingWalkingSpeedOptions() {
     assertTrue(directions.cloneCall().request().url().toString().contains("walking_speed=5.11"));
   }
 
+  @Test
+  public void build_metadataOptions() {
+    MapboxDirections directions = MapboxDirections.builder()
+        .accessToken("token")
+        .routeOptions(routeOptions)
+        .build();
+    assertTrue(directions.cloneCall().request().url().toString().contains("metadata=true"));
+  }
+
   @Test
   public void build_walkingWalkwayBiasOptions() {
     MapboxDirections directions = MapboxDirections.builder()

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

@@ -27,5 +27,6 @@
   "walkway_bias": -0.2,
   "arrive_by": "2021-01-01'T'01:01",
   "depart_at": "2021-02-02'T'02:02",
-  "enable_refresh": true
+  "enable_refresh": true,
+  "metadata": true
 }