removed access token from RouteOptions

Avoids problems of deserialization and usability of route objects. Each entity that does need to make a resources request using a route reference (like annotations refresh or reroute) will most likely get a token from a different source, the route object shouldn't need to transport it.

Author: Łukasz Paczos

samples/src/main/java/com/mapbox/samples/BasicDirections.java

@@ -40,10 +40,10 @@ private static void simpleMapboxDirectionsRequest() throws IOException {
     coordinates.add(Point.fromLngLat(-95.6332, 29.7890));
     coordinates.add(Point.fromLngLat(-95.3591, 29.7576));
     RouteOptions routeOptions = RouteOptions.builder()
-      .accessToken(BuildConfig.MAPBOX_ACCESS_TOKEN)
       .coordinatesList(coordinates)
       .build();
     builder.routeOptions(routeOptions);
+    builder.accessToken(BuildConfig.MAPBOX_ACCESS_TOKEN);
 
     // 2. That's it! Now execute the command and get the response.
     Response<DirectionsResponse> response = builder.build().executeCall();
@@ -66,14 +66,14 @@ private static void simpleMapboxDirectionsWalkingRequest() throws IOException {
     coordinates.add(Point.fromLngLat(-95.6332, 29.7890));
     coordinates.add(Point.fromLngLat(-95.3591, 29.7576));
     RouteOptions routeOptions = RouteOptions.builder()
-      .accessToken(BuildConfig.MAPBOX_ACCESS_TOKEN)
       .coordinatesList(coordinates)
       .profile("walking")
       .walkingSpeed(1.0)
       .walkwayBias(0.6)
       .alleyBias(0.7)
       .build();
     builder.routeOptions(routeOptions);
+    builder.accessToken(BuildConfig.MAPBOX_ACCESS_TOKEN);
 
     // 2. That's it! Now execute the command and get the response.
     Response<DirectionsResponse> response = builder.build().executeCall();
@@ -96,11 +96,11 @@ private static void simpleMapboxDirectionsPostRequest() throws IOException {
     coordinates.add(Point.fromLngLat(-95.6332, 29.7890));
     coordinates.add(Point.fromLngLat(-95.3591, 29.7576));
     RouteOptions routeOptions = RouteOptions.builder()
-      .accessToken(BuildConfig.MAPBOX_ACCESS_TOKEN)
       .coordinatesList(coordinates)
       .build();
     builder.routeOptions(routeOptions);
     builder.usePostMethod(true);
+    builder.accessToken(BuildConfig.MAPBOX_ACCESS_TOKEN);
 
     Response<DirectionsResponse> response = builder.build().executeCall();
 
@@ -120,12 +120,12 @@ private static void asyncMapboxDirectionsRequest() {
     coordinates.add(Point.fromLngLat(-95.6332, 29.7890));
     coordinates.add(Point.fromLngLat(-95.3591, 29.7576));
     RouteOptions routeOptions = RouteOptions.builder()
-      .accessToken(BuildConfig.MAPBOX_ACCESS_TOKEN)
       .coordinatesList(coordinates)
       .profile(DirectionsCriteria.PROFILE_CYCLING)
       .steps(true)
       .build();
     builder.routeOptions(routeOptions);
+    builder.accessToken(BuildConfig.MAPBOX_ACCESS_TOKEN);
 
     // 2. Now request the route using a async call
     builder.build().enqueueCall(new Callback<DirectionsResponse>() {

samples/src/main/java/com/mapbox/samples/BasicDirectionsRefresh.java

@@ -49,14 +49,14 @@ private static MapboxDirections mapboxDirections(Boolean addWaypoint) {
     }
     coordinates.add(Point.fromLngLat(-95.3591, 29.7576));
     RouteOptions routeOptions = RouteOptions.builder()
-      .accessToken(BuildConfig.MAPBOX_ACCESS_TOKEN)
       .coordinatesList(coordinates)
       .enableRefresh(true)
       .overview(OVERVIEW_FULL)
       .profile(PROFILE_DRIVING_TRAFFIC)
       .annotationsList(Arrays.asList(ANNOTATION_CONGESTION, ANNOTATION_MAXSPEED))
       .build();
     builder.routeOptions(routeOptions);
+    builder.accessToken(BuildConfig.MAPBOX_ACCESS_TOKEN);
 
     return builder.build();
   }

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

@@ -17,7 +17,7 @@
  * chained together to make up a similar structure to the original APIs JSON response.
  *
  * @see <a href="https://www.mapbox.com/api-documentation/navigation/#directions-response-object">Direction
- * Response Object</a>
+ *   Response Object</a>
  * @since 1.0.0
  */
 @AutoValue
@@ -146,7 +146,7 @@ public static DirectionsResponse fromJson(@NonNull String json) {
    * @return a new instance of this class defined by the values passed inside this static factory
    *   method
    * @see RouteOptions#fromUrl(java.net.URL)
-   * @see RouteOptions#fromJson(String, String)
+   * @see RouteOptions#fromJson(String)
    */
   public static DirectionsResponse fromJson(
     @NonNull String json, @Nullable RouteOptions routeOptions, @Nullable String requestUuid) {

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

@@ -167,9 +167,6 @@ public static TypeAdapter<DirectionsRoute> typeAdapter(Gson gson) {
   /**
    * Create a new instance of this class by passing in a formatted valid JSON String.
    * <p>
-   * Use this method if the provided serialized route was not obtained by this library.
-   * Alternatively, use {@link #fromJson(String, String)}.
-   * <p>
    * If you're using the provided route with the Mapbox Navigation SDK, also see
    * {@link #fromJson(String, RouteOptions, String)}.
    *
@@ -180,41 +177,6 @@ public static TypeAdapter<DirectionsRoute> typeAdapter(Gson gson) {
   public static DirectionsRoute fromJson(@NonNull String json) {
     GsonBuilder gson = new GsonBuilder();
     JsonObject jsonObject = gson.create().fromJson(json, JsonObject.class);
-    if (jsonObject.has("routeOptions")) {
-      throw new IllegalArgumentException(
-        "Provided serialized route contains RouteOptions. "
-          + "Use DirectionsRoute#fromJson(json, accessToken) instead."
-      );
-    }
-    gson.registerTypeAdapterFactory(DirectionsAdapterFactory.create());
-    gson.registerTypeAdapter(Point.class, new PointAsCoordinatesTypeAdapter());
-    return gson.create().fromJson(jsonObject, DirectionsRoute.class);
-  }
-
-  /**
-   * Create a new instance of this class by passing in a formatted valid JSON String.
-   * <p>
-   * Use this method if the provided serialized route was obtained by this library.
-   * This means that it includes {@link RouteOptions} and you need to supply a Mapbox Access Token.
-   * Alternatively, use {@link #fromJson(String)}.
-   *
-   * @param json        a formatted valid JSON string defining a GeoJson Directions Route
-   * @param accessToken a Mapbox Access Token
-   * @return a new instance of this class defined by the values passed inside this static factory
-   *   method
-   */
-  public static DirectionsRoute fromJson(@NonNull String json, @NonNull String accessToken) {
-    GsonBuilder gson = new GsonBuilder();
-    JsonObject jsonObject = gson.create().fromJson(json, JsonObject.class);
-    if (jsonObject.has("routeOptions")) {
-      JsonObject routeOptions = jsonObject.getAsJsonObject("routeOptions");
-      routeOptions.addProperty("access_token", accessToken);
-    } else {
-      throw new IllegalArgumentException(
-        "Provided serialized route does not contain RouteOptions. "
-          + "Use DirectionsRoute#fromJson(json) instead."
-      );
-    }
     gson.registerTypeAdapterFactory(DirectionsAdapterFactory.create());
     gson.registerTypeAdapter(Point.class, new PointAsCoordinatesTypeAdapter());
     return gson.create().fromJson(jsonObject, DirectionsRoute.class);
@@ -234,7 +196,7 @@ public static DirectionsRoute fromJson(@NonNull String json, @NonNull String acc
    * @return a new instance of this class defined by the values passed inside this static factory
    *   method
    * @see RouteOptions#fromUrl(java.net.URL)
-   * @see RouteOptions#fromJson(String, String)
+   * @see RouteOptions#fromJson(String)
    */
   public static DirectionsRoute fromJson(
     @NonNull String json, @Nullable RouteOptions routeOptions, @Nullable String requestUuid

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

@@ -6,7 +6,6 @@
 import com.google.auto.value.AutoValue;
 import com.google.gson.Gson;
 import com.google.gson.GsonBuilder;
-import com.google.gson.JsonElement;
 import com.google.gson.JsonObject;
 import com.google.gson.TypeAdapter;
 import com.google.gson.annotations.SerializedName;
@@ -15,7 +14,6 @@
 import com.mapbox.api.directions.v5.utils.FormatUtils;
 import com.mapbox.api.directions.v5.utils.ParseUtils;
 import com.mapbox.geojson.Point;
-import com.ryanharter.auto.value.gson.Ignore;
 import java.io.UnsupportedEncodingException;
 import java.net.URL;
 import java.net.URLDecoder;
@@ -366,16 +364,6 @@ public List<String> annotationsList() {
   @DirectionsCriteria.VoiceUnitCriteria
   public abstract String voiceUnits();
 
-  /**
-   * A valid Mapbox access token used to making the request.
-   *
-   * @return a string representing the Mapbox access token
-   */
-  @SerializedName("access_token")
-  @Ignore(Ignore.Type.SERIALIZATION)
-  @NonNull
-  public abstract String accessToken();
-
   /**
    * A semicolon-separated list indicating from which side of the road
    * to approach a waypoint.
@@ -675,20 +663,14 @@ public static TypeAdapter<RouteOptions> typeAdapter(Gson gson) {
    * Create a new instance of this class by passing in a formatted valid JSON String
    * with a Mapbox Access Token.
    *
-   * @param json        a formatted valid JSON string defining a RouteOptions
-   * @param accessToken a Mapbox Access Token since {@link #toJson()} does not serialize the token
+   * @param json a formatted valid JSON string defining a RouteOptions
    * @return a new instance of this class defined by the values passed inside this static factory
    *   method
    * @see #fromUrl(URL)
    */
   @NonNull
-  public static RouteOptions fromJson(@NonNull String json, @NonNull String accessToken) {
-    GsonBuilder gson = new GsonBuilder();
-
-    JsonObject jsonObject = gson.create().fromJson(json, JsonObject.class);
-    jsonObject.addProperty("access_token", accessToken);
-
-    return fromJsonElement(jsonObject);
+  public static RouteOptions fromJson(@NonNull String json) {
+    return fromJsonString(json);
   }
 
   /**
@@ -710,7 +692,7 @@ public String toJson() {
    * @param url request URL
    * @return a new instance of this class defined by the values passed inside this static factory
    *   method
-   * @see #fromJson(String, String)
+   * @see #fromJson(String)
    */
   @NonNull
   public static RouteOptions fromUrl(@NonNull URL url) {
@@ -746,13 +728,6 @@ private static RouteOptions fromJsonString(@NonNull String json) {
     return gson.create().fromJson(json, RouteOptions.class);
   }
 
-  @NonNull
-  private static RouteOptions fromJsonElement(@NonNull JsonElement jsonElement) {
-    GsonBuilder gson = new GsonBuilder();
-    gson.registerTypeAdapterFactory(DirectionsAdapterFactory.create());
-    return gson.create().fromJson(jsonElement, RouteOptions.class);
-  }
-
   /**
    * Convert the current {@link RouteOptions} to its builder holding the currently assigned
    * values. This allows you to modify a single property and then rebuild the object resulting in
@@ -1109,17 +1084,6 @@ public Builder annotationsList(@Nullable List<String> annotations) {
     @NonNull
     public abstract Builder voiceUnits(@Nullable String voiceUnits);
 
-    /**
-     * A valid Mapbox access token used to making the request.
-     *
-     * @param accessToken a string containing a valid Mapbox access token.
-     *                    Avoiding to provide a token will most-likely result in a failure, however,
-     *                    it's annotated as nullable to prevent serialization of tokens.
-     * @return this builder for chaining options together
-     */
-    @NonNull
-    public abstract Builder accessToken(@Nullable String accessToken);
-
     /**
      * Exclude certain road types from routing. The default is to not exclude anything from the
      * profile selected. The following exclude flags are available for each profile:

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

@@ -55,7 +55,6 @@ public void fromJson_correctlyBuildsFromJsonWithOptionsAndUuid() throws Exceptio
         add(Point.fromLngLat(1.0, 1.0));
         add(Point.fromLngLat(2.0, 2.0));
       }})
-      .accessToken("token")
       .build();
     String uuid = "123";
     DirectionsResponse response = DirectionsResponse.fromJson(json, options, uuid);

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

@@ -69,7 +69,6 @@ public void directionsRoute_doesContainOptionsAndUuid() throws Exception {
         add(Point.fromLngLat(1.0, 1.0));
         add(Point.fromLngLat(2.0, 2.0));
       }})
-      .accessToken("token")
       .build();
     String uuid = "123";
     DirectionsRoute route = DirectionsRoute.fromJson(json, options, uuid);
@@ -87,52 +86,14 @@ public void directionsRoute_json_withOptionsAndUUID_roundTripping() throws Excep
         add(Point.fromLngLat(1.0, 1.0));
         add(Point.fromLngLat(2.0, 2.0));
       }})
-      .accessToken("token")
       .build();
     String uuid = "123";
     DirectionsRoute route = DirectionsRoute.fromJson(json, options, uuid);
 
     String newRouteJson = route.toJson();
 
-    DirectionsRoute newRoute = DirectionsRoute.fromJson(newRouteJson, "token");
+    DirectionsRoute newRoute = DirectionsRoute.fromJson(newRouteJson);
 
     assertEquals(route, newRoute);
   }
-
-  @Test
-  public void directionsRoute_json_invalid_with_options() throws Exception {
-    thrown.expect(RuntimeException.class);
-    thrown.expectMessage(
-      "Provided serialized route contains RouteOptions. "
-        + "Use DirectionsRoute#fromJson(json, accessToken) instead.");
-    String json = loadJsonFixture("directions_v5-with-closure_precision_6.json");
-    RouteOptions options = RouteOptions.builder()
-      .profile(DirectionsCriteria.PROFILE_DRIVING_TRAFFIC)
-      .coordinatesList(new ArrayList<Point>() {{
-        add(Point.fromLngLat(1.0, 1.0));
-        add(Point.fromLngLat(2.0, 2.0));
-      }})
-      .accessToken("token")
-      .build();
-    String uuid = "123";
-    DirectionsRoute route = DirectionsRoute.fromJson(json, options, uuid);
-
-    String newRouteJson = route.toJson();
-
-    DirectionsRoute.fromJson(newRouteJson);
-  }
-
-  @Test
-  public void directionsRoute_json_invalid_without_options() throws Exception {
-    thrown.expect(RuntimeException.class);
-    thrown.expectMessage(
-      "Provided serialized route does not contain RouteOptions. "
-        + "Use DirectionsRoute#fromJson(json) instead.");
-    String json = loadJsonFixture("directions_v5-with-closure_precision_6.json");
-    DirectionsRoute route = DirectionsRoute.fromJson(json);
-
-    String newRouteJson = route.toJson();
-
-    DirectionsRoute.fromJson(newRouteJson, "token");
-  }
 }