ben
/
earwigbot-plugins
mirror of https://github.com/earwig/earwigbot-plugins
1
1
Fork 0
Code Releases 1 Activity
Additional IRC commands and bot tasks for EarwigBot https://en.wikipedia.org/wiki/User:EarwigBot
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
199 Commits
1 Branch
685 KiB
 
 
Tree: 33f992465e
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from '33f992465e'
${ noResults }
earwigbot-plugins/commands/weather.py

180 lines
7.9 KiB
Raw Blame History 

  1. # -*- coding: utf-8  -*-

  2. #

  3. # Copyright (C) 2009-2014 Ben Kurtovic <ben.kurtovic@gmail.com>

  4. #

  5. # Permission is hereby granted, free of charge, to any person obtaining a copy

  6. # of this software and associated documentation files (the "Software"), to deal

  7. # in the Software without restriction, including without limitation the rights

  8. # to use, copy, modify, merge, publish, distribute, sublicense, and/or sell

  9. # copies of the Software, and to permit persons to whom the Software is

  10. # furnished to do so, subject to the following conditions:

  11. #

  12. # The above copyright notice and this permission notice shall be included in

  13. # all copies or substantial portions of the Software.

  14. #

  15. # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR

  16. # IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,

  17. # FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE

  18. # AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER

  19. # LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,

  20. # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE

  21. # SOFTWARE.

  22. 

  23. from datetime import datetime

  24. from json import loads

  25. from urllib import quote

  26. from urllib2 import urlopen

  27. 

  28. from earwigbot.commands import Command

  29. 

  30. class Weather(Command):

  31.     """Get a weather forecast (via http://www.wunderground.com/)."""

  32.     name = "weather"

  33.     commands = ["weather", "weat", "forecast", "temperature", "temp"]

  34. 

  35.     def setup(self):

  36.         self.config.decrypt(self.config.commands, self.name, "apiKey")

  37.         try:

  38.             self.key = self.config.commands[self.name]["apiKey"]

  39.         except KeyError:

  40.             self.key = None

  41.             addr = "http://wunderground.com/weather/api/"

  42.             config = 'config.commands["{0}"]["apiKey"]'.format(self.name)

  43.             log = "Cannot use without an API key from {0} stored as {1}"

  44.             self.logger.warn(log.format(addr, config))

  45. 

  46.     def process(self, data):

  47.         if not self.key:

  48.             addr = "http://wunderground.com/weather/api/"

  49.             config = 'config.commands["{0}"]["apiKey"]'.format(self.name)

  50.             msg = "I need an API key from {0} stored as \x0303{1}\x0F."

  51.             log = "Need an API key from {0} stored as {1}"

  52.             self.reply(data, msg.format(addr, config))

  53.             self.logger.error(log.format(addr, config))

  54.             return

  55. 

  56.         permdb = self.config.irc["permissions"]

  57.         if not data.args:

  58.             if permdb.has_attr(data.host, "weather"):

  59.                 location = permdb.get_attr(data.host, "weather")

  60.             else:

  61.                 msg = " ".join(("Where do you want the weather of? You can",

  62.                                 "set a default with '!{0} default City,",

  63.                                 "State' (or 'City, Country' if non-US)."))

  64.                 self.reply(data, msg.format(data.command))

  65.                 return

  66.         elif data.args[0] == "default":

  67.             if data.args[1:]:

  68.                 value = " ".join(data.args[1:])

  69.                 permdb.set_attr(data.host, "weather", value)

  70.                 msg = "\x0302{0}\x0F's default set to \x02{1}\x0F."

  71.                 self.reply(data, msg.format(data.host, value))

  72.             else:

  73.                 if permdb.has_attr(data.host, "weather"):

  74.                     value = permdb.get_attr(data.host, "weather")

  75.                     msg = "\x0302{0}\x0F's default is \x02{1}\x0F."

  76.                     self.reply(data, msg.format(data.host, value))

  77.                 else:

  78.                     self.reply(data, "I need a value to set as your default.")

  79.             return

  80.         else:

  81.             location = " ".join(data.args)

  82. 

  83.         url = "http://api.wunderground.com/api/{0}/conditions/astronomy/q/{1}.json"

  84.         location = quote(location, safe="")

  85.         query = urlopen(url.format(self.key, location)).read()

  86.         res = loads(query)

  87. 

  88.         if "error" in res["response"]:

  89.             try:

  90.                 desc = res["response"]["error"]["description"]

  91.                 desc = desc[0].upper() + desc[1:]

  92.                 if desc[-1] not in (".", "!", "?"):

  93.                     desc += "."

  94.             except (KeyError, IndexError):

  95.                 desc = "An unknown error occurred."

  96.             self.reply(data, desc)

  97.         elif "current_observation" in res:

  98.             msg = self.format_weather(res)

  99.             self.reply(data, msg)

  100.         elif "results" in res["response"]:

  101.             msg = self.format_ambiguous_result(res)

  102.             self.reply(data, msg)

  103.         else:

  104.             self.reply(data, "An unknown error occurred.")

  105. 

  106.     def format_weather(self, res):

  107.         """Format the weather (as dict *data*) to be sent through IRC."""

  108.         data = res["current_observation"]

  109.         place = data["display_location"]["full"]

  110.         icon = self.get_icon(data["icon"], data["local_time_rfc822"],

  111.                              res["sun_phase"]).encode("utf8")

  112.         weather = data["weather"]

  113.         temp_f, temp_c = data["temp_f"], data["temp_c"]

  114.         humidity = data["relative_humidity"]

  115.         wind_dir = data["wind_dir"]

  116.         if wind_dir in ("North", "South", "East", "West"):

  117.             wind_dir = wind_dir.lower()

  118.         wind = "{0} {1} mph".format(wind_dir, data["wind_mph"])

  119.         if float(data["wind_gust_mph"]) > float(data["wind_mph"]):

  120.             wind += " ({0} mph gusts)".format(data["wind_gust_mph"])

  121. 

  122.         msg = "\x02{0}\x0F: {1} {2}; {3}°F ({4}°C); {5} humidity; wind {6}"

  123.         msg = msg.format(place, icon, weather, temp_f, temp_c, humidity, wind)

  124.         if data["precip_today_in"] and float(data["precip_today_in"]) > 0:

  125.             msg += "; {0}″ precipitation today".format(data["precip_today_in"])

  126.             if data["precip_1hr_in"] and float(data["precip_1hr_in"]) > 0:

  127.                 msg += " ({0}″ past hour)".format(data["precip_1hr_in"])

  128.         return msg

  129. 

  130.     def get_icon(self, condition, local_time, sun_phase):

  131.         """Return a unicode icon to describe the given weather condition."""

  132.         icons = {

  133.             "chanceflurries": u"☃",

  134.             "chancerain": u"☂",

  135.             "chancesleet": u"☃",

  136.             "chancesnow": u"☃",

  137.             "chancetstorms": u"☂",

  138.             "clear": u"☽☀",

  139.             "cloudy": u"☁",

  140.             "flurries": u"☃",

  141.             "fog": u"☁",

  142.             "hazy": u"☁",

  143.             "mostlycloudy": u"☁",

  144.             "mostlysunny": u"☽☀",

  145.             "partlycloudy": u"☁",

  146.             "partlysunny": u"☽☀",

  147.             "rain": u"☂",

  148.             "sleet": u"☃",

  149.             "snow": u"☃",

  150.             "sunny": u"☽☀",

  151.             "tstorms": u"☂",

  152.         }

  153.         try:

  154.             icon = icons[condition]

  155.             if len(icon) == 2:

  156.                 lt_no_tz = local_time.rsplit(" ", 1)[0]

  157.                 dt = datetime.strptime(lt_no_tz, "%a, %d %b %Y %H:%M:%S")

  158.                 srise = datetime(year=dt.year, month=dt.month, day=dt.day,

  159.                                  hour=int(sun_phase["sunrise"]["hour"]),

  160.                                  minute=int(sun_phase["sunrise"]["minute"]))

  161.                 sset = datetime(year=dt.year, month=dt.month, day=dt.day,

  162.                                 hour=int(sun_phase["sunset"]["hour"]),

  163.                                 minute=int(sun_phase["sunset"]["minute"]))

  164.                 return icon[int(srise < dt < sset)]

  165.             return icon

  166.         except KeyError:

  167.             return u"?"

  168. 

  169.     def format_ambiguous_result(self, res):

  170.         """Format a message when there are multiple possible results."""

  171.         results = []

  172.         for place in res["response"]["results"]:

  173.             extra = place["state" if place["state"] else "country"]

  174.             results.append("{0}, {1}".format(place["city"], extra))

  175.         if len(results) > 21:

  176.             extra = len(results) - 20

  177.             res = "; ".join(results[:20])

  178.             return "Did you mean: {0}... ({1} others)?".format(res, extra)

  179.         return "Did you mean: {0}?".format("; ".join(results))