rubyweatherforecast 1.0

data/LICENSE.txt

@@ -0,0 +1,19 @@
+Copyright (c) 2009 Guilherme Nascimento
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README

@@ -0,0 +1,7 @@
+= Ruby Weather Forecast
+
+A library that allows fetch weather forecast data from Weather.com
+
+== Install
+
+== Examples

data/lib/Current.rb

@@ -0,0 +1,46 @@
+require File.dirname(File.expand_path(__FILE__)) + '/Wind'
+
+require "Time"
+  
+module Weather
+
+	class Current
+		attr_reader :doc
+
+		def initialize(doc)
+	    	@doc = doc
+	 	end
+
+	  	# Icon to be displayed
+	  	def icon
+	    	doc.at("icon").innerHTML
+	  	end
+
+	  	# Outlook message
+	  	def description
+	    	doc.at("t").innerHTML
+	  	end
+
+	  	# Forecast date
+	  	def date
+	    	Time.now
+	  	end
+
+	  	# Temperature
+	  	def temp
+	    	doc.at("tmp").innerHTML
+	  	end
+
+		# Last update (current)
+		def last_update
+			Time.parse(doc.at("lsup").innerHTML)
+		end
+
+	  	# Wind conditions
+	  	def wind
+	    	Weather::Wind.new(doc.at("wind"))
+	  	end
+
+	end
+
+end

data/lib/Day.rb

@@ -0,0 +1,24 @@
+require File.dirname(File.expand_path(__FILE__)) + '/FutureEstimate'
+
+module Weather
+
+	class Day < Weather::FutureEstimate
+		attr_reader :doc
+
+		def initialize(doc)
+			super(doc)
+		end
+
+	  	# Select day part in the doc
+	  	def part
+	    	day = nil
+	    	(doc/"part").each do |d|
+	      		if d.attributes["p"] == "d"
+	        		day = d
+	      		end
+	    	end
+	  	end
+
+	end
+
+end

data/lib/Forecast.rb

@@ -0,0 +1,90 @@
+require File.dirname(File.expand_path(__FILE__)) + '/Current'
+require File.dirname(File.expand_path(__FILE__)) + '/Day'
+require File.dirname(File.expand_path(__FILE__)) + '/Night'
+
+require "Time"
+
+module Weather
+
+	class Forecast
+		attr_reader :doc
+
+		def initialize(doc)
+	    	@doc = doc
+	  	end
+
+	  	# Current conditions
+	  	def current
+	    	Weather::Current.new(doc.at("weather/cc"))
+	  	end
+
+	  	# Location name
+	  	def location_name
+	    	doc.at("weather/loc/dnam").innerHTML
+	  	end
+
+	  	# Location ID
+	  	def location_id
+	    	doc.at("weather/loc")["id"]
+	  	end
+
+	  	# Unit of temperature (F | C)
+	  	def temp_unit
+	    	doc.at("weather/head/ut").innerHTML
+	  	end
+
+		# Unit of distance
+	  	def distance_unit
+	    	doc.at("weather/head/ud").innerHTML
+	  	end
+
+		# Unit of speed  	
+	  	def speed_unit
+	    	doc.at("weather/head/us").innerHTML
+	  	end
+
+		# Unit of precipitation
+	  	def precipitation_unit
+	    	doc.at("weather/head/up").innerHTML
+	  	end
+
+		# Unit of presure
+	  	def presure_unit
+	    	doc.at("weather/head/ur").innerHTML
+	  	end  	
+
+		# Last update (future)
+	  	def last_update
+	  		Time.parse(doc.at("weather/dayf/lsup").innerHTML)
+	  	end
+
+	  	# Used to know the forecast from tomorrow
+	  	def tomorrow
+	    	day(1)
+	  	end
+
+		# Defines a day 
+	  	def day(id)
+	    	day = nil
+	    	(doc/"weather/dayf/day").each do |d|
+	      		if d.attributes["d"] == id.to_s
+	          		day = d
+	      		end
+	    	end
+	    	Weather::Day.new(day)
+		end
+
+	  	# Defines a night
+	  	def night(id)
+	    	night = nil
+	    	(doc/"weather/dayf/day").each do |d|
+	      		if d.attributes["d"] == id.to_s
+	          		night = d
+	      		end
+	    	end
+	    	Weather::Night.new(night)
+		end
+
+	end
+
+end

data/lib/FutureEstimate.rb

@@ -0,0 +1,57 @@
+module Weather
+
+	class FutureEstimate
+		attr_reader :doc
+
+		def initialize(doc)
+	    	@doc = doc
+	  	end
+
+	  	# Icon
+	  	def icon
+	    	part.at("icon").innerHTML
+	  	end
+
+	  	# Description
+	  	def description
+	    	part.at("t").innerHTML
+	  	end
+
+	  	# Precipitation
+	  	def precipitation
+	    	part.at("ppcp").innerHTML
+	  	end
+
+	  	# Humidity
+	  	def humidity
+	    	part.at("hmid").innerHTML
+	  	end
+
+	  	# High temperature
+	  	def high
+	    	doc.at("hi").innerHTML
+	  	end
+
+	  	# Low temperature
+	  	def low
+	    	doc.at("low").innerHTML
+	  	end
+
+		# Sunrise
+		def sunrise
+	    	doc.at("sunr").innerHTML
+		end
+
+	  	# Sunset
+		def sunset
+	    	doc.at("suns").innerHTML
+	  	end
+
+	  	# Wind conditions
+	  	def wind
+	    	Weather::Wind.new(part.at("wind"))
+	  	end
+
+	end
+
+end	

data/lib/Night.rb

@@ -0,0 +1,24 @@
+require File.dirname(File.expand_path(__FILE__)) + '/FutureEstimate'
+
+module Weather
+
+	class Night < Weather::FutureEstimate
+		attr_reader :doc
+
+		def initialize(doc)
+	    	super(doc)
+		end
+
+	  	# Select night part in the doc
+	  	def part
+	    	night = nil
+	    	(doc/"part").each do |d|
+	      		if d.attributes["p"] == "n"
+	        		night = d
+	      		end
+	    	end
+	  	end
+
+	end
+
+end

data/lib/WeatherService.rb

@@ -0,0 +1,92 @@
+require "net/http"
+require "cgi"
+require "hpricot"
+require "memcache"
+
+require File.dirname(File.expand_path(__FILE__)) + '/Forecast'
+
+module Weather
+
+	class WeatherService
+		# Weather.com HOST
+	 	XOAP_HOST = "xoap.weather.com"
+
+		# Default unit ajusted to Farenheit degrees :)
+	  	def load_forecast(location_id, days = 1, unit = 's')
+		    # Partner ID and License Key provided by Weather.com
+		    partner_id = "1094780686"
+		    license_key = "d2f90d27351df0a8"
+
+		    # URL to fetch the forecast from Weather.com
+		    url = "/weather/local/#{location_id}?cc=*&dayf=#{days}&par=#{partner_id}&key=#{license_key}&unit=#{unit}"
+
+			if (cache_ok?)
+				# Retrieving data from cache
+				xml = @cache.get("#{location_id}:#{days}")
+			end
+
+			if (xml == nil)
+				# Retrieving the XML doc from weather.com
+			    xml = Net::HTTP.get(XOAP_HOST, url)
+				
+			    if (cache_ok?)
+					# Setting data on the cache
+		    		@cache.set("#{location_id}:#{days}", xml.to_s, cache_expiry)
+		    	end
+			end
+
+			# Using Hpricot to parse the data
+			doc = Hpricot.XML(xml)
+
+			# Passing doc to the Forecast object
+			Weather::Forecast.new(doc)
+	  	end
+
+		def find_location_id(search_string)
+		    # URL encode
+		    url = "/weather/search/search?where=#{CGI.escape(search_string)}"
+
+		    # Retrieving the XML doc
+		    xml = Net::HTTP.get(XOAP_HOST, url);
+
+		    # Using Hpricot to parser the data
+		    doc = Hpricot.XML(xml)
+			location_id = doc.at("/search/loc")["id"]
+	  	end
+
+		# Enables cache
+		def enable_cache
+			@enable_cache = true
+		end
+
+		# Disables cache
+		def disable_cache
+			@enable_cache = false
+		end
+
+		# Defines default expiration time in seconds (ten minutes)
+		def cache_expiry=(seconds)
+			@cache_expiry = seconds
+		end
+
+		# Defines expiration time in seconds
+		def cache_expiry
+			@cache_expiry || 60 * 10
+      	end
+
+		# Used to instantiate the MemCache
+		def cache
+			@cache ||= MemCache.new(:namespace => 'Weather')
+		end
+
+		# Verifies if the cache is enabled and actived
+		def cache_ok?
+			@enable_cache and 
+			@cache.active? and 
+			servers = @cache.instance_variable_get(:@servers) and 
+		    servers.collect{|s| s.alive?}.include?(true)
+		end
+
+	end
+
+end

data/lib/Wind.rb

@@ -0,0 +1,32 @@
+module Weather
+
+	class Wind
+		attr_reader :doc
+
+		def initialize(doc)
+			@doc = doc
+		end
+
+		# Wind speed
+		def speed
+			doc.at("s").innerHTML
+		end
+
+		# Wind gust speed
+		def gust_speed
+			doc.at("gust").innerHTML
+		end
+
+		# Wind direction
+		def direction
+			doc.at("d").innerHTML
+		end
+
+		# Wind description
+		def description
+			doc.at("t").innerHTML
+		end
+
+	end
+
+end	

metadata

@@ -0,0 +1,66 @@
+--- !ruby/object:Gem::Specification 
+name: rubyweatherforecast
+version: !ruby/object:Gem::Version 
+  version: "1.0"
+platform: ruby
+authors: 
+- Guilherme Nascimento
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-05-06 00:00:00 -03:00
+default_executable: 
+dependencies: []
+
+description: Ruby Weather Forecast built using Hpricot and MemCached.
+email: matt@roughest.net
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+- LICENSE.txt
+files: 
+- lib/Current.rb
+- lib/Day.rb
+- lib/Forecast.rb
+- lib/FutureEstimate.rb
+- lib/Night.rb
+- lib/WeatherService.rb
+- lib/Wind.rb
+- README
+- LICENSE.txt
+has_rdoc: true
+homepage: http://rubyforge.org/projects/weatherforecast
+post_install_message: 
+rdoc_options: 
+- --title
+- RubyWeatherForecast 1.0 RDocs
+- --main
+- README
+- --line-numbers
+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: weatherforecast
+rubygems_version: 1.3.1
+signing_key: 
+specification_version: 2
+summary: Ruby Weather Forecast Library.
+test_files: []
+