wasserstand 0.0.4 → 0.0.5

data/lib/wasserstand.rb

@@ -7,10 +7,14 @@ require_rel 'wasserstand'
 
 module Wasserstand
   class << self
-    attr_writer :provider
+    attr_writer :waterway_provider, :level_provider
 
-    def provider
-      @provider ||= Provider::PegelOnline.new
+    def waterway_provider
+      @waterway_provider ||= PegelOnline::WaterwayProvider.new
+    end
+
+    def level_provider
+      @level_provider ||= PegelOnline::LevelProvider.new
     end
   end
 end

data/lib/wasserstand/level.rb

@@ -3,16 +3,39 @@ module Wasserstand
   # see http://www.pegelonline.wsv.de/gast/hilfe#hilfe_pegelparameter
   #
   class Level # Pegel
-    attr_reader :id
-    attr_accessor :name, :km, :measurements
+    class << self
+      def [](name)
+        Wasserstand.level_provider[name]
+      end
 
-    def initialize(id)
-      @id = id
+      def all
+        Wasserstand.level_provider.all
+      end
+
+      def find_by_name(regex)
+        Wasserstand.level_provider.find_by_name(regex)
+      end
+    end
+
+    attr_reader :name
+    attr_accessor :level_id, :km, :measurements
+    attr_writer :waterway
+
+    def initialize(name)
+      @name = name
       @measurements = []
     end
 
+    def waterway
+      if @waterway.respond_to?(:name)
+        @waterway
+      else
+        @waterway = Waterway[@waterway]
+      end
+    end
+
     def to_s
-      "#{@name} (km #{@km}): #{@measurements.last}"
+      name
     end
   end
 end

data/lib/wasserstand/provider/level_mapper.rb

@@ -0,0 +1,41 @@
+module Wasserstand
+  module PegelOnline
+=begin
+<item>
+  <no>8</no>
+  <psmgr>320</psmgr>
+  <pegelname>KONSTANZ</pegelname>
+  <messwert>380,7</messwert>
+  <km>0</km>
+  <pnp>391,89</pnp>
+  <tendenz>Gleich</tendenz>
+  <datum>13.09.2012</datum>
+  <uhrzeit>20:00:00</uhrzeit>
+  <pegelnummer>0906</pegelnummer>
+</item>
+=end
+    class LevelMapper
+      class << self
+        def map(item)
+          level_name = item.xpath('pegelname').text
+
+          Level.new(level_name).tap do |pegel|
+            # The level class will resolve the name to a real object if required
+            pegel.waterway = item.xpath('../name').text
+
+            pegel.level_id = item.xpath('pegelnummer').text
+            pegel.km = item.xpath('km').text.sub(',', '.').to_f
+            datum = item.xpath('datum').text
+            uhrzeit = item.xpath('uhrzeit').text
+
+            messdatum = TZInfo::Timezone.get('Europe/Berlin').local_to_utc(Time.parse("#{datum} #{uhrzeit}"))
+            wert = item.xpath('messwert').text.sub(',', '.').to_f
+            tendenz = item.xpath('tendenz').text.downcase.to_sym
+
+            pegel.measurements << Measurement.new(messdatum, wert, tendenz)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/wasserstand/provider/pegel-online.rb

@@ -1,23 +1,81 @@
 module Wasserstand
-  module Provider
-    class PegelOnline
+  module PegelOnline
+    class Provider
       def initialize(url = 'http://www.pegelonline.wsv.de/svgz/pegelstaende_neu.xml')
         @url = url
       end
 
       def [](name)
-        doc = Nokogiri::HTML(open(@url).read)
-        results = doc.xpath("//data/table/gewaesser[name/text() = '#{name.upcase}']")
+        doc = Nokogiri::HTML(fetch(@url), nil, 'ISO-8859-1')
+        results = doc.xpath(xpath_lookup(name))
 
         case results.size
         when 0
-          return []
+          return nil # loookup returns nil if not found. This is a lookup, not find_all.
         when 1
-          return Mapper.map(results.first)
+          return mapper.map(results.first)
         else
-          raise "Found #{results.size} results for #{name}."
+          raise "Name is not unique. Found #{results.size} results for #{name}."
         end
       end
