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

Development

~> 1.0
~> 1.8.7
~> 3.12

Runtime

>= 0
>= 0.4.0
 Project Readme

robut-weather¶ ↑

A Weather Underground based weather module for robut

<img src=“https://badge.fury.io/rb/robut-weather.png” alt=“Gem Version” />

Installation and usage¶ ↑

This module can be installed by running gem install robut-weather. This will require the additional gems robut, json, and {wunderground}[https://github.com/wnadeau/wunderground], which may or may not require their own dependencies.

Your Chatfile will need to have the Weather plugin loaded.

require 'robut-weather'
Robut::Plugin::Weather.default_location = "[DEFAULT LOCATION]"
Robut::Plugin::Weather.api_key = "[API KEY]"
Robut::Plugin.plugins << Robut::Plugin::Weather
DEFAULT LOCATION

must be in an acceptible Weather Underground format. See Location Formats below.

API KEY

must be obtained through Weather Underground. The Weather Underground API is only available to registered members. For light use, there is no charge. A key can be obtained from api.wunderground.com/weather/api/

Changelog¶ ↑

v1.0.0.pre1 released 9/28/2014

Added initial basic support for the radar command

v0.1.4 released 9/28/2014

Command now requires you to specify the bot's name as an @mention
Re-pushed gem with new version to include changelog

v0.1.3 released 9/24/2014

Command now requires you to specify the bot's name as an @mention

0.1.2 released 12/21/2013

Initial official release

Location Formats¶ ↑

Locations must be in the format expected by Weather Underground’s API

  • STATE/CITY

  • COUNTRY/CITY

  • AUTOIP

  • Zip Code

  • Airport Code

See api.wunderground.com/weather/api/d/docs?d=data/geolookup#examples for further examples.

Contributing to robut-weather¶ ↑

  • Check out the latest master to make sure the feature hasn’t been implemented or the bug hasn’t been fixed yet.

  • Check out the issue tracker to make sure someone already hasn’t requested it and/or contributed it.

  • Fork the project.

  • Start a feature/bugfix branch.

  • Commit and push until you are happy with your contribution.

  • Make sure to add tests for it. This is important so I don’t break it in a future version unintentionally.

  • Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.

Weather Underground API Usage¶ ↑

The data provided by this module comes from Weather Underground.