add changelog

Author: abhishek1508

CHANGELOG.md

@@ -3,7 +3,10 @@
 Mapbox welcomes participation and contributions from everyone.
 
 ### main
+
+### v6.6.0 - Jun 30, 2022
 - Fixed `RouteOptions#toUrl` for a case when `RouteOptions` was deserialized from a json generated by an old version of mapbox-java. [#1447](https://github.com/mapbox/mapbox-java/pull/1447)
+- Added support for `Amenities` by exposing them as a part of `RestStop`. [#1454](https://github.com/mapbox/mapbox-java/pull/1454)
 
 ### v6.5.0 - May 25, 2022
 - No additional changes

README.md

@@ -54,7 +54,7 @@ repositories {
 }
 
 dependencies {
-    implementation 'com.mapbox.mapboxsdk:mapbox-sdk-services:6.6.0-SNAPSHOT'
+    implementation 'com.mapbox.mapboxsdk:mapbox-sdk-services:6.7.0-SNAPSHOT'
 }
 ```
 

…/api/directions/v5/models/Amenities.java …ox/api/directions/v5/models/Amenity.javaservices-directions-models/src/main/java/com/mapbox/api/directions/v5/models/Amenities.java renamed to services-directions-models/src/main/java/com/mapbox/api/directions/v5/models/Amenity.java services-directions-models/src/main/java/com/mapbox/api/directions/v5/models/Amenities.java renamed to services-directions-models/src/main/java/com/mapbox/api/directions/v5/models/Amenity.java

@@ -14,7 +14,7 @@
  * Only available on the {@link DirectionsCriteria#PROFILE_DRIVING} profile.
  */
 @AutoValue
-public abstract class Amenities extends DirectionsJsonObject {
+public abstract class Amenity extends DirectionsJsonObject {
 
   /**
    * The type of amenities such as gas, restaurants, shopping, bank, atm etc.
@@ -36,32 +36,32 @@ public abstract class Amenities extends DirectionsJsonObject {
   public abstract String brand();
 
   /**
-   * Create a new instance of this class by using the {@link Amenities.Builder} class.
+   * Create a new instance of this class by using the {@link Amenity.Builder} class.
    *
-   * @return this classes {@link Amenities.Builder} for creating a new instance
+   * @return this classes {@link Amenity.Builder} for creating a new instance
    */
-  public static Amenities.Builder builder() {
-    return new AutoValue_Amenities.Builder();
+  public static Amenity.Builder builder() {
+    return new AutoValue_Amenity.Builder();
   }
 
   /**
-   * Convert the current {@link Amenities} to its builder holding the currently assigned
+   * Convert the current {@link Amenity} 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 Amenities}.
+   * an updated and modified {@link Amenity}.
    *
-   * @return a {@link Amenities.Builder} with the same values set to match the ones
-   *   defined in this {@link Amenities}
+   * @return a {@link Amenity.Builder} with the same values set to match the ones
+   *   defined in this {@link Amenity}
    */
-  public abstract Amenities.Builder toBuilder();
+  public abstract Amenity.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<Amenities> typeAdapter(Gson gson) {
-    return new AutoValue_Amenities.GsonTypeAdapter(gson);
+  public static TypeAdapter<Amenity> typeAdapter(Gson gson) {
+    return new AutoValue_Amenity.GsonTypeAdapter(gson);
   }
 
   /**
@@ -70,17 +70,17 @@ public static TypeAdapter<Amenities> typeAdapter(Gson gson) {
    * @param json a formatted valid JSON string defining an Incident
    * @return a new instance of this class defined by the values passed in the method
    */
-  public static Amenities fromJson(String json) {
+  public static Amenity fromJson(String json) {
     GsonBuilder gson = new GsonBuilder();
     gson.registerTypeAdapterFactory(DirectionsAdapterFactory.create());
-    return gson.create().fromJson(json, Amenities.class);
+    return gson.create().fromJson(json, Amenity.class);
   }
 
   /**
-   * This builder can be used to set the values describing the {@link Amenities}.
+   * This builder can be used to set the values describing the {@link Amenity}.
    */
   @AutoValue.Builder
-  public abstract static class Builder extends DirectionsJsonObject.Builder<Amenities.Builder> {
+  public abstract static class Builder extends DirectionsJsonObject.Builder<Amenity.Builder> {
 
     /**
      * The type of amenity, includes amenities such as gas, restaurants etc.
@@ -108,11 +108,11 @@ public abstract static class Builder extends DirectionsJsonObject.Builder<Amenit
     public abstract Builder brand(@Nullable String brand);
 
     /**
-     * Build a new {@link Amenities} object.
+     * Build a new {@link Amenity} object.
      *
-     * @return a new {@link Amenities} using the provided values in this builder
+     * @return a new {@link Amenity} using the provided values in this builder
      */
     @NonNull
-    public abstract Amenities build();
+    public abstract Amenity build();
   }
 }

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

@@ -37,7 +37,7 @@ public abstract class RestStop extends DirectionsJsonObject {
    * The list of amenities at the rest stop if available.
    */
   @Nullable
-  public abstract List<Amenities> amenities();
+  public abstract List<Amenity> amenities();
 
   /**
    * Create a new instance of this class by using the {@link Builder} class.
@@ -110,7 +110,7 @@ public abstract static class Builder extends DirectionsJsonObject.Builder<Builde
      * @param amenities list of amenities
      */
     @NonNull
-    public abstract Builder amenities(@Nullable List<Amenities> amenities);
+    public abstract Builder amenities(@Nullable List<Amenity> amenities);
 
     /**
      * Build a new {@link RestStop} object.

…/directions/v5/models/AmenitiesTest.java …pi/directions/v5/models/AmenityTest.javaservices-directions-models/src/test/java/com/mapbox/api/directions/v5/models/AmenitiesTest.java renamed to services-directions-models/src/test/java/com/mapbox/api/directions/v5/models/AmenityTest.java services-directions-models/src/test/java/com/mapbox/api/directions/v5/models/AmenitiesTest.java renamed to services-directions-models/src/test/java/com/mapbox/api/directions/v5/models/AmenityTest.java

@@ -7,46 +7,46 @@
 import static org.junit.Assert.assertNotNull;
 import static org.junit.Assert.assertNull;
 
-public class AmenitiesTest extends TestUtils {
+public class AmenityTest extends TestUtils {
 
   private static final String DIRECTIONS_V5_AMENITIES_FIXTURE = "directions_v5_amenities.json";
   @Test
   public void sanity(){
     assertNotNull(getDefault());
   }
 
-  private Amenities getDefault() {
-    return Amenities.builder()
+  private Amenity getDefault() {
+    return Amenity.builder()
         .type("restaurant")
         .name("starbucks")
         .build();
   }
 
   @Test
   public void serializableObject() throws Exception {
-    Amenities expected = Amenities
+    Amenity expected = Amenity
         .builder()
         .type("restaurant")
         .name("starbucks")
         .build();
 
-    Amenities actual = deserialize(
+    Amenity actual = deserialize(
         TestUtils.serialize(expected),
-        Amenities.class
+        Amenity.class
     );
 
     assertEquals(expected, actual);
   }
 
   @Test
   public void toFromJson() {
-    Amenities expected = Amenities
+    Amenity expected = Amenity
         .builder()
         .type("restaurant")
         .name("starbucks")
         .build();
 
-    Amenities actual = Amenities.fromJson(expected.toJson());
+    Amenity actual = Amenity.fromJson(expected.toJson());
 
     assertEquals(expected, actual);
   }
@@ -57,16 +57,16 @@ public void fromJson_correctlyBuildsFromJson() throws Exception {
     DirectionsResponse response = DirectionsResponse.fromJson(json);
 
     RestStop restStop = response.routes().get(0).legs().get(0).steps().get(1).intersections().get(0).restStop();
-    Amenities amenities1 = restStop.amenities().get(0);
-    Amenities amenities2 = restStop.amenities().get(1);
+    Amenity amenity1 = restStop.amenities().get(0);
+    Amenity amenity2 = restStop.amenities().get(1);
 
-    assertNotNull(amenities1);
-    assertNotNull(amenities2);
-    assertNull(amenities1.brand());
-    assertEquals("restaurant", amenities1.type());
-    assertEquals("Panda Express", amenities1.name());
-    assertNull(amenities2.name());
-    assertEquals("gas_station", amenities2.type());
-    assertEquals("Shell", amenities2.brand());
+    assertNotNull(amenity1);
+    assertNotNull(amenity2);
+    assertNull(amenity1.brand());
+    assertEquals("restaurant", amenity1.type());
+    assertEquals("Panda Express", amenity1.name());
+    assertNull(amenity2.name());
+    assertEquals("gas_station", amenity2.type());
+    assertEquals("Shell", amenity2.brand());
   }
 }

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

@@ -17,7 +17,7 @@ public void sanity() throws Exception {
     RestStop restStop = RestStop.builder()
         .name("ABCD")
         .type("service_area")
-        .amenities(Collections.<Amenities>emptyList())
+        .amenities(Collections.emptyList())
         .build();
     assertNotNull(restStop);
   }
@@ -28,7 +28,7 @@ public void serializableObject() throws Exception {
         .builder()
         .name("ABCD")
         .type("service_area")
-        .amenities(Collections.<Amenities>emptyList())
+        .amenities(Collections.emptyList())
         .build();
 
     RestStop actual = deserialize(
@@ -45,7 +45,7 @@ public void toFromJson() {
         .builder()
         .name("ABCD")
         .type("service_area")
-        .amenities(Collections.<Amenities>emptyList())
+        .amenities(Collections.emptyList())
         .build();
 
     RestStop actual = RestStop.fromJson(expected.toJson());