barometer 0.3.2 → 0.5.0

data/lib/barometer/{services → weather_services}/yahoo.rb

@@ -1,6 +1,6 @@
 module Barometer
   #
-  # = Yahoo Weather
+  # = Yahoo! Weather
   # www.yahoo.com
   #
   # - key required: NO
@@ -15,8 +15,6 @@ module Barometer
   # - sun rise/set: YES (today only)
   # - provides timezone: PARTIAL (just short code)
   # - requires TZInfo: NO
-  # NOTE: since this only supports US, the short code can be used
-  #       to convert times (until yahoo location id support is added)
   #
   # == resources
   # - API: http://developer.yahoo.com/weather/
@@ -28,22 +26,27 @@ module Barometer
   #
   # where query can be:
   # - zipcode (US)
-  # - Yahoo Location ID (International) - not currently supported
+  # - Yahoo! Location ID [actually weather.com id] (International)
+  #
+  # = Yahoo! terms of use
+  # The feeds are provided free of charge for use by individuals and non-profit
+  # organizations for personal, non-commercial uses. We ask that you provide
+  # attribution to Yahoo! Weather in connection with your use of the feeds.
+  # If you provide this attribution in text, please use: "Yahoo! Weather." If you
+  # provide this attribution with a graphic, please use the Yahoo! Weather logo that
+  # we have included in the feed itself.
+  # We reserve all rights in and to the Yahoo! Weather logo, and your right to use
+  # the Yahoo! Weather logo is limited to providing attribution in connection with
+  # these RSS feeds. Yahoo! also reserves the right to require you to cease
+  # distributing these feeds at any time for any reason.
   #
   # == notes
-  # - the Yahoo Location ID is a propreitary number (possibly shared with weather.com)
-  #   so this driver currently does not provide a way to get/use this number,
-  #   therefore International support is currently missing
+  # - the Yahoo! Location ID is a propreitary number (shared with weather.com)
   #
-  class Yahoo < Service
-    
-    def self.accepted_formats
-      [:zipcode]
-    end
+  class WeatherService::Yahoo < WeatherService
     
-    def self.source_name
-      :yahoo
-    end
+    def self.source_name; :yahoo; end
+    def self.accepted_formats; [:zipcode, :weather_id]; end
     
     # these are the icon codes that indicate "wet", used by wet? function
     def self.wet_icon_codes
@@ -54,19 +57,14 @@ module Barometer
       codes = (29..34).to_a + [36]
       codes.collect {|c| c.to_s}
     end
-    
-    # override, only currently supports US
-    def self.supports_country?(query=nil)
-      query && query.country_code && query.country_code.downcase == "us"
-    end
 
     def self._measure(measurement, query, metric=true)
-      raise ArgumentError unless measurement.is_a?(Barometer::Measurement)
+      raise ArgumentError unless measurement.is_a?(Data::Measurement)
       raise ArgumentError unless query.is_a?(Barometer::Query)
       measurement.source = self.source_name
       
       begin
-        result = self.get_all(query.preferred, metric)
+        result = self.fetch(query.q, metric)
       rescue Timeout::Error => e
         return measurement
       end
@@ -75,7 +73,10 @@ module Barometer
       measurement.forecast = self.build_forecast(result, metric)
       measurement.location = self.build_location(result, query.geo)
       
-      # add to current
+      if result["title"] && result["link"]
+        measurement.links[result["title"]] = result["link"]
+      end
+      
       sun = nil
       if measurement.current
         sun = self.build_sun(result)
@@ -83,42 +84,87 @@ module Barometer
       end
       # use todays sun data for all future days
       if measurement.forecast && sun
-        start_date = Date.parse(measurement.current.local_time)
         measurement.forecast.each do |forecast|
-          days_in_future = forecast.date - start_date
-          forecast.sun = Barometer::Sun.add_days!(sun,days_in_future.to_i)
+          forecast.sun = sun
         end
       end
       
+      local_time = self.build_local_time(result)
+      if local_time
+        measurement.measured_at = local_time
+        measurement.current.current_at = local_time
+      end
+      
       measurement
     end
     
