percy 1.3.0 → 1.4.0

data/README.md

@@ -1,6 +1,4 @@
-# Percy 1.3.0
-
-- You can now call all the class methods without `Percy.` in front.
+# Percy 1.4.0
 
 ## Configuring and starting the bot
 
@@ -8,7 +6,7 @@
     require 'rubygems'
     require 'percy'
     
-    Percy.configure do |c|
+    configure do |c|
       c.server             = 'chat.eu.freenode.net'
       c.port               = 6667
       # c.password         = 'password'
@@ -20,19 +18,22 @@
       c.reconnect_interval = 30
     end
     
-    Percy.connect
+    connect
 
 Start it with `ruby mybot.rb`.
 
 ## Handling Events
+
+- You can also call all methods with `Percy::IRC`, like `Percy::IRC.join('#that_cool_channel')`.
+
 ### Connect
-    Percy.on :connect do
+    on :connect do
       # ...
     end
 No variables.
 
 ### Channel message
-    Percy.on :channel, /^foo!/ do |env|
+    on :channel, /^foo!/ do |env|
       # ...
     end
 Variables:
@@ -44,7 +45,7 @@ env[:channel]<br />
 env[:message]</tt>
 
 ### Query message
-    Percy.on :query, /^bar!/ do |env|
+    on :query, /^bar!/ do |env|
       # ...
     end
 Variables:
@@ -55,7 +56,7 @@ env[:host]<br />
 env[:message]</tt>
 
 ### Join
-    Percy.on :join do |env|
+    on :join do |env|
       # ...
     end
 Variables:
@@ -66,7 +67,7 @@ env[:host]<br />
 env[:channel]</tt>
 
 ### Part
-    Percy.on :part do |env|
+    on :part do |env|
       # ...
     end
 Variables:
@@ -78,7 +79,7 @@ env[:channel]<br />
 env[:message]</tt>
 
 ### Quit
-    Percy.on :quit do |env|
+    on :quit do |env|
       # ...
     end
 Variables:
@@ -89,7 +90,7 @@ env[:host]<br />
 env[:message]</tt>
 
 ### Nickchange
-    Percy.on :nickchange do |env|
+    on :nickchange do |env|
       # ...
     end
 Variables:
@@ -100,7 +101,7 @@ env[:host]<br />
 env[:new_nick]</tt>
 
 ### Kick
-    Percy.on :kick do |env|
+    on :kick do |env|
       # ...
     end
 Variables:
@@ -113,7 +114,7 @@ env[:victim]<br />
 env[:reason]</tt>
 
 ### Raw Numerics
-    Percy.on '301' do |env|
+    on '301' do |env|
       # ...
     end
 Variables:
@@ -122,59 +123,97 @@ Variables:
 
 ## Availabe Class Methods
 
-`Percy.raw(msg)`
+`raw(msg)`
 
 Sends a raw message to the server.
 
-`Percy.message(recipient, msg)`
+`message(recipient, msg)`
 
 Sends a message to a channel or an user.
 
-`Percy.notice(recipient, msg)`
+`notice(recipient, msg)`
 
 Sends a notice to an user.
 
-`Percy.action(recipient, msg)`
+`action(recipient, msg)`
 
 Performs an action (/me ...).
 
-`Percy.mode(recipient, option)`
+`mode(recipient, option)`
 
 Sets a mode for a channel or an user.
 
-`Percy.channellimit(channel)`
+`channellimit(channel)`
 
 Returns the channel limit of a channel (as integer if set, else (not set/timeout) false).
 
-`Percy.kick(channel, user, reason)`
+`kick(channel, user, reason)`
 
 Kicks an user from a channel with a specific reason.
 
-`Percy.topic(channel, topic)`
+`topic(channel, topic)`
 
 Sets the topic for a channel.
 
-`Percy.join(channel, password = nil)`
+`join(channel, password = nil)`
 
 Joins a channel.
 
-`Percy.part(channel, msg)`
+`part(channel, msg)`
 
 Parts a channel with a message.
 
-`Percy.quit(msg = nil)`
+`quit(msg = nil)`
 
 Quits from the server with a message.
 
-`Percy.users_on(channel)`
+`users_on(channel)`
 
 Returns an array of users from a channel (mode in front like: ['@percy', 'Peter_Parker', '+The_Librarian']) or false if timeout.
 
-
-`Percy.is_online(nick)`
+`is_online(nick)`
 
 Returns a nickname as string if online, else false (not online/timeout)
 
+## Formatting
+
+There are constants for formatting your messages. They are all availabe through `Percy::Formatting` or by including the module.
+
+Availabe formatting constants:
+
+`PLAIN`
+`BOLD`
+`ITALIC`
+`UNDERLINE`
+`COLOR_CODE`
+`UNCOLOR`
+`COLORS`
+
+Availabe colors through the `COLORS` hash:
+
+`:white`
+`:black`
+`:blue`
+`:green`
+`:red`
+`:brown`
+`:purple`
+`:orange`
+`:yellow`
+`:lime`
+`:teal`
+`:cyan`
+`:royal`
+`:pink`
+`:gray`
+`:silver`
+
+### Example:
+    message '#that_cool_channel', "#{Percy::Formatting::COLOR_CODE}#{Percy::Formatting::COLORS[:red]}This is red text.#{Percy::Formatting::UNCOLOR} This is not."
+
+### Example with included Percy::Formatting module:
+    message '#that_cool_channel', "#{COLOR_CODE}#{COLORS[:red]}This is red text.#{UNCOLOR} This is not."
+
 ## License
 Copyright (c) 2009, 2010 Tobias Bühlmann
 

