Add currentFuelPercent and currentRangeMeters to RentalVehichle in the GTFS GraphQL API

application/src/ext-test/java/org/opentripplanner/ext/fares/impl/GtfsFaresV2ServiceTest.java

@@ -12,7 +12,7 @@
 import java.util.Set;
 import org.junit.jupiter.api.Nested;
 import org.junit.jupiter.api.Test;
-import org.opentripplanner.ext.fares.model.Distance;
+import org.opentripplanner.transit.model.basic.Distance;
 import org.opentripplanner.ext.fares.model.FareDistance;
 import org.opentripplanner.ext.fares.model.FareDistance.LinearDistance;
 import org.opentripplanner.ext.fares.model.FareLegRule;

application/src/ext/java/org/opentripplanner/ext/fares/model/FareDistance.java

@@ -1,5 +1,7 @@
 package org.opentripplanner.ext.fares.model;
 
+import org.opentripplanner.transit.model.basic.Distance;
+
 /** Represents a distance metric used in distance-based fare computation*/
 public sealed interface FareDistance {
   /** Represents the number of stops as a distance metric in fare computation */

application/src/main/java/org/opentripplanner/apis/gtfs/datafetchers/RentalVehicleImpl.java

@@ -4,6 +4,7 @@
 import graphql.schema.DataFetcher;
 import graphql.schema.DataFetchingEnvironment;
 import org.opentripplanner.apis.gtfs.generated.GraphQLDataFetchers;
+import org.opentripplanner.service.vehiclerental.model.RentalVehicleFuel;
 import org.opentripplanner.service.vehiclerental.model.RentalVehicleType;
 import org.opentripplanner.service.vehiclerental.model.VehicleRentalStationUris;
 import org.opentripplanner.service.vehiclerental.model.VehicleRentalSystem;
@@ -16,6 +17,11 @@ public DataFetcher<Boolean> allowPickupNow() {
     return environment -> getSource(environment).allowPickupNow();
   }
 
+  @Override
+  public DataFetcher<RentalVehicleFuel> fuel() {
+    return environment -> getSource(environment).getFuel();
+  }
+
   @Override
   public DataFetcher<Relay.ResolvedGlobalId> id() {
     return environment ->

application/src/main/java/org/opentripplanner/apis/gtfs/generated/GraphQLDataFetchers.java

@@ -58,6 +58,7 @@
 import org.opentripplanner.service.vehicleparking.model.VehicleParkingSpaces;
 import org.opentripplanner.service.vehicleparking.model.VehicleParkingState;
 import org.opentripplanner.service.vehiclerental.model.RentalVehicleEntityCounts;
+import org.opentripplanner.service.vehiclerental.model.RentalVehicleFuel;
 import org.opentripplanner.service.vehiclerental.model.RentalVehicleType;
 import org.opentripplanner.service.vehiclerental.model.RentalVehicleTypeCount;
 import org.opentripplanner.service.vehiclerental.model.VehicleRentalPlace;
@@ -908,6 +909,8 @@ public interface GraphQLRentalPlace extends TypeResolver {}
   public interface GraphQLRentalVehicle {
     public DataFetcher<Boolean> allowPickupNow();
 
+    public DataFetcher<RentalVehicleFuel> fuel();
+
     public DataFetcher<graphql.relay.Relay.ResolvedGlobalId> id();
 
     public DataFetcher<Double> lat();
@@ -935,6 +938,13 @@ public interface GraphQLRentalVehicleEntityCounts {
     public DataFetcher<Integer> total();
   }
 
+  /** Rental vehicle fuel represent the current status of the battery or fuel of a rental vehicle */
+  public interface GraphQLRentalVehicleFuel {
+    public DataFetcher<Double> percent();
+
+    public DataFetcher<Integer> range();
+  }
+
   public interface GraphQLRentalVehicleType {
     public DataFetcher<org.opentripplanner.apis.gtfs.generated.GraphQLTypes.GraphQLFormFactor> formFactor();
 

application/src/main/java/org/opentripplanner/apis/gtfs/generated/graphql-codegen.yml

@@ -134,4 +134,5 @@ config:
     CallRealTime: org.opentripplanner.apis.gtfs.model.CallRealTime#CallRealTime
     RentalPlace: org.opentripplanner.service.vehiclerental.model.VehicleRentalPlace#VehicleRentalPlace
     CallSchedule: org.opentripplanner.apis.gtfs.model.CallSchedule#CallSchedule
+    RentalVehicleFuel: org.opentripplanner.service.vehiclerental.model.RentalVehicleFuel#RentalVehicleFuel
 

application/src/main/java/org/opentripplanner/apis/transmodel/model/stop/RentalVehicleType.java

@@ -71,7 +71,7 @@ public static GraphQLObjectType create(
           .name("currentRangeMeters")
           .type(Scalars.GraphQLFloat)
           .dataFetcher(environment ->
-            ((VehicleRentalVehicle) environment.getSource()).currentRangeMeters
+            ((VehicleRentalVehicle) environment.getSource()).getFuel().getRange()
           )
           .build()
       )

application/src/main/java/org/opentripplanner/gtfs/mapping/FareLegRuleMapper.java

@@ -4,10 +4,10 @@
 
 import java.util.Collection;
 import java.util.Objects;
-import org.opentripplanner.ext.fares.model.Distance;
 import org.opentripplanner.ext.fares.model.FareDistance;
 import org.opentripplanner.ext.fares.model.FareLegRule;
 import org.opentripplanner.graph_builder.issue.api.DataImportIssueStore;
+import org.opentripplanner.transit.model.basic.Distance;
 import org.opentripplanner.transit.model.framework.FeedScopedId;
 
 public final class FareLegRuleMapper {

application/src/main/java/org/opentripplanner/service/vehiclerental/model/RentalVehicleFuel.java

@@ -0,0 +1,40 @@
+package org.opentripplanner.service.vehiclerental.model;
+
+import javax.annotation.Nullable;
+import org.opentripplanner.transit.model.basic.Distance;
+import org.opentripplanner.transit.model.basic.Ratio;
+
+/**
+ * Contains information about the current battery or fuel status.
+ * See the <a href="https://github.com/MobilityData/gbfs/blob/v3.0/gbfs.md#vehicle_statusjson">GBFS
+ * vehicle_status specification</a> for more details.
+ */
+public class RentalVehicleFuel {
+
+  /**
+   * Current fuel percentage, expressed from 0 to 1.
+   */
+  @Nullable
+  public final Ratio percent;
+
+  /**
+   * Current fuel percentage, expressed from 0 to 1.
+   */
+  @Nullable
+  public final Distance range;
+
+  public RentalVehicleFuel(@Nullable Ratio fuelPercent, @Nullable Distance range) {
+    this.percent = fuelPercent;
+    this.range = range;
+  }
+
+  @Nullable
+  public Double getPercent() {
+    return this.percent != null ? this.percent.asDouble() : null;
+  }
+
+  @Nullable
+  public Integer getRange() {
+    return this.range != null ? this.range.toMeters() : null;
+  }
+}

application/src/main/java/org/opentripplanner/service/vehiclerental/model/VehicleRentalVehicle.java

@@ -22,9 +22,9 @@ public class VehicleRentalVehicle implements VehicleRentalPlace {
   public boolean isReserved = false;
   public boolean isDisabled = false;
   public Instant lastReported;
-  public Double currentRangeMeters;
   public VehicleRentalStation station;
   public String pricingPlanId;
+  public RentalVehicleFuel fuel;
 
   @Override
   public FeedScopedId getId() {
@@ -133,4 +133,8 @@ public VehicleRentalStationUris getRentalUris() {
   public VehicleRentalSystem getVehicleRentalSystem() {
     return system;
   }
+
+  public RentalVehicleFuel getFuel() {
+    return fuel;
+  }
 }

application/src/ext/java/org/opentripplanner/ext/fares/model/Distance.java → application/src/main/java/org/opentripplanner/transit/model/basic/Distance.java

@@ -1,5 +1,6 @@
-package org.opentripplanner.ext.fares.model;
+package org.opentripplanner.transit.model.basic;
 
+import java.util.Objects;
 import org.opentripplanner.utils.tostring.ValueObjectToStringBuilder;
 
 public class Distance {
@@ -8,12 +9,16 @@ public class Distance {
   private final double meters;
 
   /** Returns a Distance object representing the given number of meters */
-  public Distance(double value) {
-    this.meters = value;
+  private Distance(double distanceInMeters) {
+    if (distanceInMeters < 0) {
+      throw new IllegalArgumentException("Distance cannot be negative");
+    }
+
+    this.meters = distanceInMeters;
   }
 
   /** Returns a Distance object representing the given number of meters */
-  public static Distance ofMeters(double value) {
+  public static Distance ofMeters(double value) throws IllegalArgumentException {
     return new Distance(value);
   }
 
@@ -23,8 +28,8 @@ public static Distance ofKilometers(double value) {
   }
 
   /** Returns the distance in meters */
-  public double toMeters() {
-    return this.meters;
+  public int toMeters() {
+    return (int) Math.round(this.meters);
   }
 
   @Override
@@ -36,6 +41,11 @@ public boolean equals(Object other) {
     }
   }
 
+  @Override
+  public int hashCode() {
+    return Objects.hash(meters);
+  }
+
   @Override
   public String toString() {
     if (meters < METERS_PER_KM) {

application/src/main/java/org/opentripplanner/transit/model/basic/Ratio.java

@@ -0,0 +1,76 @@
+package org.opentripplanner.transit.model.basic;
+
+import java.util.Optional;
+import java.util.function.Consumer;
+import javax.annotation.Nullable;
+import org.opentripplanner.utils.lang.DoubleUtils;
+
+/**
+ * Represents a ratio within the range [0, 1].
+ * The class ensures that the ratio value, represented as a double,
+ * falls withing the specified range.
+ */
+public class Ratio {
+
+  private final double ratio;
+
+  private Ratio(double ratio) {
+    this.ratio = DoubleUtils.roundTo3Decimals(ratio);
+  }
+
+  /**
+   * This method is similar to {@link #of(double, Consumer)}, but throws an
+   * {@link IllegalArgumentException} if the ratio is not valid.
+   */
+  public static Ratio of(double ratio) {
+    return of(
+      ratio,
+      errMsg -> {
+        throw new IllegalArgumentException(errMsg);
+      }
+    )
+      .orElseThrow();
+  }
+
+  public static Optional<Ratio> of(double ratio, Consumer<String> validationErrorHandler) {
+    if (ratio >= 0d && ratio <= 1d) {
+      return Optional.of(new Ratio(ratio));
+    } else {
+      validationErrorHandler.accept("Ratio must be in range [0,1], but was: " + ratio);
+      return Optional.empty();
+    }
+  }
+
+  public static Optional<Ratio> ofBoxed(
+    @Nullable Double ratio,
+    Consumer<String> validationErrorHandler
+  ) {
+    if (ratio == null) {
+      return Optional.empty();
+    }
+    return of(ratio, validationErrorHandler);
+  }
+
+  @Override
+  public boolean equals(Object o) {
+    if (o == null || getClass() != o.getClass()) {
+      return false;
+    }
+    var other = (Ratio) o;
+    return Double.compare(ratio, other.ratio) == 0;
+  }
+
+  @Override
+  public int hashCode() {
+    return Double.hashCode(ratio);
+  }
+
+  @Override
+  public String toString() {
+    return Double.toString(ratio);
+  }
+
+  public double asDouble() {
+    return ratio;
+  }
+}

application/src/main/java/org/opentripplanner/updater/vehicle_rental/datasources/GbfsFreeVehicleStatusMapper.java

@@ -9,14 +9,23 @@
 import org.mobilitydata.gbfs.v2_3.free_bike_status.GBFSBike;
 import org.mobilitydata.gbfs.v2_3.free_bike_status.GBFSRentalUris;
 import org.opentripplanner.framework.i18n.NonLocalizedString;
+import org.opentripplanner.service.vehiclerental.model.RentalVehicleFuel;
 import org.opentripplanner.service.vehiclerental.model.RentalVehicleType;
 import org.opentripplanner.service.vehiclerental.model.VehicleRentalStationUris;
 import org.opentripplanner.service.vehiclerental.model.VehicleRentalSystem;
 import org.opentripplanner.service.vehiclerental.model.VehicleRentalVehicle;
+import org.opentripplanner.transit.model.basic.Distance;
+import org.opentripplanner.transit.model.basic.Ratio;
 import org.opentripplanner.transit.model.framework.FeedScopedId;
+import org.opentripplanner.utils.logging.Throttle;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
 
 public class GbfsFreeVehicleStatusMapper {
 
+  private static final Logger LOG = LoggerFactory.getLogger(GbfsFreeVehicleStatusMapper.class);
+  private static final Throttle FUEL_PERCENT_LOG_THROTTLE = Throttle.ofOneMinute();
+
   private final VehicleRentalSystem system;
 
   private final Map<String, RentalVehicleType> vehicleTypes;
@@ -52,7 +61,41 @@ public VehicleRentalVehicle mapFreeVehicleStatus(GBFSBike vehicle) {
         vehicle.getLastReported() != null
           ? Instant.ofEpochSecond((long) (double) vehicle.getLastReported())
           : null;
-      rentalVehicle.currentRangeMeters = vehicle.getCurrentRangeMeters();
+
+      var fuelRatio = Ratio
+        .ofBoxed(
+          vehicle.getCurrentFuelPercent(),
+          validationErrorMessage ->
+            FUEL_PERCENT_LOG_THROTTLE.throttle(() ->
+              LOG.warn("'currentFuelPercent' is not valid. Details: " + validationErrorMessage)
+            )
+        )
+        .orElse(null);
+
+      Distance rangeMeters = null;
+      try {
+        rangeMeters =
+          vehicle.getCurrentRangeMeters() != null
+            ? Distance.ofMeters(vehicle.getCurrentRangeMeters())
+            : null;
+      } catch (IllegalArgumentException e) {
+        LOG.warn(
+          "Current range meter value not valid: {} - {}",
+          vehicle.getCurrentRangeMeters(),
+          e.getMessage()
+        );
+      }
+      // if the propulsion type has an engine current_range_meters is required
+      if (
+        vehicle.getVehicleTypeId() != null &&
+        vehicleTypes.get(vehicle.getVehicleTypeId()) != null &&
+        vehicleTypes.get(vehicle.getVehicleTypeId()).propulsionType !=
+        RentalVehicleType.PropulsionType.HUMAN &&
+        rangeMeters == null
+      ) {
+        return null;
+      }
+      rentalVehicle.fuel = new RentalVehicleFuel(fuelRatio, rangeMeters);
       rentalVehicle.pricingPlanId = vehicle.getPricingPlanId();
       GBFSRentalUris rentalUris = vehicle.getRentalUris();
       if (rentalUris != null) {

application/src/main/resources/org/opentripplanner/apis/gtfs/schema.graphqls

@@ -1889,6 +1889,8 @@ type RealTimeEstimate {
 type RentalVehicle implements Node & PlaceInterface {
   "If true, vehicle is currently available for renting."
   allowPickupNow: Boolean
+  "Fuel or battery status of the rental vehicle"
+  fuel: RentalVehicleFuel
   "Global object ID provided by Relay. This value can be used to refetch this object using **node** query."
   id: ID!
   "Latitude of the vehicle (WGS 84)"
@@ -1918,6 +1920,14 @@ type RentalVehicleEntityCounts {
   total: Int!
 }
 
+"Rental vehicle fuel represent the current status of the battery or fuel of a rental vehicle"
+type RentalVehicleFuel {
+  "Fuel or battery power remaining in the vehicle. Expressed from 0 to 1."
+  percent: Ratio
+  "Range in meters that the vehicle can travel with the current charge or fuel."
+  range: Int
+}
+
 type RentalVehicleType {
   "The vehicle's general form factor"
   formFactor: FormFactor