jdpace-weatherman 0.1.0

data/README.rdoc

@@ -0,0 +1,93 @@
+= WeatherMan
+
+A Ruby Gem that wraps the Weather Channel, inc. XML data feed
+written by Jared Pace, Codeword: Studios (http://codewordstudios.com),
+based on the rweather[http://github.com/ckozus/rweather] gem by Carlos Kozuszko - http://www.ckozus.com.ar/blog/.
+
+== Dependencies
+
+1. XmlSimple
+	`gem install xml-simple`
+
+---------------------------
+
+== Installation
+
+
+	% sudo gem sources -a http://gems.github.com # (if you haven't already)
+	% sudo gem install jdpace-weatherman
+
+---------------------------
+
+== Usage
+
+
+Find or load a location:
+
+	require 'weather_man'
+	WeatherMan.partner_id = '0123456789'
+	WeatherMan.license_key = '0123456789abcdef'
+	
+	# Search for a location
+	# Returns an array of WeatherMan objects
+	locations = WeatherMan.search('New York')
+	
+	# or if you know the location id or just want to use a US Zip code
+	ny = WeatherMan.new('USNY0996')
+		
+Fetch the weather:
+		
+	# Fetch the current conditions and 5 day forecast in 'standard' units
+	weather = ny.fetch
+	
+	# Fetch only current conditions in metric units
+	weather = ny.fetch(:days => 0, :unit => 'm')
+	
+	# Fetch a 3 day forecast only
+	weather = ny.fetch(:days => 3, :current_conditions => false)
+		
+Look at the Current Conditions:
+
+	# current temperature
+	temp = weather.current_conditions.temperature
+	
+	feels_like = weather.current_conditions.feels_like
+	
+	wind_speed = weather.current_conditions.wind.speed
+	wind_direction = weather.current_conditions.wind.direction
+		
+Look at the forecast:
+
+	# how many days?
+	weather.forecast.size
+	
+	# Some different forecasts
+	weather.forecast.today
+	weather.forecast.tomorrow
+	weather.forecast.monday
+	weather.forecast.for(Date.today)
+	weather.forecast.for(3.days.from_now) # Note: using rails core extensions
+	weather.forecast.for('Sep 1')
+	
+	# data for a forecast
+	friday = weather.forecast.friday
+	
+	high_temp = friday.high
+	low_temp = friday.low
+	
+	# forecasts are split into 2 parts day/night
+	friday.day.description # Partly Cloudy, Sunny...
+	friday.day.chance_percipitation # 0..100
+	
+	night_wind_speed = friday.night.wind.speed
+		
+The Weather Channel requires that you 4 promotional links for them if you use their service. Here's how to access those links:
+
+	# The array of pr links
+	weather.links
+	
+	# Getting the first links text and url
+	weather.links.first.text
+	weather.links.first.url
+		
+<b>TODO:</b> Document all attributes

data/lib/weather_man.rb

@@ -0,0 +1,113 @@
+require 'net/http'
+require 'xmlsimple'
+require 'weather_man_response'
+
+# Raised if partner_id and license_key are not provided
+class WeatherManNotConfiguredError < StandardError
+end
+
+# Raised when the API returns an error
+class WeatherManApiError < StandardError
+end
+
+# Raised when a location is not found by id
+class WeatherManLocationNotFoundError < StandardError
+end
+
+class WeatherMan
+  VALID_UNITS = ['s', 'm']
+  DEFAULT_UNIT = 's' #standard
+  
+  # partner id and license key can be obtained
+  # when you sign up for the weather.com xml api at
+  # http://www.weather.com/services/xmloap.html
+  @@partner_id = nil
+  @@license_key = nil
+  def self.partner_id; @@partner_id; end;
+  def self.partner_id=(pid); @@partner_id = pid; end;
+  def self.license_key; @@license_key; end;
+  def self.license_key=(lk); @@license_key = lk; end;
+  
+  # id is the location id for the WeatherMan instance ie. 'USNY0996'
+  # name is the human readable name of the location ie. 'New York, NY'
+  attr_reader :id, :name
+  
+  def initialize(location_id, location_name = 'n/a')
+    @id = location_id
+    @name = location_name
+    
+    self.class.check_authentication
+  end
+  
+  def fetch(opts = {})
+    options = default_forecast_options.merge(opts)
+    api_url = weather_url(options) 
+    
+    WeatherManResponse.new(self.class.fetch_response(api_url), api_url)
+  end
+  
+  # Return an array of matching locations
+  def self.search(where)
+    # Make sure the partner id and license key have been provided
+    check_authentication
+    
+    if response = fetch_response(search_url(:where => where))
+      response['loc'] ? response['loc'].map {|location| new(location['id'], location['content'])} : []
+    end
+  end
+  
+  protected
+    # API url for accssing weather
+    def weather_url(options = {})
+      options = encode_options(options)
+      options[:unit] = options[:unit].to_s.downcase[0..0] if options[:unit] # Allows for :metric, 'metric', 'Metric', or standard 'm'
+
+      url  = "http://xoap.weather.com/weather/local/#{self.id}"
+      url << "?par=#{@@partner_id}"
+      url << "&key=#{@@license_key}"
+      url << "&prod=xoap"
+      url << "&link=xoap"
+      url << "&cc=*" if options[:current_conditions]
+      url << "&dayf=#{options[:days]}" if options[:days] && (1..5).include?(options[:days].to_i)
+      url << "&unit=#{options[:unit]}" if options[:unit] = (VALID_UNITS.include?(options[:unit]) ? options[:unit] : DEFAULT_UNIT)
+      url
+    end
+
+    def default_forecast_options
+      {
+        :current_conditions => true,
+        :days               => 5, # 0 - 5
+        :unit               => DEFAULT_UNIT
+      }
+    end
+    
+    # Encode a hash of options to be used as request parameters
+    def encode_options(options)
+      options.each do |key,value|
+        options[key] = URI.encode(value.to_s) unless value.is_a?(TrueClass) || value.is_a?(FalseClass)
+      end
+    end
+    
+    # Fetch Response from the api
+    def self.fetch_response(api_url)
+      xml_data = Net::HTTP.get_response(URI.parse(api_url)).body
+      response = XmlSimple.xml_in(xml_data)
+      
+      # Check if a response was returned at all
+      raise(WeatherManNoResponseError, "WeatherMan Error: No Response.") unless response
+      
+      # Check if API call threw an error
+      raise(WeatherManApiError, "WeatherMan Error #{response['err'][0]['type']}: #{response['err'][0]['content']}") if response['err']
+      
+      response
+    end
+    
+    def self.check_authentication
+      raise(WeatherManNotConfiguredError, 'A partner id and a license key must be provided before acessing the API') unless @@partner_id && @@license_key
+    end
+    
+    # API url for searching for locations
+    def self.search_url(options = {})
+      "http://xoap.weather.com/search/search?where=#{URI.encode(options[:where])}"
+    end
+end

data/lib/weather_man_response.rb

@@ -0,0 +1,200 @@
+require 'ostruct'
+
+class WeatherManResponse
+  attr_reader :current_conditions, :forecast, :api_url, :unit_temperature, :unit_distance, :unit_speed, :unit_pressure, :links
+  
+  def initialize(simple_xml, url = nil)
+    @current_conditions = simple_xml['cc'] ? build_current_conditions(simple_xml['cc'][0]) : nil
+    @forecast = simple_xml['dayf'] ? build_forecast(simple_xml['dayf'][0]['day']) : nil
+    
+    # Promotional links required by Weather Channel, Inc.
+    @links = simple_xml['lnks'] ? build_links(simple_xml['lnks'][0]['link']) : nil
+    
+    # Capture the units
+    @unit_temperature = simple_xml['head'][0]['ut'][0]
+    @unit_distance    = simple_xml['head'][0]['ud'][0]
+    @unit_speed       = simple_xml['head'][0]['us'][0]
+    @unit_pressure    = simple_xml['head'][0]['up'][0]
+    
+    # The api url that was called to generate this response
+    @api_url = url
+  end
+  
+  protected
+    def build_current_conditions(response = {})
+      return nil if response.nil? || response.empty?
+    
+      cc = WeatherManCurrentConditions.new
+    
+      # Parse out Current Conditions
+      cc.temperature          = response['tmp'][0]
+      cc.feels_like           = response['flik'][0]
+      cc.description          = response['t'][0]
+      cc.icon_code            = response['icon'][0]
+      cc.humidity             = response['hmid'][0]
+      cc.visibility           = response['vis'][0]
+      cc.dew_point            = response['dewp'][0]
+      cc.barometric_pressure  = WeatherManBarometer.new({
+                                  :reading      => response['bar'][0]['r'][0],
+                                  :description  => response['bar'][0]['d'][0]
+                                })
+      cc.wind                 = WeatherManWind.new({
+                                  :speed        => response['wind'][0]['s'][0],
+                                  :gust         => response['wind'][0]['gust'][0],
+                                  :degrees      => response['wind'][0]['d'][0],
+                                  :direction    => response['wind'][0]['t'][0]
+                                })
+      cc.uv                   = WeatherManUV.new({
+                                  :index        => response['uv'][0]['i'][0],
+                                  :description  => response['uv'][0]['t'][0]
+                                })
+      cc.moon                 = WeatherManMoon.new({
+                                  :icon_code    => response['moon'][0]['icon'][0],
+                                  :description  => response['moon'][0]['t'][0]
+                                })
+      cc    
+    end
+  
+    def build_forecast(days = [])
+      return nil if days.nil? || days.empty?
+    
+      f = WeatherManForecast.new
+      days.each do |day|
+        f << WeatherManForecastDay.build(day)
+      end
+      f
+    end
+    
+    def build_links(links = [])
+      return nil if links.nil? || links.empty?
+      
+      links.map {|link| WeatherManPromotionalLink.new({
+        :text => link['t'][0],
+        :url  => link['l'][0]
+      })}
+    end
+end
+
+class WeatherManCurrentConditions
+  attr_accessor :temperature,
+                :feels_like,
+                :description,
+                :icon_code, 
+                :humidity,
+                :visibility, 
+                :dew_point,
+                :barometric_pressure,
+                :wind,
+                :uv,
+                :moon
+end
+
+class WeatherManForecast < Array
+  WEEK_DAYS = %w(sunday monday tuesday wednesday thursday friday saturday)
+  WEEK_DAYS.each {|day| attr_reader day.to_sym}
+  
+  # Assign a forecast day to a week day accessor as it gets added
+  # allows for accessors like forecast.monday -> <WeatherManForecastDay>
+  def <<(day)
+    super
+    eval("@#{day.week_day.downcase} = day")
+  end
+  
+  def today
+    self[0]
+  end
+  
+  def tomorrow
+    self[1]
+  end
+  
+  # Returns a forecast for a day given by a Date, DateTime,
+  # Time, or a string that can be parsed to a date
+  def for(date = Date.today)
+    # Format date into a Date class
+    date = case date.class.name
+           when 'String'
+             Date.parse(date)
+           when 'Date'
+             date
+           when 'DateTime'
+             Date.new(date.year, date.month, date.day)
+           when 'Time'
+             Date.new(date.year, date.month, date.day)
+           end
+    
+    day = nil
+    # find the matching forecast day, if any
+    self.each do |fd|
+      day = fd if date == fd.date
+    end
+    return day
+  end
+end
+
+class WeatherManForecastDay
+  attr_accessor :week_day,
+                :date,
+                :high,
+                :low,
+                :sunrise,
+                :sunset,
+                :day,
+                :night
+  
+  # Build a new WeatherManForecastDay based on
+  # A response from the Weather Channel
+  def self.build(response = {})
+    fd = new
+    fd.week_day = response['t']
+    fd.date     = Date.parse(response['dt'])
+    fd.high     = response['hi'][0]
+    fd.low      = response['low'][0]
+    fd.sunrise  = response['sunr'][0]
+    fd.sunset   = response['suns'][0]
+    fd.day      = build_part(response['part'].first)
+    fd.night    = build_part(response['part'].last)
+    fd
+  end
+  
+  protected
+    # Build a part day
+    def self.build_part(part)
+      WeatherManForecastPart.new({
+        :icon_code            => part['icon'][0],
+        :description          => part['t'][0],
+        :chance_percipitation => part['ppcp'][0],
+        :humidity             => part['hmid'][0],
+        :wind                 => WeatherManWind.new({
+                                   :speed     => part['wind'][0]['s'][0],
+                                   :gust      => part['wind'][0]['gust'][0],
+                                   :degrees   => part['wind'][0]['d'][0],
+                                   :direction => part['wind'][0]['t'][0]     
+                                 })
+      })
+    end
+end
+
+# =================================
+# WeatherMan Response classes
+# used for tracking groups of data
+# ie. Forecast parts, Barometer,
+# UV, Moon, and Wind
+# =================================
+class WeatherManForecastPart < OpenStruct
+end
+
+class WeatherManBarometer < OpenStruct
+end
+
+class WeatherManUV < OpenStruct
+end
+
+class WeatherManMoon < OpenStruct
+end
+
+class WeatherManWind < OpenStruct
+end
+
+class WeatherManPromotionalLink < OpenStruct
+end

data/spec/cc_only_response.xml

@@ -0,0 +1,72 @@
+<?xml version="1.0" encoding="ISO-8859-1"?>
+<!-- This document is intended only for use by authorized licensees of The  -->
+<!-- Weather Channel. Unauthorized use is prohibited.  Copyright 1995-2008, -->
+<!-- The Weather Channel Interactive, Inc.  All Rights Reserved.            -->
+<weather ver="2.0">
+  <head>
+    <locale>en_US</locale>
+    <form>MEDIUM</form>
+    <ut>F</ut>
+    <ud>mi</ud>
+    <us>mph</us>
+    <up>in</up>
+    <ur>in</ur>
+  </head>
+  <loc id="28277">
+    <dnam>Charlotte, NC (28277)</dnam>
+    <tm>8:34 PM</tm>
+    <lat>35.06</lat>
+    <lon>-80.81</lon>
+    <sunr>7:18 AM</sunr>
+    <suns>7:08 PM</suns>
+    <zone>-4</zone>
+  </loc>
+
+  <lnks type="prmo">
+    <link pos="1">
+      <l>http://www.weather.com/allergies?par=xoap&amp;site=textlink&amp;cm_ven=XOAP&amp;cm_cat=TextLink&amp;cm_pla=Link1&amp;cm_ite=Allergies</l>
+      <t>Local Pollen Reports</t>
+    </link>
+    <link pos="2">
+      <l>http://www.weather.com/flights?par=xoap&amp;site=textlink&amp;cm_ven=XOAP&amp;cm_cat=TextLink&amp;cm_pla=Link2&amp;cm_ite=BusinessTraveler</l>
+      <t>Airport Conditions</t>
+    </link>
+    <link pos="3">
+      <l>http://www.weather.com/garden?par=xoap&amp;site=textlink&amp;cm_ven=XOAP&amp;cm_cat=TextLink&amp;cm_pla=Link3&amp;cm_ite=Garden</l>
+      <t>Lawn and Garden Weather</t>
+    </link>
+    <link pos="4">
+      <l>http://www.weather.com/traffic?par=xoap&amp;site=textlink&amp;cm_ven=XOAP&amp;cm_cat=TextLink&amp;cm_pla=Link4&amp;cm_ite=Traffic</l>
+      <t>Rush Hour Traffic</t>
+    </link>
+  </lnks>
+  <cc>
+    <lsup>9/29/08 8:25 PM EDT</lsup>
+    <obst>Matthews, NC</obst>
+    <tmp>69</tmp>
+    <flik>69</flik>
+    <t>Clear</t>
+    <icon>31</icon>
+    <bar>
+      <r>29.97</r>
+      <d>steady</d>
+    </bar>
+    <wind>
+      <s>1</s>
+      <gust>N/A</gust>
+      <d>30</d>
+      <t>NNE</t>
+    </wind>
+    <hmid>78</hmid>
+    <vis>9.0</vis>
+    <uv>
+      <i>0</i>
+      <t>Low</t>
+    </uv>
+    <dewp>62</dewp>
+    <moon>
+      <icon>0</icon>
+      <t>New</t>
+    </moon>
+  </cc>
+</weather>

data/spec/default_response.xml

@@ -0,0 +1,234 @@
+<?xml version="1.0" encoding="ISO-8859-1"?>
+<!-- This document is intended only for use by authorized licensees of The  -->
+<!-- Weather Channel. Unauthorized use is prohibited.  Copyright 1995-2008, -->
+<!-- The Weather Channel Interactive, Inc.  All Rights Reserved.            -->
+<weather ver="2.0">
+  <head>
+    <locale>en_US</locale>
+    <form>MEDIUM</form>
+    <ut>F</ut>
+    <ud>mi</ud>
+    <us>mph</us>
+    <up>in</up>
+    <ur>in</ur>
+  </head>
+  <loc id="28277">
+    <dnam>Charlotte, NC (28277)</dnam>
+    <tm>7:17 PM</tm>
+    <lat>35.06</lat>
+    <lon>-80.81</lon>
+    <sunr>7:17 AM</sunr>
+    <suns>7:09 PM</suns>
+    <zone>-4</zone>
+  </loc>
+  <lnks type="prmo">
+    <link pos="1">
+      <l>http://www.weather.com/allergies?par=xoap&amp;site=textlink&amp;cm_ven=XOAP&amp;cm_cat=TextLink&amp;cm_pla=Link1&amp;cm_ite=Allergies</l>
+      <t>Local Pollen Reports</t>
+    </link>
+    <link pos="2">
+      <l>http://www.weather.com/flights?par=xoap&amp;site=textlink&amp;cm_ven=XOAP&amp;cm_cat=TextLink&amp;cm_pla=Link2&amp;cm_ite=BusinessTraveler</l>
+      <t>Airport Conditions</t>
+    </link>
+    <link pos="3">
+      <l>http://www.weather.com/garden?par=xoap&amp;site=textlink&amp;cm_ven=XOAP&amp;cm_cat=TextLink&amp;cm_pla=Link3&amp;cm_ite=Garden</l>
+      <t>Lawn and Garden Weather</t>
+    </link>
+    <link pos="4">
+      <l>http://www.weather.com/traffic?par=xoap&amp;site=textlink&amp;cm_ven=XOAP&amp;cm_cat=TextLink&amp;cm_pla=Link4&amp;cm_ite=Traffic</l>
+      <t>Rush Hour Traffic</t>
+    </link>
+  </lnks>
+  <cc>
+    <lsup>9/29/08 7:05 PM EDT</lsup>
+    <obst>Matthews, NC</obst>
+    <tmp>73</tmp>
+    <flik>73</flik>
+    <t>Sunny</t>
+    <icon>32</icon>
+    <bar>
+      <r>29.97</r>
+      <d>steady</d>
+    </bar>
+    <wind>
+      <s>calm</s>
+      <gust>N/A</gust>
+      <d>0</d>
+      <t>CALM</t>
+    </wind>
+    <hmid>66</hmid>
+    <vis>10.0</vis>
+    <uv>
+      <i>0</i>
+      <t>Low</t>
+    </uv>
+    <dewp>61</dewp>
+    <moon>
+      <icon>0</icon>
+      <t>New</t>
+    </moon>
+  </cc>
+  <dayf>
+    <lsup>9/29/08 6:16 PM EDT</lsup>
+    <day d="0" t="Monday" dt="Sep 29">
+      <hi>N/A</hi>
+      <low>59</low>
+      <sunr>7:17 AM</sunr>
+      <suns>7:09 PM</suns>
+      <part p="d">
+        <icon>44</icon>
+        <t>N/A</t>
+        <wind>
+          <s>N/A</s>
+          <gust>N/A</gust>
+          <d>N/A</d>
+          <t>N/A</t>
+        </wind>
+        <bt>N/A</bt>
+        <ppcp>10</ppcp>
+        <hmid>N/A</hmid>
+      </part>
+      <part p="n">
+        <icon>29</icon>
+        <t>Partly Cloudy</t>
+        <wind>
+          <s>3</s>
+          <gust>N/A</gust>
+          <d>56</d>
+          <t>NE</t>
+        </wind>
+        <bt>P Cloudy</bt>
+        <ppcp>10</ppcp>
+        <hmid>86</hmid>
+      </part>
+    </day>
+    <day d="1" t="Tuesday" dt="Sep 30">
+      <hi>82</hi>
+      <low>59</low>
+      <sunr>7:18 AM</sunr>
+      <suns>7:08 PM</suns>
+      <part p="d">
+        <icon>34</icon>
+        <t>Mostly Sunny</t>
+        <wind>
+          <s>7</s>
+          <gust>N/A</gust>
+          <d>267</d>
+          <t>W</t>
+        </wind>
+        <bt>M Sunny</bt>
+        <ppcp>20</ppcp>
+        <hmid>69</hmid>
+      </part>
+      <part p="n">
+        <icon>47</icon>
+        <t>Isolated T-Storms</t>
+        <wind>
+          <s>5</s>
+          <gust>N/A</gust>
+          <d>223</d>
+          <t>SW</t>
+        </wind>
+        <bt>Iso T-Storms</bt>
+        <ppcp>30</ppcp>
+        <hmid>83</hmid>
+      </part>
+    </day>
+    <day d="2" t="Wednesday" dt="Oct 1">
+      <hi>74</hi>
+      <low>51</low>
+      <sunr>7:19 AM</sunr>
+      <suns>7:07 PM</suns>
+      <part p="d">
+        <icon>34</icon>
+        <t>Mostly Sunny</t>
+        <wind>
+          <s>9</s>
+          <gust>N/A</gust>
+          <d>309</d>
+          <t>NW</t>
+        </wind>
+        <bt>M Sunny</bt>
+        <ppcp>20</ppcp>
+        <hmid>63</hmid>
+      </part>
+      <part p="n">
+        <icon>31</icon>
+        <t>Clear</t>
+        <wind>
+          <s>5</s>
+          <gust>N/A</gust>
+          <d>328</d>
+          <t>NNW</t>
+        </wind>
+        <bt>Clear</bt>
+        <ppcp>20</ppcp>
+        <hmid>71</hmid>
+      </part>
+    </day>
+    <day d="3" t="Thursday" dt="Oct 2">
+      <hi>69</hi>
+      <low>47</low>
+      <sunr>7:19 AM</sunr>
+      <suns>7:05 PM</suns>
+      <part p="d">
+        <icon>32</icon>
+        <t>Sunny</t>
+        <wind>
+          <s>4</s>
+          <gust>N/A</gust>
+          <d>316</d>
+          <t>NW</t>
+        </wind>
+        <bt>Sunny</bt>
+        <ppcp>20</ppcp>
+        <hmid>63</hmid>
+      </part>
+      <part p="n">
+        <icon>31</icon>
+        <t>Clear</t>
+        <wind>
+          <s>1</s>
+          <gust>N/A</gust>
+          <d>338</d>
+          <t>NNW</t>
+        </wind>
+        <bt>Clear</bt>
+        <ppcp>20</ppcp>
+        <hmid>76</hmid>
+      </part>
+    </day>
+    <day d="4" t="Friday" dt="Oct 3">
+      <hi>70</hi>
+      <low>50</low>
+      <sunr>7:20 AM</sunr>
+      <suns>7:04 PM</suns>
+      <part p="d">
+        <icon>32</icon>
+        <t>Sunny</t>
+        <wind>
+          <s>3</s>
+          <gust>N/A</gust>
+          <d>303</d>
+          <t>WNW</t>
+        </wind>
+        <bt>Sunny</bt>
+        <ppcp>20</ppcp>
+        <hmid>66</hmid>
+      </part>
+      <part p="n">
+        <icon>31</icon>
+        <t>Clear</t>
+        <wind>
+          <s>1</s>
+          <gust>N/A</gust>
+          <d>310</d>
+          <t>NW</t>
+        </wind>
+        <bt>Clear</bt>
+        <ppcp>10</ppcp>
+        <hmid>79</hmid>
+      </part>
+    </day>
+  </dayf>
+</weather>

data/spec/forecast_only_response.xml

@@ -0,0 +1,142 @@
+<?xml version="1.0" encoding="ISO-8859-1"?>
+<!-- This document is intended only for use by authorized licensees of The  -->
+<!-- Weather Channel. Unauthorized use is prohibited.  Copyright 1995-2008, -->
+<!-- The Weather Channel Interactive, Inc.  All Rights Reserved.            -->
+<weather ver="2.0">
+  <head>
+    <locale>en_US</locale>
+    <form>MEDIUM</form>
+    <ut>F</ut>
+    <ud>mi</ud>
+    <us>mph</us>
+    <up>in</up>
+    <ur>in</ur>
+  </head>
+  <loc id="28277">
+    <dnam>Charlotte, NC (28277)</dnam>
+    <tm>8:40 PM</tm>
+    <lat>35.06</lat>
+    <lon>-80.81</lon>
+    <sunr>7:18 AM</sunr>
+    <suns>7:08 PM</suns>
+    <zone>-4</zone>
+  </loc>
+  <lnks type="prmo">
+    <link pos="1">
+      <l>http://www.weather.com/allergies?par=xoap&amp;site=textlink&amp;cm_ven=XOAP&amp;cm_cat=TextLink&amp;cm_pla=Link1&amp;cm_ite=Allergies</l>
+      <t>Local Pollen Reports</t>
+    </link>
+    <link pos="2">
+      <l>http://www.weather.com/flights?par=xoap&amp;site=textlink&amp;cm_ven=XOAP&amp;cm_cat=TextLink&amp;cm_pla=Link2&amp;cm_ite=BusinessTraveler</l>
+      <t>Airport Conditions</t>
+    </link>
+    <link pos="3">
+      <l>http://www.weather.com/garden?par=xoap&amp;site=textlink&amp;cm_ven=XOAP&amp;cm_cat=TextLink&amp;cm_pla=Link3&amp;cm_ite=Garden</l>
+      <t>Lawn and Garden Weather</t>
+    </link>
+    <link pos="4">
+      <l>http://www.weather.com/traffic?par=xoap&amp;site=textlink&amp;cm_ven=XOAP&amp;cm_cat=TextLink&amp;cm_pla=Link4&amp;cm_ite=Traffic</l>
+      <t>Rush Hour Traffic</t>
+    </link>
+  </lnks>
+  <dayf>
+    <lsup>9/29/08 6:16 PM EDT</lsup>
+    <day d="0" t="Monday" dt="Sep 29">
+      <hi>N/A</hi>
+      <low>59</low>
+      <sunr>7:17 AM</sunr>
+      <suns>7:09 PM</suns>
+      <part p="d">
+        <icon>44</icon>
+        <t>N/A</t>
+        <wind>
+          <s>N/A</s>
+          <gust>N/A</gust>
+          <d>N/A</d>
+          <t>N/A</t>
+        </wind>
+        <bt>N/A</bt>
+        <ppcp>10</ppcp>
+        <hmid>N/A</hmid>
+      </part>
+      <part p="n">
+        <icon>29</icon>
+        <t>Partly Cloudy</t>
+        <wind>
+          <s>3</s>
+          <gust>N/A</gust>
+          <d>56</d>
+          <t>NE</t>
+        </wind>
+        <bt>P Cloudy</bt>
+        <ppcp>10</ppcp>
+        <hmid>86</hmid>
+      </part>
+    </day>
+    <day d="1" t="Tuesday" dt="Sep 30">
+      <hi>82</hi>
+      <low>59</low>
+      <sunr>7:18 AM</sunr>
+      <suns>7:08 PM</suns>
+      <part p="d">
+        <icon>34</icon>
+        <t>Mostly Sunny</t>
+        <wind>
+          <s>7</s>
+          <gust>N/A</gust>
+          <d>267</d>
+          <t>W</t>
+        </wind>
+        <bt>M Sunny</bt>
+        <ppcp>20</ppcp>
+        <hmid>69</hmid>
+      </part>
+      <part p="n">
+        <icon>47</icon>
+        <t>Isolated T-Storms</t>
+        <wind>
+          <s>5</s>
+          <gust>N/A</gust>
+          <d>223</d>
+          <t>SW</t>
+        </wind>
+        <bt>Iso T-Storms</bt>
+        <ppcp>30</ppcp>
+        <hmid>83</hmid>
+      </part>
+    </day>
+    <day d="2" t="Wednesday" dt="Oct 1">
+      <hi>74</hi>
+      <low>51</low>
+      <sunr>7:19 AM</sunr>
+      <suns>7:07 PM</suns>
+      <part p="d">
+        <icon>34</icon>
+        <t>Mostly Sunny</t>
+        <wind>
+          <s>9</s>
+          <gust>N/A</gust>
+          <d>309</d>
+          <t>NW</t>
+        </wind>
+        <bt>M Sunny</bt>
+        <ppcp>20</ppcp>
+        <hmid>63</hmid>
+      </part>
+      <part p="n">
+        <icon>31</icon>
+        <t>Clear</t>
+        <wind>
+          <s>5</s>
+          <gust>N/A</gust>
+
+          <d>328</d>
+          <t>NNW</t>
+        </wind>
+        <bt>Clear</bt>
+        <ppcp>20</ppcp>
+        <hmid>71</hmid>
+      </part>
+    </day>
+  </dayf>
+</weather>

data/spec/weather_man_response_spec.rb

@@ -0,0 +1,190 @@
+$: << '../lib'
+require 'weather_man_response'
+require 'xmlsimple'
+
+describe WeatherManResponse, 'built from a default response' do
+  before :each do
+    default_response = XmlSimple.xml_in(File.read('default_response.xml'))
+    @weather = WeatherManResponse.new(default_response, 'test')
+  end
+  
+  it 'should grab all the units' do
+    @weather.unit_temperature.should eql('F')
+    @weather.unit_distance.should eql('mi')
+    @weather.unit_speed.should eql('mph')
+    @weather.unit_pressure.should eql('in')
+  end
+  
+  it 'should build a CurrentConditions object' do
+    @weather.current_conditions.should be_kind_of(WeatherManCurrentConditions)
+  end
+  
+  it 'should build the current conditions correctly' do
+    cc = @weather.current_conditions
+    cc.temperature.should eql('73')
+    cc.feels_like.should eql('73')
+    cc.description.should eql('Sunny')
+    cc.icon_code.should eql('32')
+    cc.humidity.should eql('66')
+    cc.visibility.should eql('10.0')
+    cc.dew_point.should eql('61')
+    
+    # Barometric Pressure
+    cc.barometric_pressure.should be_kind_of(WeatherManBarometer)
+    cc.barometric_pressure.reading.should eql('29.97')
+    cc.barometric_pressure.description.should eql('steady')
+    
+    # Wind
+    cc.wind.should be_kind_of(WeatherManWind)
+    cc.wind.speed.should eql('calm')
+    cc.wind.gust.should eql('N/A')
+    cc.wind.degrees.should eql('0')
+    cc.wind.direction.should eql('CALM')
+    
+    # UV
+    cc.uv.should be_kind_of(WeatherManUV)
+    cc.uv.index.should eql('0')
+    cc.uv.description.should eql('Low')
+    
+    # Moon
+    cc.moon.should be_kind_of(WeatherManMoon)
+    cc.moon.icon_code.should eql('0')
+    cc.moon.description.should eql('New')
+  end
+  
+  it 'should build a forecast' do
+    @weather.forecast.should be_kind_of(WeatherManForecast)
+  end
+  
+  it 'should have a forecast for 5 days' do
+    @weather.forecast.size.should eql(5)
+  end
+  
+  it 'should build a correct forecast for today' do
+    today = @weather.forecast.today
+    today.should be_kind_of(WeatherManForecastDay)
+    
+    today.week_day.should eql('Monday')
+    today.date.should eql(Date.parse('Sep 29'))
+    today.high.should eql('N/A')
+    today.low.should eql('59')
+    today.sunrise.should eql('7:17 AM')
+    today.sunset.should eql('7:09 PM')
+    
+    # Day time part
+    today.day.should be_kind_of(WeatherManForecastPart)
+    today.day.icon_code.should eql('44')
+    today.day.description.should eql('N/A')
+    today.day.chance_percipitation.should eql('10')
+    today.day.humidity.should eql('N/A')
+    today.day.wind.should be_kind_of(WeatherManWind)
+    today.day.wind.speed.should eql('N/A')
+    today.day.wind.gust.should eql('N/A')
+    today.day.wind.degrees.should eql('N/A')
+    today.day.wind.direction.should eql('N/A')
+    
+    # Nite time part
+    today.night.should be_kind_of(WeatherManForecastPart)
+    today.night.icon_code.should eql('29')
+    today.night.description.should eql('Partly Cloudy')
+    today.night.chance_percipitation.should eql('10')
+    today.night.humidity.should eql('86')
+    today.night.wind.should be_kind_of(WeatherManWind)
+    today.night.wind.speed.should eql('3')
+    today.night.wind.gust.should eql('N/A')
+    today.night.wind.degrees.should eql('56')
+    today.night.wind.direction.should eql('NE')
+  end
+  
+  it 'should get a set of promotional links' do
+    @weather.links.should_not be_empty
+  end
+  
+  it 'should get exactly 4 links' do
+    @weather.links.size.should eql(4)
+  end
+  
+  it 'should have a set of links that are each objects' do
+    @weather.links.each do |link|
+      link.should be_kind_of(WeatherManPromotionalLink)
+    end
+  end
+  
+  it 'should build the promotional links correctly' do
+    link = @weather.links.first
+    link.text.should eql('Local Pollen Reports')
+    link.url.should eql('http://www.weather.com/allergies?par=xoap&site=textlink&cm_ven=XOAP&cm_cat=TextLink&cm_pla=Link1&cm_ite=Allergies')
+  end
+end
+
+describe WeatherManResponse, 'with only the current conditions' do
+  before :each do
+    cc_only_response = XmlSimple.xml_in(File.read('cc_only_response.xml'))
+    @weather = WeatherManResponse.new(cc_only_response, 'test')
+  end
+  
+  it 'should have a current_conditions object' do
+    @weather.current_conditions.should be_kind_of(WeatherManCurrentConditions)
+  end
+  
+  it 'should not have a forecast' do
+    @weather.forecast.should be_nil
+  end
+end
+
+describe WeatherManResponse, 'with only a 3 day forecast' do
+  before :each do
+    forecast_only_response = XmlSimple.xml_in(File.read('forecast_only_response.xml'))
+    @weather = WeatherManResponse.new(forecast_only_response, 'test')
+  end
+  
+  it 'should not have a current_conditions object' do
+    @weather.current_conditions.should be_nil
+  end
+  
+  it 'should have a forecast' do
+    @weather.forecast.should be_kind_of(WeatherManForecast)
+  end
+  
+  it 'should have a forecast for exactly 3 days' do
+    @weather.forecast.size.should eql(3)
+  end
+end
+
+describe WeatherManForecast, 'generated from a default response' do
+  before :each do
+    default_response = XmlSimple.xml_in(File.read('default_response.xml'))
+    @forecast = WeatherManResponse.new(default_response, 'test').forecast
+  end
+  
+  it 'should have some week day accessors' do
+    @forecast.monday.should be_kind_of(WeatherManForecastDay)
+    @forecast.tuesday.should be_kind_of(WeatherManForecastDay)
+    @forecast.wednesday.should be_kind_of(WeatherManForecastDay)
+    @forecast.thursday.should be_kind_of(WeatherManForecastDay)
+    @forecast.friday.should be_kind_of(WeatherManForecastDay)
+    @forecast.saturday.should be_nil
+    @forecast.sunday.should be_nil
+  end
+  
+  it 'should have some relative date helpers' do
+    @forecast.today.should eql(@forecast.first)
+    @forecast.tomorrow.should eql(@forecast[1])
+  end
+  
+  it 'should be able to get the forecast given a date' do
+    @forecast.for(Date.parse('Sep 29')).should eql(@forecast.today)
+  end
+  
+  it 'should be able to get the forecast given a time' do
+    @forecast.for(Time.at(1222750106)).should eql(@forecast.tomorrow)
+  end
+  
+  it 'should be able to get the forecast given a string representing a date' do
+    @forecast.for('Oct 1').should eql(@forecast.wednesday)
+  end
+  
+  it 'should return nil when asked for the forecast of a date it doesnt have' do
+    @forecast.for(Date.new(2050,1,1)).should be_nil
+  end
+end

data/spec/weather_man_spec.rb

@@ -0,0 +1,120 @@
+$: << '../lib'
+require 'weather_man'
+
+describe WeatherMan, 'trying to access the api before being configured' do
+  it 'should throw an error when searching' do
+    lambda {
+      WeatherMan.search('test')
+    }.should raise_error(WeatherManNotConfiguredError)
+  end
+  
+  it 'should throw an error when initializing' do
+    lambda {
+      WeatherMan.new('28115')
+    }.should raise_error(WeatherManNotConfiguredError)
+  end
+end
+
+describe WeatherMan, 'dealing with locations' do
+  before :each do
+    load_default_authentication
+  end
+  
+  it 'should be able to search for locations' do
+    WeatherMan.search('Charlotte').should_not be_empty
+  end
+  
+  it 'should return an array of instances when searching' do
+    WeatherMan.search('Charlotte').each do |location|
+      location.should be_kind_of(WeatherMan)
+    end
+  end
+  
+  it 'should be be able to able to initialize from a location id' do
+    WeatherMan.new('28115').should_not be_nil
+  end
+end
+
+describe WeatherMan, 'using a bad partner id / license key' do
+  before :each do
+    WeatherMan.partner_id = 'test'
+    WeatherMan.license_key = 'test'
+    @weatherman = WeatherMan.new('28115')
+  end
+  
+  it 'should raise an error when fetching the weather' do
+    lambda {
+      @weatherman.fetch
+    }.should raise_error(WeatherManApiError)
+  end
+end
+
+describe WeatherMan, 'trying to use a bad location id' do
+  before :each do
+    load_default_authentication
+    @weatherman = WeatherMan.new('test')
+  end
+  
+  it 'should raise an error when fetching the weather' do
+    lambda {
+      @weatherman.fetch
+    }.should raise_error(WeatherManApiError)
+  end
+end
+
+describe WeatherMan, 'fetching the weather' do
+  before :each do
+    load_default_authentication
+    @weather = WeatherMan.new('28277').fetch
+  end
+  
+  it 'should get the current conditions' do
+    @weather.current_conditions.should_not be_nil
+  end
+  
+  it 'should get a forecast' do
+    @weather.forecast.should_not be_nil
+  end
+  
+  it 'should get a forecast of 5 days by default' do
+    @weather.forecast.size.should eql(5)
+  end
+  
+  it 'should get the weather in standard units by default' do
+    @weather.unit_distance.should eql('mi')
+  end
+end
+
+describe WeatherMan, 'asking for different kinds of weather' do
+  before :each do
+    load_default_authentication
+    @charlotte = WeatherMan.new('28277')
+  end
+  
+  it 'should only not get the forecast when asking for 0 forecast days' do
+    weather = @charlotte.fetch(:days => 0)
+    weather.forecast.should be_nil
+  end
+  
+  it 'should only get the amount of days you ask for' do
+    weather = @charlotte.fetch(:days => 3)
+    weather.forecast.size.should eql(3)
+  end
+  
+  it 'should not get the current conditions if you tell it not to' do
+    weather = @charlotte.fetch(:current_conditions => false)
+    weather.current_conditions.should be_nil
+  end
+  
+  it 'should get the weather in metric when ask for it that way' do
+    weather = @charlotte.fetch(:unit => :metric)
+    weather.unit_distance.should eql('km')
+  end
+end
+
+def load_default_authentication
+  # Hey! Get your own.
+  # heres the link: http://www.weather.com/services/xmloap.html
+  WeatherMan.partner_id = '1075758518'
+  WeatherMan.license_key = '7c731d27fae916fb'
+end

metadata

@@ -0,0 +1,69 @@
+--- !ruby/object:Gem::Specification 
+name: jdpace-weatherman
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Jared Pace
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-09-29 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: xml-simple
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.0.11
+    version: 
+description: A wrapper for the Weather Channel, inc (weather.com) XML api covers most features of the api. Current Conditions, Forecasting, and access to the promotional links that you are required to display as part of the API TOS.
+email: jared@codewordstudios.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- lib/weather_man.rb
+- lib/weather_man_response.rb
+- spec/cc_only_response.xml
+- spec/default_response.xml
+- spec/forecast_only_response.xml
+- spec/weather_man_response_spec.rb
+- spec/weather_man_spec.rb
+- README.rdoc
+has_rdoc: true
+homepage: http://github.com/jdpace/weatherman
+post_install_message: 
+rdoc_options: 
+- --main
+- README.rdoc
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Ruby gem for accessing the Weather Channel XML API based on rweather.
+test_files: []
+