barometer 0.7.3 → 0.8.0

data/.gitignore

@@ -8,5 +8,6 @@ coverage
 *.gem
 
 .rvmrc
+.rspec
 .bundle
 Gemfile.lock

data/.travis.yml

@@ -0,0 +1,7 @@
+rvm:
+  - 1.9.3
+  - 1.9.2
+  - 1.8.7
+  - rbx-19mode
+  - ree
+script: "rake"

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2009-2010 Mark G
+Copyright (c) 2009-2013 Mark G
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/{README.rdoc → README.md}

@@ -1,4 +1,6 @@
-= barometer
+# barometer
+
+[![Build Status](https://travis-ci.org/attack/barometer.png?branch=master)](https://travis-ci.org/attack/barometer)
 
 A multi API consuming weather forecasting superstar.
 
@@ -13,54 +15,46 @@ same query can be used for all (or most) services, even if they don't
 support the query directly. See the "Query" section for more information on
 this.
 
-== version
+## version
 
-Version 0.7.3 is the current release of this gem. The gem is available from
-gemcutter (barometer: http://gemcutter.org/gems/barometer).
-Older version are available through rubyforge (barometer) and github
-(attack-barometer).
+Version 0.7.4 is the current release of this gem. The gem is available from
+rubygems (barometer: http://rubygems.org/gems/barometer).
 It is fully functional (for five weather service APIs).
 
-== status
+## status
 
 Currently this project has completed initial development and will work for a
-few weather services (wunderground, google, yahoo, weather.com, weather_bug).
-Barometer is developed using only Ruby 1.9.2, but will probably on both Ruby 1.8.7 and 1.9.1.
+few weather services (wunderground, yahoo, weather_bug).
+Barometer is developed using only Ruby 1.9.3, but will probably on both Ruby 1.8.7, 1.9.1 & 1.9.2.
 
 Features to be added in the future:
-- better command line output
-- even more weather service drivers (hamweather)
-- icon support
+* better command line output
+* even more weather service drivers (hamweather)
+* icon support
 
-= dependencies
+# dependencies
 
-== Google API key [UPDATED]
+## Google API key
 
 As stated on the Google Geocoding API website
 (http://code.google.com/apis/maps/documentation/geocoding/), Google no longer
 requires an API key.  Therefore Barometer no longer requires a Google API key.
 
-=== other keys
+### other keys
 
 The '~/.barometer' file can hold all your weather service API keys.
 
-eg. weather.com
-
-  weather:
-    partner: YOUR_PARTNER_KEY
-    license: YOUR_LICENSE_KEY
-
 eg. weatherbug.com
 
   weather_bug:
     code: YOUR_API_CODE
-    
+
 eg. Yahoo! Placemaker
 
   yahoo:
     app_id: YOUR_APP_ID
 
-== HTTParty
+## HTTParty
 
 Why? HTTParty was created and designed specifically for consuming web services.
 I choose to use this over using the Net::HTTP library directly to allow for
@@ -68,14 +62,14 @@ faster development of this project.
 
 It is possible that I will use Net::HTTP in the future.
 
-== tzinfo
+## tzinfo
 
 Why? Barometer deals with time information for locations all over the world.
 This information doesn't mean that much if it can't be converted to times 
 that don't correspond to the applicable timezone.
 Tzinfo handles this time zone manipulation.
 
-= queries
+# queries
 
 The query handling is one of the most beneficial and powerful features of
 Barometer.  Every weather service accepts a different set of possible
@@ -91,20 +85,20 @@ For example, Yahoo! only accepts US Zip Code or Weather.com ID.  With Barometer
 you can query Yahoo! with a simple location (ie: Paris) or even an Airport
 code (ICAO) and it will return the weather as expected.
 
-== acceptable formats
+## acceptable formats
 
-- zipcode
-- icao (international airport code)
-- coordinates (latitude and longitude)
-- postal code
-- weather.com ID
-- location name (ie address, city, state, landmark, etc.)
-- woeid (where on earth id, by Yahoo!)
+* zipcode
+* icao (international airport code)
+* coordinates (latitude and longitude)
+* postal code
+* weather.com ID
+* location name (ie address, city, state, landmark, etc.)
+* woeid (where on earth id, by Yahoo!)
 
-* if the query is of the formats zipcode or postal code it may not
-  support conversion to other formats.
-  
-== conversion caching
+*if the query is of the formats zipcode or postal code it may not
+support conversion to other formats.*
+
+## conversion caching
 
 Barometer has internal conversion caching.  No conversion will be
 repeated during a measurement, thus limiting the number of web queries
@@ -115,30 +109,30 @@ then use a query like "denver", this will require a conversion from
 "denver" to its weather.com weather_id.  This conversion is needed for
 both web services but will only happen once and be cached.
 
-= usage
+# usage
 
 You can use barometer right out of the box, as it is configured to use one
 register-less (no API key required) international weather service
 (wunderground.com).
 
+```ruby
   require 'barometer'
-  
+
   barometer = Barometer.new("Paris")
   weather = barometer.measure
-  
+
   puts weather.current.temperature
-  
-== sources
+```
+
+## sources
 
 The available sources are:
 
   Wunderground.com (:wunderground) [default]
   Yahoo! Weather (:yahoo)
-  Google Weather (:google)
-  Weather.com (:weather_dot_com) [requires key]
   WeatherBug.com (:weather_bug) [requires key]
-  
-== source configuration
+
+## source configuration
 
 Barometer can be configured to use multiple weather service APIs (either in
 a primary/failover config or in parallel).  Each weather service can also
@@ -146,45 +140,55 @@ have its own config.
 
 Weather services in parallel
 
-  Barometer.config = { 1 => [:yahoo, :google] }
-  
+```ruby
+  Barometer.config = { 1 => [:yahoo, :wunderground] }
+```
+
 Weather services in primary/failover
 
+```ruby
   Barometer.config = { 1 => [:yahoo], 2 => :wunderground }
-  
+```
+
 Weather services, one with some configuration. In this case we are setting
 a weight value, this weight is respected when calculating averages.
 
-  Barometer.config = { 1 => [{:wunderground => {:weight => 2}}, :google] }
-  
+```ruby
+  Barometer.config = { 1 => [{:wunderground => {:weight => 2}}, :yahoo] }
+```
+
 Weather services, one with keys.
 
-  Barometer.config = { 1 => [:yahoo, {:weather_dot_com => {:keys => {:partner => PARTNER_KEY, :license => LICENSE_KEY } }}] }
-  
-=== multiple weather API, with hierarchy
+```ruby
+  Barometer.config = { 1 => [:yahoo, {:weather_bug => {:keys => {:code => CODE_KEY} }}] }
+```
+
+### multiple weather API, with hierarchy
 
+```ruby
   require 'barometer'
-  
-  # use yahoo and google, if they both fail, use wunderground
-  Barometer.config = { 1 => [:yahoo, :google], 2 => :wunderground }
+
+  # use yahoo and weather.com, if they both fail, use wunderground
+  Barometer.config = { 1 => [:yahoo, {:weather_bug => {:keys => {:code => CODE_KEY} }}], 2 => :wunderground }
 
   barometer = Barometer.new("Paris")
   weather = barometer.measure
 
   puts weather.current.temperture
-  
-== command line
+```
+
+## command line
 
 You can use barometer from the command line. 
-  
+
   # barometer berlin
-  
+
 This will output the weather information for the given query.
 See the help for more command line information.
 
   # barometer -h
-  
-=== fail
+
+### fail
 
 What would cause a weather service to fail?  The most obvious is that the
 particular weather service in currently unavailable or not reachable.
@@ -196,62 +200,71 @@ weather service.
 For example, if you look at the example above, the query of "Paris" refers
 to a city in France.  Yahoo weather services only supports
 weather results for USA (at least at the time of writing).  Therefore, 
-Barometer would not use Yahoo, just Google and failover to use Wunderground
+Barometer would not use Yahoo, just WeatherBug and failover to use Wunderground
 (if needed).
 
-== searching
+## searching
 
 After you have measured the data, Barometer provides several methods to help
 you get the data you are after. All examples assume you already have measured
 the data as shown in the above examples.
 
-=== by preference (default service)
+### by preference (default service)
 
+```ruby
   weather.default         # returns measurement for default source
   weather.current         # returns current_measurement for default
   weather.now             # returns current_measurement for default
   weather.forecast        # returns all forecast_measurements for default
   weather.today           # returns forecast_measurement for default today
   weather.tomorrow        # returns forecast_measurement for default tomorrow
-  
+
   puts weather.now.temperature.c
   puts weather.tomorrow.high.c
+```
 
-=== by source
+### by source
 
+```ruby
   weather.source(:wunderground)   # returns measurement for specified source
   weather.sources                 # lists all successful sources
-  
+
   puts weather.source(:wunderground).current.temperature.c
+```
 
-=== by date
+### by date
 
+```ruby
   # note, the date is the date of the locations weather, not the date of the
   # user measuring the weather
   date = Date.parse("01-01-2009")
   weather.for(date)       # returns forecast_measurement for default on date 
   weather.source(:wunderground).for(date)   # same as above but specific source
-  
+
   puts weather.source(:wunderground).for(date).high.c
+```
 
-=== by time
+### by time
 
+```ruby
   # note, the time is the time of the locations weather, not the time of the
   # user measuring the weather
   time = Time.parse("13:00 01-01-2009")
   weather.for(time)       # returns forecast_measurement for default at time 
   weather.source(:wunderground).for(time)   # same as above but specific source
-  
+
   puts weather.source(:wunderground).for(time).low.f
-  
-== averages
+```
+
+## averages
 
 If you consume more then one weather service, Barometer can provide averages
 for the values (currently only for the 'current' values and not the forecasted
 values).
 
+```ruby
   require 'barometer'
-  
+
   Barometer.google_geocode_key = "THE_GOOGLE_API_KEY"
   # use yahoo and wunderground
   Barometer.config = { 1 => [:yahoo, :wunderground] }
@@ -260,16 +273,17 @@ values).
   weather = barometer.measure
 
   puts weather.temperture
+```
 
 This will calculate the average temperature as given by :yahoo and :wunderground
 
-=== weights
+### weights
 
 You can weight the values from a weather service so that the values from that
 web service have more influence then other values.  The weights are set in the
 config ... see the config section
   
-== simple answers
+## simple answers
 
 After you have measured the data, Barometer provides several "simple answer"
 methods to help you get answers to some basic questions. All examples assume
@@ -280,7 +294,7 @@ are configured to use.  All sources that have successfully measured data
 will be asked, but if there is no data that can answer the question then
 there will be no answer.
 
-=== is it windy?
+### is it windy?
 
   # 1st parameter is the threshold wind speed for being windy
   # 2nd parameter is the utc_time for which you want to know the answer,
@@ -288,8 +302,8 @@ there will be no answer.
   # NOTE: in my example the values are metric, so the threshold is 10 kph
 
   weather.windy?(10)
-  
-=== is it wet?
+
+### is it wet?
 
   # 1st parameter is the threshold pop (%) for being wet
   # 2nd parameter is the utc_time for which you want to know the answer,
@@ -298,69 +312,69 @@ there will be no answer.
 
   weather.wet?(50)
 
-=== is it sunny?
+### is it sunny?
 
   # 1st parameter is the utc_time for which you want to know the answer,
   #   this defaults to the current time
 
   weather.sunny?
 
-=== is it day?
+### is it day?
 
   # 1st parameter is the utc_time for which you want to know the answer,
   #   this defaults to the current time
 
   weather.day?
 
-=== is it night?
+### is it night?
 
   # 1st parameter is the utc_time for which you want to know the answer,
   #   this defaults to the current time
 
   weather.night?
 
-= design
+# design
 
-- create a Barometer instance
-- supply a query, there are very little restrictions on the format:
-  - city, country, specific address (basically anything Google will geocode)
-  - US zip code (skips conversion if weather service accepts this directly)
-  - postal code (skips conversion if weather service accepts this directly)
-  - latitude and longitude (skips conversion if weather service accepts this
+* create a Barometer instance
+* supply a query, there are very little restrictions on the format:
+  * city, country, specific address (basically anything Google will geocode)
+  * US zip code (skips conversion if weather service accepts this directly)
+  * postal code (skips conversion if weather service accepts this directly)
+  * latitude and longitude (skips conversion if weather service accepts this
     directly)
-  - weather.com weather id (even if the service you are using doesn't use it)
-  - international airport code (skips conversion if weather service
+  * weather.com weather id (even if the service you are using doesn't use it)
+  * international airport code (skips conversion if weather service
     accepts this directly)
-- determine which weather services will be queried (one or multiple)    
-- if query conversion required for specific weather service, convert the query
-- query the weather services
-- save the data
-- repeat weather service queries as needed
+* determine which weather services will be queried (one or multiple)    
+* if query conversion required for specific weather service, convert the query
+* query the weather services
+* save the data
+* repeat weather service queries as needed
 
-= extending
+# extending
 
 Barometer attempts to be a common API to any weather service API.  I have included
 several weather service 'drivers', but I know there are many more available.
 Please use the provided ones as examples to create more.
 
-= development
+# development
 
 Barometer now uses 'bundler'.  You just need to 'git clone' the repo and 'bundle install'.
 
-== Contributions
+## Contributions
 
 Thank you to these developers who have contributed. No contribution is too small.
 
-- nofxx (https://github.com/nofxx)
-- floere (https://github.com/floere)
-- plukevdh (https://github.com/plukevdh)
-
+* nofxx (https://github.com/nofxx)
+* floere (https://github.com/floere)
+* plukevdh (https://github.com/plukevdh)
+* gkop (https://github.com/gkop)
 
-= Links
+# Links
 
-- repo: http://github.com/attack/barometer
-- rdoc: http://rdoc.info/projects/attack/barometer
+* repo: http://github.com/attack/barometer
+* rdoc: http://rdoc.info/projects/attack/barometer
 
-== copyright
+## copyright
 
-Copyright (c) 2009-2011 Mark G. See LICENSE for details.
+Copyright (c) 2009-2013 Mark G. See LICENSE for details.