gares 1.1.1 → 2.0.0.pre.pre

data/spec/gares/sales_spec.rb

@@ -1,8 +1,10 @@
+require 'spec_helper'
+
 describe Gares::Sales do
 
   context 'with a valid station' do
 
-    subject(:sales) { Gares::Sales.new('frqxb') }
+    subject(:sales) { Gares::Sales.new(sncf_id: 'frqxb') }
 
     it { expect(sales.has_borne?).to be(true) }
 

data/spec/gares/search_spec.rb

@@ -1,62 +1,127 @@
 require 'spec_helper'
 
 describe Gares::Search do
-  context 'with multiple search results' do
-    before(:each) do
-      @search = Gares::Search.new('Aix')
-    end
+  describe "search by station name" do
+    context 'with multiple search results' do
+      subject do
+        Gares::Search.new('étienne')
+      end
 
-    it 'should remember the query' do
-      expect(@search.query).to eql('Aix')
-    end
+      it 'should remember the query' do
+        expect(subject.query).to eql('étienne')
+      end
 
-    it 'should find 5 results' do
-      expect(@search.stations.size).to eql(7)
-    end
+      it 'should find 28 results' do
+        expect(subject.stations.size).to eql(12)
+      end
 
-    it 'should return Gares::Station objects only' do
-      expect(@search.stations).to all(be_an(Gares::Station))
-    end
+      it 'should return Gares::Station objects only' do
+        expect(subject.stations).to all(be_an(Gares::Station))
+      end
+
+      it 'should not return gares with no name' do
+        subject.stations.each { |gare| expect(gare.name).to_not be_blank }
+      end
 
-    it 'should not return gares with no name' do
-      @search.stations.each { |gare| expect(gare.name).to_not be_blank }
+      it 'should return only the name of the result' do
+        expect(subject.stations.first.name).to eql('St-Étienne-du-Rouvray')
+      end
     end
 
-    it 'should return only the name of the result' do
-      expect(@search.stations.first.name).to eql('Aix en Provence')
+    describe 'with name that has utf-8 characters' do
+      subject { Gares::Station.search('Saone').first }
+
+      it 'should give the proper name' do
+        expect(subject.name).to eql('Port-sur-Saône')
+      end
     end
-  end
 
-  context 'with an exact match' do
-    it 'should not raise an exception' do
-      expect do
-        @search = Gares::Search.new('Paris Austerlitz').stations
-      end.not_to raise_error
+    context 'with an exact match' do
+      subject { Gares::Search.new('Paris Austerlitz') }
+
+      it 'should not raise an exception' do
+        expect do
+          subject.stations
+        end.not_to raise_error
+      end
+
+      it 'should return the gare sncf_id.downcase correctly' do
+        expect(subject.stations.first.sncf_id.downcase).to eql('frpaz')
+      end
     end
 
-    it 'should return the gare slug correctly' do
-      @search = Gares::Search.new('Paris Austerlitz')
-      expect(@search.stations.first.slug).to eql('frpaz')
+    context 'with a fuzzy match' do
+      subject { Gares::Search.new('CULMONT CHALINDREY') }
+      it 'should not raise an exception' do
+        expect do
+          subject.stations
+        end.not_to raise_error
+      end
+
+      it 'should return the gare sncf_id.downcase correctly' do
+        expect(subject.stations.first.sncf_id.downcase).to eql('frccy')
+      end
+
+      context 'with a "st" searching for "saint"' do
+        it 'should return the gare sncf_id.downcase correctly' do
+          subject = Gares::Search.new('ST ETIENNE CHATEAUCREUX')
+          expect(subject.stations.first.sncf_id.downcase).to eql('frhhd')
+        end
+      end
+
+      context 'with a multi-terms search' do
+        it 'should return the gare sncf_id.downcase correctly' do
+          subject = Gares::Search.new('BAR SUR AUBE')
+          expect(subject.stations.first.sncf_id.downcase).to eql('frapx')
+        end
+
+        it 'should return the gare sncf_id.downcase correctly' do
+          subject = Gares::Search.new('NOGENT SUR SEINE')
+          expect(subject.stations.first.sncf_id.downcase).to eql('frapm')
+        end
+
+        it 'should return the gare sncf_id.downcase correctly' do
+          subject = Gares::Station.search('MONTELIMAR GARE SNCF')
+          expect(subject.first.sncf_id.downcase).to eql('frxmk')
+        end
+
+        it 'should return the gare sncf_id.downcase correctly' do
+          subject = Gares::Station.search('MONTPELLIER SAINT-ROCH')
+          expect(subject.first.sncf_id.downcase).to eql('frmpl')
+        end
+
+        it 'should return the gare sncf_id.downcase correctly' do
+          subject = Gares::Station.search('CHALON SUR SAONE')
+          expect(subject.first.sncf_id.downcase).to eql('frxcd')
+        end
+
+      end
     end
   end
 
