crawler

type Direction struct {
	//Name is the name of the route - typically the names of the first
	// and last stops separated by a dash e.g "Ж.к.Западен парк - Метростанция Витоша".
	// But there are really strange examples including middle stops.
	Name string `json:"name"`
	//Unique ID for the direction of the line disregarding operation.
	// The ID is taken from schedules.sofiatraffic.bg.
	ID string `json:"id"`
}

type Line struct {
	//Name is the name of the line - e.g "85", "44-Б", "7-А", etc.
	Name string `json:"name"`

	//Transportation is denoting the type of Transportation of a line e.g Tram.
	Transportation `json:"transportation_type"`

	//OperationIDMap is mapping between Operation and OperationID.
	// This is needed because each line has different number of Operation modes.
	OperationIDMap `json:"operation_id_map"`

	//OperationIDRoutesMap is entry point to rest of the data for a given line
	// namely a list of all of its routes.
	OperationIDRoutesMap `json:"operation_routes_map"`
}

type Operation int

type OperationID string

type OperationIDMap map[Operation]OperationID

type OperationIDRoutesMap map[OperationID]Routes

type Route struct {
	Direction `json:"direction"`
	Stops     `json:"stops"`
}

type Routes []Route

type ScheduleID string

type ScheduleTimes []string

type SofiaTrafficCrawler struct {

	//List of active lines that were found during crawling
	Lines []Line

	//Map with keys unique string of type {OperationID}/{DirectionID}/{StopSign}
	Schedules map[ScheduleID]ScheduleTimes

	//List of active stops found on virtual tables site during crawling
	VirtualTableStops []VirtualTableStop

	//Map between those found stops and a string of comma separated times of arrival of the next vehicle
	VirtualTableStopsTimes map[VirtualTableStop]string
	// contains filtered or unexported fields
}

type Stop struct {
	//Regular name of a of a stop e.g `Метростанция "Витоша"`.
	// Extracted from m.sofiatraffic.bg/schedules/.
	Name string `json:"name"`

	//Capital name of the same stop e.g  `МЕТРОСТАНЦИЯ ВИТОША`.
	// Extracted from schedules.sofiatraffic.bg.
	CapitalName string `json:"capital_name"`

	//Sign represents an ID which is marked on each actual stop sign in the real life.
	// It is second most common way to refer to a stop after its name, e.g 0910.
	// This is bridging matcher between  schedules.sofiatraffic.bg and m.sofiatraffic.bg/schedules/.
	Sign string `json:"sign"`

	//ID is a unique ID for a stop.
	// Extracted from schedules.sofiatraffic.bg.
	ID string `json:"id"`

	//VirtualTableStop is a mapped (if that mapping exist) virtual tables entry.
	// It can be used to query the given stop for real time data such as comma separated times.
	VirtualTableStop `json:"vt_stop"`
}

type Stops []Stop

type Transportation int

type VirtualTableStop struct {
	//Unique ID for a stop on m.sofiatraffic.bg logic.
	StopID string `json:"stop"`

	//Line ID for the given stop on m.sofiatraffic.bg logic.
	LineID string `json:"lid"`

	//Route ID for the given line on m.sofiatraffic.bg logic.
	RouteID string `json:"rid"`

	//TransportationType matches Line.Transportation but is kept here for easy string access.
	TransportationType string `json:"vt"`
}