transilien_microservices 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4e8cfb26dac1858fbf4b4c7ebac75daadda2c7cb
-  data.tar.gz: 4cadc46e4741ee1a22f7f367aae37588f6f285f3
+  metadata.gz: 275d52cbd0e7cc220846b5a50a1895bd848f88ee
+  data.tar.gz: cd47565c07e423ae3bc9dd40a7c648fd02d92254
 SHA512:
-  metadata.gz: ace09e85bfcce2c6ed9fbd9a590ff119ad00c178fe008f934175a0f196b1cfc555da411eea90f4b0f62922aae559ec13c5dc40358465168e84ef3c906e2a25b5
-  data.tar.gz: 5109350653b20ad975bace3d805855f3ab468b480f1dcee6c85fe83b1b181e9bbe537e72120192cdd2c8d20a788a4bfb588f2cc99b63577aa702db55c89c5c84
+  metadata.gz: 812002b01063d42f0993e3c611277cc72716da3779378abcb2290148565db77650024cbe35980da03da7f82c8158e13366850a978cf51a13cc0f49dd37768842
+  data.tar.gz: 81726f0c943acc405f91e5447cca27d43d2e5f8ed1bc7d6964c4134cbddb7b7786fb91aa04ed60fb3e4dd91912e8e5f1a2cee4bd0ca06f17f2a78c96201108f7

data/CHANGELOG

@@ -0,0 +1,10 @@
+0.0.3
+  * Bug fix: Transilien::Time#name now works
+  * New : Transilien::Time#time convert instance into ruby Time instance
+  * Try to start documentation, Yard compatible
+
+0.0.2
+  * Fix require path to ease gem usage
+
+0.0.1
+  * Initial release. Just work

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    transilien_microservices (0.0.1)
+    transilien_microservices (0.0.3)
       faraday (>= 0.8.4)
       nokogiri (>= 1.5.5)
 
@@ -12,8 +12,8 @@ GEM
       timers (~> 1.1.0)
     coderay (1.0.9)
     diff-lcs (1.1.3)
-    faraday (0.8.4)
-      multipart-post (~> 1.1)
+    faraday (0.8.8)
+      multipart-post (~> 1.2.0)
     ffi (1.9.0)
     formatador (0.2.4)
     guard (2.1.1)
@@ -31,8 +31,10 @@ GEM
       rb-inotify (>= 0.9)
     lumberjack (1.0.4)
     method_source (0.8.2)
-    multipart-post (1.1.5)
-    nokogiri (1.5.9)
+    mini_portile (0.5.2)
+    multipart-post (1.2.0)
+    nokogiri (1.6.0)
+      mini_portile (~> 0.5.0)
     pry (0.9.12.2)
       coderay (~> 1.0.5)
       method_source (~> 0.8)

data/README.md

@@ -98,6 +98,10 @@ Transilien::VehicleJourney.find route_external_code: routes_stlaz_val.map(&:exte
 
 Easier, isn't it? Now take every `Stop` and keep only your matching `StopArea`: you'll get your hours of departures and arrivals :)
 
+## Documentation
+
+You're reading it… Ok, have a look to http://rubydoc.info/gems/transilien_microservices for code documentation. Note: you'll get a better understanding of that implementations if your read API documentation, see first link.
+
 ## Contributing
 
 1. Fork it

data/lib/transilien/micro_service.rb

@@ -60,10 +60,10 @@ class Transilien::MicroService
 
       self.filters = filters
       response = self.http.get(action_param, params)
-      puts('== Request: ')
-      puts(action_param.inspect)
-      puts(params.inspect)
-      puts(response.env[:url].inspect)
+      #puts('== Request: ')
+      #puts(action_param.inspect)
+      #puts(params.inspect)
+      #puts(response.env[:url].inspect)
       body = response.body
       collection = []
       doc = Nokogiri.XML(body)

data/lib/transilien/time.rb

@@ -1,20 +1,34 @@
+# Represents Time in Transilien MS API
+# Theorically, you NEVER had to instanciate them by yourself
+# Note: +total_seconds+ and +day+ looks like mysteries for myself right now…
 class Transilien::Time < Transilien::FakeMicroService
   attr_accessor :total_seconds, :day, :hour, :minute
 
   class << self
+    # Build a `Transilien::Time` from a Nokogiri::Node
     def from_node(node, access_time)
       item = new
       item.payload = node
 
       item.total_seconds = node.at('TotalSeconds').text
-      item.day = node.at('Day').text
-      item.hour = node.at('Hour').text
-      item.minute = node.at('Minute').text
+      item.day = node.at('Day').text.to_i
+      item.hour = node.at('Hour').text.to_i
+      item.minute = node.at('Minute').text.to_i
       item
     end
   end
 
-  def name # objective: enable caching
-    "#{day}:#{hour}:#{minutes}|#{total_seconds}"
+  # String conversion of the instance.
+  # It aims only to permit caching (see Transilien::Microservice class)
+  # @return [String] representation of that instance
+  def name
+    "#{day}:#{hour}:#{minute}|#{total_seconds}"
+  end
+
+  # Convert this object to ruby `::Time`
+  # Since the current time is not known, set it to `Time.new` year, month and day
+  def time
+    now = Time.new
+    Time.local(now.year, now.month, now.day + day, hour, minute)
   end
 end

data/lib/transilien/version.rb

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

data/spec/time_spec.rb

@@ -0,0 +1,15 @@
+require 'spec_helper'
+
+describe Transilien::Time do
+  it 'should convert to ::Time easily' do
+    tt = Transilien::Time.new
+    tt.day = 0
+    tt.hour = 14
+    tt.minute = 42
+    tt.time.is_a?(::Time).should be_true
+    now = Time.new
+    tt.time.should eql(Time.local(now.year, now.month, now.day, 14, 42))
+    tt.day = 1
+    tt.time.should eql(Time.local(now.year, now.month, now.day + 1, 14, 42))
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: transilien_microservices
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Thomas Lecavelier
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-08 00:00:00.000000000 Z
+date: 2013-11-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -49,6 +49,7 @@ files:
 - .gitignore
 - .rspec
 - .ruby-version
+- CHANGELOG
 - Gemfile
 - Gemfile.lock
 - Guardfile
@@ -71,6 +72,7 @@ files:
 - lib/transilien_microservices.rb
 - spec/microservice_spec.rb
 - spec/spec_helper.rb
+- spec/time_spec.rb
 - spec/vehicle_journey_alone.xml
 - spec/vehicle_journey_spec.rb
 - transilien_microservices.gemspec
@@ -101,6 +103,7 @@ summary: See http://test.data-sncf.com/index.php?p=transilien
 test_files:
 - spec/microservice_spec.rb
 - spec/spec_helper.rb
+- spec/time_spec.rb
 - spec/vehicle_journey_alone.xml
 - spec/vehicle_journey_spec.rb
 has_rdoc: