rubyweather 0.9.1 → 1.0.0

data/README

@@ -8,87 +8,94 @@ License::   GNU Lesser General Public License v2.1 (LGPL 2.1)
 
 Simple usage example:
 
-require 'rubygems'
-require_gem 'rubyweather'
+  require 'rubygems'
+  require_gem 'rubyweather'
 
-require 'weather'
+  require 'weather/service'
 
-service = Weather::Service.new
-service.partner_id = <b>your partner id</b>
-service.license_key = <b>your license key</b>
+  service = Weather::Service.new
+  service.partner_id = <b>your partner id</b>
+  service.license_key = <b>your license key</b>
 
-locations = service.find_location('Toronto')
-puts "Matching Locations: " + locations.inspect
+  locations = service.find_location('Toronto')
+  puts "Matching Locations: " + locations.inspect
 
 The above will print out a list of available locations and their codes. We can
 now use these codes to fetch the weather data for our city:
 
-forecast = service.fetch_forecast("CAXX0504", 5)
+  forecast = service.fetch_forecast("CAXX0504", 5)
 
-puts "Location: %s" % forecast.location_name
+  puts "Location: %s" % forecast.location_name
 
-puts "Current Temperature: %s" % forecast.current.temperature
-puts "Current Windspeed: %s" % forecast.current.wind.speed
+  puts "Current Temperature: %s" % forecast.current.temperature
+  puts "Current Windspeed: %s" % forecast.current.wind.speed
 
