Vehicles Implementation

CHANGELOG.md

@@ -5,6 +5,10 @@
 
 ### Added
 
+- Testing for every transportation system
+- `Vehicle` object
+- `TransportationSystem.getVehicles()` which returns a list of `Vehicle` objects
+
 ### Changed
 
 - Fixed `AttributeError: 'list' object has no attribute 'items'` error thrown in `TransportationSystem.getRoutes()`

passiogo/__init__.py

@@ -338,6 +338,65 @@ def getSystemAlerts(
 
 		return(allAlerts)
 
+	def getVehicles(
+		self,
+		paramDigit = 2
+	) -> list["Vehicle"]:
+		"""
+		Gets all currently running buses.
+		=========
+		s0: system from which to get content
+		paramDigit:
+			0: Error
+			>=1: Valid
+		"""
+
+
+		# Initialize & Send Request
+		url = BASE_URL+"/mapGetData.php?getBuses="+str(paramDigit)
+		body = {
+			"s0" : str(self.id),
+			"sA" : 1
+		}
+		vehicles = sendApiRequest(url, body)
+
+		# Handle Request Error
+		if(vehicles == None):
+			return(None)
+
+		allVehicles = []
+		for vehicleId, vehicle in vehicles["buses"].items():
+			if vehicleId == '-1':
+				continue
+
+			vehicle = vehicle[0]
+
+			for key in ["busId", "busName", "busType", "calculatedCourse", "routeId", "route", "color", "created", "latitude", "longitude", "speed", "paxLoad100", "outOfService", "more", "tripId"]:
+				if key not in vehicle:
+					vehicle[key] = None
+
+
+			allVehicles.append(Vehicle(
+				id = vehicle["busId"],
+				name = vehicle["busName"],
+				type = vehicle["busType"],
+				system = self,
+				calculatedCourse = vehicle["calculatedCourse"],
+				routeId = vehicle["routeId"],
+				routeName = vehicle["route"],
+				color = vehicle["color"],
+				created = vehicle["created"],
+				latitude = vehicle["latitude"],
+				longitude = vehicle["longitude"],
+				speed = vehicle["speed"],
+				paxLoad = vehicle["paxLoad100"],
+				outOfService = vehicle["outOfService"],
+				more = vehicle["more"],
+				tripId = vehicle["tripId"],
+			))
+
+		return(allVehicles)
+
 
 def getSystems(
 	appVersion = 2,
@@ -494,6 +553,7 @@ def getStops(self):
 
 		return(stopsForRoute)
 
+
 ### Stops ###
 
 class Stop:
@@ -521,7 +581,6 @@ def __init__(
 		self.radius = radius
 		self.system = system
 
-
 
 ### System Alerts ###
 
@@ -588,38 +647,49 @@ def __init__(
 		self.fromF = fromF
 		self.fromOk = fromOk
 		self.toOk = toOk
-
 
 
 
+### Vehicles ###
+
+class Vehicle:
+
+	def __init__(
+		self,
+		id: str = None,
+		name: str = None,
+		type: str = None,
+		system: TransportationSystem = None,
+		calculatedCourse: int = None,
+		routeId: str = None,
+		routeName: str = None,
+		color: str = None,
+		created: str = None,
+		latitude: float = None,
+		longitude: float = None,
+		speed: float = None,
+		paxLoad: float = None,
+		outOfService: int = None,
+		more: str = None,
+		tripId: str = None,
+	):
+		self.id = id
+		self.name = name
+		self.type = type
+		self.system = system
+		self.calculatedCourse = calculatedCourse
+		self.routeId = routeId
+		self.routeName = routeName
+		self.color = color
+		self.created = created
+		self.longitude = latitude
+		self.speed = speed
+		self.paxLoad = paxLoad
+		self.outOfService = outOfService
+		self.more = more
+		self.tripId = tripId
+
 
-def getBuses(
-	systemSelected,
-	paramDigit = 2
-):
-	"""
-	Gets all currently running buses.
-	=========
-	s0: system from which to get content
-	paramDigit:
-		0: Error
-		>=1: Valid
-	"""
-
-
-	# Initialize & Send Request
-	url = BASE_URL+"/mapGetData.php?getBuses="+str(paramDigit)
-	body = {
-		"s0" : str(systemSelected),
-		"sA" : 1
-	}
-	buses = sendApiRequest(url, body)
-
-	# Handle Request Error
-	if(buses == None):
-		return(None)
-
-	return(buses)
 
 
 ### Live Timings ###
@@ -650,12 +720,11 @@ def handleWsError(wsapp, error):
 
 def handleWsClose(wsapp, close_status_code, close_msg):
 	wsapp.close()
-	...
 
 
 def subscribeWS(
 	wsapp,
-	userId = 1068
+	userId
 ):
 
 	subscriptionMsg = {

tests/test_main.py

@@ -38,7 +38,7 @@ def test_getAllStops(system):
 def test_getSystemAlerts(system):
 	system.getSystemAlerts()
 
-
-def test_getBuses():
-	passiogo.getBuses(1068)
+@pytest.mark.parametrize("system", pytest.allSystems, ids=ids)
+def test_getVehicles(system):
+	system.getVehicles()