net-yail 1.6.1 → 1.6.2

data/examples/simple/kick.rb

@@ -0,0 +1,39 @@
+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
+
+# KICK example - kicks everybody from the channel other than self
+data = {}
+irc.heard_join do |e|
+  irc.kick(e.nick, e.channel, "I'm USING THE BATHROOM!  Give me a minute!") unless e.nick == irc.me
+end
+
+# Start the bot and enjoy the endless loop
+irc.start_listening!

data/lib/net/yail.rb

@@ -2,6 +2,7 @@ require 'socket'
 require 'thread'
 require 'yaml'
 require 'logger'
+require 'openssl'
 
 # To make this library seem smaller, a lot of code has been split up and put
 # into semi-logical files.  I don't really like this hacky solution, but I
@@ -244,7 +245,7 @@ module Net
 #   contain a comma-separated list of channels, which will restrict the list to the given channels.
 #   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>kick(nick, channel, [message])</tt>: Kicks the given user from the given channel with an optional message
 # * <tt>whois(nick, [server]): Issues a WHOIS command for the given nickname with an optional server.
 #
 # =Simple Example
@@ -538,7 +539,6 @@ class YAIL
 
   # If user asked for SSL, this is where we set it all up
   def setup_ssl
-    require 'openssl'
     ssl_context = OpenSSL::SSL::SSLContext.new()
     ssl_context.verify_mode = OpenSSL::SSL::VERIFY_NONE
     @socket = OpenSSL::SSL::SSLSocket.new(@socket, ssl_context)
@@ -553,8 +553,10 @@ class YAIL
     # Simple non-ssl socket == return a single line
     return [@socket.gets] unless @ssl
 
-    # SSL socket == return all lines available
-    return @socket.readpartial(OpenSSL::Buffering::BLOCK_SIZE).split($/).collect {|message| message}
+    # SSL socket == return all lines available - but preserve newlines for servers that split
+    # up words!  Newlines tell us where commands end!
+    messages = @socket.readpartial(OpenSSL::Buffering::BLOCK_SIZE)
+    return messages.split(/(#{$/})/).each_slice(2).map(&:join)
   end
 
   # Reads incoming data - should only be called by io_loop, and only when
@@ -576,6 +578,20 @@ class YAIL
 
     # Chomp and push each message
     for message in messages
+      # Message must have one of \r or \n at the end of it, otherwise it's a partial command and
+      # we need to hang onto it to join it with the next message
+      if message !~ /[\r\n]+$/
+        @prepend_message ||= ""
+        @prepend_message += message.dup
+        next
+      end
+
+      # If we had a partial message recently, attach it to the new message and clear it out
+      if @prepend_message
+        message = @prepend_message + message
+        @prepend_message = nil
+      end
+
       message.chomp!
       @log.debug "+++INCOMING: #{message.inspect}"
 

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

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

data/tests/mock_irc.rb

@@ -46,6 +46,13 @@ class MockIRC
     return output
   end
 
+  # Hack for SSL mocking - it's expected tests will set the broken lines however we want them, so
+  # this just spits out what gets would have
+  def readpartial(size)
+    data = gets
+    return data || ""
+  end
+
   # Hack to let YAIL know if we have data to read
   def ready?
     return @output.empty? ? nil : true
@@ -160,4 +167,9 @@ class MockIRC
   def add_output(*args)
     args.each {|arg| @output.push(arg + "\n")}
   end
+
+  # Sets up our internal string to add a broken line (no newline character)
+  def add_partial_output(string)
+    @output.push(string)
+  end
 end

data/tests/tc_yail.rb

@@ -406,4 +406,33 @@ class YailSessionTest < Test::Unit::TestCase
       assert_equal({:not_bad => 1}, @msg)
     end
   end
+
+  def test_split_messages
+    # We have to set up a whole new YAIL for this since split messages only work on SSL
+    @yail = Net::YAIL.new(
+      :io => @mockirc, :address => "fake-irc.nerdbucket.com", :log => @log,
+      :nicknames => ["Bot"], :realname => "Net::YAIL", :username => "Username",
+      :use_ssl => true
+    )
+
+    @privmsg = []
+    @yail.on_msg { |event| @privmsg.push({:channel => event.channel, :nick => event.nick, :message => event.message}) }
+    @mockirc.add_partial_output ":Nerdmaster!nerd@nerdbucket.com PRIVMSG #foosball :First line\n"
+    @mockirc.add_partial_output ":Nerdmaster!nerd@n"
+    @mockirc.add_partial_output "erdbucket.com PRIVMSG"
+    @mockirc.add_partial_output " #foosball :Second line\n:Nerdmaster!nerd@nerdbucket.com PRIVMSG #foosball :Third line\n"
+    @yail.start_listening
+    wait_for_irc
+
+    assert_equal(@privmsg.length, 3)
+
+    0.upto(2) do |idx|
+      assert_equal("Nerdmaster", @privmsg[idx][:nick])
+      assert_equal("#foosball", @privmsg[idx][:channel])
+    end
+
+    assert_equal("First line", @privmsg[0][:message])
+    assert_equal("Second line", @privmsg[1][:message])
+    assert_equal("Third line", @privmsg[2][:message])
+  end
 end

metadata

@@ -1,88 +1,102 @@
---- !ruby/object:Gem::Specification
+--- !ruby/object:Gem::Specification 
 name: net-yail
-version: !ruby/object:Gem::Version
-  version: 1.6.1
+version: !ruby/object:Gem::Version 
+  hash: 11
   prerelease: 
+  segments: 
+  - 1
+  - 6
+  - 2
+  version: 1.6.2
 platform: ruby
-authors:
+authors: 
 - Jeremy Echols
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-20 00:00:00.000000000 Z
+
+date: 2013-04-04 00:00:00 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/simple/whois.rb
-- examples/logger/default.yml
+- examples/simple/kick.rb
 - examples/logger/logger_bot.rb
+- examples/logger/default.yml
 - examples/logger/run.rb
 - lib/net/yail.rb
+- lib/net/yail/magic_events.rb
+- lib/net/yail/eventmap.yml
 - lib/net/yail/IRCBot.rb
+- lib/net/yail/message_parser.rb
 - lib/net/yail/default_events.rb
-- lib/net/yail/dispatch.rb
+- lib/net/yail/output_api.rb
 - lib/net/yail/event.rb
-- lib/net/yail/eventmap.yml
-- lib/net/yail/handler.rb
+- lib/net/yail/yail-version.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
+- lib/net/yail/dispatch.rb
+- lib/net/yail/handler.rb
+- tests/net_yail.rb
+- tests/tc_message_parser.rb
 - tests/tc_event.rb
 - tests/tc_yail.rb
-- tests/tc_message_parser.rb
 - tests/mock_irc.rb
-- 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
-      version: '0'
-required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      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/net_yail.rb
+- tests/tc_message_parser.rb
 - tests/tc_event.rb
 - tests/tc_yail.rb
-- tests/tc_message_parser.rb
 - tests/mock_irc.rb
-- tests/net_yail.rb