-
-
Notifications
You must be signed in to change notification settings - Fork 0
/
realtime.go
135 lines (113 loc) · 4.15 KB
/
realtime.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
package sl
import (
"context"
"errors"
)
// realtimeEndpoint is the endpoint to the realtime api.
const realtimeEndpoint = "realtimedeparturesV4.json"
// RealtimeService handles communication with the realtime related
// methods of the SL API.
//
// SL API docs: https://www.trafiklab.se/node/15754/documentation
type RealtimeService service
// Transport represents a transport type (bus, metro, ship, tram, train) struct.
type Transport struct {
Destination string `json:"Destination"`
Deviations []struct {
Consequence string `json:"Consequence"`
ImportanceLevel int `json:"ImportanceLevel"`
Text string `json:"Text"`
} `json:"Deviations"`
DisplayTime string `json:"DisplayTime"`
ExpectedDateTime string `json:"ExpectedDateTime"`
GroupOfLine string `json:"GroupOfLine"`
JourneyDirection int `json:"JourneyDirection"`
JourneyNumber int `json:"JourneyNumber"`
LineNumber string `json:"LineNumber"`
StopAreaName string `json:"StopAreaName"`
StopAreaNumber int `json:"StopAreaNumber"`
StopPointDesignation string `json:"StopPointDesignation"`
StopPointNumber int `json:"StopPointNumber"`
TimeTabledDateTime string `json:"TimeTabledDateTime"`
TransportMode string `json:"TransportMode"`
}
// RealtimeResponse represents the realtime response from SL.
type RealtimeResponse struct {
Buses []*Transport `json:"Buses"`
DataAge int `json:"DataAge"`
LatestUpdate string `json:"LatestUpdate"`
Metros []*Transport `json:"Metros"`
Ships []*Transport `json:"Ships"`
StopPointDeviations []struct {
Deviation struct {
Consequence interface{} `json:"Consequence"`
ImportanceLevel int `json:"ImportanceLevel"`
Text string `json:"Text"`
} `json:"Deviation"`
StopInfo struct {
GroupOfLine string `json:"GroupOfLine"`
StopAreaName string `json:"StopAreaName"`
StopAreaNumber int `json:"StopAreaNumber"`
TransportMode string `json:"TransportMode"`
} `json:"StopInfo"`
} `json:"StopPointDeviations"`
Trains []*Transport `json:"Trains"`
Trams []*Transport `json:"Trams"`
}
// RealtimeResponseData represents the realtime response data SL API.
type RealtimeResponseData struct {
ExecutionTime int `json:"ExecutionTime"`
Message string `json:"Message"`
ResponseData *RealtimeResponse `json:"ResponseData"`
StatusCode int `json:"StatusCode"`
}
// RealtimeSearchOptions specifies optional parameters to the RealtimeService.Search.
type RealtimeSearchOptions struct {
// Exclude buses if true. Default is false that are reversed to true.
Bus bool `url:"bus,omitempty"`
// Exclude metros if true. Default is false that are reversed to true.
Metro bool `url:"metro,omitempty"`
// API Key.
Key string `url:"key,omitempty"`
// Station ID.
SiteID string `url:"siteId,omitempty"`
// Exclude ships if true. Default is false that are reversed to true.
Ship bool `url:"ship,omitempty"`
// Exclude train if true. Default is false that are reversed to true.
Train bool `url:"train,omitempty"`
// Exclude trams if true. Default is false that are reversed to true.
Tram bool `url:"tram,omitempty"`
// Time window to search departures within. Max 60 minutes.
TimeWindow int `url:"timeWindow,omitempty"`
}
// Search does a realtime search and response with the realtime list or a error.
func (s *RealtimeService) Search(ctx context.Context, opt *RealtimeSearchOptions) (*RealtimeResponse, error) {
// Reverse transport options.
opt.Bus = !opt.Bus
opt.Metro = !opt.Metro
opt.Ship = !opt.Ship
opt.Train = !opt.Train
opt.Tram = !opt.Tram
if len(opt.Key) == 0 {
return nil, ErrNoKey
}
if len(opt.SiteID) == 0 {
return nil, ErrNoSiteID
}
r, err := addOptions(realtimeEndpoint, opt)
if err != nil {
return nil, err
}
req, err := s.client.NewRequest("GET", r, nil)
if err != nil {
return nil, err
}
var resp *RealtimeResponseData
if _, err := s.client.Do(ctx, req, &resp); err != nil {
return nil, err
}
if len(resp.Message) > 0 {
return nil, errors.New(resp.Message)
}
return resp.ResponseData, nil
}