net-yail 1.1.1 → 1.2.0

data/CHANGELOG

@@ -19,4 +19,18 @@
   system.
 * Net::YAIL now has handling for INVITE messages
 * Added fully working logger bot for a solid example
-* Since changes are more extensive then a minor release, bumping to 1.1.1
+* Since changes are more extensive than a minor release, bumping to 1.1.1
+
+2008-07-07:
+* The included logger example bot no longer crashes on incoming "private"
+  message
+* Logger example also has an example of using an outgoing handler to
+  centralize a list of channel passwords - all join messages get a password
+  tacked on if the central password list has one for the given channel
+* Obviously the above addition required support for joining password-protected
+  channels, so YAY!
+
+2008-07-17:
+* Fixed logger's handler to not call the channel logging code on private message
+* Figured it's about time for a new gem, 1.2.0.  Change to join handler breaks
+  existing code in a minor way - don't forget to fix your handlers!

data/examples/logger/default.yml

@@ -2,3 +2,5 @@ silent: false
 loud: false
 output-dir: /tmp/logs
 master: Nerdmaster
+passwords:
+  "#protected": "my_secret_password"

data/examples/logger/logger_bot.rb

@@ -18,6 +18,7 @@ class LoggerBot < IRCBot
   # * <tt>:silent</tt>: Very little logging
   # * <tt>:master</tt>: User who can order quits
   # * <tt>:output_dir</tt>: Where to store log files
+  # * <tt>:passwords</tt>: Hash of channel=>pass for joining channels
   def initialize(options = {})
     @master       = options.delete(:master)
     @output_dir   = options.delete(:output_dir) || File.dirname(__FILE__)
@@ -26,6 +27,7 @@ class LoggerBot < IRCBot
     # filenames on a per-channel basis
     @current_log  = {}
     @log_date     = {}
+    @passwords    = options[:passwords] || {}
 
     options[:username] = BOTNAME
     options[:realname] = BOTNAME
@@ -44,14 +46,19 @@ class LoggerBot < IRCBot
     @irc.prepend_handler(:incoming_act,             self.method(:_in_act))
     @irc.prepend_handler(:incoming_invite,          self.method(:_in_invited))
     @irc.prepend_handler(:incoming_kick,            self.method(:_in_kick))
+
+    @irc.prepend_handler(:outgoing_join,            self.method(:_out_join))
   end
 
   private
   # Incoming message handler
   def _in_msg(fullactor, user, channel, text)
     # check if this is a /msg command, or normal channel talk
-    incoming_private_message(user, text) if (channel =~ /#{bot_name}/)
-    incoming_channel_message(user, channel, text)
+    if channel =~ /#{bot_name}/
+      incoming_private_message(user, text)
+    else
+      incoming_channel_message(user, channel, text)
+    end
   end
 
   def _in_act(fullactor, user, channel, text)
@@ -61,12 +68,32 @@ class LoggerBot < IRCBot
   end
 
   # TODO: recalls the most recent logs for a given channel by reading from
-  # the file system or using a hash of log data.  Num maxes out at 100 for
-  # general sanity
+  # the file system or using a hash of log data.  Or both.
   def recent_logs(channel, num = 10)
     raise "Not implemented"
   end
 
+  # TODO: Searches logs for a given pattern.  Relies on the file system data
+  # to do a comprehensive search, and 'grep', so SANITIZE INPUT!
+  def search_logs(pattern)
+    raise "Not implemented"
+  end
+
+  # Gives the user very simplistic information.  TODO: Add a command for
+  # accessing and searching logs.
+  def incoming_private_message(user, text)
+    case text
+      when /\bhelp\b/i
+        msg(user, 'LoggerBot at your service - I log all messages and actions in any channel')
+        msg(user, 'I\'m in.  In the future I\'ll offer searchable logs.  If you /INVITE me to')
+        msg(user, 'a channel, I\'ll pop in and start logging.')
+        return
+    end
+
+    msg(user, "I don't log private messages.  If you'd like to know what I do, ")
+    msg(user, "enter \"HELP\"")
+  end
+
   def incoming_channel_message(user, channel, text)
     # check for special stuff before keywords
     # Nerdmaster is allowed to do special ordering
@@ -122,4 +149,10 @@ class LoggerBot < IRCBot
 
     return true
   end
+
+  # We're trying to join a channel - use key if we have one
+  def _out_join(target, pass)
+    key = @passwords[target]
+    pass.replace(key) unless key.to_s.empty?
+  end
 end

data/examples/logger/run.rb

@@ -9,6 +9,8 @@ require 'getopt/long'
 # If options are specified, they override the default yaml file.  If a
 # different yaml file is specified, its settings are read, then overridden
 # by options.
+#
+# Passwords hash cannot be specified on the command-line - yaml or nothing.
 
 opt = Getopt::Long.getopts(
   ['--silent',      '-s', Getopt::BOOLEAN],
@@ -35,6 +37,7 @@ end
   :loud         => options['loud'],
   :irc_network  => options['network'],
   :output_dir   => options['output-dir'],
-  :master       => options['master']
+  :master       => options['master'],
+  :passwords    => options['passwords']
 )
 @bot.irc_loop

data/lib/net/yail.rb

@@ -102,7 +102,8 @@ module Net
 # * :outgoing_ctcpreply(target, text) - CTCP NOTICE messages
 # * :outgoing_mode(target, modes, objects) - Sets or queries mode.  If modes is
 #   present, sends mode list to target.  Objects would be users.
-# * :outgoing_join(target) - The given target channel is about to be joined
+# * :outgoing_join(target, pass) - About to attempt to join target channel with
+#   given password (pass is '' if not specified in the join() command)
 # * :outgoing_part(target, text) - The given target channel is about to be
 #   left, with optional text reason.
 # * :outgoing_quit(text) - The client is about to quit, with optional text

data/lib/net/yail/default_events.rb

@@ -28,6 +28,7 @@ module Defaults
     # Incoming numeric events here
     prepend_handler :incoming_welcome,          self.method(:r_welcome)
     prepend_handler :incoming_bannedfromchan,   self.method(:r_bannedfromchan)
+    prepend_handler :incoming_badchannelkey,    self.method(:r_badchannelkey)
     prepend_handler :incoming_nicknameinuse,    self.method(:_nicknameinuse)
     prepend_handler :incoming_channelurl,       self.method(:r_channelurl)
     prepend_handler :incoming_topic,            self.method(:r_topic)
@@ -90,8 +91,13 @@ module Defaults
   end
 
   def r_bannedfromchan(text, args)
-    text =~ /^(\S*) :Cannot join channel \((\S*)\)/
-    report "Unable to join channel #{$1}: #{$2}"
+    text =~ /^(\S*) :Cannot join channel/
+    report "Banned from channel #{$1}"
+  end
+
+  def r_badchannelkey(text, args)
+    text =~ /^(\S*) :Cannot join channel/
+    report "Bad channel key (password) for #{$1}"
   end
 
   def r_welcome(*args)

data/lib/net/yail/output_api.rb

@@ -133,13 +133,16 @@ module IRCOutputAPI
   end
 
   # Calls :outgoing_join handler and then raw JOIN message for a given channel
-  def join(target)
+  def join(target, pass = '')
     # Dup strings so handler can filter safely
     target = target.dup
+    pass = pass.dup
 
-    handle(:outgoing_join, target)
+    handle(:outgoing_join, target, pass)
 
-    raw "JOIN #{target}"
+    text = "JOIN #{target}"
+    text += " #{pass}" unless pass.empty?
+    raw text
   end
 
   # Calls :outgoing_part handler and then raw PART for leaving a given channel

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: net-yail
 version: !ruby/object:Gem::Version 
-  version: 1.1.1
+  version: 1.2.0
 platform: ruby
 authors: 
 - Jeremy Echols
@@ -9,7 +9,7 @@ autorequire: net/yail
 bindir: bin
 cert_chain: []
 
-date: 2008-07-03 00:00:00 -07:00
+date: 2008-07-17 00:00:00 -07:00
 default_executable: 
 dependencies: []
 
@@ -23,16 +23,16 @@ extra_rdoc_files:
 - README
 - CHANGELOG
 files: 
+- examples/logger/default.yml
 - examples/logger/logger_bot.rb
 - examples/logger/run.rb
-- examples/logger/default.yml
 - lib/net/yail.rb
 - CHANGELOG
+- lib/net/yail/output_api.rb
+- lib/net/yail/default_events.rb
+- lib/net/yail/magic_events.rb
 - lib/net/yail/eventmap.yml
 - lib/net/yail/IRCBot.rb
-- lib/net/yail/magic_events.rb
-- lib/net/yail/default_events.rb
-- lib/net/yail/output_api.rb
 - README
 has_rdoc: true
 homepage: http://ruby-irc-yail.nerdbucket.com/
@@ -57,7 +57,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: net-yail
-rubygems_version: 1.1.1
+rubygems_version: 1.2.0
 signing_key: 
 specification_version: 2
 summary: "Yet Another IRC Library: wrapper for IRC communications in Ruby."