gasman-bahn 1.0.0

data/History.txt

@@ -0,0 +1,6 @@
+=== 1.0.0 / 2009-05-17
+
+* 1 major enhancement
+
+  * Birthday!
+

data/Manifest.txt

@@ -0,0 +1,6 @@
+History.txt
+Manifest.txt
+README.txt
+Rakefile
+lib/bahn.rb
+test/test_bahn.rb

data/README.txt

@@ -0,0 +1,64 @@
+= bahn
+
+== DESCRIPTION:
+
+A library for accessing train information from Deutsche Bahn in an
+object-oriented way
+
+== FEATURES
+
+* Exposes Station, Service and Stop objects 
+* Does hairy screen-scraping
+* Works around bahn.de's crazy transient URLs (provided you don't
+  leave objects in scope for 24 hours or so)
+  
+== BUGS
+
+* This is not an official Deutsche Bahn service, nor does it use an official API;
+  it does screen-scraping on their HTML, and is therefore liable to break if Deutsche Bahn
+  update their website code.
+* Train travel times do not take timezones into account, and may end up 24 hours out
+  because whenever it sees a time going 'backwards' (e.g. depart 08:40, arrive 08:20) it
+  assumes that just under 24 hours has elapsed. Also, summary timetables for some very long
+  distance trains (such as the Trans-Siberian Express) may only show stations that are more
+  than 24 hours apart, so there's no way to know that we should be adding on 24 hours to
+  the time.
+
+== SYNOPSIS:
+
+ require 'bahn'
+ ulm = Bahn::Station.find(:first, :name => 'Ulm')
+  #=> #<Bahn::Station:0x55fb4 @id=8000170, @y_coord="48399019", @name="Ulm Hbf", @x_coord="9982161">
+ my_train = ulm.departures(:include => :ice).find{|departure| departure.service.name == 'ICE 699'}
+  #=> #<Bahn::Stop @time=07:55 @station="Ulm Hbf" @destination="M\303\274nchen Hbf">
+ my_train.destination.arrival_time
+  #=> 09:17
+
+== INSTALL:
+
+* sudo gem install bahn
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2009 Matthew Westcott
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,11 @@
+# -*- ruby -*-
+
+require 'rubygems'
+require 'hoe'
+require './lib/bahn.rb'
+
+Hoe.new('bahn', Bahn::VERSION) do |p|
+  p.developer('Matt Westcott', 'matt@west.co.tt')
+end
+
+# vim: syntax=Ruby

data/lib/bahn.rb

