barometer 0.3.2 → 0.5.0

data/README.rdoc

@@ -8,28 +8,39 @@ information, or they can be used in a hierarchical configuration where lower
 preferred weather services are only used if previous services are
 unavailable.
 
+Barometer handles all conversions of the supplied query, so that the
+same query can be used for all (or most) services, even if they don't
+support the query directly.
+
+For example, Yahoo! only accepts US Zip Code or Weather.com ID.  With Barometer
+you can query Yahoo! with a simple location (ie: Paris) and it will return the
+weather.
+
 == version
 
-Version 0.3.2 is the current release of this gem.
+Version 0.5.0 is the current release of this gem.
 The gem is available from github (attack-barometer) or rubyforge (barometer).
-It is fully functional (for three weather service APIs).
+It is fully functional (for four weather service APIs).
 
 == status
 
 Currently this project is in development and will only work for a few weather
-services (wunderground, google, yahoo).
+services (wunderground, google, yahoo, weather.com).
 
 Features to be added next:
-- even more weather service drivers (noaa, weather.com, weatherbug)
+- even more weather service drivers (noaa, weatherbug)
+- icon support
 
 = dependencies
 
-=== Google API key
+== Google API key
 
 In most cases you will need to have a free google geocode api key.
 Get one here: http://code.google.com/apis/maps/signup.html
-Then put it in the file '~/.barometer' by adding the line:
-geocode_google: YOUR_KEY_HERE
+Then put it in the file '~/.barometer' by adding the lines:
+
+  google:
+    geocode: YOUR_KEY_HERE
 
 You will need this for:
 - using the Barometer gem (unless you use queries that are directly supported
@@ -38,7 +49,17 @@ You will need this for:
 - running the Barometer binary
 - running the Barometer Web Demo
 
-=== HTTParty
+=== other keys
+
+The same file can hold all your weather service API keys.
+
+eg. weather.com
+
+  weather:
+    partner: YOUR_PARTNER_KEY
+    license: YOUR_LICENSE_KEY
+
+== HTTParty
 
 Why? HTTParty was created and designed specifically for consuming web services.
 I choose to use this over using the Net::HTTP library directly to allow for
@@ -46,34 +67,13 @@ faster development of this project.
 
 HTTParty is also extended to include configurable Timeout support.
 
-=== tzinfo
+== tzinfo
 
 Why? Barometer deals with time information for locations all over the world.
 This information doesn't mean that much if it can't be converted to times 
 that don't correspond to the applicable timezone.
 Tzinfo handles this time zone manipulation.
 
-=== graticule (very soft dependency)
-
-Why? Barometer returns the weather for a given location.  Most weather service
-APIs are somewhat restricted on the query format they receive.  To bridge
-this gap and allow for maximum flexibility on the 'barometer' query format,
-the query will be geo-coded using the Google geocoding service, if required.
-Graticule can provide this geocoding interface.
-
-Using Graticule requires a free Google API key for geocoding.  It is possible
-to use barometer without geocoding, though your query format will be
-limited to that of the weather service API.
-
-ALTERNATE: If you supply a Google API key but don't install the Graticule gem,
-HTTParty will be used instead to provide the same geocoding.  Basically
-Graticule is only used if it exists.
-
-NOTE: you can force Barometer not to use Graticule, even if you have it installed
-using the following:
-
-  Barometer.skip_graticule = true
-
 = usage
 
 You can use barometer right out of the box, as it is configured to use one
@@ -91,13 +91,45 @@ with geo-coding.
   
   puts weather.current.temperture
   
-== multiple weather API, with hierarchy
+== sources
+
+The available sources are:
+
+  Wunderground.com (:wunderground) [default]
+  Yahoo! Weather (:yahoo)
+  Google Weather (:google)
+  Weather.com (:weather_dot_com)
+  
+== source configuration
+
+Barometer can be configured to use multiple weather service APIs (either in
+a primary/failover config or in parallel).  Each weather service can also
+have its own config.
+
+Weather services in parallel
+
+  Barometer.config = { 1 => [:yahoo, :google] }
+  
+Weather services in primary/failover
+
+  Barometer.config = { 1 => [:yahoo], 2 => :wunderground }
+  
+Weather services, one with some configuration. In this case we are setting
+a weight value, this weight is respected when calculating averages.
+
+  Barometer.config = { 1 => [{:wunderground => {:weight => 2}}, :google] }
+  
+Weather services, one with keys.
+
+  Barometer.config = { 1 => [:yahoo, {:weather_dot_com => {:keys => {:partner => PARTNER_KEY, :license => LICENSE_KEY } }}] }
+  
+=== multiple weather API, with hierarchy
 
   require 'barometer'
   
   Barometer.google_geocode_key = "THE_GOOGLE_API_KEY"
   # use yahoo and google, if they both fail, use wunderground
-  Barometer.selection = { 1 => [:yahoo, :google], 2 => :wunderground }
+  Barometer.config = { 1 => [:yahoo, :google], 2 => :wunderground }
 
   barometer = Barometer.new("Paris")
   weather = barometer.measure
@@ -139,37 +171,6 @@ weather results for USA (at least at the time of writing).  Therefore,
 Barometer would not use Yahoo, just Google and failover to use Wunderground
 (if needed).
 
-=== bootstrapping
-
-You can use weather service drivers directly.  Below is an example to use
-Wunderground, but since the driver interface is abstracted it will be the
-same for all supported services.
-
-  require 'barometer'
-  Barometer.google_geocode_key = "THE_GOOGLE_API_KEY"
-  
-  query = Barometer::Query.new("Paris")
-  weather = Barometer::Service.source(:wunderground).measure(query)
-  
-  puts weather.current.temperture
-  
-  # OR, even more raw
-  
-  measurement = Barometer::Measurement.new
-  weather = Barometer::Wunderground.measure_all(measurement, "Paris")
-  
-  puts weather.current.temperture
-  
-  
-NOTE: The disadvantage to using the drivers directly is that you lose the
-advantage of redundancy/failover added by the Module as a whole.
-
-NOTE: You still must create the Barometer::Query object with your query
-string instead of directly feeding the query string to the service (as in
-bootstrap example #1).  The Barometer::Query object has behavior required
-by the service that a regular String doesn't have. Using a driver directly
-WILL accept a String (as in bootstrap example #2).
-
 == searching
 
 After you have measured the data, Barometer provides several methods to help
@@ -225,7 +226,7 @@ values).
   
   Barometer.google_geocode_key = "THE_GOOGLE_API_KEY"
   # use yahoo and wunderground
-  Barometer.selection = { 1 => [:yahoo, :wunderground] }
+  Barometer.config = { 1 => [:yahoo, :wunderground] }
 
   barometer = Barometer.new("90210")
   weather = barometer.measure
@@ -233,6 +234,12 @@ values).
   puts weather.temperture
 
 This will calculate the average temperature as given by :yahoo and :wunderground
+
+=== weights
+
+You can weight the values from a weather service so that the values from that
+web service have more influence then other values.  The weights are set in the
+config ... see the config section
   
 == simple answers
 
@@ -289,14 +296,15 @@ there will be no answer.
 - create a Barometer instance
 - supply a query, there are very little restrictions on the format:
   - city, country, specific address (basically anything Google will geocode)
-  - US zip code (skips geocoding if weather service accepts this directly)
-  - postal code (skips geocoding if weather service accepts this directly)
-  - latitude and longitude (skips geocoding if weather service accepts this
+  - US zip code (skips conversion if weather service accepts this directly)
+  - postal code (skips conversion if weather service accepts this directly)
+  - latitude and longitude (skips conversion if weather service accepts this
     directly)
-  - TODO: international airport code (skips geocoding if weather service
+  - weather.com weather id (even if the service you are using doesn't use it)
+  - international airport code (skips conversion if weather service
     accepts this directly)
-- if geocoding required, geocode the query
-- determine which weather services will be queried (one or multiple)
+- determine which weather services will be queried (one or multiple)    
+- if query conversion required for specific weather service, convert the query
 - query the weather services
 - save the data
 - repeat weather service queries as needed

data/VERSION.yml

@@ -1,4 +1,4 @@
 --- 
-:patch: 2
+:patch: 0
 :major: 0
-:minor: 3
+:minor: 5

data/bin/barometer

@@ -31,9 +31,10 @@
 #   -g, --geocode       Force Geocoding of query
 #   -m, --metric        measure in metric
 #   -i, --imperial      measure in imperial
-#   --no-wunderground   DONT use default wunderground as source
-#   --yahoo             use yahoo as source
-#   --google            use google as source
+#   --wunderground      add wunderground as a source
+#   --yahoo             add yahoo as a source
+#   --google            add google as a source
+#   --weather           add weather.com as a source
 #   -p, --pop           pop threshold used to determine wet?
 #   -s, --wind          wind speed threshold used to determine windy?
 #   -a, --at            time/date used to determine when to calculate summary
@@ -63,9 +64,9 @@ require 'yaml'
 
 # file where API keys are stored
 KEY_FILE = File.expand_path(File.join('~', '.barometer'))
+BAROMETER_VERSION = '0.5.0'
 
 class App
-  VERSION = '0.3.2'
   
   attr_reader :options
 
@@ -76,12 +77,12 @@ class App
     @options = OpenStruct.new
     @options.timeout = 15
     @options.geocode = false
-    @options.skip_graticule = false
     @options.metric = true
-    @options.sources = [:wunderground]
+    @options.sources = []
     @options.verbode = false
     @options.web = false
-    @options.at = Time.now.utc
+    @options.at = nil
+    @options.default = true
     
     # thresholds
     @options.windy_m = 10
@@ -118,18 +119,18 @@ class App
       opt.on('-V', '--verbose')    { @options.verbose = true }
       opt.on('-a n', '--at n')     {|n| @options.at = Time.parse(n.to_s) }
       opt.on('-t n', '--timeout n') {|n| @options.timeout = n }
-      opt.on('-w', '--web')        { @options.web = true; ARGV.shift }
       opt.on('-g', '--geocode')    { @options.geocode = true }
-      opt.on('--skip')             { @options.skip_graticule = true }
       opt.on('-m', '--metric')     { @options.metric = true }
       opt.on('-i', '--imperial')   { @options.metric = false }
-      opt.on('--no-wunderground')  { @options.sources = @options.sources.delete_if{|s| s == :wunderground} }
-      opt.on('--yahoo')            { @options.sources << :yahoo }
-      opt.on('--google')           { @options.sources << :google }
+      opt.on('--wunderground')     { @options.sources << :wunderground; @options.default = false }
+      opt.on('--yahoo')            { @options.sources << :yahoo; @options.default = false }
+      opt.on('--google')           { @options.sources << :google; @options.default = false }
+      opt.on('--weather')          { @options.sources << :weather_dot_com; @options.default = false }
       opt.on('-p n', '--pop n')    {|n| @options.pop = n.to_i || 50 }
       opt.on('-s n', '--wind n')   {|n| @options.metric ? @options.windy_m = n.to_f || 10 : @options.windy_i = n.to_f || 7 }
       
       # pass these onto vegas
+      opt.on('-w', '--web')        { @options.web = true; ARGV.shift }
       opt.on('-k', '--kill')       { @options.web = true }
       opt.on('-S', '--status')     { @options.web = true }
             
@@ -138,12 +139,35 @@ class App
       process_options
       true      
     end
+    
+    def config_weather_dot_com
+      if File.exists?(KEY_FILE)
+      	keys = YAML.load_file(KEY_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
+          weather_key_message
+          exit
+        end
+      else
+        File.open(KEY_FILE, 'w') {|f| f << "\nweather:\n  partner: PARTNER_KEY\n  license: LICENSE_KEY" }
+        weather_key_message
+        exit
+      end
+      { :weather_dot_com => { :keys => { :partner => partner_key, :license => license_key } } }
+    end
 
     # Performs post-parse processing on options
     def process_options
+      @options.sources << :wunderground if @options.default
+      @options.sources = @options.sources.uniq
       Barometer.force_geocode =  @options.geocode
-      Barometer.selection = { 1 => @options.sources.uniq }
-      Barometer.skip_graticule = @options.skip_graticule
+      if @options.sources.include?(:weather_dot_com)
+        @options.sources.delete(:weather_dot_com)
+        @options.sources << config_weather_dot_com
+      end
+      Barometer.config = { 1 => @options.sources }
       Barometer.timeout = @options.timeout
     end
     
@@ -184,9 +208,10 @@ class App
       puts "  -g, --geocode       Force Geocoding of query"
       puts "  -m, --metric        measure in metric"
       puts "  -i, --imperial      measure in imperial"
-      puts "  --no-wunderground   DONT use default wunderground as source"
-      puts "  --yahoo             use yahoo as source"
-      puts "  --google            use google as source"
+      puts "  --wunderground      add wunderground as a source"
+      puts "  --yahoo             add yahoo as a source"
+      puts "  --google            add google as a source"
+      puts "  --weather           add weather.com as a source"
       puts "  -p, --pop           pop threshold used to determine wet?"
       puts "  -s, --wind          wind speed threshold used to determine windy?"
       puts "  -a, --at            time/date used to determine when to calculate summary"
@@ -198,7 +223,7 @@ class App
     end
     
     def output_version
-      puts "#{File.basename(__FILE__)} version #{VERSION}"
+      puts "#{File.basename(__FILE__)} version #{BAROMETER_VERSION}"
     end
     
     def process_command
@@ -274,13 +299,19 @@ end
 
 def pretty_query(q)
   return unless q
-  section("QUERY", 2) do
-    pretty_hash({"Format" => q.format})
+  section("ORIGINAL QUERY", 1) do
     pretty_hash({
-      "Address" => q.geo.address,
-      "Locality" => q.geo.locality, "Region" => q.geo.region,
-      "Country" => q.geo.country, "Country Code" => q.geo.country_code,
-      "Latitude" => q.geo.latitude, "Longitude" => q.geo.longitude }) if q.geo
+      "Query" => q.q, "Format" => q.format,
+      "Country Code" => q.country_code })
+  end
+  if q.geo
+    section("GEO", 2) do
+      pretty_hash({
+        "Address" => q.geo.address, "Query" => q.geo.query,
+        "Locality" => q.geo.locality, "Region" => q.geo.region,
+        "Country" => q.geo.country, "Country Code" => q.geo.country_code,
+        "Latitude" => q.geo.latitude, "Longitude" => q.geo.longitude })
+    end
   end
 end
 
@@ -319,13 +350,14 @@ def pretty_current(c)
   return unless c
   section("CURRENT", 2) do
     pretty_hash({
-      "Time" => c.time, "Local Time" => c.local_time,
+      "Measured at" => c.current_at, "Updated at" => c.updated_at,
       "Humidity" => c.humidity, "Icon" => c.icon,
       "Condition" => c.condition, "Temperature" => c.temperature,
       "Dew Point" => c.dew_point, "Heat Index" => c.heat_index,
-      "Pressure" => c.pressure, "Visibility" => c.visibility })
-    pretty_hash({ "Wind Chill" => c.wind_chill, "Wind" => c.wind,
-      "Wind Direction" => c.wind.direction, "Degrees" => c.wind.degrees }) if c.wind
+      "Pressure" => c.pressure, "Visibility" => c.visibility,
+      "Wind Chill" => c.wind_chill })
+    pretty_hash({ "Wind" => c.wind, "Wind Direction" => c.wind.direction,
+      "Wind Degrees" => c.wind.degrees }) if c.wind
     pretty_hash({ "Sun Rise" => c.sun.rise, "Sun Set" => c.sun.set }) if c.sun
   end
 end
@@ -336,14 +368,26 @@ def pretty_forecast(f)
     pretty_hash({
       "Date" => f.date, "Icon" => f.icon,
       "Condition" => f.condition, "High" => f.high,
-      "Low" => f.low, "POP" => f.pop })
+      "Low" => f.low, "POP" => f.pop, "Humidity" => f.humidity })
+    pretty_hash({ "Wind" => f.wind, "Wind Direction" => f.wind.direction,
+      "Wind Degrees" => f.wind.degrees }) if f.wind
     pretty_hash({ "Sun Rise" => f.sun.rise, "Sun Set" => f.sun.set }) if f.sun
+    if f.night
+      puts
+      title("NIGHT", 4)
+      pretty_hash({
+        "Date" => f.night.date, "Icon" => f.night.icon,
+        "Condition" => f.night.condition, "POP" => f.night.pop,
+        "Humidity" => f.night.humidity })
+      pretty_hash({ "Wind" => f.night.wind, "Wind Direction" => f.night.wind.direction,
+        "Wind Degrees" => f.night.wind.degrees }) if f.night.wind
+    end
   end
 end
 
 def pretty_forecasts(forecasts)
   return unless forecasts
-  section("FORECAST", 3, false) do
+  section("FORECAST(s)", 3, false) do
     blank
     forecasts.each do |forecast|
       pretty_forecast(forecast)
@@ -355,9 +399,13 @@ def pretty_measurement(m)
   return unless m
   section(m.source.to_s, 1) do
     pretty_hash({
-      "Source" => m.source, "Time" => m.time,
+      "Measured At" => m.measured_at,
+      "Source" => m.source, "Time Stamp" => m.utc_time_stamp,
       "Metric" => m.metric?, "Success" => m.success? })
   end
+  section("MODIFIED QUERY", 2) do
+    pretty_hash({ "Query" => m.query, "Format" => m.format })
+  end
   pretty_location(m.location)
   pretty_station(m.station)
   pretty_timezone(m.timezone)
@@ -378,7 +426,7 @@ end
 def pretty_info
   title("INFO", 1)
   value("GitHub", "http://github.com/attack/barometer")
-  value("Barometer Version", VERSION)
+  value("Barometer Version", BAROMETER_VERSION)
 end
 
 def pretty_output(barometer)
@@ -400,6 +448,7 @@ end
 
 def run_web_mode(query=nil)
   
+  require 'rubygems'
   require File.expand_path(File.dirname(__FILE__) + '/../lib/demometer/demometer.rb')
   require 'vegas'
   
@@ -411,24 +460,38 @@ end
 
 def geocode_google_key_message
   puts
+  puts "MISSING KEYS !!!"
   puts "Please update the key_file '#{KEY_FILE}' with your google api key"
   puts "Get it here: http://code.google.com/apis/maps/signup.html"
-  puts "The, add this line to the file:"
-  puts "geocode_google: YOUR_KEY_KERE"
+  puts "Then, add this line to the file:"
+  puts "google:"
+  puts "  geocode: YOUR_KEY_KERE"
+  puts
+end
+
+def weather_key_message
+  puts
+  puts "MISSING KEYS !!!"
+  puts "Please update the key_file '#{KEY_FILE}' with your weather api keys"
+  puts "Get it here: ???"
+  puts "Then, add these lines to the file:"
+  puts "weather:"
+  puts "  partner: PARTNER_KEY"
+  puts "  license: LICENSE_KEY"
   puts
 end
 
 # set API keys
 if File.exists?(KEY_FILE)
 	keys = YAML.load_file(KEY_FILE)
-	if keys["geocode_google"]
-	  Barometer.google_geocode_key = keys["geocode_google"]
+	if keys["google"] && keys["google"]["geocode"]
+	  Barometer.google_geocode_key = keys["google"]["geocode"]
   else
     geocode_google_key_message
     exit
   end
 else
-  File.open(KEY_FILE, 'w') {|f| f << "geocode_google: YOUR_KEY_KERE" }
+  File.open(KEY_FILE, 'w') {|f| f << "google: geocode: YOUR_KEY_KERE" }
   geocode_google_key_message
   exit
 end