barometer 0.6.7 → 0.7.0

data/lib/barometer/weather_services/yahoo.rb

@@ -27,6 +27,7 @@ module Barometer
   # where query can be:
   # - zipcode (US)
   # - Yahoo! Location ID [actually weather.com id] (International)
+  # - Yahoo! 'Where on Earth ID [WOEID] (International)
   #
   # = Yahoo! terms of use
   # The feeds are provided free of charge for use by individuals and non-profit
@@ -42,6 +43,11 @@ module Barometer
   #
   # == notes
   # - the Yahoo! Location ID is a propreitary number (shared with weather.com)
+  # - the Yahoo! WOEID is only used by Yahoo!, and is a 32-bit number. Unfortunately
+  #   this number confilcts with US Zipcodes (ie the zipcode=90210 and the
+  #   WOEID=90210 cannot be destinguished and do not mean the same thing).  To
+  #   solve this, any 5 digit number will be dtected as a ZIPCODE.  To have a 
+  #   5 digit query be detected as a WOEID, prepend it with a 'w' (ie: w90210).
   #
   class WeatherService::Yahoo < WeatherService
     
@@ -51,8 +57,8 @@ module Barometer
     #
     
     def self._source_name; :yahoo; end
-    def self._accepted_formats; [:zipcode, :weather_id]; end
-    
+    def self._accepted_formats; [:zipcode, :weather_id, :woe_id]; end
+
     def self._wet_icon_codes
       codes = [1] + (3..18).to_a + [35] + (37..43).to_a + (45..47).to_a
       codes.collect {|c| c.to_s}
@@ -185,9 +191,14 @@ module Barometer
     def self._fetch(query, metric=true)
       return unless query
       puts "fetch yahoo: #{query.q}" if Barometer::debug?
+      options = {
+        :p => query.format == :woe_id ? nil : query.q,
+        :w => query.format == :woe_id ? query.q : nil,
+        :u => (metric ? 'c' : 'f')
+      }.delete_if {|k,v| v.nil? }
       self.get(
         "http://weather.yahooapis.com/forecastrss",
-        :query => {:p => query.q, :u => (metric ? 'c' : 'f')},
+        :query => options,
         :format => :xml,
         :timeout => Barometer.timeout
       )['rss']['channel']

data/lib/barometer/web_services/placemaker.rb

@@ -0,0 +1,95 @@
+module Barometer
+  #
+  # Web Service: Placemaker (by Yahoo!)
+  #
+  # Yahoo! Placemaker is a geoparsing web service,
+  # this uses Placemaker to obtain a WOEID, as only Yahoo knows them
+  #
+  class WebService::Placemaker < WebService
+    
+    # get the woe_id for a given query
+    #
+    def self.fetch(query)
+      
+      begin
+        require 'nokogiri'
+      rescue LoadError
+        puts "\n****\nTo use this functionality you will need to install Nokogiri >= 1.3.3\n****\n\n"
+        return nil
+      end
+      
+      puts "fetch woe_id: #{query.q}" if Barometer::debug?
+      return nil unless query
+      return nil unless _has_geocode_key?
+      raise ArgumentError unless _is_a_query?(query)
+      
+      # BUG: httparty doesn't seem to post correctly
+      # self.post(
+      #   'http://wherein.yahooapis.com/v1/document',
+      #   :query => {
+      #     :documentType => "html",
+      #     :outputType => 'xml',
+      #     :documentContent => _adjust_query(query),
+      #    :appid => Barometer.yahoo_placemaker_app_id
+      #   }, :format => :xml, :timeout => Barometer.timeout
+      # )
+      
+      # TODO: include timeout
+      #   :timeout => Barometer.timeout
+      #
+      res = Net::HTTP.post_form(
+        URI.parse("http://wherein.yahooapis.com/v1/document"),
+        {
+          'documentType' => 'text/html',
+          'outputType' => 'xml',
+          'documentContent' => _adjust_query(query),
+          'appid' => Barometer.yahoo_placemaker_app_id
+        }
+      )
+      
+      Nokogiri::HTML.parse(res.body)
+    end
+
+    # get the location_data (geocode) for a given woe_id
+    #
+    def self.reverse(query)
+      puts "reverse woe_id: #{query.q}" if Barometer::debug?
+      return nil unless query
+      raise ArgumentError unless _is_a_query?(query)
+      self.get(
+        "http://weather.yahooapis.com/forecastrss",
+        :query => { :w => query.q },
+        :format => :xml,
+        :timeout => Barometer.timeout
+      )['rss']['channel']["yweather:location"]
+    end
+    
+    # parses a Nokogori doc object
+    #
+    def self.parse_woe_id(doc)
+      doc.search('woeid').first.content
+    end
+    
+    private
+    
+    # convert coordinates to a microformat version of coordinates
+    # so that Placemaker uses them correctly
+    #
+    def self._adjust_query(query)
+      output = query.q
+      if query.format == :coordinates
+        microformat = "<html><body><div class=\"geo\"><span class=\"latitude\">%s</span><span class=\"longitude\">%s</span></div></body></html>"
+        output = sprintf(microformat, query.latitude, query.longitude)
+      end
+      puts "placemaker adjusted query: #{output}" if Barometer::debug?
+      output
+    end
+
+    def self._has_geocode_key?
+      !Barometer.yahoo_placemaker_app_id.nil?
+    end
+
+  end
+end
+
+

