bahn.rb 1.0.0 → 2.0.0

data/README.md

@@ -0,0 +1,24 @@
+Load connections for public transportation from the m.bahn.de website.
+
+This is under heavy development. Don't expect a working solution!
+
+Example
+=
+	require 'bahn.rb'
+	
+	agent =  Bahn::Agent.new
+	routes = agent.get_routes(
+		"Düsseldorf reisholz s bahn", 	# start address or station
+		"Düsseldorf, Heerdter Sandberg 40 ",	# target address or station
+		:include_coords => true, # include coordinates of stations
+		:limit => 1,	# how many connections?
+		:start_type => :station, # :station or :address
+		:target_type => :address # :station or :address
+		)
+	# output the connection info
+	routes.each {|route| route.parts.each {|part| puts part } }
+
+How to help
+=
+Feel free to implement some additions, refactor and create a pull request!
+... and create tests of course ;)

data/lib/bahn/bahn_agent.rb

@@ -8,7 +8,7 @@ module Bahn
 	# 	You can go even use far distances...
 	#	routes = agent.get_routes "Heerdter Sandberg 35 Düsseldorf, Düsseldorf", "Berlin Hauptstraße 10"
 	# 	routes.each {|route| route.parts.each {|part| puts part } }
-	#		=> Am 2013-02-01 von 17:32 bis 17:33 : Düsseldorf - Oberkassel, Heerdter Sandberg 35 nach Heerdter Sandberg U, Düsseldorf via Fußweg
+	#		=> Am 2013-02-01 von 17:32 bis 17:33 : Düsseldorf - Oberkassel, Heerdter Sandberg 60 nach Heerdter Sandberg U, Düsseldorf via Fußweg
 	#		=> Am 2013-02-01 von 17:33 bis 17:47 : Heerdter Sandberg U, Düsseldorf nach Düsseldorf Hauptbahnhof via U 7
 	#		=> Am 2013-02-01 von 17:47 bis 17:53 : Düsseldorf Hauptbahnhof nach Düsseldorf Hbf via Fußweg
 	#		=> Am 2013-02-01 von 17:53 bis 22:22 : Düsseldorf Hbf nach Berlin Hbf via ICE 945
@@ -28,6 +28,12 @@ module Bahn
 			@@user_agent = val
 		end
 		
+		TYPES = 
+			{
+				:station => 1,
+				:address => 2
+			}.freeze
+		
 		# Initialize a new Agent
 		# options:
 		#  :user_agent => Set the user agent. Default: "bahn.rb"
@@ -41,41 +47,52 @@ module Bahn
 		# :start_type and :target_type should be the same, no other options is implemented yet
 		# Options:
 		# 	* :time => start time for the connection
-		# 	* :start_type => 1 = station, 2 = address
-		# 	* :target_type => 1 = station, 2 = address
+		# 	* :start_type => :station or :address
+		# 	* :target_type => :station or :address
+		#   * :include_coords => Include coordiantes for the station. This takes a while especially for longer routes! default: true
 		# Returns:
 		# 	Array of Bahn::Route(s)
 		# Raises:
 		# 	"no_route" if no route could be found
 		def get_routes from, to, options = {}
-			options = {:time => Time.now, :start_type => 2, :target_type => 2, :depth => 0}.merge(options)
+			options = {:time => Time.now, :start_type => :address, :target_type => :address, :depth => 0, :include_coords => true, :limit => 2}.merge(options)
+			options[:time] = options[:time] + 10.minutes # Ansonsten liegt die letzte Verbindung in der Vergangenheit
+			
 			page = @agent.get @@options[:url_route]
 			form = page.forms.first
-			form["REQ0JourneyDate"] = "#{options[:time].day}.#{options[:time].month}.#{options[:time].year-2000}"
-			form["REQ0JourneyTime"] = "#{options[:time].hour}:#{options[:time].min}"
-			form["REQ0JourneyStopsS0A"] = options[:start_type]
-			form["REQ0JourneyStopsZ0A"] = options[:target_type]
+			form["REQ0JourneyDate"] = options[:time].strftime "%d.%m.%y"
+			form["REQ0JourneyTime"] = options[:time].to_formatted_s :time
+			form["REQ0JourneyStopsS0A"] = TYPES[options[:start_type]]
+			form["REQ0JourneyStopsZ0A"] = TYPES[options[:target_type]]
 			form["REQ0JourneyStopsS0G"] = from
