No commit activity in last 3 years
No release in over 3 years
API Wrapper for Wunderground
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

~> 1.11
~> 10.0
~> 3.0
~> 3.0
~> 1.24
 Project Readme

Wunderground

Weather Underground API Wrapper. Curretly includes support for all data features.

Installation

Add this line to your application's Gemfile:

gem 'wunderground_api'

And then execute:

$ bundle

Or install it yourself as:

$ gem install wunderground_api

Usage

You will need a Wunderground API Key available here.

Configure your Wunderground to use the API key you receive.

Wunderground.configure do |config|
  config.api_key = ENV['WUNDERGROUND_API_KEY']
end

Data Objects

Available data objects are alerts, almanac, astronomy, conditions, currenthurricane, forecast, forecast10day, geolookup, history, hourly, hourly10day, planner, rawtide, satellite, tide, webcams, and yesterday. More information about each of these data objects can be found in the Wunderground API documentation.

To make a call for a data object where the arguments passed are the location parameters:

Wunderground::Resources.almanac(zip: '10001')
Wunderground::Resources.conditions(city: 'New York', state: 'NY')
Wunderground::Resources.hourly10day(city: 'London', state: 'England')
etc...

This will return a hash of the response body for the location provided. The schemas for the response objects can be found in the Wunderground API documentation.

Calls can be chained by joining resources with _and_. This will allow you to make fewer HTTP requests when multiple endpoints are needed.

Wunderground::Resources.almanac_and_forecast(zip: '10001')
Wunderground::Resources.geolookup_and_conditions(city: 'New York', state: 'NY')
Wunderground::Resources.alerts_and_conditions_and_hourly10day(city: 'London', state: 'England')
etc...

Locations

There are several ways to provide the location for the data object you wish to retrieve:

  • Zip Code (zip: '10001')
  • US City/State (city: 'New York', state: 'NY')
  • International City/Country (city: 'London', country: 'England')
  • Airport Code (airport: 'LGA')
  • Latitude/Longitude (lat: '40.748817', long: '-73.985428')
  • Private Weather Station Code (pws: B12E942)
  • AutoIP Detection (autoip: true)

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/johaywood/wunderground.

License

The gem is available as open source under the terms of the MIT License.