barometer 0.3.2 → 0.5.0

data/lib/barometer.rb

@@ -5,6 +5,7 @@ require 'barometer/query'
 require 'barometer/weather'
 require 'barometer/services'
 require 'barometer/data'
+require 'barometer/formats'
  
 module Barometer
   
@@ -12,21 +13,20 @@ module Barometer
   def self.google_geocode_key; @@google_geocode_key; end;
   def self.google_geocode_key=(key); @@google_geocode_key = key; end;
   
-  @@skip_graticule = false
-  def self.skip_graticule; @@skip_graticule; end;
-  def self.skip_graticule=(value); @@skip_graticule = value; end;
-  
   # sometimes a query is used as is and never gets geocoded (ie zipcode)
-  # often, it is useful have queries geocoded to know where in the
+  # often, it is useful to have queries geocoded to know where in the
   # world that query points to.  you can force the geocoding of
   # queries (even when not required) so that you have the geocoded
   # data.  the reason this isn't the default is that it will use an
   # extra web service query when not normally required
+  #
   @@force_geocode = false
   def self.force_geocode; @@force_geocode; end;
   def self.force_geocode=(value); @@force_geocode = value; end;
   def self.force_geocode!; @@force_geocode = true; end;
   
+  # adjust the timeout used when interactind with external web services
+  #
   @@timeout = 15
   def self.timeout; @@timeout; end;
   def self.timeout=(value); @@timeout = value; end;
@@ -35,17 +35,21 @@ module Barometer
     Barometer::Base.new(query)
   end
   
-  def self.selection=(selection=nil)
-    Barometer::Base.selection = selection
+  # update the Barometer configuration
+  #
+  def self.config=(config=nil)
+    Barometer::Base.config = config
   end
   
   # shortcut to Barometer::Service.source method
   # allows Barometer.source(:wunderground)
+  #
   def self.source(source)
-    Barometer::Service.source(source)
+    Barometer::WeatherService.source(source)
   end
 
   # custom errors
+  #
   class OutOfSources < StandardError; end
   
 end

data/lib/barometer/base.rb

@@ -1,12 +1,12 @@
 module Barometer
-
   class Base
     
     # allow the configuration of specific weather APIs to be used,
     # and the order in which they would be used
-    @@selection = { 1 => [:wunderground] }
-    def self.selection; @@selection; end;
-    def self.selection=(hash); @@selection = hash; end;
+    #
+    @@config = { 1 => [:wunderground] }
+    def self.config; @@config; end;
+    def self.config=(hash); @@config = hash; end;
     
     attr_reader   :query
     attr_accessor :weather, :success
@@ -17,36 +17,64 @@ module Barometer
       @success = false
     end
     
+    # iterate through all the configured sources and
+    # collect weather data for each one
+    #
     def measure(metric=nil)
       return nil unless @query
 
       level = 1
       until self.success?
-        if sources = @@selection[level]
-          if sources.is_a?(Array)
-            sources.each do |source|
-              measurement = Barometer.source(source.to_sym).measure(@query, metric)
-              @success = true if measurement.success?
-              @weather.measurements << measurement
-            end
-          else  
-            measurement = Barometer.source(sources.to_sym).measure(@query, metric)
-            @success = true if measurement.success?
-            @weather.measurements << measurement
-          end
+        if sources = @@config[level]
+          _dig(sources, nil, metric)
         else
           raise OutOfSources
         end
         level += 1
       end
-      
       @weather
     end
     
-    def success?
-      @success
+    def success?; @success; end
+    
+    private
+    
+    # iterate through the setup until we have a source name (and possibly
+    # a config for that source), then measure with that source
+    #
+    # this allows for many different config formats, like
+    # { 1 => :wunderground }
+    # { 1 => [:wunderground]}
+    # { 1 => [:wunderground, :yahoo]}
+    # { 1 => [:wunderground, {:yahoo => {:weight => 2}}]}
+    # { 1 => {:wunderground => {:weight => 2}}}
+    # { 1 => [{:wunderground => {:weight => 2}}]}
+    #
+    def _dig(data, config=nil, metric=nil)
+      if data.is_a?(String) || data.is_a?(Symbol)
+        _measure(data, config, metric)
+      elsif data.is_a?(Array)
+        data.each do |datum|
+          _dig(datum, nil, metric)
+        end
+      elsif data.is_a?(Hash)
+        data.each do |datum, config|
+          _dig(datum, config, metric)
+        end
+      end
+    end
+    
+    # do that actual source measurement
+    #
+    def _measure(datum, config=nil, metric=nil)
+      Barometer.source(datum.to_sym).keys = config[:keys] if (config && config[:keys])
+      measurement = Barometer.source(datum.to_sym).measure(@query, metric)
+      if config && config[:weight]
+        measurement.weight = config[:weight]
+      end
+      @success = true if measurement.success?
+      @weather.measurements << measurement
     end
 
   end
-
 end

data/lib/barometer/data.rb

@@ -1,9 +1,11 @@
 $:.unshift(File.dirname(__FILE__))
 
 # measurements and units
+#
 require 'data/measurement'
 require 'data/current'
 require 'data/forecast'
+require 'data/night'
 require 'data/zone'
 require 'data/sun'
 require 'data/geo'
@@ -12,4 +14,6 @@ require 'data/units'
 require 'data/temperature'
 require 'data/distance'
 require 'data/speed'
-require 'data/pressure'
+require 'data/pressure'
+require 'data/local_time'
+require 'data/local_datetime'

data/lib/barometer/data/current.rb

@@ -6,18 +6,15 @@ module Barometer
   # This is basically a data holding class for the current weather
   # conditions.
   #
-  class CurrentMeasurement
+  class Data::CurrentMeasurement
     
-    attr_accessor :time, :local_time
+    attr_reader :current_at, :updated_at
     attr_reader :humidity, :icon, :condition
     attr_reader :temperature, :dew_point, :heat_index, :wind_chill
     attr_reader :wind, :pressure, :visibility, :sun
     
-    def time=(time)
-      #raise ArgumentError unless time.is_a?(Time)
-      @time = time
-    end
-    
+    # accessors (with input checking)
+    #
     def humidity=(humidity)
       raise ArgumentError unless
         (humidity.is_a?(Fixnum) || humidity.is_a?(Float))
@@ -35,50 +32,61 @@ module Barometer
     end
     
     def temperature=(temperature)
-      raise ArgumentError unless temperature.is_a?(Barometer::Temperature)
+      raise ArgumentError unless temperature.is_a?(Data::Temperature)
       @temperature = temperature
     end
     
     def dew_point=(dew_point)
-      raise ArgumentError unless dew_point.is_a?(Barometer::Temperature)
+      raise ArgumentError unless dew_point.is_a?(Data::Temperature)
       @dew_point = dew_point
     end
     
     def heat_index=(heat_index)
-      raise ArgumentError unless heat_index.is_a?(Barometer::Temperature)
+      raise ArgumentError unless heat_index.is_a?(Data::Temperature)
       @heat_index = heat_index
     end
     
     def wind_chill=(wind_chill)
-      raise ArgumentError unless wind_chill.is_a?(Barometer::Temperature)
+      raise ArgumentError unless wind_chill.is_a?(Data::Temperature)
       @wind_chill = wind_chill
     end
     
     def wind=(wind)
-      raise ArgumentError unless wind.is_a?(Barometer::Speed)
+      raise ArgumentError unless wind.is_a?(Data::Speed)
       @wind = wind
     end
     
     def pressure=(pressure)
-      raise ArgumentError unless pressure.is_a?(Barometer::Pressure)
+      raise ArgumentError unless pressure.is_a?(Data::Pressure)
       @pressure = pressure
     end
     
     def visibility=(visibility)
-      raise ArgumentError unless visibility.is_a?(Barometer::Distance)
+      raise ArgumentError unless visibility.is_a?(Data::Distance)
       @visibility = visibility
     end
     
     def sun=(sun)
-      raise ArgumentError unless sun.is_a?(Barometer::Sun)
+      raise ArgumentError unless sun.is_a?(Data::Sun)
       @sun = sun
     end
     
+    def current_at=(current_at)
+      raise ArgumentError unless (current_at.is_a?(Data::LocalTime) || current_at.is_a?(Data::LocalDateTime))
+      @current_at = current_at
+    end 
+     
+    def updated_at=(updated_at)
+    raise ArgumentError unless (updated_at.is_a?(Data::LocalTime) || updated_at.is_a?(Data::LocalDateTime))
+    @updated_at = updated_at
+    end
+    
     #
     # helpers
     #
     
     # creates "?" helpers for all attributes (which maps to nil?)
+    #
     def method_missing(method,*args)
       # if the method ends in ?, then strip it off and see if we
       # respond to the method without the ?

data/lib/barometer/data/distance.rb

@@ -11,7 +11,8 @@ module Barometer
   # NOTE: this currently only supports the scale of
   #       kilometers (km) and miles (m).  There is currently
   #       no way to scale to smaller units (eg km -> m -> mm)
-  class Distance < Barometer::Units
+  #
+  class Data::Distance < Data::Units
     
     METRIC_UNITS = "km"
     IMPERIAL_UNITS = "m"
@@ -46,6 +47,7 @@ module Barometer
     #
     
     # store kilometers
+    #
     def km=(km)
       return if !km || !(km.is_a?(Integer) || km.is_a?(Float))
       @kilometers = km.to_f
@@ -53,6 +55,7 @@ module Barometer
     end
     
     # store miles
+    #
     def m=(m)
       return if !m || !(m.is_a?(Integer) || m.is_a?(Float))
       @miles = m.to_f
@@ -60,14 +63,16 @@ module Barometer
     end
     
     # return the stored kilometers or convert from miles
+    #
     def km(as_integer=true)
-      km = (@kilometers || Distance.m_to_km(@miles))
+      km = (@kilometers || Data::Distance.m_to_km(@miles))
       km ? (as_integer ? km.to_i : (100*km).round/100.0) : nil
     end
     
     # return the stored miles or convert from kilometers
+    #
     def m(as_integer=true)
-      m = (@miles || Distance.km_to_m(@kilometers))
+      m = (@miles || Data::Distance.km_to_m(@kilometers))
       m ? (as_integer ? m.to_i : (100*m).round/100.0) : nil
     end
     
@@ -84,21 +89,25 @@ module Barometer
     #
     
     # will just return the value (no units)
+    #
     def to_i(metric=nil)
       (metric || (metric.nil? && self.metric?)) ? self.km : self.m
     end
     
     # will just return the value (no units) with more precision
+    #
     def to_f(metric=nil)
       (metric || (metric.nil? && self.metric?)) ? self.km(false) : self.m(false)
     end
     
     # will return the value with units
+    #
     def to_s(metric=nil)
       (metric || (metric.nil? && self.metric?)) ? "#{self.km} #{METRIC_UNITS}" : "#{self.m} #{IMPERIAL_UNITS}"
     end
     
     # will just return the units (no value)
+    #
     def units(metric=nil)
       (metric || (metric.nil? && self.metric?)) ? METRIC_UNITS : IMPERIAL_UNITS
     end
@@ -107,7 +116,7 @@ module Barometer
     # kilometers remains.  if so, clear it.
     def update_kilometers(m)
       return unless @kilometers
-      difference = Distance.m_to_km(m.to_f) - @kilometers
+      difference = Data::Distance.m_to_km(m.to_f) - @kilometers
       # only clear kilometers if the stored kilometers is off be more then 1 unit
       # then the conversion of miles
       @kilometers = nil unless difference.abs <= 1.0
@@ -115,9 +124,10 @@ module Barometer
     
     # when we set kilometers, it is possible the a non-equivalent value of
     # miles remains.  if so, clear it.
+    #
     def update_miles(km)
       return unless @miles
-      difference = Distance.km_to_m(km.to_f) - @miles
+      difference = Data::Distance.km_to_m(km.to_f) - @miles
       # only clear miles if the stored miles is off be more then 1 unit
       # then the conversion of kilometers
       @miles = nil unless difference.abs <= 1.0

data/lib/barometer/data/forecast.rb

@@ -7,11 +7,13 @@ module Barometer
   # This is basically a data holding class for the forecasted weather
   # conditions.
   #
-  class ForecastMeasurement
+  class Data::ForecastMeasurement
     
     attr_reader :date, :icon, :condition
-    attr_reader :low, :high, :pop, :sun
+    attr_reader :low, :high, :pop, :wind, :humidity, :sun, :night
     
