ztm_warszawa 0.1.4 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3a09f75e478850781ed4613f9c2ea504f4e3d2c0
-  data.tar.gz: 336b877fd3ee308266e5daa33b1c0848664ffa38
+  metadata.gz: ead520c5b30cebbcb503045bbfdad7b43f3eba3b
+  data.tar.gz: db7985726176205529c7449ec01e2e7af8caab61
 SHA512:
-  metadata.gz: 24cbe504c66d951ab59668a24c14365151de7dce556d09f2e13829c15c3dbd04ef8f8f1af0e95f7dd226a175ee88bca8c2930c512a96462785ae0859f8df2ba3
-  data.tar.gz: ab14856d78bebbc7e1206863881388850faaba43b2fc5c4e4d84e371f819bfbd713d93f81580f7dfce1e6fd1f25699f28ee1906222b6eb58c91f68a7f3e504bc
+  metadata.gz: 2e484701caabe832d7aa18f34b664c467759e41b3567d20939d17f014d1904c95db418fe9e9e1bbe2c78af4cdd12860fe21c7c034b94a0e6e8d39c1a4781ec4a
+  data.tar.gz: 2592fccfcdcc2fc961edd1be26a72092df33bacebb30899cf0cf4cfbaa01de7102c24777cda27f987691ef857b1df7e3fd79493430fd98ed43c5c6ff34533fe8

data/README.md

@@ -7,6 +7,7 @@ Using this gem, you can easily:
 - find out, which bus lines depart from a given bus stop
 - get the hours of departure of a given bus line from a specified bus stop
 - get the closest bus departures for a given bus stop
+- check for traffic alerts (buses/trams suspended due to traffic accidents etc.)
 
 It also seems to work with other types of stops that are under ZTM's administration (e.g. railway stations, tram stations...)
 
@@ -17,8 +18,13 @@ Add this line to your application's Gemfile:
 ```ruby
 gem 'ztm_warszawa'
 ```
+or just require it with 
 
-And then execute:
+```ruby
+require 'ztm_warszawa'
+```
+
+Then execute:
 
     $ bundle
 
@@ -34,21 +40,37 @@ This gem depends on the `httparty` gem for making HTTP requests and the `address
 
 First, create the the appropriate object:
 
-`ztm_api = ZtmWarszawa.new(api_key)`
+`ztm_api = ZtmWarszawa.new`
 
-The API key has to be a string. It can be changed later on by calling `ztm_api.api_key = (new api key)`.
+Most of the methods require setting an API key. You can set the API key by calling `ztm_api.api_key = (new api key)`. The API key has to be a string. If you try to use a function which requires the API key without specifying it, an NoApiKey exception will be raised.
 
 You can get an API key by registering [here](https://api.um.warszawa.pl/index.php?wcag=true&opc=8.8,2,0,0,).
 
 Now, you can use the following methods:
 
-- `get_stop_id(bus_stop_name)`: Queries the ZTM API to get the bus stop's ID from its name. The ID is required for all the latter operations.
+##### Methods which require setting the API key:
+
+- `get_stop_id(bus_stop_name)`
+
+Queries the ZTM API to get the bus stop's ID from its name. The ID is required for all the latter operations. Raises an "BusStopNotFound" exception if the bus stop hasn't been found.
+
+- `get_bus_lines(bus_stop_id, bus_stop_no)`
+ 
+Returns an array of bus lines (e.g. 527, 141...) that depart from a given bus stop. Raises an "NoDepartures" exception when the server's response is empty (which could mean no buses depart from this stop).
+
+- `get_line_departure_hours(bus_stop_id, bus_stop_no, bus_line)` 
+ 
+Returns the server response with all the hours of departure of a given bus line from a given bus stop. Night bus lines (e.g. N37, N85...) are not supported due to some server-side errors (and an "NightLineError" exception is raised)
+
+`get_closest_departures(server_response, script_starting_time, bus_line, number_of_departures)`
+
+Given the server's response from `get_line_departure_hours()`, finds a given number of closest departures. The result is an array of hashes with "bus_line" and "time" entries.
 
-- `get_bus_lines(bus_stop_id, bus_stop_no)`: Returns an array of bus lines (e.g. 527, 141...) that depart from a given bus stop.
+##### Methods which don't require setting the API key:
 
-- `get_line_departure_hours(bus_stop_id, bus_stop_no, bus_line)`: Returns the server response with all the hours of departure of a given bus line from a given bus stop. Night bus lines (e.g. N37, N85...) are not supported due to some server-side errors.
+- `check_alerts()`
 
-- `get_closest_departures(server_response, script_starting_time, bus_line, number_of_departures)`: Given the server's response from `get_line_departure_hours()`, finds a given number of closest departures. The result is an array of hashes with "bus_line" and "time" entries.
+Checks the ZTM website's RSS feed for any traffic alerts (buses/trams suspended due to traffic accidents etc.); returns an array of hashes with "title", "description" and "link" keys.
 
 ## License
 

data/lib/ztm_warszawa.rb

@@ -1,33 +1,43 @@
 require "ztm_warszawa/version"
 require 'httparty'
 require 'addressable/uri'
+require 'rss'
+
+class NoDepartures < StandardError; end
+class BusStopNotFound < StandardError; end
+class NightLineError < StandardError; end
+class NoApiKey < StandardError; end
+
+
 
 class ZtmWarszawa
 
 	attr_writer :api_key
 
-	def initialize(api_key)
-		@api_key = api_key
-	end
+	#def initialize(api_key)
+		#@api_key = api_key
+	#end
 
 	# Queries the ZTM API to get the bus stop's ID from its name.
 	# The ID is required for all the latter operations.
 	def get_stop_id(bus_stop_name)
+		raise NoApiKey, "No API key specified." if @api_key.nil?
 		raw_url = "https://api.um.warszawa.pl/api/action/dbtimetable_get?id=b27f4c17-5c50-4a5b-89dd-236b282bc499&name=#{bus_stop_name}&apikey=#{@api_key}"
 		url = Addressable::URI.parse(raw_url)
 		response = HTTParty.get(url.normalize).parsed_response["result"]
-		raise 'Bus stop not found' if response.empty?
+		raise BusStopNotFound, 'Bus stop not found' if response.empty?
 		bus_stop_id = response[0]["values"][0]["value"]
 		return bus_stop_id
 	end
 
 	# Returns an array of bus lines (e.g. 527, 141...) that depart from a given bus stop.
 	def get_bus_lines(bus_stop_id, bus_stop_no)
+		raise NoApiKey, "No API key specified." if @api_key.nil?
 		bus_lines = []
 	
 		url = "https://api.um.warszawa.pl/api/action/dbtimetable_get/?id=88cd555f-6f31-43ca-9de4-66c479ad5942&busstopId=#{bus_stop_id}&busstopNr=#{bus_stop_no}&apikey=#{@api_key}"
 		response = HTTParty.get(url).parsed_response["result"]
-		raise 'No vehicles seem to depart from here.' if response.empty?
+		raise NoDepartures, 'No vehicles seem to depart from here.' if response.empty?
 
 		response.each do |bus_line_info|
 		bus_lines << bus_line_info["values"][0]["value"]
@@ -37,7 +47,8 @@ class ZtmWarszawa
 
 	# Returns the server response with all the hours of departure of a given bus line from a given bus stop.
 	def get_line_departure_hours(bus_stop_id, bus_stop_no, bus_line)
-		raise 'Night bus lines are not supported due to some server-side errors.' if bus_line.start_with? "N"
+		raise NoApiKey, "No API key specified." if @api_key.nil?
+		raise NightLineError, 'Night bus lines are not supported due to some server-side errors.' if bus_line.start_with? "N"
 		url = "https://api.um.warszawa.pl/api/action/dbtimetable_get?id=e923fa0e-d96c-43f9-ae6e-60518c9f3238&busstopId=#{bus_stop_id}&busstopNr=#{bus_stop_no}&line=#{bus_line}&apikey=#{@api_key}"
 		response = HTTParty.get(url).parsed_response["result"]
 		return response
@@ -58,4 +69,15 @@ class ZtmWarszawa
 		return closest_departures.take(number_of_departures)
 	end
 
+	def check_alerts
+		alerts = []
+		alert_page = HTTParty.get("http://ztm.waw.pl/rss.php?l=1&IDRss=6")
+		alert_feed = RSS::Parser.parse(alert_page.body)
+
+		alert_feed.items.each do |item|
+			alerts << {"title" => item.title, "link" => item.link, "description" => item.description}
+		end
+		return alerts
+	end
+
 end

data/lib/ztm_warszawa/version.rb

@@ -1,3 +1,3 @@
 class ZtmWarszawa
-  VERSION = "0.1.4"
+  VERSION = "0.1.5"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ztm_warszawa
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors:
 - Piotr Górni
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-09-28 00:00:00.000000000 Z
+date: 2016-10-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty