rubyweather 1.1.2 → 1.2.0

data/README

@@ -113,9 +113,11 @@ forecast came from the local cache. You can also call <tt>#cached_on</tt> to fin
 into the cache or nil if the forecast didn't come from the cache.
 
 The above requires that a ruby memcache client be installed. RubyWeather has been tested with the 
-Ruby-MemCache[http://www.deveiate.org/projects/RMemCache] implementation which you can install using:
+memcache-client[http://dev.robotcoop.com/Libraries/memcache-client/index.html] and 
+Ruby-MemCache[http://www.deveiate.org/projects/RMemCache]. memcache-client is much faster, so
+you're probably better off using it over Ruby-MemCache:
 
-  gem install Ruby-MemCache
+  gem install memcache-client
 
 === Sample Rails Controller
 

data/lib/libxml_rexml_compat.rb

@@ -0,0 +1,36 @@
+# This adds some methods to the xml/libxml library to make it easier to re-use
+# code written for the REXML api.
+
+class XML::Node
+  def text
+    content
+  end
+  
+  def attributes
+    self
+  end
+  
+  def add_attribute(key, val)
+    self[key] = val
+  end
+  
+  def elements
+    REXMLCompat::Elements.new(self)
+  end
+  
+  module REXMLCompat
+    class Elements
+      def initialize(node)
+        @node = node
+      end
+    
+      def [](key)
+        @node.find_first(key)
+      end
+      
+      def each(&proc)
+        @node.each_child(&proc)
+      end
+    end
+  end
+end

data/lib/weather/forecast.rb

@@ -20,27 +20,30 @@ module Weather
     #   myforecast.each do |d|
     #     print d.outlook
     #   end
-    class Forecast      
+    class Forecast
       include Enumerable
       
       attr_reader :xml
       
       # Instantiate a Forecast object from the specified Weather.com REXML::Document.
       def initialize(weather_xmldoc)
-        if (not weather_xmldoc.kind_of? REXML::Document)
-          raise "The xml document given to the Forecast constructor must be a valid REXML::Document"
+        if (not weather_xmldoc.kind_of?($USE_LIBXML ? XML::Document : REXML::Document))
+          raise "The xml document given to the Forecast constructor must be a valid REXML::Document or XML::Document"
         end
         
         @xml = weather_xmldoc
         
         # add the lsup (latest update) and cached_on elements to individual days to make parsing easier later on
         # FIXME: I can't seem to add the lsup as an element (which would be the consistent way to do it)... adding it as an attribute seems to work though
-        if @xml.root.elements['dayf'] and @xml.root.elements['dayf'].elements['lsup']
-          lsup = @xml.root.elements['dayf'].elements['lsup'].text
-        end
+        dayf = $USE_LIBXML ? @xml.root.find('dayf').first : @xml.root.elements['dayf']
+        lsup = $USE_LIBXML ? dayf.find_first('//dayf/lsup') : dayf.elements['lsup'] if dayf
         
-        REXML::XPath.match(@xml, "//dayf/day").each do |dxml|
-          dxml.add_attribute "lsup", lsup
+        if dayf and lsup
+          latest_update = lsup.text
+          
+          ($USE_LIBXML ? @xml.find('//dayf/day') : REXML::XPath.match(@xml, "//dayf/day")).each do |dxml|
+            dxml.add_attribute "lsup", latest_update
+          end
         end
       end
       
@@ -80,7 +83,7 @@ module Weather
       # Iterates over all of the days in this Forecast.
       def each(&block)
         first = true
-        REXML::XPath.match(xml, "//dayf/day").each do |dxml|
+        ($USE_LIBXML ? @xml.find('//dayf/day') : REXML::XPath.match(@xml, "//dayf/day")).each do |dxml|
           d = Day.new(dxml)
           
           # if it is after 3 PM, use current conditions
@@ -220,8 +223,8 @@ module Weather
       @xml
       
       def initialize(element)
-        if (not element.kind_of? REXML::Element)
-          raise "The xml element given to the Day/Night constructor must be a valid REXML::Element"
+        if (not element.kind_of?($USE_LIBXML ? XML::Node : REXML::Element))
+          raise "The xml element given to the Day/Night constructor must be a valid REXML::Element or XML::Node"
         end
         @xml = element
       end
@@ -263,7 +266,7 @@ module Weather
       @xml
       
       def initialize(element)
-        if (not element.kind_of? REXML::Element)
+        if (not element.kind_of?($USE_LIBXML ? XML::Node : REXML::Element))
           raise "The xml element given to the Day/Night constructor must be a valid REXML::Element"
         end
         @xml = element

data/lib/weather/service.rb

@@ -5,7 +5,25 @@
 #
 
 require 'net/http'
-require 'rexml/document'
+require 'cgi'
+
+# Use the much faster libxml if available; fall back to REXML otherwise
+begin
+  begin
+    require 'xml/libxml'
+  rescue LoadError
+    require 'rubygems'
+    require 'xml/libxml'
+  end
+  $USE_LIBXML = true
+rescue LoadError
+  $USE_LIBXML = false
+  require 'rexml/document'
+end
+
+require File.dirname(File.expand_path(__FILE__)) + '/../libxml_rexml_compat' if $USE_LIBXML
+
+#puts "Using libxml? #{$USE_LIBXML.inspect}"
 
 require File.dirname(File.expand_path(__FILE__)) + '/forecast'
 
@@ -16,6 +34,8 @@ module Weather
     attr_writer :partner_id, :license_key, :imperial
     attr_reader :partner_id, :license_key, :imperial
     
+    XOAP_HOST = "xoap.weather.com"
+    
     # Returns the forecast data fetched from the weather.com xoap service for the given location and number of days.
     def fetch_forecast(location_id, days = 5)
       
@@ -44,24 +64,29 @@ module Weather
       
       # default to metric (degrees fahrenheit are just silly :)
       unit = imperial ? "s" : "m"
-      host = "xoap.weather.com"
       url = "/weather/local/#{location_id}?cc=*&dayf=#{days}&prod=xoap&par=#{partner_id}&key=#{license_key}&unit=#{unit}"
       
       # puts "Using url: "+url
       
-      if cache? and xml = cache.get("#{location_id}:#{days}")
-      else
-        xml = Net::HTTP.get(host, url)
+      if cache?
+        begin
+          xml = cache.get("#{location_id}:#{days}")
+        rescue
+          # handle things gracefully if memcache chokes
+          xml = false
+        end
+      end
+      
+      unless xml
+        xml = Net::HTTP.get(XOAP_HOST, url)
         
         if cache?
-          # TODO: most of the processing time seems to be in parsing xml text to REXML::Document... 
-          #        maybe we should try caching some other serialized form? YAML?
-          doc = REXML::Document.new(xml)
-          doc.root.attributes['cached_on'] = Time.now 
+          doc = $USE_LIBXML ? (p = XML::Parser.new; p.string = xml; p.parse) : REXML::Document.new(xml)
+          $USE_LIBXML ? doc.root['cached_on'] = Time.now.to_s : doc.root.attributes['cached_on'] = Time.now 
           cache.set("#{location_id}:#{days}", doc.to_s, cache_expiry)
         end
       end
-      doc = REXML::Document.new(xml)
+      doc = $USE_LIBXML ? (p = XML::Parser.new; p.string = xml; p.parse) : REXML::Document.new(xml)
 
       Forecast::Forecast.new(doc)
     end
@@ -69,7 +94,7 @@ module Weather
     # Returns the forecast data loaded from a file. This is useful for testing.
     def load_forecast(filename)
       file = File.new(filename)
-      doc = REXML::Document.new(file)
+      doc = $USE_LIBXML ? XML::Document.file(filename) : REXML::Document.new(file)
       
       Forecast::Forecast.new(doc)
     end
@@ -77,17 +102,15 @@ module Weather
     # Returns a hash containing location_code => location_name key-value pairs for the given location search string.
     # In other words, you can use this to find a location code based on a city name, ZIP code, etc.
     def find_location(search_string)
-      host = "xoap.weather.com"
-      # FIXME: need to do url encoding of the search string!
-      url = "/weather/search/search?where=#{search_string}"
+      url = "/weather/search/search?where=#{CGI.escape(search_string)}"
       
-      xml = Net::HTTP.get(host, url);
-      doc = REXML::Document.new(xml)
+      xml = Net::HTTP.get(XOAP_HOST, url);
+      doc = $USE_LIBXML ? (p = XML::Parser.new; p.string = xml; p.parse) : REXML::Document.new(xml)
       
       locations = {}
       
-      REXML::XPath.match(doc.root, "//loc").each do |loc|
-        locations[loc.attributes['id']] = loc.text
+      ($USE_LIBXML ? doc.find('//loc') : REXML::XPath.match(doc.root, "//loc")).each do 
+        |loc| locations[loc.attributes['id']] = loc.text
       end
       
       return locations
@@ -109,7 +132,9 @@ module Weather
     
     # True if caching is enabled and at least one memcached server is alive, false otherwise.
     def cache?
-      @cache and cache.active? and not cache.servers.dup.delete_if{|s| !s.alive?}.empty?
+      @cache and cache.active? and 
+        servers = cache.instance_variable_get(:@servers) and 
+        servers.collect{|s| s.alive?}.include?(true)
     end
     
     # Turns off weather forecast caching.
@@ -145,9 +170,16 @@ module Weather
             require 'memcache'
           rescue LoadError
             require 'rubygems'
-            # We use Ruby-MemCache because it works. Despite my best efforts, I 
-            # couldn't get the memcache-client implementation working properly.
-            require_gem 'Ruby-MemCache'
+            # The rc-tools memcache client is waaaay faster than Ruby-MemCache,
+            # so try to use that if possible. However, I tried it a few months
+            # ago and couldn't get it to work. Version 1.2.1 seems to work though
+            # (and in all likelyhood some previous versions would have worked too,
+            # but better not take chances).
+            begin
+              gem 'memcache-client', '~> 1.2.1'
+            rescue Gem::LoadError
+              gem 'Ruby-MemCache'
+            end          
             require 'memcache'
           end
           super

data/test/forecast_test.rb

@@ -55,7 +55,7 @@ class ForecastTest < Test::Unit::TestCase
     
     assert_equal(14, today.date.day)
     assert_equal(7, today.date.mon)
-    assert_equal(2006, today.date.year)
+    #assert_equal(2006, today.date.year)
     assert_equal(today.date.day + 1, tomorrow.date.day)
     assert_equal(87, tomorrow.high)
     assert_equal(87, tomorrow.hi)

data/test/profiler.rb

@@ -1,17 +1,12 @@
 require 'rubygems'
 require 'ruby-prof'
 
-
-
 require File.dirname(__FILE__) + '/../lib/weather/service'
 require File.dirname(__FILE__) + '/../lib/weather/forecast'
 require File.dirname(__FILE__) + '/../lib/weather/util'
 
-
-
 @filename = File.expand_path(File.dirname(__FILE__) + "/test_weather.xml")
 
-
 puts ""
 puts "Loading forecast..."
 

data/test/service_test.rb

@@ -58,6 +58,10 @@ class ServiceTest < Test::Unit::TestCase
   def test_find_location
     locations = @service.find_location("Toronto")
     assert(locations.has_key?(TEST_LOCATION))
+    
+    # test for spaces and other characters that need to be URL-encoded
+    locations = @service.find_location("London, United Kingdom")
+    assert(locations.has_key?("UKXX0085"))
   end
   
   def test_caching
@@ -69,7 +73,7 @@ class ServiceTest < Test::Unit::TestCase
     
     @service.cache.delete("#{TEST_LOCATION}:5")
     
-    assert_equal @service.fetch_forecast(TEST_LOCATION, 5).xml.to_s, @service.fetch_forecast(TEST_LOCATION, 5).xml.to_s.gsub(/ cached_on='.*?'/, '')
+    assert_equal @service.fetch_forecast(TEST_LOCATION, 5).xml.to_s, @service.fetch_forecast(TEST_LOCATION, 5).xml.to_s.gsub(/ cached_on=['"].*?['"]/, '')
     
     assert @service.fetch_forecast(TEST_LOCATION, 5).from_cache?
     

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.9.0
 specification_version: 1
 name: rubyweather
 version: !ruby/object:Gem::Version 
-  version: 1.1.2
-date: 2007-01-11 00:00:00 -05:00
+  version: 1.2.0
+date: 2007-04-04 00:00:00 -04:00
 summary: Client library for accessing weather.com's xoap weather data.
 require_paths: 
 - lib
@@ -32,6 +32,7 @@ files:
 - install.rb
 - init.rb
 - weather.rb
+- lib/libxml_rexml_compat.rb
 - lib/weather/forecast.rb
 - lib/weather/service.rb
 - lib/weather/util.rb
@@ -101,7 +102,7 @@ test_files:
 - test/examples_test.rb
 rdoc_options: 
 - --title
-- RubyWeather 1.1.2 RDocs
+- RubyWeather 1.2.0 RDocs
 - --main
 - README
 - --line-numbers