data/lib/barometer/web_services/web_service.rb

@@ -1,9 +1,6 @@
 require 'rubygems'
 require 'httparty'
 
-$:.unshift(File.dirname(__FILE__))
-require 'extensions/httparty'
-
 module Barometer
   #
   # Web Service Class
@@ -20,7 +17,7 @@ module Barometer
     
     # 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)

data/spec/barometer_spec.rb

@@ -4,7 +4,8 @@ describe "Barometer" do
   
   before(:each) do
     @config_hash = { 1 => [:wunderground] }
-    @key = KEY
+    @google_key = KEY
+    @yahoo_key = YAHOO_KEY
   end
   
   describe "and class methods" do
@@ -23,9 +24,18 @@ describe "Barometer" do
     
     it "sets the Graticule Google geocoding API key" do
       Barometer.respond_to?("google_geocode_key").should be_true
+      Barometer.google_geocode_key = nil
       Barometer.google_geocode_key.should be_nil
-      Barometer.google_geocode_key = @key
-      Barometer.google_geocode_key.should == @key
+      Barometer.google_geocode_key = @google_key
+      Barometer.google_geocode_key.should == @google_key
+    end
+    
+    it "sets the Placemaker Yahoo! app ID" do
+      Barometer.respond_to?("yahoo_placemaker_app_id").should be_true
+      Barometer.yahoo_placemaker_app_id = nil
+      Barometer.yahoo_placemaker_app_id.should be_nil
+      Barometer.yahoo_placemaker_app_id = @yahoo_key
+      Barometer.yahoo_placemaker_app_id.should == @yahoo_key
     end
     
     it "forces the geocoding of queries" do
@@ -93,38 +103,10 @@ describe "Barometer" do
   describe "when measuring" do
     
     before(:each) do
-      Barometer.google_geocode_key = @key
+      Barometer.google_geocode_key = @google_key
       query_term = "Calgary,AB"
       @barometer = Barometer::Base.new(query_term)
       @time = Time.now
-      FakeWeb.register_uri(:get, 
-        "http://api.wunderground.com/auto/wui/geo/WXCurrentObXML/index.xml?query=#{CGI.escape(query_term)}",
-        :body => File.read(File.join(File.dirname(__FILE__), 
-          'fixtures/services/wunderground', 
-          'current_calgary_ab.xml')
-        )
-      )
-      FakeWeb.register_uri(:get, 
-        "http://api.wunderground.com/auto/wui/geo/ForecastXML/index.xml?query=#{CGI.escape(query_term)}",
-        :body => File.read(File.join(File.dirname(__FILE__), 
-          'fixtures/services/wunderground',
-          'forecast_calgary_ab.xml')
-        )
-      )
-      # FakeWeb.register_uri(:get, 
-      #   "http://maps.google.com/maps/geo?gl=&key=#{@key}&q=Calgary%2CAB&sensor=false&output=xml",
-      #   :body => File.read(File.join(File.dirname(__FILE__), 
-      #     'fixtures/geocode',
-      #     'calgary_ab.xml')
-      #   )
-      # )
-      FakeWeb.register_uri(:get, 
-        "http://maps.google.com/maps/geo?gl=&key=#{@key}&q=Calgary%2CAB&sensor=false&output=json",
-        :body => File.read(File.join(File.dirname(__FILE__), 
-          'fixtures/geocode',
-          'calgary_ab.json')
-        )
-      )
     end
     
     it "responds to measure" do

