em-irc-bot 0.1.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e78c1ab5d757c56c181033211f06be8150b75592
-  data.tar.gz: 4efaea1d51c1c9c891cc4dac2a42a32e14261c1c
+  metadata.gz: a268a89c7bd0bab9f524ff94d7079a0e84b5e884
+  data.tar.gz: 15f98e9245cc3710db11bd557fd91d2ced75dc88
 SHA512:
-  metadata.gz: 25f6c3a59befbd5183d8005289a91ffdab33e7c2b218271b3f1396099dc4db86f4b7e086cbb8df4abeef6b9b76b7a1958b92695f4050394094179fa2aaaf6017
-  data.tar.gz: f049ba6506e2def21de565a2bbe9db2d8e6db5e0c602a7b8a90e1b5bf6f10cff249272804dff08bae4777ba1dc8803afbdc34d3446a4f40f9d12d6b973e1062e
+  metadata.gz: f14695cda664f52416611c1522bce4010d26d564401a4ae831dad2e51fe77ac7379363a2efbd01864a1684f0287273e0ef1638ee62bcbcb4c462ce94d99cd4e3
+  data.tar.gz: 1151587b6f8460427339f7561a14a5fd36542823ed6780c193bb1db37f51f8d781cb1d11336f9bb25d0181e91084a470b6c971e879f9401f04e4d8e1836ba368

data/lib/em/irc_bot.rb

@@ -18,6 +18,12 @@ require 'logger'
 # regular expression.  That's... pretty much it.  The rest is up to you.
 # 
 class EM::IrcBot
+	# This bot's nick.
+	#
+	# @return [String]
+	#
+	attr_reader :nick
+
 	# Create a new IRC bot.
 	#
 	# If you want to have the bot connect to the server immediately upon
@@ -62,12 +68,16 @@ class EM::IrcBot
 	#   specified, a default logger will be setup to send only fatal errors
 	#   to `$stderr`.
 	#
+	# @option opts [String] :command_prefix The string which must precede
+	#   any commands sent to the bot in-channel.  The default is `"!"`.
+	#
 	def initialize(nick, opts = {})
 		@nick             = nick
 		@ready            = false
 		@backlog          = ""
 		@line_handlers    = {}
 		@privmsg_handlers = {}
+		@commands         = {}
 
 		@serverpass = opts[:serverpass]
 		@username   = opts[:username] || "em-irc-bot"
@@ -77,6 +87,7 @@ class EM::IrcBot
 		                                   l.level = Logger::FATAL
 		                                   l.formatter = proc { |s, dt, p, m| "#{m}\n" }
 		                                 end
+		@cmd_prefix = opts[:command_prefix] || "!"
 
 		if opts[:server] and opts[:port]
 			connect(opts[:server], opts[:port], opts[:tls])
@@ -87,6 +98,8 @@ class EM::IrcBot
 		end
 
 		on(/^:[^\s]+ PRIVMSG /, &method(:do_privmsg))
+
+		listen_for(/./, &method(:command_handler))
 	end
 
 	# Connect to an IRC server.
@@ -122,6 +135,38 @@ class EM::IrcBot
 		send_line("JOIN #{ch}")
 	end
 
+	# Register a callback to be executed on a given command.
+	#
+	# A command is anything said in-channel which is prefixed by the
+	# `:command_prefix` option passed to the bot's constructor (`"!"` by
+	# default), or anything at all said to the bot privately.
+	#
+	# Only one callback can be registered for a given command.  If you
+	# register for the same command twice, only the last callback will be
+	# activated.
+	#
+	# @param cmd [String] The command to call back for.  It must have
+	#   no whitespace.
+	#
+	# @param blk [Proc] The callback.
+	#
+	# @yieldparam [EM::IrcBot::Message] The full message that was received.
+	#   This is given so you can reply through it
+	#
+	# @yieldparam [String] The command itself.  Just in case you have multiple
+	#   commands pointing to the same block, so you can differentiate between
+	#   them.
+	#
+	# @yieldparam [Array<String>] The remaining arguments that were passed to
+	#   the command.  All command arguments are strictly whitespace-separated.
+	#   There is no way to pass an argument containing whitespace.
+	#
+	# @return void
+	#
+	def command(cmd, &blk)
+		@commands[cmd] = blk
+	end
+
 	# Register a new callback for a PRIVMSG seen by the bot.
 	#
 	# The fundamental way of causing the bot to interact with its environment
@@ -308,11 +353,11 @@ class EM::IrcBot
 			      "do_privmsg got line that wasn't a PRIVMSG: #{l.inspect}"
 		end
 
-		source = $2
-		sender = $1
+		channel = ($2 == nick) ? $1 : $2
+		sender  = $1
 		message = $3
 
-		msg = EM::IrcBot::Message.new(self, source, sender, message)
+		msg = EM::IrcBot::Message.new(self, channel, sender, message)
 
 		@privmsg_handlers.each_pair do |re, blk|
 			if (matchdata = message.match(re))
@@ -320,6 +365,17 @@ class EM::IrcBot
 			end
 		end
 	end
+
+	def command_handler(msg)
+		if msg.private? or msg.line.index(@cmd_prefix) == 0
+			cmdline = msg.line.gsub(/^#{@cmd_prefix}/, '').split(/\s+/)
+			if @commands[cmdline[0]]
+				@commands[cmdline[0]].call(msg, cmdline[0], cmdline[1..-1])
+			else
+				msg.reply "I don't understand that."
+			end
+		end
+	end
 end
 
 require_relative "irc_bot/conn_handler"

data/lib/em/irc_bot/message.rb

@@ -17,15 +17,16 @@ class EM::IrcBot::Message
 	#
 	attr_reader :bot
 
-	# The nick or channel which originated the message.
+	# The public channel, or nick, which originated the message.  This is the
+	# place which replies will be sent to by {#reply}.
 	#
 	# @return [String]
 	#
-	attr_reader :source
+	attr_reader :channel
 
-	# The nick which sent the message.  For private messages, this will
-	# be the same as {#source}, but for messages in-channel, this will be
-	# the nick which sent the message, while {#source} is the channel.
+	# The nick which sent the message.  For private messages, this will be
+	# the same as {#channel}, but for messages in-channel, this will be the
+	# nick which sent the message, while {#channel} is, well, the channel.
 	#
 	# @return [String]
 	#
@@ -39,23 +40,33 @@ class EM::IrcBot::Message
 
 	#:nodoc:
 	#
-	def initialize(bot, source, sender, line)
-		@bot    = bot
-		@source = source
-		@sender = sender
-		@line   = line
+	def initialize(bot, channel, sender, line)
+		@bot     = bot
+		@channel = channel
+		@sender  = sender
+		@line    = line
 	end
 
-	# Send a line of text back to the source of the message.
+	# Send a line of text back to the channel which originated the message.
 	#
-	# This is only a reply to the *source*; it doesn't modify your message at
-	# all to, say, prepend the nick of the sender.  That bit's up to you.
+	# This is only a reply to the *source channel*; it doesn't modify your
+	# message at all to, say, prepend the nick of the sender.  That bit's up
+	# to you.
 	#
 	# @param s [String] The message to send.
 	#
 	# @return void
 	#
 	def reply(s)
-		bot.say(source, s)
+		bot.say(channel, s)
+	end
+
+	# Whether or not this message was sent directly to the bot, or came to us
+	# via a channel.
+	#
+	# @return [Boolean]
+	#
+	def private?
+		channel == sender
 	end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: em-irc-bot
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Matt Palmer