yahoo_weatherman 0.2

data/i18n/pt-br.yml

@@ -0,0 +1,54 @@
+0: Tornado
+1: Tempestade Tropical
+2: Furacão
+3: Tempestades Severas
+4: Tempestades
+5: Chuva com Neve
+6: Chuva com Granizo
+7: Chova com Neve e Granizo
+8: Geada
+9: Garoa
+10: Geada
+11: Chuva
+12: Chuva
+13: Flocos de Neve
+14: Neve Calma
+15: Nevasca
+16: Neve
+17: Granizo
+18: Granizo
+19: Poeira
+20: Neblina
+21: Nevoeiro
+22: Nevoeiro
+23: Tempestuoso
+24: Ventoso
+25: Frio
+26: Nublado
+27: Predominantemente Nublado (noite)
+28: Predominantemente Nublado
+29: Parcialmente Nublado (noite)
+30: Parcialmente Nublado
+31: Céu Limpo
+32: Ensolarado
+33: Limpo
+34: Limpo
+35: Misto de Chuva e Granizo
+36: Quente
+37: Tempestades Isoladas
+38: Tempestades Intermitentes
+39: Tempestades Intermitentes
+40: Chuvas Intermitentes
+41: Bastante Neve
+42: Neve
+43: Bastante Neve
+44: Parcialmente Nublado
+45: Tempestade
+46: Neve
+47: Chuvas Isoladas
+3200: Não Disponível
+
+locations:
+  Brazil: Brasil
+  Belo Horizonte: Belzonti
+  MG: Minas Gerais

data/lib/yahoo_weatherman/image.rb

@@ -0,0 +1,15 @@
+module Weatherman
+  # == Image
+  #
+  # A hash-like object with the weather image attributes (width, height, url, etc..)
+  #
+  class Image
+    def initialize(doc)
+      @image_root = doc
+    end
+
+    def [](attr)
+      @image_root.xpath(attr).first.content 
+    end
+  end
+end

data/lib/yahoo_weatherman/response.rb

@@ -0,0 +1,203 @@
+module Weatherman
+
+  # = Response
+  #
+  # This is where we get access to the contents parsed by Nokogiri in a object-oriented way.
+  # We also use this class to do the i18n stuff.
+  #
+  class Response
+    attr_accessor :document_root
+
+    def initialize(raw, language = nil)
+      @document_root = Nokogiri::XML.parse(raw).xpath('rss/channel')
+      @language = !!language
+      load_language_yaml!(language) if @language
+    end
+
+    #
+    # Returns a hash containing the actual weather condition details:
+    #
+    #  condition = response.condition
+    #  condition['text'] => "Tornado"
+    #  condition['code'] => 0
+    #  condition['temp'] => 21
+    #  condition['date'] => #<Date: -1/2,0,2299161>
+    #
+    def condition
+      condition = item_attribute 'yweather:condition'
+      condition = do_convertions(condition, [:code, :to_i], [:temp, :to_i], [:date, :to_date], :text)
+      translate!(condition)
+    end
+
+    # 
+    # Wind's details:
+    #
+    #  wind = response.wind
+    #  wind['chill'] => 21 
+    #  wind['direction'] => 340 
+    #  wind['chill'] => 9.66
+    #
+    def wind
+      wind = attribute 'yweather:wind'
+      do_convertions(wind, [:chill, :to_i], [:direction, :to_i], [:speed, :to_f]) 
+    end
+
+    #
+    # Forecasts for the next 2 days.
+    #
+    #  forecast = response.forecasts.first
+    #  forecast['low'] => 20
+    #  forecast['high'] => 31
+    #  forecast['text'] => "Tornado"
+    #  forecast['code'] => 0
+    #  forecast['day'] => "Sat"
+    #
+    def forecasts
+      item_attribute('yweather:forecast').collect do |forecast|
+        do_convertions(forecast, [:date, :to_date], [:low, :to_i], [:high, :to_i], [:code, :to_i], :day, :text)
+      end
+    end
+
+    #
+    # Location:
+    #
+    #  location = response.location
+    #  location['country'] => "Brazil"
+    #  location['region'] => "MG"
+    #  location['city'] => Belo Horizonte
+    #
+    def location
+      location = attribute 'yweather:location'
+      translate!(location)
+    end
+
+    # Units:
+    #
+    #  units = response.units
+    #  units['temperature']  => "C"
+    #  units['distance']  => "km"
+    #  units['pressure']  => "mb"
+    #  units['speed']  => "km/h"
+    #
+    def units
+      attribute 'yweather:units'
+    end
+
+    #
+    # Astronomy:
+    #
+    #  astronomy = response.astronomy
+    #  astronomy['sunrise'] => "6:01 am"
+    #  astronomy['sunset'] => "7:20 pm"
+    #
+    def astronomy
+      attribute 'yweather:astronomy' 
+    end
+
+    #
+    # Latitude:
+    #
+    #  response.latitude => -49.90
+    def latitude
+      geo_attribute('lat').to_f
+    end
+
+    # 
+    # Longitude;
+    #
+    #  response.longitude => -45.32
+    #
+    def longitude
+      geo_attribute('long').to_f
+    end
+
+    #
+    # A hash like object providing image info:
+    #
+    #  image = reponse.image
+    #  image['width'] => 142
+    #  image['height'] => 18
+    #  image['title'] => "Yahoo! Weather"
+    #  image['link'] => "http://weather.yahoo.com"
+    #
+    def image
+      image = Weatherman::Image.new(attribute 'image')
+      do_convertions(image, [:width, :to_i], [:height, :to_i], :title, :link, :url)
+    end
+
+    #
+    # A short HTML snippet with a simple weather description.
+    # 
+    def description
+      text_attribute 'description'
+    end
+
+    private
+      def attribute(attr, root = @document_root)
+        elements = root.xpath(attr)
+        elements.size == 1 ? elements.first : elements
+      end
+
+      def item_attribute(attr)
+        item = document_root.xpath('item').first
+        attribute(attr, item)
+      end
+
+      def geo_attribute(attr)
+        geo = item_attribute('geo:' + attr)
+        geo.children.first.text
+      end
+
+      def text_attribute(attr)
+        item_attribute(attr).content        
+      end
+
+      def do_convertions(attributes, *pairs)
+        pairs.inject({}) do |hash, (attr, method)|
+          value = attributes[attr.to_s]
+          hash[attr.to_s] = convert(value, method)
+          hash
+        end
+      end
+
+      def convert(value, method)
+        if method == :to_date
+          Date.parse(value)
+        else
+          method ? value.send(method) : value
+        end
+      end
+
+      def load_language_yaml!(language)
+        stream = File.read(File.join([I18N_YAML_DIR, language + '.yml']))
+        @language_config = YAML.load(stream) 
+      end
+
+      def make_translations!(condition)
+        if condition['text']
+          condition['text'] = @language_config[condition['code']]
+        end
+
+        %w(city country region).each do |attr|
+          next unless condition[attr]
+          if translated = @language_config['locations'][condition[attr]]
+            condition[attr] = translated
+          end
+        end
+
+        condition
+      end
+
+      def translate!(attribute)
+        if i18n?
+          make_translations! attribute
+        else
+          attribute
+        end
+      end
+
+      def i18n?
+        @language
+      end
+  end
+end

data/lib/yahoo_weatherman.rb

