bahn.rb 1.0.0

data/LICENSE

@@ -0,0 +1,7 @@
+Copyright (c) 2012 Simon Woker
+
+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/lib/bahn/bahn_agent.rb

@@ -0,0 +1,107 @@
+module Bahn
+	# Agent class that searches stations, street addresses and public transportation routes for germany
+	# Example:
+	# 	agent = Agent.new
+	# 	routes = agent.get_routes "Düsseldorf Heerdter Sandberg 25", "Düsseldorf Am Dreieck 1"
+	#	routes.each {|route| route.parts.each {|part| puts part } }
+	#	
+	# 	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: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
+	#		=> Am 2013-02-01 von 22:34 bis 22:40 : Berlin Hbf nach Berlin Alexanderplatz via RE 37386
+	#		=> Am 2013-02-01 von 22:40 bis 22:46 : Berlin Alexanderplatz nach Alexanderplatz (U), Berlin via Fußweg
+	#		=> Am 2013-02-01 von 22:46 bis 23:07 : Alexanderplatz (U), Berlin nach Oberseestr., Berlin via STR M5
+	#		=> Am 2013-02-01 von 23:07 bis 23:15 : Oberseestr., Berlin nach Berlin - Alt-Hohenschönhausen, Hauptstraße 10 via Fußweg
+	class Agent	
+		@@options = {
+			:url_route => 'http://mobile.bahn.de/bin/mobil/query.exe/dox?country=DEU&rt=1&use_realtime_filter=1&searchMode=ADVANCED',
+			:uri_adresses => 'http://reiseauskunft.bahn.de/bin/ajax-getstop.exe/en?REQ0JourneyStopsS0A=2&REQ0JourneyStopsS0G=',
+			:uri_stations => 'http://reiseauskunft.bahn.de/bin/ajax-getstop.exe/en?REQ0JourneyStopsS0A=1&REQ0JourneyStopsS0G='			
+		}
+	
+		# Set the used user agent
+		def self.user_agent=val
+			@@user_agent = val
+		end
+		
+		# Initialize a new Agent
+		# options:
+		#  :user_agent => Set the user agent. Default: "bahn.rb"
+		def initialize
+			@agent = Mechanize.new
+			@agent.user_agent = @@user_agent ||= "bahn.rb"
+		end
+		
+		# Get the next few routes with public transportation from A to B.
+		#
+		# :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
+		# 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)
+			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["REQ0JourneyStopsS0G"] = from
+			form["REQ0JourneyStopsZ0G"] = to			
+			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)
+			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}
+			end
+			
+			raise "no_route" if routes.count == 0 || links.count == 0			
+			routes
+		end
+		
+		# Find the first best station by name
+		# Example:
+		# 	Input: HH Allee Düsseldorf
+		# 	Output: Heinrich-Heine-Allee U, Düsseldorf
+		def find_station name		
+			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"]
+		end
+		
+		# Finds the first usable address for the given parameter. The returned address can then be used for further processing in routes
+		# Example: 
+		# 	Input: Roßstr. 41 40476 Düsseldorf 
+		# 	Output: Düsseldorf - Golzheim, Rossstraße 41
+		def find_address address		
+			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"]
+		end
+	end
+end

data/lib/bahn/bahn_route.rb

@@ -0,0 +1,147 @@
+module Bahn
+	# The whole Route from A to B.
+	# This is created from the m.bahn.de detail view page and parses the given data.
+	# 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
+	
+		# 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
+			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
+				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
+		end
+		
+		# Start time of the  route
+		def start_time
+			@parts.first.start_time
+		end
+		
+		# End time of the route
+		def end_time
+			@parts.last.start_time
+		end
+		
+		# Starting point of the route
+		def start
+			@parts.first.start
+		end
+		
+		# Target point of the route
+		def target
+			@parts.last.target
+		end
+		
+		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
+			i = start_index
+			while i < route.length do
+				if route[i..i+4].count != 5 || route[i..i+4].include?(nil)
+					break
+				end
+				
+				part = RoutePart.new
+				part.start = route[i]
+				@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]
+					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]
+					i += 3
+				end	
+				
+				part.end_time += 1.day if part.end_time.hour < @start.start_time.hour
+				part.start_time += 1.day if part.start_time.hour < @start.start_time.hour
+				
+				@target.start_time = part.end_time
+				@target.start = part.target
+				
+				# we don't want to show Fußwege from and to the same station
+				@parts << part unless part.start == part.target
+			end
+		end
+	end
+end

data/lib/bahn/bahn_routepart.rb

@@ -0,0 +1,18 @@
+module Bahn
+	# Route Parts show a small step of the route from A to B with one specific type of transportation
+	# Example: "Am 2013-02-01 von 17:33 bis 17:47 : Heerdter Sandberg U, Düsseldorf nach Düsseldorf Hauptbahnhof via U 7"
+	class RoutePart
+		attr_accessor :start, :target, :type, :price, :start_time, :end_time
+		
+		# 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}"
+		end
+		
+		# Set the type, e.g. Fußweg
+		def type= val
+			@type = val.squeeze(" ")
+		end
+	end
+end

data/lib/bahn/version.rb

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

data/lib/bahn.rb

@@ -0,0 +1,10 @@
+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'

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification 
+name: bahn.rb
+version: !ruby/object:Gem::Version 
+  hash: 23
+  prerelease: 
+  segments: 
+  - 1
+  - 0
+  - 0
+  version: 1.0.0
+platform: ruby
+authors: 
+- Simon Woker
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2013-02-07 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 1
+        - 6
+        version: "1.6"
+  requirement: *id001
+  prerelease: false
+  type: :runtime
+  name: json
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id002
+  prerelease: false
+  type: :runtime
+  name: mechanize
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id003
+  prerelease: false
+  type: :runtime
+  name: activesupport
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id004
+  prerelease: false
+  type: :development
+  name: rake
+description: Load connections for public transportation from the m.bahn.de website.
+email: github@simonwoker.de
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/bahn/bahn_agent.rb
+- lib/bahn/bahn_route.rb
+- lib/bahn/bahn_routepart.rb
+- lib/bahn/version.rb
+- lib/bahn.rb
+- LICENSE
+homepage: https://github.com/swoker/random_stuff
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 23
+      segments: 
+      - 1
+      - 3
+      - 6
+      version: 1.3.6
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: "Bahn \xC3\x96PNV information"
+test_files: []
+