net-yail 1.6.0 → 1.6.1

data/examples/simple/dumbbot.rb

@@ -10,15 +10,19 @@ require 'getopt/long'
 opt = Getopt::Long.getopts(
   ['--network',  Getopt::REQUIRED],
   ['--nick', Getopt::REQUIRED],
+  ['--port', Getopt::REQUIRED],
   ['--loud', Getopt::BOOLEAN]
 )
 
-irc = Net::YAIL.new(
+opts = {
   :address    => opt['network'],
-  :username   => 'Frakking Bot',
+  :username   => 'FrakkingBot',
   :realname   => 'John Botfrakker',
-  :nicknames  => [opt['nick']]
-)
+  :nicknames  => [opt['nick']],
+}
+opts[:port] = opt['port'] if opt['port']
+
+irc = Net::YAIL.new(opts)
 
 irc.log.level = Logger::DEBUG if opt['loud']
 

data/examples/simple/whois.rb

@@ -0,0 +1,52 @@
+require 'rubygems'
+
+# Want a specific version of net/yail?  Try uncommenting this:
+# gem 'net-yail', '1.x.y'
+
+require 'net/yail'
+require 'getopt/long'
+
+# User specifies channel and nick
+opt = Getopt::Long.getopts(
+  ['--network',  Getopt::REQUIRED],
+  ['--nick', Getopt::REQUIRED],
+  ['--port', Getopt::REQUIRED],
+  ['--loud', Getopt::BOOLEAN]
+)
+
+opts = {
+  :address    => opt['network'],
+  :username   => 'FrakkingBot',
+  :realname   => 'John Botfrakker',
+  :nicknames  => [opt['nick']],
+}
+opts[:port] = opt['port'] if opt['port']
+
+irc = Net::YAIL.new(opts)
+
+irc.log.level = Logger::DEBUG if opt['loud']
+
+# Register handlers
+irc.heard_welcome { |e| irc.join('#bots') }       # Filter - runs after the server's welcome message is read
+irc.on_invite     { |e| irc.join(e.channel) }     # Handler - runs on an invite message
+
+# WHOIS example (this could be useful for other numerics as well)
+data = {}
+irc.heard_join do |e|
+  data = {:nick => e.nick}
+  irc.whois(e.nick)
+end
+irc.heard_whoisuser do |e|
+  data[:name] = e.parameters[4]
+  data[:host] = e.parameters[2]
+end
+irc.heard_whoischannels do |e|
+  data[:channels] = e.parameters.last
+end
+irc.heard_endofwhois do |e|
+  irc.msg(data[:nick], "I know who you are, #{data[:nick]}")
+  irc.msg(data[:nick], data.inspect)
+end
+
+# Start the bot and enjoy the endless loop
+irc.start_listening!

data/lib/net/yail.rb

@@ -245,6 +245,7 @@ module Net
 #   If <tt>server</tt> is present, the request is forwarded to the given server.
 # * <tt>invite(nick, channel)</tt>: Invites a user to the given channel.
 # * <tt>kick(nick, channel, [message])</tt>: "KICK :channel :nick", :nick, :channel, :reason, " ::reason"
+# * <tt>whois(nick, [server]): Issues a WHOIS command for the given nickname with an optional server.
 #
 # =Simple Example
 #
@@ -380,7 +381,7 @@ class YAIL
       @log = options[:log]
     else
       @log = Logger.new(options[:log_io] || STDERR)
-      @log.level = Logger::WARN
+      @log.level = Logger::INFO
 
       if (options[:silent] || options[:loud])
         @log.warn '[DEPRECATED] - passing :silent and :loud options to constructor are deprecated as of 1.4.1'
@@ -496,6 +497,7 @@ class YAIL
     set_callback :outgoing_act, self.method(:magic_out_act)
 
     # WHOIS is tricky due to how weird its argument positioning is, so can't use create_command, either
+    set_callback :outgoing_whois, self.method(:magic_out_whois)
 
     # All PRIVMSG events eventually hit this - it's a legacy thing, and kinda dumb, but there you
     # have it.  Just sends a raw PRIVMSG out to the socket.
@@ -720,7 +722,8 @@ class YAIL
   # Reports may not get printed in the proper order since I scrubbed the
   # IRCSocket report capturing, but this is way more straightforward to me.
   def report(*lines)
-    lines.each {|line| $stdout.puts "(#{Time.now.strftime('%H:%M.%S')}) #{line}"}
+    @log.warn '[DEPRECATED] - Net::YAIL#report is deprecated and will be removed in 2.0 - use the logger (e.g., "@irc.log.info") instead'
+    lines.each {|line| @log.info line}
   end
 
   # Converts events that are numerics into the internal "incoming_numeric_xxx" format

data/lib/net/yail/default_events.rb

@@ -10,13 +10,13 @@ module Defaults
   # quitting may be fine, but for something else, we may want to prompt a
   # user or try again in 20 minutes or something.  Note that we only fail
   # when the adapter hasn't gotten logged in yet - an attempt at changing
-  # nick after registration (welcome message) just generates a report.
+  # nick after registration (welcome message) just generates a log message.
   #
   # TODO: This should really not even be here.  Client should have full control over whether or not
   # they want this.  Base IRC bot class should have this, but not the core YAIL lib.
   def _nicknameinuse(event)
     event.message =~ /^(\S+)/
-    report "Nickname #{$1} is already in use."
+    @log.warn "Nickname #{$1} is already in use."
 
     if (!@registered)
       begin
@@ -24,11 +24,11 @@ module Defaults
         if (nextnick != nil)
           nick nextnick
         else
-          report '*** All nicknames in use. ***'
+          @log.error '*** All nicknames in use. ***'
           raise ArgumentError.new("All nicknames in use")
         end
       rescue
-        report '*** Nickname selection error. ***'
+        @log.error '*** Nickname selection error. ***'
         raise
       end
     end
@@ -40,10 +40,10 @@ module Defaults
   def _namreply(event)
     event.message =~ /^(@|\*|=) (\S+) :?(.+)$/
     channeltype = {'@' => 'Secret', '*' => 'Private', '=' => 'Normal'}[$1]
-    report "{#{$2}} #{channeltype} channel nickname list: #{$3}"
+    @log.info "{#{$2}} #{channeltype} channel nickname list: #{$3}"
     @nicklist = $3.split(' ')
     @nicklist.collect!{|name| name.sub(/^\W*/, '')}
-    report "First nick: #{@nicklist[0]}"
+    @log.info "First nick: #{@nicklist[0]}"
   end
 
 end

data/lib/net/yail/irc_bot.rb

@@ -144,9 +144,10 @@ class IRCBot
     @irc.join(*args)
   end
 
-  # Wraps Net::YAIL.report
-  def report(*args)
-    @irc.report(*args)
+  # Logs the requested lines using the internal logger - deprecated to push logger on people
+  def report(*lines)
+    @log.warn '[DEPRECATED] - IRCBot#report is deprecated and will be removed in 2.0 - use the logger (e.g., "@bot.log.info") instead'
+    lines.each {|line| @irc.log.info line}
   end
 
   # Wraps Net::YAIL.nick

data/lib/net/yail/legacy_events.rb

@@ -189,7 +189,7 @@ module LegacyEvents
         return handle(event.type, event.nick, event.channel)
 
       when :outgoing_kick
-        return handle(event.type, event.nick, event.channel, event.reason)
+        return handle(event.type, event.nick, event.channel, event.message)
 
       when :outgoing_begin_connection
         return handle(event.type, event.username, event.address, event.realname)

data/lib/net/yail/magic_events.rb

