ztm_warszawa 0.1.5 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ead520c5b30cebbcb503045bbfdad7b43f3eba3b
-  data.tar.gz: db7985726176205529c7449ec01e2e7af8caab61
+  metadata.gz: 7fd93bc84ecab26b7d3ebf4f0df1d4cdf9e493eb
+  data.tar.gz: ba71bcf8dafb8bd9b4d478397a8a4105d1e0f125
 SHA512:
-  metadata.gz: 2e484701caabe832d7aa18f34b664c467759e41b3567d20939d17f014d1904c95db418fe9e9e1bbe2c78af4cdd12860fe21c7c034b94a0e6e8d39c1a4781ec4a
-  data.tar.gz: 2592fccfcdcc2fc961edd1be26a72092df33bacebb30899cf0cf4cfbaa01de7102c24777cda27f987691ef857b1df7e3fd79493430fd98ed43c5c6ff34533fe8
+  metadata.gz: 60316c9ae4a206ba19ab155b3e09a6d289bf3d5a0ac3994221b02db9a208584b4c27fd56751ac9da3acb8f54dde06985a42c28136d0c4e381a3b78a86d25df50
+  data.tar.gz: 9eb1a607b7ad54a0fe3acac9c551f6cced4b4e51f3102c9af71085ad51b72700ce90409f3e67546a76015ac160f9bc6dd1b1d058ac71b8d6d0ba967666c04d5c

data/README.md

@@ -40,33 +40,43 @@ This gem depends on the `httparty` gem for making HTTP requests and the `address
 
 First, create the the appropriate object:
 
-`ztm_api = ZtmWarszawa.new`
+`ztm_api = ZtmWarszawa.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.
+The "api_key" is optional. Most of the methods require setting an API key, though; 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:
 
-##### Methods which require setting the API key:
+### 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)`
+
+
+- `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.
 
-##### Methods which don't require setting the API key:
+
+
+### Methods which don't require setting the API key:
 
 - `check_alerts()`
 

data/lib/ztm_warszawa.rb

@@ -14,9 +14,9 @@ class ZtmWarszawa
 
 	attr_writer :api_key
 
-	#def initialize(api_key)
-		#@api_key = api_key
-	#end
+	def initialize(api_key = nil)
+		@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.

data/lib/ztm_warszawa/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ztm_warszawa
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.1.6
 platform: ruby
 authors:
 - Piotr Górni