bahn.rb 2.0.0 → 2.1.0

data/README.md

@@ -17,6 +17,17 @@ Example
 		)
 	# output the connection info
 	routes.each {|route| route.parts.each {|part| puts part } }
+	
+	# or with Geocoder
+	routes = agent.get_routes(
+		Geocoder.search("Düsseldorf reisholz s bahn").first, 	# start address or station
+		Geocoder.search("Düsseldorf, Heerdter Sandberg 40").first,	# target address or station
+		:include_coords => true, # include coordinates of stations
+		:limit => 1	# how many connections?
+		# you don't need start- and target-type with geocoder :)
+		)
+	# output the connection info
+	routes.each {|route| route.parts.each {|part| puts part } }
 
 How to help
 =

data/lib/bahn.rb

@@ -9,5 +9,5 @@ require 'bahn/bahn_station'
 require 'bahn/bahn_agent'
 
 module Bahn
-	VERSION = "2.0.0"
+	VERSION = "2.1.0"
 end

data/lib/bahn/bahn_agent.rb

@@ -44,30 +44,21 @@ module Bahn
 		
 		# 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 => :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 => :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
-			
+			options[:start_type] = check_point_type(from) || options[:start_type]
+			options[:target_type] =  check_point_type(to) || options[:target_type]
+			options = {:time => Time.now, :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].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["REQ0JourneyProduct_prod_list"] = "4:0001111111000000"
-			result = form.submit(form.button_with(:value => "Suchen"))
+			
+			result = submit_form page.forms.first, from, to, options		
 			
 			routes = []
 			links = result.links_with(:href => /details=opened!/)
@@ -78,20 +69,20 @@ module Bahn
 			end
 			
 			# Keine Station gefunden und es werden keine Vorschläge angezeigt... 
-			# also suchen wir nachder nächstbesten Adresse und nutzen dies
+			# also suchen wir nach der nächstbesten Adresse/Station und nutzen diese
 			if links.count == 0 && options[:depth] == 0 
 				if options[:start_type] == :address
-					from = find_address(from).name
+					from = find_address(from, options).name
 				elsif options[:start_type] == :station
-					from = find_station(from).name
+					from = find_station(from, options).name
 				end
 				
 				if options[:target_type] == :address
-					to = find_address(to).name
+					to = find_address(to, options).name
 				elsif options[:target_type] == :station
-					to = find_station(to).name
+					to = find_station(to, options).name
 				end
-				
+
 				return get_routes from, to, options.merge(:depth => options[:depth]+1)
 			end
 			
@@ -103,22 +94,82 @@ module Bahn
 		# 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)
-			Station.new(JSON.parse(result)["suggestions"].first)
+		def find_station name, options={}
+			val = get_address_or_station(name, :station)
+			options[:coords] = name.coordinates if name.respond_to?(:coordinates)
+			result = @agent.get("#{@@options[:uri_stations]}#{val}").body.gsub("SLs.sls=", "").gsub(";SLs.showSuggestion();", "")
+			find_nearest_station result, options
 		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();", "")
+		def find_address address, options={}
+			val = get_address_or_station(address, :address)
+			options[:coords] = address.coordinates if address.respond_to?(:coordinates)
+			result = @agent.get("#{@@options[:uri_adresses]}#{val}").body.gsub("SLs.sls=", "").gsub(";SLs.showSuggestion();", "")
+			find_nearest_station result, options
+		end
+		
+		############################################################################################
+		private
+		############################################################################################
+		
+		def find_nearest_station result, options={}
 			# a Mechanize::File instead of a Page is returned so we have to convert manually
