viaggiatreno 1.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in viaggiatreno.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Michele Bologna
+
+MIT License
+
+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/README.md

@@ -0,0 +1,29 @@
+# Viaggiatreno
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'viaggiatreno'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install viaggiatreno
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/viaggiatreno.rb

@@ -0,0 +1,6 @@
+require "viaggiatreno/version"
+require "viaggiatreno/Train"
+
+
+module Viaggiatreno
+end

data/lib/viaggiatreno/RegExpMatchInfo.rb

@@ -0,0 +1,23 @@
+class RegExpMatchInfo
+
+  # regex to match train status (string)
+  @@REGEXP_STATE_RUNNING = /(Il treno viaggia.*)(Ultimo rilevamento a)(.*)/
+  @@REGEXP_STATE_NOT_STARTED = /Il treno non e' ancora partito/
+  @@REGEXP_STATE_FINISHED = /Il treno e' arrivato.*/
+  @@REGEXP_DELAY_STR = /con (\d+) minuti di ([anticipo|ritardo]+)/
+  @@REGEXP_NODELAY_STR = /Il treno .* in orario.*/
+  @@REGEXP_STOP_ALREADY_DONE = /giaeffettuate/
+  @@STR_DELAY_STR = "ritardo"
+  @@STR_TRAIN_NUMBER_URL_REPLACE = "TRAINNUMBER"
+
+  # attr_reader for class variables
+  def self.REGEXP_STATE_FINISHED() @@REGEXPSTATE_FINISHED end
+  def self.REGEXP_STATE_RUNNING() @@REGEXP_STATE_RUNNING end
+  def self.REGEXP_STATE_NOT_STARTED() @@REGEXP_STATE_NOT_STARTED end
+  def self.REGEXP_STATE_FINISHED() @@REGEXP_STATE_FINISHED end
+  def self.STR_DELAY_STR() @@STR_DELAY_STR end
+  def self.REGEXP_DELAY_STR() @@REGEXP_DELAY_STR end
+  def self.REGEXP_NODELAY_STR() @@REGEXP_NODELAY_STR end
+  def self.REGEXP_STOP_ALREADY_DONE() @@REGEXP_STOP_ALREADY_DONE end
+  def self.STR_TRAIN_NUMBER_URL_REPLACE() @@STR_TRAIN_NUMBER_URL_REPLACE end
+end

data/lib/viaggiatreno/Scraper.rb

@@ -0,0 +1,87 @@
+require 'open-uri'
+require 'nokogiri'
+require_relative 'TrainStop'
+require_relative 'TrainState'
+require_relative 'StringUtils'
+require_relative 'RegExpMatchInfo'
+require_relative 'StopState'
+require_relative 'XPathMatchInfo'
+require_relative 'ViaggiatrenoURLs'
+
+class Scraper
+
+  def initialize(trainNumber, train)
+    @site_info_main = ViaggiatrenoURLs.SITE_INFO_MAIN.gsub(
+        RegExpMatchInfo.STR_TRAIN_NUMBER_URL_REPLACE, trainNumber)
+    @site_info_details = ViaggiatrenoURLs.SITE_INFO_DETAILS.gsub(
+        RegExpMatchInfo.STR_TRAIN_NUMBER_URL_REPLACE, trainNumber)
+    @train = train
+  end
+
+  # fetch and parse basic train information (status, trainName, details)
+  def updateTrain()
+    doc = Nokogiri::HTML(open(@site_info_main))
+    doc.xpath(XPathMatchInfo.XPATH_STATUS).each do |x|
+      @status = StringUtils.remove_newlines_tabs_and_spaces(x)
+    end
+    doc.xpath(XPathMatchInfo.XPATH_TRAIN_NAME).each do |x|
+      @trainName = x.content
+    end
+    if @status =~ RegExpMatchInfo.REGEXP_STATE_NOT_STARTED
+      @train.state = TrainState.NOT_STARTED
+    elsif @status =~ RegExpMatchInfo.REGEXP_STATE_RUNNING or \
+        RegExpMatchInfo.REGEXP_STATE_FINISHED
+      if @status =~ RegExpMatchInfo.REGEXP_NODELAY_STR
+        @train.delay = 0
+      else 
+        @train.delay = @status.match(RegExpMatchInfo.REGEXP_DELAY_STR)[1].to_i
+        if @status.match(RegExpMatchInfo.REGEXP_DELAY_STR)[2] \
+            != RegExpMatchInfo.STR_DELAY_STR
+          # train is ahead of time, delay is negative
+          @train.delay *= -1
+        end
+      end
+      if @status =~ RegExpMatchInfo.REGEXP_STATE_RUNNING
+        @train.state = TrainState.RUNNING
+        @train.lastUpdate = @status.match(
+            RegExpMatchInfo.REGEXP_STATE_RUNNING)[3].strip
+        @status = @status.match(RegExpMatchInfo.REGEXP_STATE_RUNNING)[1].rstrip
+      else
+        @train.state = TrainState.FINISHED
+      end
+    end
+
+    @train.status = @status
+    @train.trainName = @trainName
+  end
+ 
+  # fetch and parse train details (departing and arriving station, 
+  # intermediate stops)
+  def updateTrainDetails()
+    doc = Nokogiri::HTML(open(@site_info_details))
+    doc.xpath(XPathMatchInfo.XPATH_DETAILS_GENERIC).each do |x|
+      x.xpath(XPathMatchInfo.XPATH_DETAILS_STATION_NAME).each do |stationName|
+        @stationName = stationName.to_s
+      end
+      x.xpath(XPathMatchInfo.XPATH_DETAILS_SCHEDULED_STOP_TIME).each do \
+          |scheduledArrivalTime|
+        @scheduledArrivalTime = StringUtils.remove_newlines_tabs_and_spaces(
+            scheduledArrivalTime).to_s
+      end
+      x.xpath(XPathMatchInfo.XPATH_DETAILS_ACTUAL_STOP_TIME).each do \
+          |actualArrivalTime|
+        @actualArrivalTime = StringUtils.remove_newlines_tabs_and_spaces(
+            actualArrivalTime).to_s
+      end
+      if x.attributes()['class'].to_s =~ RegExpMatchInfo.REGEXP_STOP_ALREADY_DONE
+        t = TrainStop.new(@stationName, @scheduledArrivalTime, 
+                          @actualArrivalTime, StopState.DONE)
+      else
+        t = TrainStop.new(@stationName, @scheduledArrivalTime, 
+                          @actualArrivalTime, StopState.TODO)
+      end
+      @train.addStop(t)
+    end
+  end
+end
+

data/lib/viaggiatreno/StopState.rb

@@ -0,0 +1,8 @@
+class StopState
+    # train station status: already done ("DONE") or to be done ("TODO")
+    @@DONE = "DONE"
+	@@TODO = "TODO"
+
+	def self.DONE() @@DONE end
+	def self.TODO() @@TODO end
+end

data/lib/viaggiatreno/StringUtils.rb

@@ -0,0 +1,7 @@
+class StringUtils
+    # utility method
+	def self.remove_newlines_tabs_and_spaces(str) 
+		return str.content.gsub(/\r/, "").gsub(/\n/, "")\
+		    .gsub(/\t/, " ").gsub(/ +/, " ").strip
+	end
+end

data/lib/viaggiatreno/Train.rb

