viaggiatreno 1.0.2 → 1.0.5

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5cf3f766e8e7a062b46e264817834fe98d21f02c
+  data.tar.gz: 91de43e8d50a9b01e92e59984995e01467f73149
+SHA512:
+  metadata.gz: b8cc778203d61d1c5ced80dd05759b07c81a2278f2831160b0495b258636678ce90741a1d9fedb6acb926998879802a731d4378d6da6e2767283ac398b943d61
+  data.tar.gz: a0a8181f56b43948d01953abf2b2c1306e392013b7bf0790e46f51761f0c863dfc1ab06c19083de010527b4f078380f9e0417079f2e1003ef920f87e68268d09

data/.codeclimate.yml

@@ -0,0 +1,25 @@
+---
+engines:
+  duplication:
+    enabled: true
+    config:
+      languages:
+      - ruby
+      - javascript
+      - python
+      - php
+  fixme:
+    enabled: true
+  rubocop:
+    enabled: true
+ratings:
+  paths:
+  - "**.inc"
+  - "**.js"
+  - "**.jsx"
+  - "**.module"
+  - "**.php"
+  - "**.py"
+  - "**.rb"
+exclude_paths:
+- spec/**/*

data/.gitignore

@@ -1,6 +1,5 @@
 *.gem
 *.rbc
-.bundle
 .config
 .yardoc
 Gemfile.lock
@@ -15,3 +14,8 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+
+# Ignore bundle configuration
+/bin
+.bundle
+/vendor/bundle

data/.rubocop.yml

@@ -0,0 +1,46 @@
+AllCops:
+  Include:
+    - '**/Rakefile'
+    - '**/Gemfile'
+
+AndOr:
+  Enabled: false
+
+AsciiComments:
+  Enabled: false
+
+Blocks:
+  Enabled: false
+
+BracesAroundHashParameters:
+  Enabled: false
+
+ClassAndModuleChildren:
+  Enabled: false
+
+ClassLength:
+  Enabled: false
+
+ConstantName:
+  Enabled: false
+
+Documentation:
+  Enabled: false
+
+Encoding:
+  Enabled: false
+
+LineLength:
+  Max: 100
+
+MethodLength:
+  Max: 12
+
+RegexpLiteral:
+  Enabled: false
+
+SignalException:
+  EnforcedStyle: only_raise
+
+Validation:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,17 @@
+language: ruby
+rvm:
+  - 2.0.0
+  - 2.1.8
+  - 2.2.4
+  - 2.3.0
+  - ruby-head
+script:
+  - 'bundle exec rspec --color --format documentation'
+notifications:
+  recipients:
+    - michele.bologna@gmail.com
+    - marius.colacioiu@gmail.com
+sudo: false
+addons:
+  code_climate:
+    repo_token: 31c466aad9acda9cfe23ab74ca7a9c50a2243f2dd473d972a70c795c2affdab0

data/Gemfile

@@ -1,4 +1,13 @@
 source 'https://rubygems.org'
 
-# Specify your gem's dependencies in viaggiatreno.gemspec
 gemspec
+
+group :test do
+  gem 'codeclimate-test-reporter', require: nil
+  gem 'guard-rspec', require: false
+  gem 'guard-rubocop', require: false
+  gem 'rspec'
+  gem 'simplecov', require: false
+  gem 'vcr'
+  gem 'webmock'
+end

data/Guardfile

@@ -0,0 +1,12 @@
+guard :rspec, cmd: 'rspec' do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end
+
+guard :rubocop, all_on_start: false, cli: ['--format', 'clang'] do
+  watch(%r{^bin/flash$})
+  watch(%r{^lib/.+\.rb$})
+  watch(%r{^spec/.+\.rb$})
+  watch(%r{(?:.+/)?\.rubocop\.yml$}) { |m| File.dirname(m[0]) }
+end

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Michele Bologna
+
+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

@@ -1,6 +1,12 @@
 # Viaggiatreno
 
