ns-yapi 0.1 → 0.1.1

data/Gemfile.lock

@@ -1,8 +1,8 @@
 PATH
   remote: .
   specs:
-    ns-yapi (0.1)
-      httpi
+    ns-yapi (0.1.1)
+      httpclient
       nokogiri
       nori
 
@@ -21,8 +21,6 @@ GEM
       safe_yaml (~> 0.9.0)
     diff-lcs (1.2.4)
     httpclient (2.3.3)
-    httpi (2.0.2)
-      rack
     metaclass (0.0.1)
     mime-types (1.23)
     mini_portile (0.5.0)
@@ -32,7 +30,6 @@ GEM
     nokogiri (1.6.0)
       mini_portile (~> 0.5.0)
     nori (2.2.0)
-    rack (1.5.2)
     rake (10.0.3)
     rest-client (1.6.7)
       mime-types (>= 1.16)

data/README.md

@@ -2,16 +2,55 @@ Yet Another NS API [![Build Status](https://travis-ci.org/stefanhendriks/ns-api.
 ==================
 A Ruby client for the NS API.
 
+Goal
+====
+I'd like to write a comprehensive, yet very thin implementation of the NS API. For now I have limited access therefor this gem is limited.
 
+If you have credentials that work with the prices-api calls, and are willing to share them with me so I can expand this gem. Please contact me.
+
+You can also send me an example response, so I can work from there. Although I would like to see it working for real as well.
+
+Pull requests are welcome.
 
 Usage
 =====
-First, make sure you have a username and password from the NS API website.
+First, make sure you have a username and password from the NS API website. (at: http://www.ns.nl/api)
+
+You can use the NSYAPI singleton, you can configure it by using a configuration block:
+```ruby
+require 'ns_client'
+
+NSYapi::configure do |config|
+  config.username = "some-username"
+  config.password = "some-password"
+end
+
+client = NSYapi::client
+
+client.stations
+```
+
+or, you can instantiate the NSClient yourself, providing a username and password. You can then regulate the instance yourself.
+
 ```ruby
+require 'ns_client'
+
 # get username/password from NS site
 client = NSClient.new("my-username", "my-password")
 
+```
+
+After you have created a client, you can use it for several operations
+
+Retrieve all stations
+=====================
+
+```ruby
 # get all known stations
-client.stations
+stations = client.stations
+station = stations.first
+station.name # 's-Hertogenbosch
+station.lat # 51.69048
+station.long # 5.29362
 ```
 

data/lib/ns_client.rb

@@ -1,6 +1,5 @@
 require 'pathname'
 require 'time'
-require 'httpi'
 require 'nori'
 require 'nokogiri'
 
@@ -16,6 +15,29 @@ Dir.glob(File.join(lib_path, '/**/*.rb')).each do |file|
   require file
 end
 
+module NSYapi
+
+  class Configuration
+    attr_accessor :username, :password
+  end
+
+  # Configures Plugin.
+  def self.configure(configuration = NSYapi::Configuration.new)
+    yield configuration if block_given?
+    @@configuration = configuration
+  end
+
+  def self.configuration # :nodoc:
+    @@configuration ||= Plugin::NSYapi.new
+  end
+
+  def self.client
+    @client_instance = NSClient.new(configuration.username, configuration.password) unless @client_instance
+    @client_instance
+  end
+
+end
+
 class NSClient
 
   def initialize(username, password)
@@ -43,6 +65,36 @@ class NSClient
     result
   end
 
+  def disruptions
+    response = @client.get "http://username:password@webservices.ns.nl/ns-api-storingen?"
+    result = {planned: [], unplanned: []}
+    xdoc = Nokogiri.XML(response.content)
+
+    (xdoc/'/Storingen').each { |disruption|
+
+      (disruption/'Ongepland/Storing').each { |unplanned|
+        # TODO: check if element has data
+        unplanned_disruption = UnplannedDisruption.new
+        result[:unplanned] << unplanned_disruption
+      }
+
+      (disruption/'Gepland/Storing').each { |planned|
+        # TODO: check if element has data
+        planned_disruption = PlannedDisruption.new
+        result[:planned] << planned_disruption
+      }
+    }
+    result
+  end
+
+  class UnplannedDisruption
+    # TODO: add properties
+  end
+
+  class PlannedDisruption
+    # TODO: add properties
+  end
+
   class Station
     attr_accessor :code, :type, :land, :short_name, :name, :long_name, :uiccode, :synonyms, :lat, :long
   end

data/ns.gemspec

@@ -4,10 +4,10 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |gem|
   gem.name          = "ns-yapi"
-  gem.version       = '0.1'
+  gem.version       = '0.1.1'
   gem.authors       = ["Stefan Hendriks"]
   gem.email         = ["stefanhen83@gmail.com"]
-  gem.description   = %q{A Ruby client for the NS (Dutch Railways) API}
+  gem.description   = %q{Yet Another (Ruby) NS API}
   gem.summary       = %q{A Ruby client for the NS (Dutch Railways) API}
   gem.homepage      = "https://github.com/stefanhendriks/ns-api"
 
@@ -16,7 +16,8 @@ Gem::Specification.new do |gem|
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = ["lib"]
 
-  gem.add_dependency 'httpi'
+  gem.add_dependency 'httpclient'
   gem.add_dependency 'nori'
   gem.add_dependency 'nokogiri'
+
 end

data/spec/fixtures/disruptions.xml

@@ -0,0 +1,24 @@
+<Storingen>
+  <Ongepland>
+    <Storing>
+      <id>prio-13345</id>
+      <Traject>'s-Hertogenbosch-Nijmegen</Traject>
+      <Reden>beperkingen op last van de politie</Reden>
+      <Bericht></Bericht>
+      <Datum>2010-12-16T11:16:00+0100</Datum>
+    </Storing>
+  </Ongepland>
+  <Gepland>
+    <Storing>
+      <id>2010_almo_wp_18_19dec</id>
+      <Traject>Almere Oostvaarders-Weesp/Naarden-Bussum</Traject>
+      <Periode>zaterdag 18 en zondag 19 december</Periode>
+      <Reden>Beperkt treinverkeer, businzet en/of omreizen, extra reistijd 15-30 min.</Reden>
+      <Advies>Maak gebruik van de overige treinen of de bussen: reis tussen Weesp en Almere Centrum met de NS-bus in
+        plaats van de trein tussen Almere Centrum en Lelystad Centrum rijden vier Sprinters per uur reis tussen Almere
+        Muziekwijk en Naarden-Bussum via Weesp
+      </Advies>
+      <Bericht></Bericht>
+    </Storing>
+  </Gepland>
+</Storingen>

data/spec/fixtures/disruptions_amsterdam.xml

@@ -0,0 +1,148 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<Storingen>
+  <Ongepland>
+
+  </Ongepland>
+  <Gepland>
+
+    <Storing>
+      <id>2013_hrl_aachen_14_17jun</id>
+
+      <Traject>Heerlen-Aachen Hbf</Traject>
+
+
+      <Periode>vrijdag 14 juni tot en met maandag 17 juni 13.00 uur</Periode>
+
+
+      <Advies>U kunt gebruikmaken van de bus tussen Heerlen en Herzogenrath kunt u gebruikmaken van de bussen tussen
+        Heerlen en Heerlen de Kissel kunt u gebruikmaken van de reguliere busdienst van Veolia
+      </Advies>
+
+
+      <Bericht><![CDATA[
+        <p>
+            <b>Wanneer: vrijdag 14 juni tot en met maandag 17 juni 13.00 uur</b>
+            <br/>
+            <b>Oorzaak: aangepaste dienstregeling</b>
+            <br/>
+            <b>Advies: U kunt gebruikmaken van de bus</b>
+            <br/>	tussen Heerlen en Herzogenrath kunt u gebruikmaken van de bussen<br/>	tussen Heerlen en Heerlen de Kissel kunt u gebruikmaken van de reguliere busdienst van Veolia<br/><br/><b>Extra Reistijd: een kwartier tot een half uur</b><br/></p>
+    ]]></Bericht>
+
+
+      <Oorzaak>aangepaste dienstregeling</Oorzaak>
+
+
+      <Vertraging>een kwartier tot een half uur</Vertraging>
+
+    </Storing>
+
+    <Storing>
+      <id>2013_asd_basel_15_16jun</id>
+
+      <Traject>Amsterdam C-Koeln Hbf-Frankfurt (M) Hbf-Basel SBB</Traject>
+
+
+      <Periode>zaterdag 15 en zondag 16 juni</Periode>
+
+
+      <Advies>U kunt gebruikmaken van de gewijzigde dienstregeling door werkzaamheden rijdt ICE International via een
+        andere route daardoor stopt ICE International niet in Arnhem, Oberhausen, Duisburg en Duesseldorf, maar extra in
+        's-Hertogenbosch en Eindhoven en vaak ook in Moenchengladgach; de vertrek- en aankomsttijden op alle stations
+        zullen worden gewijzigd houdt u rekening met eerder vertrekken of later aankomen
+      </Advies>
+
+
+      <Bericht><![CDATA[
+        <p>
+            <b>Wanneer: zaterdag 15 en zondag 16 juni</b>
+            <br/>
+            <b>Oorzaak: door werkzaamheden</b>
+            <br/>
+            <b>Advies: U kunt gebruikmaken van de gewijzigde dienstregeling</b>
+            <br/>	door werkzaamheden rijdt ICE International via een andere route<br/>	daardoor stopt ICE International niet in Arnhem, Oberhausen, Duisburg en Duesseldorf, maar extra in 's-Hertogenbosch en Eindhoven en vaak ook in Moenchengladgach; de vertrek- en aankomsttijden op alle stations zullen worden gewijzigd<br/>	houdt u rekening met eerder vertrekken of later aankomen<br/><br/><b>Extra Reistijd: een uur</b><br/></p>
+    ]]></Bericht>
+
+
+      <Oorzaak>door werkzaamheden</Oorzaak>
+
+
+      <Vertraging>een uur</Vertraging>
+
+    </Storing>
+
+    <Storing>
+      <id>2013_amf_brn_ut_16jun</id>
+
+      <Traject>Amersfoort/Baarn/Utrecht Centraal</Traject>
+
+
+      <Periode>zondag 16 juni</Periode>
+
+
+      <Advies>U kunt gebruikmaken van de omgeleide Intercity, omreizen of van de bussen Intercity's tussen Amersfoort en
+        Utrecht Centraal rijden via Hilversum Sprinters tussen Baarn, Den Dolder en Utrecht Centraal rijden niet; er
+        rijdt elk kwartier een NS-bus tussen Baarn, Den Dolder en Utrecht Overvecht tussen Utrecht Overvecht en Utrecht
+        Centraal kunt u gebruikmaken van de Sprinters tussen Hilversum en Utrecht Centraal tussen Baarn en Utrecht
+        Overvecht/Utrecht Centraal kunt u omreizen via Hilversum
+      </Advies>
+
+
+      <Bericht><![CDATA[
+        <p>
+            <b>Wanneer: zondag 16 juni</b>
+            <br/>
+            <b>Oorzaak: door werkzaamheden</b>
+            <br/>
+            <b>Advies: U kunt gebruikmaken van de omgeleide Intercity, omreizen of van de bussen</b>
+            <br/>	Intercity's tussen Amersfoort en Utrecht Centraal rijden via Hilversum<br/>	Sprinters tussen Baarn, Den Dolder en Utrecht Centraal rijden niet; er rijdt elk kwartier een NS-bus tussen Baarn, Den Dolder en Utrecht Overvecht<br/>	tussen Utrecht Overvecht en Utrecht Centraal kunt u gebruikmaken van de Sprinters tussen Hilversum en Utrecht Centraal<br/>	tussen Baarn en Utrecht Overvecht/Utrecht Centraal kunt u omreizen via Hilversum<br/><br/><b>Extra Reistijd: een kwartier tot een half uur</b><br/></p>
+    ]]></Bericht>
+
+
+      <Oorzaak>door werkzaamheden</Oorzaak>
+
+
+      <Vertraging>een kwartier tot een half uur</Vertraging>
+
+    </Storing>
+
+    <Storing>
+      <id>2013_asd_bd_16jun</id>
+
+      <Traject>Amsterdam Centraal-Breda Fyra</Traject>
+
+
+      <Periode>zondag 16 juni</Periode>
+
+
+      <Advies>U kunt gebruikmaken van de overige treinen Tot 09.30 uur: de treinen die om 06.56, 07.26 en om 07.56 uur
+        uit Amsterdam Centraal zouden vertrekken, rijden uitsluitend tussen Schiphol en Rotterdam Centraal en stoppen
+        daardoor niet in Amsterdam Centraal en Breda de treinen die om 07.28, 07.58, 08.28, 08.58 en 09.28 uur uit Breda
+        zouden vertrekken, rijden niet tussen Breda en Rotterdam Centraal, maar uitsluitend tussen Rotterdam Centraal en
+        Schiphol daardoor stoppen deze treinen niet in Breda en Amsterdam Centraal Na 09.30 uur: Fyra rijdt de hele dag
+        uitsluitend tussen Schiphol, Rotterdam Centraal en Breda; daardoor stopt Fyra niet in Amsterdam Centraal we
+        adviseren u uw reis kort van te voren te plannen met behulp van de reisplanners
+      </Advies>
+
+
+      <Bericht><![CDATA[
+        <p>
+            <b>Wanneer: zondag 16 juni</b>
+            <br/>
+            <b>Oorzaak: door werkzaamheden</b>
+            <br/>
+            <b>Advies: U kunt gebruikmaken van de overige treinen</b>
+            <br/>	Tot 09.30 uur:<br/>	de treinen die om 06.56, 07.26 en om 07.56 uur uit Amsterdam Centraal zouden vertrekken, rijden uitsluitend tussen Schiphol en Rotterdam Centraal en stoppen daardoor niet in Amsterdam Centraal en Breda<br/>	de treinen die om 07.28, 07.58, 08.28, 08.58 en 09.28 uur uit Breda zouden vertrekken, rijden niet tussen Breda en Rotterdam Centraal, maar uitsluitend tussen Rotterdam Centraal en Schiphol<br/>	daardoor stoppen deze treinen niet in Breda en Amsterdam Centraal<br/>	Na 09.30 uur:<br/>	Fyra rijdt de hele dag uitsluitend tussen Schiphol, Rotterdam Centraal en Breda; daardoor stopt Fyra niet in Amsterdam Centraal<br/>	we adviseren u uw reis kort van te voren te plannen met behulp van de reisplanners<br/><br/><b>Extra Reistijd: een half uur tot een uur</b><br/></p>
+    ]]></Bericht>
+
+
+      <Oorzaak>door werkzaamheden</Oorzaak>
+
+
+      <Vertraging>een half uur tot een uur</Vertraging>
+
+    </Storing>
+
+  </Gepland>
+</Storingen>

data/spec/fixtures/no_disruptions.xml

@@ -0,0 +1,10 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<Storingen>
+  <Ongepland>
+
+  </Ongepland>
+  <Gepland>
+
+  </Gepland>
+</Storingen>

data/spec/fixtures/prices.xml

@@ -0,0 +1,20 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<Producten>
+  <Tariefeenheden>10</Tariefeenheden>
+  <Product naam="Enkele reis">
+    <Prijs korting="vol tarief" klasse="2">2,40</Prijs>
+    <Prijs korting="reductie_20" klasse="2">1,90</Prijs>
+    <Prijs korting="reductie_40" klasse="2">1,40</Prijs>
+    <Prijs korting="vol tarief" klasse="1">4,10</Prijs>
+    <Prijs korting="reductie_20" klasse="1">3,30</Prijs>
+    <Prijs korting="reductie_40" klasse="1">2,50</Prijs>
+  </Product>
+  <Product naam="Dagretour">
+    <Prijs korting="vol tarief" klasse="2">4,80</Prijs>
+    <Prijs korting="reductie_20" klasse="2">3,80</Prijs>
+    <Prijs korting="reductie_40" klasse="2">2,80</Prijs>
+    <Prijs korting="vol tarief" klasse="1">8,20</Prijs>
+    <Prijs korting="reductie_20" klasse="1">6,60</Prijs>
+    <Prijs korting="reductie_40" klasse="1">5,00</Prijs>
+  </Product>
+</Producten>

data/spec/ns_client_spec.rb

@@ -3,22 +3,22 @@ require 'spec_helper'
 describe NSClient do
 
   before :each do
-    @nsclient = NSClient.new("username", "password")
+    @client = NSClient.new("username", "password")
   end
 
-  context "Fetching stations from NS" do
+  context "Stations" do
 
     before :each do
-      stub_ns_client_request "http://username:password@webservices.ns.nl/ns-api-stations-v2", load_fixture('ns_stations.xml')
+      stub_ns_client_request "http://username:password@webservices.ns.nl/ns-api-stations-v2", load_fixture('stations.xml')
     end
 
     it "should return all stations" do
-      stations = @nsclient.stations
+      stations = @client.stations
       stations.size.should == 620
     end
 
     it "should return expected first station from list" do
-      stations = @nsclient.stations
+      stations = @client.stations
       first_station = stations.first
       first_station.class.should == NSClient::Station
       first_station.type.should == "knooppuntIntercitystation"
@@ -34,6 +34,35 @@ describe NSClient do
 
   end
 
+  context "Disruptions" do
+
+    it "should retrieve planned and unplanned disruptions" do
+      stub_ns_client_request "http://username:password@webservices.ns.nl/ns-api-storingen?", load_fixture('disruptions.xml')
+      disruptions = @client.disruptions
+      disruptions.size.should == 2
+      disruptions[:planned].size.should == 1
+      disruptions[:unplanned].size.should == 1
+    end
+
+    xit "should retrieve expected planned disruption"
+    xit "should retrieve expected unplanned disruption"
+
+    xit "should not return disruption when empty in response" do
+      stub_ns_client_request "http://username:password@webservices.ns.nl/ns-api-storingen?", load_fixture('no_disruptions.xml')
+      disruptions = @client.disruptions
+      disruptions.size.should == 2
+      disruptions[:planned].size.should == 0
+      disruptions[:unplanned].size.should == 0
+    end
+
+    xit "should retrieve disruptions for station name" # ie, for Amsterdam only (http://webservices.ns.nl/ns-api-storingen?station=Amsterdam)
+
+  end
+
+  context "Prices" do
+    xit "should retrieve prices for a trip"
+  end
+
   def stub_ns_client_request(url, response)
     # headers based on "username", "password"
     stub_request(:get, url).

data/spec/nsyapi_spec.rb

@@ -0,0 +1,33 @@
+require 'spec_helper'
+
+describe NSYapi do
+
+  context "Configuration" do
+
+    it "should be configurable with a block" do
+      NSYapi::configure do |config|
+        config.username = "some-username"
+        config.password = "some-password"
+      end
+      NSYapi::configuration.username.should == "some-username"
+      NSYapi::configuration.password.should == "some-password"
+    end
+
+  end
+
+  context "Singleton" do
+
+    it "should create a singleton" do
+      NSYapi::configure do |config|
+        config.username = "some-username"
+        config.password = "some-password"
+      end
+
+      client = NSYapi::client
+      client.should == NSYapi::client
+    end
+
+  end
+
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ns-yapi
 version: !ruby/object:Gem::Version
-  version: '0.1'
+  version: 0.1.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,10 +9,10 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-16 00:00:00.000000000 Z
+date: 2013-06-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: httpi
+  name: httpclient
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
@@ -59,7 +59,7 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: A Ruby client for the NS (Dutch Railways) API
+description: Yet Another (Ruby) NS API
 email:
 - stefanhen83@gmail.com
 executables: []
@@ -75,8 +75,13 @@ files:
 - lib/ns_client.rb
 - ns.gemspec
 - rakefile.rb
-- spec/fixtures/ns_stations.xml
+- spec/fixtures/disruptions.xml
+- spec/fixtures/disruptions_amsterdam.xml
+- spec/fixtures/no_disruptions.xml
+- spec/fixtures/prices.xml
+- spec/fixtures/stations.xml
 - spec/ns_client_spec.rb
+- spec/nsyapi_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/stefanhendriks/ns-api
 licenses: []
@@ -103,6 +108,11 @@ signing_key:
 specification_version: 3
 summary: A Ruby client for the NS (Dutch Railways) API
 test_files:
-- spec/fixtures/ns_stations.xml
+- spec/fixtures/disruptions.xml
+- spec/fixtures/disruptions_amsterdam.xml
+- spec/fixtures/no_disruptions.xml
+- spec/fixtures/prices.xml
+- spec/fixtures/stations.xml
 - spec/ns_client_spec.rb
+- spec/nsyapi_spec.rb
 - spec/spec_helper.rb