@@ -0,0 +1,465 @@
+require 'rubygems'
+require 'open-uri'
+require 'json'
+require 'iconv'
+require 'hpricot'
+require 'cgi'
+
+module Bahn
+	VERSION = '1.0.0'
+
+	# Represents a time of day on a 24-hour clock, without implying any particular date.
+	class ClockTime < Time
+		# Create a new ClockTime object for the time specified by hours and mins
+		def self.clock(hours, mins)
+			self.utc(1970, 1, 1, hours, mins, 0)
+		end
+		
+		# Parses a string of the form "hh:mm" and converts it to a ClockTime object
+		def self.parse(str)
+			if str =~ /(\d+):(\d+)/ then self.utc(1970, 1, 1, $1, $2, 0) end
+		end
+		
+		def inspect # :nodoc:
+			to_s
+		end
+		
+		def to_s # :nodoc:
+			sprintf("%02d:%02d", hour, min)
+		end
+	end
+	
+	class Station
+		# Finds and returns one or many Station objects. Invoked through one of the following forms:
+		# 
+		# * <tt>Bahn::Station.find(id)</tt> - returns the Station with the given ID
+		# * <tt>Bahn::Station.find(:first, :name => name)</tt> - returns the first station matching name
+		# * <tt>Bahn::Station.find(:all, :name => name)</tt> - returns an array of all stations matching name
+		def self.find(id_or_type, opts = {})
+			case id_or_type
+				when :first
+					query = autocomplete_query(opts[:name])
+					query.size ? self.new(:autocomplete_result => query.first) : nil
+				when :all
+					query = autocomplete_query(opts[:name])
+					query.collect {|result| self.new(:autocomplete_result => result)}
+				else # assume a numeric ID
+					self.new(:id => id_or_type)
+			end
+		end
+		
+		def initialize(opts) # :nodoc:
+			if opts[:autocomplete_result]
+				populate_from_autocomplete_result(opts[:autocomplete_result])
+			else
+				@id = opts[:id].to_i
+				@name = opts[:name]
+				@x_coord = opts[:x_coord]
+				@y_coord = opts[:y_coord]
+			end
+		end
+		
+		# The numeric ID of this station.
+		attr_reader :id
+
+		# Returns the station name.
+		def name
+			fetch_autocomplete_result if @name.nil?
+			@name
+		end
+
+		# Returns the X coordinate of the station; appears to be a WGS84 longitude in units of 10^-6 degrees.
+		def x_coord
+			fetch_autocomplete_result if @x_coord.nil?
+			@x_coord
+		end
+
+		# Returns the Y coordinate of the station; appears to be a WGS84 latitude in units of 10^-6 degrees.
+		def y_coord
+			fetch_autocomplete_result if @y_coord.nil?
+			@y_coord
+		end
+
+		# Returns an Enumerable listing of Stop objects for all services departing from this station.
+		# The list can be filtered by transport type through the following options:
+		# * <tt>:include</tt> - One of the symbols :ice, :ic_ec, :ir, :regional, :urban, :bus, :boat, :subway, :tram, or an array of them, to determine which transport types should be included in the list
+		# * <tt>:exclude</tt> - Specifies one or more of the above transport types to be excluded from the results.
+		def departures(opts = {})
+			DepartureBoard.new(self, opts)
+		end
+		
+		# =====
+		private
+		# =====
+		def self.autocomplete_query(term)
+			uri = "http://reiseauskunft.bahn.de/bin/ajax-getstop.exe/en?REQ0JourneyStopsS0A=1&REQ0JourneyStopsS0G=#{CGI.escape(term.to_s)}"
+			io = open(uri)
+			response_text = Iconv.iconv('utf-8', io.charset, io.read).first
+			response_json = JSON.parse(response_text.scan(/\{.*\}/).first)
+			response_json['suggestions']
+		end
+	
+		def fetch_autocomplete_result
+			populate_from_autocomplete_result(Bahn::Station.autocomplete_query(@id).first)
+		end
+
+		def populate_from_autocomplete_result(autocomplete_data)
+			@id = autocomplete_data['id'].scan(/\@L=(\d+)\@/).first.first.to_i
+			@name = autocomplete_data['id'].scan(/\@O=([^\@]*)\@/).first.first
+			@x_coord = autocomplete_data['xcoord']
+			@y_coord = autocomplete_data['ycoord']
+		end
+	end
+	
+	class DepartureBoard
+		TRANSPORT_TYPES = {
+			:ice =>0x100,
+			:ic_ec => 0x80,
+			:ir => 0x40,
+			:regional => 0x20,
+			:urban => 0x10,
+			:bus => 0x08,
+			:boat => 0x04,
+			:subway => 0x02,
+			:tram => 0x01
+		}
+		include Enumerable
+		def initialize(station, opts)
+			@station = station
+			
+			transport_types = Array(opts[:include] || TRANSPORT_TYPES.keys) - Array(opts[:exclude])
+			filter_num = transport_types.inject(0) {|sum, type| sum + (TRANSPORT_TYPES[type] || 0) }
+			filter = sprintf("%09b", filter_num)
+			@url_prefix = "http://reiseauskunft.bahn.de/bin/bhftafel.exe/en?input=#{station.id}&productsFilter=#{filter}&start=1&boardType=dep&dateBegin=14.12.08&dateEnd=12.12.09&time=00:00"
+			@departure_pages = []
+		end
+		
+		def each
+			0.upto(23) do |hour|
+				doc = departure_page(hour)
+				# find all tr children of table.result which contain a td.train
+				# and do not have class 'browse'
+				departure_docs = doc / 'table.result tr[td.train]:not(.browse)'
+				departure_docs.each do |departure_doc|
+					service_link = departure_doc % 'td.train:nth-child(1) a'
+					destination_link = departure_doc % 'td.route span.bold a'
+					(destination_id, destination_time_string), = destination_link['onclick'].scan(/^sHC\(this, '', '(\d+)','([^']*)'\)/)
+					destination_time = ClockTime.parse(destination_time_string)
+
+					intermediate_stops =  (departure_doc % 'td.route').children.find_all{|node| node.text?}.join(' ')
+					departure_time = ClockTime.parse((departure_doc % 'td.time').inner_text)
+					last_time = departure_time
+					days_passed = 0
+
+					intermediate_stops.scan(/\d+:\d+/) do |time_string|
+						time = ClockTime.parse(time_string)
+						days_passed += 1 if time < last_time
+						last_time = time
+					end
+					inferred_time_to_destination = days_passed * 24*60*60 + (destination_time - departure_time)
+					
+					platform_td = departure_doc % 'td.platform'
+					if platform_td.nil?
+						platform = :none
+					else
+						platform = platform_td.inner_text.strip
+					end
+
+					yield Stop.new(
+						:station => @station,
+						:service => Service.new(
+							:path => service_link['href'].sub(/\?.*/, ''),
+							:name => service_link.inner_text.strip.gsub(/\s+/, ' '),
+							:destination_info => {
+								:station => Station.new(
+									:id => destination_id,
+									:name => destination_link.inner_text.strip
+								),
+								:arrival_time => destination_time
+							}
+						),
+						:departure_time => departure_time,
+						:platform => (platform == '' ? :none : platform),
+						:inferred_time_to_destination => inferred_time_to_destination
+					)
+				end
+			end
+		end
+		
+		# =====
+		private
+		# =====
+		def departure_page(hour)
+			@departure_pages[hour] ||= Hpricot(open("#{@url_prefix}%2B#{hour * 60}"))
+		end
+	end
+	
+	# Represents a scheduled train (or other transportation) service. This is not specific to
+	# a particular day's train, but encompasses all trains taking this route at this
+	# time of day. When services are subject to daily or seasonal variations, each such variation
+	# is considered a Service of its own, even if they share the same service name.
+	class Service
+		def initialize(opts) # :nodoc:
+			@path = opts[:path]
+			@name = opts[:name]
+			if opts[:origin_info]
+				@origin = Stop.new(opts[:origin_info].merge(
+					:service => self,
+					:arrival_time => :none,
+					:arrival_time_from_origin => :none,
+					:arrival_time_to_destination => :none,
+					:departure_time_from_origin => 0
+				))
+			end
+			if opts[:destination_info]
+				@destination = Stop.new(opts[:destination_info].merge(
+					:service => self,
+					:arrival_time_to_destination => 0,
+					:departure_time => :none,
+					:departure_time_from_origin => :none,
+					:departure_time_to_destination => :none
+				))
+			end
+		end
+		
+		# The designated name for this service, if any - e.g. "ICE 692".
+		attr_reader :name
+		
+		# Returns an array of Stop objects for all the stops that this service makes.
+		def stops
+			if !@stops
+				stop_docs = traininfo_response_doc / "table.result tr[td.station]"
+				last_time = nil
+				days_passed = 0
+				
+				origin_departure_time = nil
+				
+				@stops = stop_docs.collect {|stop_doc|
+					station_link = stop_doc % 'td.station a'
+					
+					arrival_time = ClockTime.parse((stop_doc % 'td.arrival').inner_text)
+					departure_time = ClockTime.parse((stop_doc % 'td.departure').inner_text)
+					origin_departure_time ||= departure_time
+					
+					if arrival_time.nil?
+						arrival_time_from_origin = :none
+					else
+						days_passed += 1 if (!last_time.nil? && arrival_time < last_time)
+						arrival_time_from_origin = days_passed * 24*60*60 + (arrival_time - origin_departure_time)
+						last_time = arrival_time
+					end
+					
+					if departure_time.nil?
+						departure_time_from_origin = :none
+					else
+						days_passed += 1 if (!last_time.nil? && departure_time < last_time)
+						departure_time_from_origin = days_passed * 24*60*60 + (departure_time - origin_departure_time)
+						last_time = departure_time
+					end
+	
+					platform = (stop_doc % 'td.platform').inner_text.strip
+
+					Stop.new(
+						:station => Station.new(
+							:id => station_link['href'].scan(/&input=[^&]*%23(\d+)&/).first.first,
+							:name => station_link.inner_text
+						),
+						:service => self,
+						:arrival_time => arrival_time || :none,
+						:departure_time => departure_time || :none,
+						:platform => (platform == '' ? :none : platform),
+						:arrival_time_from_origin => arrival_time_from_origin,
+						:departure_time_from_origin => departure_time_from_origin
+					)
+				}
+			end
+			@stops
+		end
+		
+		# Returns the Stop object for the departure station of this service.
+		def origin
+			@origin ||= stops.first
+		end
+
+		# Returns the Stop object for the destination station of this service.
+		def destination
+			@destination ||= stops.last
+		end
+		
+		def inspect # :nodoc:
+			"#<#{self.class} @name=#{@name.inspect} @origin=#{@origin.inspect} @destination=#{@destination.inspect}>"
+		end
+		
+		# Returns a hash code which will match for any two Service objects that stop at the same list of
+		# stations at the same times. (This is the nearest thing we have to a unique ID, as Deutsche Bahn
+		# do not expose unique IDs for services)
+		def hash
+			stops.collect{|stop| stop.subhash}.hash
+		end
+		
+		# Returns an array of strings indicating the features of this train, as listed as 'Comments:' on
+		# the Deutsche Bahn website; e.g. "Subject to compulsory reservation", "Sleeping-car". There
+		# doesn't seem to be a consistent format for these.
+		def features
+			if @features.nil?
+				tr = (traininfo_response_doc / 'table.remarks tr').find {|tr| (tr % 'th').inner_text == 'Comments:'}
+				if tr
+					@features = (tr / 'td strong').collect {|elem| elem.inner_text}.uniq
+				else
+					@features = []
+				end
+			end
+			@features
+		end
+		
+		# =====
+		private
+		# =====
+		def traininfo_response_doc
+			@traininfo_response_doc ||= Hpricot(open("http://reiseauskunft.bahn.de#{@path}"))
+		end
+	end
+	
+	# Represents a stop made at a Station by a Service.
+	class Stop
+		def initialize(opts) # :nodoc:
+			# for the following fields, use :none to mean none supplied (as opposed to not fetched yet):
+			# @arrival_time, @departure_time, @platform, @arrival_time_from_origin, @departure_time_from_origin
+
+			@station = opts[:station] # required
+			@service = opts[:service] # required
+			@arrival_time = opts[:arrival_time]
+			@departure_time = opts[:departure_time] # arrival_time or departure_time is required
+			@platform = opts[:platform]
+			@arrival_time_from_origin = opts[:arrival_time_from_origin]
+			@departure_time_from_origin = opts[:departure_time_from_origin]
+
+			@inferred_time_to_destination = opts[:inferred_time_to_destination]
+			
+			# these can be calculated from arrival_time_from_origin and departure_time_from_origin
+			# (but require service.origin, and therefore service.stops, to have been looked up)
+			@arrival_time_to_destination = opts[:arrival_time_to_destination]
+			@departure_time_to_destination = opts[:departure_time_to_destination]
+		end
+		
+		# The Station where this stop occurs.
+		attr_reader :station
+		# The Service making this stop.
+		attr_reader :service
+		
+		# The name of the station for this stop (provided as a shortcut for stop.station.name).
+		def name
+			@station.name
+		end
+
+		# The Stop object for the departure station (provided as a shortcut for stop.service.origin).
+		def origin
+			@service.origin
+		end
+
+		# The Stop object for the destination station (provided as a shortcut for stop.service.destination).
+		def destination
+			@service.destination
+		end
+		
+		# Returns the platform number or name for this stop, or nil if not specified.
+		def platform
+			get_full_details if @platform.nil?
+			@platform == :none ? nil : @platform
+		end
+		
+		# Returns the ClockTime at which the service arrives at this station, or nil if not specified
+		# (e.g. because this is the origin station for the service, or is for boarding only).
+		def arrival_time
+			get_full_details if @arrival_time.nil?
+			@arrival_time == :none ? nil : @arrival_time
+		end
+
+		# Returns the ClockTime at which the service leaves at this station, or nil if not specified
+		# (e.g. because this is the destination station for the service, or is for alighting only).
+		def departure_time
+			get_full_details if @departure_time.nil?
+			@departure_time == :none ? nil : @departure_time
+		end
+		
+		# Returns the time between departing the origin station and arriving at this station,
+		# as a number of seconds, or nil if arrival time is not specified.
+		def arrival_time_from_origin
+			get_full_details if @arrival_time_from_origin.nil?
+			@arrival_time_from_origin == :none ? nil : @arrival_time_from_origin
+		end
+		
+		# Returns the time between departing the origin station and departing from this station,
+		# as a number of seconds, or nil if departure time is not specified.
+		def departure_time_from_origin
+			get_full_details if @departure_time_from_origin.nil?
+			@departure_time_from_origin == :none ? nil : @departure_time_from_origin
+		end
+		
+		# Returns the time between arriving at this station and arriving at the destination station,
+		# as a number of seconds, or nil if arrival time is not specified.
+		def arrival_time_to_destination
+			if @arrival_time_to_destination.nil?
+				if arrival_time_from_origin == :none
+					@arrival_time_to_destination == :none
+				else
+					@arrival_time_to_destination = @service.destination.arrival_time_from_origin - arrival_time_from_origin
+				end
+			end
+			@arrival_time_to_destination
+		end
+
+		# Returns the time between departing from this station and arriving at the destination station,
+		# as a number of seconds, or nil if departure time is not specified.
+		def departure_time_to_destination
+			if @departure_time_to_destination.nil?
+				if departure_time_from_origin == :none
+					@departure_time_to_destination == :none
+				else
+					@departure_time_to_destination = @service.destination.arrival_time_from_origin - departure_time_from_origin
+				end
+			end
+			@departure_time_to_destination
+		end
+		
+		# Returns calculated time to destination while minimising additional hits to the Deutsche Bahn website:
+		# * if the service timetable has already been fetched, use that;
+		# * if nothing relevant has been fetched yet, fetch the service timetable and use that;
+		# * if only the station timetable has been fetched, use that. This may result in an inaccurate count -
+		#   see BUGS in README.txt.
+		def inferred_time_to_destination
+			@inferred_time_to_destination ||= departure_time_to_destination || arrival_time_to_destination
+		end
+
+		def inspect # :nodoc:
+			"#<#{self.class} @time=#{(@departure_time.nil? || @departure_time == :none ? @arrival_time : @departure_time).inspect} @station=#{@station.name.inspect} @destination=#{service.destination.station.name.inspect}>"
+		end
+		
+		# Code identifying this stop, which can form part of the hash for the Service.
+		# Not quite suitable as a hash for this stop in its own right, as different trains
+		# at the same station at the same time will have the same hash...
+		def subhash # :nodoc:
+			[@station.id, departure_time, arrival_time].hash
+		end
+
+		# =====
+		private
+		# =====
+		def get_full_details
+			if @arrival_time and @arrival_time != :none
+				stop = @service.stops.find {|stop|
+					stop.station.id == @station.id && stop.arrival_time == @arrival_time
+				}
+				@departure_time = stop.departure_time || :none
+			else
+				stop = @service.stops.find {|stop|
+					stop.station.id == @station.id && stop.departure_time == @departure_time
+				}
+				@arrival_time = stop.arrival_time || :none
+			end
+			@platform = stop.platform || :none
+			@arrival_time_from_origin = stop.arrival_time_from_origin || :none
+			@departure_time_from_origin = stop.departure_time_from_origin || :none
+		end
+	end
+end

data/test/test_bahn.rb

@@ -0,0 +1,8 @@
+require "test/unit"
+require "bahn"
+
+class TestBahn < Test::Unit::TestCase
+  def test_sanity
+    flunk "write tests or I will kneecap you"
+  end
+end

metadata

@@ -0,0 +1,71 @@
+--- !ruby/object:Gem::Specification 
+name: gasman-bahn
+version: !ruby/object:Gem::Version 
+  version: 1.0.0
+platform: ruby
+authors: 
+- Matt Westcott
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-05-17 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.12.2
+    version: 
+description: A library for accessing train information from Deutsche Bahn in an object-oriented way
+email: 
+- matt@west.co.tt
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- README.txt
+files: 
+- History.txt
+- Manifest.txt
+- README.txt
+- Rakefile
+- lib/bahn.rb
+- test/test_bahn.rb
+has_rdoc: true
+homepage: 
+post_install_message: 
+rdoc_options: 
+- --main
+- README.txt
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: bahn
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: A library for accessing train information from Deutsche Bahn in an object-oriented way
+test_files: 
+- test/test_bahn.rb