Merge pull request #45 from entur/add-rule-no-missing-store-uris-in-system-information

feature: new rule to verify store uris exist in system_information

Author: testower

README.md

@@ -21,10 +21,7 @@ List of additional rules:
 * `NoMissingVehicleTypesAvailableWhenVehicleTypesExists`
 * `NoMissingVehicleTypeIdInVehicleStatusWhenVehicleTypesExist`
 * `NoMissingCurrentRangeMetersInVehicleStatusForMotorizedVehicles`
-
-Planned rules:
-
-* if free_bike_status / vehicle_status or station_information has rental uris then system_information must have store_uri in rental_apps (ios and / or android)
+* `NoMissingStoreUriInSystemInformation`
 
 ## Non-schema rules:
 

src/main/java/org/entur/gbfs/validation/validator/rules/NoMissingStoreUriInSystemInformation.java

@@ -0,0 +1,104 @@
+/*
+ *
+ *  *
+ *  *
+ *  *  * Licensed under the EUPL, Version 1.2 or – as soon they will be approved by
+ *  *  * the European Commission - subsequent versions of the EUPL (the "Licence");
+ *  *  * You may not use this work except in compliance with the Licence.
+ *  *  * You may obtain a copy of the Licence at:
+ *  *  *
+ *  *  *   https://joinup.ec.europa.eu/software/page/eupl
+ *  *  *
+ *  *  * Unless required by applicable law or agreed to in writing, software
+ *  *  * distributed under the Licence is distributed on an "AS IS" basis,
+ *  *  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *  *  * See the Licence for the specific language governing permissions and
+ *  *  * limitations under the Licence.
+ *  *
+ *
+ */
+
+package org.entur.gbfs.validation.validator.rules;
+
+import com.jayway.jsonpath.DocumentContext;
+import com.jayway.jsonpath.JsonPath;
+import org.json.JSONArray;
+import org.json.JSONObject;
+
+import java.util.Map;
+
+/**
+ * It is required to provide ios and android store uris in system_information if vehicle_status
+ * or station_information has ios and android rental uris respectively
+ */
+public class NoMissingStoreUriInSystemInformation implements CustomRuleSchemaPatcher {
+
+    private static final String DATA_REQUIRED_SCHEMA_PATH = "$.properties.data.required";
+    private static final String RENTAL_APPS_SCHEMA_PATH = "$.properties.data.properties.rental_apps";
+
+
+    private final String vehicleStatusFileName;
+
+
+    public NoMissingStoreUriInSystemInformation(String vehicleStatusFileName) {
+        this.vehicleStatusFileName = vehicleStatusFileName;
+    }
+
+    @Override
+    public DocumentContext addRule(DocumentContext rawSchemaDocumentContext, Map<String, JSONObject> feeds) {
+        boolean hasIosRentalUris = false;
+        boolean hasAndroidRentalUris = false;
+
+        JSONObject vehicleStatusFeed = feeds.get(vehicleStatusFileName);
+
+        if (vehicleStatusFeed != null) {
+            String vehiclesKey = vehicleStatusFileName.equals("vehicle_status") ? "vehicles" : "bikes";
+
+             if (!((JSONArray) JsonPath.parse(vehicleStatusFeed)
+                    .read("$.data." + vehiclesKey + "[:1].rental_uris.ios")).isEmpty()) {
+                 hasIosRentalUris = true;
+             }
+
+             if (!((JSONArray) JsonPath.parse(vehicleStatusFeed)
+                    .read("$.data." + vehiclesKey + "[:1].rental_uris.android")).isEmpty()) {
+                 hasAndroidRentalUris = true;
+             }
+        }
+
+        JSONObject stationInformationFeed = feeds.get("station_information");
+
+        if (stationInformationFeed != null) {
+            if (!((JSONArray) JsonPath.parse(stationInformationFeed)
+                    .read("$.data.stations[:1].rental_uris.ios")).isEmpty()) {
+                hasIosRentalUris = true;
+            }
+
+            if (!((JSONArray) JsonPath.parse(stationInformationFeed)
+                    .read("$.data.stations[:1].rental_uris.android")).isEmpty()) {
+                hasAndroidRentalUris = true;
+            }
+        }
+
+        if (hasIosRentalUris || hasAndroidRentalUris) {
+
+            JSONArray systemInformationDataRequiredSchema = rawSchemaDocumentContext.read(DATA_REQUIRED_SCHEMA_PATH);
+            systemInformationDataRequiredSchema.put("rental_apps");
+
+            JSONObject rentalAppsSchema = rawSchemaDocumentContext.read(RENTAL_APPS_SCHEMA_PATH);
+            JSONArray rentalAppRequired = new JSONArray();
+
+
+            if (hasIosRentalUris) {
+                rentalAppRequired.put("ios");
+            }
+
+            if (hasAndroidRentalUris) {
+                rentalAppRequired.put("android");
+            }
+
+            rentalAppsSchema.put("required", rentalAppRequired);
+        }
+
+        return rawSchemaDocumentContext;
+    }
+}

src/main/java/org/entur/gbfs/validation/validator/versions/Version21.java

@@ -20,6 +20,7 @@
 
 import org.entur.gbfs.validation.validator.rules.NoMissingCurrentRangeMetersInVehicleStatusForMotorizedVehicles;
 import org.entur.gbfs.validation.validator.rules.CustomRuleSchemaPatcher;