-			result = Iconv.conv("utf-8", "iso-8859-1", result)
-			Station.new(JSON.parse(result)["suggestions"].first)
+			result = encode result
+			result = JSON.parse(result)["suggestions"]
+
+			if options[:coords].nil?
+				s = Station.new(result.first)
+			else
+				result.map!{|r| Station.new(r)}
+				result.each {|s| s.distance = Geocoder::Calculations.distance_between(options[:coords], s)}
+				result.sort! {|a,b| a.distance <=> b.distance}
+				s = result.first
+			end
+
+			s
+		end
+		
+		def encode str
+			if str.respond_to? :encode
+				str.force_encoding("iso-8859-1").encode("utf-8")
+			else
+				Iconv.conv("utf-8", "iso-8859-1", str)
+			end
+		end
+		
+		def check_point_type geocoder_result
+			return nil unless geocoder_result.is_a? Geocoder::Result::Base
+			return :address unless geocoder_result.address_components.index{|a| a["types"].include?("route")}.nil?
+			return :station if geocoder_result.address_components.index{|a| a["types"].include?("train_station") || a["types"].include?("transit_station")}.nil?
+			return :station
+		end
+		
+		def get_address_or_station geocoder_result, type
+			return geocoder_result.to_s unless geocoder_result.is_a? Geocoder::Result::Base
+			addy = geocoder_result.address
+			if type == :station
+				begin
+					addy = geocoder_result.address_components.find{|a| a["types"].include? "transit_station"}["short_name"]
+					addy += " #{geocoder_result.city}" unless addy.include?(geocoder_result.city)
+				rescue StandardError
+				end
+			end
+			addy
+		end
+		
+		def submit_form form, from, to, options
+			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"] = get_address_or_station(from, options[:start_type])
+			form["REQ0JourneyStopsZ0G"] = get_address_or_station(to, options[:target_type])
+			form["REQ0JourneyProduct_prod_list"] = "4:0001111111000000"
+			form.submit(form.button_with(:value => "Suchen"))
 		end
 	end
 end

data/lib/bahn/bahn_route.rb

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 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.

data/lib/bahn/bahn_routepart.rb

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 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"

data/lib/bahn/bahn_station.rb

@@ -1,6 +1,7 @@
 module Bahn
 	class Station
-		attr_accessor :lat, :lon, :name
+		attr_accessor :lat, :lon, :distance, :name
+		
 		def initialize json={}		
 			self.name = json["value"] unless json["value"].nil?
 			
@@ -22,6 +23,11 @@ module Bahn
 			"#{self.name} (#{self.lat},#{self.lon})"
 		end
 		
+		def to_coordinates
+			[lat, lon]
+		end
+		alias_method :coordinates, :to_coordinates
+		
 		def == other
 			return false if other.nil?
 			other.name == self.name

metadata

@@ -1,88 +1,66 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: bahn.rb
-version: !ruby/object:Gem::Version 
-  hash: 15
+version: !ruby/object:Gem::Version
+  version: 2.1.0
   prerelease: 
-  segments: 
-  - 2
-  - 0
-  - 0
-  version: 2.0.0
 platform: ruby
-authors: 
+authors:
 - Simon Woker
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2013-02-20 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
-  version_requirements: &id001 !ruby/object:Gem::Requirement 
+date: 2013-03-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: &12393320 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 1
-        - 6
-        version: "1.6"
-  requirement: *id001
-  prerelease: false
+      - !ruby/object:Gem::Version
+        version: '1.6'
   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
+  version_requirements: *12393320
+- !ruby/object:Gem::Dependency
   name: mechanize
-- !ruby/object:Gem::Dependency 
-  version_requirements: &id003 !ruby/object:Gem::Requirement 
+  requirement: &12392820 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
-  requirement: *id003
-  prerelease: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
+  prerelease: false
+  version_requirements: *12392820
+- !ruby/object:Gem::Dependency
   name: activesupport
-- !ruby/object:Gem::Dependency 
-  version_requirements: &id004 !ruby/object:Gem::Requirement 
+  requirement: &12392000 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
-  requirement: *id004
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
   prerelease: false
-  type: :development
+  version_requirements: *12392000
+- !ruby/object:Gem::Dependency
   name: rake
+  requirement: &12390680 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *12390680
 description: Load connections for public transportation from the m.bahn.de website.
 email: github@simonwoker.de
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - lib/bahn/bahn_agent.rb
 - lib/bahn/bahn_route.rb
 - lib/bahn/bahn_routepart.rb
@@ -92,38 +70,29 @@ files:
 - README.md
 homepage: https://github.com/swoker/bahn.rb
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
       - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+      hash: 3470599687635693811
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 23
-      segments: 
-      - 1
-      - 3
-      - 6
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
       version: 1.3.6
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.8.25
+rubygems_version: 1.8.11
 signing_key: 
 specification_version: 3
-summary: "Bahn \xC3\x96PNV information"
+summary: Bahn ÖPNV information
 test_files: []
-