translink 1.0.0 → 2.0.0

data/CHANGELOG.md

@@ -1,9 +1,16 @@
 # Changelog
 
-## Current
+## 2012-07-21 / v2.0.0
+
+* Add headsign column to trips table.
+* Direction column distinguishes between travelling in one direction (Regular)
+  and opposite direction (Goofy).
+* Headsign column is a human readable name for the given direction. Eg "Inbound".
+
+## 2012-06-26 / v1.0.0
 
 * Compatibility with Translink website (2012-05-29).
-* Changed schema to conform with Google Transit feed specification.
+* Changed schema to conform with General Transit Feed Specification.
 * Stops include latitude and longitude fields.
 * Help command always gives working example.
 

data/README.md

@@ -6,10 +6,14 @@
 South-East Queensland. Their website has an abundance of data with no easy way for a developer
 to query it.
 
-Translink (Program) scrapes bus routes, trips, stops and times into a relational database. 
+Translink (Program) scrapes bus routes, trips, stops and times into a relational database.
+The schema is a subset of the [General Transit Feed Specification](https://developers.google.com/transit/gtfs/reference).
 Data is sourced from the [Translink website](http://translink.com.au/).You should be 
 aware their data is protected by [copyright](http://translink.com.au/site-information/legal/copyright).
 
+I created Translink (Program) to solve my problem of getting lost on new routes. With this data I 
+have been working on an app for iOS called [Next Stop](http://nextstop.me).
+
 ## Installation
 
 Translink requires Ruby 1.9.2 or greater. For documentation on how to install Ruby on your
@@ -50,10 +54,15 @@ Routes that visit the 'Calam Rd near Honeywood St' stop.
 
 ## Schema
 
+Schema is a subset of the [General Transit Feed Specification](https://developers.google.com/transit/gtfs/reference)
+defined by Google for [Google Transit](https://developers.google.com/transit/google-transit).
+
 ![Class Analysis Diagram](https://github.com/tatey/translink/raw/master/doc/schema.png)
 
 ## Contributing
 
+If you would like to help, please browse the [issues](https://github.com/tatey/translink/issues).
+
 1. Fork it
 2. Install dependencies (`bundle install`)
 3. Create your feature branch (`git checkout -b my-new-feature`)

data/lib/translink.rb

@@ -7,6 +7,7 @@ require 'translink/version'
 require 'translink/cli'
 require 'translink/crawler'
 require 'translink/db'
+require 'translink/direction'
 require 'translink/model/route'
 require 'translink/model/stop'
 require 'translink/model/stop_time'

data/lib/translink/direction.rb

@@ -0,0 +1,6 @@
+module Translink
+  module Direction
+    REGULAR = 0 # Travel in one direction.
+    GOOFY   = 1 # Travel in opposite direction.
+  end
+end

data/lib/translink/model/trip.rb

@@ -6,7 +6,8 @@ module Translink
       storage_names[:default] = 'trips'
 
       property :id,         Serial
-      property :direction,  String
+      property :direction,  Integer # Travel in one direction (Regular) or the opposite (Goofy) direction.
+      property :headsign,   String  # Name of the direction. Eg "Inbound".
       property :service_id, Integer # Service belongs to a trip. Assigned by Translink.
       property :trip_id,    Integer # Unique ID assigned by Translink.
 
@@ -40,6 +41,7 @@ module Translink
       # @return [void]
       def trip_page! trip_page
        self.direction  = trip_page.direction
+       self.headsign   = trip_page.headsign
        self.service_id = trip_page.service_id
        self.trip_id    = trip_page.trip_id
       end

data/lib/translink/page/route.rb

@@ -31,12 +31,28 @@ module Translink
       DateTime.parse page.search('select#TimetableDate option[selected]').first['value']
     end
 
+    # Get headsigns of directions travelled by this route.
+    #
+    # @return [Array<String>]
+    def headsigns
+      page.search('h3').map { |node| node.text.downcase }.uniq
+    end
+
+    # Get the direction of travel for the given +anchor+.
+    #
+    # @param anchor [Nokogiri::XML::Node] Anchor to ascend from.
+    # @return [Integer] +0+ for one (Regular) direction of travel, +1+ for
+    #   opposite (Goofy) direction of travel.
+    def direction_from_anchor anchor
+      headsigns.index anchor.ancestors('div.route-timetable').search('h3').first.text.downcase
+    end
+
     # Builds an array of trip pages.
     #
     # @return [Array<Page::Trip>]
     def trip_pages
       page.search('a.map-link-top').map do |anchor|
-        Trip.new url_from_href(anchor[:href]), date
+        Trip.new url_from_href(anchor[:href]), date, direction_from_anchor(anchor)
       end
     end
 

data/lib/translink/page/trip.rb

@@ -61,21 +61,24 @@ module Translink
       end
     end
 
-    attr_accessor :date # [Date] Date the trip runs on.
+    attr_accessor :date      # [Date] Date the trip runs on.
+    attr_accessor :direction # [Integer] Travel in one direction (Regular)
+                             # or the opposite (Goofy) direction.
 
     # Creates a new trip.
     # 
     # @param url [String] URL to fetch the page from.
     # @param date [Date] Date the trip runs on.
-    def initialize url, date
+    def initialize url, date, direction
       super url
       @date = date.to_date
+      @direction = direction
     end
 
-    # Get the trip's direction of travel.
+    # Get the trip's headsign.
     #
     # @return [String] "inbound" or "outbound".
-    def direction
+    def headsign
       url.to_s =~ /information\/([a-z]+)\//
       $1
     end

data/lib/translink/version.rb

@@ -1,3 +1,3 @@
 module Translink
-  VERSION = '1.0.0'
+  VERSION = '2.0.0'
 end

data/test/helper.rb

@@ -1,4 +1,5 @@
 require 'minitest/autorun'
+require 'pry'
 require 'translink'
 require 'webmock/minitest'
 

data/test/unit/model/route_test.rb

@@ -15,7 +15,7 @@ class Model::RouteTest < MiniTest::Unit::TestCase
 
   def test_add_trip_from_trip_page
     DB.context 'sqlite::memory:', :migrate => true do
-      trip_page   = OpenStruct.new :direction => 'outbound', :service_id => 8550, :trip_id => 1712196
+      trip_page   = OpenStruct.new :direction => Direction::REGULAR, :headsign => 'outbound', :service_id => 8550, :trip_id => 1712196
       route_model = Model::Route.new
       trip_model  = route_model.add_trip_from_trip_page trip_page
       assert trip_model.saved?

data/test/unit/page/route_test.rb

@@ -1,32 +1,43 @@
 require 'helper'
 
 class Page::RouteTest < MiniTest::Unit::TestCase
-  def test_date
+  attr_accessor :route
+
+  def setup
     stub_request(:get, 'http://jp.translink.com.au/travel-information/network-information/buses/130/2012-06-21').
       to_return(:status => 200, :body => fixture('verbatim/route.html'), :headers => {'Content-Type' => 'text/html'})
-    assert_equal DateTime.parse('21/06/2012 12:00:00 AM'), Page::Route.new('http://jp.translink.com.au/travel-information/network-information/buses/130/2012-06-21', 'City, Griffith Uni, Sunnybank Hills, Algester, Parkinson').date
+    @route = Page::Route.new 'http://jp.translink.com.au/travel-information/network-information/buses/130/2012-06-21', 'City, Griffith Uni, Sunnybank Hills, Algester, Parkinson'
   end
 
-  def test_long_name
-    route = Page::Route.new('http://local', 'City, Griffith Uni, Sunnybank Hills, Algester, Parkinson')
-    assert_equal 'City, Griffith Uni, Sunnybank Hills, Algester, Parkinson', route.long_name
+  def test_date
+    assert_equal DateTime.parse('21/06/2012 12:00:00 AM'), route.date
+  end
+
+  def test_headsigns
+    assert_equal ['outbound', 'inbound'], route.headsigns
   end
 
   def test_short_name
-    stub_request(:get, 'http://jp.translink.com.au/travel-information/network-information/buses/130/2012-06-21').
-      to_return(:status => 200, :body => fixture('verbatim/route.html'), :headers => {'Content-Type' => 'text/html'})
-    assert_equal '130', Page::Route.new('http://jp.translink.com.au/travel-information/network-information/buses/130/2012-06-21', 'City, Griffith Uni, Sunnybank Hills, Algester, Parkinson').short_name
+    assert_equal '130', route.short_name
   end
 
   def test_trip_pages
-    stub_request(:get, 'http://jp.translink.com.au/travel-information/network-information/buses/130/2012-06-21').
-      to_return(:status => 200, :body => fixture('verbatim/route.html'), :headers => {'Content-Type' => 'text/html'})
-    route = Page::Route.new('http://jp.translink.com.au/travel-information/network-information/buses/130/2012-06-21', 'City, Griffith Uni, Sunnybank Hills, Algester, Parkinson')
     trip_pages = route.trip_pages
-    assert_equal 'http://jp.translink.com.au/travel-information/network-information/service-information/outbound/8904/1891449/2012-06-20', trip_pages.first.url.to_s
-    assert_equal route.date.to_date, trip_pages.first.date 
-    assert_equal 'http://jp.translink.com.au/travel-information/network-information/service-information/inbound/8904/1881543/2012-06-22', trip_pages.last.url.to_s
-    assert_equal route.date.to_date, trip_pages.last.date 
+    trip1 = trip_pages.first
+    trip2 = trip_pages.last
+    assert_equal 'http://jp.translink.com.au/travel-information/network-information/service-information/outbound/8904/1891449/2012-06-20', trip1.url.to_s
+    assert_equal route.date.to_date, trip1.date
+    assert_equal Direction::REGULAR, trip1.direction
+    assert_equal 'http://jp.translink.com.au/travel-information/network-information/service-information/inbound/8904/1881543/2012-06-22', trip2.url.to_s
+    assert_equal route.date.to_date, trip2.date
+    assert_equal Direction::GOOFY, trip2.direction
+  end
+end
+
+class Page::RouteLongNameTest < MiniTest::Unit::TestCase
+  def test_long_name
+    route = Page::Route.new('http://local', 'City, Griffith Uni, Sunnybank Hills, Algester, Parkinson')
+    assert_equal 'City, Griffith Uni, Sunnybank Hills, Algester, Parkinson', route.long_name
   end
 end
 

data/test/unit/page/trip_test.rb

@@ -3,16 +3,22 @@ require 'helper'
 class Page::TripTest < MiniTest::Unit::TestCase
   def test_date
     timestamp = DateTime.now
-    assert_equal timestamp.to_date, Page::Trip.new('http://localhost', timestamp).date
+    assert_equal timestamp.to_date, Page::Trip.new('http://localhost', timestamp, Direction::REGULAR).date
     date = Date.today
-    assert_equal date, Page::Trip.new('http://localhost', date).date
+    assert_equal date, Page::Trip.new('http://localhost', date, Direction::REGULAR).date
   end
 
   def test_direction
-    assert_equal 'inbound', Page::Trip.new('http://jp.translink.com.au/travel-information/network-information/service-information/inbound/8550/1704728', Date.today).direction
-    assert_equal 'outbound', Page::Trip.new('http://jp.translink.com.au/travel-information/network-information/service-information/outbound/8550/1712196/2012-05-31', Date.today).direction
-    assert_equal 'counterclockwise', Page::Trip.new('http://jp.translink.com.au/travel-information/network-information/service-information/counterclockwise/8904/1882248/2012-06-25', Date.today).direction
-    assert_equal 'clockwise', Page::Trip.new('http://jp.translink.com.au/travel-information/network-information/service-information/clockwise/8904/1882152/2012-06-25', Date.today).direction
+    timestamp = DateTime.now
+    assert_equal Direction::REGULAR, Page::Trip.new('http://localhost', timestamp, Direction::REGULAR).direction
+    assert_equal Direction::GOOFY, Page::Trip.new('http://localhost', timestamp, Direction::GOOFY).direction
+  end
+
+  def test_headsign
+    assert_equal 'inbound', Page::Trip.new('http://jp.translink.com.au/travel-information/network-information/service-information/inbound/8550/1704728', Date.today, Direction::GOOFY).headsign
+    assert_equal 'outbound', Page::Trip.new('http://jp.translink.com.au/travel-information/network-information/service-information/outbound/8550/1712196/2012-05-31', Date.today, Direction::REGULAR).headsign
+    assert_equal 'counterclockwise', Page::Trip.new('http://jp.translink.com.au/travel-information/network-information/service-information/counterclockwise/8904/1882248/2012-06-25', Date.today, Direction::GOOFY).headsign
+    assert_equal 'clockwise', Page::Trip.new('http://jp.translink.com.au/travel-information/network-information/service-information/clockwise/8904/1882152/2012-06-25', Date.today, Direction::REGULAR).headsign
   end
 end
 
@@ -23,7 +29,7 @@ class Page::TripRequestTest < MiniTest::Unit::TestCase
   end
 
   def stub_trip
-    Page::Trip.new('http://jp.translink.com.au/travel-information/network-information/service-information/outbound/8550/1712196/2012-05-31', Date.today)
+    Page::Trip.new('http://jp.translink.com.au/travel-information/network-information/service-information/outbound/8550/1712196/2012-05-31', Date.today, Direction::REGULAR)
   end
 
   def test_service_id

data/translink.gemspec

@@ -20,6 +20,7 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency 'dm-migrations', '~> 1.2.0'
   s.add_runtime_dependency 'dm-sqlite-adapter', '~> 1.2.0'
   s.add_runtime_dependency 'mechanize', '~> 2.0.1'
+  s.add_development_dependency 'pry'
   s.add_development_dependency 'rake', '~> 0.9.2'
   s.add_development_dependency 'webmock', '~> 1.7.8'
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: translink
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 2.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-06-25 00:00:00.000000000 Z
+date: 2012-07-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dm-core
-  requirement: &70170271474960 !ruby/object:Gem::Requirement
+  requirement: &70220170640540 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: 1.2.0
   type: :runtime
   prerelease: false
-  version_requirements: *70170271474960
+  version_requirements: *70220170640540
 - !ruby/object:Gem::Dependency
   name: dm-migrations
-  requirement: &70170271474500 !ruby/object:Gem::Requirement
+  requirement: &70220170639960 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: 1.2.0
   type: :runtime
   prerelease: false
-  version_requirements: *70170271474500
+  version_requirements: *70220170639960
 - !ruby/object:Gem::Dependency
   name: dm-sqlite-adapter
-  requirement: &70170271474040 !ruby/object:Gem::Requirement
+  requirement: &70220170639060 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: 1.2.0
   type: :runtime
   prerelease: false
-  version_requirements: *70170271474040
+  version_requirements: *70220170639060
 - !ruby/object:Gem::Dependency
   name: mechanize
-  requirement: &70170271473580 !ruby/object:Gem::Requirement
+  requirement: &70220170638380 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,10 +54,21 @@ dependencies:
         version: 2.0.1
   type: :runtime
   prerelease: false
-  version_requirements: *70170271473580
+  version_requirements: *70220170638380
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: &70220170638000 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70220170638000
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70170271753220 !ruby/object:Gem::Requirement
+  requirement: &70220170637340 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -65,10 +76,10 @@ dependencies:
         version: 0.9.2
   type: :development
   prerelease: false
-  version_requirements: *70170271753220
+  version_requirements: *70220170637340
 - !ruby/object:Gem::Dependency
   name: webmock
-  requirement: &70170271454480 !ruby/object:Gem::Requirement
+  requirement: &70220170636820 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -76,7 +87,7 @@ dependencies:
         version: 1.7.8
   type: :development
   prerelease: false
-  version_requirements: *70170271454480
+  version_requirements: *70220170636820
 description: Scrapes bus routes, trips, stops and times into a relational database.
 email:
 - tate@tatey.com
@@ -99,6 +110,7 @@ files:
 - lib/translink/cli.rb
 - lib/translink/crawler.rb
 - lib/translink/db.rb
+- lib/translink/direction.rb
 - lib/translink/model/route.rb
 - lib/translink/model/stop.rb
 - lib/translink/model/stop_time.rb
@@ -146,7 +158,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 3982084261629869304
+      hash: -132775799840568295
 requirements: []
 rubyforge_project: translink
 rubygems_version: 1.8.11