davidjrice-hamweather 0.0.1

data/Manifest

@@ -0,0 +1,13 @@
+lib/hamweather/forecast/daily.rb
+lib/hamweather/forecast/hourly.rb
+lib/hamweather/forecast.rb
+lib/hamweather/location.rb
+lib/hamweather.rb
+Rakefile
+sample_data.xml
+spec/daily_spec.rb
+spec/forecast_spec.rb
+spec/hamweather_spec.rb
+spec/hourly_spec.rb
+spec/spec_helper.rb
+Manifest

data/README

@@ -0,0 +1,73 @@
+Hamweather
+==========
+
+This is a Ruby API to an XML webservice providing weather detail for global locations.
+It can handle diverse locations by Zip Code, Canadian Post code or by any international address.
+
+* It requires a Google Maps API key: http://code.google.com/apis/maps/signup.html
+* It requires a Hamweather API key, contact Hamweather to discuss: http://www.hamweather.com/
+
+Installation
+------------
+> sudo gem install hamweather
+
+Usage
+-----
+require 'rubygems'
+require 'hamweather'
+
+*** Hamweather is a singleton class, it takes the two API keys as such:
+Hamweather.google_maps_api_key = " ... "
+Hamweather.api_key = " ... "
+
+@location = Hamweather.locate('Belfast')    # Assuming your location is unambiguous:
+@forecast = Hamweather.forecast(@location)  # Forecast is returned as a Hamweather::Forecast object
+
+What 'address' to use?
+----------------------
+Zip Code, Canadian Postcode, International Address - it doesn't really matter.
+This API uses the Google Maps API to geolocate any address which doesn't fit either of the former
+precisely.
+Which means the user could input "Lodnon" and get the right location as it's parsing is intelligent.
+
+Using Hamweather::Location
+--------------------------
+If the 'address' you enter is ambiguous, the API may return a hash of Location objects which you can
+use to choose. Check this by: @location.kind_of?(Hash)
+Otherwise @location.zipcode @location.postcode? @location.geocode? will tell you what type of
+Location you have.
+
+Using Hamweather::Forecast
+--------------------------
+Assuming @location has been defined, @forecast = Hamweather.forecast(@location) will return a 
+Hamweather::Forecast object. A Forecast object has two available hashes: dailies{} and hourlies{}
+which give all available Daily forecasts and Hourly forecasts respectively. Each Daily or Hourly
+forecast is a Hash of Hamweather::Forecast::Daily or Hamweather::Forecast::Hourly objects.
+
+The Daily object has a list of it's Hourly Forecasts available to you: 'hours'
+Forecast variables available in a Daily forecast are:
+  :high_farenheit
+  :high_celsius
+  :low_farenheit
+  :low_celsius
+  :day
+  :date
+  :expected_weather
+  :detail
+  :probability_of_preciptiation
+
+Forecast variables available in an Hourly forecast are:
+  :date
+  :time
+  :expected_weather
+  :temp_celsius
+  :temp_farenheit
+  :probability_of_precipitation
+  :precipitation_millimeters
+  :precipitation_inches
+  :dew_point_celsius
+  :dew_point_farenheit
+  :relative_humidity
+  :wind_speed_knots
+  :wind_speed_mph
+  :wind_direction

data/Rakefile

@@ -0,0 +1,40 @@
+begin
+  require 'echoe'
+ 
+  Echoe.new('hamweather', '0.0.1') do |p|
+    p.rubyforge_name = 'hamweather'
+    p.summary      = "Hamweather is a Ruby client library for interacting with http://hamweather.com weather data"
+    p.description  = "Hamweather is a Ruby client library for interacting with http://hamweather.com weather data"
+    p.url          = "http://github.com/davidjrice/hamweather"
+    p.author       = ['David Rice']
+    p.email        = "david@contrast.ie"
+    p.dependencies = ["json"]
+  end
+ 
+rescue LoadError => e
+  puts "You are missing a dependency required for meta-operations on this gem."
+  puts "#{e.to_s.capitalize}."
+end
+ 
+# add spec tasks, if you have rspec installed
+begin
+  require 'spec/rake/spectask'
+ 
+  Spec::Rake::SpecTask.new("spec") do |t|
+    t.spec_files = FileList['spec/**/*_spec.rb']
+    t.spec_opts = ['--color']
+  end
+ 
+  task :test do
+    Rake::Task['spec'].invoke
+  end
+ 
+  Spec::Rake::SpecTask.new("coverage") do |t|
+    t.spec_files = FileList['spec/**/*_spec.rb']
+    t.spec_opts = ['--color']
+    t.rcov = true
+    t.rcov_opts = ['--exclude', '^spec,/gems/']
+  end
+
+  
+end

data/hamweather.gemspec

@@ -0,0 +1,30 @@
+Gem::Specification.new do |s|
+  s.name     = "hamweather"
+  s.version  = "0.0.1"
+  s.date     = "2008-10-13"
+  s.summary  = "	Ruby Client API for Hamweather Weather Service (http://www.hamweather.com)"
+  s.email    = "david@contrast.ie"
+  s.homepage = "http://github.com/davidjrice/hamweather"
+  s.description = "Client API for Hamweather Weather Service (http://www.hamweather.com)"
+  s.has_rdoc = true
+  s.authors  = ["David Rice", "David Lowry"]
+  s.files    = ["Manifest", 
+		"README", 
+		"Rakefile", 
+		"hamweather.gemspec",
+		"lib/hamweather/forecast/daily.rb",
+		"lib/hamweather/forecast/hourly.rb",
+    "lib/hamweather/forecast.rb",
+    "lib/hamweather/location.rb",
+    "lib/hamweather.rb"]
+  s.test_files = ["spec/daily_spec.rb",
+      "spec/forecast_spec.rb",
+      "spec/hamweather_spec.rb",
+      "spec/hourly_spec.rb",
+      "spec/location_spec.rb",
+      "spec/spec_helper.rb"]
+  s.rdoc_options = ["--main", "README"]
+  s.extra_rdoc_files = ["Manifest", "README"]
+  s.add_dependency("google-geo", ["> 0.0.0"])
+  s.add_dependency("hpricot", ["> 0.0.0"])
+end

data/lib/hamweather.rb

@@ -0,0 +1,44 @@
+$:.unshift File.dirname(__FILE__)
+require 'hamweather/location'
+require 'hamweather/forecast'
+require 'hamweather/forecast/daily'
+require 'hamweather/forecast/hourly'
+
+require 'date'
+require 'hpricot'
+ 
+module Hamweather
+  
+  class ApiKeyException < StandardError; end
+  class GoogleApiKeyException < StandardError; end
+  
+  class UnknownAddressError < StandardError; end
+  
+  class << self
+    
+    attr_accessor :api_key, :google_maps_api_key
+    # Hamweather.api_key = "..."
+    # Hamweather.google_maps_api_key = "..."
+    # locations = Hamweather.locate "Belfast"
+    # Hamweather.forecast(locations.first)
+
+    def locate(place)
+      check_api_key
+      @location = Hamweather::Location.parse(place)
+    end
+    
+    def forecast(location)
+      check_api_key
+      Hamweather::Forecast.new(location)
+    end
+    
+    protected
+    
+    def check_api_key
+      raise ApiKeyException.new("you must provide a Hamweather api key.") if api_key.nil? 
+      raise ApiKeyException.new("you must provide a Google Maps api key.") if google_maps_api_key.nil?
+    end
+    
+  end
+  
+end

data/lib/hamweather/forecast.rb

@@ -0,0 +1,54 @@
+require 'net/http'
+require 'uri'
+
+module Hamweather
+  class Forecast
+
+    # @forecast.each_day 
+    # => day_proxy_object.high_farenheit
+    # @forecast.each_hour
+    # => hour_proxy_object.high_farenheit
+    
+    attr_accessor :forecast, :dailies, :hourlies
+    
+    def initialize(location)
+      # Construct url from api key, location uri
+      # Request url, get xml then parse
+      xml_data = self.class.fetch(location.to_uri).gsub!(/\n/,'')
+      data = Hpricot.parse(xml_data)
+      
+      @dailies = {}
+      @hourlies = {}
+            
+      data.at(:wxforecast).children.each do |day| 
+        #TODO make ordered hash
+        @dailies[day[:date].to_s] = Daily.new(day)
+      end
+      
+      data.at(:wxshortterm).children.each do |hour|
+        #TODO make ordered hash
+        @hourlies[hour[:time]] = Hourly.new(hour)
+        @dailies[hour[:date]].hours[hour[:time]] = Hourly.new(hour)
+      end
+    end
+    
+    # TODO stub out calls to this where possible.
+    # TODO / or raise an error.
+    def self.fetch(location_uri)
+      Net::HTTP.get URI.parse("http://hwlite.hamweather.net/#{Hamweather.api_key}/#{location_uri}")
+    end
+
+    def each_day
+      @dailies.each_pair do |key, value|
+        yield value
+      end
+    end
+    
+    def each_hour
+      @hourlies.each_pair do |key, value|
+        yield value
+      end
+    end
+    
+  end
+end

data/lib/hamweather/forecast/daily.rb

@@ -0,0 +1,25 @@
+module Hamweather
+  class Forecast::Daily
+    #daily_forecast = Hpricot.parse('<FPeriod interval="1" Day="FRI" Date="2008-11-14" Wx="Chance T-storms" Icon="tstorm.gif" HiF="66" HiC="19" LoF="56" LoC="13" Pop="60" Detail="Occasional showers with a chance of thunderstorms. Areas of fog. Some thunderstorms May be severe after midnight. Lows in the mid 50s. South winds 5 to 10 mph shifting to the southwest 10 to 15 mph after midnight. Chance of rain near 100 percent."/>').root
+    attr_accessor :high_farenheit, :high_celsius, :low_farenheit, :low_celsius, :day, :date, :expected_weather, :detail, :probability_of_preciptiation
+    attr_accessor :hours
+
+    def initialize(daily_forecast)
+      @hours = {}
+      @high_farenheit = daily_forecast[:hif].to_i
+      @high_celsius = daily_forecast[:hic].to_i
+      @low_farenheit = daily_forecast[:lof].to_i
+      @low_celsius = daily_forecast[:loc].to_i
+      @date = Date.parse(daily_forecast[:date])
+      @expected_weather = daily_forecast[:wx]
+      @detail = daily_forecast[:detail]
+      @probability_of_preciptiation = daily_forecast[:pop].to_i
+    end
+    
+    def each_hour
+      @hours.each_pair do |key, value|
+        yield value
+      end
+    end
+  end
+end

data/lib/hamweather/forecast/hourly.rb

@@ -0,0 +1,27 @@
+module Hamweather
+  class Forecast::Hourly
+    #hourly_forecast = Hpricot.parse('<STPeriod interval="1" Epoch="1228298400" Day="Wed" Date="2008-12-03" Time="10:00" Wx="Partly Cloudy" Icon="pcloudy.gif" TempC="0" TempF="32" Pop="10" QPFmm="" QPFin="" DewPointC="-5" DewPointF="23" RelativeHumidity="70" WindSpeedKnots="8" WindSpeedMPH="9"  WindDirectionEng="SW" />').root
+    attr_accessor :date, :time, :expected_weather, :temp_celsius, :temp_farenheit, :probability_of_precipitation, :precipitation_millimeters, :precipitation_inches, :dew_point_celsius, :dew_point_farenheit, :relative_humidity, :wind_speed_knots, :wind_speed_mph, :wind_direction
+
+    # def initialize(xml_data)
+    #   hourly_forecast = Hpricot.parse(xml_data).root
+
+    def initialize(hourly_forecast)
+      @date = Date.parse(hourly_forecast[:date])
+      @time = hourly_forecast[:time]
+      @expected_weather = hourly_forecast[:wx]
+      @temp_farenheit = hourly_forecast[:tempf].to_i
+      @temp_celsius = hourly_forecast[:tempc].to_i
+      @probability_of_precipitation = hourly_forecast[:pop].to_i
+      @precipitation_millimeters = hourly_forecast[:qpfmm]
+      @precipitation_inches = hourly_forecast[:qpfin]
+      @dew_point_celsius = hourly_forecast[:dewpointc].to_i
+      @dew_point_farenheit = hourly_forecast[:dewpointf].to_i
+      @relative_humidity = hourly_forecast[:relativehumidity].to_i
+      @wind_speed_knots = hourly_forecast[:windspeedknots].to_i
+      @wind_speed_mph = hourly_forecast[:windspeedmph].to_i
+      @wind_direction = hourly_forecast[:winddirectioneng]
+    end
+    
+  end
+end

data/lib/hamweather/location.rb

@@ -0,0 +1,91 @@
+require 'rubygems'
+require 'google/geo'
+
+module Hamweather
+  
+  class Location
+    
+    attr_reader :string, :address
+    
+    def lat
+      @address.latitude
+    end
+    
+    def lon
+      @address.longitude
+    end
+    
+    def to_uri
+      if zipcode? || postcode?
+        @uri ||= "wx/#{string}.xml"
+      elsif geocode?
+        @uri ||= "wx/nearby.xml?lat=#{lat}&lon=#{lon}"
+      end
+    end
+    
+    def zipcode?
+      @kind == :zipcode
+    end
+    
+    def postcode?
+      @kind == :postcode
+    end
+    
+    def geocode?
+      @kind == :geocode
+    end
+    
+    def self.parse(string)
+      if is_zipcode?(string) || is_canadian_postcode?(string)
+        return self.new(string)
+      else
+        geocode(string)
+      end
+    end
+
+    def initialize(object)
+      if self.class.is_zipcode?(object)
+        @string = object
+        @kind = :zipcode
+      elsif self.class.is_canadian_postcode?(object)
+        @string = object
+        @kind = :postcode
+      elsif object.kind_of?(Google::Geo::Address)
+        @address = object
+        @kind = :geocode
+      end
+    end
+
+    def self.geocode(string)
+      locations = call_geocoder(string).map { |a| self.new(a) }
+      return locations.first if locations.size == 1
+      return locations
+    end
+    
+    def self.call_geocoder(string)
+      geo = Google::Geo.new Hamweather.google_maps_api_key
+      
+      begin
+      return geo.locate(string)
+      
+      rescue Google::Geo::UnknownAddressError, Google::Geo::UnknownError
+        raise Hamweather::UnknownAddressError
+      end
+    end
+
+    def self.is_zipcode?(string)
+      #Address: ZIP code (US)
+      zip_codes_regex = /(^[0-9]{5}$)|(^[0-9]{5}-[0-9]{4}$)/
+      return string =~ zip_codes_regex
+    end
+
+    def self.is_canadian_postcode?(string)
+      #Rules: no D, F, I, O, Q, or U anywhere
+      #    Basic validation:    ^[ABCEGHJ-NPRSTVXY]{1}[0-9]{1}[ABCEGHJ-NPRSTV-Z]{1}[ ]?[0-9]{1}[ABCEGHJ-NPRSTV-Z]{1}[0-9]{1}$
+      #    Extended validation: ^(A(0[ABCEGHJ-NPR]|1[ABCEGHK-NSV-Y]|2[ABHNV]|5[A]|8[A])|B(0[CEHJ-NPRSTVW]|1[ABCEGHJ-NPRSTV-Y]|2[ABCEGHJNRSTV-Z]|3[ABEGHJ-NPRSTVZ]|4[ABCEGHNPRV]|5[A]|6[L]|9[A])|C(0[AB]|1[ABCEN])|E(1[ABCEGHJNVWX]|2[AEGHJ-NPRSV]|3[ABCELNVYZ]|4[ABCEGHJ-NPRSTV-Z]|5[ABCEGHJ-NPRSTV]|6[ABCEGHJKL]|7[ABCEGHJ-NP]|8[ABCEGJ-NPRST]|9[ABCEGH])|G(0[ACEGHJ-NPRSTV-Z]|1[ABCEGHJ-NPRSTV-Y]|2[ABCEGJ-N]|3[ABCEGHJ-NZ]|4[ARSTVWXZ]|5[ABCHJLMNRTVXYZ]|6[ABCEGHJKLPRSTVWXZ]|7[ABGHJKNPSTXYZ]|8[ABCEGHJ-NPTVWYZ]|9[ABCHNPRTX])|H(0[HM]|1[ABCEGHJ-NPRSTV-Z]|2[ABCEGHJ-NPRSTV-Z]|3[ABCEGHJ-NPRSTV-Z]|4[ABCEGHJ-NPRSTV-Z]|5[AB]|7[ABCEGHJ-NPRSTV-Y]|8[NPRSTYZ]|9[ABCEGHJKPRSWX])|J(0[ABCEGHJ-NPRSTV-Z]|1[ACEGHJ-NRSTXZ]|2[ABCEGHJ-NRSTWXY]|3[ABEGHLMNPRTVXYZ]|4[BGHJ-NPRSTV-Z]|5[ABCJ-MRTV-Z]|6[AEJKNRSTVWYXZ]|7[ABCEGHJ-NPRTV-Z]|8[ABCEGHLMNPRTVXYZ]|9[ABEHJLNTVXYZ])|K(0[ABCEGHJ-M]|1[ABCEGHJ-NPRSTV-Z]|2[ABCEGHJ-MPRSTVW]|4[ABCKMPR]|6[AHJKTV]|7[ACGHK-NPRSV]|8[ABHNPRV]|9[AHJKLV])|L(0[[ABCEGHJ-NPRS]]|1[ABCEGHJ-NPRSTV-Z]|2[AEGHJMNPRSTVW]|3[BCKMPRSTVXYZ]|4[ABCEGHJ-NPRSTV-Z]|5[ABCEGHJ-NPRSTVW]|6[ABCEGHJ-MPRSTV-Z]|7[ABCEGJ-NPRST]|8[EGHJ-NPRSTVW]|9[ABCGHK-NPRSTVWYZ])|M(1[BCEGHJ-NPRSTVWX]|2[HJ-NPR]|3[ABCHJ-N]|4[ABCEGHJ-NPRSTV-Y]|5[ABCEGHJ-NPRSTVWX]|6[ABCEGHJ-NPRS]|7[AY]|8[V-Z]|9[ABCLMNPRVW])|N(0[ABCEGHJ-NPR]|1[ACEGHKLMPRST]|2[ABCEGHJ-NPRTVZ]|3[ABCEHLPRSTVWY]|4[BGKLNSTVWXZ]|5[ACHLPRV-Z]|6[ABCEGHJ-NP]|7[AGLMSTVWX]|8[AHMNPRSTV-Y]|9[ABCEGHJKVY])|P(0[ABCEGHJ-NPRSTV-Y]|1[ABCHLP]|2[ABN]|3[ABCEGLNPY]|4[NPR]|5[AEN]|6[ABC]|7[ABCEGJKL]|8[NT]|9[AN])|R(0[ABCEGHJ-M]|1[ABN]|2[CEGHJ-NPRV-Y]|3[ABCEGHJ-NPRSTV-Y]|4[AHJKL]|5[AGH]|6[MW]|7[ABCN]|8[AN]|9[A])|S(0[ACEGHJ-NP]|2[V]|3[N]|4[AHLNPRSTV-Z]|6[HJKVWX]|7[HJ-NPRSTVW]|9[AHVX])|T(0[ABCEGHJ-MPV]|1[ABCGHJ-MPRSV-Y]|2[ABCEGHJ-NPRSTV-Z]|3[ABCEGHJ-NPRZ]|4[ABCEGHJLNPRSTVX]|5[ABCEGHJ-NPRSTV-Z]|6[ABCEGHJ-NPRSTVWX]|7[AENPSVXYZ]|8[ABCEGHLNRSVWX]|9[ACEGHJKMNSVWX])|V(0[ABCEGHJ-NPRSTVWX]|1[ABCEGHJ-NPRSTV-Z]|2[ABCEGHJ-NPRSTV-Z]|3[ABCEGHJ-NRSTV-Y]|4[ABCEGK-NPRSTVWXZ]|5[ABCEGHJ-NPRSTV-Z]|6[ABCEGHJ-NPRSTV-Z]|7[ABCEGHJ-NPRSTV-Y]|8[ABCGJ-NPRSTV-Z]|9[ABCEGHJ-NPRSTV-Z])|X(0[ABCGX]|1[A])|Y(0[AB]|1[A]))[ ]?[0-9]{1}[ABCEGHJ-NPRSTV-Z]{1}[0-9]{1}$
+      ca_postcode_regex = /^[A-Z]{1}[\d]{1}[A-Z]{1}[ ]?[\d]{1}[A-Z]{1}[\d]{1}$/
+      return string =~ ca_postcode_regex
+    end
+
+  end  
+end  

data/spec/daily_spec.rb

@@ -0,0 +1,56 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+#Hpricot.parse('<FPeriod interval="1" Day="FRI" Date="2008-11-14" Wx="Chance T-storms" Icon="tstorm.gif" HiF="66" HiC="19" LoF="56" LoC="13" Pop="60" Detail="Occasional showers with a chance of thunderstorms. Areas of fog. Some thunderstorms May be severe after midnight. Lows in the mid 50s. South winds 5 to 10 mph shifting to the southwest 10 to 15 mph after midnight. Chance of rain near 100 percent."/>').root
+#=> {emptyelem <fperiod loc="13" wx="Chance T-storms" hic="19" lof="56" icon="tstorm.gif" date="2008-11-14" hif="66" pop="60" day="FRI" interval="1" detail="Occasional showers with a chance of thunderstorms. Areas of fog. Some thunderstorms May be severe after midnight. Lows in the mid 50s. South winds 5 to 10 mph shifting to the southwest 10 to 15 mph after midnight. Chance of rain near 100 percent.">}
+
+describe Hamweather::Forecast::Daily do
+  
+  def test_forecast_data
+    <<-XML
+<FPeriod interval="1" Day="FRI" Date="2008-11-14" Wx="Chance T-storms" Icon="tstorm.gif" HiF="66" HiC="19" LoF="56" LoC="13" Pop="60" Detail="Occasional showers with a chance of thunderstorms. Areas of fog. Some thunderstorms May be severe after midnight. Lows in the mid 50s. South winds 5 to 10 mph shifting to the southwest 10 to 15 mph after midnight. Chance of rain near 100 percent."/>    
+    XML
+  end
+  
+  before(:each) do
+    @daily_forecast = Hamweather::Forecast::Daily.new(Hpricot.parse(test_forecast_data).root)
+  end
+  
+  it "@hours should contain only hours belonging to 'today'" do
+    @daily_forecast.each_hour do |hour|
+      hour.date.should_be @daily_forecast.date
+    end
+  end
+  
+  it "high_farenheit should be 66 degrees" do
+    @daily_forecast.high_farenheit.should == 66
+  end
+  
+  it "high_celsius should be 19 degrees" do
+    @daily_forecast.high_celsius.should == 19
+  end
+
+  it "low_farenheit should be 56 degrees" do
+    @daily_forecast.low_farenheit.should == 56
+  end
+  
+  it "low_celsius should be 13 degrees" do
+    @daily_forecast.low_celsius.should == 13
+  end
+  
+  it "date should be the 14th of November 2008" do
+    @daily_forecast.date.should == Date.parse("2008-11-14")
+  end
+  
+  it "expected_weather should be Chance T-storms" do
+    @daily_forecast.expected_weather.should == "Chance T-storms"
+  end
+  
+  it "probability_of_preciptiation should be 60 percent" do
+    @daily_forecast.probability_of_preciptiation.should == 60
+  end
+  
+  it "detail should be Occasional showers with a chance of thunderstorms. Areas of fog. Some thunderstorms May be severe after midnight. Lows in the mid 50s. South winds 5 to 10 mph shifting to the southwest 10 to 15 mph after midnight. Chance of rain near 100 percent." do
+    @daily_forecast.detail.should == "Occasional showers with a chance of thunderstorms. Areas of fog. Some thunderstorms May be severe after midnight. Lows in the mid 50s. South winds 5 to 10 mph shifting to the southwest 10 to 15 mph after midnight. Chance of rain near 100 percent."
+  end
+end
+

data/spec/forecast_spec.rb

@@ -0,0 +1,52 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe Hamweather::Forecast::Daily do
+  
+  before(:each) do 
+    setup_hamweather_api_config
+  end
+  
+  def test_forecast_data
+    <<-XML
+<WeatherFeed><Location ID="12834" name="Greenwich" state="NY" country="US" tz="-5" tzname="EST" ><Astro><AstroPeriod Day="WED" Date="2008-12-03" Sunrise="7:06 AM EST" Sunset="4:19 PM EST" Moonrise="11:19 AM EST" Moonset="9:45 PM EST" MoonIllum="44%" MoonAge="6" MoonPhase="Waxing Crescent Moon" MoonIcon="6" /><AstroPeriod Day="WED" Date="2008-12-03" Sunrise="7:07 AM EST" Sunset="4:19 PM EST" Moonrise="11:41 AM EST" Moonset="10:50 PM EST" MoonIllum="50%" MoonAge="7" MoonPhase="First Quarter Moon" MoonIcon="7" /></Astro><WxOb StationID="KGFL" TempC="-4" TempF="25"  ApparentC="-7" ApparentF="19" DewPointC="-5" DewPointF="23" RelativeHumidity="93" WindSpeedKnots="4" WindSpeedMPH="5" WindDirection="200" WindDirectionEng="SSW"  WindGustKnots="0" WindGustMPH="0"  PressureMB="1022" PressureIN="30.15" Wx="Fog/mist"   Icon="fog.gif" Visibility="3SM" VisibilityKM="4.83" VisibilityMI="3" ReportEpoch="1228302540" ReportDate="2008-12-03 11:09 UTC"  /><WxShortTerm ID="NYZ084"><STPeriod interval="1" Epoch="1228298400" Day="Wed" Date="2008-12-03" Time="10:00" Wx="Partly Cloudy" Icon="pcloudy.gif" TempC="0" TempF="32" Pop="10" QPFmm="" QPFin="" DewPointC="-5" DewPointF="23" RelativeHumidity="70" WindSpeedKnots="8" WindSpeedMPH="9"  WindDirectionEng="SW" /></WxShortTerm><WxForecast ID="NYZ084"><FPeriod interval="1" Day="FRI" Date="2008-11-14" Wx="Chance T-storms" Icon="tstorm.gif" HiF="66" HiC="19" LoF="56" LoC="13" Pop="60" Detail="Occasional showers with a chance of thunderstorms. Areas of fog. Some thunderstorms May be severe after midnight. Lows in the mid 50s. South winds 5 to 10 mph shifting to the southwest 10 to 15 mph after midnight. Chance of rain near 100 percent."/></WxForecast></Location></WeatherFeed>
+    XML
+  end
+  
+  def test_location_name
+    "Greenwich, NY, 12834, USA"
+  end
+  
+  before(:each) do
+    #@forecast = Hamweather::Forecast.new(test_forecast_data)
+    @forecast = Hamweather::Forecast.new(Hamweather::Location.parse(test_location_name))
+  end
+  
+  it "dailies{} should not be empty" do
+    @forecast.dailies.empty?.should be_false
+  end
+  
+  it "each_day should yield Daily objects" do
+    @forecast.each_day do |day|
+      day.class.should == Hamweather::Forecast::Daily
+    end
+  end
+  
+  it "each_hour should give back a Hash of Hourly objects" do
+    @forecast.each_day do |day|
+      day.each_hour do |hour|
+        hour.class.should == Hamweather::Forecast::Hourly
+      end
+    end
+  end
+  
+  it "hourlies{} should not be empty" do
+    @forecast.hourlies.empty?.should be_false
+  end
+  
+  it "each_hour should yield Hourly objects" do
+    @forecast.each_hour do |hour|
+      hour.class.should == Hamweather::Forecast::Hourly
+    end
+  end
+
+end

data/spec/hamweather_spec.rb

@@ -0,0 +1,37 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe Hamweather do
+  
+  describe "with no configuration" do
+    
+    it "should raise an ApiKeyException" do
+      lambda { Hamweather.locate('Belfast') }.should raise_error(Hamweather::ApiKeyException)
+    end
+  
+    it "should raise an ApiKeyException" do
+      lambda { Hamweather.forecast(mock(Hamweather::Location)) }.should raise_error(Hamweather::ApiKeyException)
+    end
+
+  end
+  
+  describe "with a normal configuration" do
+    
+    before(:each) do 
+      setup_google_api_config
+      setup_hamweather_api_config
+      @location = Hamweather.locate('Belfast')
+      @forecast = Hamweather.forecast(@location)
+    end
+    
+    it "should give a location" do
+      @location.kind_of?(Hamweather::Location).should be_true
+    end
+    
+    it "should give a forecast" do
+      @forecast.kind_of?(Hamweather::Forecast).should be_true
+    end
+  end
+  
+end
+
+    

data/spec/hourly_spec.rb

@@ -0,0 +1,73 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+#Hpricot.parse('<STPeriod interval="1" Epoch="1228298400" Day="Wed" Date="2008-12-03" Time="10:00" Wx="Partly Cloudy" Icon="pcloudy.gif" TempC="0" TempF="32" Pop="10" QPFmm="" QPFin="" DewPointC="-5" DewPointF="23" RelativeHumidity="70" WindSpeedKnots="8" WindSpeedMPH="9"  WindDirectionEng="SW" />').root
+#=> {emptyelem <stperiod qpfmm="" wx="Partly Cloudy" relativehumidity="70" dewpointc="-5" time="10:00" icon="pcloudy.gif" date="2008-12-03" tempc="0" qpfin="" windspeedknots="8" dewpointf="23" pop="10" day="Wed" winddirectioneng="SW" tempf="32" epoch="1228298400" interval="1" windspeedmph="9">}
+
+describe Hamweather::Forecast::Hourly do
+  
+  def test_forecast_data
+    <<-XML
+<STPeriod interval="1" Epoch="1228298400" Day="Wed" Date="2008-12-03" Time="10:00" Wx="Partly Cloudy" Icon="pcloudy.gif" TempC="0" TempF="32" Pop="10" QPFmm="" QPFin="" DewPointC="-5" DewPointF="23" RelativeHumidity="70" WindSpeedKnots="8" WindSpeedMPH="9"  WindDirectionEng="SW" />
+    XML
+  end
+  
+  before(:each) do
+    @hourly_forecast = Hamweather::Forecast::Hourly.new(Hpricot.parse(test_forecast_data).root)
+  end
+  
+  it "date should be 3rd December 2008" do
+    @hourly_forecast.date.should == Date.parse("2008-12-03")
+  end
+  
+  it "time should be 10:00" do 
+    @hourly_forecast.time.should == "10:00"
+  end
+  
+  it "expected_weather should be Partly Cloudy" do 
+    @hourly_forecast.expected_weather.should == "Partly Cloudy"
+  end
+  
+  it "temp_farenheit should be 32" do 
+    @hourly_forecast.temp_farenheit.should == 32
+  end
+  
+  it "temp_celsius should be 0" do 
+    @hourly_forecast.temp_celsius.should == 0
+  end
+  
+  it "probability_of_precipitation should be 10" do 
+    @hourly_forecast.probability_of_precipitation.should == 10
+  end
+  
+  it "precipitation_millimeters should be " do 
+    @hourly_forecast.precipitation_millimeters.should == ""
+  end
+  
+  it "precipitation_inches should be " do 
+    @hourly_forecast.precipitation_inches.should == ""
+  end
+  
+  it "dew_point_celsius should be -5" do 
+    @hourly_forecast.dew_point_celsius.should == -5
+  end
+  
+  it "dew_point_farenheit should be 23" do 
+    @hourly_forecast.dew_point_farenheit.should == 23
+  end
+  
+  it "relative_humidity should be 70" do 
+    @hourly_forecast.relative_humidity.should == 70
+  end
+  
+  it "wind_speed_knots should be 8" do 
+    @hourly_forecast.wind_speed_knots.should == 8
+  end
+  
+  it "wind_speed_mph should be 9" do 
+    @hourly_forecast.wind_speed_mph.should == 9
+  end
+  
+  it "wind_direction should be SW" do 
+    @hourly_forecast.wind_direction.should == "SW"
+  end
+end

data/spec/location_spec.rb

@@ -0,0 +1,77 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe Hamweather::Location do
+  
+  before(:each) do 
+    setup_google_api_config
+  end
+  
+  describe "with zipcode 12834" do
+    
+    # should be a valid zipcode (Greenwich, NY, USA)
+    
+    before(:each) do
+      @location = Hamweather::Location.parse("12834")
+    end
+    
+    it ".to_uri should be 'wx/12834.xml'" do
+      @location.to_uri.should == "wx/12834.xml"
+    end
+    
+  end
+  
+  describe "with postcode H0H0H0" do
+    
+    # should be a valid postcode (Santa, Lapland, CA)
+    
+    before(:each) do
+      @location = Hamweather::Location.parse("H0H0H0")
+    end
+    
+    it ".to_uri should be 'wx/H0H0H0.xml'" do
+      @location.to_uri.should == "wx/H0H0H0.xml"
+    end
+    
+  end
+  
+  describe "with an unambiguous address, '575 Burton Road, Greenwich, NY, 12834'" do
+    #Returns one option
+    
+    before(:each) do
+      @location = Hamweather::Location.parse('575 Burton Road, Greenwich, NY, 12834')
+    end
+    
+    it "should return one location object" do
+      #Google::Geo.should_receive(:new).with('thisapikey').and_return(mock(Google::Geo))
+      #so if you are using should_receive i'd put it in the actual it block of the spec
+      #so you should create the mock object first, set an expectation that ".locate" is called on it... then set the expectation that it's instantiated too!
+      @location.kind_of?(Hamweather::Location).should be_true
+    end
+    
+    it ".to_uri should be 'wx/nearby.xml?lat=-73.504265&lon=43.0676821'" do
+      @location.to_uri.should == "wx/nearby.xml?lat=43.0676821&lon=-73.504265"
+    end
+  end
+  
+  describe "with an ambiguous address, 'Greenwich, USA" do
+    #Returns circa 10 options, nb, no 'NY' or 'CT' in search string
+    before(:each) do
+      @location = Hamweather::Location.parse('Greenwich, USA')
+    end
+    
+    it "should return an array of location objects" do
+      @location.kind_of?(Array).should be_true
+      @location.should_not be_empty
+    end
+  end
+  
+  describe "with an unlocatable address" do
+
+    it "should raise a Hamweather::UnknownAddressError" do
+      
+      lambda { Hamweather::Location.parse('') }.should raise_error(Hamweather::UnknownAddressError)
+      
+    end
+    
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+require 'rubygems'
+require File.dirname(__FILE__) + '/../lib/hamweather'
+
+
+def setup_google_api_config 
+  Hamweather.google_maps_api_key = "ABQIAAAAuC9Wz6AZ_BvsKClq3zThQhT2yXp_ZAY8_ufC3CFXhHIE1NvwkxRAjq1Mt9DYkVx1c-jcuAsAreOT_w"
+end
+
+def setup_hamweather_api_config
+  Hamweather.api_key = "wxC1E2gT8AY7"
+end

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification 
+name: davidjrice-hamweather
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- David Rice
+- David Lowry
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-10-13 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: google-geo
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">"
+      - !ruby/object:Gem::Version 
+        version: 0.0.0
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: hpricot
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">"
+      - !ruby/object:Gem::Version 
+        version: 0.0.0
+    version: 
+description: Client API for Hamweather Weather Service (http://www.hamweather.com)
+email: david@contrast.ie
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- Manifest
+- README
+files: 
+- Manifest
+- README
+- Rakefile
+- hamweather.gemspec
+- lib/hamweather/forecast/daily.rb
+- lib/hamweather/forecast/hourly.rb
+- lib/hamweather/forecast.rb
+- lib/hamweather/location.rb
+- lib/hamweather.rb
+has_rdoc: true
+homepage: http://github.com/davidjrice/hamweather
+post_install_message: 
+rdoc_options: 
+- --main
+- README
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Ruby Client API for Hamweather Weather Service (http://www.hamweather.com)
+test_files: 
+- spec/daily_spec.rb
+- spec/forecast_spec.rb
+- spec/hamweather_spec.rb
+- spec/hourly_spec.rb
+- spec/location_spec.rb
+- spec/spec_helper.rb