Merge pull request #20 from HBTGmbH/feature/add-query-for-stop

add query for stop by id

Author: leonardehrenfried

Diff for: src/main/java/org/opentripplanner/client/OtpApiClient.java

@@ -18,6 +18,7 @@
 import org.apache.hc.core5.http.io.entity.StringEntity;
 import org.opentripplanner.client.model.Pattern;
 import org.opentripplanner.client.model.Route;
+import org.opentripplanner.client.model.Stop;
 import org.opentripplanner.client.model.TripPlan;
 import org.opentripplanner.client.model.VehicleRentalStation;
 import org.opentripplanner.client.parameters.TripPlanParameters;
@@ -114,6 +115,27 @@ public List<Pattern> patterns() throws IOException {
     return deserializeList(json, type, "/data/patterns");
   }
 
+  /**
+   * Returns a Stop with limited information.
+   *
+   * @link <a href="https://docs.opentripplanner.org/api/dev-2.x/graphql-gtfs/queries/stop">OTP API
+   *     docs</a>
+   */
+  public Stop stop(String gtfsId) throws IOException {
+
+    var stopQuery = GraphQLQueries.stop();
+    var formattedQuery = stopQuery.formatted(gtfsId);
+
+    final var jsonNode = sendRequest(formattedQuery);
+    try {
+      var stop = jsonNode.at("/data/stop");
+      return mapper.treeToValue(stop, Stop.class);
+    } catch (IOException e) {
+      LOG.error("Could not deserialize response: {}", jsonNode.toPrettyString());
+      throw e;
+    }
+  }
+
   private <T> List<T> deserializeList(JsonNode json, CollectionType type, String path)
       throws JsonProcessingException {
     return mapper.treeToValue(json.at(path), type);

Diff for: src/main/java/org/opentripplanner/client/query/GraphQLQueries.java

@@ -21,6 +21,10 @@ public static String patterns() {
     return loadQuery("patterns");
   }
 
+  public static String stop() {
+    return loadQuery("stop");
+  }
+
   private static String loadQuery(String name) {
     var is =
         GraphQLQueries.class

Diff for: src/main/resources/queries/stop.graphql

@@ -0,0 +1,7 @@
+query {
+    stop(id: "%s") {
+        name
+        gtfsId
+        code
+    }
+}

Diff for: src/test/java/org/opentripplanner/IntegrationTest.java

@@ -5,6 +5,7 @@
 import static org.junit.jupiter.api.Assertions.assertNotNull;
 import static org.opentripplanner.StationParameters.OSLO_EAST;
 import static org.opentripplanner.StationParameters.OSLO_LUFTHAVN_ID;
+import static org.opentripplanner.StationParameters.OSLO_LUFTHAVN_QUAY;
 import static org.opentripplanner.StationParameters.OSLO_S_ID;
 import static org.opentripplanner.StationParameters.OSLO_WEST;
 
@@ -187,6 +188,18 @@ public void patterns() throws IOException {
         });
   }
 
+  @Test
+  public void stop() throws IOException {
+
+    var result = client.stop(OSLO_LUFTHAVN_QUAY);
+
+    LOG.info("Received stop");
+
+    assertNotNull(result);
+    assertNotNull(result.name());
+    assertNotNull(result.id());
+  }
+
   @Disabled
   @Test
   public void seattleFares() throws IOException {

Diff for: src/test/java/org/opentripplanner/StationParameters.java

@@ -8,4 +8,5 @@ public interface StationParameters {
   Coordinate OSLO_WEST = new Coordinate(59.9203, 10.6823);
   StopId OSLO_LUFTHAVN_ID = new StopId("RB:NSR:StopPlace:5357");
   StopId OSLO_S_ID = new StopId("RB:NSR:StopPlace:337");
+  String OSLO_LUFTHAVN_QUAY = "RB:NSR:Quay:9786";
 }