-  context 'with a fuzzy match' do
-    it 'should not raise an exception' do
-      expect do
-        @search = Gares::Search.new('CULMONT CHALINDREY').stations
-      end.not_to raise_error
-    end
+  describe "search by sncf_id" do
+    context 'with an exact match' do
+      subject { Gares::Search.new('frlpd', :sncf_id) }
 
-    it 'should return the gare slug correctly' do
-      @search = Gares::Search.new('CULMONT CHALINDREY')
-      expect(@search.stations.first.slug).to eql('frccy')
-    end
+      it 'should not raise an exception' do
+        expect do
+          subject.stations
+        end.not_to raise_error
+      end
 
-    context 'with a "st" searching for "saint"' do
-      it 'should return the gare slug correctly' do
-        @search = Gares::Search.new('ST ETIENNE CHATEAUCREUX')
-        expect(@search.stations.first.slug).to eql('frhhd')
+      it 'returns the good station' do
+        expect(subject.stations.first.sncf_id.downcase).to eql('frlpd')
+        expect(subject.stations.first.name).to eql('Lyon Part-Dieu')
       end
     end
   end
+
+  describe "search by unsupported field" do
+    it 'raises an exception' do
+      expect do
+        Gares::Search.new('Paris Austerlitz', :foo)
+      end.to raise_error
+    end
+  end
+
 end

data/spec/gares/station_spec.rb

@@ -0,0 +1,64 @@
+require 'spec_helper'
+
+# This test uses "Lyon Part-Dieu" as a testing sample:
+#
+#     http://www.gares-en-mouvement.com/fr/frlpd/votre-gare/
+#
+describe Gares::Station do
+
+  describe 'valid gare' do
+
+    subject do
+      # Get gare de Lyon Part-Dieu
+      Gares::Station.search_by_sncf_id('frlpd').first
+    end
+
+    it 'should find the name' do
+      expect(subject.name).to eql('Lyon Part-Dieu')
+    end
+
+    it 'should find the sncf_id' do
+      expect(subject.sncf_id).to eql('FRLPD')
+      # Still supports deprecated fields
+      expect(subject.slug).to eql(subject.sncf_id.downcase)
+    end
+
+    it 'should find the geolocation coordinates' do
+      expect(subject.latitude).to eql(45.760568)
+      expect(subject.longitude).to eql(4.859991)
+      # Still supports deprecated fields
+      expect(subject.lat).to eql(subject.latitude)
+      expect(subject.long).to eql(subject.longitude)
+    end
+
+    it 'should have opening hours' do
+      expect(subject.horaires.first).to eql('du lundi au dimanche de 04:50 à 00:45')
+    end
+
+    it 'should have a list of services' do
+      expect(subject.services).to be_an(Array)
+      expect(subject.services.first).to_not be_blank
+    end
+
+    it 'should have a list of sales services' do
+      expect(subject.sales).to be_an(Array)
+      expect(subject.sales.first).to_not be_blank
+    end
+
+    context 'Station of Agde' do
+      subject do
+        # Get gare de Agde
+        Gares::Station.search_by_sncf_id('frxag').first
+      end
+
+      describe 'a gare without wifi nor defibrillator' do
+        it { expect(subject.wifi?).to be(false) }
+        it { expect(subject.defibrillator?).to be(false) }
+      end
+
+      describe 'a gare with no sales services' do
+        it { expect(subject.has_borne?).to be(false) }
+      end
+    end
+  end
+end

data/spec/gares/train_spec.rb

@@ -3,6 +3,27 @@
 require 'spec_helper'
 
 describe Gares::Train do
+
+  subject do
+    Gares::Train.new(train_number, date)
+  end
+
+  describe 'no results' do
+
+    let (:train_number) { 12345 }
+    let (:date) { Time.parse("2015-04-25") }
+
+    before do
+      # See tasks/fixtures.rake to change dataset
+      fake_response_for_train(train_number)
+    end
+
+    it "raises an error for any method called on it" do
+      expect { subject.departure }.to raise_error
+    end
+
+  end
+
   describe 'a delayed train' do
 
     let (:train_number) { 17709 }
@@ -24,8 +45,8 @@ describe Gares::Train do
     it "has a departure station" do
       expect(subject.departure.departure_date).to eq(Time.parse('2015-04-25 09:18:00'))
       expect(subject.departure.real_departure_date).to eq(Time.parse('2015-04-25 09:28:00'))
-      expect(subject.departure.station.name).to eq('Lyon Part Dieu')
-      expect(subject.departure.station.lat).to eql(45.760281)
+      expect(subject.departure.station.name).to eq('Lyon Part-Dieu')
+      expect(subject.departure.station.latitude).to eql(45.760568)
       expect(subject.departure.platform).to eq('--')
 
       expect(subject.departure.delayed?).to be(true)
@@ -35,17 +56,17 @@ describe Gares::Train do
       expect(subject.stops.size).to eq(12)
       expect(subject.stops.first.station.name).to eq('Vienne')
 
-      expect(subject.stops[2].station.name).to eq('Tain l\'Hermitage Tournon')
+      expect(subject.stops[2].station.name).to eq('Tain')
       expect(subject.stops[2].platform).to eq('B')
       expect(subject.stops[2].minutes_of_delay).to eq(10)
 
-      expect(subject.stops.last.station.name).to eq('Vitrolles Aéroport Marseille Provence')
+      expect(subject.stops.last.station.name).to eq('Vitrolles Aéroport Marseille-Provence TER')
     end
 
     it "has a arrival station" do
       expect(subject.arrival.arrival_date).to eq(Time.parse('2015-04-25 12:50:00'))
       expect(subject.arrival.real_arrival_date).to eq(Time.parse('2015-04-25 13:00:00'))
-      expect(subject.arrival.station.name).to eq('Marseille St Charles')
+      expect(subject.arrival.station.name).to eq('Marseille St-Charles')
       expect(subject.arrival.platform).to eq('--')
     end
   end
@@ -71,15 +92,15 @@ describe Gares::Train do
     it "has a departure station" do
       expect(subject.departure.departure_date).to eq(Time.parse('2015-04-25 06:42:00'))
       expect(subject.departure.real_departure_date).to be_nil
-      expect(subject.departure.station.name).to eq('Paris Est')
+      expect(subject.departure.station.name).to eq('Paris-Gare-de-l’Est')
       expect(subject.departure.platform).to eq('--')
 
       expect(subject.departure.delayed?).to be(false)
     end
 
-    it "has stops" do
+    it "has stops", focus: true do
       expect(subject.stops.size).to eq(7)
-      expect(subject.stops.first.station.name).to eq('Nogent sur Seine')
+      expect(subject.stops.first.station.name).to eq('Nogent-sur-Seine')
 
       expect(subject.stops[2].station.name).to eq('Troyes')
 
@@ -89,8 +110,28 @@ describe Gares::Train do
     it "has a arrival station" do
       expect(subject.arrival.arrival_date).to eq(Time.parse('2015-04-25 09:45:00'))
       expect(subject.arrival.real_arrival_date).to be_nil
-      expect(subject.arrival.station.name).to eq('Culmont - Chalindrey')
+      expect(subject.arrival.station.name).to eq('Culmont-Chalindrey')
       expect(subject.arrival.platform).to eq('--')
     end
   end
+
+  describe 'a multi-itinerary train' do
+    let (:train_number) { 6815 }
+    let (:date) { Time.parse("2015-04-25") }
+
+    before do
+      # See tasks/fixtures.rake to change dataset
+      fake_response_for_train(train_number)
+    end
+
+    subject do
+      Gares::Train.new(train_number, date)
+    end
+
+    it "selects always the first itinerary", focus: true do
+      expect(subject.departure.station.name).to eq("Dijon Ville")
+      expect(subject.stops.first.station.name).to eq("Chalon-sur-Saône")
+      expect(subject.arrival.station.name).to eq("Nice Ville")
+    end
+  end
 end

data/spec/spec_helper.rb

@@ -33,7 +33,7 @@ GARES_SAMPLES = {
   'http://www.gares-en-mouvement.com/fr/frxag/votre-gare' => 'frxag',
   'http://www.gares-en-mouvement.com/fr/frlpd/votre-gare' => 'frlpd',
   'http://www.gares-en-mouvement.com/fr/frhco/votre-gare' => 'frhco',
-  'https://www.kimonolabs.com/api/7jys32dy?apikey=lsOO4tNm78cH9JxqWg9gAk9l4nYaou9j&kimmodify=1' => 'search'
+  'https://raw.githubusercontent.com/capitainetrain/stations/master/stations.csv' => 'stations.csv'
 }
 
 # Sample fixtures for Trains
@@ -41,7 +41,12 @@ TRAINS_SAMPLES = [
   { 17709 => 'train-17709' },
   { 11641 => 'train-11641' },
   { 17495 => 'train-17495' },
-  { 6815  => 'train-6815'  }, # Multi-itinerary
+  { 12345 => 'train-12345' },
+  { 6815  => 'train-6815'  }, # Multi-itinerary see MULTI_TRAINS_SAMPLES
+]
+
+MULTI_TRAINS_SAMPLES = [
+  { 6815  => ['train-6815-0', 'train-6815-1'] },
 ]
 
 unless ENV['LIVE_TEST']
@@ -63,10 +68,18 @@ def fake_response_for_train(number)
   unless ENV['LIVE_TEST']
     begin
       response = TRAINS_SAMPLES.find { |sample| sample.keys.first == number }.values.first
+      multi_responses = MULTI_TRAINS_SAMPLES.find { |sample| sample.keys.first == number }
+      multi_responses = multi_responses.nil? ? [] : multi_responses.values.first
       sncf_result_url = 'http://www.sncf.com/en/horaires-info-trafic/train/resultats'
       FakeWeb.register_uri(:get, sncf_result_url, response: read_fixture("get-#{response}"))
       sncf_post_url = 'http://www.sncf.com/sncf/train'
       FakeWeb.register_uri(:post, sncf_post_url, response: read_fixture("post-#{response}"))
+      multi_responses.each_with_index do |multi_response, idx|
+        sncf_get_multi_url = "http://www.sncf.com/sncf/train/displayDetailTrain?idItineraire=#{idx}"
+        FakeWeb.register_uri(:get, sncf_get_multi_url, response: read_fixture("get-#{multi_response}"))
+        sncf_get_data_url = "http://www.sncf.com/en/horaires-info-trafic/train/resultats?#{idx}"
+        FakeWeb.register_uri(:get, sncf_get_data_url, response: read_fixture("get-#{multi_response}-data"))
+      end
     rescue LoadError
       puts 'Could not load FakeWeb, these tests will hit gares-en-mouvement.com'
       puts 'You can run `gem install fakeweb` to stub out the responses.'

data/tasks/fixtures.rake

@@ -34,6 +34,24 @@ namespace :fixtures do
       File.open(File.expand_path(File.dirname(__FILE__) + "/../spec/fixtures/#{get_fixture}"), 'w') do |f|
         f.write(page)
       end
+
+      multi_train_sample = MULTI_TRAINS_SAMPLES.find { |one| one.keys.first == train_number } || {"" => []}
+      multi_train_sample.values.first.each_with_index do |fixture, idx|
+        get_fixture = "get-#{fixture}"
+        get_fixture_data = "#{get_fixture}-data"
+        page = `curl -is 'http://www.sncf.com/sncf/train/displayDetailTrain?idItineraire=#{idx}' -H 'Cookie: #{cookies.join(";")}'`
+
+        File.open(File.expand_path(File.dirname(__FILE__) + "/../spec/fixtures/#{get_fixture}"), 'w') do |f|
+          f.write(page)
+        end
+
+        page = `curl -is 'http://www.sncf.com/en/horaires-info-trafic/train/resultats?#{idx}' -H 'Cookie: #{cookies.join(";")}'`
+
+        File.open(File.expand_path(File.dirname(__FILE__) + "/../spec/fixtures/#{get_fixture_data}"), 'w') do |f|
+          f.write(page)
+        end
+
+      end
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gares
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 2.0.0.pre.pre
 platform: ruby
 authors:
 - Paul Bonaud
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-25 00:00:00.000000000 Z
+date: 2015-05-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -38,6 +38,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: smarter_csv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: unidecoder
   requirement: !ruby/object:Gem::Requirement
@@ -198,6 +212,7 @@ files:
 - gares.gemspec
 - lib/gares.rb
 - lib/gares/base.rb
+- lib/gares/errors.rb
 - lib/gares/sales.rb
 - lib/gares/search.rb
 - lib/gares/services.rb
@@ -217,17 +232,24 @@ files:
 - spec/fixtures/frqxb-services-vente
 - spec/fixtures/frxag
 - spec/fixtures/get-train-11641
+- spec/fixtures/get-train-12345
 - spec/fixtures/get-train-17495
 - spec/fixtures/get-train-17709
 - spec/fixtures/get-train-6815
+- spec/fixtures/get-train-6815-0
+- spec/fixtures/get-train-6815-0-data
+- spec/fixtures/get-train-6815-1
+- spec/fixtures/get-train-6815-1-data
 - spec/fixtures/post-train-11641
+- spec/fixtures/post-train-12345
 - spec/fixtures/post-train-17495
 - spec/fixtures/post-train-17709
 - spec/fixtures/post-train-6815
 - spec/fixtures/search
-- spec/gares/gare_spec.rb
+- spec/fixtures/stations.csv
 - spec/gares/sales_spec.rb
 - spec/gares/search_spec.rb
+- spec/gares/station_spec.rb
 - spec/gares/string_extensions_spec.rb
 - spec/gares/train_spec.rb
 - spec/spec_helper.rb
@@ -248,9 +270,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: gares
 rubygems_version: 2.2.0

data/spec/gares/gare_spec.rb

@@ -1,82 +0,0 @@
-# encoding: utf-8
-
-require 'spec_helper'
-
-# This test uses "Lyon Part-Dieu" as a testing sample:
-#
-#     http://www.gares-en-mouvement.com/fr/frlpd/votre-gare/
-#
-describe Gares::Station do
-
-  describe 'valid gare' do
-
-    before(:each) do
-      # Get gare de Lyon Part-Dieu
-      @gare = Gares::Station.new('frlpd')
-    end
-
-    it 'should find the name' do
-      name = @gare.name
-
-      expect(name).to eql('Lyon Part Dieu')
-    end
-
-    it 'should find the geolocation coordinates' do
-      lat = @gare.lat
-      long = @gare.long
-
-      expect(lat).to eql(45.760281)
-      expect(long).to eql(4.859801)
-    end
-
-    it 'should have opening hours' do
-      horaires = @gare.horaires
-
-      expect(horaires.first).to eql('du lundi au dimanche de 04:50 à 00:45')
-    end
-
-    it 'should have a list of services' do
-      services = @gare.services
-
-      expect(services).to be_an(Array)
-      expect(services.first).to_not be_blank
-    end
-
-    it 'should have a list of sales services' do
-      sales = @gare.sales
-
-      expect(sales).to be_an(Array)
-      expect(sales.first).to_not be_blank
-    end
-
-    context 'a gare without wifi nor defibrillator' do
-      before(:each) do
-        # Get gare de Agde
-        @gare = Gares::Station.new('frxag')
-      end
-
-      it { expect(@gare.wifi?).to be(false) }
-      it { expect(@gare.defibrillator?).to be(false) }
-    end
-
-    context 'a gare with no sales services' do
-      before(:each) do
-        # Get gare de Agde
-        @gare = Gares::Station.new('frxag')
-      end
-
-      it { expect(@gare.has_borne?).to be(false) }
-    end
-  end
-
-  describe 'with name that has utf-8 characters' do
-    # Belleville sur Sâone
-    before(:each) do
-      @gare = Gares::Station.search('Saone').first
-    end
-
-    it 'should give the proper name' do
-      expect(@gare.name).to eql('Belleville sur Sâone')
-    end
-  end
-end