@@ -0,0 +1,56 @@
+path = File.expand_path(File.dirname(__FILE__))
+$LOAD_PATH.unshift(path) unless $LOAD_PATH.include?(path)
+
+require 'open-uri'
+require 'nokogiri'
+require 'yaml'
+
+require 'yahoo_weatherman/image'
+require 'yahoo_weatherman/response'
+
+module Weatherman
+  
+  VERSION = '0.2'
+
+  URI = 'http://weather.yahooapis.com/forecastrss'
+
+  I18N_YAML_DIR = File.expand_path(File.dirname(__FILE__) + '/../i18n/')
+
+  # = Client
+  #
+  # The weatherman client. Where it all begins.
+  #
+  class Client
+    attr_reader :options
+
+    def initialize(options = {})
+      @options = options
+    end
+    
+    #
+    # Just pass in a +woeid+ and it will return a Weatherman::Response object:w
+    #
+    def lookup_by_woeid(woeid)
+      raw = get request_url(woeid)
+      Response.new(raw, options[:lang])
+    end
+
+    private
+      def request_url(woeid)
+        URI + query_string(woeid)
+      end
+
+      def query_string(woeid)
+        "?w=#{woeid}&u=#{degrees_units}"
+      end
+
+      def degrees_units
+        options[:degrees_units] || 'c'
+      end
+
+      def get(url)
+        open(url) { |stream| stream.read } 
+      end
+  end
+
+end

data/spec/files/belo_horizonte.rss

@@ -0,0 +1,49 @@
+<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
+<rss version="2.0" xmlns:yweather="http://xml.weather.yahoo.com/ns/rss/1.0" xmlns:geo="http://www.w3.org/2003/01/geo/wgs84_pos#">
+<channel>
+
+<title>Yahoo! Weather - Belo Horizonte, BR</title>
+<link>http://us.rd.yahoo.com/dailynews/rss/weather/Belo_Horizonte__BR/*http://weather.yahoo.com/forecast/BRXX0033_c.html</link>
+<description>Yahoo! Weather for Belo Horizonte, BR</description>
+<language>en-us</language>
+<lastBuildDate>Sat, 13 Mar 2010 6:00 pm LST</lastBuildDate>
+<ttl>60</ttl>
+<yweather:location city="Belo Horizonte" region="MG"   country="Brazil"/>
+
+<yweather:units temperature="C" distance="km" pressure="mb" speed="km/h"/>
+<yweather:wind chill="28"   direction="340"   speed="9.66" />
+<yweather:atmosphere humidity="62"  visibility="9.99"  pressure="982.05"  rising="0" />
+<yweather:astronomy sunrise="5:57 am"   sunset="6:13 pm"/>
+<image>
+<title>Yahoo! Weather</title>
+<width>142</width>
+<height>18</height>
+<link>http://weather.yahoo.com</link>
+<url>http://l.yimg.com/a/i/us/nws/th/main_142b.gif</url>
+</image>
+<item>
+
+<title>Conditions for Belo Horizonte, BR at 6:00 pm LST</title>
+<geo:lat>-19.95</geo:lat>
+<geo:long>-43.93</geo:long>
+<link>http://us.rd.yahoo.com/dailynews/rss/weather/Belo_Horizonte__BR/*http://weather.yahoo.com/forecast/BRXX0033_c.html</link>
+<pubDate>Sat, 13 Mar 2010 6:00 pm LST</pubDate>
+<yweather:condition  text="Mostly Cloudy"  code="28"  temp="28"  date="Sat, 13 Mar 2010 6:00 pm LST" />
+<description><![CDATA[
+<img src="http://l.yimg.com/a/i/us/we/52/28.gif"/><br />
+<b>Current Conditions:</b><br />
+Mostly Cloudy, 28 C<BR />
+<BR /><b>Forecast:</b><BR />
+Sat - Showers. High: 27 Low: 18<br />
+Sun - Scattered Thunderstorms. High: 27 Low: 18<br />
+<br />
+<a href="http://us.rd.yahoo.com/dailynews/rss/weather/Belo_Horizonte__BR/*http://weather.yahoo.com/forecast/BRXX0033_c.html">Full Forecast at Yahoo! Weather</a><BR/><BR/>
+(provided by <a href="http://www.weather.com" >The Weather Channel</a>)<br/>
+]]></description>
+<yweather:forecast day="Sat" date="13 Mar 2010" low="18" high="27" text="Showers" code="11" />
+<yweather:forecast day="Sun" date="14 Mar 2010" low="18" high="27" text="Scattered Thunderstorms" code="38" />
+<guid isPermaLink="false">BRXX0033_2010_03_13_18_00_LST</guid>
+</item>
+
+</channel>
+</rss><!-- api5.weather.ac4.yahoo.com compressed/chunked Sat Mar 13 14:29:51 PST 2010 -->

