weatherboy 1.0.1

data/README

@@ -0,0 +1,134 @@
+== Weatherboy
+
+Weatherboy is an easy-to-use gem that interfaces with the wunderground.com weather XML feeds.
+You are responsible for following Weather Underground's Terms of Service when using thier data feeds.
+
+TOS: http://wiki.wunderground.com/index.php/API_-_XML#API_Terms_Of_Service
+
+All classes in Wetherboy are wrapped inside the Weatherboy namespace. The class you directly interface with is the Core class. All other classes in the gem hold individual bits of weather info (current conditions, alerts, etc) that the Core class invokes.
+
+== Setup
+Require the gem like you would any other gem. 
+
+Then somewhere in your code, create a new Weatherboy::Core object. The initilize method can take an area code, airport code, localweather station code, a city/state combo, or no arguments. Passing a location into the initilize method sets the location attribute used for all API calls.
+
+  weatherboy = Weatherboy::Core.new(90210)
+  weatherboy = Weatherboy::Core.new("Indianapolis, IN")
+  weatherboy = Weatherboy::Core.new
+
+You can set/change the location at any time via the location attribute of the object.
+
+  weatherboy.location = "New York, NY"
+  weatherboy.location = 46220
+  weatherboy.location
+  => 46220
+
+The location attribute must be set before you can use any API calls.
+
+== Retrieving Weather Information 
+Now that you've created a Weatherboy::Core instance and set a location for it, you're ready to get some weather information.
+
+=== get_current
+The get_current method retrieves the current weather information in the form of a Weatherboy::Current object. It stores the result in the current attribute of the Core class. get_current returns true on a successful result.
+
+  weatherboy.get_current
+  => true
+  weatherboy.current.weather
+  => "Overcast"
+  weatherboy.current.temp_f
+  => "31"
+
+=== Attributes of the Weatherboy::Current class
+* icon (URL)
+* weather
+* temp_f
+* temp_c
+* relative_humidity
+* wind_dir
+* wind_mph
+* pressure_mb
+* pressure_in
+* dewpoint_f
+* dewpoint_c
+* heat_index_f
+* heat_index_c
+* windchill_f
+* windchill_c
+* windchill_c
+* visibility_mi
+* visibility_km
+
+
+=== get_forecasts
+The get_forecasts method retrieves future weather predictions in the form of an array of Weatherboy::Forecast objects. It stores the result in the forecsts attribute of the Core class. get_forecasts returns true on a successful result.
+
+  weatherboy.get_forecasts
+  => true
+  weatherboy.forecasts[0].high_f
+  => "43"
+  weatherboy.forecasts[0].conditions
+  => "Mostly Cloudy"
+
+=== Attributes of the Weatherboy::Current class
+* high_f
+* high_c
+* low_f
+* low_c
+* conditions
+* icon (URL)
+* pop (Possibility of Precipitation)
+* title (This Afternoon, Tonight, Monday, etc)
+* text (Full text of forecast)
+
+
+=== get_alerts ===
+The get_alerts method retrieves severe weather alerts and special weather statements in the form of an array of Weatherboy::Alert objects. It stores the result in the alerts attribute of the Core class. get_alerts returns true on a successful result.
+
+  weatherboy.get_alerts
+  => true
+  weatherboy.alerts.size
+  => 1
+  weatherboy.alerts[0].date
+  => "3:40 am PST on January 15, 2008"
+  weatherboy.alerts[0].description
+  => "Lake Wind Advisory"
+
+=== Attributes of the Weatherboy::Alert class
+* description
+* date (Just the string returned from the XML. Not a date object)
+* message (Usually a HUGE wall of text)
+
+
+=== get_media
+The get_media method retrieves local weather webcams of the location and stores them in an array of Weatherboy::Webcam objects in the webcams attribute. 
+It also gets the Weather Underground radar information and stores is as a Weatherboy::Radar object in the radar attribute.
+get_media returns true on a successful result.
+
+  weatherboy.get_media
+  => true
+  weatherboy.radar.image_url
+  => "http://www.wunderground.com/radar/radblast.asp?ID=IND&region=b4&lat=39.89311981&lon=-86.18370819" 
+  weatherboy.webcams[2].image_url
+  => "http://icons.wunderground.com/webcamramdisk/v/e/VeedersburgBear/1/current.jpg?t=1298845906" 
+
+=== Attributes of the Weatherboy::Radar class
+* image_url
+* url
+
+=== Attributes of the Weatherboy::Webcam class
+* handle
+* camid
+* assoc_station_id
+* link
+* link_text
+* organization
+* cameratype
+* neighborhood
+* zip
+* city
+* state
+* country
+* updated
+* image_url
+* widget_url
+* cam_url

data/lib/weatherboy/alert.rb

@@ -0,0 +1,14 @@
+module Weatherboy
+  class Alert
+    
+    attr_reader :description, :date, :message
+  
+    def initialize(doc)
+      @description = doc.elements['description'].text
+      @date = doc.elements['date'].text
+      @message = doc.elements['message'].text
+    end   
+    
+  end
+
+end

data/lib/weatherboy/current.rb

@@ -0,0 +1,30 @@
+module Weatherboy
+  class Current
+    
+    attr_reader :icon, :weather, :temp_f, :temp_c, :relative_humidity, :wind_dir, :wind_mph, :pressure_mb, :pressure_in, :dewpoint_f, :dewpoint_c
+    attr_reader :heat_index_f, :heat_index_c, :windchill_f, :windchill_c, :windchill_c, :visibility_mi, :visibility_km
+  
+    def initialize(doc)
+      @icon = "http://icons-ecast.wxug.com/graphics/conds/#{doc.elements['current_observation/icon'].text}.gif"
+      @weather = doc.elements['current_observation/weather'].text
+      @temp_f = doc.elements['current_observation/temp_f'].text
+      @temp_c = doc.elements['current_observation/temp_c'].text
+      @relative_humidity = doc.elements['current_observation/relative_humidity'].text
+      @wind_dir = doc.elements['current_observation/wind_dir'].text
+      @wind_mph = doc.elements['current_observation/wind_mph'].text
+      @pressure_mb = doc.elements['current_observation/pressure_mb'].text
+      @pressure_in = doc.elements['current_observation/pressure_in'].text
+      @dewpoint_f = doc.elements['current_observation/dewpoint_f'].text
+      @dewpoint_c = doc.elements['current_observation/dewpoint_c'].text
+      @heat_index_f = doc.elements['current_observation/heat_index_f'].text
+      @heat_index_c = doc.elements['current_observation/heat_index_c'].text
+      @windchill_f = doc.elements['current_observation/windchill_f'].text
+      @windchill_c = doc.elements['current_observation/windchill_c'].text
+      @windchill_c = doc.elements['current_observation/windchill_c'].text
+      @visibility_mi = doc.elements['current_observation/visibility_mi'].text
+      @visibility_km = doc.elements['current_observation/visibility_km'].text
+    end   
+    
+  end
+
+end

data/lib/weatherboy/forecast.rb

@@ -0,0 +1,23 @@
+module Weatherboy
+  class Forecast
+    
+    attr_reader :high_f, :high_c, :low_f, :low_c, :conditions, :icon, :pop, :title, :text
+  
+    def first_pass(doc)
+      @high_f = doc.elements['high/fahrenheit'].text
+      @high_c = doc.elements['high/celsius'].text
+      @low_f = doc.elements['low/fahrenheit'].text
+      @low_c = doc.elements['low/celsius'].text
+      @conditions = doc.elements['conditions'].text
+      @icon = "http://icons-ecast.wxug.com/graphics/conds/#{doc.elements['icon'].text}.gif"
+      @pop = doc.elements['pop'].text
+    end
+    
+    def second_pass(doc)
+      @title = doc.elements['title'].text
+      @text = doc.elements['fcttext'].text
+    end
+    
+  end
+
+end

data/lib/weatherboy/radar.rb

@@ -0,0 +1,13 @@
+module Weatherboy
+  class Radar
+    
+    attr_reader :image_url, :url
+  
+    def initialize(doc)
+      @image_url = doc.elements['image_url'].text
+      @url = doc.elements['url'].text
+    end   
+    
+  end
+
+end

data/lib/weatherboy/weatherboy.rb

@@ -0,0 +1,78 @@
+module Weatherboy
+  class Core
+    require 'net/http'
+    require 'rexml/document'
+    
+    attr_reader :current, :alerts, :forecasts, :webcams, :radar
+    attr_accessor :location, :debug
+    #From http://wiki.wunderground.com/index.php/API_-_XML
+    
+    BASE_URL = "http://api.wunderground.com/auto/wui/geo/"
+    
+    def initialize(loc=nil)
+      @location = loc
+    end
+        
+    def get_current
+      verify
+      doc = makeCall(BASE_URL+"WXCurrentObXML/index.xml?query=#{@location}")
+      @current = Current.new(doc)
+      true
+    end
+    
+    def get_alerts
+      verify
+      @alerts = []
+      doc = makeCall(BASE_URL+"AlertsXML/index.xml?query=#{@location}")
+      doc.elements.each('alerts/alert/AlertItem') do |alert_doc|
+        @alerts << Alert.new(alert_doc)
+      end
+      true
+    end
+    
+    def get_forecasts
+      verify
+      @forecasts = []
+      doc = makeCall(BASE_URL+"ForecastXML/index.xml?query=#{@location}")
+      doc.elements.each('forecast/simpleforecast/forecastday') do |forcastday|
+        this_forecast = Forecast.new
+        this_forecast.first_pass(forcastday)
+        @forecasts << this_forecast
+      end
+      i = 0
+      doc.elements.each('forecast/txt_forecast/forecastday') do |forecastday|
+        @forecasts[i].second_pass(forecastday)
+        i = i + 1
+      end
+      true
+    end
+    
+    def get_media
+      verify
+      @webcams = []
+      @radar = nil
+      doc = makeCall(BASE_URL+"GeoLookupXML/index.xml?query=#{@location}")
+      doc.elements.each('location/webcams/cam') do |webcam|
+        @webcams << Webcam.new(webcam)
+      end
+      @radar = Radar.new(doc.elements['location/radar'])
+      true
+    end
+    
+    
+    protected
+    
+    def verify
+      raise "Weatherboy: Location not set. Can't make call." if @location.nil?
+    end
+      
+    def makeCall(url)
+      return REXML::Document.new( Net::HTTP.get_response(URI.parse(url)).body )
+    end
+    
+    def debugging?
+      @debug == true
+    end
+    
+  end
+end

data/lib/weatherboy/webcam.rb

@@ -0,0 +1,27 @@
+module Weatherboy
+  class Webcam
+    
+    attr_reader :handle, :camid, :assoc_station_id, :link, :link_text, :organization, :cameratype, :neighborhood, :zip, :city, :state, :country, :updated, :image_url, :widget_url, :cam_url
+  
+    def initialize(doc)
+      @handle = doc.elements['handle'].text
+      @camid = doc.elements['camid'].text
+      @assoc_station_id = doc.elements['assoc_station_id'].text
+      @link = doc.elements['link'].text
+      @link_text = doc.elements['linktext'].text
+      @organization = doc.elements['organization'].text
+      @cameratype = doc.elements['cameratype'].text
+      @neighborhood = doc.elements['neighborhood'].text
+      @zip = doc.elements['zip'].text
+      @city = doc.elements['city'].text
+      @state = doc.elements['state'].text
+      @country = doc.elements['country'].text
+      @updated = doc.elements['updated'].text
+      @image_url = doc.elements['CURRENTIMAGEURL'].text
+      @widget_url = doc.elements['WIDGETCURRENTIMAGEURL'].text
+      @cam_url = doc.elements['CAMURL'].text
+    end   
+    
+  end
+
+end

data/lib/weatherboy.rb

@@ -0,0 +1,6 @@
+require 'weatherboy/alert'
+require 'weatherboy/forecast'
+require 'weatherboy/current'
+require 'weatherboy/webcam'
+require 'weatherboy/radar'
+require 'weatherboy/weatherboy'

metadata

@@ -0,0 +1,76 @@
+--- !ruby/object:Gem::Specification 
+name: weatherboy
+version: !ruby/object:Gem::Version 
+  hash: 21
+  prerelease: 
+  segments: 
+  - 1
+  - 0
+  - 1
+  version: 1.0.1
+platform: ruby
+authors: 
+- Tony Drake
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-02-28 00:00:00 -10:00
+default_executable: 
+dependencies: []
+
+description: A Ruby Gem that connects to Weather Underground's XML API feed. Provides current conditions, future forecasts, weather alerts, and links to weather camera images and weather radars.
+email: 
+- t27duck@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+files: 
+- README
+- lib/weatherboy.rb
+- lib/weatherboy/webcam.rb
+- lib/weatherboy/weatherboy.rb
+- lib/weatherboy/radar.rb
+- lib/weatherboy/forecast.rb
+- lib/weatherboy/alert.rb
+- lib/weatherboy/current.rb
+has_rdoc: true
+homepage: https://bitbucket.org/t27duck/weatherboy
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --main
+- README
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: weatherboy
+rubygems_version: 1.5.2
+signing_key: 
+specification_version: 3
+summary: Retrieve weather information from Weather Underground
+test_files: []
+