sbfaulkner-net-irc 0.9.1 → 0.9.2

data/README.markdown

@@ -14,7 +14,10 @@ Install the gem(s):
 
 ## Example
 
-See the examples folder for how to use.
+The gem installs the nicl command-line client (pronounced "nickle", as in worth
+about a...). This client is strictly intended as a sample usage of and testbed
+for Net::IRC, and is not meant as an example of how to write a command-line
+client.
 
 ## Legal
 

data/bin/nicl

@@ -0,0 +1,198 @@
+#!/usr/bin/ruby
+#
+# nicl Copyright © 2007-2008 unwwwired.net
+# Created by: S. Brent Faulkner (brentf@unwwwired.net) 2007-08-29
+#
+
+require 'rubygems'
+require 'net/irc'
+
+module Ansi
+  RESET = 0
+  BOLD = 1
+  DIM = 2
+  UNDERSCORE = 4
+  BLINK = 5
+  REVERSE = 7
+  HIDDEN = 8
+  
+  BLACK = 0
+  RED = 1
+  GREEN = 2
+  YELLOW = 3
+  BLUE = 4
+  MAGENTA = 5
+  CYAN = 6
+  WHITE = 7
+  
+  def esc(*attrs)
+    "\033[#{attrs.join(';')}m"
+  end
+  
+  def fg(colour)
+    30 + colour
+  end
+  
+  def bg(colour)
+    40 + colour
+  end
+  
+  def highlight(text, *attrs)
+    "#{esc(*attrs)}#{text}#{esc(RESET)}"
+  end
+end
+
+include Ansi
+
+def prompt(text)
+  print text
+  readline.chomp
+end
+  
+Net::IRC.logger.level = Logger::DEBUG
+Net::IRC.logger.datetime_format = "%Y/%m/%d %H:%M:%S"
+
+Thread.abort_on_exception = true
+
+server = ARGV[0] || "irc.freenode.net"
+port = ARGV[1] || 6667
+user = ARGV[2] || prompt('User: ')
+full_name = ARGV[3] || ARGV[2] || prompt('Full name: ')
+
+Net::IRC.start user, full_name, server, port do |irc|
+  Thread.new do
+    irc.each do |message|
+      case message
+      # TODO: required = VERSION, PING, CLIENTINFO, ACTION
+      # TODO: handle internally... probably true for most CTCP requests
+      when Net::IRC::CTCPVersion
+        irc.ctcp_version(message.source, "net-irc simple-client", Net::IRC::VERSION, PLATFORM, "http://www.github.com/sbfaulkner/net-irc")
+    
+      when Net::IRC::CTCPAction
+        puts "#{highlight(message.source, BOLD, fg(YELLOW))} #{highlight(message.target, BOLD, fg(GREEN))}: #{highlight(message.text, BOLD)}"
+
+      when Net::IRC::CTCPPing
+        irc.ctcp_ping(message.source, message.arg)
+
+      when Net::IRC::CTCPTime
+        irc.ctcp_time(message.source)
+        
+      when Net::IRC::CTCP
+        puts highlight("Unhandled CTCP REQUEST: #{message.class} (#{message.keyword})", BOLD, fg(RED))
+
+      when Net::IRC::Join
+        puts "#{highlight(message.prefix.nickname, BOLD, fg(YELLOW))} joined #{highlight(message.channels.first, BOLD, fg(GREEN))}."
+      
+      when Net::IRC::Part
+        if message.text && ! message.text.empty?
+          puts "#{highlight(message.prefix.nickname, BOLD, fg(YELLOW))} has left #{highlight(message.channels.first, BOLD, fg(GREEN))} (#{message.text})."
+        else
+          puts "#{highlight(message.prefix.nickname, BOLD, fg(YELLOW))} has left #{highlight(message.channels.first, BOLD, fg(GREEN))}."
+        end
+      
+      when Net::IRC::Mode
+        # TODO: handle internally
+        puts highlight("#{message.channel} mode changed #{message.modes}", fg(BLUE))
+        
+      when Net::IRC::Quit
+        if message.text && ! message.text.empty?
+          puts "#{highlight(message.prefix.nickname, BOLD, fg(YELLOW))} has quit (#{message.text})."
+        else
+          puts "#{highlight(message.prefix.nickname, BOLD, fg(YELLOW))} has quit."
+        end
+      
+      when Net::IRC::Notice
+        puts highlight(message.text, fg(CYAN))
+      
+      when Net::IRC::Privmsg
+        puts "#{highlight(message.prefix.nickname, BOLD, fg(YELLOW))} #{highlight(message.target, BOLD, fg(GREEN))}: #{highlight(message.text, BOLD)}"
+      
+      when Net::IRC::Nick
+        puts "#{highlight(message.prefix.nickname, BOLD)} is now #{highlight(message.nickname, BOLD, fg(YELLOW))}"
+        
+      when Net::IRC::ErrNicknameinuse
+        irc.nick message.nickname.sub(/\d*$/) { |n| n.to_i + 1 }
+
+      when Net::IRC::ErrNeedreggednick
+        irc.privmsg('nickserv', 'help')
+        
+      when Net::IRC::Error
+        puts highlight("Unhandled ERROR: #{message.class} (#{message.command})", BOLD, fg(RED))
+      
+      when Net::IRC::RplWelcome, Net::IRC::RplYourhost, Net::IRC::RplCreated
+        puts message.text
+    
+      when Net::IRC::RplLuserclient, Net::IRC::RplLuserme, Net::IRC::RplLocalusers, Net::IRC::RplGlobalusers, Net::IRC::RplStatsconn
+        puts highlight(message.text, fg(BLUE))
+
+      when Net::IRC::RplLuserop, Net::IRC::RplLuserchannels
+        puts highlight("#{message.count} #{message.text}", fg(BLUE))
+      
+      when Net::IRC::RplIsupport
+        # TODO: handle internally... parse into capabilities collection
+      
+      when Net::IRC::RplMyinfo
+      when Net::IRC::RplMotdstart
+
+      when Net::IRC::RplTopic
+        # TODO: handle internally
+        puts "#{highlight(message.channel, BOLD, fg(GREEN))}: #{message.text}"
+
+      when Net::IRC::RplTopicwhotime
+        # TODO: handle internally
+        puts "#{highlight(message.channel, BOLD, fg(GREEN))}: #{message.nickname} #{message.time.strftime("%Y/%m/%d %H:%M:%S")}"
+
+      when Net::IRC::RplNamreply
+        # TODO: handle internally
+        puts "#{highlight(message.channel, BOLD, fg(GREEN))}: #{message.names.join(', ')}"
+      
+      when Net::IRC::RplEndofnames
+        # TODO: handle internally
+
+      when Net::IRC::RplMotd
+        puts message.text.sub(/^- /,'')
+      
+      when Net::IRC::RplEndofmotd
+        puts ""
+    
+      when Net::IRC::Reply
+        puts highlight("Unhandled REPLY: #{message.class} (#{message.command})", BOLD, fg(RED))
+      
+      when Net::IRC::Message
+        puts highlight("Unhandled MESSAGE: #{message.class} (#{message.command})", BOLD, fg(RED))
+      
+      else
+        raise IOError, "unknown class #{message.class}"
+      
+      end
+    end
+  end
+
+  while line = readline
+    scanner = StringScanner.new(line.chomp)
+    if command = scanner.scan(/\/([[:alpha:]]+)\s*/) && scanner[1]
+      case command.upcase
+      when 'JOIN'
+        # TODO: validate arguments... support for password... etc.
+        irc.join scanner.rest
+      
+      when 'MSG'
+        # TODO: validate arguments... support for password... etc.
+        scanner.scan(/(.+)\s+(.*)/)
+        irc.privmsg(scanner[1], scanner[2])
+      when 'PART'
+        # TODO: validate arguments... support for password... etc.
+        irc.part scanner.rest
+        
+      when 'QUIT'
+        break
+      else
+        puts highlight("Unknown COMMAND: #{command}", BOLD, fg(RED))
+      end
+    elsif scanner.scan(/(.+)\s+(.*)/)
+      irc.privmsg(scanner[1], scanner[2])
+    else
+      # TODO: error? need a concept of a current room
+    end
+  end
+end