-TODO: Write a gem description
+[![Build Status](https://travis-ci.org/mbologna/viaggiatreno.svg)](https://travis-ci.org/mbologna/viaggiatreno)
+[![Code Climate](https://codeclimate.com/repos/569a5314b23bff7a6c011fb0/badges/7a1d250d86b806acee6c/gpa.svg)](https://codeclimate.com/repos/569a5314b23bff7a6c011fb0/feed)
+[![Test Coverage](https://codeclimate.com/repos/569a5314b23bff7a6c011fb0/badges/7a1d250d86b806acee6c/coverage.svg)](https://codeclimate.com/repos/569a5314b23bff7a6c011fb0/coverage)
+[![Issue Count](https://codeclimate.com/repos/569a5314b23bff7a6c011fb0/badges/7a1d250d86b806acee6c/issue_count.svg)](https://codeclimate.com/repos/569a5314b23bff7a6c011fb0/feed)
+
+This gem parses Italian railway real-time status for trains (viaggiatreno.it).
+Use this API to fetch online information about Italian trains.
 
 ## Installation
 
@@ -18,7 +24,7 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+See examples at http://michelebologna.net
 
 ## Contributing
 

data/Rakefile

@@ -1 +1,2 @@
-require "bundler/gem_tasks"
+require 'bundler/gem_tasks'
+task default: 'build'

data/lib/viaggia_treno.rb

@@ -0,0 +1 @@
+require 'viaggiatreno'

data/lib/viaggiatreno.rb

@@ -1,6 +1,5 @@
-require "viaggiatreno/version"
-require "viaggiatreno/Train"
-
+require 'viaggiatreno/version'
+require 'viaggiatreno/train'
 
 module Viaggiatreno
 end

data/lib/viaggiatreno/regex_match_info.rb

@@ -0,0 +1,11 @@
+class RegExpMatchInfo
+  # regex to match train status (string)
+  REGEXP_STATE_TRAVELING = /(Il treno viaggia.*)(Ultimo rilevamento a)(.*)/
+  REGEXP_STATE_NOT_DEPARTED = /Il treno non e' ancora partito/
+  REGEXP_STATE_ARRIVED = /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'.freeze
+  STR_TRAIN_NUMBER_URL_REPLACE = 'TRAINNUMBER'.freeze
+end

data/lib/viaggiatreno/scraper.rb

@@ -0,0 +1,94 @@
+require 'open-uri'
+require 'nokogiri'
+require_relative 'train_stop'
+require_relative 'train_state'
+require_relative 'string_utils'
+require_relative 'regex_match_info'
+require_relative 'train_stop_state'
+require_relative 'xpath_match_info'
+require_relative 'viaggiatreno_urls'
+
+class Scraper
+  def initialize(train_number, train)
+    @site_info_main = ViaggiatrenoURLs::SITE_INFO_MAIN.gsub(
+      RegExpMatchInfo::STR_TRAIN_NUMBER_URL_REPLACE, train_number)
+    @site_info_details = ViaggiatrenoURLs::SITE_INFO_DETAILS.gsub(
+      RegExpMatchInfo::STR_TRAIN_NUMBER_URL_REPLACE, train_number)
+    @train = train
+  end
+
+  # fetch and parse basic train information (status, train)name, details)
+  def update_train
+    doc = Nokogiri::HTML(open(@site_info_main))
+    @train.status = StringUtils.remove_newlines_tabs_and_spaces(
+      doc.xpath(XPathMatchInfo::XPATH_STATUS).first)
+    @train.train_name = doc.xpath(XPathMatchInfo::XPATH_TRAIN_NAME).first.content
+    update_train_status(@train)
+    @train.delay = fetch_train_delay(@train.status)
+  end
+
+  def update_train_status(train)
+    case
+    when train.status =~ RegExpMatchInfo::REGEXP_STATE_NOT_DEPARTED
+      train.state = TrainState::NOT_DEPARTED
+    when train.status =~ RegExpMatchInfo::REGEXP_STATE_ARRIVED
+      train.state = TrainState::ARRIVED
+    when train.status =~ RegExpMatchInfo::REGEXP_STATE_TRAVELING
+      train.state = TrainState::TRAVELING
+      regex_match = train.status.match(
+        RegExpMatchInfo::REGEXP_STATE_TRAVELING)
+      train.last_update = regex_match[3].strip
+      train.status = regex_match[1].rstrip
+    end
+  end
+
+  def fetch_train_delay(status)
+    return nil if @train.state == TrainState::NOT_DEPARTED
+    if status =~ RegExpMatchInfo::REGEXP_NODELAY_STR
+      delay = 0
+    else
+      delay = status.match(RegExpMatchInfo::REGEXP_DELAY_STR)[1].to_i
+      if status.match(RegExpMatchInfo::REGEXP_DELAY_STR)[2] != RegExpMatchInfo::STR_DELAY_STR
+        delay *= -1 # train is ahead of schedule, delay is negative
+      end
+    end
+    delay
+  end
+
+  # fetch and parse train details (departing and arriving station,
+  # intermediate stops)
+  def update_train_details
+    doc = Nokogiri::HTML(open(@site_info_details))
+    doc.xpath(XPathMatchInfo::XPATH_DETAILS_GENERIC).each do |x|
+      @station_name = x.xpath(XPathMatchInfo::XPATH_DETAILS_STATION_NAME).first.to_s
+      arrival_time = fetch_trainstop_arrival_time(x)
+      @scheduled_arrival_time = arrival_time['scheduled_arrival_time']
+      @actual_arrival_time = arrival_time['actual_arrival_time']
+      @status = update_trainstop_status(x, @train, @status)
+      @train.add_stop(TrainStop.new(
+                        @station_name, @scheduled_arrival_time,
+                        @actual_arrival_time, @status))
+    end
+  end
+
+  def update_trainstop_status(x, train, status)
+    status = if x.attributes['class'].to_s =~ RegExpMatchInfo::REGEXP_STOP_ALREADY_DONE && \
+                train.state != TrainState::NOT_DEPARTED
+               TrainStopState::DONE
+             else
+               TrainStopState::TO_BE_DONE
+             end
+    status
+  end
+
+  def fetch_trainstop_arrival_time(xpath)
+    scheduled_arrival_time = StringUtils.remove_newlines_tabs_and_spaces(
+      xpath.xpath(XPathMatchInfo::XPATH_DETAILS_SCHEDULED_STOP_TIME).first).to_s
+    actual_arrival_time = StringUtils.remove_newlines_tabs_and_spaces(
+      xpath.xpath(XPathMatchInfo::XPATH_DETAILS_ACTUAL_STOP_TIME).first).to_s
+    {
+      'scheduled_arrival_time' => scheduled_arrival_time,
+      'actual_arrival_time' => actual_arrival_time
+    }
+  end
+end

data/lib/viaggiatreno/string_utils.rb

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

data/lib/viaggiatreno/train.rb

@@ -0,0 +1,93 @@
+require_relative 'scraper.rb'
+require_relative 'train_state.rb'
+require_relative 'train_stop.rb'
+
+class Train
+  attr_accessor :train_number, :train_name, :delay, :status, :last_update, :state
+
+  def initialize(train_number)
+    @train_number = train_number
+    @scraper = Scraper.new(train_number.to_s, self)
+    update
+  end
+
+  def update
+    @scraper.update_train
+  end
+
+  def update_details
+    @train_stops = []
+    @scraper.update_train_details
+  end
+
+  def to_s
+    "#{@train_number} #{@train_name}: #{@status} state: #{@state}, \
+    delay: #{@delay}, last_update: #{@last_update}"
+  end
+
+  def add_stop(train_stop)
+    @train_stops << train_stop
+  end
+
+  def train_stops
+    update_details if @train_stops.nil?
+    @train_stops
+  end
+
+  def departing_station
+    train_stops.first.train_station.to_s
+  end
+
+  def arriving_station
+    train_stops.last.train_station.to_s
+  end
+
+  def scheduled_departing_time
+    train_stops.first.scheduled_stop_time.to_s
+  end
+
+  def scheduled_arriving_time
+    train_stops.last.scheduled_stop_time.to_s
+  end
+
+  def actual_departing_time
+    train_stops.first.actual_stop_time.to_s
+  end
+
+  def actual_arriving_time
+    train_stops.last.actual_stop_time.to_s
+  end
+
+  def scheduled_stop_time(station_name)
+    find_stop_time(station_name)['scheduled']
+  end
+
+  def actual_stop_time(station_name)
+    find_stop_time(station_name)['actual']
+  end
+
+  def last_stop
+    return train_stops.last.to_s if @state == TrainState::ARRIVED
+    train_stops.each_with_index do |train_stop, index|
+      if train_stop.status == TrainStopState::DONE && \
+         train_stops[index + 1].status == TrainStopState::TO_BE_DONE
+        return train_stop.to_s
+      end
+    end
+    nil
+  end
+
+  private
+
+  def find_stop_time(station_name)
+    train_stops.each do |train_stop|
+      if train_stop.train_station.to_s == station_name
+        return \
+        {
+          'actual' => "#{train_stop.actual_stop_time} [#{train_stop.status}]",
+          'scheduled' => "#{train_stop.scheduled_stop_time} [#{train_stop.status}]"
+        }
+      end
+    end
+  end
+end

data/lib/viaggiatreno/train_state.rb

@@ -0,0 +1,6 @@
+class TrainState
+  # Train status
+  TRAVELING = 'TRAVELING'.freeze
+  ARRIVED = 'ARRIVED'.freeze
+  NOT_DEPARTED = 'NOT DEPARTED'.freeze
+end

data/lib/viaggiatreno/train_stop.rb

@@ -0,0 +1,26 @@
+require_relative 'train_stop_state'
+
+class TrainStop
+  attr_accessor :train_station, :scheduled_stop_time, :actual_stop_time, :status
+
+  def initialize(train_station, scheduled_stop_time, actual_stop_time, status)
+    @train_station = train_station
+    @scheduled_stop_time = scheduled_stop_time
+    @actual_stop_time = actual_stop_time
+    @status = status
+  end
+
+  def to_s
+    retstr = ''
+    if @status == TrainStopState::DONE
+      done = 'X'
+      actual_or_expected = 'ACTUAL'
+    elsif @status == TrainStopState::TO_BE_DONE
+      done = ' '
+      actual_or_expected = 'EXPECTED'
+    end
+    retstr += "[#{done}] #{train_station} = SCHEDULED: #{scheduled_stop_time}"\
+              " #{actual_or_expected}: #{actual_stop_time}"
+    retstr
+  end
+end