data/spec/data/local_datetime_spec.rb

@@ -144,7 +144,12 @@ describe "Data::LocalDateTime" do
       datetime.min.should == @m
       datetime.sec.should == @s
     end
-    
+
+    it "returns nil when string contains no date/time info" do
+      string = "Last Updated on , "
+      datetime = Data::LocalDateTime.parse(string)
+      datetime.should be_nil
+    end
   end
   
   describe "storing" do
@@ -266,4 +271,4 @@ describe "Data::LocalDateTime" do
     
   end
   
-end
+end

data/spec/data/zone_spec.rb

@@ -65,7 +65,10 @@ describe "Data::Zone" do
         zone.code.should be_nil
 
         zone = Data::Zone.new(@timezone)
-        zone.code.should == "CET"
+        # the expected result of this depends on the time of year
+        # when summer expect "CEST", otherwise "CET"
+        # just let TZINFO handle this
+        zone.code.should == TZInfo::Timezone.get(@timezone).period_for_utc(Time.now.utc).zone_identifier.to_s
       end
 
       it "responds to dst?" do
@@ -360,4 +363,4 @@ describe "Data::Zone" do
     
   end
   
-end
+end

data/spec/fakeweb_helper.rb

@@ -0,0 +1,158 @@
+require 'fakeweb'
+FakeWeb.allow_net_connect = false
+
+#
+# Set random test keys
+#
+KEY = "ABC123"
+WEATHER_PARTNER_KEY = "1234"
+WEATHER_LICENSE_KEY = "12345"
+WEATHERBUG_CODE = "A9999"
+YAHOO_KEY = "YAHOO"
+
+#
+# for geocoding
+#
+geo_url = "http://maps.google.com/maps/geo?"
+FakeWeb.register_uri(:get, 
+  "#{geo_url}gl=US&key=#{KEY}&sensor=false&q=90210&output=json",
+  :body => File.read(File.dirname(__FILE__) + '/fixtures/geocode/90210.json')
+)
+
+FakeWeb.register_uri(:get, 
+  "#{geo_url}gl=&q=#{CGI.escape("40.756054,-73.986951")}&output=json&key=#{KEY}&sensor=false",
+  :body => File.read(File.dirname(__FILE__) + '/fixtures/geocode/40_73.json')
+)
+
+FakeWeb.register_uri(:get, 
+  "#{geo_url}gl=&q=New%20York%2C%20NY&output=json&key=#{KEY}&sensor=false",
+  :body => File.read(File.dirname(__FILE__) + '/fixtures/geocode/newyork_ny.json')
+)
+FakeWeb.register_uri(:get, 
+  "#{geo_url}gl=CA&key=#{KEY}&output=json&q=T5B%204M9&sensor=false",
+  :body => File.read(File.dirname(__FILE__) + '/fixtures/geocode/T5B4M9.json')
+)
+FakeWeb.register_uri(:get, 
+  "#{geo_url}gl=US&q=KSFO&output=json&key=#{KEY}&sensor=false",
+  :body => File.read(File.dirname(__FILE__) + '/fixtures/geocode/ksfo.json')
+)
+FakeWeb.register_uri(:get, 
+  "#{geo_url}gl=&q=Atlanta%2C%20GA%2C%20US&output=json&key=#{KEY}&sensor=false",
+  :body => File.read(File.dirname(__FILE__) + '/fixtures/geocode/atlanta.json')
+)
+FakeWeb.register_uri(:get, 
+  "#{geo_url}output=xml&q=Atlanta%2C%20GA%2C%20US&gl=US&key=#{KEY}",
+  :body => File.read(File.dirname(__FILE__) + '/fixtures/geocode/atlanta.xml')
+)  
+FakeWeb.register_uri(:get, 
+  "#{geo_url}gl=&key=#{KEY}&q=Calgary%2CAB&sensor=false&output=json",
+  :body => File.read(File.dirname(__FILE__) + '/fixtures/geocode/calgary_ab.json')
+)
+#
+# for weather.com searches
+#
+FakeWeb.register_uri(:get, 
+  "http://xoap.weather.com:80/search/search?where=Beverly%20Hills%2C%20CA%2C%20USA",
+  :body => File.read(File.dirname(__FILE__) + '/fixtures/formats/weather_id/90210.xml')
+)
+FakeWeb.register_uri(:get, 
+  "http://xoap.weather.com:80/search/search?where=New%20York%2C%20NY",
+  :body => File.read(File.dirname(__FILE__) + '/fixtures/formats/weather_id/new_york.xml')
+)
+FakeWeb.register_uri(:get, 
+  "http://xoap.weather.com:80/search/search?where=New%20York%2C%20NY%2C%20USA",
+  :body => File.read(File.dirname(__FILE__) + '/fixtures/formats/weather_id/new_york.xml')
+)
+FakeWeb.register_uri(:get, 
+  "http://xoap.weather.com:80/search/search?where=90210",
+  :body => File.read(File.dirname(__FILE__) + '/fixtures/formats/weather_id/90210.xml')
+)
+FakeWeb.register_uri(:get, 
+  "http://xoap.weather.com:80/search/search?where=Millbrae%2C%20CA%2C%20USA",
+  :body => File.read(File.dirname(__FILE__) + '/fixtures/formats/weather_id/ksfo.xml')
+)
+#
+# for yahoo.com searches
+#
+FakeWeb.register_uri(:get, 
+  "http://weather.yahooapis.com:80/forecastrss?p=USGA0028",
+  :body => File.read(File.dirname(__FILE__) + '/fixtures/formats/weather_id/from_USGA0028.xml')
+)
+#
+# for Google weather
+#
+FakeWeb.register_uri(:get, 
+  "http://google.com/ig/api?weather=#{CGI.escape('Calgary,AB')}&hl=en-GB",
+  :body => File.read(File.dirname(__FILE__) + '/fixtures/services/google/calgary_ab.xml')
+)
+#
+# for WeatherBug weather
+#
+bug_url_current = "http://#{WEATHERBUG_CODE}.api.wxbug.net:80/getLiveWeatherRSS.aspx?"
+FakeWeb.register_uri(:get, 
+  "#{bug_url_current}ACode=#{WEATHERBUG_CODE}&OutputType=1&UnitType=1&zipCode=90210",
+  :body => File.read(File.dirname(__FILE__) + '/fixtures/services/weather_bug/90210_current.xml')
+)
+
+bug_url_future = "http://#{WEATHERBUG_CODE}.api.wxbug.net:80/getForecastRSS.aspx?"
+FakeWeb.register_uri(:get, 
+  "#{bug_url_future}ACode=#{WEATHERBUG_CODE}&OutputType=1&UnitType=1&zipCode=90210",
+  :body => File.read(File.dirname(__FILE__) + '/fixtures/services/weather_bug/90210_forecast.xml')
+)
+#
+# for weather.com weather
+#
+weather_com_url = "http://xoap.weather.com:80/weather/local/"
+FakeWeb.register_uri(:get, 
+  "#{weather_com_url}90210?dayf=5&unit=m&link=xoap&par=#{WEATHER_PARTNER_KEY}&prod=xoap&key=#{WEATHER_LICENSE_KEY}&cc=*",
+  :body => File.read(File.dirname(__FILE__) + '/fixtures/services/weather_dot_com/90210.xml')
+)
+#
+# for yahoo weather
+#
+FakeWeb.register_uri(:get, 
+  "http://weather.yahooapis.com:80/forecastrss?u=c&p=90210",
+  :body => File.read(File.dirname(__FILE__) + '/fixtures/services/yahoo/90210.xml')
+)
+
+#
+# For wunderground weather
+#
+FakeWeb.register_uri(:get, 
+  "http://api.wunderground.com/auto/wui/geo/WXCurrentObXML/index.xml?query=51.055149%2C-114.062438",
+  :body => File.read(File.dirname(__FILE__) + '/fixtures/services/wunderground/current_calgary_ab.xml')
+)  
+FakeWeb.register_uri(:get, 
+  "http://api.wunderground.com/auto/wui/geo/ForecastXML/index.xml?query=51.055149%2C-114.062438",
+  :body => File.read(File.dirname(__FILE__) + '/fixtures/services/wunderground/forecast_calgary_ab.xml')
+)  
+FakeWeb.register_uri(:get, 
+  "http://api.wunderground.com/auto/wui/geo/WXCurrentObXML/index.xml?query=#{CGI.escape('Calgary,AB')}",
+  :body => File.read(File.dirname(__FILE__) + '/fixtures/services/wunderground/current_calgary_ab.xml')
+)
+FakeWeb.register_uri(:get, 
+  "http://api.wunderground.com/auto/wui/geo/ForecastXML/index.xml?query=#{CGI.escape('Calgary,AB')}",
+  :body => File.read(File.dirname(__FILE__) + '/fixtures/services/wunderground/forecast_calgary_ab.xml')
+)
+
+#
+# For Placemaker
+#
+FakeWeb.register_uri(:post, 
+  "http://wherein.yahooapis.com/v1/document",
+  [
+    {:body => File.read(File.dirname(__FILE__) + '/fixtures/services/placemaker/the_hills.xml')},
+    {:body => File.read(File.dirname(__FILE__) + '/fixtures/services/placemaker/the_hills.xml')},
+    {:body => File.read(File.dirname(__FILE__) + '/fixtures/services/placemaker/the_hills.xml')},
+    {:body => File.read(File.dirname(__FILE__) + '/fixtures/services/placemaker/T5B4M9.xml')},  
+    {:body => File.read(File.dirname(__FILE__) + '/fixtures/services/placemaker/coords.xml')},
+    {:body => File.read(File.dirname(__FILE__) + '/fixtures/services/placemaker/new_york.xml')},
+    {:body => File.read(File.dirname(__FILE__) + '/fixtures/services/placemaker/atlanta.xml')},
+    {:body => File.read(File.dirname(__FILE__) + '/fixtures/services/placemaker/ksfo.xml')}
+  ]
+)
+
+FakeWeb.register_uri(:get, 
+  "http://weather.yahooapis.com/forecastrss?w=615702",
+  :body => File.read(File.dirname(__FILE__) + '/fixtures/services/placemaker/w615702.xml')
+)

