percy 0.0.4 → 0.0.5

data/README.md

@@ -0,0 +1,176 @@
+# Percy 0.0.5
+
+## Configuring and starting the bot
+
+### mybot.rb
+    $:.unshift "#{File.expand_path(File.dirname(__FILE__))}/lib"
+    PERCY_ROOT = File.expand_path(File.dirname(__FILE__))
+
+    require 'rubygems'
+    require 'percy'
+    
+    bot = Percy.new
+    
+    bot.configure do |c|
+      c.server = 'chat.eu.freenode.net'
+      c.port = 6667
+      c.nick = 'Percyguy'
+      c.verbose = true
+      c.logging = true
+    end
+    
+    bot.connect
+
+Start it with `ruby mybot.rb`.
+
+## Handling Events
+### Connect
+    bot.on :connect do
+      # ...
+    end
+No variables.
+
+### Channel message
+    bot.on :channel, /^foo!/ do |env|
+      # ...
+    end
+Variables:
+
+<tt>env[:nick]
+env[:user]
+env[:host]
+env[:channel]
+env[:message]</tt>
+
+### Query message
+    bot.on :query, /^bar!/ do |env|
+      # ...
+    end
+Variables:
+
+<tt>env[:nick]
+env[:user]
+env[:host]
+env[:message]</tt>
+
+### Join
+    bot.on :join do |env|
+      # ...
+    end
+Variables:
+
+<tt>env[:nick]
+env[:user]
+env[:host]
+env[:channel]</tt>
+
+### Part
+    bot.on :part do |env|
+      # ...
+    end
+Variables:
+
+<tt>env[:nick]
+env[:user]
+env[:host]
+env[:channel]
+env[:message]</tt>
+
+### Quit
+    bot.on :quit do |env|
+      # ...
+    end
+Variables:
+
+<tt>env[:nick]
+env[:user]
+env[:host]
+env[:message]</tt>
+
+### Nickchange
+    bot.on :nickchange do |env|
+      # ...
+    end
+Variables:
+
+<tt>env[:nick]
+env[:user]
+env[:host]
+env[:new_nick]</tt>
+
+### Kick
+    bot.on :kick do |env|
+      # ...
+    end
+Variables:
+
+<tt>env[:nick]
+env[:user]
+env[:host]
+env[:channel]
+env[:victim]
+env[:reason]</tt>
+
+## Availabe Methods
+
+`raw(msg)`
+
+Sends a raw message to the server.
+
+`message(recipient, msg)`
+
+Sends a message to a channel or an user.
+
+`notice(recipient, msg)`
+
+Sends a notice to an user.
+
+`action(recipient, msg)`
+
+Performs an action (/me ...).
+
+`mode(recipient, option)`
+
+Sets a mode for a channel or an user.
+
+`channellimit(channel)`
+
+Returns the channel limit of a channel (as integer if set, else (not set/timeout) false).
+
+`kick(channel, user, reason)`
+
+Kicks an user from a channel with a specific reason.
+
+`topic(channel, topic)`
+
+Sets the topic for a channel.
+
+`join(channel, password = nil)`
+
+Joins a channel.
+
+`part(channel, msg)`
+
+Parts a channel with a message.
+
+`quit(msg = nil)`
+
+Quits from the server with a message.
+
+`users_on(channel)`
+
+Returns an array of users from a channel (mode in front like: ['@percy', 'Peter_Parker', '+The_Librarian']) or false if timeout.
+
+
+`is_online(nick)`
+
+Returns a nickname as string if online, else false (not online/timeout)
+
+## License
+Copyright (c) 2009 Tobias Bühlmann
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/VERSION

@@ -0,0 +1 @@
+0.0.5

data/lib/percy.rb

@@ -8,7 +8,7 @@ require 'thread'
 Thread.abort_on_exception = true
 
 class Percy
-  VERSION = 'Percy 0.0.4 (http://github.com/tbuehlmann/percy)'
+  VERSION = 'Percy 0.0.5 (http://github.com/tbuehlmann/percy)'
   
   Config = Struct.new(:server, :port, :password, :nick, :username, :verbose, :logging)
   
@@ -67,8 +67,8 @@ class Percy
     raw "MODE #{recipient} #{option}"
   end
   
-  # get the channellimit of a channel
-  def channellimit(channel)
+  # get the channel limit of a channel
+  def channel_limit(channel)
     add_observer
     raw "MODE #{channel}"
     
@@ -76,8 +76,8 @@ class Percy
       Timeout::timeout(10) do # try 10 seconds to retrieve l mode of <channel>
         loop do
           @temp_socket.each do |line|
-            if line =~ /^:(\S+) 324 (\S+) #{channel} .*l.* (\d+)/
-              return $3.to_i
+            if line =~ /^:\S+ 324 \S+ #{channel} .*l.* (\d+)/
+              return $1.to_i
             end
           end
           sleep 0.5
@@ -99,8 +99,8 @@ class Percy
       Timeout::timeout(10) do
         loop do
           @temp_socket.each do |line|
-            if line =~ /^:(\S+) 311 (\S+) (#{nick}) /i
-              return $3
+            if line =~ /^:\S+ 311 \S+ (#{nick}) /i
+              return $1
             elsif line =~ /^:\S+ 401 \S+ #{nick} /i
               return false
             end
@@ -209,7 +209,7 @@ class Percy
       Timeout::timeout(10) do # try 10 seconds to retrieve the users of <channel>
         loop do
           @temp_socket.each do |line|
-            if line =~ /^:(\S+) 353 (\S+) = #{channel} :/
+            if line =~ /^:\S+ 353 \S+ = #{channel} :/
               return $'.split(' ')
             end
           end
@@ -403,13 +403,13 @@ class Percy
           when /^PING \S+$/
             raw line.chomp.gsub('PING', 'PONG')
           
-          when /^:(\S+) (376|422)/
+          when /^:\S+ 376|422/
             parse(:connect)
           
           when /^:(\S+)!(\S+)@(\S+) PRIVMSG #(\S+) :/
             parse(:channel, :nick => $1, :user => $2, :host => $3, :channel => "##{$4}", :message => $')
           
-          when /^:(\S+)!(\S+)@(\S+) PRIVMSG (\S+) :/
+          when /^:(\S+)!(\S+)@(\S+) PRIVMSG \S+ :/
             parse(:query, :nick => $1, :user => $2, :host => $3, :message => $')
           
           when /^:(\S+)!(\S+)@(\S+) JOIN :*(\S+)$/

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: percy
 version: !ruby/object:Gem::Version 
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors: 
 - "Tobias B\xC3\xBChlmann"
@@ -24,8 +24,9 @@ extra_rdoc_files: []
 files: 
 - lib/percy.rb
 - lib/percylogger.rb
-- README.rdoc
+- README.md
 - LICENSE
+- VERSION
 has_rdoc: true
 homepage: http://github.com/tbuehlmann/percy
 licenses: []

data/README.rdoc

@@ -1,80 +0,0 @@
-= Percy 0.0.4
-
-== Configuring the bot
-
-=== mybot.rb
-  $:.unshift "#{File.expand_path(File.dirname(__FILE__))}/lib"
-  PERCY_ROOT = File.expand_path(File.dirname(__FILE__))
-
-  require 'rubygems'
-  require 'percy'
-
-  bot = Percy.new
-
-  bot.configure do |c|
-    c.server = 'chat.eu.freenode.net'
-    c.port = 6667
-    c.nick = 'Percyguy'
-    c.verbose = true
-    c.logging = true
-  end
-
-Start it with <tt>ruby mybot.rb</tt>.
-
-== Events
-Handle events with:
-  bot.on :connect do
-    # join channels
-    # do things
-  end
-  
-  bot.on :channel, /^foo!/ do |env|
-    # available variables: env[:nick], env[:user], env[:host], env[:channel], env[:message]
-  end
-  
-  bot.on :query, /^bar!/ do |env|
-    # available variables: env[:nick], env[:user], env[:host], env[:message]
-  end
-  
-  bot.on :join do |env|
-    # available variables: env[:nick], env[:user], env[:host], env[:channel]
-  end
-  
-  bot.on :part do |env|
-    # available variables: env[:nick], env[:user], env[:host], env[:channel], env[:message]
-  end
-  
-  bot.on :quit do |env|
-    # available variables: env[:nick], env[:user], env[:host], env[:message]
-  end
-  
-  bot.on :nickchange do |env|
-    # available variables: env[:nick], env[:user], env[:host], env[:new_nick]
-  end
-  
-  bot.on :kick do |env|
-    # available variables: env[:nick], env[:user], env[:host], env[:new_nick], env[:channel], env[:victim]
-  end
-
-== Methods availabe
-* message(recipient, msg)
-* notice(recipient, msg)
-* action(recipient, msg)
-* mode(recipient, option)
-* channellimit(channel)
-* kick(channel, user, reason)
-* topic(channel, topic)
-* join(channel, password = nil)
-* part(channel, msg)
-* quit(msg = nil)
-* users_on(channel)
-* is_online(nick)
-
-== License
-Copyright (c) 2009 Tobias Bühlmann
-
-Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.