diff --git a/README.md b/README.md index 4ff3a44..4155509 100644 --- a/README.md +++ b/README.md @@ -77,6 +77,9 @@ Most of these plugins also have their own READMEs in their folders; you can usua ##### Replacer - History replacer using sed-style expressions. +##### RhymeZone +- Fetches rhymes from http://rhymezone.com/. + ##### SupyMisc - Some assorted commands that don't seem to fit anywhere else. diff --git a/RhymeZone/README.md b/RhymeZone/README.md new file mode 100644 index 0000000..e32aa72 --- /dev/null +++ b/RhymeZone/README.md @@ -0,0 +1 @@ +Fetches rhymes from http://rhymezone.com/. diff --git a/RhymeZone/__init__.py b/RhymeZone/__init__.py new file mode 100644 index 0000000..4a4d33f --- /dev/null +++ b/RhymeZone/__init__.py @@ -0,0 +1,68 @@ +### +# Copyright (c) 2015, James Lu +# All rights reserved. +# +# Redistribution and use in source and binary forms, with or without +# modification, are permitted provided that the following conditions are met: +# +# * Redistributions of source code must retain the above copyright notice, +# this list of conditions, and the following disclaimer. +# * Redistributions in binary form must reproduce the above copyright notice, +# this list of conditions, and the following disclaimer in the +# documentation and/or other materials provided with the distribution. +# * Neither the name of the author of this software nor the name of +# contributors to this software may be used to endorse or promote products +# derived from this software without specific prior written consent. +# +# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" +# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE +# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE +# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR +# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF +# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS +# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN +# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) +# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE +# POSSIBILITY OF SUCH DAMAGE. + +### + +""" +RhymeZone: Fetches rhymes from http://rhymezone.com/. +""" + +import supybot +import supybot.world as world + +# Use this for the version of this plugin. You may wish to put a CVS keyword +# in here if you're keeping the plugin in CVS or some similar system. +__version__ = "" + +# XXX Replace this with an appropriate author or supybot.Author instance. +__author__ = supybot.authors.unknown + +# This is a dictionary mapping supybot.Author instances to lists of +# contributions. +__contributors__ = {} + +# This is a url where the most recent plugin package can be downloaded. +__url__ = '' + +from . import config +from . import plugin +from imp import reload +# In case we're being reloaded. +reload(config) +reload(plugin) +# Add more reloads here if you add third-party modules and want them to be +# reloaded when this plugin is reloaded. Don't forget to import them as well! + +if world.testing: + from . import test + +Class = plugin.Class +configure = config.configure + + +# vim:set shiftwidth=4 tabstop=4 expandtab textwidth=79: diff --git a/RhymeZone/config.py b/RhymeZone/config.py new file mode 100644 index 0000000..95bcf25 --- /dev/null +++ b/RhymeZone/config.py @@ -0,0 +1,57 @@ +### +# Copyright (c) 2015, James Lu +# All rights reserved. +# +# Redistribution and use in source and binary forms, with or without +# modification, are permitted provided that the following conditions are met: +# +# * Redistributions of source code must retain the above copyright notice, +# this list of conditions, and the following disclaimer. +# * Redistributions in binary form must reproduce the above copyright notice, +# this list of conditions, and the following disclaimer in the +# documentation and/or other materials provided with the distribution. +# * Neither the name of the author of this software nor the name of +# contributors to this software may be used to endorse or promote products +# derived from this software without specific prior written consent. +# +# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" +# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE +# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE +# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR +# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF +# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS +# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN +# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) +# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE +# POSSIBILITY OF SUCH DAMAGE. + +### + +import supybot.conf as conf +import supybot.registry as registry +try: + from supybot.i18n import PluginInternationalization + _ = PluginInternationalization('RhymeZone') +except: + # Placeholder that allows to run the plugin on a bot + # without the i18n module + _ = lambda x: x + + +def configure(advanced): + # This will be called by supybot to configure this module. advanced is + # a bool that specifies whether the user identified themself as an advanced + # user or not. You should effect your configuration by manipulating the + # registry as appropriate. + from supybot.questions import expect, anything, something, yn + conf.registerPlugin('RhymeZone', True) + + +RhymeZone = conf.registerPlugin('RhymeZone') +# This is where your configuration variables (if any) should go. For example: +# conf.registerGlobalValue(RhymeZone, 'someConfigVariableName', +# registry.Boolean(False, _("""Help for someConfigVariableName."""))) + + +# vim:set shiftwidth=4 tabstop=4 expandtab textwidth=79: diff --git a/RhymeZone/local/__init__.py b/RhymeZone/local/__init__.py new file mode 100644 index 0000000..e86e97b --- /dev/null +++ b/RhymeZone/local/__init__.py @@ -0,0 +1 @@ +# Stub so local is a module, used for third-party modules diff --git a/RhymeZone/plugin.py b/RhymeZone/plugin.py new file mode 100644 index 0000000..c087879 --- /dev/null +++ b/RhymeZone/plugin.py @@ -0,0 +1,107 @@ +### +# Copyright (c) 2015, James Lu +# All rights reserved. +# +# Redistribution and use in source and binary forms, with or without +# modification, are permitted provided that the following conditions are met: +# +# * Redistributions of source code must retain the above copyright notice, +# this list of conditions, and the following disclaimer. +# * Redistributions in binary form must reproduce the above copyright notice, +# this list of conditions, and the following disclaimer in the +# documentation and/or other materials provided with the distribution. +# * Neither the name of the author of this software nor the name of +# contributors to this software may be used to endorse or promote products +# derived from this software without specific prior written consent. +# +# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" +# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE +# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE +# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR +# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF +# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS +# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN +# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) +# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE +# POSSIBILITY OF SUCH DAMAGE. + +### + +import supybot.utils as utils +from supybot.commands import * +import supybot.plugins as plugins +import supybot.ircutils as ircutils +import supybot.callbacks as callbacks +try: + from supybot.i18n import PluginInternationalization + _ = PluginInternationalization('RhymeZone') +except ImportError: + # Placeholder that allows to run the plugin on a bot + # without the i18n module + _ = lambda x: x + +try: + from bs4 import BeautifulSoup +except ImportError: + raise ImportError("Beautiful Soup 4 is required for this plugin: " + "http://www.crummy.com/software/BeautifulSoup/bs4/" + "doc/#installing-beautiful-soup") + +class RhymeZone(callbacks.Plugin): + """Fetches rhymes from http://rhymezone.com/.""" + threaded = True + + @wrap(['text']) + def rhymes(self, irc, msg, args, word): + """ + + Looks up rhymes for the word/phrase given on rhymezone.com. + """ + url = 'http://www.rhymezone.com/r/rhyme.cgi?typeofrhyme=perfect&%s' % utils.web.urlencode({'Word': word}) + data = utils.web.getUrl(url) + soup = BeautifulSoup(data) + + results = [] + + try: + for tag in soup.find("div", {"id": "snippets_top"}).next_siblings: + if tag.name == 'a': # It's a rhyme result! + # Get rid of non-breaking spaces in IRC output + result = tag.text.replace('\xa0', ' ').strip() + + # Each page ends with a bunch of links, such as one to a + # "words ending with xyz" page. Once we get here, there are no + # results left, and we can break. + if result.startswith('words ending with'): + break + + results.append(result) + + elif tag.name == 'center': # These are usually used for headings + + # Get the heading text, cut at the first newline + text = tag.text.split('\n')[0] + + # The dagger is used for a footnote about near-rhymes and how + # they work; we don't need this. + text = text.replace(' †', '').strip() + + if text: # Ignore empty content + # Add the results for this type to replies + results.append(ircutils.bold(text)) + + except AttributeError: + irc.error("Word or phrase not found.") + + else: + # Join, tweak the formatting, and reply + s = ', '.join(results) + s = s.replace(':\x02,', ':\x02') + s = s.replace(':\x02 \x02', ':\x02 (none), \x02') + irc.reply(s) + +Class = RhymeZone + + +# vim:set shiftwidth=4 softtabstop=4 expandtab textwidth=79: diff --git a/RhymeZone/test.py b/RhymeZone/test.py new file mode 100644 index 0000000..c82c428 --- /dev/null +++ b/RhymeZone/test.py @@ -0,0 +1,41 @@ +### +# Copyright (c) 2015, James Lu +# All rights reserved. +# +# Redistribution and use in source and binary forms, with or without +# modification, are permitted provided that the following conditions are met: +# +# * Redistributions of source code must retain the above copyright notice, +# this list of conditions, and the following disclaimer. +# * Redistributions in binary form must reproduce the above copyright notice, +# this list of conditions, and the following disclaimer in the +# documentation and/or other materials provided with the distribution. +# * Neither the name of the author of this software nor the name of +# contributors to this software may be used to endorse or promote products +# derived from this software without specific prior written consent. +# +# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" +# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE +# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE +# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR +# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF +# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS +# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN +# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) +# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE +# POSSIBILITY OF SUCH DAMAGE. + +### + +from supybot.test import * +import unittest + +class RhymeZoneTestCase(PluginTestCase): + plugins = ('RhymeZone',) + + @unittest.skipUnless(network, 'Network-based tests have been disabled via --no-network.') + def testRhymes(self): + self.assertNotError('rhymes cat') + +# vim:set shiftwidth=4 tabstop=4 expandtab textwidth=79: