rubyweather 1.1.0 → 1.1.1

data/README

@@ -14,14 +14,14 @@ or install as a RubyGem:
 
   sudo gem install rubyweather
 
-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 http://rubyweather.googlecode.com/svn/trunk/.
+If you would like to contribute back your changes to the code, please contact me via the RubyForge or
+Google Code project site to obtain a subversion account.
 
 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
+  ./script/plugin install -x http://rubyweather.googlecode.com/svn/trunk
 
 
 === Examples

data/lib/weather/forecast.rb

@@ -5,13 +5,14 @@
 #
 
 require 'time'
+require 'ostruct'
 require File.dirname(File.expand_path(__FILE__)) + '/util'
 
 module Weather
-
+  
   # Namespace module for weather data objects.
   module Forecast
-  
+    
     # Contains several days of weather data.
     # The forecast object includes the Enumerable mixin, so that you can iterate
     # over all of the days in the forecast using the standard ruby mechanisms as follows:
@@ -59,9 +60,9 @@ module Weather
         element = xml.root.elements['dayf'].elements["day[@d='#{num.to_s}']"]
         if not element
           case num
-            when 0 then daydisplay = "today"
-            when 1 then daydisplay = "tomorrow"
-            else daydisplay = "#{num} days from now"
+          when 0 then daydisplay = "today"
+          when 1 then daydisplay = "tomorrow"
+          else daydisplay = "#{num} days from now"
           end
           raise "Sorry, there is no data available for #{daydisplay}"
         else
@@ -125,6 +126,7 @@ module Weather
       #   forecast.current.latest_update
       #   
       def latest_update
+        puts xml.root.to_s
         Time.parse(xml.root.elements['dayf'].elements['lsup'].text)
       end
       
@@ -147,7 +149,7 @@ module Weather
     
     # Abstract class that all Forecast entities are based on.
     class Conditions
-    
+      
       # For elements in the forecast that we have not defined an explicit accessor,
       # this allows accessing the raw underlying data in the forecast xml.
       def method_missing(symbol)
@@ -158,9 +160,10 @@ module Weather
         end
       end
       
-      # 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.
+      # The wind conditions as an anonymous object (i.e. wind.d or wind.direction for 
+      # wind direction, wind.s or wind.speed for wind speed, wind.h or wind.heading for
+      # heading, 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
@@ -171,14 +174,14 @@ module Weather
         Time.parse(self.lsup)
       end
       
-    
+      
       private
       # 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)
         temp = @xml.elements[name].text
-      
+        
         if (temp == "N/A")
           return nil
         else
@@ -192,23 +195,20 @@ module Weather
       # as anonymous objects (i.e. wind.d for wind direction, wind.s for wind speed, etc.)
       def complex_attribute(objxml)
         obj = {}
-        class << obj
-          def method_missing(name)
-            return self[name.to_s]
-          end
-        end
         
         objxml.elements.each do |element|
           obj[element.name] = element.text
         end
         
-        return obj
+        return OpenStruct.new(obj)
       end
       
+      # Adds more verbose names for wind properties. For example, "speed" for wind speed
+      # rather than just "s".
       def fix_wind(obj)
-        obj['heading'] = obj.t
-        obj['direction'] = obj.d.to_i
-        obj['speed'] = obj.s.to_i
+        obj.heading = obj.t
+        obj.direction = obj.d.to_i
+        obj.speed = obj.s.to_i
         
         return obj
       end
@@ -227,6 +227,8 @@ module Weather
         @xml = element
       end
       
+      # The numeric ID for the icon representing current conditions.
+      # You can find the corresponding icons packaged with RubyWeather in the example/weather_32 directory.
       def icon
         xml.elements['icon'].text.to_i
       end
@@ -258,9 +260,9 @@ module Weather
     # Abstract class representing either a day or night in the daily forecast (note that "future" can include today).
     class FutureConditions < Conditions
       attr_reader :xml
-    
+      
       @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"
@@ -292,6 +294,8 @@ module Weather
         Time.local(Time.now.year, mon, day)
       end
       
+      # The numeric ID for the icon representing these forecast conditions.
+      # You can find the corresponding icons packaged with RubyWeather in the example/weather_32 directory.
       def icon
         mypart.elements['icon'].text.to_i
       end
@@ -333,7 +337,7 @@ module Weather
         minute = minute.to_i
         Time.local(date.year, date.month, date.day, hour, minute)
       end
-
+      
     end
     
     # The daytime part of the forecast for a given day.
@@ -341,17 +345,17 @@ module Weather
       def initialize(element)
         super(element)
       end
-    
+      
       def temp
         high
       end
       alias tmp temp
       alias temperature temp
-    
+      
       private 
-        def mypart
-          @xml.elements['part[@p="d"]']
-        end
+      def mypart
+        @xml.elements['part[@p="d"]']
+      end
     end
     
     # The nighttime part of a forecast for a given day.
@@ -365,11 +369,11 @@ module Weather
       end
       alias tmp temp
       alias temperature temp
-    
+      
       private
-        def mypart
-          @xml.elements['part[@p="n"]']
-        end
+      def mypart
+        @xml.elements['part[@p="n"]']
+      end
     end
   end
   

data/lib/weather/service.rb

@@ -19,6 +19,8 @@ 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?
+      
       # 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
       license_key = ENV['WEATHER_COM_LICENSE_KEY'] unless license_key
@@ -42,7 +44,7 @@ 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}"
       
@@ -53,12 +55,14 @@ module Weather
         xml = Net::HTTP.get(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 
           cache.set("#{location_id}:#{days}", doc.to_s, cache_expiry)
         end
       end
-      
+      puts xml
       doc = REXML::Document.new(xml)
 
       Forecast::Forecast.new(doc)
@@ -105,9 +109,9 @@ module Weather
       end
     end
     
-    # True if caching is enabled, false otherwise.
+    # True if caching is enabled and at least one memcached server is alive, false otherwise.
     def cache?
-      @cache and cache.active?
+      @cache and cache.active? and not cache.servers.dup.delete_if{|s| !s.alive?}.empty?
     end
     
     # Turns off weather forecast caching.

data/test/profiler.rb

@@ -0,0 +1,52 @@
+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..."
+
+start = Time.now
+RubyProf.start
+@forecast = Weather::Service.new.load_forecast(@filename)
+@forecast2 = Weather::Service.new.load_forecast(@filename)
+@forecast3 = Weather::Service.new.load_forecast(@filename)
+@forecast4 = Weather::Service.new.load_forecast(@filename)
+@forecast5 = Weather::Service.new.load_forecast(@filename)
+load_result = RubyProf.stop
+
+puts "#{Time.now - start} seconds!"
+
+puts ""
+puts "Examining forecast..."
+
+start = Time.now
+RubyProf.start
+@forecast.location_name
+@forecast.current.temp
+@forecast.day(1).date.month
+@forecast.day(3).wind.speed
+@forecast.night(2).date.day
+@forecast.tomorrow.outlook
+@forecast.current.wind.heading
+@forecast.tomorrow.temp
+@forecast.latest_update
+use_result = RubyProf.stop
+
+puts "#{Time.now - start} seconds!"
+puts ""
+
+printer = RubyProf::FlatPrinter.new(load_result)
+printer.print(STDOUT, 3.0)
+
+printer = RubyProf::FlatPrinter.new(use_result)
+printer.print(STDOUT, 1.0)

data/test/service_test.rb

@@ -65,6 +65,8 @@ class ServiceTest < Test::Unit::TestCase
     @service.enable_cache
     @service.cache.servers = "localhost:11211"
     
+    raise "Memcache server must be up and running at localhost:11211 for this test to run." unless @service.cache?
+    
     @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='.*?'/, '')

metadata

@@ -1,9 +1,9 @@
 --- !ruby/object:Gem::Specification 
-rubygems_version: 0.8.11
+rubygems_version: 0.9.0
 specification_version: 1
 name: rubyweather
 version: !ruby/object:Gem::Version 
-  version: 1.1.0
+  version: 1.1.1
 date: 2006-07-28 00:00:00 -04:00
 summary: Client library for accessing weather.com's xoap weather data.
 require_paths: 
@@ -25,80 +25,81 @@ required_ruby_version: !ruby/object:Gem::Version::Requirement
 platform: ruby
 signing_key: 
 cert_chain: 
+post_install_message: 
 authors: 
 - Matt Zukowski
 files: 
-- weather.rb
 - install.rb
 - init.rb
-- lib/weather/service.rb
+- weather.rb
 - lib/weather/forecast.rb
+- lib/weather/service.rb
 - lib/weather/util.rb
-- LICENSE
 - README
-- test/forecast_test.rb
+- LICENSE
 - test/service_test.rb
+- test/forecast_test.rb
+- test/profiler.rb
 - test/test_weather.xml
-- example/weather_32
 - example/weather_portlet_controller.rb
+- example/weather_32
 - 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/41.png
+- example/weather_32/4.png
+- example/weather_32/32.png
 - example/weather_32/na.png
-- example/weather_32/10.png
+- example/weather_32/33.png
+- example/weather_32/40.png
+- example/weather_32/25.png
+- example/weather_32/29.png
+- example/weather_32/16.png
+- example/weather_32/28.png
 - example/weather_32/11.png
-- example/weather_32/12.png
+- example/weather_32/42.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/45.png
+- example/weather_32/43.png
+- example/weather_32/26.png
 - example/weather_32/18.png
+- example/weather_32/3.png
+- example/weather_32/35.png
 - example/weather_32/19.png
+- example/weather_32/31.png
+- example/weather_32/24.png
+- example/weather_32/23.png
+- example/weather_32/10.png
+- example/weather_32/46.png
+- example/weather_32/8.png
 - example/weather_32/20.png
-- example/weather_32/21.png
+- example/weather_32/6.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/1.png
+- example/weather_32/47.png
+- example/weather_32/17.png
+- example/weather_32/2.png
+- example/weather_32/38.png
+- example/weather_32/44.png
+- example/weather_32/Thumbs.db
+- example/weather_32/15.png
+- example/weather_32/0.png
+- example/weather_32/7.png
+- example/weather_32/21.png
+- example/weather_32/36.png
+- example/weather_32/39.png
 - example/weather_32/30.png
-- example/weather_32/31.png
-- example/weather_32/32.png
-- example/weather_32/33.png
+- example/weather_32/14.png
 - example/weather_32/34.png
-- example/weather_32/35.png
-- example/weather_32/36.png
+- example/weather_32/9.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
+- example/weather_32/12.png
+- example/weather_32/27.png
 test_files: 
-- test/forecast_test.rb
 - test/service_test.rb
+- test/forecast_test.rb
 rdoc_options: 
 - --title
-- RubyWeather 1.1.0 RDocs
+- RubyWeather 1.1.1 RDocs
 - --main
 - README
 - --line-numbers

data/example/weather_32/WS_FTP.LOG

@@ -1,49 +0,0 @@
-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