Skip to content

Latest commit

 

History

History
145 lines (87 loc) · 4.27 KB

README.md

File metadata and controls

145 lines (87 loc) · 4.27 KB
Raw

Gares - A gem to interact with French train Stations

Build Status Gem Version Coverage Status

Description

The Gares gem allows you to easily access publicly available data from gares-sncf.com. It can also retrieve data from sncf.com for live train information. Train station information comes from the public CapitaineTrain database.

Features

Gares currently features the following:

  • Search for a train station by name or sncf_id
  • Retrieve station information such as:
    • Whether it has a self-service ticket machine
    • Next departing / arriving trains with live information (platform numbers, delay)
  • Retrieve a specific train live information given its number and its date

Examples

Station:

g = Gares::Station.find_by_sncf_id("frlpd")

g.name
#=> "Lyon Part-Dieu"

g.has_borne?
#=> true

[g.latitude, g.longitude]
#=> [45.760568, 4.859991]

g.departing_trains.first
#=> #<Gares::Train heure="05:50" num=9852 type="TGV" origdest=#<Gares::Station name="Bruxelles" ...> ...>

g.departing_trains.first.platform
#=> "K"

See the Gares::Base class documentation for all available data on a station.

Searching:

g = Gares::Search.new("Aix")

g.stations.size
#=> 28

# or directly a class method on the Gares::Station object

stations = Gares::Station.search("lyon")
station = stations.last

station.name
#=> "Lyon St-Exupéry TGV"

# or by sncf_id

station = Gares::Station.find_by_sncf_id("frjdq")

station.name
#=> "Lyon St-Exupéry TGV"

Train live information:

train = Gares::Train.new(11641, Time.now)

train.departure.station
#=> #<Gares::Station @name="Paris-Gare-de-l’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 for all available data on a train.

Installation

gem install gares

Or if you want to use it in a project add this to your Gemfile:

gem "gares"

Running Tests

As this gem uses external content from gare-en-mouvement.com and sncf.com, the test suite uses a set of pre-defined fixture files in spec/fixtures. These fixtures are copies of gares-sncf.com and sncf.com pages used in tests.

Run bundle install to install all dependencies, including fakeweb, which will serve the fixture files instead of doing actual requests to gares-sncf.com or sncf.com.

$ bundle install

Next, simple run rake to run the entire test suite.

Running against real data

It's possible to run the test suite directly against gares-sncf.com or sncf.com. This has two disadvantages:

  1. Tests will be slow

  2. Running tests often will probably get you into trouble, see Disclaimer.

    $ LIVE_TEST=true rake

If you want to run against actual data, it's better to just update 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

Neither I, nor any developer who contributed to this project, accept any kind of liability for your use of this library.

gares-sncf.com and sncf.com certainly does not permit use of its data by third parties without their consent.

Using this library for anything other than limited personal use may result in an IP ban to the gares-sncf.com or sncf.com website.

This gem is not endorsed or affiliated with gares-sncf.com, nor SNCF Inc, nor Capitaine Train.

License

Code licensed under MIT-LICENSE

Stations database ODbL LICENSE