@@ -0,0 +1,92 @@
+require_relative 'Scraper.rb'
+require_relative 'TrainState.rb'
+require_relative 'TrainStop.rb'
+
+class Train
+  attr_accessor :trainNumber, :trainName, :delay, :status, :lastUpdate, :state
+
+  def initialize(trainNumber)
+    @trainNumber = trainNumber
+    @scraper = Scraper.new(trainNumber.to_s, self)
+    self.update()
+  end
+
+  def update()
+    @scraper.updateTrain()
+  end
+
+  def updateDetails()
+    @trainStops = Array.new
+    @scraper.updateTrainDetails()
+  end
+
+  def to_s
+   return "#{@trainNumber} #{@trainName}: #{@status} state: #{@state}, \
+   delay: #{@delay}, lastUpdate: #{@lastUpdate} #{@trainStops}"
+  end
+
+  def addStop(trainStop)
+    @trainStops << trainStop
+  end
+
+  def trainStops()
+    if @trainStops == nil
+      self.updateDetails()
+    end
+    @trainStops
+  end
+
+  def departingStation()
+    self.trainStops.first.trainStation.to_s
+  end
+
+  def arrivingStation()
+    self.trainStops.last.trainStation.to_s
+  end
+
+  def scheduledDepartingTime()
+    self.trainStops.first.scheduledStopTime.to_s
+  end
+
+  def scheduledArrivingTime()
+    self.trainStops.last.scheduledStopTime.to_s
+  end
+
+  def actualDepartingTime()
+    self.trainStops.first.actualStopTime.to_s
+  end
+
+  def actualArrivingTime()
+    self.trainStops.last.actualStopTime.to_s
+  end
+
+  def scheduledStopTime(stationName) 
+    self.trainStops.each do |trainStop| 
+      if trainStop.trainStation.to_s == stationName 
+        return trainStop.scheduledStopTime.to_s
+      end
+    end
+  end
+
+  def actualStopTime(stationName) 
+    self.trainStops.each do |trainStop| 
+      if trainStop.trainStation.to_s == stationName 
+        return trainStop.actualStopTime.to_s
+      end
+    end
+  end
+
+  def lastStop() 
+    if self.trainStops[0].status.to_s != StopState.DONE
+      return @trainStops[0].to_s
+    end
+    (self.trainStops.length-1).times do |i|
+      if self.trainStops[i].status.to_s == StopState.DONE && \
+          self.trainStops[i+1].status.to_s != StopState.DONE
+        return self.trainStops[i].to_s
+      end
+    end
+    return self.trainStops[self.trainStops.length-1].to_s
+  end
+end  
+

data/lib/viaggiatreno/TrainState.rb

@@ -0,0 +1,11 @@
+class TrainState
+	# Train status
+	@@RUNNING = "TRAVELING"
+	@@FINISHED = "ARRIVED"
+	@@NOT_STARTED = "NOT DEPARTED"
+
+	def self.RUNNING() @@RUNNING end
+	def self.FINISHED() @@FINISHED end
+	def self.NOT_STARTED() @@NOT_STARTED end
+end
+

data/lib/viaggiatreno/TrainStop.rb

@@ -0,0 +1,24 @@
+require_relative 'StopState'
+
+class TrainStop
+	attr_accessor :trainStation, :scheduledStopTime, :actualStopTime, :status
+
+	def initialize(trainStation, scheduledStopTime, actualStopTime, status)
+		@trainStation = trainStation
+		@scheduledStopTime = scheduledStopTime
+		@actualStopTime = actualStopTime
+		@status = status
+	end
+
+	def to_s
+	    retstr = ""
+		if @status == StopState.DONE
+			retstr += "[X] " 
+		elsif @status == StopState.TODO
+			retstr += "[ ] " 
+		end
+		retstr += "#{trainStation} = SCHEDULED: #{scheduledStopTime} EXPECTED: #{actualStopTime}"
+		return retstr
+	end
+end
+

data/lib/viaggiatreno/ViaggiatrenoURLs.rb

