gares 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 371e96298472d334dcfbce42c20bc6a67813139a
-  data.tar.gz: 3dc98f7e626ed7d6092b912a8e3441047bffb0c3
+  metadata.gz: 5a7346ed6637e992bd4ce2dc1be20d8b1e44fcf8
+  data.tar.gz: 2d681f7d329983887a33aed98d6399fde4097c85
 SHA512:
-  metadata.gz: 89a404991c7555b8c65ccfa57987f8e553b03f18c284be6a73536ab0ab3213e8060e32faafe29b2d4b8492c340d0ec8586ffe7cbf0b678ba8f71efe1485b69aa
-  data.tar.gz: a19cc680b00bc2244cf8670e0c60e60c91a92e75a0bade68004abc8adfc6f3c9e90a58000cc25700b0186629cbf0de49969162831c34a5caff3b9c48e40bccb9
+  metadata.gz: ca67937fb6fdfc242aefebb4661e67f456fde6512463ee367cab41bf33a06d0be452b21e8e5a1002ad75c28b22f0f044209cab6b899560295917303feaedf34d
+  data.tar.gz: 58958615ac14299dbae8ee968e8ef22ce9e9eeaf71bfddcc5664412c214a118f480bba287e38df92ad20353e9c44684c96e8e578c643f580e315c1df0c04852b

data/README.md

@@ -5,6 +5,7 @@
 ## Description
 
 The Gares gem allows you to easily access publicly available data from gares-en-mouvement.com.
+It can also retrieve data from sncf.com for live train information.
 
 ## Features
 
@@ -12,6 +13,7 @@ Gares currently features the following:
 
 * Search for a station
 * Retrieve station information
+* Search for a train to get live information about it
 
 ## Examples
 
@@ -34,6 +36,8 @@ Gares currently features the following:
     [g.lat, g.long]
     #=> [45.760281, 4.859801]
 