@@ -18,8 +18,7 @@ module Magic
   # We were welcomed, so we need to set up initial nickname and set that we
   # registered so nick change failure doesn't cause DEATH!
   def magic_welcome(event)
-    # TODO: Ditch this call to report - move to report lib if necessary
-    report "#{event.from} welcome message: #{event.message}"
+    @log.info "#{event.from} welcome message: #{event.message}"
     if (event.message =~ /(\S+)!\S+$/)
       @me = $1
     elsif (event.message =~ /(\S+)$/)
@@ -55,7 +54,8 @@ module Magic
 
   # WHOIS - here because first parameter might be the nick and might be the optional server
   def magic_out_whois(event)
-    raw "WHOIS %s%s" % [event.server.to_s.empty? ? "" : event.server, event.nick]
+    string = "WHOIS %s%s" % [event.server.to_s.empty? ? "" : event.server, event.nick]
+    raw string
   end
 
 end

data/lib/net/yail/report_events.rb

@@ -35,137 +35,137 @@ module Reports
 
   private
   def r_msg(event)
-    report "{%s} <%s> %s" % [event.target || event.channel, event.nick, event.message]
+    @yail.log.info "{%s} <%s> %s" % [event.target || event.channel, event.nick, event.message]
   end
 
   def r_act(event)
-    report "{%s} * %s %s" % [event.target || event.channel, event.nick, event.message]
+    @yail.log.info "{%s} * %s %s" % [event.target || event.channel, event.nick, event.message]
   end
 
   def r_notice(event)
     nick = event.server? ? '' : event.nick
-    report "{%s} -%s- %s" % [event.target || event.channel, nick, event.message]
+    @yail.log.info "{%s} -%s- %s" % [event.target || event.channel, nick, event.message]
   end
 
   def r_ctcp(event)
-    report "{%s} [%s %s]" % [event.target || event.channel, event.nick, event.message]
+    @yail.log.info "{%s} [%s %s]" % [event.target || event.channel, event.nick, event.message]
   end
 
   def r_ctcpreply(event)
-    report "{%s} [Reply: %s %s]" % [event.target || event.channel, event.nick, event.message]
+    @yail.log.info "{%s} [Reply: %s %s]" % [event.target || event.channel, event.nick, event.message]
   end
 
   def r_mode(event)
-    report "{%s} %s sets mode %s %s" % [event.channel, event.from, event.message, event.targets.join(' ')]
+    @yail.log.info "{%s} %s sets mode %s %s" % [event.channel, event.from, event.message, event.targets.join(' ')]
   end
 
   def r_join(event)
-    report "{#{event.channel}} #{event.nick} joins"
+    @yail.log.info "{#{event.channel}} #{event.nick} joins"
   end
 
   def r_part(event)
-    report "{#{event.channel}} #{event.nick} parts (#{event.message})"
+    @yail.log.info "{#{event.channel}} #{event.nick} parts (#{event.message})"
   end
 
   def r_kick(event)
-    report "{#{event.channel}} #{event.nick} kicked #{event.target} (#{event.message})"
+    @yail.log.info "{#{event.channel}} #{event.nick} kicked #{event.target} (#{event.message})"
   end
 
   def r_quit(event)
-    report "#{event.nick} quit (#{event.message})"
+    @yail.log.info "#{event.nick} quit (#{event.message})"
   end
 
   # Incoming invitation
   def r_invite(event)
-    report "[#{event.nick}] INVITE to #{event.target}"
+    @yail.log.info "[#{event.nick}] INVITE to #{event.target}"
   end
 
   # Reports nick change unless nickname is us - we check nickname here since
   # the magic method changes @yail.me to the new nickname.
   def r_nick(event)
-    report "#{event.nick} changed nick to #{event.message}" unless event.nick == @yail.me
+    @yail.log.info "#{event.nick} changed nick to #{event.message}" unless event.nick == @yail.me
   end
 
   def r_bannedfromchan(event)
     event.message =~ /^(\S*) :Cannot join channel/
-    report "Banned from channel #{$1}"
+    @yail.log.info "Banned from channel #{$1}"
   end
 
   def r_badchannelkey(event)
     event.message =~ /^(\S*) :Cannot join channel/
-    report "Bad channel key (password) for #{$1}"
+    @yail.log.info "Bad channel key (password) for #{$1}"
   end
 
   def r_welcome(event)
-    report "*** Logged in as #{@yail.me}. ***"
+    @yail.log.info "*** Logged in as #{@yail.me}. ***"
   end
 
   # Channel URL
   def r_channelurl(event)
     event.message =~ /^(\S+) :?(.+)$/
-    report "{#{$1}} URL is #{$2}"
+    @yail.log.info "{#{$1}} URL is #{$2}"
   end
 
   # Channel topic
   def r_topic(event)
     event.message =~ /^(\S+) :?(.+)$/
-    report "{#{$1}} Topic is: #{$2}"
+    @yail.log.info "{#{$1}} Topic is: #{$2}"
   end
 
   # Channel topic setter
   def r_topicinfo(event)
     event.message =~ /^(\S+) (\S+) (\d+)$/
-    report "{#{$1}} Topic set by #{$2} on #{Time.at($3.to_i).asctime}"
+    @yail.log.info "{#{$1}} Topic set by #{$2} on #{Time.at($3.to_i).asctime}"
   end
 
   # End of names
   def r_endofnames(event)
     event.message =~ /^(\S+)/
-    report "{#{$1}} Nickname list complete"
+    @yail.log.info "{#{$1}} Nickname list complete"
   end
 
   # MOTD line
   def r_motd(event)
     event.message =~ /^:?(.+)$/
-    report "*MOTD* #{$1}"
+    @yail.log.info "*MOTD* #{$1}"
   end
 
   # Beginning of MOTD
   def r_motdstart(event)
     event.message =~ /^:?(.+)$/
-    report "*MOTD* #{$1}"
+    @yail.log.info "*MOTD* #{$1}"
   end
 
   # End of MOTD
   def r_endofmotd(event)
-    report "*MOTD* End of MOTD"
+    @yail.log.info "*MOTD* End of MOTD"
   end
 
   # Sent a privmsg (non-ctcp)
   def r_out_msg(event)
-    report "{#{event.target}} <#{@yail.me}> #{event.message}"
+    @yail.log.info "{#{event.target}} <#{@yail.me}> #{event.message}"
   end
 
   # Sent a ctcp
   def r_out_ctcp(event)
-    report "{#{event.target}} [#{@yail.me} #{event.message}]"
+    @yail.log.info "{#{event.target}} [#{@yail.me} #{event.message}]"
   end
 
   # Sent ctcp action
   def r_out_act(event)
-    report "{#{event.target}} <#{@yail.me}> #{event.message}"
+    @yail.log.info "{#{event.target}} <#{@yail.me}> #{event.message}"
   end
 
   def r_out_notice(event)
-    report "{#{event.target}} -#{@yail.me}- #{event.message}"
+    @yail.log.info "{#{event.target}} -#{@yail.me}- #{event.message}"
   end
 
   def r_out_ctcpreply(event)
-    report "{#{event.target}} [Reply: #{@yail.me} #{event.message}]"
+    @yail.log.info "{#{event.target}} [Reply: #{@yail.me} #{event.message}]"
   end
 
   def r_out_generic(event)
-    report "bot: #{event.inspect}"
+    @yail.log.info "bot: #{event.inspect}"
   end
 end
 

data/lib/net/yail/yail-version.rb

@@ -1,5 +1,5 @@
 module Net
   class YAIL
-    VERSION = '1.6.0'
+    VERSION = '1.6.1'
   end
 end

data/tests/tc_yail.rb

