cta_redux 0.3.2 → 0.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 91c1d7dfb1bb819b342dc96de7c5ef191fd75d0a
-  data.tar.gz: d751fceb08ae3876d8c2e1a2fbee5a977c356e23
+  metadata.gz: 8ebdfcb117df8f4fe78aba18570093bca3b31889
+  data.tar.gz: 73b88fc7bcdd14a3841514c849028f4383fda0b4
 SHA512:
-  metadata.gz: 971c732b11e5781aa8f319c1b03510800c1caf6f0c808320a81f66f207ad578554262fc2d86e4ac9c43478127ac4aa2a54c890449ec0d0428622f24e2625e73f
-  data.tar.gz: daeaf6f74a5d5a6a962d7418b70ea649dada4a63642fdf65e7ed0e92e9707a2081b06b321582e7929bcc5e0c1779bea24c656564e46e840c5b2598014a847282
+  metadata.gz: a319534c7da09c458a6ed0224bfc1fb2da0e74fb44ee191d96a6cc1690563f2fbbfff94849e7893193b3a2f400b5dbf62d191b47c4e454870ba62b9321e1fc98
+  data.tar.gz: 5588efc46e16b89723bda4b58a62a71d787dd3bf760f890ba1f5493eb99853a87241e765e084e85297a2f806d402855649f977e2a3100a213528b90f76828b0b

data/CONTRIBUTING.md

@@ -1,14 +1,41 @@
-# Notes
+## Development Setup
 
-When running the gem from a git checkout, you'll need to unzip the CTA database yourself.
+1. Fork and clone the repo
 
-````cd data && gunzip cta-gtfs.db.gz````
+2. ```bundle install```
 
-# How to reload CTA GTFS data
+3. Load your REPL like so: ```TRAVIS=true irb```. This ensures that the embedded SQLite database will be
+   unzipped in the correct location for you. The TRAVIS environment variable is only necessary once for a fresh checkout.
 
-Note that this will take a long time - there are several million stop_time records.
+4. Make changes, and submit a pull request. Open issues as needed.
 
-1. cd data && curl 'http://www.transitchicago.com/downloads/sch_data/<latest file>' > gtfs.zip && unzip gtfs.zip
+If you make a substantial change to the code base, document your code and write some sort of test. Pull requests may be rejected without
+at least some sort of smokescreen test.
+
+Testing framework: rspec, builds set up on [travis-ci](https://travis-ci.org/ahayworth/cta_redux)
+
+Documentation: yard, hosted on [rubydoc.info](http://www.rubydoc.info/github/ahayworth/cta_redux) and rubygems.org (for releases).
+
+
+## Testing notes
+
+Faraday has a stub interface that we use to stub out test data. The workflow usually goes something like:
+
+1. Figure out what call you're making to the API
+
+2. `curl 'url for the api call' > spec/stubs/some_response_name.xml`
+
+3. Add the appropriate stub in spec/{bus,train}_tracker_spec.rb or spec/customer_alerts_spec.rb
+
+The Faraday stub interface is adequate, but picky - you must set up things with the *exact* URL - see the examples already there.
+
+
+## How to reload CTA GTFS data
+
+Note that this will take a long time - there are several million stop_time records. This should only be necessary
+when the CTA releases new GTFS data, or if a manual correction to the data is needed.
+
+1. cd data && curl 'http://www.transitchicago.com/downloads/sch_data/filename' > gtfs.zip && unzip gtfs.zip
 
 2. cd ../script && for i in `ls ../data/*.txt`; do echo $i; ./gtfs_to_sqlite.rb $i ../data/cta-gtfs.db; done
 
@@ -20,7 +47,6 @@ Note that this will take a long time - there are several million stop_time recor
 
 6. VACUUM
 
-7. gzip cta-gtfs.db
-
-8. Commit / push / create release and gem
+7. gzip -9 cta-gtfs.db
 
+8. Commit / bump version / tag release / push / build and push gem

data/lib/cta_redux/models/train.rb

@@ -92,8 +92,10 @@ module CTA
       attr_reader :destination
       # @return [String] A human-readable direction of this train, eg "O'Hare-bound"
       attr_reader :direction
-      # @return [CTA::Stop] The next {CTA::Stop} of this train
+      # @return [CTA::Stop] The next parent {CTA::Stop} of this train
       attr_reader :next_station
+      # @return [CTA::Stop] The next {CTA::Stop} of this train
+      attr_reader :next_stop
       # @return [DateTime] The time this {Prediction} was generated on the TrainTracker servers
       attr_reader :prediction_generated_at
       # @return [DateTime] The time this train is predicted to arrive at the next_station
@@ -122,6 +124,7 @@ module CTA
         @trip = CTA::Trip.where(:schd_trip_id => "R#{@run}").first
         @destination = CTA::Stop.where(:stop_id => data["destSt"]).first
         @next_station = CTA::Stop.where(:stop_id => (data["staId"] || data["nextStaId"])).first
+        @next_stop = CTA::Stop.where(:stop_id => (data["stpId"] || data["nextStpId"])).first
         @prediction_generated_at = DateTime.parse(data["prdt"])
         @arrival_time = DateTime.parse(data["arrT"])
         @seconds = @arrival_time.to_time - @prediction_generated_at.to_time

data/lib/cta_redux/version.rb

@@ -1,3 +1,3 @@
 module CTA
-  VERSION = "0.3.2"
+  VERSION = "0.3.3"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cta_redux
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.3.3
 platform: ruby
 authors:
 - Andrew Hayworth