From f1c15527a5e5cc97a2a0d1b7935b4450e15ebc70 Mon Sep 17 00:00:00 2001 From: Valentin Lorentz Date: Tue, 1 Jan 2013 23:55:21 +0100 Subject: [PATCH] Pinglist: First commit. --- Pinglist/README.txt | 1 + Pinglist/__init__.py | 66 +++++++++++++++++++++++ Pinglist/config.py | 52 ++++++++++++++++++ Pinglist/local/__init__.py | 1 + Pinglist/plugin.py | 108 +++++++++++++++++++++++++++++++++++++ Pinglist/test.py | 62 +++++++++++++++++++++ README.md | 5 ++ 7 files changed, 295 insertions(+) create mode 100644 Pinglist/README.txt create mode 100644 Pinglist/__init__.py create mode 100644 Pinglist/config.py create mode 100644 Pinglist/local/__init__.py create mode 100644 Pinglist/plugin.py create mode 100644 Pinglist/test.py diff --git a/Pinglist/README.txt b/Pinglist/README.txt new file mode 100644 index 0000000..d60b47a --- /dev/null +++ b/Pinglist/README.txt @@ -0,0 +1 @@ +Insert a description of your plugin here, with any notes, etc. about using it. diff --git a/Pinglist/__init__.py b/Pinglist/__init__.py new file mode 100644 index 0000000..ee87b11 --- /dev/null +++ b/Pinglist/__init__.py @@ -0,0 +1,66 @@ +### +# Copyright (c) 2013, Valentin Lorentz +# 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. + +### + +""" +Add a description of the plugin (to be presented to the user inside the wizard) +here. This should describe *what* the plugin does. +""" + +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__ = '' # 'http://supybot.com/Members/yourname/Pinglist/download' + +import config +import plugin +reload(plugin) # In case we're being reloaded. +# 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: + import test + +Class = plugin.Class +configure = config.configure + + +# vim:set shiftwidth=4 tabstop=4 expandtab textwidth=79: diff --git a/Pinglist/config.py b/Pinglist/config.py new file mode 100644 index 0000000..687ac9f --- /dev/null +++ b/Pinglist/config.py @@ -0,0 +1,52 @@ +### +# Copyright (c) 2013, Valentin Lorentz +# 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 +from supybot.i18n import PluginInternationalization, internationalizeDocstring + +_ = PluginInternationalization('Pinglist') + +def configure(advanced): + # This will be called by supybot to configure this module. advanced is + # a bool that specifies whether the user identified himself 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('Pinglist', True) + + +Pinglist = conf.registerPlugin('Pinglist') +# This is where your configuration variables (if any) should go. For example: +# conf.registerGlobalValue(Pinglist, 'someConfigVariableName', +# registry.Boolean(False, _("""Help for someConfigVariableName."""))) + + +# vim:set shiftwidth=4 tabstop=4 expandtab textwidth=79: diff --git a/Pinglist/local/__init__.py b/Pinglist/local/__init__.py new file mode 100644 index 0000000..e86e97b --- /dev/null +++ b/Pinglist/local/__init__.py @@ -0,0 +1 @@ +# Stub so local is a module, used for third-party modules diff --git a/Pinglist/plugin.py b/Pinglist/plugin.py new file mode 100644 index 0000000..4e120e3 --- /dev/null +++ b/Pinglist/plugin.py @@ -0,0 +1,108 @@ +### +# Copyright (c) 2013, Valentin Lorentz +# 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 +from supybot.i18n import PluginInternationalization, internationalizeDocstring + +_ = PluginInternationalization('Pinglist') + +@internationalizeDocstring +class Pinglist(callbacks.Plugin): + """Add the help for "@plugin help Pinglist" here + This should describe *how* to use this plugin.""" + + def __init__(self, irc): + super(Pinglist, self).__init__(irc) + self._subscriptions = ircutils.IrcDict() + + @internationalizeDocstring + def pingall(self, irc, msg, args, channel, meeting): + """[] + + Ping all participants of the . + defaults to the current channel.""" + try: + subscribers = self._subscriptions[channel][meeting] + except KeyError: + irc.error(_('No such meeting.'), Raise=True) + if subscribers: + irc.reply(format(_('Ping %L'), list(subscribers))) + else: + # Should not happen + irc.error(_('No subscribers.')) + pingall = wrap(pingall, ['channel', 'something']) + + @internationalizeDocstring + def subscribe(self, irc, msg, args, channel, meeting): + """[] + + Subscribe to the . + defaults to the current channel.""" + if channel not in self._subscriptions: + self._subscriptions[channel] = ircutils.IrcDict() + if meeting not in self._subscriptions[channel]: + self._subscriptions[channel][meeting] = ircutils.IrcSet() + self._subscriptions[channel][meeting].add(msg.nick) + irc.replySuccess() + subscribe = wrap(subscribe, ['channel', 'something']) + + @internationalizeDocstring + def unsubscribe(self, irc, msg, args, channel, meeting): + """[] + + Unsubscribe from the . + defaults to the current channel.""" + if channel not in self._subscriptions: + irc.error(_('No such meeting.')) + if meeting not in self._subscriptions[channel]: + irc.error(_('No such meeting.')) + try: + self._subscriptions[channel][meeting].remove(msg.nick) + except KeyError: + irc.error(_('You did not subscribe.'), Raise=True) + if not self._subscriptions[channel][meeting]: + del self._subscriptions[channel][meeting] + if not self._subscriptions[channel]: + del self._subscriptions[channel] + irc.replySuccess() + unsubscribe = wrap(unsubscribe, ['channel', 'something']) + + + + + +Class = Pinglist + + +# vim:set shiftwidth=4 softtabstop=4 expandtab textwidth=79: diff --git a/Pinglist/test.py b/Pinglist/test.py new file mode 100644 index 0000000..d4eefdc --- /dev/null +++ b/Pinglist/test.py @@ -0,0 +1,62 @@ +### +# Copyright (c) 2013, Valentin Lorentz +# 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 * + +prefixes = {'foo': 'foo!bar@baz', + 'qux': 'qux!quux@corge', + 'spam': 'spam!egg@test', + 'su': 'su!py@bot'} + +class PinglistTestCase(ChannelPluginTestCase): + plugins = ('Pinglist',) + + def testPing(self): + self.prefix = prefixes['foo'] + self.assertResponse('pingall testing', 'Error: No such meeting.') + self.assertNotError('subscribe testing') + self.assertResponse('pingall testing', 'Ping foo') + + self.prefix = prefixes['qux'] + self.assertResponse('pingall testing', 'Ping foo') + self.assertNotError('subscribe testing') + self.assertRegexp('pingall testing', 'Ping (foo and qux|qux and foo)') + self.assertResponse('pingall "something else"', 'Error: No such meeting.') + self.assertNotError('subscribe "something else"') + self.assertResponse('pingall "something else"', 'Ping qux') + self.assertRegexp('pingall testing', 'Ping (foo and qux|qux and foo)') + self.assertNotError('unsubscribe testing') + self.assertResponse('pingall testing', 'Ping foo') + self.assertResponse('unsubscribe testing', 'Error: You did not subscribe.') + self.assertResponse('unsubscribe supybot', 'Error: No such meeting.') + + + +# vim:set shiftwidth=4 tabstop=4 expandtab textwidth=79: diff --git a/README.md b/README.md index 5c9bcef..fe60c25 100644 --- a/README.md +++ b/README.md @@ -57,6 +57,11 @@ List empty channels (or with few people) the bot is on. Run a telnet server and announce messages to a channel. +##Pinglist + +Keeps a list of people attending a meeting/game, and provides a `pingall` +command to ping them all. + ##Seeks Plugin for the Seeks search engine.