Added public transit. Fix #113

Author: Fluepke

.classpath

@@ -13,5 +13,5 @@
 	<classpathentry kind="src" path="test"/>
 	<classpathentry kind="con" path="org.eclipse.jdt.launching.JRE_CONTAINER/org.eclipse.jdt.internal.debug.ui.launcher.StandardVMType/JavaSE-1.8/"/>
 	<classpathentry kind="con" path="org.eclipse.buildship.core.gradleclasspathcontainer"/>
-	<classpathentry kind="output" path="build/classes"/>
+	<classpathentry kind="output" path="bin"/>
 </classpath>

.gitmodules

@@ -0,0 +1,3 @@
+[submodule "dependencies/public-transport-enabler"]
+	path = dependencies/public-transport-enabler
+	url = https://github.com/schildbach/public-transport-enabler.git

build.gradle

@@ -55,6 +55,7 @@ dependencies {
   compile group: 'org.bouncycastle', name: 'bcprov-jdk15on', version: '1.+'
   compile group: 'org.bouncycastle', name: 'bcpkix-jdk15on', version: '1.+'
   compile group: 'jfree', name: 'jfreechart', version: '1.+'
+  compile(project(':dependencies:public-transport-enabler:enabler')) {	}
 }
 
 tasks.withType(Javadoc) {

conf/susi/bahn.json

@@ -0,0 +1,11 @@
+{"rules":[
+	{
+		"example":"How to get from München HBF to Potsdam Griebnitzsee",
+		"phrases":[ {"type":"pattern", "expression":"How to get from * to *"}
+		],
+		"process":[ {"type":"console", "expression":"SELECT description FROM bahn WHERE from='$1$' to='$2$';"}],
+		"actions":[ {"type":"answer", "select":"random", "phrases":[
+			"$description$",
+		]}],
+	},
+]}

dependencies/public-transport-enabler

@@ -1 +1,2 @@
 rootProject.name = 'susi_server'
+include ':dependencies:public-transport-enabler:enabler'

settings.gradle

@@ -43,6 +43,8 @@
 import ai.susi.server.BaseUserRole;
 import ai.susi.server.ClientConnection;
 import ai.susi.server.Query;
+import api.external.transit.BahnService;
+import api.external.transit.BahnService.NoStationFoundException;
 
 import javax.servlet.http.HttpServletResponse;
 
@@ -176,6 +178,25 @@ public static byte[] loadData(String url) throws IOException {
             }
             return json;
         });
+        dbAccess.put(Pattern.compile("SELECT +?(.*?) +?FROM +?bahn +?WHERE +?from ??= ??'(.*?)' +?to ??= ??'(.*?)' ??;"), (flow, matcher) -> {
+        	String query = matcher.group(1);
+        	String from = matcher.group(2);
+        	String to = matcher.group(3);
+        	SusiThought json = new SusiThought();
+			try {
+				json = (new BahnService()).getConnections(from, to);
+				SusiTransfer transfer = new SusiTransfer(query);
+                json.setData(transfer.conclude(json.getData()));
+                return json;
+			} catch (IOException e) {
+				// TODO Auto-generated catch block
+				e.printStackTrace();
+			} catch (NoStationFoundException e) {
+				// TODO Auto-generated catch block
+				e.printStackTrace();
+			}
+			return json;
+        });
     }
 
     @Override

src/ai/susi/server/api/susi/ConsoleService.java

@@ -0,0 +1,57 @@
+package api.external.transit;
+import java.io.IOException;
+import java.util.Calendar;
+import java.util.Date;
+import java.util.List;
+
+import org.json.*;
+
+import ai.susi.mind.SusiThought;
+import de.schildbach.pte.*;
+import de.schildbach.pte.dto.Location;
+import de.schildbach.pte.dto.QueryTripsResult;
+import de.schildbach.pte.dto.Trip;
+
+public class BahnService {
+	@SuppressWarnings("serial")
+	public static class NoStationFoundException extends Exception {
+		public NoStationFoundException(String stationName) {
+			super("No station named '" + stationName + "' found.");
+		}
+	}
+	private BahnProvider provider = new BahnProvider();
+	
+	public SusiThought getConnections(String from, String to) throws IOException, NoStationFoundException {
+		Calendar cal = Calendar.getInstance();
+		return this.getConnections(from, to, cal.get(Calendar.HOUR_OF_DAY), cal.get(Calendar.MINUTE));
+	}
+	
+	@SuppressWarnings("deprecation")
+	public SusiThought getConnections(String from, String to, int hoursDep, int minutesDep) throws IOException, NoStationFoundException {
+		// Yes, Date is deprecated, but the referenced library needs it...
+		Date date = new Date();
+		date.setHours(hoursDep);
+		date.setMinutes(minutesDep);
+		SusiThought response = new SusiThought();
+		JSONArray data = new JSONArray();
+		
+		List<Location> fromLocations = provider.suggestLocations(from).getLocations();
+		List<Location> toLocations = provider.suggestLocations(to).getLocations();
+		if (fromLocations.size() == 0) {
+			throw new NoStationFoundException(from);
+		}
+		if (toLocations.size() == 0) {
+			throw new NoStationFoundException(to);
+		}
+		
+		QueryTripsResult tripsResult = provider.queryTrips(fromLocations.get(0), null, toLocations.get(0), date, true, null, null, null, null, null);
+		response.setHits(tripsResult.trips.size());
+		
+		for (Trip trip : tripsResult.trips) {
+			data.put(JSONConverter.tripToJSON(trip));
+		}
+		response.setData(data);
+		
+		return response;
+	}
+}

src/api/external/transit/BahnService.java

@@ -0,0 +1,109 @@
+package api.external.transit;
+
+import java.util.List;
+
+import org.json.JSONArray;
+import org.json.JSONObject;
+
+import de.schildbach.pte.dto.Fare;
+import de.schildbach.pte.dto.Location;
+import de.schildbach.pte.dto.Trip;
+import de.schildbach.pte.dto.Trip.Leg;
+import de.schildbach.pte.dto.Line;
+
+public class JSONConverter {
+	public static JSONObject tripToJSON(Trip trip) {
+		JSONObject tripObj = new JSONObject();
+		tripObj.put("durationMinutes", trip.getDuration() / 60000.0);
+		tripObj.put("departureTime", trip.getFirstDepartureTime());
+		JSONObject legs = new JSONObject();
+		for (Integer i = 0; i < trip.legs.size(); i++) {
+			legs.put(i.toString(), JSONConverter.legToJSON(trip.legs.get(i)));
+		}
+		tripObj.put("legs", legs);
+		tripObj.put("numChanges", trip.numChanges);
+		JSONArray fares = new JSONArray();
+		if (trip.fares != null) {
+			for (Fare fare : trip.fares) {
+				fares.put(JSONConverter.fareToJson(fare));
+			}
+			tripObj.put("fares", fares);
+		}
+		tripObj.put("description", JSONConverter.getDescription(trip.legs));
+		return tripObj;
+	}
+	
+	public static JSONObject fareToJson(Fare fare) {
+		JSONObject fareObj = new JSONObject();
+		if (fare == null) return fareObj;
+		fareObj.put("currency", fare.currency.getCurrencyCode());
+		fareObj.put("fare", fare.fare);
+		fareObj.put("network", fare.network);
+		fareObj.put("units", fare.units);
+		fareObj.put("unitName", fare.unitName);
+		fareObj.put("class", fare.getClass().getName());
+		return fareObj;
+	}
+	
+	public static JSONObject legToJSON(Leg leg) {
+		JSONObject legObj = new JSONObject();
+		if (leg == null) return legObj;
+		legObj.put("departure", JSONConverter.locationToJSON(leg.departure));
+		legObj.put("arrival", JSONConverter.locationToJSON(leg.arrival));
+		legObj.put("departureTime", leg.getDepartureTime());
+		legObj.put("arrivalTime", leg.getArrivalTime());
+		if (leg instanceof Trip.Public) {
+			Trip.Public pub = (Trip.Public)leg;
+			legObj.putOpt("departureDelay", pub.getDepartureDelay() / 60000.0);
+			legObj.putOpt("arrivalDelay", pub.getArrivalDelay() / 60000.0);
+			legObj.putOpt("line", JSONConverter.lineToJSON(pub.line));
+		}
+		return legObj;
+	}
+	
+	public static JSONObject lineToJSON(Line line) {
+		JSONObject lineObj = new JSONObject();
+		if (line == null) return lineObj;
+		lineObj.put("id", line.id);
+		lineObj.put("name", line.name);
+		lineObj.put("label", line.label);
+		lineObj.put("message", line.message);
+		lineObj.put("network", line.network);
+		lineObj.put("product", line.product.toString());
+		return lineObj;
+	}
+	
+	public static JSONObject locationToJSON(Location location) {
+		JSONObject locationObj = new JSONObject();
+		if (location == null) return locationObj;
+		JSONObject coordinateObj = new JSONObject();
+		coordinateObj.put("lat", location.lat);
+		coordinateObj.put("lon", location.lon);
+		locationObj.put("coords", coordinateObj);
+		locationObj.put("name", location.name);
+		locationObj.put("place", location.place);
+		locationObj.put("id", location.id);
+		return locationObj;
+	}
+	
+	@SuppressWarnings("deprecation")
+	public static String getDescription(List<Leg> legs) {
+		String response = "";
+		for (int i = 0; i < legs.size(); i++) {
+			if (!(legs.get(i) instanceof Trip.Public)) continue;
+			if (i == 0) {
+				response += "Take the ";
+			} else {
+				response += " From there, take the ";
+			}
+			Trip.Public pub = (Trip.Public)legs.get(i);
+			response += pub.line.label;
+			response += " (departing at " + pub.getDepartureTime().getHours() + ":" + pub.getDepartureTime().getMinutes();
+			response += ", +" + (pub.getDepartureDelay() / 60000.0) + " mins delay) to ";
+			response += pub.arrival.name;
+			response += " (arriving at " + pub.getArrivalTime().getHours() + ":" + pub.getArrivalTime().getMinutes();
+			response += ", +" + (pub.getArrivalDelay() / 60000.0) + " mins delay).";
+		}
+		return response;
+	}
+}