-			form["REQ0JourneyStopsZ0G"] = to			
+			form["REQ0JourneyStopsZ0G"] = to
+			form["REQ0JourneyProduct_prod_list"] = "4:0001111111000000"
 			result = form.submit(form.button_with(:value => "Suchen"))
 			
-			type = :undefined
-			type = :door2door if options[:start_type] == 2 && options[:target_type] == 2
-			type = :station2station if options[:start_type] == 1 && options[:target_type] == 1
-
 			routes = []
 			links = result.links_with(:href => /details=opened!/)
-			links.each  do |link|
-			  page = link.click 
-			  routes << Route.new(page, type)
+			links.each do |link|
+			  page = link.click
+			  routes << Route.new(page, options)
+			  break if routes.count == options[:limit]
 			end
 			
 			# Keine Station gefunden und es werden keine Vorschläge angezeigt... 
 			# also suchen wir nachder nächstbesten Adresse und nutzen dies
-			if links.count == 0 && options[:depth] == 0 && type == :door2door
-				from = find_address from
-				to = find_address to
-				return get_routes from, to, {:time => options[:time], :depth => options[:depth]+1}
+			if links.count == 0 && options[:depth] == 0 
+				if options[:start_type] == :address
+					from = find_address(from).name
+				elsif options[:start_type] == :station
+					from = find_station(from).name
+				end
+				
+				if options[:target_type] == :address
+					to = find_address(to).name
+				elsif options[:target_type] == :station
+					to = find_station(to).name
+				end
+				
+				return get_routes from, to, options.merge(:depth => options[:depth]+1)
 			end
 			
 			raise "no_route" if routes.count == 0 || links.count == 0			
@@ -90,7 +107,7 @@ module Bahn
 			result = @agent.get("#{@@options[:uri_stations]}#{name}").body.gsub("SLs.sls=", "").gsub(";SLs.showSuggestion();", "")
 			# a Mechanize::File instead of a Page is returned so we have to convert manually
 			result = Iconv.conv("utf-8", "iso-8859-1", result)
-			r = JSON.parse(result)["suggestions"].first["value"]
+			Station.new(JSON.parse(result)["suggestions"].first)
 		end
 		
 		# Finds the first usable address for the given parameter. The returned address can then be used for further processing in routes
@@ -101,7 +118,7 @@ module Bahn
 			result = @agent.get("#{@@options[:uri_adresses]}#{address}").body.gsub("SLs.sls=", "").gsub(";SLs.showSuggestion();", "")
 			# a Mechanize::File instead of a Page is returned so we have to convert manually
 			result = Iconv.conv("utf-8", "iso-8859-1", result)
-			JSON.parse(result)["suggestions"].first["value"]
+			Station.new(JSON.parse(result)["suggestions"].first)
 		end
 	end
 end

data/lib/bahn/bahn_route.rb

@@ -4,40 +4,72 @@ module Bahn
 	# At the end you'll have a nice step by step navigation
 	# Feel free to refactor ;)
 	class Route
-		include ActionView::Helpers::DateHelper
-		attr_accessor :price, :type, :parts
+		attr_accessor :price, :parts, :notes, :start_type, :target_type
 	
 		# Initialize with a Mechanize::Page and a specific type 
 		# The page should be the detail view of m.bahn.de
 		# Parameters:
 		# 	* page => Mechanize::Page
-		#	* type => :door2door or :station2station
-		def initialize page, type
+		#		* type => :door2door or :station2station
+		def initialize page, options = {}
+			options = {:start_type => :address, :target_type => :address, :include_coords => true}.merge(options)
+			@do_load = options[:include_coords]
+			self.start_type = options[:start_type]
+			self.target_type = options[:target_type]
 			summary_time = page.search("//div[contains(@class, 'querysummary2')]").text.gsub("\n", " ").strip
 			html_parts = page.search("//div[contains(@class, 'haupt')]")
 			price = html_parts.pop.text
 			html_parts.pop
-			@type = type
 
 			route = ""
 			html_parts.each do |part|
 				text = part.text.strip
 				next if text.start_with? "Reiseprofil" # not important
+				if text.starts_with?("Hinweis", "Aktuelle Informationen")
+					self.notes = "#{self.notes}\n#{text}" if !text.include?("Start/Ziel mit äquivalentem Bahnhof ersetzt")
+					next
+				end
+				
 				route << text << "\n"
 			end
