sncf 0.2.3 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a026f1bfe24c4ced4665a384074384d182d5517f
-  data.tar.gz: c7aa7f84fe05f301775fffdc25e0a9d72cdb9781
+  metadata.gz: 294f2a61e3f1f7d2200b9f6e79ebadb1876bb9c2
+  data.tar.gz: e04537454ac8128eb48211a2ee00f37ff9e6ace6
 SHA512:
-  metadata.gz: 3cd58abdb81144af7542fbb382897b533efb87c6b521f22e3a03240947e4387fd1544b6fcfe138463f7a4a77139c6b887761974f268904c6fb90183eaa170ff1
-  data.tar.gz: f1be502d88ca5583b585ee9dff93899e895d858a96a3199cc76da123cf68d383b89d1b69f84f142ac79bf63ca296e0f9e80265f7f2d4cfa940c867e73a35e7d7
+  metadata.gz: d1b88782092964e5fce6ebb443c12c30b2f64dfeea34b8c52ec9bba5d3da68a681ccca2cb6d75755cbdc0f4792224be44adf4abb60f220f8b9f3b39a3fd388a8
+  data.tar.gz: fec8027ab3d967f30de57bdbd5ca543ae807af1fe6fd0eea499282d4fdcb57733e9415db493fa3c9d3f2a6dbfac7d4012c5fdbef776f8a95c51139421d8079e5

data/README.md

@@ -1,13 +1,11 @@
 # SNCF Open Data API Ruby wrapper
 
-# This gem in currently in beta, it may contains bugs, do not use in production.
-
-# 1.0.0 release is due to Fri, 03 Jul 2015
-
 [![Gem Version](https://badge.fury.io/rb/sncf.svg)](http://badge.fury.io/rb/sncf)
 
 Ruby gem to use easily the SNCF Open Data API with Ruby.
 
+Current SNCF Open Data API version: `1.0`
+
 API Documentation is available [here](https://data.sncf.com/api)
 
 You don't already have an API KEY ? [Register here!](https://data.sncf.com/api/register)
@@ -30,6 +28,70 @@ Or install it yourself as:
 
 ## Usage
 
+## Fetch train stations
+
+```ruby
+require 'sncf'
+
+# Create your Sncf::ApiClient with your API_KEY
+client = Sncf::ApiClient.new('MY_API_KEY')
+
+client.api_key
+=> 'MY_API_KEY'
+
+# Will returns a parsed model
+response = client.fetch_stations('Lille Europe')
+=> [#<Sncf::Models::Station:0x007fee0cf051c0
+  @administrative_regions=
+   [#<Sncf::Models::AdministrativeRegion:0x007fee0cf05490
+     @coord={"lat"=>"50.630508", "lon"=>"3.070641"},
+     @id="admin:58404extern",
+     @insee="59350",
+     @label="Lille (59000-59800)",
+     @level=8,
+     @name="Lille",
+     @zip_code="59000;59800">],
+  @coord={"lat"=>"50.638861", "lon"=>"3.075774"},
+  @id="stop_area:OCE:SA:87223263",
+  @label="gare de Lille Europe (Lille)",
+  @name="gare de Lille Europe",
+  @quality=80,
+  @timezone="Europe/Paris">]
+
+```
+
+## Fetch journeys by stations name
+
+```ruby
+require 'sncf'
+
+# Create your Sncf::ApiClient with your API_KEY
+client = Sncf::ApiClient.new('MY_API_KEY')
+
+# Without options
+response_without_options = client.fetch_journeys_by_stations('Paris Nord', 'Lille Europe', Time.now)
+=> #<Sncf::ApiResponse:0x007f8b0592abe8
+  @body        = #<HTTP::Response::Body:3fc582c9818c @streaming=true>,
+  @content     = { ... }, # Here is the api response
+  @pagination  = nil,
+  @response    = #<HTTP::Response/1.1 200 OK ...>,
+  @start_page  = 0>
+
+# With options
+response_with_options = client.fetch_journeys_by_stations('Paris Nord', 'Lille Europe', Time.now, { datetime_represents: 'arrival' })
+=> #<Sncf::ApiResponse:0x007f8b0592abe8
+  @body        = #<HTTP::Response::Body:3fc582c9818c @streaming=true>,
+  @content     = { ... }, # Here is the api response
+  @pagination  = nil,
+  @response    = #<HTTP::Response/1.1 200 OK ...>,
+  @start_page  = 0>
+
+```
+
+Available options are available here: [https://data.sncf.com/api/documentation#title.1.6.4.1](https://data.sncf.com/api/documentation#title.1.6.4.1)
+
+## Custom API fetch
+
 ```ruby
 require 'sncf'
 
@@ -39,7 +101,7 @@ client = Sncf::ApiClient.new('MY_API_KEY')
 client.api_key
 => 'MY_API_KEY'
 
-response = req.fetch('coverage')
+response = client.fetch('coverage')
 => #<Sncf::ApiResponse:0x007f8b0592abe8
   @body        = #<HTTP::Response::Body:3fc582c9818c @streaming=true>,
   @content     = { ... }, # Here is the api response
@@ -53,7 +115,7 @@ Available `fetch` parameters and API actions are here [https://data.sncf.com/api
 
 ## Contributing
 
-1. Fork it ( https://github.com/rdlh/sncf/fork )
+1. Fork it ( https://github.com/Libertrip/sncf/fork )
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)

data/lib/sncf/api_client.rb

@@ -52,6 +52,33 @@ module Sncf
       Sncf::Parsers::Stations.new(stations_response).get_stations_list
     end
 
+    def fetch_journeys_by_stations(from, to, time, options = {})
+      raise ArgumentError, "The `from` argument should be a string, example: 'Paris Nord'." if from.to_s == ''
+      raise ArgumentError, "The `to` argument should be a string, example: 'Paris Nord'." if to.to_s == ''
+      raise ArgumentError, "The `time` argument should be Time or DateTime." unless time.is_a?(Time) || time.is_a?(DateTime)
+
+      from_station  = fetch_stations(from).first
+      to_station    = fetch_stations(to).first
+
+      case
+      when from_station.nil?
+        raise ArgumentError, "The '#{from}' station doesn't exist."
+      when to_station.nil?
+        raise ArgumentError, "The '#{to}' station doesn't exist."
+      else
+        fetch_journeys_by_station_ids from_station.id, to_station.id, time, options
+      end
+    end
+
+    def fetch_journeys_by_station_ids(from_station_id, to_station_id, time, options)
+      fetch_options = {
+        from: from_station_id,
+        to: to_station_id,
+        datetime: time.to_datetime.strftime('%Y%m%dT%H%M%S')
+      }.merge(options)
+      fetch('coverage/sncf/journeys', fetch_options)
+    end
+
     protected
 
     def construct_formated_url(path, additional_params)

data/lib/sncf/api_response.rb

@@ -2,7 +2,7 @@ require 'http'
 require 'oj'
 module Sncf
   class ApiResponse
-    attr_reader :response, :body, :content, :pagination, :start_page
+    attr_reader :response, :body, :content, :pagination, :start_page, :query
 
     def initialize(response, query)
       @response = response

data/lib/sncf/parsers/stations.rb

@@ -4,29 +4,31 @@ module Sncf
       def get_stations_list
         stations, administrative_regions = [], []
 
-        @api_response.content['places'].each do |place|
-          if place['embedded_type'] == 'stop_area'
-            place['stop_area']['administrative_regions'].each do |administrative_region|
-              administrative_regions << create_model('AdministrativeRegion', {
-                id: administrative_region['id'],
-                insee: administrative_region['insee'],
-                level: administrative_region['level'],
-                coord: administrative_region['coord'],
-                name: administrative_region['name'],
-                label: administrative_region['label'],
-                zip_code: administrative_region['zip_code']
+        unless @api_response.content['places'].nil?
+          @api_response.content['places'].each do |place|
+            if place['embedded_type'] == 'stop_area'
+              place['stop_area']['administrative_regions'].each do |administrative_region|
+                administrative_regions << create_model('AdministrativeRegion', {
+                  id: administrative_region['id'],
+                  insee: administrative_region['insee'],
+                  level: administrative_region['level'],
+                  coord: administrative_region['coord'],
+                  name: administrative_region['name'],
+                  label: administrative_region['label'],
+                  zip_code: administrative_region['zip_code']
+                })
+              end
+
+              stations << create_model('Station', {
+                id: place['id'],
+                coord: place['stop_area']['coord'],
+                quality: place['quality'],
+                name: place['stop_area']['name'],
+                label: place['stop_area']['label'],
+                timezone: place['stop_area']['timezone'],
+                administrative_regions: administrative_regions
               })
             end
-
-            stations << create_model('Station', {
-              id: place['id'],
-              coord: place['stop_area']['coord'],
-              quality: place['quality'],
-              name: place['stop_area']['name'],
-              label: place['stop_area']['label'],
-              timezone: place['stop_area']['timezone'],
-              administrative_regions: administrative_regions
-            })
           end
         end
 

data/lib/sncf/version.rb

@@ -1,3 +1,3 @@
 module Sncf
-  VERSION = "0.2.3"
+  VERSION = "0.3.0"
 end

data/sncf.gemspec

@@ -9,9 +9,9 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Rémi Delhaye"]
   spec.email         = ["remi@libertrip.com"]
 
-  spec.summary       = %q{SNCF open data API ruby gem}
-  spec.description   = %q{SNCF open source API. Documentation here: https://data.sncf.com/api/documentation }
-  spec.homepage      = "https://github.com/rdlh/sncf"
+  spec.summary       = %q{Open source ruby api client for SNCF Open Data API}
+  spec.description   = %q{Open source ruby api client for SNCF Open Data API. Documentation available here: https://github.com/Libertrip/sncf }
+  spec.homepage      = "https://github.com/Libertrip/sncf"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files`.split("\n").reject { |f| f.match(%r{^(test|spec|features)/}) }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sncf
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.3.0
 platform: ruby
 authors:
 - Rémi Delhaye
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-06-29 00:00:00.000000000 Z
+date: 2015-07-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: http
@@ -136,7 +136,8 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.1'
-description: 'SNCF open source API. Documentation here: https://data.sncf.com/api/documentation '
+description: 'Open source ruby api client for SNCF Open Data API. Documentation available
+  here: https://github.com/Libertrip/sncf '
 email:
 - remi@libertrip.com
 executables: []
@@ -160,7 +161,7 @@ files:
 - lib/sncf/parsers/stations.rb
 - lib/sncf/version.rb
 - sncf.gemspec
-homepage: https://github.com/rdlh/sncf
+homepage: https://github.com/Libertrip/sncf
 licenses:
 - MIT
 metadata: {}
@@ -183,5 +184,5 @@ rubyforge_project:
 rubygems_version: 2.4.6
 signing_key: 
 specification_version: 4
-summary: SNCF open data API ruby gem
+summary: Open source ruby api client for SNCF Open Data API
 test_files: []