+
+      def all
+        Nokogiri::HTML(fetch(@url), nil, 'ISO-8859-1').xpath(xpath_all).map{|o| mapper.map(o)}
+      end
+
+      def find_by_name(name_expression)
+        # Not the best performing way, but it gives us the ability to use the  XPath 2.0 'matches' function
+        # which isn't supported in Nokogiri (yet).
+        Nokogiri::HTML(fetch(@url), nil, 'ISO-8859-1').xpath(xpath_finder(name_expression), Class.new{
+          def matches(node_set, regex)
+            node_set.find_all do |node|
+              node.to_s.match(%r{#{regex}})
+            end
+          end
+        }.new).map{|o| mapper.map(o)}
+      end
+
+      protected
+
+      def xpath_lookup(name)
+        "#{xpath_all}[#{name_attribute}/text() = '#{name.upcase}']"
+      end
+
+      def xpath_finder(regex)
+        "#{xpath_all}[matches(#{name_attribute}/text(), '#{regex}')]"
+      end
+
+      def fetch(url)
+        open(url).read
+      end
+
+      def name_attribute
+        'name'
+      end
+    end
+
+    class WaterwayProvider < Provider
+      def xpath_all
+        "//data/table/gewaesser"
+      end
+
+      def mapper
+        Wasserstand::PegelOnline::WaterwayMapper
+      end
+    end
+
+    class LevelProvider < Provider
+      def xpath_all
+        "//data/table/gewaesser/item"
+      end
+
+      def mapper
+        Wasserstand::PegelOnline::LevelMapper
+      end
+
+      def name_attribute
+        'pegelname'
+      end
     end
   end
 end

data/lib/wasserstand/provider/waterway_mapper.rb

@@ -0,0 +1,34 @@
+module Wasserstand
+  module PegelOnline
+=begin
+      <gewaesser>
+        <name>BODENSEE</name>
+        <item>
+          <no>8</no>
+          <psmgr>320</psmgr>
+          <pegelname>KONSTANZ</pegelname>
+          <messwert>380,7</messwert>
+          <km>0</km>
+          <pnp>391,89</pnp>
+          <tendenz>Gleich</tendenz>
+          <datum>13.09.2012</datum>
+          <uhrzeit>20:00:00</uhrzeit>
+          <pegelnummer>0906</pegelnummer>
+        </item>
+      </gewaesser>
+=end
+    class WaterwayMapper
+      class << self
+        def map(node)
+          Waterway.new(node.xpath('name').text).tap do |ww|
+            node.xpath('item').each do |item|
+              level = LevelMapper.map(item)
+              level.waterway = ww
+              ww.levels[level.name] = level
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/wasserstand/version.rb

@@ -1,3 +1,3 @@
 module Wasserstand
-  VERSION = "0.0.4"
+  VERSION = "0.0.5"
 end

data/lib/wasserstand/waterway.rb

@@ -1,8 +1,27 @@
 module Wasserstand
+  # http://stackoverflow.com/questions/2030336/how-do-i-create-a-hash-in-ruby-that-compares-strings-ignoring-case
+  class HashClod < Hash
+    def [](key)
+      key.respond_to?(:upcase) ? super(key.upcase) : super(key)
+    end
+
+    def []=(key, value)
+      key.respond_to?(:upcase) ? super(key.encode.upcase, value) : super(key, value)
+    end
+  end
+
   class Waterway
     class << self
       def [](name)
-        Wasserstand.provider[name]
+        Wasserstand.waterway_provider[name]
+      end
+
+      def all
+        Wasserstand.waterway_provider.all
+      end
+
+      def find_by_name(regex)
+        Wasserstand.waterway_provider.find_by_name(regex)
       end
     end
 
@@ -10,7 +29,11 @@ module Wasserstand
 
     def initialize(name)
       @name = name
-      @levels = {}
+      @levels = HashClod.new
+    end
+
+    def to_s
+      name
     end
   end
 end

data/test/helper.rb

@@ -1,2 +1,11 @@
 require 'minitest/autorun'
 require 'wasserstand'
+
+class WasserstandTestCase < MiniTest::Unit::TestCase
+  include Wasserstand
+
+  def setup
+    url = File.join(File.dirname(__FILE__), 'fixtures', 'pegelstaende_neu.xml')
+    Wasserstand.waterway_provider = PegelOnline::WaterwayProvider.new(url)
+  end
+end

data/test/unit/test_level.rb

@@ -0,0 +1,37 @@
+require 'helper'
+
+class TestLevel < WasserstandTestCase
+  def test_size
+    assert_equal(534, Level.all.size)
+  end
+
+  def test_kms
+    elbe_levels = Waterway['ELBE'].levels
+    assert_equal(60, elbe_levels.size)
+
+    assert_level({:name => 'PIRNA', :km => 34.67, :measurements_size => 1}, elbe_levels['PIRNA'])
+  end
+
+  def test_finder
+    assert_equal(['HEIDELBERG UW', 'HAVELBERG EP', 'HAVELBERG STADT', 'HAVELBERG UP'], Level.find_by_name('ELBERG').map{|w| w.name})
+    assert_equal(21, Level.find_by_name('^E').size)
+  end
+
+  def test_lookup
+    pirna = Level['Pirna']
+    assert(pirna)
+    assert(pirna.waterway)
+    assert_equal('ELBE', pirna.waterway.name)
+
+    assert(Level['GENTHIN'])
+  end
+
+  private
+
+  def assert_level(values, level)
+    assert(level)
+    assert_equal(values[:name], level.name)
+    assert_equal(values[:km], level.km)
+    assert_equal(values[:measurements_size], level.measurements.size)
+  end
+end

data/test/unit/test_measurement.rb

@@ -0,0 +1,11 @@
+require 'helper'
+
+class TestMeasurement < WasserstandTestCase
+  def test_single
+    konstanz_measurements = Waterway['BODENSEE'].levels['KONSTANZ'].measurements
+
+    assert_equal(Time.parse('2012-09-13 18:00:00 UTC'), konstanz_measurements.last.date)
+    assert_equal(380.7, konstanz_measurements.last.value)
+    assert_equal(:gleich, konstanz_measurements.last.trend)
+  end
+end

data/test/unit/test_waterway.rb

@@ -0,0 +1,21 @@
+require 'helper'
+
+class TestWaterway < WasserstandTestCase
+  def test_finder
+    assert_equal(['ELBE', 'ELBE-HAVEL-KANAL', 'ELBESEITENKANAL'], Waterway.find_by_name('ELB.*').map{|w| w.name})
+    assert_equal(7, Waterway.find_by_name('^E').size)
+  end
+
+  def test_size
+    assert_equal(77, Waterway.all.size)
+  end
+
+  def test_levels
+    assert_equal(1, Waterway['BODENSEE'].levels.size)
+  end
+
+  def test_lookup
+    assert(Waterway['Elbe'].levels['Pirna'])
+    assert(Waterway['ELBE-HAVEL-KANAL'].levels['GENTHIN'])
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: wasserstand
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-15 00:00:00.000000000 Z
+date: 2012-09-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: require_all
@@ -108,14 +108,17 @@ files:
 - bin/wasserstand
 - lib/wasserstand.rb
 - lib/wasserstand/level.rb
-- lib/wasserstand/mapper.rb
 - lib/wasserstand/measurement.rb
+- lib/wasserstand/provider/level_mapper.rb
 - lib/wasserstand/provider/pegel-online.rb
+- lib/wasserstand/provider/waterway_mapper.rb
 - lib/wasserstand/version.rb
 - lib/wasserstand/waterway.rb
 - test/fixtures/pegelstaende_neu.xml
 - test/helper.rb
-- test/unit/test_wasserstand.rb
+- test/unit/test_level.rb
+- test/unit/test_measurement.rb
+- test/unit/test_waterway.rb
 - wasserstand.gemspec
 homepage: http://github.com/nerab/wasserstand
 licenses: []
@@ -144,4 +147,6 @@ summary: Wasserstand auf deutschen Flüssen
 test_files:
 - test/fixtures/pegelstaende_neu.xml
 - test/helper.rb
-- test/unit/test_wasserstand.rb
+- test/unit/test_level.rb
+- test/unit/test_measurement.rb
+- test/unit/test_waterway.rb

data/lib/wasserstand/mapper.rb

@@ -1,43 +0,0 @@
-module Wasserstand
-=begin
-      <gewaesser>
-        <name>BODENSEE</name>
-        <item>
-          <no>8</no>
-          <psmgr>320</psmgr>
-          <pegelname>KONSTANZ</pegelname>
-          <messwert>380,7</messwert>
-          <km>0</km>
-          <pnp>391,89</pnp>
-          <tendenz>Gleich</tendenz>
-          <datum>13.09.2012</datum>
-          <uhrzeit>20:00:00</uhrzeit>
-          <pegelnummer>0906</pegelnummer>
-        </item>
-      </gewaesser>
-=end
-  class Mapper
-    class << self
-      def map(node)
-        Waterway.new(node.xpath('name').text) .tap do |ww|
-          node.xpath('item').each do |item|
-            pegel_name = item.xpath('pegelname').text
-            ww.levels[pegel_name] = Level.new(item.xpath('pegelnummer').text).tap do |pegel|
-              pegel.name = pegel_name
-              pegel.km = item.xpath('km').text
-
-              datum = item.xpath('datum').text
-              uhrzeit = item.xpath('uhrzeit').text
-
-              messdatum = TZInfo::Timezone.get('Europe/Berlin').local_to_utc(Time.parse("#{datum} #{uhrzeit}"))
-              wert = item.xpath('messwert').text.sub(',', '.').to_f
-              tendenz = item.xpath('tendenz').text.downcase.to_sym
-
-              pegel.measurements << Measurement.new(messdatum, wert, tendenz)
-            end
-          end
-        end
-      end
-    end
-  end
-end

data/test/unit/test_wasserstand.rb

@@ -1,31 +0,0 @@
-require 'helper'
-
-class TestWasserstand < MiniTest::Unit::TestCase
-  include Wasserstand
-
-  def setup
-    url = File.join(File.dirname(__FILE__), '..', 'fixtures', 'pegelstaende_neu.xml')
-    Wasserstand.provider = Provider::PegelOnline.new(url)
-  end
-
-  def test_plain
-    assert Waterway['BODENSEE']
-  end
-
-  def test_levels
-    assert_equal(1, Waterway['BODENSEE'].levels.size)
-  end
-
-  def test_level_lookup
-    assert(Waterway['BODENSEE'].levels['KONSTANZ'])
-    assert(Waterway['ELBE-HAVEL-KANAL'].levels['GENTHIN'])
-  end
-
-  def test_single_measurement
-    konstanz_measurements = Waterway['BODENSEE'].levels['KONSTANZ'].measurements
-
-    assert_equal(Time.parse('2012-09-13 18:00:00 UTC'), konstanz_measurements.last.date)
-    assert_equal(380.7, konstanz_measurements.last.value)
-    assert_equal(:gleich, konstanz_measurements.last.trend)
-  end
-end