data/VERSION

@@ -1 +1 @@
-1.3.0
+1.4.0

data/examples/github_blog.rb

@@ -3,6 +3,7 @@ require 'nokogiri'
 require 'open-uri'
 require 'percy'
 
+# abbreviated notation without Percy::IRC
 configure do |c|
   c.server    = 'chat.eu.freenode.net'
   c.port      = 6667
@@ -20,7 +21,7 @@ on :channel, /^!quit$/ do
   quit
 end
 
-on :channel, /^blog?$/ do |env|
+on :channel, /^blog\?$/ do |env|
   doc = Nokogiri::HTML(open('http://github.com/blog'))
   title = doc.xpath('//html/body/div/div[2]/div/div/ul/li/h2/a')[0].text
   

data/examples/is_online_checker.rb

@@ -1,7 +1,7 @@
 require 'rubygems'
 require 'percy'
 
-Percy.configure do |c|
+Percy::IRC.configure do |c|
   c.server    = 'chat.eu.freenode.net'
   c.port      = 6667
   c.nick      = 'Percy_onlchk'
@@ -10,24 +10,24 @@ Percy.configure do |c|
   c.reconnect = false
 end
 
-Percy.on :connect do
-  Percy.join '#that_cool_channel'
+Percy::IRC.on :connect do
+  Percy::IRC.join '#that_cool_channel'
 end
 
-Percy.on :channel, /^!quit$/ do
-  Percy.quit
+Percy::IRC.on :channel, /^!quit$/ do
+  Percy::IRC.quit
 end
 
-Percy.on :channel, /^online\?/ do |env|
+Percy::IRC.on :channel, /^online\?/ do |env|
   match = env[:message].split(' ')
   if match.length > 1
-    user = Percy.is_online(match[1])
+    user = Percy::IRC.is_online(match[1])
     if user
-      Percy.message env[:channel], "#{user} is online!"
+      Percy::IRC.message env[:channel], "#{user} is online!"
     else
-      Percy.message env[:channel], "#{user} is not online!"
+      Percy::IRC.message env[:channel], "#{user} is not online!"
     end
   end
 end
 
-Percy.connect
+Percy::IRC.connect

data/lib/percy/connection.rb

@@ -0,0 +1,35 @@
+require 'rubygems'
+require 'eventmachine'
+
+module Percy
+  class Connection < EventMachine::Connection
+    include EventMachine::Protocols::LineText2
+    
+    def connection_completed
+      IRC.raw "NICK #{IRC.config.nick}"
+      IRC.raw "USER #{IRC.config.nick} 0 * :#{IRC.config.username}"
+      IRC.raw "PASS #{IRC.config.password}" if IRC.config.password
+    end
+    
+    def unbind
+      IRC.connected = false
+      IRC.traffic_logger.info('-- Percy disconnected') if IRC.traffic_logger
+      puts "#{Time.now.strftime('%d.%m.%Y %H:%M:%S')} -- Percy disconnected"
+      
+      if IRC.config.reconnect
+        IRC.traffic_logger.info("-- Reconnecting in #{IRC.config.reconnect_interval} seconds") if IRC.traffic_logger
+        puts "#{Time.now.strftime('%d.%m.%Y %H:%M:%S')} -- Reconnecting in #{IRC.config.reconnect_interval} seconds"
+        
+        EventMachine::add_timer(IRC.config.reconnect_interval) do
+          reconnect IRC.config.server, IRC.config.port
+        end
+      else
+        EventMachine::stop_event_loop
+      end
+    end
+    
+    def receive_line(line)
+      IRC.parse line
+    end
+  end
+end

data/lib/percy/formatting.rb

@@ -0,0 +1,28 @@
+module Percy
+  module Formatting
+    PLAIN      = 15.chr
+    BOLD       = 2.chr
+    ITALIC     = 22.chr
+    UNDERLINE  = 31.chr
+    COLOR_CODE = 3.chr
+    UNCOLOR    = COLOR_CODE
+    
+    #mIRC color codes from http://www.mirc.com/help/color.txt
+    COLORS     = {:white       => '00',
+                  :black       => '01',
+                  :blue        => '02',
+                  :green       => '03',
+                  :red         => '04',
+                  :brown       => '05',
+                  :purple      => '06',
+                  :orange      => '07',
+                  :yellow      => '08',
+                  :lime        => '09',
+                  :teal        => '10',
+                  :cyan        => '11',
+                  :royal       => '12',
+                  :pink        => '13',
+                  :gray        => '14',
+                  :silver      => '15'}
+  end
+end