ruby-irail 0.4.1 → 0.4.2

data/README.md

@@ -44,6 +44,14 @@ irail.connections(origin, destination)
 #get train trip information (all stops for a train)
 
 irail.vehicle("BE.NMBS.IC2240") # the vehicle ids cans be found when querying for a connection
+
+#get departures from a specific station
+
+irail.departures("BE.NMBS.008813003") # get station identifiers from the stations call
+
+#get arrivals to a specific station
+
+irail.arrivals("BE.NMBS.008813003")
 ```
 
 ## Contributing

data/lib/ruby-irail/packages/mivbstib/api.rb

@@ -3,20 +3,12 @@ module IRail::API
     API_URL       = "http://data.irail.be"
     PACKAGE_ID    = "MIVBSTIB"
     STATIONS_URI  = "Stations"
-    PARSER_FORMAT = "xml"
+    PARSER_FORMAT = "json"
 
     def stations
-      @stations ||= get_stations
-    end
-
-    def get_stations
-      station_list_url = build_station_list_url
-      xml_station_list = get_station_list(station_list_url)
-      IRail::MIVBSTIB::DocumentParser.parse_stations(xml_station_list)
-    end
-
-    def get_station_list(station_list_url)
-      IRail::Request.get(station_list_url)
+      url  = build_station_list_url
+      json = IRail::Request.get(url)
+      IRail::MIVBSTIB::JSONParser.parse_stations(json)
     end
 
     private

data/lib/ruby-irail/packages/mivbstib/models/station.rb

@@ -1,12 +1,22 @@
 require "virtus"
 
 module IRail::MIVBSTIB
+  module Attributes
+    class Coordinate < Virtus::Attribute::Object
+      primitive Float
+
+      def coerce(value)
+        value.strip.to_f
+      end
+    end
+  end
+
   class Station
     include Virtus
 
-    attribute :id, Integer
-    attribute :latitude, Float
-    attribute :longitude, Float
-    attribute :name, String
+    attribute :id,        Integer
+    attribute :latitude,  Attributes::Coordinate
+    attribute :longitude, Attributes::Coordinate
+    attribute :name,      String
   end
 end

data/lib/ruby-irail/packages/mivbstib/parser/json_parser.rb

@@ -0,0 +1,15 @@
+require "json"
+
+module IRail::MIVBSTIB
+  class JSONParser
+    STATIONS_KEY = "Stations"
+
+    def self.parse_stations(json_string)
+      json_hash      = JSON.parse(json_string)
+      stations_json  = json_hash[STATIONS_KEY]
+      stations_json.inject([]) do |stations, station_attributes|
+        stations << IRail::MIVBSTIB::Station.new(station_attributes)
+      end
+    end
+  end
+end

data/lib/version.rb

@@ -1,3 +1,3 @@
 module IRail
-  VERSION = "0.4.1"
+  VERSION = "0.4.2"
 end

data/ruby-irail.gemspec

@@ -17,5 +17,6 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency "rspec"
   gem.add_dependency "httparty"
   gem.add_dependency "roxml"
+  gem.add_dependency "json"
   gem.add_dependency "nokogiri"
 end

data/spec/packages/mivbstib/api_spec.rb

@@ -2,73 +2,34 @@ require_relative "../../../lib/ruby-irail/packages/mivbstib/api.rb"
 
 describe IRail::API::MIVBSTIB do
   let(:irail) { IRail::API::MIVBSTIB.new }
-
-  describe :stations do
-    let(:stations)         { mock("Stations") }
-    let(:fetched_stations) { mock("Fetched stations") }
-
-    before :each do
-      irail.stub(:get_stations => fetched_stations)
-    end
-
-    it "returns the stations when they were already fetched" do
-      irail.instance_variable_set(:@stations, stations)
-      irail.stations.should eql stations
-    end
-
-    context "when stations have not been fetched yet" do
-      it "fetches them" do
-        irail.should_receive(:get_stations)
-        irail.stations
-      end
-
-      it "returns them" do
-        irail.stations.should eql fetched_stations
-      end
-    end
+  let(:url)   { mock("Stations url") }
+  let(:json)  { mock("Json stations") }
+  let(:stations) { mock("Stations") }
+
+  before :each do
+    irail.stub(:build_station_list_url => url)
+    IRail::Request.stub(:get => json)
+    IRail::MIVBSTIB::JSONParser.stub(:parse_stations => stations)
   end
 
-  describe :get_stations do
-    let(:station_list_url) { mock("Url") }
-    let(:xml_station_list) { mock("Xml station list") }
-    let(:stations)         { mock("Stations") }
-
-    before :each do
-      irail.stub(:build_station_list_url => station_list_url)
-      irail.stub(:get_station_list => xml_station_list)
-      IRail::MIVBSTIB::DocumentParser.stub(:parse_stations => stations)
-    end
-
-    it "builds the station list url" do
+  describe :stations do
+    it "builds the station url" do
       irail.should_receive(:build_station_list_url)
-      irail.get_stations
-    end
-
-    it "gets the xml station list" do
-      irail.should_receive(:get_station_list).with(station_list_url)
-      irail.get_stations
+      irail.stations
     end
 
-    it "returns the parsed stations" do
-      irail.get_stations.should eql stations
-    end
-  end
-
-  describe :get_station_list do
-    let(:url)      { mock("Url") }
-    let(:response) { mock("Response") }
-
-    before :each do
-      IRail::Request.stub(:get => response)
+    it "calls the api" do
+      IRail::Request.should_receive(:get).with(url)
+      irail.stations
     end
 
-    it "calls the station list url through a get request" do
-      IRail::Request.should_receive(:get).with(url)
-      irail.get_station_list(url)
+    it "parses the returned json" do
+      IRail::MIVBSTIB::JSONParser.should_receive(:parse_stations).with(json)
+      irail.stations
     end
 
-    it "returns the response" do
-      irail.get_station_list(url).should eql response
+    it "returns the stations" do
+      irail.stations.should eql stations
     end
   end
 end

data/spec/packages/mivbstib/parser/json_parser_spec.rb

@@ -0,0 +1,33 @@
+require_relative "../../../../lib/ruby-irail/packages/mivbstib/parser/json_parser.rb"
+
+describe IRail::MIVBSTIB::JSONParser do
+  class IRail::MIVBSTIB::Station
+  end
+
+  describe :'self.parse_stations' do
+    let(:json_string)   { mock("Json string") }
+    let(:json_stations) { [ IRail::MIVBSTIB::Station.new, IRail::MIVBSTIB::Station.new, IRail::MIVBSTIB::Station.new ] }
+    let(:station)       { mock("Station") }
+
+    before :each do
+      JSON.stub(:parse => {"Stations" => json_stations})
+      IRail::MIVBSTIB::Station.stub(:new => station)
+    end
+
+    it "parses the json" do
+      JSON.should_receive(:parse).with(json_string)
+      IRail::MIVBSTIB::JSONParser.parse_stations(json_string)
+    end
+
+    it "creates a station for each json station" do
+      json_stations.each do |station|
+        IRail::MIVBSTIB::Station.should_receive(:new).with(station)
+      end
+      IRail::MIVBSTIB::JSONParser.parse_stations(json_string)
+    end
+
+    it "returns the stations" do
+      IRail::MIVBSTIB::JSONParser.parse_stations(json_string).should eql [ station, station, station ]
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ruby-irail
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.4.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-19 00:00:00.000000000Z
+date: 2012-07-20 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70350038980380 !ruby/object:Gem::Requirement
+  requirement: &70163615043800 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70350038980380
+  version_requirements: *70163615043800
 - !ruby/object:Gem::Dependency
   name: httparty
-  requirement: &70350038979960 !ruby/object:Gem::Requirement
+  requirement: &70163615043380 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70350038979960
+  version_requirements: *70163615043380
 - !ruby/object:Gem::Dependency
   name: roxml
-  requirement: &70350038979540 !ruby/object:Gem::Requirement
+  requirement: &70163615042960 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,21 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70350038979540
+  version_requirements: *70163615042960
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: &70163615036020 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70163615036020
 - !ruby/object:Gem::Dependency
   name: nokogiri
-  requirement: &70350038979120 !ruby/object:Gem::Requirement
+  requirement: &70163615035400 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,7 +65,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70350038979120
+  version_requirements: *70163615035400
 description: IRail makes Belgian railway schedule easily available for anyone. This
   is a Ruby wrapper for their API.
 email:
@@ -75,8 +86,7 @@ files:
 - lib/ruby-irail/http/request.rb
 - lib/ruby-irail/packages/mivbstib/api.rb
 - lib/ruby-irail/packages/mivbstib/models/station.rb
-- lib/ruby-irail/packages/mivbstib/parser/document_parser.rb
-- lib/ruby-irail/packages/mivbstib/parser/station_parser.rb
+- lib/ruby-irail/packages/mivbstib/parser/json_parser.rb
 - lib/ruby-irail/packages/nmbs/api.rb
 - lib/ruby-irail/packages/nmbs/models/connection.rb
 - lib/ruby-irail/packages/nmbs/models/liveboard.rb
@@ -95,8 +105,7 @@ files:
 - spec/http/request_spec.rb
 - spec/packages/mivbstib/api_spec.rb
 - spec/packages/mivbstib/models/station_spec.rb
-- spec/packages/mivbstib/parser/document_parser_spec.rb
-- spec/packages/mivbstib/parser/station_parser_spec.rb
+- spec/packages/mivbstib/parser/json_parser_spec.rb
 - spec/packages/nmbs/api_spec.rb
 - spec/packages/nmbs/models/connection_spec.rb
 - spec/packages/nmbs/models/liveboard_spec.rb
@@ -138,8 +147,7 @@ test_files:
 - spec/http/request_spec.rb
 - spec/packages/mivbstib/api_spec.rb
 - spec/packages/mivbstib/models/station_spec.rb
-- spec/packages/mivbstib/parser/document_parser_spec.rb
-- spec/packages/mivbstib/parser/station_parser_spec.rb
+- spec/packages/mivbstib/parser/json_parser_spec.rb
 - spec/packages/nmbs/api_spec.rb
 - spec/packages/nmbs/models/connection_spec.rb
 - spec/packages/nmbs/models/liveboard_spec.rb

data/lib/ruby-irail/packages/mivbstib/parser/document_parser.rb

@@ -1,14 +0,0 @@
-module IRail::MIVBSTIB
-  class DocumentParser
-    STATION_XPATH = "//Stations"
-
-    def self.parse_stations(xml_string)
-      xml_payload  = Nokogiri::XML(xml_string)
-      xml_stations = xml_payload.xpath(STATION_XPATH)
-      xml_stations.inject([]) do |stations, xml_station|
-        attributes = IRail::MIVBSTIB::StationParser.parse(xml_station)
-        stations << IRail::MIVBSTIB::Station.new(attributes)
-      end
-    end
-  end
-end

data/lib/ruby-irail/packages/mivbstib/parser/station_parser.rb

@@ -1,27 +0,0 @@
-module IRail::MIVBSTIB
-  class StationParser
-    def self.parse(xml_payload)
-      id            = parse_station_id(xml_payload)
-      latitude      = parse_station_latitude(xml_payload)
-      longitude     = parse_station_longitude(xml_payload)
-      name          = parse_station_name(xml_payload)
-      {id: id, latitude: latitude, longitude: longitude, name: name}
-    end
-
-    def self.parse_station_id(xml_payload)
-      xml_payload.xpath('id').text.strip
-    end
-
-    def self.parse_station_latitude(xml_payload)
-      xml_payload.xpath('latitude').text.strip
-    end
-
-    def self.parse_station_longitude(xml_payload)
-      xml_payload.xpath('longitude').text.strip
-    end
-
-    def self.parse_station_name(xml_payload)
-      xml_payload.xpath('name').text.strip
-    end
-  end
-end

data/spec/packages/mivbstib/parser/document_parser_spec.rb

@@ -1,55 +0,0 @@
-require_relative "../../../../lib/ruby-irail/packages/mivbstib/parser/document_parser.rb"
-
-describe IRail::MIVBSTIB::DocumentParser do
-  module Nokogiri
-    module XML
-    end
-  end
-
-  class IRail::MIVBSTIB::StationParser
-  end
-
-  class IRail::MIVBSTIB::Station
-  end
-
-  describe :'self.parse_stations' do
-    let(:xml_string)  { mock("Xml string") }
-    let(:xml_payload) { mock("Xml payload") }
-    let(:stations)    { [ mock("Station"), mock("Station"), mock("Station") ] }
-    let(:attributes)  { {} }
-
-    before :each do
-      Nokogiri.stub(:XML => xml_payload)
-      xml_payload.stub(:xpath => stations)
-      IRail::MIVBSTIB::StationParser.stub(:parse => attributes)
-    end
-
-    it "gets the xml payload from the string passed as parameter" do
-      Nokogiri.should_receive(:XML).with(xml_string)
-      IRail::MIVBSTIB::DocumentParser.parse_stations(xml_string)
-    end
-
-    it "extracts the stations from the xml payload" do
-      xml_payload.should_receive(:xpath).with(IRail::MIVBSTIB::DocumentParser::STATION_XPATH)
-      IRail::MIVBSTIB::DocumentParser.parse_stations(xml_string)
-    end
-
-    it "parses the attributes of all stations" do
-      stations.each do |xml_station|
-        IRail::MIVBSTIB::StationParser.should_receive(:parse).with(xml_station)
-      end
-      IRail::MIVBSTIB::DocumentParser.parse_stations(xml_string)
-    end
-
-    it "creates a new station for all parsed station attributes" do
-      stations.each do |station|
-        IRail::MIVBSTIB::Station.should_receive(:new).with(attributes)
-      end
-      IRail::MIVBSTIB::DocumentParser.parse_stations(xml_string)
-    end
-
-    it "returns as many stations as in the xml payload" do
-      IRail::MIVBSTIB::DocumentParser.parse_stations(xml_string).size.should eql stations.size
-    end
-  end
-end

data/spec/packages/mivbstib/parser/station_parser_spec.rb

@@ -1,43 +0,0 @@
-require_relative "../../../../lib/ruby-irail/packages/mivbstib/parser/station_parser.rb"
-
-describe IRail::MIVBSTIB::StationParser do
-  describe :'self.parse' do
-    let(:xml_payload)   { mock("Xml Payload") }
-    let(:id)            { mock("Station Id") }
-    let(:latitude)      { mock("Latitude") }
-    let(:longitude)     { mock("Longitude") }
-    let(:name)          { mock("Name") }
-
-    before :each do
-      IRail::MIVBSTIB::StationParser.stub(parse_station_id: id)
-      IRail::MIVBSTIB::StationParser.stub(parse_station_latitude: latitude)
-      IRail::MIVBSTIB::StationParser.stub(parse_station_longitude: longitude)
-      IRail::MIVBSTIB::StationParser.stub(parse_station_name: name)
-    end
-
-    it "parses the id" do
-      IRail::MIVBSTIB::StationParser.should_receive(:parse_station_id).with(xml_payload)
-      IRail::MIVBSTIB::StationParser.parse(xml_payload)
-    end
-
-    it "parses the latitude" do
-      IRail::MIVBSTIB::StationParser.should_receive(:parse_station_latitude).with(xml_payload)
-      IRail::MIVBSTIB::StationParser.parse(xml_payload)
-    end
-
-    it "parses the longitude" do
-      IRail::MIVBSTIB::StationParser.should_receive(:parse_station_longitude).with(xml_payload)
-      IRail::MIVBSTIB::StationParser.parse(xml_payload)
-    end
-
-    it "parses the name" do
-      IRail::MIVBSTIB::StationParser.should_receive(:parse_station_name).with(xml_payload)
-      IRail::MIVBSTIB::StationParser.parse(xml_payload)
-    end
-
-    it "returns a hash containing the parsed attributes" do
-      expected = { id: id, latitude: latitude, longitude: longitude, name: name}
-      IRail::MIVBSTIB::StationParser.parse(xml_payload).should eql expected
-    end
-  end
-end