barometer 0.6.1 → 0.6.2

data/README.rdoc

@@ -15,7 +15,7 @@ this.
 
 == version
 
-Version 0.6.0 is the current release of this gem.
+Version 0.6.2 is the current release of this gem.
 The gem is available from github (attack-barometer) or rubyforge (barometer).
 It is fully functional (for five weather service APIs).
 

data/VERSION.yml

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

data/bin/barometer

@@ -66,7 +66,7 @@ require 'yaml'
 
 # file where API keys are stored
 KEY_FILE = File.expand_path(File.join('~', '.barometer'))
-BAROMETER_VERSION = '0.6.0'
+BAROMETER_VERSION = '0.6.2'
 
 class App
   
@@ -403,22 +403,14 @@ def pretty_forecast(f)
   return unless f
   section("FOR: #{f.date}", 3) do
     pretty_hash({
-      "Date" => f.date, "Icon" => f.icon,
+      "Valid From" => f.valid_start_date.to_s(true), 
+      "Valid Until" => f.valid_end_date.to_s(true),
+      "Icon" => f.icon, "Description" => f.description,
       "Condition" => f.condition, "High" => f.high,
       "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
 

data/lib/barometer/data.rb

@@ -17,8 +17,5 @@ require 'data/local_datetime'
 # measurements
 #
 require 'measurements/measurement'
-require 'measurements/common'
-require 'measurements/current'
-require 'measurements/forecast_array'
-require 'measurements/forecast'
-require 'measurements/night'
+require 'measurements/result'
+require 'measurements/result_array'

data/lib/barometer/data/local_datetime.rb

@@ -101,8 +101,8 @@ module Barometer
       end
       raise ArgumentError unless the_other.is_a?(Data::LocalDateTime) || the_other.is_a?(Data::LocalTime)
       
-      if (other.is_a?(String) || other.is_a?(Time) || other.is_a?(DateTime)) &&
-        the_other.is_a?(Data::LocalDateTime)
+      if ((other.is_a?(String) || other.is_a?(Time) || other.is_a?(DateTime)) &&
+        the_other.is_a?(Data::LocalDateTime)) || other.is_a?(Data::LocalDateTime)
         # we are counting days + seconds
         if (_total_days <=> the_other._total_days) == 0
           return total_seconds <=> the_other.total_seconds

data/lib/barometer/measurements/measurement.rb

@@ -3,8 +3,8 @@ module Barometer
   # Measurement
   # a class that holds the response from a weather service
   #
-  # its main purpose is to hold all the data collected from a weather service
-  # as it is passed to the weather object
+  # its main purpose is to hold all the data collected from a single weather
+  # service as it is passed to the weather object
   #
   # this response includes
   # - current weather data (using the CurrentMeasurement class)
@@ -31,8 +31,8 @@ module Barometer
     end
     
     def success!
-       current && current.temperature &&
-         !current.temperature.c.nil? && @success = true
+      current && current.temperature &&
+        !current.temperature.c.nil? && @success = true
     end
     
     def stamp!; @utc_time_stamp = Time.now.utc; end
@@ -95,14 +95,14 @@ module Barometer
     end
     
     def current=(current)
-      raise ArgumentError unless current.is_a?(Measurement::Current)
+      raise ArgumentError unless current.is_a?(Measurement::Result)
       @current = current
       self.stamp!
       self.success!
     end
     
     def forecast=(forecast)
-      raise ArgumentError unless forecast.is_a?(Measurement::ForecastArray)
+      raise ArgumentError unless forecast.is_a?(Measurement::ResultArray)
       @forecast = forecast
     end
     

data/lib/barometer/measurements/result.rb

@@ -0,0 +1,207 @@
+module Barometer
+  #
+  # Result Measurement
+  # a data class for resulting weather conditions
+  #
+  # This is basically a data holding class for the resulting weather
+  # conditions.
+  #
+  class Measurement::Result
+    
+    attr_reader :current_at, :updated_at
+    attr_reader :valid_start_date, :valid_end_date, :date
+    attr_reader :humidity, :icon, :condition
+    attr_reader :temperature, :dew_point, :heat_index, :wind_chill
+    attr_reader :low, :high, :pop
+    attr_reader :wind, :sun, :pressure, :visibility
+    attr_accessor :metric, :description
+    
+    def initialize(metric=true); @metric = metric; end
+    
+    # accessors (with input checking)
+    #
+    def temperature=(temperature)
+      raise ArgumentError unless temperature.is_a?(Data::Temperature)
+      @temperature = temperature
+    end
+    
+    def dew_point=(dew_point)
+      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?(Data::Temperature)
+      @heat_index = heat_index
+    end
+    
+    def wind_chill=(wind_chill)
+      raise ArgumentError unless wind_chill.is_a?(Data::Temperature)
+      @wind_chill = wind_chill
+    end
+    
+    def pressure=(pressure)
+      raise ArgumentError unless pressure.is_a?(Data::Pressure)
+      @pressure = pressure
+    end
+    
+    def visibility=(visibility)
+      raise ArgumentError unless visibility.is_a?(Data::Distance)
+      @visibility = visibility
+    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
+    
+    def date=(date)
+      raise ArgumentError unless date.is_a?(Date)
+      @date = date
+      @valid_start_date = Data::LocalDateTime.new(date.year,date.month,date.day,0,0,0)
+      @valid_end_date = Data::LocalDateTime.new(date.year,date.month,date.day,23,59,59)
+    end
+    
+    def valid_start_date=(date)
+      raise ArgumentError unless date.is_a?(Data::LocalDateTime)
+      @valid_start_date = date
+    end
+    
+    def valid_end_date=(date)
+      raise ArgumentError unless date.is_a?(Data::LocalDateTime)
+      @valid_end_date = date
+    end
+    
+    def high=(high)
+      raise ArgumentError unless high.is_a?(Data::Temperature)
+      @high = high
+    end
+    
+    def low=(low)
+      raise ArgumentError unless low.is_a?(Data::Temperature)
+      @low = low
+    end
+    
+    def pop=(pop)
+      raise ArgumentError unless pop.is_a?(Fixnum)
+      @pop = pop
+    end
+    
+    def humidity=(humidity)
+      raise ArgumentError unless
+        (humidity.is_a?(Fixnum) || humidity.is_a?(Float))
+      @humidity = humidity
+    end
+    
+    def icon=(icon)
+      raise ArgumentError unless icon.is_a?(String)
+      @icon = icon
+    end
+    
+    def condition=(condition)
+      raise ArgumentError unless condition.is_a?(String)
+      @condition = condition
+    end
+    
+    def wind=(wind)
+      raise ArgumentError unless wind.is_a?(Data::Speed)
+      @wind = wind
+    end
+    
+    def sun=(sun)
+      raise ArgumentError unless (sun.is_a?(Data::Sun) || sun.nil?)
+      @sun = sun
+    end
+    
+    #
+    # answer simple questions
+    #
+    
+    def windy?(threshold=10)
+      raise ArgumentError unless (threshold.is_a?(Fixnum) || threshold.is_a?(Float))
+      return nil unless wind?
+      wind.to_f(metric?) >= threshold.to_f
+    end
+    
+    def day?(time)
+      return nil unless time && sun?
+      sun.after_rise?(time) && sun.before_set?(time)
+    end
+    
+    def sunny?(time, sunny_icons=nil)
+      return nil unless time
+      is_day = day?(time)
+      return nil if is_day.nil?
+      is_day && _sunny_by_icon?(sunny_icons)
+    end
+    
+    def wet?(wet_icons=nil, pop_threshold=50, humidity_threshold=99)
+      result = nil
+      result ||= _wet_by_pop?(pop_threshold) if pop?
+      result ||= _wet_by_icon?(wet_icons) if icon?
+      result ||= _wet_by_humidity?(humidity_threshold) if humidity?
+      result ||= _wet_by_dewpoint? if (dew_point? && temperature?)
+      result
+    end
+    
+    #
+    # helpers
+    #
+    
+    def metric?; metric; end
+    
+    def for_datetime?(datetime)
+      raise ArgumentError unless datetime.is_a?(Data::LocalDateTime)
+      datetime >= @valid_start_date && datetime <= @valid_end_date
+    end
+    
+    # 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 ?
+      if (call_method = method.to_s.chomp!("?")) && respond_to?(call_method)
+        return send(call_method).nil? ? false : true
+      else
+        super(method,*args)
+      end
+    end
+    
+    private
+    
+    def _wet_by_dewpoint?
+      return nil unless dew_point? && temperature?
+      temperature.to_f(metric?) <=  dew_point.to_f(metric?)
+    end
+    
+    def _wet_by_pop?(threshold=50)
+      raise ArgumentError unless (threshold.is_a?(Fixnum) || threshold.is_a?(Float))
+      return nil unless pop?
+      pop.to_f >= threshold.to_f
+    end
+    
+    def _wet_by_humidity?(threshold=99)
+      raise ArgumentError unless (threshold.is_a?(Fixnum) || threshold.is_a?(Float))
+      return nil unless humidity?
+      humidity.to_f >= threshold.to_f
+    end
+    
+    def _wet_by_icon?(wet_icons=nil)
+      raise ArgumentError unless (wet_icons.nil? || wet_icons.is_a?(Array))
+      return nil unless (icon? && wet_icons)
+      wet_icons.include?(icon.to_s.downcase)
+    end
+    
+    def _sunny_by_icon?(sunny_icons=nil)
+      raise ArgumentError unless (sunny_icons.nil? || sunny_icons.is_a?(Array))
+      return nil unless (icon? && sunny_icons)
+      sunny_icons.include?(icon.to_s.downcase)
+    end
+    
+  end
+end

data/lib/barometer/measurements/{forecast_array.rb → result_array.rb}

@@ -1,13 +1,15 @@
 require 'date'
 module Barometer
   #
-  # Forecast Array
-  # an array that holds multiple forecasts
+  # Result Array
   #
-  class Measurement::ForecastArray < Array
+  # an array that holds multiple results,
+  # with methods for insertion and searching
+  #
+  class Measurement::ResultArray < Array
     
     def <<(forecast)
-      raise ArgumentError unless forecast.is_a?(Measurement::Forecast)
+      raise ArgumentError unless forecast.is_a?(Measurement::Result)
       super(forecast)
     end
     
@@ -17,31 +19,32 @@ module Barometer
     
     #
     # Returns a forecast for a day given by a Date, DateTime,
-    # Time, or a string that can be parsed to a date
+    # Time, or a string that can be parsed to a Data::LocalDateTime
     #
     # credit: http://github.com/jdpace/weatherman/
     #
-    def for(date)
+    def for(datetime)
     
       return nil unless self.size > 0
       
       # Format date into a Date class
-      date = case date.class.name
+      datetime = case datetime.class.name
       when 'Date'
-        date
+        # if just given a date, assume a time that will be mid-day
+        Data::LocalDateTime.new(datetime.year,datetime.month,datetime.day,12,0,0)
       when 'Data::LocalDateTime'
-        date.to_d
+        datetime
       when 'String'
-        Date.parse(date)
+        Data::LocalDateTime.parse(datetime)
       when 'Time'
-        Date.new(date.year, date.month, date.day)
+        Data::LocalDateTime.parse(datetime)
       when 'DateTime'
-        Date.new(date.year, date.month, date.day)
+        Data::LocalDateTime.parse(datetime)
       end
       
       day = nil
       self.each do |f|
-        day = f if date == f.date
+        day = f if f.for_datetime?(datetime)
       end
       return day
     end

data/lib/barometer/translations/weather_country_codes.yml

@@ -102,7 +102,7 @@ MG : MN
 
 WA : NA
 NT : AN
-NU: NI
+NU : NI
 NG : NE
 NI : NG
 
@@ -127,7 +127,7 @@ LO : SK
 BP : SB
 SF : ZA
 SP : ES
-CE: LK
+CE : LK
 SU : SD
 NS : SR
 WZ : SZ
@@ -147,7 +147,7 @@ UP : UA
 UK : GB
 
 NH : VU
-VM: VN
+VM : VN
 
 WI : EH
 

data/lib/barometer/weather_services/google.rb

@@ -52,7 +52,7 @@ module Barometer
 
     def self._build_current(data, metric=true)
       raise ArgumentError unless data.is_a?(Hash)
-      current = Measurement::Current.new
+      current = Measurement::Result.new
 
       if data['current_conditions']
         data = data['current_conditions']
@@ -81,7 +81,7 @@ module Barometer
     def self._build_forecast(data, metric=true)
       raise ArgumentError unless data.is_a?(Hash)
 
-      forecasts = Measurement::ForecastArray.new
+      forecasts = Measurement::ResultArray.new
       return forecasts unless data && data['forecast_information'] &&
                               data['forecast_information']['forecast_date']
       start_date = Date.parse(data['forecast_information']['forecast_date']['data'])
@@ -90,7 +90,7 @@ module Barometer
       # go through each forecast and create an instance
       d = 0
       data.each do |forecast|
-        forecast_measurement = Measurement::Forecast.new
+        forecast_measurement = Measurement::Result.new
         if forecast['icon']
           icon_match = forecast['icon']['data'].match(/.*\/([A-Za-z_]*)\.png/)
           forecast_measurement.icon = icon_match[1] if icon_match

data/lib/barometer/weather_services/weather_bug.rb

@@ -97,7 +97,7 @@ module Barometer
     def self._build_current(data, metric=true)
       raise ArgumentError unless data.is_a?(Hash)
 
-      current = Measurement::Current.new
+      current = Measurement::Result.new
       # current.updated_at = Data::LocalDateTime.parse(data['observation_time']) if data['observation_time']
       current.humidity = data['aws:humidity'].to_i
       current.condition = data['aws:current_condition'] if data['aws:current_condition']
@@ -124,13 +124,13 @@ module Barometer
     
     def self._build_forecast(data, metric=true)
       raise ArgumentError unless data.is_a?(Hash)
-      forecasts = Measurement::ForecastArray.new
+      forecasts = Measurement::ResultArray.new
       # go through each forecast and create an instance
       if data && data["aws:forecast"]
         start_date = Date.parse(data['date'])
         i = 0
         data["aws:forecast"].each do |forecast|
-          forecast_measurement = Measurement::Forecast.new
+          forecast_measurement = Measurement::Result.new
           icon_match = forecast['aws:image'].match(/cond(\d*)\.gif$/)
           forecast_measurement.icon = icon_match[1].to_i.to_s if icon_match
           forecast_measurement.date = start_date + i