tomk32-yahoo-weather 1.2.1

data/CHANGELOG.rdoc

@@ -0,0 +1,44 @@
+= YAHOO_WEATHER_20091226_1_2_0
+
+* [shaper] upped library to version 1.2.0 to reflect changes.
+
+* [shaper] added new client.lookup_by_woeid method which should be
+  used instead of the now-deprecated lookup_location method.  Thanks
+  to Chris Cummer (http://github.com/senorprogrammer) for pointing out
+  the new WOEID-based Yahoo API functionality.
+
+* [shaper] use new Yahoo Weather API at 
+  http://weather.yahooapis.com/forecastrss
+
+* [shaper] shift xml parsing to use nokogiri rather than xml-simple.
+
+* [shaper] shift from Response.image_url to Response.image which
+  contains the new YahooWeather::Image record with the old image url
+  plus more detail as now provided in the API response.
+
+* [shaper] refactor for single class per file.
+
+* [shaper] fix km/h unit speed in test.
+
+= YAHOO_WEATHER_20091209_1_1_0
+
+* [shaper] revise atmosphere.barometer to reflect tri-state as
+  "steady", "rising", or "falling" via one of the new
+  YahooWeather::Atmosphere::Barometer constants, whereas previously it
+  was simply a boolean for whether rising.  Thanks to Andy Weber for
+  suggestion.
+
+= YAHOO_WEATHER_20091021_1_0_1
+
+* [shaper] update documentation to reflect reality and use suffix for
+  rdoc format.
+
+* [shaper] move source repository to github.
+
+* [shaper] use Hoe for Rakefile and gem management.
+
+* [shaper] fix test warnings.
+
+= 20061105
+
+* [shaper] Initial version.

data/Manifest.txt

@@ -0,0 +1,18 @@
+CHANGELOG.rdoc
+examples/example.rb
+examples/get-weather.rb
+lib/yahoo-weather/astronomy.rb
+lib/yahoo-weather/atmosphere.rb
+lib/yahoo-weather/client.rb
+lib/yahoo-weather/condition.rb
+lib/yahoo-weather/forecast.rb
+lib/yahoo-weather/image.rb
+lib/yahoo-weather/location.rb
+lib/yahoo-weather/response.rb
+lib/yahoo-weather/units.rb
+lib/yahoo-weather/wind.rb
+lib/yahoo-weather.rb
+LICENSE
+Rakefile
+README.rdoc
+test/test_api.rb

data/Rakefile

@@ -0,0 +1,24 @@
+require 'rubygems'
+require 'hoe'
+$:.unshift(File.dirname(__FILE__) + "/lib")
+require 'yahoo-weather'
+
+Hoe.spec('yahoo-weather') do |p|
+  self.version = YahooWeather::VERSION
+  self.rubyforge_name = 'yahoo-weather'
+  self.author = 'Walter Korman'
+  self.email = 'shaper@fatgoose.com'
+  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
+Yahoo! Weather service described in detail at:
+
+http://developer.yahoo.com/weather
+EDOC
+  self.url = 'http://rubyforge.org/projects/yahoo-weather'
+  self.remote_rdoc_dir = '' # Release to root
+  self.readme_file = 'README.rdoc'
+  self.history_file = 'CHANGELOG.rdoc'
+  self.extra_rdoc_files = [ 'CHANGELOG.rdoc', 'README.rdoc' ]
+end

data/TODO

@@ -0,0 +1,3 @@
+- fix YahooWeather::_parse_time hack
+- use open-uri, custom user agent, gzip compression for fetching content
+- provide easy way to map name/zip to woeid?

data/examples/example.rb

@@ -0,0 +1,30 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'yahoo-weather'
+
+@client = YahooWeather::Client.new
+# 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
+#{response.title}
+#{response.condition.temp} degrees
+#{response.condition.text}
+EDOC
+
+# sample html output
+print <<EDOC
+<div>
+  <img src="#{response.image.url}"><br/>
+  #{response.condition.temp} degrees #{response.units.temperature}<br/>
+  #{response.condition.text}<br>
+  Forecast:<br/>
+  #{response.forecasts[0].day} - #{response.forecasts[0].text}.  High: #{response.forecasts[0].high} Low: #{response.forecasts[0].low}<br/>
+  #{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

data/examples/get-weather.rb

@@ -0,0 +1,21 @@
+#!/usr/bin/env ruby
+#
+# Simple example script demonstrating usage of the yahoo-weather library.
+#
+# 2006/11/05 - Walter Korman (shaper@wgks.org)
+#
+
+require 'rubygems'
+require 'pp'
+require 'yahoo-weather'
+
+location = ARGV[0]
+if !location
+  STDERR.print "Usage: get-weather.rb <zip code>\n"
+  exit
+end
+
+print "Looking up weather for #{location}...\n"
+@client = YahooWeather::Client.new
+response = @client.lookup_location(location)
+pp(response)

data/lib/yahoo-weather.rb

@@ -0,0 +1,40 @@
+# yahoo-weather -- provides OO access to the Yahoo! Weather RSS XML feed
+# 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
+# License as published by the Free Software Foundation; either
+# version 2.1 of the License, or (at your option) any later version.
+#
+# This library is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+# Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public
+# License along with this library; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
+
+require 'net/http'
+require 'cgi'
+require 'time'
+require 'nokogiri'
+
+class YahooWeather
+  VERSION = '1.2.0'
+
+  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'

data/test/test_api.rb

@@ -0,0 +1,150 @@
+require 'rubygems'
+require 'test/unit'
+require 'yahoo-weather'
+
+class TestAPI < Test::Unit::TestCase
+  def setup
+    @client = YahooWeather::Client.new
+  end
+
+  def test_lookup_zip
+    # check a seattle, wa zipcode
+    request_location = '98103'
+    response = @client.lookup_location(request_location)
+    _assert_valid_response(response, request_location, 
+                           YahooWeather::Units::FAHRENHEIT,
+                           'Seattle', 'WA', 'US')
+  end
+
+  def test_lookup_location
+    # check france just for fun with the sample france location code from the
+    # yahoo weather developer page
+    request_location = 'FRXX0076'
+    response = @client.lookup_location(request_location)
+    _assert_valid_response(response, request_location, 
+                           YahooWeather::Units::FAHRENHEIT, 
+                           'Paris', '', 'FR')
+  end
+
+  def test_units
+    request_location = '10001'
+    city = 'New York'
+    region = 'NY'
+    country = 'US'
+
+    # check explicitly specifying fahrenheit units
+    response = @client.lookup_location(request_location, 
+                                       YahooWeather::Units::FAHRENHEIT)
+    _assert_valid_response(response, request_location, 
+                           YahooWeather::Units::FAHRENHEIT, 
+                           city, region, country)
+
+    # check alternate units
+    response = @client.lookup_location(request_location, 
+                                       YahooWeather::Units::CELSIUS)
+    _assert_valid_response(response, request_location, 
+                           YahooWeather::Units::CELSIUS, 
+                           city, region, country)
+  end
+
+  def test_lookup_by_woeid
+    woeid_sf = '12797168'
+    response = @client.lookup_by_woeid(woeid_sf)
+    _assert_valid_response(response, woeid_sf, 
+                           YahooWeather::Units::FAHRENHEIT,
+                           'San Francisco', 'CA', 'United States')
+  end
+
+  private
+
+    def _assert_valid_response (response, request_location, units, 
+                                city, region, country)
+      assert_not_nil response
+
+      # check the request location and url explicitly against what we
+      # know they should be
+      assert_equal response.request_location, request_location
+      assert_match(/http:\/\/weather\.yahooapis\.com\/forecastrss\?[pw]=#{request_location}&u=#{units}/, response.request_url)
+
+      # check the astronomy info
+      assert_instance_of YahooWeather::Astronomy, response.astronomy
+      assert_instance_of Time, response.astronomy.sunrise
+      assert_instance_of Time, response.astronomy.sunset
+      assert(response.astronomy.sunrise < response.astronomy.sunset)
+
+      # check the location
+      assert_instance_of YahooWeather::Location, response.location
+      assert_equal response.location.city, city
+      assert_equal response.location.region, region
+      assert_equal response.location.country, country
+
+      # check the default units
+      _assert_valid_units(response.units, 
+                          (units == YahooWeather::Units::FAHRENHEIT))
+
+      # check the wind info
+      assert_instance_of YahooWeather::Wind, response.wind
+      assert(response.wind.chill <= response.condition.temp)
+      assert_kind_of Numeric, response.wind.direction
+      assert_kind_of Numeric, response.wind.speed
+
+      # check the atmosphere info
+      assert_instance_of YahooWeather::Atmosphere, response.atmosphere
+      assert_kind_of Numeric, response.atmosphere.humidity
+      assert_kind_of Numeric, response.atmosphere.visibility
+      assert_kind_of Numeric, response.atmosphere.pressure
+      assert(YahooWeather::Atmosphere::Barometer::ALL.include?(response.atmosphere.barometer))
+
+      # check the condition info
+      assert_instance_of YahooWeather::Condition, response.condition
+      _assert_valid_weather_code response.condition.code
+      assert_instance_of Time, response.condition.date
+      assert_kind_of Numeric, response.condition.temp
+      assert(response.condition.text && response.condition.text.length > 0)
+
+      # check the forecast info
+      assert_not_nil response.forecasts
+      assert_kind_of Array, response.forecasts
+      assert_equal response.forecasts.length, 2
+      response.forecasts.each do |forecast|
+        assert_instance_of YahooWeather::Forecast, forecast
+        assert(forecast.day && forecast.day.length == 3)
+        assert_instance_of Time, forecast.date
+        assert_kind_of Numeric, forecast.low
+        assert_kind_of Numeric, forecast.high
+        assert(forecast.low <= forecast.high)
+        assert(forecast.text && forecast.text.length > 0)
+        _assert_valid_weather_code forecast.code
+      end
+
+      # check the basic attributes
+      assert(response.description && response.description.length > 0)
+      assert(response.image.url =~ /yimg\.com/)
+      assert_kind_of Numeric, response.latitude
+      assert_kind_of Numeric, response.longitude
+      assert(response.page_url =~ /\.html$/)
+      assert(response.title && response.title.length > 0)
+      assert_not_nil(response.title.index("#{response.location.city}, #{response.location.region}"))
+    end
+
+    def _assert_valid_weather_code (code)
+      (((code >= 0) && (code <= 47)) || (code == 3200))
+    end
+
+    def _assert_valid_units (units, fahrenheit_based)
+      assert_instance_of YahooWeather::Units, units
+      if fahrenheit_based
+        assert_equal units.temperature, 'F'
+        assert_equal units.distance, 'mi'
+        assert_equal units.pressure, 'in'
+        assert_equal units.speed, 'mph'
+
+      else
+        assert_equal units.temperature, 'C'
+        assert_equal units.distance, 'km'
+        assert_equal units.pressure, 'mb'
+        assert_equal units.speed, 'km/h'
+      end
+    end
+
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification 
+name: tomk32-yahoo-weather
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 1
+  - 2
+  - 1
+  version: 1.2.1
+platform: ruby
+authors: 
+- Walter Korman
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-02-24 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: nokogiri
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 4
+        - 1
+        version: 1.4.1
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 4
+        - 0
+        version: 2.4.0
+  type: :runtime
+  version_requirements: *id002
+description: "The yahoo-weather rubygem provides a Ruby object-oriented interface to the Yahoo! Weather service described in detail at: http://developer.yahoo.com/weather"
+email: shaper@fatgoose.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- CHANGELOG.rdoc
+- Manifest.txt
+- Rakefile
+- TODO
+- examples/example.rb
+- examples/get-weather.rb
+- lib/yahoo-weather.rb
+- test/test_api.rb
+has_rdoc: true
+homepage: http://rubyforge.org/projects/yahoo-weather
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --exclude
+- .
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: A Ruby object-oriented interface to the Yahoo! Weather service
+test_files: []
+