viaggiatreno 1.0.2 → 1.0.5

data/spec/viaggiatreno/train_spec.rb

@@ -0,0 +1,190 @@
+require 'spec_helper'
+require 'viaggia_treno'
+
+describe Train do
+  describe 'Arrived train (delay negative)' do
+    before do
+      VCR.use_cassette('Arrived train (delay negative)') do
+        @train = Train.new('2550')
+        @train.update_details
+      end
+    end
+
+    it do
+      expect(@train.to_s).to eq \
+        '2550 REG 2550: Il treno e\' arrivato con 2 minuti di anticipo state'\
+        ': ARRIVED,     delay: -2, last_update: '
+      expect(@train.state).to eq TrainState::ARRIVED
+      expect(@train.delay).to eq(-2)
+      expect(@train.train_number).to eq '2550'
+      expect(@train.train_name).to eq 'REG 2550'
+      expect(@train.status).to eq 'Il treno e\' arrivato con 2 minuti di anticipo'
+      expect(@train.last_update).to eq nil
+      expect(@train.last_stop).to eq '[X] TIRANO = SCHEDULED: 08:52 ACTUAL: 08:50'
+      expect(@train.departing_station).to eq 'MILANO CENTRALE'
+      expect(@train.arriving_station).to eq 'TIRANO'
+      expect(@train.scheduled_departing_time).to eq '06:20'
+      expect(@train.actual_departing_time).to eq '06:20'
+      expect(@train.scheduled_arriving_time).to eq '08:52'
+      expect(@train.actual_arriving_time).to eq '08:50'
+      expect(@train.scheduled_stop_time('COLICO')).to eq '07:47 [DONE]'
+      expect(@train.actual_stop_time('COLICO')).to eq '07:49 [DONE]'
+      expect(@train.train_stops.map(&:to_s)).to eq \
+        [
+          '[X] MILANO CENTRALE = SCHEDULED: 06:20 ACTUAL: 06:20',
+          '[X] MONZA = SCHEDULED: 06:31 ACTUAL: 06:32',
+          '[X] LECCO = SCHEDULED: 06:59 ACTUAL: 06:55',
+          '[X] VARENNA ESINO = SCHEDULED: 07:23 ACTUAL: 07:23',
+          '[X] BELLANO TARTAVELLE TERME = SCHEDULED: 07:28 ACTUAL: 07:29',
+          '[X] COLICO = SCHEDULED: 07:47 ACTUAL: 07:49',
+          '[X] MORBEGNO = SCHEDULED: 07:59 ACTUAL: 08:01',
+          '[X] SONDRIO = SCHEDULED: 08:20 ACTUAL: 08:20',
+          '[X] TRESENDA-APRICA-TEGLIO = SCHEDULED: 08:40 ACTUAL: 08:37',
+          '[X] TIRANO = SCHEDULED: 08:52 ACTUAL: 08:50'
+        ]
+    end
+  end
+
+  describe 'Arrived train (delay = 0)' do
+    before do
+      VCR.use_cassette('Arrived train (delay = 0)') do
+        @train = Train.new('3961')
+        @train.update_details
+      end
+    end
+
+    it do
+      expect(@train.to_s).to eq \
+        '3961 REG 3961: Il treno e\' arrivato in orario state: ARRIVED,     delay: 0, last_update: '
+      expect(@train.state).to eq TrainState::ARRIVED
+      expect(@train.delay).to eq 0
+      expect(@train.train_number).to eq '3961'
+      expect(@train.train_name).to eq 'REG 3961'
+      expect(@train.status).to eq 'Il treno e\' arrivato in orario'
+      expect(@train.last_update).to eq nil
+      expect(@train.last_stop).to eq '[X] ALESSANDRIA = SCHEDULED: 09:48 ACTUAL: 09:48'
+      expect(@train.departing_station).to eq 'MILANO CENTRALE'
+      expect(@train.arriving_station).to eq 'ALESSANDRIA'
+      expect(@train.scheduled_departing_time).to eq '08:25'
+      expect(@train.actual_departing_time).to eq '08:27'
+      expect(@train.scheduled_arriving_time).to eq '09:48'
+      expect(@train.actual_arriving_time).to eq '09:48'
+      expect(@train.scheduled_stop_time('TORTONA')).to eq '09:27 [DONE]'
+      expect(@train.actual_stop_time('TORTONA')).to eq '09:27 [DONE]'
+    end
+  end
+
+  describe 'Arrived train (delay positive)' do
+    before do
+      VCR.use_cassette('Arrived train (delay positive)') do
+        @train = Train.new('2109')
+        @train.update_details
+      end
+    end
+
+    it do
+      expect(@train.to_s).to eq \
+        '2109 REG 2109: Il treno e\' arrivato con 3 minuti di ritardo state: '\
+        'ARRIVED,     delay: 3, last_update: '
+      expect(@train.state).to eq TrainState::ARRIVED
+      expect(@train.delay).to eq 3
+      expect(@train.train_number).to eq '2109'
+      expect(@train.train_name).to eq 'REG 2109'
+      expect(@train.status).to eq 'Il treno e\' arrivato con 3 minuti di ritardo'
+      expect(@train.last_update).to eq nil
+      expect(@train.last_stop).to eq '[X] VERONA PORTA NUOVA = SCHEDULED: 20:20 ACTUAL: 20:23'
+      expect(@train.departing_station).to eq 'MILANO CENTRALE'
+      expect(@train.arriving_station).to eq 'VERONA PORTA NUOVA'
+      expect(@train.scheduled_departing_time).to eq '18:25'
+      expect(@train.actual_departing_time).to eq '18:29'
+      expect(@train.scheduled_arriving_time).to eq '20:20'
+      expect(@train.actual_arriving_time).to eq '20:23'
+      expect(@train.scheduled_stop_time('DESENZANO')).to eq '19:50 [DONE]'
+      expect(@train.actual_stop_time('DESENZANO')).to eq '19:57 [DONE]'
+    end
+  end
+
+  describe 'Running train (delay positive)' do
+    before do
+      VCR.use_cassette('Running train (delay positive)') do
+        @train = Train.new('2655')
+        @train.update_details
+      end
+    end
+
+    it do
+      expect(@train.to_s).to eq \
+        '2655 REG 2655: Il treno viaggia con 1 minuti di ritardo state: '\
+        'TRAVELING,     delay: 1, last_update: MILANO LAMBRATE alle ore 14:28'
+      expect(@train.state).to eq TrainState::TRAVELING
+      expect(@train.delay).to eq 1
+      expect(@train.train_number).to eq '2655'
+      expect(@train.train_name).to eq 'REG 2655'
+      expect(@train.status).to eq 'Il treno viaggia con 1 minuti di ritardo'
+      expect(@train.last_update).to eq 'MILANO LAMBRATE alle ore 14:28'
+      expect(@train.last_stop).to eq '[X] MILANO LAMBRATE = SCHEDULED: 14:26 ACTUAL: 14:25'
+      expect(@train.departing_station).to eq 'MILANO CENTRALE'
+      expect(@train.arriving_station).to eq 'MANTOVA'
+      expect(@train.scheduled_departing_time).to eq '14:20'
+      expect(@train.actual_departing_time).to eq '14:21'
+      expect(@train.scheduled_arriving_time).to eq '16:10'
+      expect(@train.actual_arriving_time).to eq '16:11'
+      expect(@train.scheduled_stop_time('PIADENA')).to eq '15:46 [TO_BE_DONE]'
+      expect(@train.actual_stop_time('PIADENA')).to eq '15:47 [TO_BE_DONE]'
+      expect(@train.train_stops.map(&:to_s)).to eq \
+        [
+          '[X] MILANO CENTRALE = SCHEDULED: 14:20 ACTUAL: 14:21',
+          '[X] MILANO LAMBRATE = SCHEDULED: 14:26 ACTUAL: 14:25',
+          '[ ] MILANO ROGOREDO = SCHEDULED: 14:31 EXPECTED: 14:32',
+          '[ ] LODI = SCHEDULED: 14:46 EXPECTED: 14:47',
+          '[ ] CODOGNO = SCHEDULED: 15:01 EXPECTED: 15:02',
+          '[ ] PONTE D`ADDA = SCHEDULED: 15:11 EXPECTED: 15:12',
+          '[ ] CREMONA = SCHEDULED: 15:28 EXPECTED: 15:29',
+          '[ ] PIADENA = SCHEDULED: 15:46 EXPECTED: 15:47',
+          '[ ] MANTOVA = SCHEDULED: 16:10 EXPECTED: 16:11'
+        ]
+    end
+  end
+
+  describe 'Not departed train' do
+    before do
+      VCR.use_cassette('Not departed train') do
+        @train = Train.new('2657')
+        @train.update_details
+      end
+    end
+
+    it do
+      expect(@train.to_s).to eq \
+        '2657 REG 2657: Il treno non e\' ancora partito state: '\
+        'NOT DEPARTED,     delay: , last_update: '
+      expect(@train.state).to eq TrainState::NOT_DEPARTED
+      expect(@train.delay).to eq nil
+      expect(@train.train_number).to eq '2657'
+      expect(@train.train_name).to eq 'REG 2657'
+      expect(@train.status).to eq 'Il treno non e\' ancora partito'
+      expect(@train.last_update).to eq nil
+      expect(@train.last_stop).to eq nil
+      expect(@train.departing_station).to eq 'MILANO CENTRALE'
+      expect(@train.arriving_station).to eq 'MANTOVA'
+      expect(@train.scheduled_departing_time).to eq '16:20'
+      expect(@train.actual_departing_time).to eq ''
+      expect(@train.scheduled_arriving_time).to eq '18:10'
+      expect(@train.actual_arriving_time).to eq '18:10'
+      expect(@train.scheduled_stop_time('LODI')).to eq '16:46 [TO_BE_DONE]'
+      expect(@train.actual_stop_time('LODI')).to eq '16:46 [TO_BE_DONE]'
+      expect(@train.train_stops.map(&:to_s)).to eq \
+        [
+          '[ ] MILANO CENTRALE = SCHEDULED: 16:20 EXPECTED: ',
+          '[ ] MILANO LAMBRATE = SCHEDULED: 16:26 EXPECTED: 16:26',
+          '[ ] MILANO ROGOREDO = SCHEDULED: 16:31 EXPECTED: 16:31',
+          '[ ] LODI = SCHEDULED: 16:46 EXPECTED: 16:46',
+          '[ ] CODOGNO = SCHEDULED: 17:01 EXPECTED: 17:01',
+          '[ ] PONTE D`ADDA = SCHEDULED: 17:11 EXPECTED: 17:11',
+          '[ ] CREMONA = SCHEDULED: 17:28 EXPECTED: 17:28',
+          '[ ] PIADENA = SCHEDULED: 17:46 EXPECTED: 17:46',
+          '[ ] MANTOVA = SCHEDULED: 18:10 EXPECTED: 18:10'
+        ]
+    end
+  end
+end