+See the [`Gares::Base` class documentation](http://www.rubydoc.info/github/paulrbr/gares/master/Gares/Base) for all available data on a station.
+
 ### Searching:
 
     g = Gares::Search.new("Aix")
@@ -49,6 +53,30 @@ Gares currently features the following:
     station.name
     #=> "Paris Gare de Lyon"
 
+### Train information:
+
+    train = Gares::Train.new(11641, Time.now)
+
+    train.departure.station
+    #=> #<Gares::Station:0x000f0000000000 @slug="frpst", @name="Paris Est">
+
+    train.departure.departure_date
+    #=> 2015-04-25 06:42:00 +0200
+
+    train.stops.size
+    #=> 12
+
+    train.delayed?
+    #=> false
+
+    train.arrival.station.name
+    #=> "Culmont - Chalindrey"
+
+    train.arrival.platform
+    #=> "B"
+
+See the [`Gares::Train` class documentation](http://www.rubydoc.info/github/paulrbr/gares/master/Gares/Train) for all available data on a train.
+
 ## Installation
 
     gem install gares
@@ -85,6 +113,8 @@ the fixture files once with up-to-date content:
 
     $ rake fixtures:refresh
 
+__Warning: this will probably break some tests, in particular the live train information tests.__
+
 When you run the test suite now, it will use the updated fixture files.
 
 ## Disclaimer

data/gares.gemspec

@@ -22,6 +22,7 @@ Gem::Specification.new do |s|
   s.add_dependency 'nokogiri', '~> 1.6'
   s.add_dependency 'hashie', '~> 3.4'
   s.add_dependency 'unidecoder', '~> 1.1'
+  s.add_dependency 'httparty', '~> 0.13'
 
   s.add_development_dependency 'rake'
   s.add_development_dependency 'rspec'

data/lib/gares/train.rb

@@ -0,0 +1,62 @@
+require "net/http"
+require "uri"
+
+module Gares
+  # Represents something a train from http://www.sncf.com/fr/horaires-info-trafic/train
+  class Train
+    attr_accessor :date, :number
+
+    # Initialize a new Train object with it's number and departure date
+    #
+    #   train = Gares::Train.new(6704, Time.parse('2015-04-15'))
+    #
+    # Gares::Train objects are lazy loaded, meaning that no HTTP request
+    # will be performed when a new object is created. An HTTP request is made (once)
+    # Only when you use an accessor that needs the remote data.
+    def initialize(number, date)
+      fail "Please provide a train number" unless number.is_a?(Integer)
+      fail "Please provide a departure date" unless date.is_a?(Time)
+
+      @number = number
+      @date = date
+    end
+
+    # @return [TrainStop] The departure point of the train
+    def departure
+      @departure ||= TrainStop.new(document.at('tr.itinerary-start'), @date)
+    end
+
+    # @return [Array<TrainStop>] A list of all stops between departure and arrival stations.
+    def stops
+      @stops ||= document.css('tr.itinerary-stop').map { |stop| TrainStop.new(stop, @date) }
+    end
+
+    # @return [TrainStop] The arrival point of the train
+    def arrival
+      @arrival ||= TrainStop.new(document.at('tr.itinerary-end'), @date)
+    end
+
+    def delayed?
+      ([departure] + stops + [arrival]).any?(&:delayed?)
+    end
+
+    private
+
+    # Returns a new Nokogiri document for parsing.
+    def document
+      @document ||= Nokogiri::HTML(self.class.request_sncf(@number, @date))
+    end
+
+    def self.request_sncf(number, date)
+      uri = URI.parse("http://www.sncf.com/sncf/train")
+      response = Net::HTTP.post_form(uri, {"numeroTrain" => number, "date" => date.strftime("%d/%m/%Y")})
+      cookies = response.get_fields('Set-Cookie').map { |cookie| cookie.split(";").first }.join(";")
+
+      uri = URI.parse("http://www.sncf.com/en/horaires-info-trafic/train/resultats")
+      req = Net::HTTP::Get.new(uri.path)
+      req.add_field("Cookie", cookies)
+      Net::HTTP.new(uri.host, uri.port).start { |http| http.request(req) }.body
+    end
+
+  end # Train
+end # Gares

data/lib/gares/train_stop.rb

@@ -0,0 +1,86 @@
+require 'time'
+
+module Gares
+  # Represents a stop for a train from http://www.sncf.com/fr/horaires-info-trafic/train
+  class TrainStop
+    # @!attribute departure_date
+    #   @return [Time] The scheduled departure date at this stop.
+
+    # @!attribute real_departure_date
+    #   @return [Time] The live schedule departure date at this stop.
+
+    # @!attribute arrival_date
+    #   @return [Time] The scheduled arrival date at this stop.
+
+    # @!attribute real_arrival_date
+    #   @return [Time] The live schedule departure date at this stop.
+
+    # @!attribute station
+    #   @return [Station] The station in which this train is stopping.
+
+    # @!attribute platform
+    #   @return [String] The platform number/letter if available.
+
+    # @!attribute formatted_info
+    #   @return [String] A formatted detailed information in HTML.
+
+    attr_accessor :departure_date, :real_departure_date, :arrival_date, :real_arrival_date,
+      :station, :platform, :formatted_info
+
+    # Given the HTML node from sncf.com/fr/horaires-info-trafic/train containing the stop
+    # and the +date+ for this train stop.
+    # The object gathers all useful information about the stop made by the train.
+    def initialize(nokogiri_node, date)
+      initialize_dates(nokogiri_node, date)
+      initialize_station(nokogiri_node)
+      @platform = nokogiri_node.at('td.track').inner_html.strip
+      @formatted_info = nokogiri_node.at('td.info').inner_html.strip
+    end
+
+    def delayed?
+      minutes_of_delay > 0
+    end
+
+    # @return [Integer] The amount of minutes of delay at this stop.
+    def minutes_of_delay
+      if @real_departure_date
+        (@real_departure_date - @departure_date) / 60
+      else
+        0
+      end
+    end
+
+    private
+
+    def initialize_dates(node, date)
+      raw_time = node.at('td.time').inner_html.strip
+      raw_real_time = node.at('td.new-schedule').inner_html.strip
+      raw_arrival_time = raw_time.split('<br/>').first
+      raw_departure_time = raw_time.split('<br/>').last
+      raw_real_arrival_time = raw_real_time.split('<br/>').first
+      raw_real_departure_time = raw_real_time.split('<br/>').last
+
+      @departure_date = Time.parse(raw_departure_time, date)
+      @arrival_date = Time.parse(raw_arrival_time, date)
+      if raw_real_departure_time
+        @real_departure_date = Time.parse(raw_real_departure_time, date)
+      end
+      if raw_real_arrival_time
+        @real_arrival_date = Time.parse(raw_real_arrival_time, date)
+      end
+    end
+
+    def initialize_station(node)
+      raw_name = node.at('td.stations div.station').inner_html.strip
+      stations = Station.search(raw_name)
+      @station = if stations.size > 1
+        stations.find do |station|
+          name = /(^#{raw_name}$|^#{raw_name} | #{raw_name}$| #{raw_name} )/i
+          station.name.match(name)
+        end
+      else
+        stations.first
+      end
+    end
+  end
+end

data/lib/gares/version.rb

@@ -1,3 +1,3 @@
 module Gares
-  VERSION = '1.0.0'
+  VERSION = '1.1.0'
 end

data/lib/gares.rb

@@ -7,6 +7,7 @@ require 'nokogiri'
 require 'json'
 require 'hashie'
 require 'unidecoder'
+require 'httparty'
 
 require 'gares/base'
 require 'gares/station'
@@ -15,4 +16,6 @@ require 'gares/sales'
 require 'gares/services'
 require 'gares/search'
 require 'gares/string_extensions'
+require 'gares/train'
+require 'gares/train_stop'
 require 'gares/version'