data/lib/net/irc.rb

@@ -23,7 +23,7 @@ module Net
 
     PORT_DEFAULT = 6667
     
-    VERSION = "0.9.1"
+    VERSION = "0.9.2"
     
     class CTCP
       attr_accessor :source, :target, :keyword, :parameters

data/net-irc.gemspec

@@ -1,7 +1,7 @@
 SPEC = Gem::Specification.new do |s| 
   # identify the gem
   s.name = "net-irc" 
-  s.version = "0.9.1" 
+  s.version = "0.9.2" 
   s.author = "S. Brent Faulkner" 
   s.email = "brentf@unwwwired.net" 
   s.homepage = "http://www.unwwwired.net" 
@@ -9,12 +9,12 @@ SPEC = Gem::Specification.new do |s|
   s.platform = Gem::Platform::RUBY 
   # description of gem
   s.summary = "a ruby implementation of the IRC client protocol"
-  s.files = %w(examples/test.rb lib/net/irc.rb lib/net/rfc2812.yml MIT-LICENSE Rakefile README.markdown net-irc.gemspec)
+  s.files = %w(bin/nicl lib/net/irc.rb lib/net/rfc2812.yml MIT-LICENSE Rakefile README.markdown net-irc.gemspec)
   s.require_path = "lib" 
-  s.autorequire = "irc" 
+  s.autorequire = "net/irc" 
   # s.test_file = "test/net-irc.rb" 
   s.has_rdoc = true 
   s.extra_rdoc_files = ["README.markdown"] 
   # s.add_dependency("fastercsv", ">= 1.2.3") 
-  # s.executables = ["rsql"]
+  s.executables = ["nicl"]
 end 

metadata

@@ -1,11 +1,11 @@
 --- !ruby/object:Gem::Specification 
 name: sbfaulkner-net-irc
 version: !ruby/object:Gem::Version 
-  version: 0.9.1
+  version: 0.9.2
 platform: ruby
 authors: 
 - S. Brent Faulkner
-autorequire: irc
+autorequire: net/irc
 bindir: bin
 cert_chain: []
 
@@ -15,14 +15,14 @@ dependencies: []
 
 description: 
 email: brentf@unwwwired.net
-executables: []
-
+executables: 
+- nicl
 extensions: []
 
 extra_rdoc_files: 
 - README.markdown
 files: 
-- examples/test.rb
+- bin/nicl
 - lib/net/irc.rb
 - lib/net/rfc2812.yml
 - MIT-LICENSE