+    # accessors (with input checking)
+    #
     def date=(date)
       raise ArgumentError unless date.is_a?(Date)
       @date = date
@@ -28,12 +30,12 @@ module Barometer
     end
     
     def high=(high)
-      raise ArgumentError unless high.is_a?(Barometer::Temperature)
+      raise ArgumentError unless high.is_a?(Data::Temperature)
       @high = high
     end
     
     def low=(low)
-      raise ArgumentError unless low.is_a?(Barometer::Temperature)
+      raise ArgumentError unless low.is_a?(Data::Temperature)
       @low = low
     end
     
@@ -42,16 +44,32 @@ module Barometer
       @pop = pop
     end
     
+    def wind=(wind)
+      raise ArgumentError unless wind.is_a?(Data::Speed)
+      @wind = wind
+    end
+    
+    def humidity=(humidity)
+      raise ArgumentError unless humidity.is_a?(Fixnum)
+      @humidity = humidity
+    end
+    
     def sun=(sun)
-      raise ArgumentError unless sun.is_a?(Barometer::Sun)
+      raise ArgumentError unless sun.is_a?(Data::Sun)
       @sun = sun
     end
     
+    def night=(night)
+      raise ArgumentError unless night.is_a?(Data::NightMeasurement)
+      @night = night
+    end
+    
     #
     # helpers
     #
     
     # creates "?" helpers for all attributes (which maps to nil?)
+    #
     def method_missing(method,*args)
       # if the method ends in ?, then strip it off and see if we
       # respond to the method without the ?

data/lib/barometer/data/geo.rb

@@ -2,71 +2,27 @@ module Barometer
   #
   # A simple Geo class
   # 
-  # Used to store location data from Graticule or HTTParty and convert
-  # into just the data needed for geocoding
+  # Used to store location data
   #
-  class Geo
+  class Data::Geo
     
-    attr_accessor :latitude, :longitude
+    attr_accessor :latitude, :longitude, :query
     attr_accessor :locality, :region, :country, :country_code, :address
     
-    #
-    # this will take a Location object (either generated by Graticule
-    # or HTTParty), and fill in the applicable data
-    #
     def initialize(location=nil)
       return unless location
-      
-      has_graticule = false
-      begin
-        Graticule
-        has_graticule = true
-      rescue
-        # do nothing, Graticule not available
-      end
-      
-      if has_graticule
-        raise ArgumentError unless
-          (location.is_a?(Graticule::Location) || location.is_a?(Hash))
-      else
-        raise ArgumentError unless location.is_a?(Hash)
-      end
-      
-      if has_graticule && location.class == Graticule::Location
-        self.build_from_graticule(location)
-      elsif location.class == Hash
-        self.build_from_httparty(location)
-      end
+      raise ArgumentError unless location.is_a?(Hash)
+      self.build_from_hash(location)
       self
     end
     
-    def build_from_graticule(location=nil)
-      return nil unless location
-      
-      begin
-        require 'rubygems'
-        require 'graticule'
-        $:.unshift(File.dirname(__FILE__))
-        # load some changes to Graticule
-        # TODO: attempt to get changes into Graticule gem
-        require 'extensions/graticule'
-      end
-
-      raise ArgumentError unless location.is_a?(Graticule::Location)
-      
-      @latitude = location.latitude
-      @longitude = location.longitude
-      @locality = location.locality
-      @region = location.region
-      @country = location.country
-      @country_code = location.country_code
-      @address = location.address_line
-    end
-    
-    def build_from_httparty(location=nil)
+    # build the Geo object from a Hash
+    #
+    def build_from_hash(location=nil)
       return nil unless location
       raise ArgumentError unless location.is_a?(Hash)
       
+      @query = location["name"]
       placemark = location["Placemark"]
       placemark = placemark.first if placemark.is_a?(Array)
       
@@ -91,10 +47,16 @@ module Barometer
         @address = placemark["AddressDetails"]["Country"]["AddressLine"]
       end
     end
-    
+
     def coordinates
       [@latitude, @longitude].join(',')
     end
     
+    def to_s
+      s = [@address, @locality, @region, @country || @country_code]
+      s.delete("")
+      s.compact.join(', ')
+    end
+
   end
 end