+def self.build_local_time(data)
+  if data
+    if data['item']
+      # what time is it now?
+      now_utc = Time.now.utc
+      
+      # get published date
+      pub_date = data['item']['pubDate']
+      
+      # get the TIME ZONE CODE
+      zone_match = pub_date.match(/ ([A-Z]*)$/) if pub_date
+      
+      if zone_match
+        zone = zone_match[1] 
+        
+        # try converting pub_date to utc
+#        pub_date_utc = Data::Zone.code_to_utc(Time.parse(pub_date), zone) if zone
+     
+        # how far back was this?
+ #       data_age_in_seconds = now_utc - pub_date_utc
+      
+        # is this older then 2 hours
+#        if (data_age_in_seconds < 0) || (data_age_in_seconds > (60 * 60 * 2))
+          # we may have converted the time wrong.
+          # if pub_date in the future, then?
+          # if pub_date too far back, then?
+        
+          # for now do nothing ... don't set measured_time
+#          return nil
+#        else
+          # everything seems fine
+          # convert now to the local time 
+          offset = Data::Zone.zone_to_offset(zone)
+          return Data::LocalTime.parse(now_utc + offset)
+#        end
+      end
+      nil
+    end
+  end
+end
+    
     def self.build_current(data, metric=true)
       raise ArgumentError unless data.is_a?(Hash)
-      current = CurrentMeasurement.new
+      current = Data::CurrentMeasurement.new
       if data
         if data['item'] && data['item']['yweather:condition']
           condition_result = data['item']['yweather:condition']
-          current.local_time = condition_result['date']
+          current.updated_at = Data::LocalDateTime.parse(condition_result['date'])
           current.icon = condition_result['code']
           current.condition = condition_result['text']
-          current.temperature = Temperature.new(metric)
+          current.temperature = Data::Temperature.new(metric)
           current.temperature << condition_result['temp']
         end
         if data['yweather:atmosphere']
           atmosphere_result = data['yweather:atmosphere']
           current.humidity = atmosphere_result['humidity'].to_i
-          current.pressure = Pressure.new(metric)
+          current.pressure = Data::Pressure.new(metric)
           current.pressure << atmosphere_result['pressure']
-          current.visibility = Distance.new(metric)
+          current.visibility = Data::Distance.new(metric)
           current.visibility << atmosphere_result['visibility']
         end
         if data['yweather:wind']
           wind_result = data['yweather:wind']
-          current.wind = Speed.new(metric)
+          current.wind = Data::Speed.new(metric)
           current.wind << wind_result['speed']
           current.wind.degrees = wind_result['degrees'].to_f
-          current.wind_chill = Temperature.new(metric)
+          current.wind_chill = Data::Temperature.new(metric)
           current.wind_chill << wind_result['chill']
         end
       end
@@ -133,13 +179,13 @@ module Barometer
          forecast_result = data['item']['yweather:forecast']
          
         forecast_result.each do |forecast|
-          forecast_measurement = ForecastMeasurement.new
+          forecast_measurement = Data::ForecastMeasurement.new
           forecast_measurement.icon = forecast['code']
           forecast_measurement.date = Date.parse(forecast['date'])
           forecast_measurement.condition = forecast['text']
-          forecast_measurement.high = Temperature.new(metric)
+          forecast_measurement.high = Data::Temperature.new(metric)
           forecast_measurement.high << forecast['high'].to_f
-          forecast_measurement.low = Temperature.new(metric)
+          forecast_measurement.low = Data::Temperature.new(metric)
           forecast_measurement.low << forecast['low'].to_f
           forecasts << forecast_measurement
         end
@@ -149,8 +195,8 @@ module Barometer
     
     def self.build_location(data, geo=nil)
       raise ArgumentError unless data.is_a?(Hash)
-      raise ArgumentError unless (geo.nil? || geo.is_a?(Barometer::Geo))
-      location = Location.new
+      raise ArgumentError unless (geo.nil? || geo.is_a?(Data::Geo))
+      location = Data::Location.new
       # use the geocoded data if available, otherwise get data from result
       if geo
         location.city = geo.locality
@@ -177,41 +223,16 @@ module Barometer
       raise ArgumentError unless data.is_a?(Hash)
       sun = nil
       if data && data['yweather:astronomy'] && data['item']
-        # get the TIME ZONE CODE
-        zone_match = data['item']['pubDate'].match(/ ([A-Z]*)$/)
-        zone = zone_match[1] if zone_match
-        # get the sun rise and set
-        rise = Barometer::Zone.merge(
-          data['yweather:astronomy']['sunrise'],
-          data['item']['pubDate'],
-          zone
-        )
-        set = Barometer::Zone.merge(
-          data['yweather:astronomy']['sunset'],
-          data['item']['pubDate'],
-          zone
-        )
-        sun = Sun.new(rise, set)
+        local_rise = Data::LocalTime.parse(data['yweather:astronomy']['sunrise'])
+        local_set = Data::LocalTime.parse(data['yweather:astronomy']['sunset'])
+        sun = Data::Sun.new(local_rise, local_set)
       end
-      sun || Sun.new
+      sun || Data::Sun.new
     end
 
-    # def self.build_timezone(data)
-    #   raise ArgumentError unless data.is_a?(Hash)
-    #   
-    #   timezone = nil
-    #   if data && data['simpleforecast'] &&
-    #      data['simpleforecast']['forecastday'] &&
-    #      data['simpleforecast']['forecastday'].first &&
-    #      data['simpleforecast']['forecastday'].first['date']
-    #     timezone = Barometer::Zone.new(Time.now.utc,data['simpleforecast']['forecastday'].first['date']['tz_long'])
-    #   end
-    #   timezone
-    # end
-    
     # use HTTParty to get the current weather
-    def self.get_all(query, metric=true)
-      Barometer::Yahoo.get(
+    def self.fetch(query, metric=true)
+      self.get(
         "http://weather.yahooapis.com/forecastrss",
         :query => {:p => query, :u => (metric ? 'c' : 'f')},
         :format => :xml,
@@ -220,55 +241,4 @@ module Barometer
     end
     
   end
-end
-
-# Condition Codes
-# 0   tornado
-# 1   tropical storm
-# 2   hurricane
-# 3   severe thunderstorms
-# 4   thunderstorms
-# 5   mixed rain and snow
-# 6   mixed rain and sleet
-# 7   mixed snow and sleet
-# 8   freezing drizzle
-# 9   drizzle
-# 10  freezing rain
-# 11  showers
-# 12  showers
-# 13  snow flurries
-# 14  light snow showers
-# 15  blowing snow
-# 16  snow
-# 17  hail
-# 18  sleet
-# 19  dust
-# 20  foggy
-# 21  haze
-# 22  smoky
-# 23  blustery
-# 24  windy
-# 25  cold
-# 26  cloudy
-# 27  mostly cloudy (night)
-# 28  mostly cloudy (day)
-# 29  partly cloudy (night)
-# 30  partly cloudy (day)
-# 31  clear (night)
-# 32  sunny
-# 33  fair (night)
-# 34  fair (day)
-# 35  mixed rain and hail
-# 36  hot
-# 37  isolated thunderstorms
-# 38  scattered thunderstorms
-# 39  scattered thunderstorms
-# 40  scattered showers
-# 41  heavy snow
-# 42  scattered snow showers
-# 43  heavy snow
-# 44  partly cloudy
-# 45  thundershowers
-# 46  snow showers
-# 47  isolated thundershowers
-# 3200  not available
+end

data/lib/barometer/web_services/geocode.rb

@@ -0,0 +1,33 @@
+module Barometer
+  #
+  # Web Service: Geocode
+  #
+  # uses Google Maps Geocoding service
+  #
+  class WebService::Geocode < WebService
+    
+    def self.fetch(query)
+      raise ArgumentError unless _is_a_query?(query)
+      return nil unless _has_geocode_key?
+      location = self.get(
+        "http://maps.google.com/maps/geo",
+        :query => {
+          :gl => query.country_code, :key => Barometer.google_geocode_key,
+          :output => "xml", :q => query.q
+        },
+        :format => :xml, :timeout => Barometer.timeout
+      )
+      location = location['kml']['Response'] if location && location['kml']
+      location ? (geo = Data::Geo.new(location)) : nil
+    end
+
+    private
+    
+    def self._has_geocode_key?
+      !Barometer.google_geocode_key.nil?
+    end
+    
+  end
+end
+
+

data/lib/barometer/web_services/weather_id.rb

@@ -0,0 +1,37 @@
+module Barometer
+  #
+  # Web Service: WeatherID
+  #
+  # uses Weather.com search to obtain a weather id
+  #
+  class WebService::WeatherID < WebService
+    
+    # get the weather_id for a given query
+    #
+    def self.fetch(query)
+      return nil unless query
+      raise ArgumentError unless _is_a_query?(query)
+      response = self.get(
+        "http://xoap.weather.com/search/search",
+        :query => { :where => query.q }, :format => :plain,
+        :timeout => Barometer.timeout
+      )
+    end
+
+    # get the location_date (geocode) for a given weather_id
+    #
+    def self.reverse(query)
+      return nil unless query
+      raise ArgumentError unless _is_a_query?(query)
+      self.get(
+        "http://weather.yahooapis.com/forecastrss",
+        :query => { :p => query.q },
+        :format => :xml,
+        :timeout => Barometer.timeout
+      )['rss']['channel']["yweather:location"]
+    end
+
+  end
+end
+
+

data/lib/barometer/web_services/web_service.rb

@@ -0,0 +1,32 @@
+require 'rubygems'
+require 'httparty'
+
+$:.unshift(File.dirname(__FILE__))
+require 'extensions/httparty'
+
+module Barometer
+  #
+  # Web Service Class
+  #
+  # This is a base class for creating web service api-consuming
+  # drivers.  Each driver inherits from this class.
+  # 
+  # Basically, all a service is required to do is take a query
+  # (ie "Paris") and return it corresponding data class
+  #
+  class WebService
+    # all web_service drivers will use the HTTParty gem
+    include HTTParty
+    
+    # STUB: define this method to actually retireve the data
+    def self.fetch(query=nil); raise NotImplementedError; end
+    
+    private
+    
+    def self._is_a_query?(object=nil)
+      return false unless object
+      object.is_a?(Barometer::Query)
+    end
+
+  end
+end 

data/lib/demometer/demometer.rb

@@ -3,15 +3,35 @@ require 'sinatra'
 require 'barometer'
 
 # load API keys
-keys = YAML.load_file(File.expand_path(File.join('~', '.barometer')))
-if keys["geocode_google"]
-  Barometer.google_geocode_key = keys["geocode_google"]
+@@config_file ||= File.expand_path(File.join('~', '.barometer'))
+keys = YAML.load_file(@@config_file)
+if keys["google"] && keys["google"]["geocode"]
+  Barometer.google_geocode_key = keys["google"]["geocode"]
 else
+  raise RunTimeError "no geocoding keys"
   exit
 end
 
 class Demometer < Sinatra::Default
 
+  def config_weather_dot_com
+    if File.exists?(@@config_file)
+    	keys = YAML.load_file(@@config_file)
+    	if keys["weather"] && keys["weather"]["partner"] && keys["weather"]["license"]
+    	  partner_key = keys["weather"]["partner"].to_s
+    	  license_key = keys["weather"]["license"].to_s
+      else
+        raise RunTimeError "no weather.com keys"
+        exit
+      end
+    else
+      File.open(@@config_file, 'w') {|f| f << "\nweather:\n  partner: PARTNER_KEY\n  license: LICENSE_KEY" }
+      raise RunTimeError "no weather.com keys"
+      exit
+    end
+    { :weather_dot_com => { :keys => { :partner => partner_key, :license => license_key } } }
+  end
+
   helpers do
     def data(title, value)
       return if value.nil?
@@ -29,7 +49,14 @@ class Demometer < Sinatra::Default
     metric = (params[:query][:metric].to_s == "1" ? true : false)
     
     # determine sources
-    Barometer.selection = { 1 => params[:query][:source].collect{|s| s.to_sym } }
+    Barometer.config = { 1 => params[:query][:source].collect{|s| s.to_sym } }
+    
+    # setup weather.com
+    if Barometer::Base.config && Barometer::Base.config[1] &&
+      Barometer::Base.config[1].include?(:weather_dot_com)
+      Barometer::Base.config[1].delete(:weather_dot_com)
+      Barometer::Base.config[1] << config_weather_dot_com
+    end
     
     if params[:query] && !params[:query][:q].empty?
       @barometer = Barometer.new(params[:query][:q])