@@ -0,0 +1,17 @@
+require_relative 'RegExpMatchInfo'
+
+class ViaggiatrenoURLs
+	@@SITE_INFO_MAIN = 
+	    "http://mobile.viaggiatreno.it/viaggiatreno/mobile/numero?numeroTreno=" + \
+	    RegExpMatchInfo.STR_TRAIN_NUMBER_URL_REPLACE + \
+	    "&tipoRicerca=numero&lang=IT"
+    @@SITE_INFO_DETAILS = 
+        "http://mobile.viaggiatreno.it/viaggiatreno/mobile/scheda?dettaglio=visualizza&numeroTreno=" + \
+        RegExpMatchInfo.STR_TRAIN_NUMBER_URL_REPLACE + \
+        "&tipoRicerca=numero&lang=IT"
+
+    def self.SITE_INFO_MAIN() @@SITE_INFO_MAIN end
+    def self.SITE_INFO_DETAILS() @@SITE_INFO_DETAILS end
+
+end
+

data/lib/viaggiatreno/XPathMatchInfo.rb

@@ -0,0 +1,19 @@
+class XPathMatchInfo
+    # xpath expression to retrieve train info
+	@@XPATH_STATUS = '//div[@class="evidenziato"]/strong'
+	@@XPATH_TRAIN_NAME = '//h1/text()'
+	@@XPATH_DETAILS_GENERIC = 
+	    '//div[@class="giaeffettuate"] | //div[@class="corpocentrale"]'
+	@@XPATH_DETAILS_STATION_NAME = 'h2/text()'
+	@@XPATH_DETAILS_SCHEDULED_STOP_TIME = 'p[1]/strong[1]/text()'
+	@@XPATH_DETAILS_ACTUAL_STOP_TIME = 'p[2]/strong[1]/text()'
+
+	def self.XPATH_STATUS() @@XPATH_STATUS end
+	def self.XPATH_TRAIN_NAME() @@XPATH_TRAIN_NAME end
+	def self.XPATH_DETAILS_GENERIC() @@XPATH_DETAILS_GENERIC end
+	def self.XPATH_DETAILS_STATION_NAME() @@XPATH_DETAILS_STATION_NAME end
+	def self.XPATH_DETAILS_SCHEDULED_STOP_TIME() 
+	     @@XPATH_DETAILS_SCHEDULED_STOP_TIME end
+	def self.XPATH_DETAILS_ACTUAL_STOP_TIME() @@XPATH_DETAILS_ACTUAL_STOP_TIME end
+end
+

data/lib/viaggiatreno/version.rb

@@ -0,0 +1,4 @@
+module Viaggiatreno
+  VERSION = "1.0.1"
+end
+

data/viaggiatreno.gemspec

@@ -0,0 +1,20 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'viaggiatreno/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "viaggiatreno"
+  gem.version       = Viaggiatreno::VERSION
+  gem.authors       = ["Michele Bologna"]
+  gem.email         = ["michele.bologna@gmail.com"]
+  gem.description   = %q{A web scraper to fetch real time information on train riding the Italian railway system (viaggiatreno/trenitalia)}
+  gem.summary       = %q{A scraper for real time information on Italian railway system (viaggiatreno)}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+  gem.add_dependency "nokogiri"
+end

metadata

@@ -0,0 +1,79 @@
+--- !ruby/object:Gem::Specification
+name: viaggiatreno
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Michele Bologna
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-05-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A web scraper to fetch real time information on train riding the Italian
+  railway system (viaggiatreno/trenitalia)
+email:
+- michele.bologna@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/viaggiatreno.rb
+- lib/viaggiatreno/RegExpMatchInfo.rb
+- lib/viaggiatreno/Scraper.rb
+- lib/viaggiatreno/StopState.rb
+- lib/viaggiatreno/StringUtils.rb
+- lib/viaggiatreno/Train.rb
+- lib/viaggiatreno/TrainState.rb
+- lib/viaggiatreno/TrainStop.rb
+- lib/viaggiatreno/ViaggiatrenoURLs.rb
+- lib/viaggiatreno/XPathMatchInfo.rb
+- lib/viaggiatreno/version.rb
+- viaggiatreno.gemspec
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: A scraper for real time information on Italian railway system (viaggiatreno)
+test_files: []