+import org.entur.gbfs.validation.validator.rules.NoMissingStoreUriInSystemInformation;
 import org.entur.gbfs.validation.validator.rules.NoMissingVehicleTypeIdInVehicleStatusWhenVehicleTypesExist;
 import org.entur.gbfs.validation.validator.rules.NoInvalidReferenceToVehicleTypesInStationStatus;
 import org.entur.gbfs.validation.validator.rules.NoMissingVehicleTypesAvailableWhenVehicleTypesExists;
@@ -55,6 +56,9 @@ public class Version21 extends AbstractVersion {
             "free_bike_status", List.of(
                     new NoMissingVehicleTypeIdInVehicleStatusWhenVehicleTypesExist("free_bike_status"),
                     new NoMissingCurrentRangeMetersInVehicleStatusForMotorizedVehicles("free_bike_status")
+            ),
+            "system_information", List.of(
+                    new NoMissingStoreUriInSystemInformation("free_bike_status")
             )
     );
 

src/main/java/org/entur/gbfs/validation/validator/versions/Version22.java

@@ -20,6 +20,7 @@
 
 import org.entur.gbfs.validation.validator.rules.NoMissingCurrentRangeMetersInVehicleStatusForMotorizedVehicles;
 import org.entur.gbfs.validation.validator.rules.CustomRuleSchemaPatcher;
+import org.entur.gbfs.validation.validator.rules.NoMissingStoreUriInSystemInformation;
 import org.entur.gbfs.validation.validator.rules.NoMissingVehicleTypeIdInVehicleStatusWhenVehicleTypesExist;
 import org.entur.gbfs.validation.validator.rules.NoInvalidReferenceToVehicleTypesInStationStatus;
 import org.entur.gbfs.validation.validator.rules.NoMissingVehicleTypesAvailableWhenVehicleTypesExists;
@@ -55,6 +56,9 @@ public class Version22 extends AbstractVersion {
             "free_bike_status", List.of(
                     new NoMissingVehicleTypeIdInVehicleStatusWhenVehicleTypesExist("free_bike_status"),
                     new NoMissingCurrentRangeMetersInVehicleStatusForMotorizedVehicles("free_bike_status")
+            ),
+            "system_information", List.of(
+                    new NoMissingStoreUriInSystemInformation("free_bike_status")
             )
     );
 

src/main/java/org/entur/gbfs/validation/validator/versions/Version23.java

@@ -21,6 +21,7 @@
 import org.entur.gbfs.validation.validator.rules.NoMissingCurrentRangeMetersInVehicleStatusForMotorizedVehicles;
 import org.entur.gbfs.validation.validator.rules.CustomRuleSchemaPatcher;
 import org.entur.gbfs.validation.validator.rules.NoInvalidReferenceToPricingPlansInVehicleTypes;
+import org.entur.gbfs.validation.validator.rules.NoMissingStoreUriInSystemInformation;
 import org.entur.gbfs.validation.validator.rules.NoMissingVehicleTypeIdInVehicleStatusWhenVehicleTypesExist;
 import org.entur.gbfs.validation.validator.rules.NoInvalidReferenceToVehicleTypesInStationStatus;
 import org.entur.gbfs.validation.validator.rules.NoMissingVehicleTypesAvailableWhenVehicleTypesExists;
@@ -59,6 +60,9 @@ public class Version23 extends AbstractVersion {
             "free_bike_status", List.of(
                     new NoMissingVehicleTypeIdInVehicleStatusWhenVehicleTypesExist("free_bike_status"),
                     new NoMissingCurrentRangeMetersInVehicleStatusForMotorizedVehicles("free_bike_status")
+            ),
+            "system_information", List.of(
+                    new NoMissingStoreUriInSystemInformation("free_bike_status")
             )
     );
 

src/main/java/org/entur/gbfs/validation/validator/versions/Version30_RC.java

@@ -21,6 +21,7 @@
 import org.entur.gbfs.validation.validator.rules.NoMissingCurrentRangeMetersInVehicleStatusForMotorizedVehicles;
 import org.entur.gbfs.validation.validator.rules.CustomRuleSchemaPatcher;
 import org.entur.gbfs.validation.validator.rules.NoInvalidReferenceToPricingPlansInVehicleTypes;
+import org.entur.gbfs.validation.validator.rules.NoMissingStoreUriInSystemInformation;
 import org.entur.gbfs.validation.validator.rules.NoMissingVehicleTypeIdInVehicleStatusWhenVehicleTypesExist;
 import org.entur.gbfs.validation.validator.rules.NoInvalidReferenceToVehicleTypesInStationStatus;
 import org.entur.gbfs.validation.validator.rules.NoMissingVehicleTypesAvailableWhenVehicleTypesExists;
@@ -58,6 +59,9 @@ public class Version30_RC extends AbstractVersion {
             "vehicle_status", List.of(
                     new NoMissingVehicleTypeIdInVehicleStatusWhenVehicleTypesExist("vehicle_status"),
                     new NoMissingCurrentRangeMetersInVehicleStatusForMotorizedVehicles("vehicle_status")
+            ),
+            "system_information", List.of(
+                    new NoMissingStoreUriInSystemInformation("vehicle_status")
             )
     );