shaunagm / welcomebot Goto Github PK

Would you mind adding a license to the welcome-bot? Thanks!

When the bot is queried the URL shown has an extra > at the end, resulting in a 404 page

Because readability is more important than saving a little bit of space!

Rules for keyword arguments are here.

As a follow up to this issue I think it would be great if our regexes were a bit more flexible. For instance, the common "WelcomeBot: hi" does not trigger a response - the greeting needs to come before the name. I think we should at least make sure any order is recognized.

The rules to remember slightly different names (see https://github.com/shaunagm/WelcomeBot/pull/29/files) are great but we need an exception for openhatch_####. These are folks coming in via freenode webchat and are actually the people who most need WelcomeBot.

When users who have registered their nicknames join IRC without identifying, different IRC clients will change their nickname in different ways.

For instance, the default behavior in quassel is to add a trailing underscore (or two, or three) if you haven't identified to your nick. The bot currently catches this (https://github.com/shaunagm/oh-irc-bot/blob/master/bot.py#L113) but if we can determine the rules for other popular clients we can catch those as well.

To improve the bot, please:

1. Research an IRC client (ideally starting with the most popular ones) and determine the default for un-identified nicks.

AND/OR

You can look through the stored nicks for patterns.

2. Add to bot.py, in the function clean_nick(), appropriate rules to deal with that behavior.

Update: The bot now deals with trailing underscores, trailing numbers, and things with a pipe. Is there anything we're missing? The main one I see when browsing through the nicks is something like: name[Mobile]

1. help WelcomeBot
   Works
2. help WelcomeBot
   dose not.

Note that there are multiple spaces in second example.
same for hello/hi etc.

how can i host this on heroku

There are lots of Python constants that could be moved into a configuration file instead of being hardcoded. This would make configuring a non-OpenHatch bot easier, and allow staying up to date with changes to WelcomeBot without having to merge.

/query WelcomeBot faq WelcomeBot

will trigger in #openhatch.

See:

20:05 < paultag> ok, bug report time:
20:06 < WelcomeBot> I'm a bot!  I'm from here 
                    <https://github.com/shaunagm/oh-irc-bot>.  You can 
                    change my behavior by submitting a pull request or 
                    by talking to shauna.

It's good practice to use a configuration format for pulling in configurable options. This Issue is to suggest using PyYAML to achieve this. See http://pyyaml.org/

I'd like to run WelcomeBot in a channel I moderate, but I haven't run an IRC bot before, and I'm not sure how to set up a bot to run indefinitely/permanently. I'd like to see a bit of explanation for recommended ways to do this.

For example, my friend suggested that I could run it inside a screen session on the tiny server that I use for running irssi inside screen; I haven't tried setting this up yet though.

Right now the WelcomeBot stops running at seemingly random times and sits there, quietly, until someone notices and reminds me to log into the server and restart it. It would be nice if I got an email notification or something similar when WelcomeBot stopped running.

We should enable Travis CI [1] to run automated tests to validate pull requests. Before this can happen we should:

• Enable tox for running pep8 and unittest suite see #55
• pep8 voliations should be resolved
• tox can run cleanly against master

[1] https://travis-ci.org/

Branched from a previous issue: #10

Every couple of weeks, WelcomeBot goes offline. The error messages all seem to look like this:
File "data/bot.py", line 98, in
actor = ircmsg.split(":")[1].split("!")[0]
IndexError: list index out of range

The input that appears to have caused this looks something like this:

ERROR :Closing Link: 87.98.215.226 (Ping timeout: 265 seconds)

It's not clear to me what's causing the index out of range. Split returns a list of size 1 or greater (I believe) so doing split("!")[0] should be fine, even if there's no ! in the string (as appears to be the case above). And the input above does have several ":" so the [1] shouldn't be out of range either. Maybe this is the wrong input somehow?

If we can't figure out how in particular this is being broken, we can perhaps still solve it by inserting a try:except statement around line 98. I don't think that we actually need to address whatever this rare, break-ing message is - we can just insert some nonsense that doesn't match any of the .find()s in the rest of the loop.

This is slightly advanced testing bizness. Basically, right now the testing suite is testing the time-sensitive aspects of the welcomebot code by using .sleep(), but @nedbat points out that a more robust way to do this is to make a mock time (like we do with the ircsock object). If anyone wants to pair with me on this, let me know!

e.g _foo_ is saved as foo

Right now we import the welcome message from a settings file and attach it to an instantiated bot, but with this method we can't dynamically include the username with the message. My guess is that the best way to fix this is to have welcome_message be a method on the bot which takes a username.

Whenever WelcomeBot joins a room, it says "[greeting] [server] NOTICE *", for instance:
"hey hobana.freenode.net NOTICE *"

It should probably not do that.

The bot currently imports queue, which is no longer used. It should be removed!

While they're at it, whoever fixes this issue should make sure that the other import statements are being used. You can do this by searching for references to the library in the program.

This error.log was mistakenly included in the repo. Can someone get rid of it?

Currently the bot welcomes people who enter and then leave before the 60 second countdown ends.

It's obvious we shouldn't welcome someone who has left. The question is whether they should get their nicknamed stored. Thoughts?

I'm getting this error message when running the bot on my server. https://pastebin.mozilla.org/5601652

it works fine when I run it in freenode, but on the mozilla server it doesn't seem to want to run.

Before a contributor can run unit tests it is assumed that the user has a created a nicks.csv file in their WelcomeBot directory. Proper unit tests should create required files in the setUp() function and remove them during tearDown().

Traceback (most recent call last):
  File "test_bot.py", line 41, in setUp
    self.bot = botcode.Bot()
  File "bot.py", line 25, in __init__
    with open(self.nick_source, 'rb') as csv_file:
IOError: [Errno 2] No such file or directory: 'nicks.csv'

"though" should be "thought"

If someone joins the channel and then changes their name before the minute of silence is up the bot will use the original name to greet them.

Example of the issue is at: http://bpaste.net/show/222579/

Just observed this happening:

[14:10:42] -- jerrychen (~jerrychen@$place) has joined #openhatch
[14:11:00] jerrychen: Hello
[14:11:58] -- jerrychen (~jerrychen@$place) has left #openhatch
[14:12:11] -- jerrychen (~jerrychen@$place) has joined #openhatch
[14:14:26] shauna: hi jerrychen
[14:17:12] WelcomeBot: Welcome jerrychen!  The channel is pretty quiet right now, so I thought I'd say hello, and ping some people (like shauna, paulproteus, and marktraceur) that you're here.  If no one responds for a while, try emailing us at [email protected] or just try coming back later.  FYI, you're now on my list of known nicknames, so I won't bother you again.

Initial thoughts: when someone quits before being welcomed, they should be treated as new when they return. Maybe somethings going wrong with that part of the program and the old newcomer object is not being removed?

This bug should probably be reproduced before we go further.

The bot program as currently designed does not run in python 3, only python 2. I don't know how to make it able to function in python 3, but it would probably be good if someone updated it to function with newer versions.

Probably a good start is to just list the things we want to test. This could go in the readme for manual testing. At some point it would be nice to set up automated testing, too.

WelcomeBot currently has very primitive regexes that tell it when to reply to a greeting or request for information (https://github.com/shaunagm/oh-irc-bot/blob/master/bot.py#L120).

For instance, it looks for any of the items in helpArray anywhere in each message, along with its name. So "I think WelcomeBot should stop talking" triggers a greeting, because it contains "hi" and the bot's name.

It seems likely that we could use regular expressions to improve upon this. Another option would be to generate phrases such as helloArray[i] + " " + botnick.

Four tests (test_sent_messages, test_hello, test_help, & test_welcome_nick) currently fail and two tests (test_wait_time_from_non_admin and test_wait_time_from_admin) give errors because certain variables are hard-coded into the tests. We need to replace these with references to the variables themselves.

For example, in test_sent_messages (test_bot.py line 105) you can see that the list of strings Expected hard-codes the bot nickname of WelcomeBot2 and the channel openhatch-bots.

To fix this, we need to pass the variables used in bot.py (should be doable by passing botcode.channel, botcode.botnick, etc) and incorporate them into the test strings using the formatting described here and seen, for example, here.

At issue are, I think: channel, the bot's nick, and the number of admins allowed (the suite currently hard-codes for a single admin).

Right now there are few comments in test_bot.py, and the README only covers how to run the test suite, not how to understand it nor how to write your own.

During events, WelcomeBot ends up responding a lot to newcomers, who don't really need the info (as they're at our events). It would be nice to be able to suspend the bot (or alter the delay to 5 min or something, instead of 60 seconds) without having to log into the server and make changes.

Two instances:

http://irclogs.jackgrigg.com/irc.freenode.net/openhatch/2015-04-11#i_3612706
http://irclogs.jackgrigg.com/irc.freenode.net/openhatch/2015-04-13#i_3613671

Does the database reset sometimes? I've accessed the openhatch IRC in the meantime and didn't get welcomed then.

The files test_nicks.csv and nicks.csv are overwritten during test execution. Proper unittests should not modify the user's environment. Would recommend using something like tempfile [1] to create temporary files for testing.

Steps to reproduce:

1. touch nicks.csv
2. modify test_nicks.csv
3. python -m unittest test_bot
4. test_nicks.csv and nicks.csv is overwritten with test data

[1] https://docs.python.org/2/library/tempfile.html

Let's check with NickServ to see if the nick that joined and isn't recognized is maybe an account we recognize.

This would save people like paulproteus from being greeted when he joins as paulprot1us etc.

May need to populate this (slowly) by running through the database and sorting out if any of the saved nicks are associated with accounts.

In order to implement this, we'll probably need to add:

• a variable or flag in the code that indicates whether or not the bot should try to identify
• a function that sends a message to the network identifying using this syntax

To keep the password private, you'll probably want the password to be read in from a separate file, for example "bot_password.txt", that is outside the repository or is gitignored.

I would like WelcomeBot to be useful as an example of implementing different tools and concepts. To that end, let's expand the documentation to explain:

• How we do testing, and how we use python's unittests
• How regular expressions work, and how we use python's regex functions
• How IRC works, and how we use python's socket and select libraries