-			route = route.split("\n")
-			create_door2door route, summary_time if @type == :door2door
-			create_station2station route if @type == :station2station
-		end
-		
-		# Start time from now in words
-		def start_time_from_now
-			distance_of_time_in_words DateTime.now, @parts.first.start_time
-		end
-		
-		# End time from now in words
-		def end_time_from_now
-			distance_of_time_in_words DateTime.now, @parts.last.start_time
+			route = route.split("\n")			
+			
+			idx = 3
+			@start = RoutePart.new
+			@target = RoutePart.new
+			if options[:start_type] == :address
+				@start.start = Station.new({"value" => route[0], :load => :foot, :do_load => @do_load})
+				@start.type = "Fußweg" # route[2]
+				@start.end_time = DateTime.parse(summary_time.split("-").first.gsub(".13", ".2013"))
+				@start.start_time = @start.end_time - route[1].to_i.minutes
+				@start.target = route[3]
+			elsif	options[:start_type] == :station
+				@start.start = Station.new({"value" => route[0], :load => :station, :do_load => @do_load})
+				@start.start_time = DateTime.parse(@date.to_s + route[1])
+				@start.type = route[2]
+				@start.end_time = DateTime.parse(@date.to_s + route[3])
+				@start.target = Station.new({"value" => route[4], :load => :station, :do_load => @do_load})
+				idx = 4
+			end
+			
+			@date = @start.start_time.to_date # otherwise all dates will be "today"
+			create_parts idx, route
+			if options[:target_type] == :station
+				@target = @parts.last
+			elsif options[:target_type] == :address
+				@target.type = "Fußweg"
+				@target.target = Station.new({"value" => route.last, :load => :foot, :do_load => @do_load})
+				if summary_time.split("-").last.strip.length != 5
+					# Date is included in the string
+					@target.end_time = DateTime.parse(summary_time.split("-").last.gsub(".13", ".2013"))
+				else
+					# no date given, use start date
+					@target.end_time = DateTime.parse("#{@start.start_time.to_date} #{summary_time.split("-").last}")
+				end
+				
+				@target.end_time += route[route.length-3].to_i.minutes				
+				@parts << @target
+			end
 		end
 		
 		# Start time of the  route
@@ -47,7 +79,7 @@ module Bahn
 		
 		# End time of the route
 		def end_time
-			@parts.last.start_time
+			@parts.last.end_time
 		end
 		
 		# Starting point of the route
@@ -62,74 +94,33 @@ module Bahn
 		
 		private
 		
-		# Create the station 2 station route parts...
-		def create_station2station route
-			@start = RoutePart.new
-			@start.start = route[0]
-			@start.start_time = DateTime.parse(@date.to_s + route[1])
-			@start.type = route[2]
-			@start.end_time = DateTime.parse(@date.to_s + route[3])
-			@start.target = route[4]
-			
-			@target = RoutePart.new # avoid nullpointer
-
-			@parts = [@start]
-			create_parts 0, route
-			@target = @parts.last
-		end
-		
-		# Create the door 2 door route parts
-		def create_door2door route, summary_time
-			@start = RoutePart.new
-			@start.start = route[0]
-			@start.type = "Fußweg" # route[2]
-			@start.end_time = DateTime.parse(summary_time.split("-").first.gsub(".13", ".2013"))
-			@start.start_time = @start.end_time - route[1].to_i.minutes
-			@start.target = route[3]
-						
-			@target = RoutePart.new
-			@target.type = "Fußweg"
-			@target.target = route.last
-			if summary_time.split("-").last.strip.length != 5
-				# Date is included in the string
-				@target.end_time = DateTime.parse(summary_time.split("-").last.gsub(".13", ".2013"))
-			else
-				# no date given, use start date
-				@target.end_time = DateTime.parse("#{@start.start_time.to_date} #{summary_time.split("-").last}")
-			end
-			
-			@target.end_time += route[route.length-3].to_i.minutes
-			
-			@date = (@start.start_time.to_date) # otherwise all dates will be "today"
-			@parts = [@start]
-			create_parts 3, route
-			@parts << @target
-		end
-		
 		# Create all general parts.
 		# Set @parts, @target and @date first!
 		def create_parts start_index, route
+			@parts = [@start]
 			i = start_index
+			done_anything = false
 			while i < route.length do
 				if route[i..i+4].count != 5 || route[i..i+4].include?(nil)
 					break
 				end
 				
+				done_anything = true
 				part = RoutePart.new
-				part.start = route[i]
+				part.start = Station.new({"value" => route[i], :load => :station, :do_load => @do_load})
 				@parts.last.target = part.start
 				part.type = route[i+2].squeeze
 				
 				begin
 					part.start_time = DateTime.parse(@date.to_s + route[i+1])
 					part.end_time = DateTime.parse(@date.to_s + route[i+3])
-					part.target = route[i+4]
+					part.target = Station.new({"value" => route[i+4], :load => :station, :do_load => @do_load})
 					i += 4
 				rescue ArgumentError
 					# occures if there is a "Fußweg" in between
 					part.start_time = @parts.last.end_time
 					part.end_time = part.start_time + route[i+1].to_i.minutes
-					part.target = route[i+3]
+					part.target = Station.new({"value" => route[i+3], :load => :foot, :do_load => @do_load})
 					i += 3
 				end	
 				
@@ -142,6 +133,11 @@ module Bahn
 				# we don't want to show Fußwege from and to the same station
 				@parts << part unless part.start == part.target
 			end
+			
+			unless done_anything
+				@target.start_time = @parts.last.end_time
+				@target.start = @parts.last.start 
+			end
 		end
 	end
 end

data/lib/bahn/bahn_routepart.rb

@@ -7,12 +7,26 @@ module Bahn
 		# Return a nicely formatted route
 		# Raises errors if not everything is set properly
 		def to_s
-			"Am #{start_time.to_date} von #{start_time.hour}:#{start_time.min} bis #{end_time.to_date.to_s + ' ' if end_time.to_date != start_time.to_date}#{end_time.hour}:#{end_time.min} : #{start} nach #{target} via #{type}"
+			"Am #{start_time.to_date} von #{start_time.to_formatted_s :time} bis #{end_time.to_date.to_s + ' ' if end_time.to_date != start_time.to_date}#{end_time.to_formatted_s :time} : #{start} nach #{target} via #{type}"
 		end
 		
 		# Set the type, e.g. Fußweg
 		def type= val
 			@type = val.squeeze(" ")
 		end
+		
+		def transport_type
+			short_type = self.type.split.first.downcase
+			if ["str", "u", "s", "re", "erb", "ic", "ice"].include? short_type
+				return :train
+			elsif ["bus", "ne"].include? short_type
+				return :bus
+			elsif "Fußweg" == short_type
+				return :foot
+			end
+			
+			# nothing else works
+			self.type
+		end
 	end
 end

data/lib/bahn/bahn_station.rb

@@ -0,0 +1,30 @@
+module Bahn
+	class Station
+		attr_accessor :lat, :lon, :name
+		def initialize json={}		
+			self.name = json["value"] unless json["value"].nil?
+			
+			if json[:do_load]
+				station = Agent.new.find_station(name) if json[:load] == :station			
+				station = Agent.new.find_address(name) if json[:load] == :foot
+			end
+			
+			if station.nil?
+				self.lat = json["ycoord"].insert(-7, ".") unless json["ycoord"].nil?
+				self.lon = json["xcoord"].insert(-7, ".") unless json["xcoord"].nil?
+			else
+				self.lat = station.lat
+				self.lon = station.lon
+			end
+		end
+		
+		def to_s
+			"#{self.name} (#{self.lat},#{self.lon})"
+		end
+		
+		def == other
+			return false if other.nil?
+			other.name == self.name
+		end
+	end
+end

data/lib/bahn.rb

@@ -1,10 +1,13 @@
 require 'rubygems'
 require 'mechanize'
 require 'active_support/all'
-require 'action_view'
 require 'json'
 
-
 require 'bahn/bahn_routepart' 
 require 'bahn/bahn_route' 
-require 'bahn/bahn_agent'
+require 'bahn/bahn_station' 
+require 'bahn/bahn_agent'
+
+module Bahn
+	VERSION = "2.0.0"
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: bahn.rb
 version: !ruby/object:Gem::Version 
-  hash: 23
+  hash: 15
   prerelease: 
   segments: 
-  - 1
+  - 2
   - 0
   - 0
-  version: 1.0.0
+  version: 2.0.0
 platform: ruby
 authors: 
 - Simon Woker
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2013-02-07 00:00:00 Z
+date: 2013-02-20 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   version_requirements: &id001 !ruby/object:Gem::Requirement 
@@ -86,10 +86,11 @@ files:
 - lib/bahn/bahn_agent.rb
 - lib/bahn/bahn_route.rb
 - lib/bahn/bahn_routepart.rb
-- lib/bahn/version.rb
+- lib/bahn/bahn_station.rb
 - lib/bahn.rb
 - LICENSE
-homepage: https://github.com/swoker/random_stuff
+- README.md
+homepage: https://github.com/swoker/bahn.rb
 licenses: []
 
 post_install_message: 

data/lib/bahn/version.rb

@@ -1,3 +0,0 @@
-module Bahn
-  VERSION = "1.0.0"
-end