-puts "Tomorrow's High: %s" % forecast.tomorrow.high
-puts "Tomorrow's Outlook: %s" % forecast.tomorrow.outlook
-puts "Tomorrow's Wind Direction: %s" % forecast.tomorrow.wind.direction
+  puts "Tomorrow's High: %s" % forecast.tomorrow.high
+  puts "Tomorrow's Outlook: %s" % forecast.tomorrow.outlook
+  puts "Tomorrow's Wind Direction: %s" % forecast.tomorrow.wind.direction
 
 Forecasts for days in the future are accessed via <tt>forecast.day(#)</tt> where <tt>#</tt> is the number of day sinto the future
 (assuming that you've fetched data for as many days in your <tt>service.fetch_forecast</tt> request):
 
-puts "High 3 days from now: %s" % forecast.day(3).high
-puts "Probability of precipitation 4 days from now: %s" % forecast.day(4).pop
+  puts "High 3 days from now: %s" % forecast.day(3).high
+  puts "Probability of precipitation 4 days from now: %s" % forecast.day(4).pop
 
 There are a lot of attributes you can fetch for a forecast day. Here are just a few:
 
-<tt>temp</tt>, <tt>temperature</tt>, <tt>temp</tt>::
-The temperature. For future days this is equivalent to the low for nighttime and high for daytime.
-<tt>icon</tt>::
-The number of the icon gif file from the weather.com SDK[http://www.weather.com/services/xmloap.html] that
-identifies the conditions (e.g. a little icon of a cloud with rain, or sun, or whatever).
-<tt>outlook</tt>, <tt>outlook_brief</tt>::
-Brief text describing the conditions (e.g. "Mostly Cloudy", "Rain", "Scattered T-Storms"). An abbreviated
-version is available in <tt>outlook_brief</tt> (e.g. "M Cloudy", "Scat T-Storms").
-<tt>low</tt>, <tt>lo</tt>::
-The forecasted low temperature. (Not available for current conditions)
-<tt>high</tt>, <tt>hi</tt>::
-The forecasted high temperature. (Not available for current conditions)
-<tt>wind</tt>, <tt>wind.direction</tt>, <tt>wind.speed</tt>, <tt>wind.heading</tt>::
-Wind conditions. The <tt>wind</tt> attribute returns an object with sub-attributes.
-<tt>pop</tt>, <tt>ppcp</tt>::
-Probability of precipitation.
-<tt>date</tt>::
-The date that this forecast is for, returned as a ruby Time object.
-<tt>sunrise</tt>::
-The time of sunrise on the day of the forecast.
-<tt>sunset</tt>::
-The time of sunset on the day of the forecast.
-
-Additionally, all (or at least most) of the attributes for a given day in the raw weather.com xml data are
-also available. For example, you can call forecast.tomorrow.dewp to get the dewpoint, because the xml file
++temp+, +temperature+:: The temperature. For future days this is equivalent to the low for nighttime, and high for daytime.
++icon+:: The number of the icon gif file from the weather.com SDK[http://www.weather.com/services/xmloap.html] that
+         identifies the conditions (e.g. a little icon of a cloud with rain, or sun, or whatever).
++outlook+::       Brief text describing the conditions (e.g. "Mostly Cloudy", "Rain", "Scattered T-Storms").
++outlook_brief+:: An abbreviated version of +outlook+ (e.g. "M Cloudy", "Scat T-Storms").
++low+, +lo+::     The forecasted low temperature. (Not available for current conditions)
++high+, +hi+::    The forecasted high temperature. (Not available for current conditions)
++wind+::          Wind conditions. The <tt>wind</tt> attribute returns an object with sub-attributes that can be
+                  addressed like <tt>wind.direction</tt>, <tt>wind.speed</tt>, <tt>wind.heading</tt>, etc.
++pop+, +ppcp+::   Probability of precipitation.
++date+::          The date that this forecast is for, returned as a ruby Time object.
++sunrise+::       The time of sunrise on the day of the forecast.
++sunset+::        The time of sunset on the day of the forecast.
++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 forecast.tomorrow.dewp to get the dewpoint, because the xml file
 contains a <tt>dewp</tt> element for that day. Have a look at #test/test_weather.xml 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.
 
-I encourage other programmers to add more functionality to the lib/forecast.rb module to provide better
-accessor methods for the underlying xml data.
+Other programmers are encouraged to add more functionality to the lib/forecast.rb module to provide better
+accessor methods for the underlying xml data. See below for how to obtain subversion access to contribute
+your changes back to the project.
 
 == Download
 
 You can download the latest stable version of RubyWeather from http://rubyforge.org/projects/rubyweather/.
-Alternatively, the files <em>may</em> be available from http://roughest.net/rubyweather (but no promises -- the 
-rubyforge site is a better bet).
 
-You can also check out the latest copy via subversion from svn://rubyforge.org//var/svn/rubyweather/trunk. If you would
-like to contribute back your changes to the code, please contact me via the rubyforge project site to obtain a subversion
-account.
+You can also check out the latest copy via subversion from svn://rubyforge.org//var/svn/rubyweather/trunk.
+If you would like to contribute back your changes to the code, please contact me via the rubyforge project 
+site to obtain a subversion account.
 
-== Note
+RubyWeather can also be installed as a Rails plugin using the following command from your Rails application's
+directory:
+
+  ./script/plugin install -x svn://rubyforge.org//var/svn/rubyweather/trunk
+
+== Sample Rails Controller
+
+In the <tt>example</tt> directory you will find a sample Rails controller that uses RubyWeather to show
+a simple weather forecast. To try this out:
+
+1. Copy the controller into your Rails app's <tt>app/controllers/</tt>.
+2. Copy the <tt>forecast.rhtml</tt> template into <tt>apps/view/weather_portlet/</tt>
+3. Copy <tt>weather_32</tt> into <tt>public/images/</tt>.
+
+Fire up your Rails server, and go to <tt>/weather_portlet/forecast</tt> to see the controller in action.
+
+== Note About Weather.com Licensing & Registration
 
 To use this library you will need a partner id and license key from
 weather.com. The service is completely free, but requires that you agree
-to weather.com's legal stuff, which, among other things, requires your software
+to weather.com's legal stuff, which, among other things, asks that your software
 to include a link back to the weather.com website (although this is not actually
 enforced in any way by the service).
 
@@ -96,7 +103,13 @@ To obtain the free license visit http://www.weather.com/services/xmloap.html.
 This will also allow you to download an SDK that includes nice weather icons for
 use with the data.
 
-== License
+Note that weather.com doesn't seem to be enforcing the partner id/license key at this time.
+You can specify any value for partner id and license key (e.g. par=123456&key=abcdefg) and
+the weather.com service will happily accept it (in fact, you can even leave both fields blank,
+i.e. part=&key=). However, this is probably unintentional and subject to change, so it is
+highly recommended that you obtain a valid id and key.
+
+== Software License
 
 This program is free software; you can redistribute it and/or modify
 it under the terms of the GNU General Public License as published by

data/example/forecast.rhtml

@@ -0,0 +1,26 @@
+
+<table>
+    <thead>
+		<tr>
+			<% for d in @forecasts.first -%>
+			<th><%= d.date.strftime('%a') %></th>
+			<% end -%>
+		</tr>
+    </thead>
+    <tbody>
+		<% for f in @forecasts -%>
+		<tr>
+            <th colspan="<%= f.entries.size %>"><%= f.location_city %></th>
+            <!-- LATEST UPDATE: <%= f.latest_update %> -->
+		</tr>
+		<tr>
+			<% for d in f -%>
+			<td>
+			    <%= image_tag("weather_32/"+d.icon.to_s+".png", {:alt => d.outlook, :title => outlook_tooltip(d)}) %>
+			    <br /><%= d.temp.nil? ? "N/A" : d.temp.to_s+"&deg;" %>
+			</td>
+			<% end -%>
+		</tr>
+		<% end -%>
+	</tbody>
+</table>

data/example/weather_32/WS_FTP.LOG

@@ -0,0 +1,49 @@
+2005.11.14 11:00 B U:\cq's\14773\wx_icons32x32\0.png <-- ftp.twc.weather.com /Server HD/Web Folder/wx_icons_pngs/wx_icons32x32 0.png
+2005.11.14 11:00 B U:\cq's\14773\wx_icons32x32\1.png <-- ftp.twc.weather.com /Server HD/Web Folder/wx_icons_pngs/wx_icons32x32 1.png
+2005.11.14 11:00 B U:\cq's\14773\wx_icons32x32\10.png <-- ftp.twc.weather.com /Server HD/Web Folder/wx_icons_pngs/wx_icons32x32 10.png
+2005.11.14 11:00 B U:\cq's\14773\wx_icons32x32\11.png <-- ftp.twc.weather.com /Server HD/Web Folder/wx_icons_pngs/wx_icons32x32 11.png
+2005.11.14 11:00 B U:\cq's\14773\wx_icons32x32\12.png <-- ftp.twc.weather.com /Server HD/Web Folder/wx_icons_pngs/wx_icons32x32 12.png
+2005.11.14 11:00 B U:\cq's\14773\wx_icons32x32\13.png <-- ftp.twc.weather.com /Server HD/Web Folder/wx_icons_pngs/wx_icons32x32 13.png
+2005.11.14 11:00 B U:\cq's\14773\wx_icons32x32\14.png <-- ftp.twc.weather.com /Server HD/Web Folder/wx_icons_pngs/wx_icons32x32 14.png
+2005.11.14 11:00 B U:\cq's\14773\wx_icons32x32\15.png <-- ftp.twc.weather.com /Server HD/Web Folder/wx_icons_pngs/wx_icons32x32 15.png
+2005.11.14 11:00 B U:\cq's\14773\wx_icons32x32\16.png <-- ftp.twc.weather.com /Server HD/Web Folder/wx_icons_pngs/wx_icons32x32 16.png
+2005.11.14 11:00 B U:\cq's\14773\wx_icons32x32\17.png <-- ftp.twc.weather.com /Server HD/Web Folder/wx_icons_pngs/wx_icons32x32 17.png
+2005.11.14 11:00 B U:\cq's\14773\wx_icons32x32\18.png <-- ftp.twc.weather.com /Server HD/Web Folder/wx_icons_pngs/wx_icons32x32 18.png
+2005.11.14 11:00 B U:\cq's\14773\wx_icons32x32\19.png <-- ftp.twc.weather.com /Server HD/Web Folder/wx_icons_pngs/wx_icons32x32 19.png
+2005.11.14 11:00 B U:\cq's\14773\wx_icons32x32\2.png <-- ftp.twc.weather.com /Server HD/Web Folder/wx_icons_pngs/wx_icons32x32 2.png
+2005.11.14 11:00 B U:\cq's\14773\wx_icons32x32\20.png <-- ftp.twc.weather.com /Server HD/Web Folder/wx_icons_pngs/wx_icons32x32 20.png
+2005.11.14 11:00 B U:\cq's\14773\wx_icons32x32\21.png <-- ftp.twc.weather.com /Server HD/Web Folder/wx_icons_pngs/wx_icons32x32 21.png
+2005.11.14 11:00 B U:\cq's\14773\wx_icons32x32\22.png <-- ftp.twc.weather.com /Server HD/Web Folder/wx_icons_pngs/wx_icons32x32 22.png
+2005.11.14 11:00 B U:\cq's\14773\wx_icons32x32\23.png <-- ftp.twc.weather.com /Server HD/Web Folder/wx_icons_pngs/wx_icons32x32 23.png
+2005.11.14 11:00 B U:\cq's\14773\wx_icons32x32\24.png <-- ftp.twc.weather.com /Server HD/Web Folder/wx_icons_pngs/wx_icons32x32 24.png
+2005.11.14 11:00 B U:\cq's\14773\wx_icons32x32\25.png <-- ftp.twc.weather.com /Server HD/Web Folder/wx_icons_pngs/wx_icons32x32 25.png
+2005.11.14 11:00 B U:\cq's\14773\wx_icons32x32\26.png <-- ftp.twc.weather.com /Server HD/Web Folder/wx_icons_pngs/wx_icons32x32 26.png
+2005.11.14 11:00 B U:\cq's\14773\wx_icons32x32\27.png <-- ftp.twc.weather.com /Server HD/Web Folder/wx_icons_pngs/wx_icons32x32 27.png
+2005.11.14 11:00 B U:\cq's\14773\wx_icons32x32\28.png <-- ftp.twc.weather.com /Server HD/Web Folder/wx_icons_pngs/wx_icons32x32 28.png
+2005.11.14 11:00 B U:\cq's\14773\wx_icons32x32\29.png <-- ftp.twc.weather.com /Server HD/Web Folder/wx_icons_pngs/wx_icons32x32 29.png
+2005.11.14 11:00 B U:\cq's\14773\wx_icons32x32\3.png <-- ftp.twc.weather.com /Server HD/Web Folder/wx_icons_pngs/wx_icons32x32 3.png
+2005.11.14 11:00 B U:\cq's\14773\wx_icons32x32\30.png <-- ftp.twc.weather.com /Server HD/Web Folder/wx_icons_pngs/wx_icons32x32 30.png
+2005.11.14 11:00 B U:\cq's\14773\wx_icons32x32\31.png <-- ftp.twc.weather.com /Server HD/Web Folder/wx_icons_pngs/wx_icons32x32 31.png
+2005.11.14 11:00 B U:\cq's\14773\wx_icons32x32\32.png <-- ftp.twc.weather.com /Server HD/Web Folder/wx_icons_pngs/wx_icons32x32 32.png
+2005.11.14 11:00 B U:\cq's\14773\wx_icons32x32\33.png <-- ftp.twc.weather.com /Server HD/Web Folder/wx_icons_pngs/wx_icons32x32 33.png
+2005.11.14 11:00 B U:\cq's\14773\wx_icons32x32\34.png <-- ftp.twc.weather.com /Server HD/Web Folder/wx_icons_pngs/wx_icons32x32 34.png
+2005.11.14 11:00 B U:\cq's\14773\wx_icons32x32\35.png <-- ftp.twc.weather.com /Server HD/Web Folder/wx_icons_pngs/wx_icons32x32 35.png
+2005.11.14 11:00 B U:\cq's\14773\wx_icons32x32\36.png <-- ftp.twc.weather.com /Server HD/Web Folder/wx_icons_pngs/wx_icons32x32 36.png
+2005.11.14 11:00 B U:\cq's\14773\wx_icons32x32\37.png <-- ftp.twc.weather.com /Server HD/Web Folder/wx_icons_pngs/wx_icons32x32 37.png
+2005.11.14 11:00 B U:\cq's\14773\wx_icons32x32\38.png <-- ftp.twc.weather.com /Server HD/Web Folder/wx_icons_pngs/wx_icons32x32 38.png
+2005.11.14 11:00 B U:\cq's\14773\wx_icons32x32\39.png <-- ftp.twc.weather.com /Server HD/Web Folder/wx_icons_pngs/wx_icons32x32 39.png
+2005.11.14 11:00 B U:\cq's\14773\wx_icons32x32\4.png <-- ftp.twc.weather.com /Server HD/Web Folder/wx_icons_pngs/wx_icons32x32 4.png
+2005.11.14 11:00 B U:\cq's\14773\wx_icons32x32\40.png <-- ftp.twc.weather.com /Server HD/Web Folder/wx_icons_pngs/wx_icons32x32 40.png
+2005.11.14 11:00 B U:\cq's\14773\wx_icons32x32\41.png <-- ftp.twc.weather.com /Server HD/Web Folder/wx_icons_pngs/wx_icons32x32 41.png
+2005.11.14 11:00 B U:\cq's\14773\wx_icons32x32\42.png <-- ftp.twc.weather.com /Server HD/Web Folder/wx_icons_pngs/wx_icons32x32 42.png
+2005.11.14 11:00 B U:\cq's\14773\wx_icons32x32\43.png <-- ftp.twc.weather.com /Server HD/Web Folder/wx_icons_pngs/wx_icons32x32 43.png
+2005.11.14 11:00 B U:\cq's\14773\wx_icons32x32\44.png <-- ftp.twc.weather.com /Server HD/Web Folder/wx_icons_pngs/wx_icons32x32 44.png
+2005.11.14 11:00 B U:\cq's\14773\wx_icons32x32\45.png <-- ftp.twc.weather.com /Server HD/Web Folder/wx_icons_pngs/wx_icons32x32 45.png
+2005.11.14 11:00 B U:\cq's\14773\wx_icons32x32\46.png <-- ftp.twc.weather.com /Server HD/Web Folder/wx_icons_pngs/wx_icons32x32 46.png
+2005.11.14 11:00 B U:\cq's\14773\wx_icons32x32\47.png <-- ftp.twc.weather.com /Server HD/Web Folder/wx_icons_pngs/wx_icons32x32 47.png
+2005.11.14 11:00 B U:\cq's\14773\wx_icons32x32\5.png <-- ftp.twc.weather.com /Server HD/Web Folder/wx_icons_pngs/wx_icons32x32 5.png
+2005.11.14 11:00 B U:\cq's\14773\wx_icons32x32\6.png <-- ftp.twc.weather.com /Server HD/Web Folder/wx_icons_pngs/wx_icons32x32 6.png
+2005.11.14 11:00 B U:\cq's\14773\wx_icons32x32\7.png <-- ftp.twc.weather.com /Server HD/Web Folder/wx_icons_pngs/wx_icons32x32 7.png
+2005.11.14 11:00 B U:\cq's\14773\wx_icons32x32\8.png <-- ftp.twc.weather.com /Server HD/Web Folder/wx_icons_pngs/wx_icons32x32 8.png
+2005.11.14 11:00 B U:\cq's\14773\wx_icons32x32\9.png <-- ftp.twc.weather.com /Server HD/Web Folder/wx_icons_pngs/wx_icons32x32 9.png
+2005.11.14 11:00 B U:\cq's\14773\wx_icons32x32\na.png <-- ftp.twc.weather.com /Server HD/Web Folder/wx_icons_pngs/wx_icons32x32 na.png

data/example/weather_portlet_controller.rb

@@ -0,0 +1,49 @@
+require 'portlet_controller'
+require_gem 'rubyweather'
+require 'weather/service'
+
+# Simple Rails controller that shows the weather forecast.
+class WeatherPortletController < ActionController::Base
+
+  configurable
+
+  def rescue_action_in_public(exception)
+    render :text => <<ERROR
+      <em>Sorry, this portlet is temporarily out of service.</em>
+      
+      <!--
+        ERROR: #{exception.message}
+          #{exception.backtrace.join("\n\t\t\t")}
+      -->
+ERROR
+  end
+
+  def forecast
+    if params['locations'] and params['locations'].is_array? and params['locations'].length > 0
+      locations = params['locations']
+    else
+      locations = ["CAXX0504", "CAXX0301", "CAXX0054"]
+    end
+ 
+    days = params['days'] || 5
+
+    @forecasts = []
+    
+    service = Weather::Service.new
+    locations.each do |loc|
+      @forecasts << service.fetch_forecast(loc, days)
+    end
+  end
+  
+  # Normally this would go in the weather_portlet_helper, but to reduce the number of files in this example it is included.
+  def outlook_tooltip(d)
+    tooltip = d.outlook.to_s
+    tooltip += ", PoP: "+d.pop.to_s+"%" if (not d.pop.nil?)
+    
+    return tooltip
+  end
+  helper_method :outlook_tooltip
+  hidden_actions :outlook_tooltip
+  
+end
+

data/init.rb

@@ -0,0 +1,3 @@
+require File.dirname(File.expand_path(__FILE__)) + '/lib/weather/util'
+require File.dirname(File.expand_path(__FILE__)) + '/lib/weather/service'
+require File.dirname(File.expand_path(__FILE__)) + '/lib/weather/forecast'

data/lib/{forecast.rb → weather/forecast.rb}

@@ -4,7 +4,8 @@
 # License::   GNU Lesser General Public License v2.1 (LGPL 2.1)
 #
 
-require File.dirname(__FILE__) + '/util'
+require 'time'
+require File.dirname(File.expand_path(__FILE__)) + '/util'
 
 module Weather
 
@@ -27,9 +28,16 @@ module Weather
         end
         
         @xml = weather_xmldoc
+        
+        # add the lsup (latest update) element 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
+        lsup = @xml.root.elements['dayf'].elements['lsup'].text
+        REXML::XPath.match(@xml, "//dayf/day").each do |dxml|
+          dxml.add_attribute "lsup", lsup
+        end
       end
       
-      # Returns the current conditions as a Conditions object.
+      # The current conditions as a Conditions object.
       def current
         CurrentConditions.new(xml.root.elements['cc'])
       end
@@ -39,7 +47,7 @@ module Weather
         day(1)
       end
       
-      # Returns the conditions for the given day (0 = today, 1 = tomorrow, etc.)
+      # The conditions for the given day (0 = today, 1 = tomorrow, etc.)
       # The maximum day number depends on the data available in the xml that was used to create this Forecast.
       def day(num)
         element = xml.root.elements['dayf'].elements["day[@d='#{num.to_s}']"]
@@ -55,7 +63,7 @@ module Weather
         end
       end
       
-      # Returns the conditions for the given night (0 = tonight, 1 = tomorrow night, etc.)
+      # The conditions for the given night (0 = tonight, 1 = tomorrow night, etc.)
       # The maximum day number depends on the data available in the xml that was used to create this Forecast.
       def night(num)
         element = xml.root.elements['dayf'].elements["day[@d='#{num.to_s}']"]
@@ -79,12 +87,12 @@ module Weather
         end
       end
       
-      # Returns the full human-readable name of the place that this Forecast is for.
+      # The full human-readable name of the place that this Forecast is for.
       def location_name
         xml.root.elements['loc'].elements['dnam'].text
       end
       
-      # Returns the name of the city that this Forecast is for.
+      # The name of the city that this Forecast is for.
       def location_city
         xml.root.elements['loc'].elements['dnam'].text.split(",").first
       end
@@ -94,10 +102,25 @@ module Weather
         xml.root.elements['loc'].attributes['id']
       end
       
-      # Returns true if the units returned by this Forecast will be in the metric system (i.e. Celcius).
+      # True if the units returned by this Forecast will be in the metric system (i.e. Celcius).
       def metric?              
         xml.root.elements['head'].elements['ut'].text == "C"
       end
+      
+      # The date and time when the conditions were last measured/forecast.
+      # Returned as a Time object.
+      # 
+      # Note that this is a bit misleading, because the Forecast actually contains
+      # two "latest update" times -- one for the current conditions and the other
+      # for the future forecast. This method will return the latest update time
+      # of the <em>future forecast</em>. If you want the latest update time of the current
+      # conditions, you should do:
+      # 
+      #   forecast.current.latest_update
+      #   
+      def latest_update
+        Time.parse(xml.root.elements['dayf'].elements['lsup'].text)
+      end
     end
     
     # Abstract class that all Forecast entities (roughly "days") are based on.
@@ -113,15 +136,22 @@ module Weather
         end
       end
       
-      # Returns the wind conditions as an anonymous object (i.e. wind.d for wind
+      # The wind conditions as an anonymous object (i.e. wind.d for wind
       # direction, wind.s for wind speed, etc.) See the <wind> element in the 
       # weather.com XML data spec for more info.
       def wind
         fix_wind(complex_attribute(@xml.elements['wind']))
       end
+      
+      # The date and time when the conditions were last measured/forecast.
+      # Returned as a Time object.
+      def latest_update
+        Time.parse(self.lsup)
+      end
+      
     
       private
-      # Returns the element specified by name as a cleaned-up temperature value.
+      # The element specified by name as a cleaned-up temperature value.
       # That is, if the temperature is "N/A", then nil is returned; otherwise
       # the value is converted to an integer.
       def clean_temp(name)
@@ -134,7 +164,7 @@ module Weather
         end
       end
       
-      # Return the given xml element as an anonymous object, with the text nodes of the element's
+      # The given xml element as an anonymous object, with the text nodes of the element's
       # immediate children available as accessor methods.
       # This allows for accessing attributes that have child elements (i.e. wind, bar, etc.)
       # as anonymous objects (i.e. wind.d for wind direction, wind.s for wind speed, etc.)
@@ -182,8 +212,8 @@ module Weather
       def temp
         clean_temp('tmp')
       end
-      alias_method :tmp, :temp
-      alias_method :temperature, :temp
+      alias tmp temp
+      alias temperature temp
       
       def outlook
         xml.elements['t'].text
@@ -196,7 +226,7 @@ module Weather
       def pop
         nil
       end
-      alias_method :ppcp, :pop
+      alias ppcp pop
       
       def date
         Time.now
@@ -224,6 +254,12 @@ module Weather
         end
       end
       
+      # The date and time when the conditions were last measured/forecast.
+      # Returned as a Time object.
+      def latest_update
+        Time.parse(@xml.attributes['lsup'])
+      end
+      
       def wind
         fix_wind(complex_attribute(mypart.elements['wind']))
       end
@@ -241,12 +277,12 @@ module Weather
       def high
         clean_temp('hi')
       end
-      alias_method :hi, :high
+      alias hi high
       
       def low
         clean_temp('low')
       end
-      alias_method :lo, :low
+      alias lo low
       
       
       def outlook
@@ -260,7 +296,7 @@ module Weather
       def pop
         mypart.elements['ppcp'].text.to_i
       end
-      alias_method :ppcp, :pop
+      alias ppcp pop
       
       def sunrise
         hour,minute = @xml.elements['sunr'].text.split(" ").first.split(":")
@@ -287,8 +323,8 @@ module Weather
       def temp
         high
       end
-      alias_method :tmp, :temp
-      alias_method :temperature, :temp
+      alias tmp temp
+      alias temperature temp
     
       private 
         def mypart
@@ -305,8 +341,8 @@ module Weather
       def temp
         low
       end
-      alias_method :tmp, :temp
-      alias_method :temperature, :temp
+      alias tmp temp
+      alias temperature temp
     
       private
         def mypart

data/lib/{service.rb → weather/service.rb}

@@ -7,7 +7,7 @@
 require 'net/http'
 require 'rexml/document'
 
-require File.dirname(__FILE__) + '/forecast'
+require File.dirname(File.expand_path(__FILE__)) + '/forecast'
 
 module Weather
 

data/test/forecast_test.rb

@@ -5,9 +5,10 @@
 #
 
 require 'test/unit'
-require File.dirname(__FILE__) + '/../lib/service'
-require File.dirname(__FILE__) + '/../lib/forecast'
-require File.dirname(__FILE__) + '/../lib/util'
+require 'time'
+require File.dirname(__FILE__) + '/../lib/weather/service'
+require File.dirname(__FILE__) + '/../lib/weather/forecast'
+require File.dirname(__FILE__) + '/../lib/weather/util'
 
 class ForecastTest < Test::Unit::TestCase
 
@@ -74,4 +75,9 @@ class ForecastTest < Test::Unit::TestCase
     assert_equal(8, tomorrow_night.wind.speed)
   end
   
+  def test_latest_update
+    assert_equal Time.parse("2006-07-14 14:15"), @forecast.latest_update
+    assert_equal Time.parse("2006-07-14 15:00"), @forecast.current.latest_update
+    assert_equal Time.parse("2006-07-14 14:15"), @forecast.tomorrow.latest_update
+  end
 end

data/test/service_test.rb

@@ -5,14 +5,14 @@
 #
 
 require 'test/unit'
-require File.dirname(__FILE__) + '/../lib/service'
+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=###########) before running this test."
+  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=###########) before running this test."
+  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

data/weather.rb

@@ -1,3 +1,5 @@
-require 'lib/util'
-require 'lib/forecast'
-require 'lib/service'
+# DEPRECATED
+# This file will likely go away within the next few versions.
+# Use init.rb instead, or just require 'weather/service'
+
+require File.dirname(File.expand_path(__FILE__)) + '/init'

metadata

@@ -3,12 +3,11 @@ rubygems_version: 0.8.11
 specification_version: 1
 name: rubyweather
 version: !ruby/object:Gem::Version 
-  version: 0.9.1
+  version: 1.0.0
 date: 2006-07-28 00:00:00 -04:00
 summary: Client library for accessing weather.com's xoap weather data.
 require_paths: 
 - lib
-- .
 email: matt@roughest.net
 homepage: http://rubyforge.org/projects/rubyweather
 rubyforge_project: rubyweather
@@ -30,14 +29,70 @@ authors:
 - Matt Zukowski
 files: 
 - weather.rb
-- lib/service.rb
-- lib/forecast.rb
-- lib/util.rb
+- install.rb
+- init.rb
+- lib/weather/service.rb
+- lib/weather/forecast.rb
+- lib/weather/util.rb
 - LICENSE
 - README
 - test/forecast_test.rb
 - test/service_test.rb
 - test/test_weather.xml
+- example/weather_32
+- example/weather_portlet_controller.rb
+- example/forecast.rhtml
+- example/weather_32/0.png
+- example/weather_32/1.png
+- example/weather_32/2.png
+- example/weather_32/3.png
+- example/weather_32/4.png
+- example/weather_32/5.png
+- example/weather_32/6.png
+- example/weather_32/7.png
+- example/weather_32/8.png
+- example/weather_32/9.png
+- example/weather_32/WS_FTP.LOG
+- example/weather_32/Thumbs.db
+- example/weather_32/na.png
+- example/weather_32/10.png
+- example/weather_32/11.png
+- example/weather_32/12.png
+- example/weather_32/13.png
+- example/weather_32/14.png
+- example/weather_32/15.png
+- example/weather_32/16.png
+- example/weather_32/17.png
+- example/weather_32/18.png
+- example/weather_32/19.png
+- example/weather_32/20.png
+- example/weather_32/21.png
+- example/weather_32/22.png
+- example/weather_32/23.png
+- example/weather_32/24.png
+- example/weather_32/25.png
+- example/weather_32/26.png
+- example/weather_32/27.png
+- example/weather_32/28.png
+- example/weather_32/29.png
+- example/weather_32/30.png
+- example/weather_32/31.png
+- example/weather_32/32.png
+- example/weather_32/33.png
+- example/weather_32/34.png
+- example/weather_32/35.png
+- example/weather_32/36.png
+- example/weather_32/37.png
+- example/weather_32/38.png
+- example/weather_32/39.png
+- example/weather_32/40.png
+- example/weather_32/41.png
+- example/weather_32/42.png
+- example/weather_32/43.png
+- example/weather_32/44.png
+- example/weather_32/45.png
+- example/weather_32/46.png
+- example/weather_32/47.png
 test_files: 
 - test/forecast_test.rb
 - test/service_test.rb