Building Social IDC Bots with Node.js and MongoDB

3/11/13 reveal.js - The HTML Presentation Framework

ryanjarvinen.com/presentations/irc/#/ 1/72

SOCIAL IRC BOTS IN THE CLOUD

with

node.js

and

MongoDB

http://bit.ly/11Qft8j

http://bit.ly/11Qft8j



presented by

/ ryan jarvinen @ryanj

http://ryanjarvinen.com/

http://twitter.com/ryanj/



Open Platform Evangelistat

Red Hat

[email protected]



AGENDALearn some IRC basicsCreate a bot and teach it to speakLearn some MongoDB basicsBuild a social leaderboardGo live with a Mongo-powered IRC bot in ~30 mins



CODE DU JOURhttps://github.com/openshift-quickstart/irc-

leaderboard-quickstart

https://github.com/openshift-quickstart/irc-leaderboard-quickstart



IRCis

just

multiplayer notepad



“Hello, nice to troll you!”

http://www.zazzle.com/irc_is_just_multiplayer_notepad_tees-235837046911006156



IRCis

just multiplayer notepada drama club for nerds



ACTING / EMOTING“ An emote is an entry into a text-based

chat client that indicates an action takingplace. Unlike emoticons, they are not textart, and instead describe the action using

words.”http://en.wikipedia.org/wiki/Emote

http://en.wikipedia.org/wiki/Emote



REAL DRAMAThe Hamnet Players

http://www.hambule.co.uk/hamnet/

The Plaintext Playershttp://yin.arts.uci.edu/~players/

http://www.hambule.co.uk/hamnet/

http://yin.arts.uci.edu/~players/



THE CYPOSIUM?

http://www.cyposium.net/

http://www.cyposium.net/



MAKING A BIGENTRANCE

To perform an action,

type '/me' followed by a description of an action:

/me rolls eyes at IRC over-actors



IRC BOTS



IRC BOTS AREtalking applicationsscripted actors who appear to be another user in theroomgenerally benevolent (they fight for the users)



IRC BOT ABILITIESmost bots know a few simple jokesmany know how to assist with bug reportsthey may offer links to relevant informationor even fight against spam



IRC ISjust multiplayer notepaddrama club for nerds✓an open protocol for realtime mutiuser communicationvia text ( )✓found at the heart of every high-tech company that I'veworked for✓a serious contender for "most valuable communicationtool" in many organizations✓realtime communication✓

rfc1459

http://www.ietf.org/rfc/rfc1459.txt



IRC IS

OPEN



OPEN CLIENTS

XCHAT, COLLOQUY



WEB CLIENTSGive it a try:

http://webchat.freenode.net/




OPEN SERVERS

FREENODEOpenShift on

/join #openshift

freenode IRC

http://freenode.net/



HOSTING OPTIONS

DIY / ON PREMISEPUBLIC IRC(FREENODE)

CLOUD SERVERS



IRC is built on an open standard, allowing you to host it asa service (on your own hardware), or from within a

private network (for added security).

OpenShift was designed with many of the samecharacteristics in mind, minus the drama.



OPENSHIFT IS

OPEN



OPEN CLIENTINTERFACE

https://github.com/openshift/rhc

https://github.com/openshift/rhc



OPEN CARTRIDGEFORMAT





PAAS SOURCE

OPENSHIFT ORIGIN





OPENSHIFT HOSTING

DIY / ORIGINONLINE

ENTERPRISE



DEVELOPER PREVIEWSign up for an OpenShift Online account:

Free-as-in-beer (no cost)Free-as-in-freedom (open source)512 MB RAM / 1 GB storage per gear (3 free)Need more resources? (just ask!)REALLY a Developer Preview (GA this summer)

http://openshift.redhat.com/

https://openshift.redhat.com/app/account/new



THE CLOUD LANDSCAPE



OPENSHIFT IS...





THE BIG PICTURE





OPENSTACK

IS OPENand

FOCUSED ON IAAS



BUZZ WORDS

PUBLIC CLOUD +PRIVATE CLOUD =

HYBRID CLOUD



GETTING STARTED WITH OPENSHIFTPRE-REQUISITES:

ruby, rubygemsgit



INSTALLING THE 'RHC' CLIENT TOOLand

install

sudo gem install rhc

node.js

http://nodejs.org/



HELP WITH CLIENT TOOLSRHC client tool installation

Openshift Getting Started guide

https://openshift.redhat.com/community/get-started#cli

https://openshift.redhat.com/community/developers/get-started


https://openshift.redhat.com/community/developers/get-started



CONFIGURING YOUR DEV ENVIRONMENTWill automatically:

set your openshift email addressverify your ssh key configurationconfigure your application namespace

rhc setup



GEARING UP A NEW APP ON OPENSHIFTor

rhc app create APP_NAME APP_CARTRIDGE

rhc app create ircbot nodejs-0.6



Application Options------------------- Namespace: ryanj Cartridges: nodejs-0.6 Gear Size: default Scaling: no

Creating application 'ircbot' ... done

Waiting for your DNS name to be available ... done

Downloading the application Git repository ...Cloning into 'ircbot'...



ircbot @ http://ircbot-ryanj.rhcloud.com/ (uuid: 25918304bf8d406e89802a1e642063a0)--------------------------------------------------- Created: 10:23 PM Gear Size: small Git URL: ssh://[email protected]/~/git/ircbot.git/ SSH: [email protected]

nodejs-0.6 (Node.js 0.6) ------------------------

RESULT:Application ircbot was created.



SUCCESS!You now have a basic node.js app up an running on

OpenShift!

Your gear is now configured with:

it's own git repoit's own web serverssh accessloggingpublicly accessible DNS



BUILDING YOUR BOT cd ircbot



INSTALLING DEPENDENCIESUsing Node's :

Include the `-S` flag in order to save this dependency toyour application's `package.json` file.

npm package managernpm install irc -S

http://npmjs.org/package/irc/

https://npmjs.org/

http://npmjs.org/package/irc/



BOT BASICSAdd the following to your server.js to load and configure

the irc library:var irc = require('irc');var bot_name = process.env.OPENSHIFT_APP_NAME || 'ircbot';var bot = new irc.Client('chat.freenode.net', bot_name, { channels: ['#botzoo', '#botwar'], port: 8001, debug: true});



TEACHING YOUR BOT TO SPEAKListen and respond to conversations as they happen:bot.addListener('message', function(from, to, message) { if( message.indexOf('Know any good jokes?') > -1 || message.indexOf('good joke') > -1 ) { bot.say(to, 'Knock knock!'); }});



Getting to the punchline:bot.addListener('message', function(from, to, message) { if( message.indexOf('who is there?') > -1 || message.indexOf("who's there?") > -1 || message.indexOf("Who's there?") > -1 || message.indexOf("Who is there?") > -1 ) { bot.say(to, 'Doris'); }});bot.addListener('message', function(from, to, message) { if( message.indexOf('Doris who?') > -1 || message.indexOf("doris who?") > -1 ) { bot.say(to, "Doris locked, that's why I'm knocking!"); }});



COMMITTING YOUR CHANGESgit add package.json server.jsCommit your changes locally

git commit -m 'adding irc npm dependency, initializing irclibrary, adding a few jokes'



DEPLOYMENTDone! Your bot should now be live on IRC.

git push



INTERACTING WITH YOUR NEW BOTLogin to IRC, and enter one of the channels that your bot

has been configured to join:

If you don't already have an IRC client, you can connect tofreenode on the web:

/join #botzoo





Ask if anyone knows a good joke:[guest] Know any good jokes?[ircbot] Knock knock![guest] Who is there?[ircbot] Doris[guest] Doris who?[ircbot] Doris locked, that's why I'm knocking![guest] meh...



BOT DEBUGGING AND MAINTAINANCEIf your bot decides to quit mid-conversation, it may be

suffering from a bug.

Checking it's logs may reveal what set it off:

Or, debug it while running locally:

rhc tail ircbot

npm start



TEACHING YOUR BOT TOKEEP SCORE



SETTING UP MONGODB ON OPENSHIFTrhc cartridge add mongodb-2.2



Adding mongodb-2.2 to application 'ircbot' ... Success

mongodb-2.2 (MongoDB NoSQL Database 2.2)---------------------------------------- Connection URL: mongodb://127.6.102.129:27017/ Database Name: ircbot Password: T5xJwCiDZYGn Username: admin

RESULT:Added mongodb-2.2 to application ircbot



Adding mongodb-2.2 to application 'ircbot' ... Success

MongoDB 2.2 database added. Please make note of these credentials:

Root User: admin Root Password: T5xJwCiDZYGn Database Name: ircbot

Connection URL: mongodb://$OPENSHIFT_MONGODB_DB_HOST:$OPENSHIFT_MONGODB_DB_PORT/

You can manage your new MongoDB by also embedding rockmongo-1.1The rockmongo username and password will be the same as the MongoDB credentials above.



ROCKMONGO ON OPENSHIFT(optional)

rhc cartridge add rockmongo-1.1



ADDING A MONGOJS DEPENDENCYnpm install -S mongojs



CONNECTING TO MONGODBvar mongojs = require('mongojs');var connection_string = bot_name;if(process.env.OPENSHIFT_MONGODB_DB_PASSWORD){ connection_string = process.env.OPENSHIFT_MONGODB_DB_USERNAME + ":" + process.env.OPENSHIFT_MONGODB_DB_PASSWORD + "@" + process.env.OPENSHIFT_MONGODB_DB_HOST + '/' + process.env.OPENSHIFT_APP_NAME;}var db = mongojs(connection_string, ['scoreboard']);



SETTING A SCOREbot.addListener('message', function(from, to, message) { if( message.indexOf('++') > -1 ){ var subject = message.slice(0,message.indexOf('++')); db.scoreboard.find({query: {name: subject}}).limit(1, function(err, doc) { if( typeof(doc)=='object' && (doc instanceof Array) && doc[0] && doc[0].name){ // update db.scoreboard.update({name: subject}, {$inc:{score:1}}, function(err) { bot.say(to, "score: " + ( 1 + doc[0].score )); }); }else{ // insert db.scoreboard.insert({name: subject, score: 1}, function(err) { bot.say(to, "score: 1"); }); } }); }});



SHOWING THE SCOREBOARDbot.addListener('message', function(from, to, message) { if( message.indexOf('scoreboard') > -1 ){ db.scoreboard.find().sort({score:-1}).limit(10).forEach(function(err, doc){ if (doc && doc.name && doc.score ) { bot.say(to, doc.name + ": " + doc.score); } }); }});



UPDATING YOUR APPgit add package.json server.js

git commit -m 'adding a social scoreboard'

git push



SOCIAL REWARDS



ALLOCATING POINTSterm++

[raphael] Anyone down for pizza?[donatello] pizza++[ircbot] score: 43[raphael] Let's order two[leonardo] Good idea, Raph! raphael++[ircbot] score: 23



CHECKING THE SCOREBOARDircbot scoreboard

[ircbot] ircbot: 7[ircbot] ryanj: 4[ircbot] doris: -2



BOTS ON-DEMANDrhc app create ircbot nodejs-0.6 mongodb-2.2 --from-code=https://github.com/openshift-quickstart/irc-leaderboard-quickstart.git



You can find much more information about this npm IRClibrary here:

https://github.com/martynsmith/node-irc

https://github.com/martynsmith/node-irc



Thanks for following along! --ryanj



REFERENCES

Building social IRC Bots with Node.js (Part 1)Leaderboards for IRC - Social Node.js Bots (Part 2)RHC command-line installer helpWhy contact Freenode on port 8001?IRC - It's how hackers talk. Luckily, I speak "leet"node-ircRun any version of Node.js on OpenShift

https://openshift.redhat.com/community/blogs/building-social-irc-bots-with-nodejs

https://openshift.redhat.com/community/blogs/leaderboards-for-irc-social-nodejs-bots-part-2


https://openshift.redhat.com/community/content/open-irc-port-6667

http://www.youtube.com/watch?v=O2rGTXHvPCQ&t=18s

https://node-irc.readthedocs.org/en/latest/

https://openshift.redhat.com/community/blogs/any-version-of-nodejs-you-want-in-the-cloud-openshift-does-it-paas-style

Documents

Building Social IDC Bots with Node.js and MongoDB