gares 1.1.1 → 2.0.0.pre.pre

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 37c2b4d26cf3ffa144fb673445cca829225fab7b
-  data.tar.gz: dbb3e6740437f1dab018ee9da896123192e84ef4
+  metadata.gz: f87e7dc8b8d185548c8dcc4c12c789e07802caea
+  data.tar.gz: 971aa5a58e033f79d41f901899bc6d862c56f5f0
 SHA512:
-  metadata.gz: ffffb7fe4abf9d9dd92cb16d5e416b67b4d950004dfebf6ed1e457b431f85d3ee4786dfef5acaca6784770b186f1ba08f74dbd06a17f4ef8e0b75c98704bcdd9
-  data.tar.gz: 914ebb3686e8539e739e4ae009825104df72ddaccb28f657abe6a128461ae3b18db5602b75f6856603ce8b8c844aacafd540fb3df0eb194b02659d49c14986d2
+  metadata.gz: 4432ec3fa4011d82f5b22f63aa647e7b75fca52fa2222335032f9cbb0b5078bcb59008d9d9bfd4fe9474143248d212beac197c2c5758b871519968bed5a8fd38
+  data.tar.gz: 9afd2bd055b35a12e10b15b10d9a29c4208744c0ae1a119c39403f4b8ccfb9ad06c66e1f6d92c8b6bdd09113e6d9c9a068ee9b41412cbad0586127a4ced2f589

data/Guardfile

@@ -1,6 +1,6 @@
 group 'gem' do
   guard 'rspec', :cmd => "bundle exec rspec", :all_on_start => false, :all_after_pass => false, :failed_mode => :focus do
     watch(%r{^spec/.+_spec\.rb$})
-    watch(%r{^lib/(.+)\.rb$})                          { |m| "spec/gares/#{m[1]}_spec.rb" }
+    watch(%r{^lib/gares/(.+)\.rb$})                          { |m| "spec/gares/#{m[1]}_spec.rb" }
   end
 end

data/README.md

@@ -22,7 +22,7 @@ Gares currently features the following:
     g = Gares::Station.new("frlpd")
 
     g.name
-    #=> "Lyon Part Dieu"
+    #=> "Lyon Part-Dieu"
 
     g.wifi?
     #=> true
@@ -33,7 +33,7 @@ Gares currently features the following:
     g.services.first
     #=> "Services à la clientèle"
 
-    [g.lat, g.long]
+    [g.latitude, g.longitude]
     #=> [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.
@@ -43,7 +43,7 @@ See the [`Gares::Base` class documentation](http://www.rubydoc.info/github/paulr
     g = Gares::Search.new("Aix")
 
     g.stations.size
-    #=> 7
+    #=> 28
 
     # or
 
@@ -51,14 +51,14 @@ See the [`Gares::Base` class documentation](http://www.rubydoc.info/github/paulr
     station = stations.last
 
     station.name
-    #=> "Paris Gare de Lyon"
+    #=> "Aéroport-Lyon-Saint-Exupéry"
 
 ### Train information:
 
     train = Gares::Train.new(11641, Time.now)
 
     train.departure.station
-    #=> #<Gares::Station:0x000f0000000000 @slug="frpst", @name="Paris Est">
+    #=> #<Gares::Station:0x000f0000000000 @name="Paris-Gare-de-l’Est", ...>
 
     train.departure.departure_date
     #=> 2015-04-25 06:42:00 +0200
@@ -70,7 +70,7 @@ See the [`Gares::Base` class documentation](http://www.rubydoc.info/github/paulr
     #=> false
 
     train.arrival.station.name
-    #=> "Culmont - Chalindrey"
+    #=> "Culmont-Chalindrey"
 
     train.arrival.platform
     #=> "B"
@@ -132,3 +132,5 @@ _This gem is not endorsed or affiliated with gares-en-mouvement.com, nor SNCF, I
 ## License
 
 See [MIT-LICENSE](https://github.com/paulrbr/gares/blob/master/MIT-LICENSE)
+
+Station database [ODbL LICENSE](https://raw.githubusercontent.com/capitainetrain/stations/master/LICENCE.txt)

data/gares.gemspec

@@ -21,6 +21,7 @@ Gem::Specification.new do |s|
 
   s.add_dependency 'nokogiri', '~> 1.6'
   s.add_dependency 'hashie', '~> 3.4'
+  s.add_dependency 'smarter_csv', '~> 1.0'
   s.add_dependency 'unidecoder', '~> 1.1'
   s.add_dependency 'httparty', '~> 0.13'
 

data/lib/gares/base.rb

@@ -1,92 +1,118 @@
 module Gares
   # Represents something on gare-en-mouvement.com
-  class Base
-    attr_accessor :slug, :name
-
-    GPS_COORD = 'Coordonnées GPS : '
-    NAME = 'En direct de '
-
-    # Initialize a new Station object with it's gare-en-mouvemnt id (as a String)
-    #
-    #   station = Gares::Station.new("frabt")
-    #
-    # Gares::Station 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(slug, name = nil)
-      @slug = slug
-      @name = name if name
-    end
-
-    def lat
-      coordinates.first.to_f
-    end
-
-    def long
-      coordinates.last.to_f
-    end
-
+  class Base < Hashie::Dash
+    property :id
+    property :name
+    property :slug
+    property :sncf_id
+    property :longitude
+    property :latitude
+    property :uic
+    property :uic8_sncf
+    property :parent_station_id
+    property :is_city
+    property :country
+    property :is_main_station
+    property :time_zone
+    property :is_suggestable
+    property :sncf_is_enabled
+    property :idtgv_id
+    property :idtgv_is_enabled
+    property :db_id
+    property :db_is_enabled
+    property :idbus_id
+    property :idbus_is_enabled
+    property :ouigo_id
+    property :ouigo_is_enabled
+    property :trenitalia_id
+    property :trenitalia_is_enabled
+    property :ntv_id
+    property :ntv_is_enabled
+    property :'info:fr'
+    property :'info:en'
+    property :'info:de'
+    property :'info:it'
+    property :same_as
+
+    # @deprecated
     def services
-      @services ||= Services.new(@slug)
+      warn "[DEPRECATION] since gares-en-mouvement.com does not exist anymore."
+      @services ||= Services.new(sncf_id: sncf_id)
       @services.all
     end
 
+    # @deprecated
     def sales
-      @sales ||= Sales.new(@slug)
+      warn "[DEPRECATION] since gares-en-mouvement.com does not exist anymore."
+      @sales ||= Sales.new(sncf_id: sncf_id)
       @sales.all
     end
 
+    # @deprecated
     def horaires
+      warn "[DEPRECATION] since gares-en-mouvement.com does not exist anymore."
       document.search('ul.ouverture_heure li').
           map { |horaire| horaire.inner_html } rescue []
     end
     alias opening_hours horaires
 
     # Whether the gare has a defibrillator or not
+    # @deprecated
     def defibrillateur?
+      warn "[DEPRECATION] since gares-en-mouvement.com does not exist anymore."
       !document.at('div.defibrillateur').nil?
     end
     alias defibrillator? defibrillateur?
 
     # Whether the gare is equipped with wifi or not
+    # @deprecated
     def wifi?
+      warn "[DEPRECATION] since gares-en-mouvement.com does not exist anymore."
       !document.at('div.wifi').nil?
     end
 
+    # @deprecated
     def has_borne?
+      warn "[DEPRECATION] since gares-en-mouvement.com does not exist anymore."
       sales.any? { |sales_service| sales_service =~ /bornes?.libre.service/i }
     end
 
-    # Returns a string containing the name
-    def name(force_refresh = false)
-      if @name && !force_refresh
-        @name
-      else
-        @name = document.at('h1').inner_html.gsub(NAME, '') rescue nil
-      end
+    # deprecated
+    def slug
+      sncf_id.downcase
     end
 
-    private
+    # deprecated
+    def lat
+      latitude
+    end
 
-    def coordinates
-      @coordinates ||= document.xpath("//p/strong[contains(text(), '#{GPS_COORD}')]").first.parent.text
-        .gsub(GPS_COORD, '').split(',')
+    # deprecated
+    def long
+      longitude
     end
 
+    private
+
     # Returns a new Nokogiri document for parsing.
     def document
-      @document ||= Nokogiri::HTML(Gares::Station.find_by_slug(@slug))
+      @document ||= Nokogiri::HTML(self.class.external_data(sncf_id))
     end
 
     # Use HTTParty to fetch the raw HTML for this gare.
-    def self.find_by_slug(slug, page = :"votre-gare")
-      open("http://www.gares-en-mouvement.com/fr/#{slug}/#{page}")
+    # @deprecated
+    def self.external_data(sncf_id, page = :"votre-gare")
+      open("http://www.gares-en-mouvement.com/fr/#{sncf_id.downcase}/#{page}")
     end
 
-    # Convenience method for search
+    # Convenience method for search (by name)
     def self.search(query)
       Gares::Search.new(query).stations
     end
+
+    # Convenience method for search_by_sncf_id
+    def self.search_by_sncf_id(query)
+      Gares::Search.new(query, :sncf_id).stations
+    end
   end # Base
 end # Gares

data/lib/gares/errors.rb

@@ -0,0 +1,14 @@
+module Gares
+  # All errors from this gem will inherit from this one.
+  class Error < StandardError
+  end
+  class UnsupportedIndex < StandardError
+  end
+
+  # Raised when requesting a train that does not exist.
+  class TrainNotFound < Error
+  end
+  # Raised when requesting a station that does not exist.
+  class StationNotFound < Error
+  end
+end

data/lib/gares/sales.rb

@@ -9,8 +9,7 @@ module Gares
     private
 
     def document
-      @document ||= Nokogiri::HTML(Gares::Station.find_by_slug(
-        @slug, :"services-en-gare/vente/"))
+      @document ||= Nokogiri::HTML(self.class.external_data(sncf_id, :"services-en-gare/vente/"))
     end
   end
 end

data/lib/gares/search.rb

@@ -3,11 +3,11 @@ module Gares
   class Search < StationList
     attr_reader :query
 
-    # This is a file containing minimal information (name and slug) of all stations of gares-en-mouvement.com
-    GARES_LIST_URL = "https://www.kimonolabs.com/api/7jys32dy?apikey=lsOO4tNm78cH9JxqWg9gAk9l4nYaou9j&kimmodify=1"
+    # This is the stations database from capitainetrain.com
+    GARES_LIST_URL = "https://raw.githubusercontent.com/capitainetrain/stations/master/stations.csv"
 
     # List of keywords to ignore while searching
-    IGNORE_KEYWORDS = ["ST"]
+    IGNORE_KEYWORDS = ["ST", "SAINT", "GARE", "SNCF"]
     # Initialize a new Station search with the specified query
     #
     #   search = Gares::Search.new("Aix")
@@ -15,8 +15,12 @@ module Gares
     # Gares::Search is lazy loaded, meaning that unless you access the +stations+
     # attribute, no remomte query is made.
     #
-    def initialize(query)
+    # Search can by done via the :name or :sncf_id field given in parameter.
+    # Defaults to the :name field.
+    def initialize(query, field = :name)
+      fail UnsupportedIndex unless %w(name sncf_id).include?(field.to_s)
       @query = query
+      @by = field
     end
 
     # Returns an array of Gares::Station objects in order to easily search result yielded.
@@ -27,24 +31,42 @@ module Gares
 
     private
 
-    def document
-      @document ||= Hashie::Mash.new(JSON.load(Gares::Search.query))
+    def result
+      @raw_result ||= case @by
+      when :name
+        keywords = @query.to_ascii.split(/[ -]/).select { |keyword| !IGNORE_KEYWORDS.include?(keyword.upcase) }
+        regexp_query = keywords.join(".*")
+        self.class.data(@by).select do |index, v|
+          index && index =~ /#{regexp_query}/i
+        end
+      when :sncf_id
+        { @query.downcase => self.class.data(@by)[@query.downcase] }
+      end
+
+      @result ||= @raw_result.map { |_, raw_station| Gares::Station.new(raw_station) }
     end
 
-    def result
-      keywords = @query.split(" ").select { |keyword| !IGNORE_KEYWORDS.include?(keyword) }
-      @result ||= document.results.collection1.map(&:station).select do |station|
-        station.name.to_ascii =~ /#{keywords.join(".*")}/i
+    # Read stations.csv file into memory
+    # @param index either :name or :sncf_id
+    # @return [Hash<String, Hash>] list of stations indexed in a Hash
+    def self.data(index)
+      @@raw_data ||= SmarterCSV.process(open(GARES_LIST_URL), col_sep: ";")
+      case index
+      when :name
+        @@data_by_name ||= index_data(@@raw_data, index)
+      when :sncf_id
+        @@data_by_sncf_id ||= index_data(@@raw_data, index)
       end
     end
 
-    def self.query
-      open(GARES_LIST_URL)
+    def self.index_data(data, by)
+      data.map do |raw_station|
+        [raw_station[by].to_ascii.downcase, raw_station] if raw_station[by] && raw_station[:uic]
+      end.compact.to_h
     end
 
     def parse_station
-      station = result.first
-      [Gares::Station.new(station.slug, station.name)]
+      [result.first]
     end
 
     def exact_match?

data/lib/gares/services.rb

@@ -1,4 +1,5 @@
 module Gares
+  # @deprecated
   class Services < Base
 
     def all
@@ -9,8 +10,7 @@ module Gares
     private
 
     def document
-      @document ||= Nokogiri::HTML(Gares::Station.find_by_slug(
-        @slug, :"services-en-gare/service/"))
+      @document ||= Nokogiri::HTML(self.class.external_data(sncf_id, :"services-en-gare/service/"))
     end
   end
 end

data/lib/gares/station_list.rb

@@ -4,9 +4,7 @@ module Gares
     private
 
     def parse_stations
-      result.compact.uniq.map do |station|
-        Gares::Station.new(station.slug, station.name)
-      end
+      result.compact.uniq
     end
   end # StationList
 end # Gares

data/lib/gares/train.rb

@@ -42,19 +42,44 @@ module Gares
 
     private
 
+    def itinerary_available?
+      document.css('ul.itinerary-details').size > 0
+    end
+
     # Returns a new Nokogiri document for parsing.
     def document
-      @document ||= Nokogiri::HTML(self.class.request_sncf(@number, @date))
+      if !@document
+        @document = Nokogiri::HTML(self.class.request_sncf(@number, @date))
+        if !itinerary_available?
+          @document = Nokogiri::HTML(self.class.request_sncf_itinerary(0))
+        end
+      end
+      if @document.at('#no_results')
+        fail TrainNotFound, @document.at('#no_results b').inner_html
+      end
+      @document
     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(";")
+      @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)
+      req.add_field("Cookie", @cookies)
+      Net::HTTP.new(uri.host, uri.port).start { |http| http.request(req) }.body
+    end
+
+    def self.request_sncf_itinerary(index)
+      uri = URI.parse("http://www.sncf.com/sncf/train/displayDetailTrain?idItineraire=#{index}")
+      req = Net::HTTP::Get.new(uri)
+      req.add_field("Cookie", @cookies) if @cookies
+      Net::HTTP.new(uri.host, uri.port).start { |http| http.request(req) }.body
+
+      uri = URI.parse("http://www.sncf.com/en/horaires-info-trafic/train/resultats?#{index}")
+      req = Net::HTTP::Get.new(uri)
+      req.add_field("Cookie", @cookies) if @cookies
       Net::HTTP.new(uri.host, uri.port).start { |http| http.request(req) }.body
     end
 

data/lib/gares/train_stop.rb

@@ -74,9 +74,22 @@ module Gares
       raw_name = node.at('td.stations div.station').inner_html.strip
       stations = Station.search(raw_name)
       @station = if stations.size > 1
+        raw_name.gsub!(/[ -]/, '.*')
+        exact_match  = /^#{raw_name}$/i
+        begin_match  = /^#{raw_name}/i
+        end_match    = /#{raw_name}$/
+        middle_match = /#{raw_name}/i
         stations.find do |station|
-          name = /(^#{raw_name}$|^#{raw_name} | #{raw_name}$| #{raw_name} )/i
-          station.name.match(name)
+          station.name.to_ascii.match(exact_match)
+        end ||
+        stations.find do |station|
+          station.name.to_ascii.match(begin_match)
+        end ||
+        stations.find do |station|
+          station.name.to_ascii.match(end_match)
+        end ||
+        stations.find do |station|
+          station.name.to_ascii.match(middle_match)
         end
       else
         stations.first

data/lib/gares/version.rb

@@ -1,3 +1,3 @@
 module Gares
-  VERSION = '1.1.1'
+  VERSION = '2.0.0-pre'
 end

data/lib/gares.rb

@@ -6,9 +6,11 @@ require 'rubygems'
 require 'nokogiri'
 require 'json'
 require 'hashie'
+require 'smarter_csv'
 require 'unidecoder'
 require 'httparty'
 
+require 'gares/errors'
 require 'gares/base'
 require 'gares/station'
 require 'gares/station_list'