transilien_microservices 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d9ce413dfd4786a986a8fe3226cef622df78e9f9
-  data.tar.gz: 3b672ac27a336f667d79fa1f73543d9012a84bb6
+  metadata.gz: 4e8cfb26dac1858fbf4b4c7ebac75daadda2c7cb
+  data.tar.gz: 4cadc46e4741ee1a22f7f367aae37588f6f285f3
 SHA512:
-  metadata.gz: 0c673cb9635c16509f58f0829002111cfdf40302ff62d0252f5f27dac5ec6d393f171074e1d16096224d20cedcb7d9460608689fe5fd0e8265d594d6a8258253
-  data.tar.gz: 70b3ebb0084748339843dd5b64fd33b4cec56d5cf1c5f37be79a2b7062171b3b0b81d5104f63a6804641914ca1e829e4c9b4eba7fdc471e1546e37a34ab0be73
+  metadata.gz: ace09e85bfcce2c6ed9fbd9a590ff119ad00c178fe008f934175a0f196b1cfc555da411eea90f4b0f62922aae559ec13c5dc40358465168e84ef3c906e2a25b5
+  data.tar.gz: 5109350653b20ad975bace3d805855f3ab468b480f1dcee6c85fe83b1b181e9bbe537e72120192cdd2c8d20a788a4bfb588f2cc99b63577aa702db55c89c5c84

data/README.md

@@ -2,79 +2,101 @@
 
 Ruby implementation of SNCF Transilien Microservices.
 
-Here the original service documentation: http://test.data-sncf.com/index.php/transilien.html/api.22.22-micro-services.html
+Here is the original service documentation: http://test.data-sncf.com/index.php/transilien.html/api.22.22-micro-services.html
 
-These services let you know the theoric offer on Transilien service.
+These services let you know the theoric train times on the Transilien service.
 
-Disclamer: The gem only intend to implements the API. I'll create a "easy" wrapper to access these data in a convenient way very soon.
+Disclamer: The gem only intends to implements the API. I'll create a "easy" wrapper to access these data in a convenient way very soon.
 
 ## Installation
 
-Gem developped with ruby 2.0.0, should work with ruby 1.9.3
+Gem developped with ruby 2.0.0, should work with ruby 1.9.3.
 
 Add this line to your application's Gemfile:
 
-    gem 'transilien_microservices'
+```ruby
+gem 'transilien_microservices'
+````
 
 And then execute:
 
-    $ bundle
+```sh
+$ bundle
+```
 
 Or install it yourself as:
 
-    $ gem install transilien_microservices
+```sh
+$ gem install transilien_microservices
+```
 
 ## Usage
 
-The best way to access data is certainly querying through StopArea: start by fetching them.
+The best way to access data is certainly querying through `StopArea`. Start by fetching them.
 
-    stop_areas = Transilien::StopArea.find
+```ruby
+stop_areas = Transilien::StopArea.find
+```
 
-Every Transilien "main" objects have the same attributes:
+Every Transilien "main" object has the same attributes:
 
-    stop_areas.first.inspect
-    => "#<Transilien::StopArea external_code=\"DUA8738221\" name=\"LA DEFENSE GRANDE ARCHE\" >"
+```ruby
+stop_areas.first.inspect
+=> "#<Transilien::StopArea external_code=\"DUA8738221\" name=\"LA DEFENSE GRANDE ARCHE\" >"
+```
 
-* "name" is a "public" name. Can't be filtered directly through Transilien API
-* "external_code" is the true "key" to use in queries.
+* `name` is a "public" name. Can't be filtered directly through Transilien API
+* `external_code` is the true "key" to use in queries.
 
-They have in bonus #payload method which return the node used to build this object.
+As a bonus method, `#payload` returns the node used to build this object.
 
-If you want to find a commercial line that stops by two StopArea, say: Val d'Argenteuil (DUA8738179) and Paris Saint Lazare (DUA8738400) you can query this way:
+If you want to find a commercial line that stops by two `StopArea`, say: Val d'Argenteuil (DUA8738179) and Paris Saint Lazare (DUA8738400) you can query them this way:
 
-    val_stlaz_lines = Transilien::Line.find(stop_area_external_code: {and: ['DUA8738400', 'DUA8738179']})
+```ruby
+val_stlaz_lines = Transilien::Line.find(stop_area_external_code: {and: ['DUA8738400', 'DUA8738179']})
+```
 
-Ok, but to tell the truth, I doubt that you don't bother about the way: you're going from Val to StLaz, not the inverse, so precise it:
+Ok, but you will probably care about the direction you're taking. You're going from Val to StLaz, not the inverse, so precise it:
 
-    val_to_stlaz_lines = Transilien::Line.find(destination_external_code: 'DUA8738400', stop_area_external_code: 'DUA8738179')
+```ruby
+val_to_stlaz_lines = Transilien::Line.find(destination_external_code: 'DUA8738400', stop_area_external_code: 'DUA8738179')
+```
 
-You get an Array of Transilien::Line fullfilling your wish.
+You get an `Array` of `Transilien::Line` that meet your wish.
 
-Staying on that example, we'll stay with the "biggest" Line of the set: "Mantes la Jolie => Gare St Lazare via CONFLANS" DUA800854044
+Staying on this example, we'll stay with the "biggest" Line of the set: "Mantes la Jolie => Gare St Lazare via CONFLANS" DUA800854044
 To get ALL the stops served by this Line:
 
-    Transilien::StopArea.find(line_external_code: 'DUA800854044')
+```ruby
+Transilien::StopArea.find(line_external_code: 'DUA800854044')
+```
 
-Ok, that's fun. But Transilien is all about train and departures. What are the trains going from Val d’Argenteuil to Paris Saint Lazare? Transilien::VehicleJourney is all about it
+Ok, that's fun. But Transilien is all about train and departures. What are the trains going from Val d’Argenteuil to Paris Saint Lazare? `Transilien::VehicleJourney` is all about it:
 
-    instant = Time.new
-    start_time = Time.local(instant.year, instant.month, instant.day, 17, 30)
-    end_time = Time.local(instant.year, instant.month, instant.day, 18, 45)
-    Transilien::VehicleJourney.find stop_area_external_code: {and: ['DUA8738400', 'DUA8738179'], date: Transilien.date(instant), start_time: Transilien.time(start_time), end_time: Transilien.time(end_time) }
+```ruby
+instant = Time.new
+start_time = Time.local(instant.year, instant.month, instant.day, 17, 30)
+end_time = Time.local(instant.year, instant.month, instant.day, 18, 45)
+Transilien::VehicleJourney.find stop_area_external_code: {and: ['DUA8738400', 'DUA8738179'], date: Transilien.date(instant), start_time: Transilien.time(start_time), end_time: Transilien.time(end_time) }
+```
 
-Yeah! Better. You still have a problem: this give you all the journey starting between start_time and end_time on date instant, but don't give a fuck to your way.
+Yeah! Better. You still have a problem: this gives you all the journeys starting between `start_time` and `end_time`, but doesnt't give a fuck about your direction.
 
-Ready to forget what you just learnt? Go back a little bit before this point: a Line instance always have at least two Route (one way, the other). And its finder understand a convenient param: CheckOrder. If set to 1, and 2 stops are given, Route returned will honor the given way by stops order:
+Ready to forget what you just learnt? Go back a little bit before this point: a `Line` instance always has at least two `Route` (one way and the other). And its finder accepts a convenient parameter: `check_order`. If set to `1` or `2` stops, `Route` returned will honor the given way by stops order:
 
-    routes_stlaz_val = Transilien::Route.find(stop_area_external_code: {and:['DUA8738400','DUA8738179']}, check_order: 1)
+```ruby
+routes_stlaz_val = Transilien::Route.find(stop_area_external_code: {and:['DUA8738400','DUA8738179']}, check_order: 1)
+```
 
-Here you have only Route stoping by DUA8738400 then DUA8738179, not the inverse.
+Here you only get `Route`s stoping by DUA8738400 then DUA8738179, not the inverse.
 
-Now it'll be easy to get VehicleJourney matching your needs. The same VehicleJourney will become:
+Now it'll be easy to get a `VehicleJourney` matching your needs. The same `VehicleJourney` will become:
 
-    Transilien::VehicleJourney.find route_external_code: routes_stlaz_val.map(&:external_code), date: Transilien.date(instant), start_time: Transilien.time(start_time), end_time: Transilien.time(end_time)
+```
+Transilien::VehicleJourney.find route_external_code: routes_stlaz_val.map(&:external_code), date: Transilien.date(instant), start_time: Transilien.time(start_time), end_time: Transilien.time(end_time)
+```
 
-Easier, isn't it? Now take every Stop and keep only your matching StopArea: you'll get your hours of departures and arrivals :)
+Easier, isn't it? Now take every `Stop` and keep only your matching `StopArea`: you'll get your hours of departures and arrivals :)
 
 ## Contributing
 
@@ -86,6 +108,8 @@ Easier, isn't it? Now take every Stop and keep only your matching StopArea: you'
 
 NOTA: you're a beginner gem dev? This command may help you: 
 
-    pry -Ilib -rtransilien_microservices 
+```sh
+$ pry -Ilib -rtransilien_microservices 
+```
 
-(you can replace pry with irb if you're not a good person…)
+(You can replace `pry` with `irb` if you're not that kind of person…)

data/lib/transilien/version.rb

@@ -1,3 +1,3 @@
 module Transilien
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/lib/transilien_microservices.rb

@@ -1,16 +1,16 @@
-require "./lib/transilien/version.rb"
-require "./lib/transilien/micro_service.rb"
-require "./lib/transilien/time.rb"
-require "./lib/transilien/network.rb"
-require "./lib/transilien/mode_type.rb"
-require "./lib/transilien/line.rb"
-require "./lib/transilien/route.rb"
-require "./lib/transilien/stop_point.rb"
-require "./lib/transilien/stop_area.rb"
-require "./lib/transilien/vehicle_journey.rb"
-require "./lib/transilien/mode.rb"
-require "./lib/transilien/company.rb"
-require "./lib/transilien/stop.rb"
+require "transilien/version.rb"
+require "transilien/micro_service.rb"
+require "transilien/time.rb"
+require "transilien/network.rb"
+require "transilien/mode_type.rb"
+require "transilien/line.rb"
+require "transilien/route.rb"
+require "transilien/stop_point.rb"
+require "transilien/stop_area.rb"
+require "transilien/vehicle_journey.rb"
+require "transilien/mode.rb"
+require "transilien/company.rb"
+require "transilien/stop.rb"
 
 module Transilien
   def self.date(time)

data/spec/vehicle_journey_spec.rb

@@ -1,9 +1,5 @@
 require 'spec_helper'
 
-raw_payload = %(
-
-)
-
 describe Transilien::MicroService do
   it 'should get a set of Stop' do
     # This payload was generated from

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: transilien_microservices
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Thomas Lecavelier
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-29 00:00:00.000000000 Z
+date: 2013-11-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday