sfba_transit_api 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA1:
3
+ metadata.gz: a91205825ff83f8ee86dc627a40aa701baebb01c
4
+ data.tar.gz: 1cfe169dd87692a8c4a3ce72f83e0cf45aedb929
5
+ SHA512:
6
+ metadata.gz: 297a294c2863f724ee4c21bc3663c57fcda7862d52b11a59f3ce507b4b4bccf471c62a581867e3df3e13efeaf3291c3fbe586d37509da12d3a690501f15039a6
7
+ data.tar.gz: e2957283da7b6633349ba7bb02209773b81227e8e06902b70f355a15f1ce8a2b601d8c88a46301c8a5e46c492a375b565845d2985e73afe3a6603102097ace4e
@@ -0,0 +1,30 @@
1
+ module SFBATransitAPI
2
+ class Agency
3
+ attr_accessor :name, :has_direction, :mode, :routes
4
+
5
+ def to_s
6
+ "#<SFBATransitAPI::Agency:#{object_id} @name=\"#{name}\", @has_direction=#{has_direction}, @mode=\"#{mode}\", routes.count=#{routes.count}>"
7
+ end
8
+
9
+ def has_direction=(has_direction)
10
+ if has_direction.is_a? String
11
+ @has_direction = has_direction.downcase == "true" ? true : false
12
+ else
13
+ @has_direction = has_direction ? true : false
14
+ end
15
+ end
16
+
17
+ def self.parse(node)
18
+ node.xpath("//Agency").map do |agency_node|
19
+ agency = new
20
+
21
+ agency.name = agency_node["Name"]
22
+ agency.has_direction = agency_node["HasDirection"]
23
+ agency.mode = agency_node["Mode"]
24
+ agency.routes = Route.parse(agency_node, agency)
25
+
26
+ agency
27
+ end
28
+ end
29
+ end
30
+ end
@@ -0,0 +1,77 @@
1
+ module SFBATransitAPI
2
+ class Client
3
+
4
+ attr_accessor :connection
5
+
6
+ # Initialize the client
7
+ #
8
+ # @param token [String] obtained from http://www.511.org/developer-resources_api-security-token_rtt.asp
9
+ # @return [String] the object converted into the expected format.
10
+ def initialize(token, options={})
11
+ self.connection = Connection.new(token, options)
12
+ end
13
+
14
+ def get_agencies
15
+ response = get(:get_agencies)
16
+
17
+ Agency.parse(response)
18
+ end
19
+
20
+ def get_routes_for_agency(agency_name)
21
+ response = get(:get_routes_for_agency, {agency_name: agency_name})
22
+
23
+ Agency.parse(response).map { |agency| agency.routes }.flatten
24
+ end
25
+
26
+ def get_routes_for_agencies(agency_names)
27
+ response = get(:get_routes_for_agencies, {agency_names: agency_names.join("|")})
28
+
29
+ Agency.parse(response).map { |agency| agency.routes }.flatten
30
+ end
31
+
32
+ def get_stops_for_route(route_info)
33
+ route_idf = makeRouteIDF(route_info)
34
+
35
+ response = get(:get_stops_for_route, {route_idf: route_idf})
36
+
37
+ Agency.parse(response).map do |agency|
38
+ agency.routes.map do |route|
39
+ route.stops
40
+ end.flatten
41
+ end.flatten
42
+ end
43
+
44
+ def get_stops_for_routes(route_infos)
45
+ route_idf = route_infos.map { |route_info| makeRouteIDF(route_info) }.join("|")
46
+
47
+ response = get(:get_stops_for_routes, {route_idf: route_idf})
48
+
49
+ Agency.parse(response).map do |agency|
50
+ agency.routes.map do |route|
51
+ route.stops
52
+ end.flatten
53
+ end.flatten
54
+ end
55
+
56
+ def get_next_departures_by_stop_code(stopcode)
57
+ response = get(:get_next_departures_by_stop_code, stopcode: stopcode)
58
+
59
+ Agency.parse(response).map do |agency|
60
+ agency.routes.map do |route|
61
+ route.stops
62
+ end.flatten
63
+ end.flatten.first
64
+ end
65
+
66
+ def makeRouteIDF(route_info)
67
+ route_idf = "#{route_info[:agency_name]}~#{route_info[:route_code]}"
68
+ route_idf += "~Inbound" if route_info[:route_direction] == :inbound
69
+ route_idf += "~Outbound" if route_info[:route_direction] == :outbound
70
+ route_idf
71
+ end
72
+
73
+ def get(method, options={})
74
+ self.connection.get(method, options)
75
+ end
76
+ end
77
+ end
@@ -0,0 +1,52 @@
1
+ require 'faraday'
2
+ require 'active_support/core_ext/string'
3
+ require 'nokogiri'
4
+
5
+ module SFBATransitAPI
6
+ class Connection
7
+
8
+ attr_accessor :token, :path_prefix
9
+
10
+ def initialize(token, options={})
11
+ self.token = token
12
+ self.path_prefix = options.fetch(:path_prefix, PATH_PREFIX)
13
+
14
+ @connection = Faraday.new(:url => options.fetch(:api_endpoint, API_ENDPOINT))
15
+ end
16
+
17
+ def get(method, options={})
18
+ path = "#{path_prefix}/#{method.to_s.camelize}.aspx"
19
+ params = options_to_params(options)
20
+ params["token"] = token
21
+
22
+ response = request(path, params)
23
+
24
+ if response.status != 200
25
+ raise ResponseException, "Server responded with #{response.status}"
26
+ end
27
+
28
+ xml_doc = Nokogiri::XML(response.body)
29
+
30
+ error_node = xml_doc.at_xpath("/transitServiceError")
31
+
32
+ if error_node
33
+ raise ResponseException, error_node.text
34
+ end
35
+
36
+ xml_doc
37
+ end
38
+
39
+ def request(path, params)
40
+ @connection.get path, params
41
+ end
42
+
43
+ def options_to_params(options)
44
+ options.inject({}) do |memo, pair|
45
+ key = pair[0].to_s.camelize(:lower).sub(/idf/i, "IDF")
46
+ value = pair[1]
47
+ memo[key] = value
48
+ memo
49
+ end
50
+ end
51
+ end
52
+ end
@@ -0,0 +1,39 @@
1
+ module SFBATransitAPI
2
+ class Route
3
+ attr_accessor :name, :code, :inbound_name, :outbound_name, :stops, :agency
4
+
5
+ def has_direction
6
+ not (inbound_name.nil? and outbound_name.nil?)
7
+ end
8
+
9
+ def to_s
10
+ "#<SFBATransitAPI::Route:#{object_id} @name=\"#{name}\", @code=\"#{code}\", @inbound_name=\"#{inbound_name}\", @outbound_name=\"#{outbound_name}\", @agency=<SFBATransitAPI::Agency:#{agency.object_id}>, stops.count=#{stops.count}>"
11
+ end
12
+
13
+ def self.parse(agency_node, agency)
14
+ agency_node.xpath(".//Route").map do |route_node|
15
+ route = new
16
+
17
+
18
+ route.agency = agency
19
+ route.name = route_node["Name"]
20
+ route.code = route_node["Code"]
21
+
22
+ direction_nodes = route_node.xpath(".//RouteDirection")
23
+ if direction_nodes.count > 0
24
+ direction_nodes.each do |direction_node|
25
+ if direction_node["Code"] == "Inbound"
26
+ route.inbound_name = direction_node["Name"]
27
+ elsif direction_node["Code"] == "Outbound"
28
+ route.outbound_name = direction_node["Name"]
29
+ end
30
+ end
31
+ end
32
+
33
+ route.stops = Stop.parse(route_node, route)
34
+
35
+ route
36
+ end
37
+ end
38
+ end
39
+ end
@@ -0,0 +1,47 @@
1
+ module SFBATransitAPI
2
+ class Stop
3
+ attr_accessor :name, :code, :direction, :direction_name, :departure_times, :route
4
+
5
+ def to_s
6
+ "#<SFBATransitAPI::Stop:#{object_id} @name=\"#{name}\", @code=\"#{code}\", @direction=\"#{direction}\", @direction_name=\"#{direction_name}\", @route=<SFBATransitAPI::Route:#{route.object_id}>, departure_times=#{departure_times}>"
7
+ end
8
+
9
+ def self.parse_departure_times(stop_node)
10
+ stop_node.xpath(".//DepartureTime").map do |departure_time_node|
11
+ departure_time_node.text ? departure_time_node.text.to_i : nil
12
+ end
13
+ end
14
+
15
+ def self.parse(route_node, route)
16
+ if route.has_direction
17
+ route_node.xpath(".//RouteDirection").map do |direction_node|
18
+
19
+ if direction_node["Code"] == "Inbound"
20
+ direction = :inbound
21
+ elsif direction_node["Code"] == "Outbound"
22
+ direction = :outbound
23
+ end
24
+
25
+ parse_stop(direction_node, route, direction, direction_node["Name"])
26
+ end.flatten
27
+ else
28
+ parse_stop(route_node, route)
29
+ end
30
+ end
31
+
32
+ def self.parse_stop(node, route, direction=nil, direction_name=nil)
33
+ node.xpath(".//Stop").map do |stop_node|
34
+ stop = new
35
+
36
+ stop.route = route
37
+ stop.name = stop_node["name"]
38
+ stop.code = stop_node["StopCode"]
39
+ stop.departure_times = parse_departure_times(stop_node)
40
+ stop.direction = direction
41
+ stop.direction_name = direction_name
42
+
43
+ stop
44
+ end
45
+ end
46
+ end
47
+ end
@@ -0,0 +1,18 @@
1
+ require_relative "./sfba_transit_api/stop"
2
+ require_relative "./sfba_transit_api/route"
3
+ require_relative "./sfba_transit_api/agency"
4
+ require_relative "./sfba_transit_api/connection"
5
+ require_relative "./sfba_transit_api/client"
6
+
7
+ module SFBATransitAPI
8
+
9
+ API_ENDPOINT = "http://services.my511.org"
10
+ PATH_PREFIX = "/Transit2.0"
11
+
12
+ class ResponseException < Exception
13
+ end
14
+
15
+ def self.client(token, options={})
16
+ Client.new(token, options)
17
+ end
18
+ end
metadata ADDED
@@ -0,0 +1,147 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: sfba_transit_api
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.1.0
5
+ platform: ruby
6
+ authors:
7
+ - Frank Liu
8
+ autorequire:
9
+ bindir: bin
10
+ cert_chain: []
11
+ date: 2014-12-30 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: nokogiri
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - ">="
18
+ - !ruby/object:Gem::Version
19
+ version: '0'
20
+ type: :runtime
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - ">="
25
+ - !ruby/object:Gem::Version
26
+ version: '0'
27
+ - !ruby/object:Gem::Dependency
28
+ name: faraday
29
+ requirement: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - ">="
32
+ - !ruby/object:Gem::Version
33
+ version: '0'
34
+ type: :runtime
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - ">="
39
+ - !ruby/object:Gem::Version
40
+ version: '0'
41
+ - !ruby/object:Gem::Dependency
42
+ name: activesupport
43
+ requirement: !ruby/object:Gem::Requirement
44
+ requirements:
45
+ - - ">="
46
+ - !ruby/object:Gem::Version
47
+ version: '0'
48
+ type: :runtime
49
+ prerelease: false
50
+ version_requirements: !ruby/object:Gem::Requirement
51
+ requirements:
52
+ - - ">="
53
+ - !ruby/object:Gem::Version
54
+ version: '0'
55
+ - !ruby/object:Gem::Dependency
56
+ name: rspec
57
+ requirement: !ruby/object:Gem::Requirement
58
+ requirements:
59
+ - - ">="
60
+ - !ruby/object:Gem::Version
61
+ version: '0'
62
+ type: :development
63
+ prerelease: false
64
+ version_requirements: !ruby/object:Gem::Requirement
65
+ requirements:
66
+ - - ">="
67
+ - !ruby/object:Gem::Version
68
+ version: '0'
69
+ - !ruby/object:Gem::Dependency
70
+ name: guard
71
+ requirement: !ruby/object:Gem::Requirement
72
+ requirements:
73
+ - - ">="
74
+ - !ruby/object:Gem::Version
75
+ version: '0'
76
+ type: :development
77
+ prerelease: false
78
+ version_requirements: !ruby/object:Gem::Requirement
79
+ requirements:
80
+ - - ">="
81
+ - !ruby/object:Gem::Version
82
+ version: '0'
83
+ - !ruby/object:Gem::Dependency
84
+ name: guard-rspec
85
+ requirement: !ruby/object:Gem::Requirement
86
+ requirements:
87
+ - - ">="
88
+ - !ruby/object:Gem::Version
89
+ version: '0'
90
+ type: :development
91
+ prerelease: false
92
+ version_requirements: !ruby/object:Gem::Requirement
93
+ requirements:
94
+ - - ">="
95
+ - !ruby/object:Gem::Version
96
+ version: '0'
97
+ - !ruby/object:Gem::Dependency
98
+ name: dotenv
99
+ requirement: !ruby/object:Gem::Requirement
100
+ requirements:
101
+ - - ">="
102
+ - !ruby/object:Gem::Version
103
+ version: '0'
104
+ type: :development
105
+ prerelease: false
106
+ version_requirements: !ruby/object:Gem::Requirement
107
+ requirements:
108
+ - - ">="
109
+ - !ruby/object:Gem::Version
110
+ version: '0'
111
+ description: A Simple Way to Query the 511 RTT API
112
+ email: gniquil@gmail.com
113
+ executables: []
114
+ extensions: []
115
+ extra_rdoc_files: []
116
+ files:
117
+ - lib/sfba_transit_api.rb
118
+ - lib/sfba_transit_api/agency.rb
119
+ - lib/sfba_transit_api/client.rb
120
+ - lib/sfba_transit_api/connection.rb
121
+ - lib/sfba_transit_api/route.rb
122
+ - lib/sfba_transit_api/stop.rb
123
+ homepage: https://github.com/gniquil/sfba_transit_api
124
+ licenses:
125
+ - MIT
126
+ metadata: {}
127
+ post_install_message:
128
+ rdoc_options: []
129
+ require_paths:
130
+ - lib
131
+ required_ruby_version: !ruby/object:Gem::Requirement
132
+ requirements:
133
+ - - ">="
134
+ - !ruby/object:Gem::Version
135
+ version: '0'
136
+ required_rubygems_version: !ruby/object:Gem::Requirement
137
+ requirements:
138
+ - - ">="
139
+ - !ruby/object:Gem::Version
140
+ version: '0'
141
+ requirements: []
142
+ rubyforge_project:
143
+ rubygems_version: 2.4.5
144
+ signing_key:
145
+ specification_version: 4
146
+ summary: San Francisco Bay Area 511 Real-time Transit Data Services API
147
+ test_files: []