data/spec/viaggiatreno_spec.rb

@@ -0,0 +1,9 @@
+require 'spec_helper'
+require 'viaggiatreno'
+
+describe Viaggiatreno do
+  describe '#version' do
+    subject { Viaggiatreno::VERSION }
+    it { should be_a String }
+  end
+end

data/viaggiatreno.gemspec

@@ -4,17 +4,18 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'viaggiatreno/version'
 
 Gem::Specification.new do |gem|
-  gem.name          = "viaggiatreno"
+  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.authors       = ['Michele Bologna']
+  gem.email         = ['michele.bologna@gmail.com']
+  gem.description   = 'A web scraper to fetch real time information on train riding the Italian railway system (viaggiatreno/trenitalia)'
+  gem.summary       = '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.files         = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
+  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"
+  gem.add_development_dependency 'rake'
 end

metadata

@@ -1,30 +1,41 @@
 --- !ruby/object:Gem::Specification
 name: viaggiatreno
 version: !ruby/object:Gem::Version
-  version: 1.0.2
-  prerelease: 
+  version: 1.0.5
 platform: ruby
 authors:
 - Michele Bologna
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-02 00:00:00.000000000 Z
+date: 2016-01-20 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'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: A web scraper to fetch real time information on train riding the Italian
@@ -35,45 +46,66 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".codeclimate.yml"
+- ".gitignore"
+- ".rubocop.yml"
+- ".travis.yml"
 - Gemfile
-- LICENSE.txt
+- Guardfile
+- LICENSE
 - README.md
 - Rakefile
+- lib/viaggia_treno.rb
 - 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/regex_match_info.rb
+- lib/viaggiatreno/scraper.rb
+- lib/viaggiatreno/string_utils.rb
+- lib/viaggiatreno/train.rb
+- lib/viaggiatreno/train_state.rb
+- lib/viaggiatreno/train_stop.rb
+- lib/viaggiatreno/train_stop_state.rb
 - lib/viaggiatreno/version.rb
+- lib/viaggiatreno/viaggiatreno_urls.rb
+- lib/viaggiatreno/xpath_match_info.rb
+- spec/spec_helper.rb
+- spec/vcr_cassettes/Arrived_train_delay_0_.yml
+- spec/vcr_cassettes/Arrived_train_delay_negative_.yml
+- spec/vcr_cassettes/Arrived_train_delay_positive_.yml
+- spec/vcr_cassettes/Not_departed_train.yml
+- spec/vcr_cassettes/Running_train_delay_positive_.yml
+- spec/viaggiatreno/train_spec.rb
+- spec/viaggiatreno_spec.rb
 - viaggiatreno.gemspec
 homepage: ''
 licenses: []
+metadata: {}
 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
+rubygems_version: 2.2.2
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: A scraper for real time information on Italian railway system (viaggiatreno)
-test_files: []
+test_files:
+- spec/spec_helper.rb
+- spec/vcr_cassettes/Arrived_train_delay_0_.yml
+- spec/vcr_cassettes/Arrived_train_delay_negative_.yml
+- spec/vcr_cassettes/Arrived_train_delay_positive_.yml
+- spec/vcr_cassettes/Not_departed_train.yml
+- spec/vcr_cassettes/Running_train_delay_positive_.yml
+- spec/viaggiatreno/train_spec.rb
+- spec/viaggiatreno_spec.rb
+has_rdoc: 

data/LICENSE.txt

@@ -1,22 +0,0 @@
-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/lib/viaggiatreno/RegExpMatchInfo.rb

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

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