yahoo-weather 1.1.0 → 1.2.0

data/README.rdoc

@@ -5,22 +5,33 @@
 yahoo-weather provides an object-oriented interface to the Yahoo! Weather XML
 RSS feed detailed at http://developer.yahoo.com/weather.
 
-People care a lot about the weather, which sometimes seems ironic given that
-they can just glance out the window, but we can all understand the fascination
-with details and forecasting.
+People care a lot about the weather.  This may seem ironic given they
+can just glance out the window.  However, we can all understand a
+fascination with details and forecasting.
 
-Log the weather information to your database! Graph it to your heart's
-content! Write a widget that emails the weather to your cell phone every five
-minutes with a link to your friend's PayPal account to deposit money if the
-weather's sunny and you both bet that it would be rainy. And the fun doesn't
-have to stop there.
+Log the weather information to your database!  Graph it to your
+heart's content!  Write a widget that emails the weather to your cell
+phone every five minutes with a link to your friend's PayPal account
+to deposit money if the weather's sunny and you both bet that it would
+be rainy. And the fun doesn't have to stop there.
 
-The RubyForge project page is at http://rubyforge.org/projects/yahoo-weather.
+The RubyForge project page for this library is at
+http://rubyforge.org/projects/yahoo-weather.
 
 Source code is at http://github.com/shaper/yahoo-weather.
 
-== Installation
+NOTE: This library was updated as of December 2009 to use a new
+WOEID-based lookup interface.  Yahoo has deprecated the older
+non-WOEID-based lookup API.  The archived page with the deprecated API
+details is at:
+
+http://developer.yahoo.com/weather/archive.html
 
+The older interface is still operational but users of this library
+should shift from using YahooWeather::Client::lookup_location to
+YahooWeather::Client::lookup_by_woeid.
+
+== Installation
 
 Install +rubygems+ if you don't already have it.  See http://rubyforge.org/projects/rubygems/.
 
@@ -36,7 +47,10 @@ A simple example program:
  require 'yahoo-weather'
 
  @client = YahooWeather::Client.new
- response = @client.lookup_location('98103')
+ # look up WOEID via http://weather.yahoo.com; enter location by city
+ # name or zip and WOEID is at end of resulting page url.  herein we use
+ # the WOEID for Santa Monica, CA.
+ response = @client.lookup_by_woeid(2488892)
 
  # straight text output
  print <<edoc
@@ -48,7 +62,7 @@ A simple example program:
  # sample html output
  print <<edoc
  <div>
-   <img src="#{response.image_url}"><br/>
+   <img src="#{response.image.url}"><br/>
    #{response.condition.temp} degrees #{response.units.temperature}<br/>
    #{response.condition.text}<br>
    Forecast:<br/>
@@ -60,17 +74,17 @@ A simple example program:
     
 Produces output as:
 
- Conditions for Seattle, WA at 2:53 pm PST
- 55 degrees F
- Light Rain
+ Conditions for Santa Monica, CA at 10:51 am PST
+ 56 degrees
+ Partly Cloudy
  <div>
-   <img src="http://us.i1.yimg.com/us.yimg.com/i/us/we/52/11.gif"><br/>
-   55 degrees F<br/>
-   Light Rain<br>
+   <img src="http://l.yimg.com/a/i/us/nws/th/main_142b.gif"><br/>
+   56 degrees F<br/>
+   Partly Cloudy<br>
    Forecast:<br/>
-   Sun - Rain/Wind.  High: 56 Low: 54<br/>
-   Mon - Heavy Rain/Wind.  High: 60 Low: 54<br/>
-   More information <a href="http://us.rd.yahoo.com/dailynews/rss/weather/Seattle__WA/*http://xml.weather.yahoo.com/forecast/98103_f.html">here</a>.
+   Sat - Mostly Cloudy.  High: 59 Low: 46<br/>
+   Sun - Partly Cloudy.  High: 64 Low: 48<br/>
+   More information <a href="http://us.rd.yahoo.com/dailynews/rss/weather/Santa_Monica__CA/*http://weather.yahoo.com/forecast/USCA1024_f.html">here</a>.
  </div>
 
 There is a variety of detailed weather information in other attributes of the

data/Rakefile

@@ -8,7 +8,7 @@ Hoe.spec('yahoo-weather') do |p|
   self.rubyforge_name = 'yahoo-weather'
   self.author = 'Walter Korman'
   self.email = 'shaper@fatgoose.com'
-  self.extra_deps << [ 'xml-simple', '>= 1.0.9' ]
+  self.extra_deps << [ 'nokogiri', '>= 1.4.1' ]
   self.summary = 'A Ruby object-oriented interface to the Yahoo! Weather service.'
   self.description = <<EDOC
 The yahoo-weather rubygem provides a Ruby object-oriented interface to the
@@ -17,7 +17,6 @@ Yahoo! Weather service described in detail at:
 http://developer.yahoo.com/weather
 EDOC
   self.url = 'http://rubyforge.org/projects/yahoo-weather'
-  self.changes = p.paragraphs_of('CHANGELOG.rdoc', 0..1).join("\n\n")
   self.remote_rdoc_dir = '' # Release to root
   self.readme_file = 'README.rdoc'
   self.history_file = 'CHANGELOG.rdoc'

data/examples/example.rb

@@ -4,19 +4,22 @@ require 'rubygems'
 require 'yahoo-weather'
 
 @client = YahooWeather::Client.new
-response = @client.lookup_location('98103')
+# look up WOEID via http://weather.yahoo.com; enter location by city
+# name or zip and WOEID is at end of resulting page url.  herein we use
+# the WOEID for Santa Monica, CA.
+response = @client.lookup_by_woeid(2488892)
 
 # straight text output
-print <<edoc
+print <<EDOC
 #{response.title}
-#{response.condition.temp} degrees #{response.units.temperature}
+#{response.condition.temp} degrees
 #{response.condition.text}
-edoc
+EDOC
 
-# html output
-print <<edoc
+# sample html output
+print <<EDOC
 <div>
-  <img src="#{response.image_url}"><br/>
+  <img src="#{response.image.url}"><br/>
   #{response.condition.temp} degrees #{response.units.temperature}<br/>
   #{response.condition.text}<br>
   Forecast:<br/>
@@ -24,4 +27,4 @@ print <<edoc
   #{response.forecasts[1].day} - #{response.forecasts[1].text}.  High: #{response.forecasts[1].high} Low: #{response.forecasts[1].low}<br/>
   More information <a href="#{response.page_url}">here</a>.
 </div>
-edoc
+EDOC

data/lib/yahoo-weather.rb

@@ -1,5 +1,5 @@
 # yahoo-weather -- provides OO access to the Yahoo! Weather RSS XML feed
-# Copyright (C) 2006 Walter Korman <shaper@wgks.org>
+# Copyright (C) 2006 - 2009 Walter Korman <shaper@fatgoose.com>
 #
 # This library is free software; you can redistribute it and/or
 # modify it under the terms of the GNU Lesser General Public
@@ -16,306 +16,25 @@
 # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 
 require 'net/http'
+require 'cgi'
 require 'time'
-require 'xmlsimple'
+require 'nokogiri'
 
 class YahooWeather
+  VERSION = '1.2.0'
 
-  VERSION = '1.1.0'
-
-  # Describes astronomy information for a particular location.
-  class Astronomy
-    # a Time object detailing the sunrise time for a location.
-    attr_reader :sunrise
-    
-    # a Time object detailing the sunset time for a location.
-    attr_reader :sunset
-    
-    def initialize (payload)
-      @sunrise = YahooWeather._parse_time(payload['sunrise'])
-      @sunset = YahooWeather._parse_time(payload['sunset'])
-    end
-  end
-
-  # Describes a geographical location.
-  class Location
-    # the name of the city.
-    attr_reader :city
-    
-    # the name of the country.
-    attr_reader :country
-    
-    # the name of the region, such as a state.
-    attr_reader :region
-
-    def initialize (payload)
-      @city = payload['city']
-      @country = payload['country']
-      @region = payload['region']
-    end
-  end
-
-  # Describes the units of measure with which weather information is provided.
-  class Units
-    # the units in which temperature is measured, e.g. +F+ for +Fahrenheit+ or +C+ for +Celsius+.
-    attr_reader :temperature
-    
-    # the units in which distance is measured, e.g. +mi+ for +miles+.
-    attr_reader :distance
-    
-    # the units in which pressure is measured, e.g. +in+ for +inches+.
-    attr_reader :pressure
-    
-    # the units in which speed is measured, e.g. +mph+ for <tt>miles per hour</tt>.
-    attr_reader :speed
-    
-    def initialize (payload)
-      @temperature = payload['temperature']
-      @distance = payload['distance']
-      @pressure = payload['pressure']
-      @speed = payload['speed']
-    end
-  end
-
-  # Describes the specific wind conditions at a location.
-  class Wind
-    # the temperature factoring in wind chill.
-    attr_reader :chill
-    
-    # the direction of the wind in degrees.
-    attr_reader :direction
-    
-    # the speed of the wind.
-    attr_reader :speed
-    
-    def initialize (payload)
-      @chill = payload['chill'].to_i
-      @direction = payload['direction'].to_i
-      @speed = payload['speed'].to_i
-    end
-  end
-
-  # Describes the specific atmospheric conditions at a location.
-  class Atmosphere
-    # Constants representing the state of the barometric pressure.
-    #
-    class Barometer
-      STEADY = 'steady'
-      RISING = 'rising'
-      FALLING = 'falling'
-
-      # lists all possible barometer constants
-      ALL = [ STEADY, RISING, FALLING ]
-    end
-
-    # the humidity of the surroundings.
-    attr_reader :humidity
-    
-    # the visibility level of the surroundings
-    attr_reader :visibility
-    
-    # the pressure level of the surroundings.
-    attr_reader :pressure
-    
-    # the state of the barometer, defined as one of the
-    # YahooWeather::Atmosphere::Barometer constants.
-    attr_reader :barometer
-
-    def initialize (payload)
-      @humidity = payload['humidity'].to_i
-      @visibility = payload['visibility'].to_i
-      @pressure = payload['pressure'].to_f
-
-      # map barometric pressure direction to appropriate constant
-      @barometer = nil
-      case payload['rising'].to_i
-      when 0: @barometer = Barometer::STEADY
-      when 1: @barometer = Barometer::RISING
-      when 2: @barometer = Barometer::FALLING
-      end
-    end
-  end
-  
-  class Condition
-    # the Yahoo! Weather condition code, as detailed at http://developer.yahoo.com/weather.
-    attr_reader :code
-    
-    # the date and time associated with these conditions.
-    attr_reader :date
-    
-    # the temperature of the location.
-    attr_reader :temp
-    
-    # the brief prose text description of the weather conditions of the location.
-    attr_reader :text
-    
-    def initialize (payload)
-      @code = payload['code'].to_i
-      @date = YahooWeather._parse_time(payload['date'])
-      @temp = payload['temp'].to_i
-      @text = payload['text']
-    end
-  end
-
-  # The forecasted weather conditions for a specific location.
-  class Forecast
-    # the brief name of the day associated with the forecast.
-    attr_reader :day
-    
-    # the date associated with the forecast.
-    attr_reader :date
-    
-    # the low temperature forecasted.
-    attr_reader :low
-    
-    # the high temperature forecasted.
-    attr_reader :high
-    
-    # the brief prose text description of the forecasted weather conditions.
-    attr_reader :text
-    
-    # the Yahoo! Weather code associated with the forecast, per http://developer.yahoo.com/weather.
-    attr_reader :code
-    
-    def initialize (payload)
-      @day = payload['day']
-      @date = YahooWeather._parse_time(payload['date'])
-      @low = payload['low'].to_i
-      @high = payload['high'].to_i
-      @text = payload['text']
-      @code = payload['code'].to_i
-    end
-  end
-
-  # Describes the weather conditions for a particular requested location.
-  class Response
-    # a YahooWeather::Astronomy object detailing the sunrise and sunset
-    # information for the requested location.
-    attr_reader :astronomy
-
-    # a YahooWeather::Location object detailing the precise geographical names
-    # to which the requested location was mapped.
-    attr_reader :location
-
-    # a YahooWeather::Units object detailing the units corresponding to the
-    # information detailed in the response.
-    attr_reader :units
-
-    # a YahooWeather::Wind object detailing the wind information at the
-    # requested location.
-    attr_reader :wind
-
-    # a YahooWeather::Atmosphere object detailing the atmosphere information
-    # of the requested location.
-    attr_reader :atmosphere
-
-    # a YahooWeather::Condition object detailing the current conditions of the
-    # requested location.
-    attr_reader :condition
-
-    # a list of YahooWeather::Forecast objects detailing the high-level
-    # forecasted weather conditions for upcoming days.
-    attr_reader :forecasts
-
-    # the raw HTML generated by the Yahoo! Weather service summarizing current
-    # weather conditions for the requested location.
-    attr_reader :description
-    
-    # a link to the Yahoo! Weather image icon representing the current weather
-    # conditions visually.
-    attr_reader :image_url
-    
-    # the latitude of the location for which weather is detailed.
-    attr_reader :latitude
-
-    # the longitude of the location for which weather is detailed.
-    attr_reader :longitude
-    
-    # a link to the Yahoo! Weather page with full detailed information on the
-    # requested location's current weather conditions.
-    attr_reader :page_url
-
-    # the location string initially requested of the service.
-    attr_reader :request_location
-
-    # the url with which the Yahoo! Weather service was accessed to build the response.
-    attr_reader :request_url
-    
-    # the prose descriptive title of the weather information.
-    attr_reader :title
-
-    # regular expression used to pull the weather image icon from full
-    # description text.
-    @@REGEXP_IMAGE = Regexp.new(/img src="([^"]+)"/)
-
-    def initialize (request_location, request_url, payload)
-      @request_location = request_location
-      @request_url = request_url
-
-      root = payload['channel'].first
-      @astronomy = YahooWeather::Astronomy.new root['astronomy'].first
-      @location = YahooWeather::Location.new root['location'].first
-      @units = YahooWeather::Units.new root['units'].first
-      @wind = YahooWeather::Wind.new root['wind'].first
-      @atmosphere = YahooWeather::Atmosphere.new root['atmosphere'].first
-
-      item = root['item'].first
-      @condition = YahooWeather::Condition.new item['condition'].first
-      @forecasts = []
-      item['forecast'].each { |forecast| @forecasts << YahooWeather::Forecast.new(forecast) }
-      @latitude = item['lat'].first.to_f
-      @longitude = item['long'].first.to_f
-      @page_url = item['link'].first
-      @title = item['title'].first
-      @description = item['description'].first
-
-      match_data = @@REGEXP_IMAGE.match(description)
-      @image_url = (match_data) ? match_data[1] : nil
-    end
-  end
-
-  # The main client object through which the Yahoo! Weather service may be accessed.
-  class Client
-    # the url with which we obtain weather information from yahoo
-    @@API_URL = "http://xml.weather.yahoo.com/forecastrss"
-  
-    def initialize (api_url = @@API_URL)
-      @api_url = api_url
-    end
-
-    # Returns a YahooWeather::Response object detailing the current weather
-    # information for the specified location.
-    #
-    # +location+ can be either a US zip code or a location code.  Location
-    # codes can be looked up at http://weather.yahoo.com, where it will appear
-    # in the URL that results from searching on the city or zip code.  For
-    # instance, searching on 'Seattle, WA' results in a URL ending in
-    # 'USWA0395.html', so the location code for Seattle is 'USWA0395'.
-    #
-    # +units+ allows specifying whether to retrieve information in
-    # +Fahrenheit+ as +f+, or +Celsius+ as +c+, and defaults to +f+.
-    def lookup_location (location, units = 'f')
-      # query the service to grab the xml data
-      url = _request_url(location, units)
-      begin
-         response = Net::HTTP.get_response(URI.parse(url)).body.to_s
-      rescue
-        raise "failed to get weather via '#{url}': " + $!
-      end
-
-      # create the response object
-      response = XmlSimple.xml_in(response)
-      YahooWeather::Response.new(location, url, response)
-    end
-  
-    private
-    def _request_url (location, units)
-      @api_url + '?p=' + URI.encode(location) + '&u=' + URI.encode(units)
-    end
-  end
-
-  private
   def self._parse_time (text)
     (text) ? Time.parse(text) : nil
   end
 end
+
+require 'yahoo-weather/astronomy'
+require 'yahoo-weather/atmosphere'
+require 'yahoo-weather/client'
+require 'yahoo-weather/condition'
+require 'yahoo-weather/forecast'
+require 'yahoo-weather/image'
+require 'yahoo-weather/location'
+require 'yahoo-weather/response'
+require 'yahoo-weather/units'
+require 'yahoo-weather/wind'