rubyweather 1.1.1 → 1.1.2

data/README

@@ -27,8 +27,8 @@ directory:
 === Examples
 
 First, we need to find out the weather.com location code for your city.
-This will print out a list of locations and their codes matching the 
-string "Toronto":
+The following code will print out a list of locations and their codes 
+matching the string "Toronto":
 
   require 'rubygems'
   require_gem 'rubyweather'
@@ -83,10 +83,10 @@ There are a lot of attributes you can fetch for a forecast. Here are just a few:
 +latest_update+:: The datetime when the conditions were last measured/forecast.
 
 Additionally, most of the attributes for a given day in the raw weather.com xml data are
-also directly accessible. For example, you can call <tt>forecast.tomorrow.dewp</tt> to get the dewpoint, because the xml file
-contains a <tt>dewp</tt> element for that day. Have a look at <tt>test/test_weather.xml</tt> to see what data is
-available in the xml file. Note though that raw xml elements will be returned as a string, without any nice
-class casting or unit conversion.
+also directly accessible. For example, you can call <tt>forecast.tomorrow.dewp</tt> to get the dewpoint, because 
+the xml file contains a <tt>dewp</tt> element for that day. Have a look at <tt>test/test_weather.xml</tt> to see 
+what data is available in the xml file. Note though that raw xml element values will be returned as a string, \
+without any nice class casting or unit conversion.
 
 Other programmers are encouraged to add more functionality to the <tt>lib/forecast.rb</tt> module to provide better
 accessor methods for the underlying xml data. See below for how to obtain subversion access to contribute