@@ -55,12 +55,13 @@ class YailSessionTest < Test::Unit::TestCase
       @notices.push({:from => f, :nick => actor, :target => target, :message => message})
     end
 
-    @yail.prepend_handler(:incoming_ping) { |message|                        @ping_message = message; false }
-    @yail.prepend_handler(:incoming_quit) { |f, actor, message|              @quit = {:full => f, :nick => actor, :message => message}; false }
+    @yail.prepend_handler(:incoming_ping) { |message|                     @ping_message = message; false }
+    @yail.prepend_handler(:incoming_quit) { |f, actor, message|           @quit = {:full => f, :nick => actor, :message => message}; false }
     @yail.prepend_handler(:outgoing_join) { |channel, pass|               @out_join = {:channel => channel, :password => pass}; false }
-    @yail.prepend_handler(:incoming_msg)  { |f, actor, channel, message|     @privmsg = {:channel => channel, :nick => actor, :message => message}; false }
-    @yail.prepend_handler(:incoming_ctcp) { |f, actor, channel, message|     @ctcp = {:channel => channel, :nick => actor, :message => message}; false }
-    @yail.prepend_handler(:incoming_act)  { |f, actor, channel, message|     @act = {:channel => channel, :nick => actor, :message => message}; false }
+    @yail.prepend_handler(:outgoing_kick) { |nick, channel, reason|       @out_kick = {:channel => channel, :nick => nick, :message => reason}; false }
+    @yail.prepend_handler(:incoming_msg)  { |f, actor, channel, message|  @privmsg = {:channel => channel, :nick => actor, :message => message}; false }
+    @yail.prepend_handler(:incoming_ctcp) { |f, actor, channel, message|  @ctcp = {:channel => channel, :nick => actor, :message => message}; false }
+    @yail.prepend_handler(:incoming_act)  { |f, actor, channel, message|  @act = {:channel => channel, :nick => actor, :message => message}; false }
   end
 
   # "New" handlers are set up (the 1.5+ way of doing things) here to perform tests in common with
@@ -110,6 +111,7 @@ class YailSessionTest < Test::Unit::TestCase
     @yail.heard_ping  { |event| @ping_message = event.message }
     @yail.on_quit     { |event| @quit = {:full => event.fullname, :nick => event.nick, :message => event.message} }
     @yail.saying_join { |event| @out_join = {:channel => event.channel, :password => event.password} }
+    @yail.saying_kick { |event| @out_kick = {:channel => event.channel, :nick => event.nick, :message => event.message} }
     @yail.on_msg      { |event| @privmsg = {:channel => event.channel, :nick => event.nick, :message => event.message} }
     @yail.on_ctcp     { |event| @ctcp = {:channel => event.channel, :nick => event.nick, :message => event.message} }
     @yail.on_act      { |event| @act = {:channel => event.channel, :nick => event.nick, :message => event.message} }
@@ -194,6 +196,19 @@ class YailSessionTest < Test::Unit::TestCase
     assert_equal "pass", @out_join[:password]
     assert_equal ['#foosball'], @channels
 
+    # Kick somebody
+    @yail.kick("Nerdminion", "#foosball")
+    wait_for_irc
+    assert_equal("#foosball", @out_kick[:channel])
+    assert_equal("Nerdminion", @out_kick[:nick])
+
+    # Kick with message
+    @yail.kick("Nerdminion", "#foosball", "Because you're a bad, bad man")
+    wait_for_irc
+    assert_equal("#foosball", @out_kick[:channel])
+    assert_equal("Nerdminion", @out_kick[:nick])
+    assert_equal("Because you're a bad, bad man", @out_kick[:message])
+
     # Mock some chatter to verify PRIVMSG info
     mock_message ":Nerdmaster!nerd@nerdbucket.com PRIVMSG #foosball :#{@yail.me}: Welcome!" do
       assert_equal 1, @msg[:msg]
@@ -332,9 +347,9 @@ class YailSessionTest < Test::Unit::TestCase
 
     # Conditional filters are really ugly when passing a block instead of a method, so let's
     # at least try to make this look decent
-    hearing_food    = lambda { @msg[:food] += 1 }
-    not_hearing_bad = lambda { @msg[:not_bad] += 1 }
-    heard_nothing   = lambda { @msg[:nothing] += 1 }
+    hearing_food    = lambda { |e| @msg[:food] += 1 }
+    not_hearing_bad = lambda { |e| @msg[:not_bad] += 1 }
+    heard_nothing   = lambda { |e| @msg[:nothing] += 1 }
 
     # If the message looks like "food", the handler will be hit
     @yail.hearing_msg(hearing_food, :if => lambda {|e| e.message =~ /food/})

metadata

@@ -1,56 +1,52 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: net-yail
-version: !ruby/object:Gem::Version 
-  hash: 15
+version: !ruby/object:Gem::Version
+  version: 1.6.1
   prerelease: 
-  segments: 
-  - 1
-  - 6
-  - 0
-  version: 1.6.0
 platform: ruby
-authors: 
+authors:
 - Jeremy Echols
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2012-11-08 00:00:00 Z
+date: 2013-02-20 00:00:00.000000000 Z
 dependencies: []
+description: ! 'Net::YAIL is an IRC library written in pure Ruby.  Using simple functions,
+  it
 
-description: |-
-  Net::YAIL is an IRC library written in pure Ruby.  Using simple functions, it
   is trivial to build a complex, event-driven IRC application, such as a bot or
+
   even a full command-line client.  All events can have a single callback and
+
   any number of before-callback and after-callback filters.  Even outgoing events,
+
   such as when you join a channel or send a message, can have filters for stats
-  gathering, text filtering, etc.
+
+  gathering, text filtering, etc.'
 email: yail<at>nerdbucket dot com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - examples/simple/dumbbot.rb
-- examples/logger/run.rb
+- examples/simple/whois.rb
 - examples/logger/default.yml
 - examples/logger/logger_bot.rb
+- examples/logger/run.rb
 - lib/net/yail.rb
-- lib/net/yail/irc_bot.rb
-- lib/net/yail/yail-version.rb
-- lib/net/yail/message_parser.rb
-- lib/net/yail/magic_events.rb
-- lib/net/yail/legacy_events.rb
-- lib/net/yail/report_events.rb
-- lib/net/yail/output_api.rb
-- lib/net/yail/eventmap.yml
+- lib/net/yail/IRCBot.rb
 - lib/net/yail/default_events.rb
 - lib/net/yail/dispatch.rb
-- lib/net/yail/IRCBot.rb
 - lib/net/yail/event.rb
+- lib/net/yail/eventmap.yml
 - lib/net/yail/handler.rb
+- lib/net/yail/irc_bot.rb
+- lib/net/yail/legacy_events.rb
+- lib/net/yail/magic_events.rb
+- lib/net/yail/message_parser.rb
+- lib/net/yail/output_api.rb
+- lib/net/yail/report_events.rb
+- lib/net/yail/yail-version.rb
 - tests/tc_event.rb
 - tests/tc_yail.rb
 - tests/tc_message_parser.rb
@@ -58,41 +54,33 @@ files:
 - tests/net_yail.rb
 homepage: http://ruby-irc-yail.nerdbucket.com/
 licenses: []
-
 post_install_message: 
-rdoc_options: 
+rdoc_options:
 - -m
 - Net::YAIL
 - -f
 - sdoc
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: net-yail
 rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
-summary: "Yet Another IRC Library: wrapper for IRC communications in Ruby."
-test_files: 
+summary: ! 'Yet Another IRC Library: wrapper for IRC communications in Ruby.'
+test_files:
 - tests/tc_event.rb
 - tests/tc_yail.rb
 - tests/tc_message_parser.rb