hyperoslo/yr

Yr makes it easy to get weather forecast from Yr.no.

Yr

Yr makes it easy to get weather forecast from Yr.no.

Installation

Add this line to your application's Gemfile:

gem 'yr'

And then execute:

$ bundle

Or install it yourself as:

$ gem install yr

Usage

oslo = Yr::Place.find "Oslo"
oslo.forecast.days.each do |day|
  p day.name
  p day.date
  p day.temperature.value
end

If you are using Rails, all the weather symbols are included in the assets pipeline, both svg and png formats. This means you can do something like this if you want to display an icon <%= image_tag day.symbol.svg %> or <%= image_tag day.symbol.png %>.

PNG files are included in several sizes, which you can specify like this <%= image_tag day.symbol.png(size: 100) %>.

The supported png sizes are:

• 30px
• 38px
• 48px (default)
• 100px
• 200px

Contributing

1. Fork it
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'Add some feature')
4. Push to the branch (git push origin my-new-feature)
5. Create new Pull Request

Credits

Hyper made this. We're a digital communications agency with a passion for good code, and if you're using this library we probably want to hire you.

Also thanks to https://github.com/Hakon/yr_api for inspiration and some code.

License

Yr is available under the MIT license. See the LICENSE file for more info.

yr's Issues

Facilitate for easy convertion between celcius and other temperature units.

Enable searching for forecast with geodata.

Fix bug where requesting urls with strange characters in them fail.

If a place, municipality or county has non url safe characters in it, the request for the xml fails.

Change the name of the gem, since it clashes with another one.

Think about renaming Yr::Symbol class

"Symbol" class name might cause collisions with ruby's symbols

Facilitate for configuring which language to use.

The yr.no API provides answers in english, norwegian (nb and nn).

If the period with ID 2, the "day period" is not there (the time has passed) use the next available.

The second period is the correct period to use, but if we are based 18.00 it will not be returned by the API since they don't show historical data. If so, use the next available period.

Provide a search using zip codes.

Provide links to weather icons from Yr::Symbol

It should be easy to retrieve the weather icons from the Symbol class.