@@ -95,8 +95,9 @@ your changes back to the project.
 === Caching Forecast Data
 
 RubyWeather supports data caching using the memcached[http://www.danga.com/memcached/] daemon. This allows for
-much quicker response time -- especially if you have a lot of clients accessing the weather data -- and is 
-just a polite thing to do in regards weather.com's servers.
+much quicker response time -- especially if you have a lot of clients accessing the weather data -- and it's 
+just a polite thing to do in regards to weather.com's servers.
+
 If you have a memcached server running, you can turn on data caching as follows:
 
   s = Weather::Service.new
@@ -108,8 +109,8 @@ From now on, any fetch_forecast calls made on this service will cache their data
 server will not be queried again as long as the data is cached.
 
 You can check if a forecast came from the cache by calling <tt>#from_cache?</tt>, which returns true if this
-forecast came from the local cache, or <tt>#cached_on</tt>, which returns the datetime when this forecast was
-entered into the cache or nil if the forecast didn't come from the cache.
+forecast came from the local cache. You can also call <tt>#cached_on</tt> to find out when this forecast was entered
+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:

data/lib/weather/forecast.rb

@@ -126,7 +126,6 @@ module Weather
       #   forecast.current.latest_update
       #   
       def latest_update
-        puts xml.root.to_s
         Time.parse(xml.root.elements['dayf'].elements['lsup'].text)
       end
       

data/lib/weather/service.rb

@@ -19,7 +19,7 @@ module Weather
     # 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)
       
-      days = 5 if days.nil? or days.empty?
+      days = 5 if days.nil? or days == 0 or days == ""
       
       # try to pull the partner_id and license_key from the environment if not already set
       partner_id = ENV['WEATHER_COM_PARTNER_ID'] unless partner_id
@@ -44,7 +44,6 @@ module Weather
       
       # default to metric (degrees fahrenheit are just silly :)
       unit = imperial ? "s" : "m"
-      puts "#{location_id} #{partner_id} #{license_key} DAYS: #{days.inspect}"
       host = "xoap.weather.com"
       url = "/weather/local/#{location_id}?cc=*&dayf=#{days}&prod=xoap&par=#{partner_id}&key=#{license_key}&unit=#{unit}"
       
@@ -62,7 +61,6 @@ module Weather
           cache.set("#{location_id}:#{days}", doc.to_s, cache_expiry)
         end
       end
-      puts xml
       doc = REXML::Document.new(xml)
 
       Forecast::Forecast.new(doc)

data/test/examples_test.rb

@@ -0,0 +1,71 @@
+#
+# Author::    Matt Zukowski  (http://blog.roughest.net)
+# Copyright:: Copyright (c) 2006 Urbacon Ltd.
+# License::   GNU Lesser General Public License v2.1 (LGPL 2.1)
+#
+# This test ensures that the examples in the README run without errors.
+#
+
+require 'test/unit'
+require File.dirname(__FILE__) + '/../lib/weather/service'
+
+if not ENV['WEATHER_COM_PARTNER_ID']
+  puts "WARNING: You should set the WEATHER_COM_PARTNER_ID env variable (i.e. export WEATHER_COM_PARTNER_ID=<your weather.com partner id>) before running this test."
+end
+
+if not ENV['WEATHER_COM_LICENSE_KEY']
+  puts "WARNING: You should set the WEATHER_COM_LICENSE_KEY env variable (i.e. export WEATHER_COM_LICENSE_KEY=<your weather.com license key>) before running this test."
+end
+
+class ServiceTest < Test::Unit::TestCase
+  TORONTO = "CAXX0504"
+  
+  # Note that for this test to work the WEATHER.COM_PARTNER_ID and WEATHER.COM_LICENSE_KEY
+  # environment variables must be set!
+  
+  def setup
+    @service = Weather::Service.new
+  end
+  
+  def test_find_location_example
+    assert_nothing_raised do
+      #require 'weather/service'
+  
+      service = Weather::Service.new
+      service.partner_id = ""
+      service.license_key = ""
+    
+      locations = service.find_location('Toronto')
+      "Matching Locations: " + locations.inspect
+    end
+  end
+  
+  def test_forecast_example
+    assert_nothing_raised do
+      forecast = @service.fetch_forecast("CAXX0504", 5)
+  
+      "Location: %s" % forecast.location_name
+    
+      "Current Temperature: %s" % forecast.current.temperature
+      "Current Windspeed: %s" % forecast.current.wind.speed
+    
+      "Tomorrow's High: %s" % forecast.tomorrow.high
+      "Tomorrow's Outlook: %s" % forecast.tomorrow.outlook
+      "Tomorrow's Wind Direction: %s" % forecast.tomorrow.wind.direction
+      
+      "High 3 days from now: %s" % forecast.day(3).high
+      "Probability of precipitation 4 days from now: %s" % forecast.day(4).pop
+      
+      "Probability of precipitation three nights from now: %s" % forecast.night(3).pop
+    end
+  end
+    
+  def test_caching_example
+    assert_nothing_raised do
+      s = Weather::Service.new
+      s.enable_cache
+      s.cache_expiry = 60  # cached data will expire after 60 seconds; if omitted, the default is 10 minutes
+      s.cache.servers = ['127.0.0.1:11211']
+    end
+  end
+end

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.9.0
 specification_version: 1
 name: rubyweather
 version: !ruby/object:Gem::Version 
-  version: 1.1.1
-date: 2006-07-28 00:00:00 -04:00
+  version: 1.1.2
+date: 2007-01-11 00:00:00 -05:00
 summary: Client library for accessing weather.com's xoap weather data.
 require_paths: 
 - lib
@@ -40,6 +40,7 @@ files:
 - test/service_test.rb
 - test/forecast_test.rb
 - test/profiler.rb
+- test/examples_test.rb
 - test/test_weather.xml
 - example/weather_portlet_controller.rb
 - example/weather_32
@@ -97,9 +98,10 @@ files:
 test_files: 
 - test/service_test.rb
 - test/forecast_test.rb
+- test/examples_test.rb
 rdoc_options: 
 - --title
-- RubyWeather 1.1.1 RDocs
+- RubyWeather 1.1.2 RDocs
 - --main
 - README
 - --line-numbers