data/spec/fixtures/services/placemaker/T5B4M9.xml

@@ -0,0 +1,65 @@
+<?xml version="1.0" encoding="utf-8"?>
+<contentlocation xmlns:yahoo="http://www.yahooapis.com/v1/base.rng" xmlns="http://wherein.yahooapis.com/v1/schema" xml:lang="en">
+  <processingTime>0.000986</processingTime>
+  <version> build 091119</version>
+  <documentLength>7</documentLength>
+  <document>
+    <administrativeScope>
+      <woeId>8676</woeId>
+      <type>Town</type>
+      <name><![CDATA[Edmonton, Alberta, CA]]></name>
+      <centroid>
+        <latitude>53.5462</latitude>
+        <longitude>-113.49</longitude>
+      </centroid>
+    </administrativeScope>
+    <geographicScope>
+      <woeId>24354344</woeId>
+      <type>Zip</type>
+      <name><![CDATA[T5B 4M9, Edmonton, Alberta, CA]]></name>
+      <centroid>
+        <latitude>53.5705</latitude>
+        <longitude>-113.458</longitude>
+      </centroid>
+    </geographicScope>
+    <extents>
+      <center>
+        <latitude>53.5705</latitude>
+        <longitude>-113.458</longitude>
+      </center>
+      <southWest>
+        <latitude>53.5695</latitude>
+        <longitude>-113.46</longitude>
+      </southWest>
+      <northEast>
+        <latitude>53.5715</latitude>
+        <longitude>-113.456</longitude>
+      </northEast>
+    </extents>
+    <placeDetails>
+      <place>
+        <woeId>24354344</woeId>
+        <type>Zip</type>
+        <name><![CDATA[T5B 4M9, Edmonton, Alberta, CA]]></name>
+        <centroid>
+          <latitude>53.5705</latitude>
+          <longitude>-113.458</longitude>
+        </centroid>
+      </place>
+      <matchType>0</matchType>
+      <weight>1</weight>
+      <confidence>7</confidence>
+    </placeDetails>
+    <referenceList>
+      <reference>
+        <woeIds>24354344</woeIds>
+        <start>0</start>
+        <end>7</end>
+        <isPlaintextMarker>1</isPlaintextMarker>
+        <text><![CDATA[T5B 4M9]]></text>
+        <type>plaintext</type>
+        <xpath><![CDATA[]]></xpath>
+      </reference>
+    </referenceList>
+  </document>
+</contentlocation>