src/api/external/transit/JSONConverter.java

@@ -0,0 +1,18 @@
+package api.external;
+
+import java.io.IOException;
+
+import org.junit.Test;
+
+import api.external.transit.*;
+import api.external.transit.BahnService.NoStationFoundException;
+
+public class BahnTest {
+	BahnService service = new BahnService();
+	
+	@Test
+	public void testConnection() throws IOException, NoStationFoundException {
+		System.out.println(service.getConnections("Alexanderplatz", "Griebnitzsee"));
+		System.out.println(service.getConnections("München HBF", "Griebnitzsee").getData().getJSONObject(0).getString("description"));
+	}
+}

test/api/external/BahnTest.java

@@ -0,0 +1,40 @@
+package api.external;
+
+import static org.junit.Assert.assertFalse;
+import static org.junit.Assert.assertTrue;
+
+import java.io.IOException;
+import java.net.URISyntaxException;
+import java.util.List;
+
+import org.apache.http.client.ClientProtocolException;
+import org.json.JSONObject;
+import org.junit.Test;
+
+import api.external.deliveroo.*;
+
+public class DeliverooTest {
+	private static String rawJson = "{\"id\":36242,\"name\":\"Sigiriya\",\"name_with_branch\":\"Sigiriya\",\"uname\":\"sigiriya\",\"price_category\":2,\"currency_symbol\":\"\u20AC\",\"primary_image_url\":\"https://cdn1.deliveroo.co.uk/media/menus/28019/320x180.jpg?v=1481188440\",\"image_url\":\"https://cdn1.deliveroo.co.uk/media/menus/28019/{w}x{h}.jpg?v=1481188440{&filters}{&quality}\",\"neighborhood\":{\"id\":519,\"name\":\"Friedrichshain\",\"uname\":\"friedrichshain\"},\"coordinates\":[13.4579792,52.5113786],\"newly_added\":false,\"category\":\"Nur Bei Uns\",\"curr_prep_time\":20,\"delay_time\":0,\"baseline_deliver_time\":21,\"total_time\":20,\"distance_m\":590,\"travel_time\":10,\"kitchen_open_advance\":0,\"hours\":{\"today\":[],\"tomorrow\":[]},\"opening_hours\":{\"today\":[[\"12:00\",\"22:30\"]],\"tomorrow\":[[\"12:00\",\"22:30\"]]},\"target_delivery_time\":{\"minutes\":\"15 - 25\"},\"menu\":{\"menu_tags\":[{\"id\":293,\"type\":\"Collection\",\"name\":\"Nur Bei Uns\"},{\"id\":33,\"type\":\"Locale\",\"name\":\"S\u00FCdindisch\"},{\"id\":188,\"type\":\"Locale\",\"name\":\"Sri Lankisch\"},{\"id\":86,\"type\":\"Dietary\",\"name\":\"Vegetarier\"},{\"id\":71,\"type\":\"Food\",\"name\":\"Meeresfr\u00FCchte\"}]},\"open\":false,\"delivery_hours\":{\"today\":[],\"tomorrow\":[]}}";
+	
+	@Test
+	public void testParsing() {
+		Restaurant restaurant = new Restaurant(new JSONObject(rawJson));
+		assertTrue(restaurant.getName().equals("Sigiriya"));
+		assertTrue(restaurant.getCoordinate().getLatitude().equals("13.4579792"));
+	}
+
+	// test the exptected behaviour of the deliveroo API
+	@Test
+	public void testAPI() throws ClientProtocolException, URISyntaxException, IOException {
+		Client client = new Client();
+		List<Restaurant> restaurants = Restaurant.fetchRestaurants(client, new Coordinate("52.5166791", "13.4584727"));
+		assertFalse(restaurants.isEmpty());
+		restaurants.get(0).fetchMenuItems(client);
+	}
+	
+	// test the demo
+	@Test
+	public void testDemo() throws ClientProtocolException, URISyntaxException, IOException {
+		DeliverooDemo.main(null);
+	}
+}