data/spec/spec_helper.rb

@@ -0,0 +1,15 @@
+path = File.expand_path(File.dirname(__FILE__) + "/../lib/")
+$LOAD_PATH.unshift(path) unless $LOAD_PATH.include?(path)
+
+require 'rubygems'
+require 'fakeweb'
+require 'yahoo_weatherman'
+require 'spec'
+
+def fixture
+  filepath = File.expand_path(File.dirname(__FILE__) + "/files/belo_horizonte.rss")
+  File.read filepath
+end
+
+FakeWeb.allow_net_connect = false
+FakeWeb.register_uri(:get, "http://weather.yahooapis.com/forecastrss?w=455821&u=c", :body => fixture)

data/spec/yahoo_weatherman/response_spec.rb

@@ -0,0 +1,104 @@
+require 'spec_helper'
+
+describe Weatherman::Response do
+  before do
+    @response = Weatherman::Client.new.lookup_by_woeid 455821
+  end
+
+  it 'should provide a location' do
+    @response.location['city'].should == 'Belo Horizonte'
+    @response.location['region'].should == 'MG'
+    @response.location['country'].should == 'Brazil'
+  end
+
+  it 'should provide a weather condition' do
+    @response.condition['code'].should ==  28
+    @response.condition['temp'].should == 28
+    @response.condition['text'].should == 'Mostly Cloudy'
+    @response.condition['date'].should == Date.parse('Sat, 13 Mar 2010 11:00 pm LST')
+  end
+
+  it 'should provide the units used' do
+    @response.units['temperature'].should == 'C'
+    @response.units['distance'].should == 'km'
+    @response.units['pressure'].should == 'mb'
+    @response.units['speed'].should == 'km/h'
+  end
+
+  it 'should provide information about the wind' do
+    @response.wind['chill'].should == 28
+    @response.wind['direction'].should == 340
+    @response.wind['speed'].should == 9.66
+  end
+
+  it 'should provide astronomy information' do
+    @response.astronomy['sunrise'].should == '5:57 am'
+    @response.astronomy['sunset'].should == '6:13 pm'
+  end
+
+  it 'should get the next 2 forecasts' do
+    first = @response.forecasts.first
+    first['day'].should == 'Sat'
+    first['date'].should == Date.parse('13 Mar 2010')
+    first['low'].should == 18
+    first['high'].should == 27
+    first['text'].should == 'Showers'
+    first['code'].should == 11
+
+    last = @response.forecasts.last
+    last['day'].should == 'Sun'
+    last['date'].should == Date.parse('14 Mar 2010')
+    last['low'].should == 18
+    last['high'].should == 27
+    last['text'].should == 'Scattered Thunderstorms'
+    last['code'].should == 38
+  end
+
+  it 'it should provide latitude and longitude' do
+    @response.latitude.should == -19.95
+    @response.longitude.should == -43.93
+  end
+
+  it 'should provide a description' do
+    description = <<-DESCRIPTION
+
+<img src="http://l.yimg.com/a/i/us/we/52/28.gif"/><br />
+<b>Current Conditions:</b><br />
+Mostly Cloudy, 28 C<BR />
+<BR /><b>Forecast:</b><BR />
+Sat - Showers. High: 27 Low: 18<br />
+Sun - Scattered Thunderstorms. High: 27 Low: 18<br />
+<br />
+<a href="http://us.rd.yahoo.com/dailynews/rss/weather/Belo_Horizonte__BR/*http://weather.yahoo.com/forecast/BRXX0033_c.html">Full Forecast at Yahoo! Weather</a><BR/><BR/>
+(provided by <a href="http://www.weather.com" >The Weather Channel</a>)<br/>
+DESCRIPTION
+
+    @response.description.should == description
+  end
+
+  it 'should provide the weather image attributes' do
+    image = @response.image
+    image['width'].should == 142
+    image['height'].should == 18
+    image['title'].should == 'Yahoo! Weather'
+    image['link'].should == 'http://weather.yahoo.com'
+    image['url'].should == 'http://l.yimg.com/a/i/us/nws/th/main_142b.gif'
+  end
+
+  context 'using internationalization' do
+    before do
+      @response = Weatherman::Client.new(:lang => 'pt-br').lookup_by_woeid 455821
+    end
+
+    it 'should translate the response#conditions attributes' do
+      @response.condition['text'].should == 'Predominantemente Nublado'
+    end
+
+    it 'should translate the location details' do
+      @response.location['country'].should == 'Brasil'
+      @response.location['region'].should == 'Minas Gerais'
+      @response.location['city'].should == 'Belzonti'
+    end
+
+  end
+end

data/spec/yahoo_weatherman/yahoo_weatherman_spec.rb

@@ -0,0 +1,13 @@
+require 'spec_helper'
+
+describe Weatherman::Client do
+  before do
+    @client = Weatherman::Client.new
+  end
+
+  it 'should lookup by woeid' do
+    response = @client.lookup_by_woeid 455821
+    response.should be_instance_of Weatherman::Response
+  end
+
+end

data/yahoo_weatherman.gemspec

@@ -0,0 +1,14 @@
+Gem::Specification.new do |gem|
+  gem.name = "yahoo_weatherman"
+  gem.version = "0.2"
+  gem.authors = ["Dalto Curvelano Junior"]
+  gem.description = "A ruby wrapper to the Yahoo! Weather feed with i18n support."
+  gem.summary = "A ruby wrapper to the Yahoo! Weather feed with i18n support."
+  gem.files = [
+    "yahoo_weatherman.gemspec",
+    "lib/yahoo_weatherman/image.rb", "lib/yahoo_weatherman/response.rb", "lib/yahoo_weatherman.rb",
+    "i18n/pt-br.yml", "spec/files/belo_horizonte.rss", "spec/spec_helper.rb",
+    "spec/yahoo_weatherman/response_spec.rb", "spec/yahoo_weatherman/yahoo_weatherman_spec.rb"
+  ]
+  gem.homepage = "http://github.com/dlt/yahoo_weatherman"
+end

metadata

@@ -0,0 +1,69 @@
+--- !ruby/object:Gem::Specification 
+name: yahoo_weatherman
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 2
+  version: "0.2"
+platform: ruby
+authors: 
+- Dalto Curvelano Junior
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-03-15 00:00:00 -03:00
+default_executable: 
+dependencies: []
+
+description: A ruby wrapper to the Yahoo! Weather feed with i18n support.
+email: 
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- yahoo_weatherman.gemspec
+- lib/yahoo_weatherman/image.rb
+- lib/yahoo_weatherman/response.rb
+- lib/yahoo_weatherman.rb
+- i18n/pt-br.yml
+- spec/files/belo_horizonte.rss
+- spec/spec_helper.rb
+- spec/yahoo_weatherman/response_spec.rb
+- spec/yahoo_weatherman/yahoo_weatherman_spec.rb
+has_rdoc: true
+homepage: http://github.com/dlt/yahoo_weatherman
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: A ruby wrapper to the Yahoo! Weather feed with i18n support.
+test_files: []
+