weatherfinder 1.1 → 1.2

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,71 @@
+Author::    Guilherme Nascimento
+Copyright:: Copyright (c) 2009
+
+== Overview
+
+Weather Finder is a Ruby library to access Weather.com data (XOAP). The library uses Hpricot and MemCached and allows fetch current forecast data from anywhere location.
+
+In order to use this library, you need to get a partner_id and license_key from Weather.com service at:
+http://www.weather.com/services/xmloap.html
+
+After signed up, you will receive an email with partner_id and license_key.
+
+If you need read the complete terms and conditions about the use of the service, you can download the SDK from link below:
+http://download.weather.com/web/xml/sdk.zip
+
+In this .zip file, you can find too the graphical icons to represent the conditions associated with the current forecast.
+
+== Quick Install
+
+RubyGem:
+
+	sudo gem install weatherfinder
+
+== Fetching current conditions
+
+	require "weatherfinder"
+
+	service = Weather::WeatherFinder.new
+
+	# Partner ID and License Key provided by Weather.com
+	service.partner_id = your partner id
+	service.license_key = your license key
+
+	# Fetching current forecast from Rio de Janeiro ;)
+	forecast = service.load_forecast("BRXX0201")
+
+	puts "Current Description: " + forecast.current.description
+	puts "Current Temperature: " + forecast.current.temp
+	puts "Current Icon: " + forecast.current.icon
+	puts "Current Wind Speed: " + forecast.current.wind.speed
+
+== Fetching tomorrow's forecast:
+
+	puts "Tomorrow's High Temperature: " + forecast.tomorrow.high
+	puts "Tomorrow's Low Temperature: " + forecast.tomorrow.low
+	puts "Tomorrow's Sunrise: " + forecast.tomorrow.sunrise
+	puts "Tomorrow's Sunset: " + forecast.tomorrow.sunset
+	puts "Tomorrow's Wind Speed" + forecast.tomorrow.wind.speed
+
+== Future Forecasts
+
+Future forecasts can be accessed using day() method from Forecast class. This method accept an argument indicating the number of days that will be fetched. This functionality depends of the day that was defined at load_forecast() method.
+
+	puts "High Temperature 2 days from now: " + forecast.day(2).high
+	puts "High Temperature 2 days from now: " + forecast.day(2).low
+	puts "Sunrise 2 days from now: " + forecast.day(2).sunrise
+	puts "Sunset 2 days from now: " + forecast.day(2).sunset
+
+== Cache
+
+WeatherFinder uses Memcached[http://www.danga.com/memcached/] to support data caching. This functionality is very useful when a lot of requests are made by clients.
+
+You need to install Ruby-MemCache[http://www.deveiate.org/code/Ruby-MemCache/] Gem:
+
+	sudo gem install Ruby-MemCache
+
+After installation, you need to enable the cache:
+
+	service.enable_cache
+	service.cache.servers = "localhost:11211"
+	service.cache_expiry = 10

data/weatherfinder.gemspec

@@ -1,13 +1,13 @@
 Gem::Specification.new do |s|
   s.name = %q{weatherfinder}
-  s.version = "1.1"
+  s.version = "1.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Guilherme Nascimento"]
   s.date = %q{2009-02-20}
   s.description = %q{Weather Finder is a Ruby library to access Weather.com data (XOAP)}
   s.email = ["javaplayer@gmail.com"]
-  s.files = ["weatherfinder.gemspec","lib/weatherfinder.rb", "lib/current.rb", "lib/day.rb", "lib/forecast.rb", "lib/future_estimate.rb", "lib/night.rb", "lib/wind.rb"]
+  s.files = ["weatherfinder.gemspec","lib/weatherfinder.rb", "lib/current.rb", "lib/day.rb", "lib/forecast.rb", "lib/future_estimate.rb", "lib/night.rb", "lib/wind.rb", "README", "License.txt"]
   s.require_paths = ["lib"]
   s.rubyforge_project = %q{weatherfinder}
   s.rubygems_version = %q{1.3.1}

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: weatherfinder
 version: !ruby/object:Gem::Version 
-  version: "1.1"
+  version: "1.2"
 platform: ruby
 authors: 
 - Guilherme Nascimento
@@ -31,6 +31,8 @@ files:
 - lib/future_estimate.rb
 - lib/night.rb
 - lib/wind.rb
+- README
+- License.txt
 has_rdoc: true
 homepage: http://weatherfinder.rubyforge.org/
 post_install_message: