net-irc 0.0.1

data/README

@@ -0,0 +1,92 @@
+
+= net-irc
+
+
+== Description
+
+IRC library. This is mostly conform to RFC1459 but partly not for convenience.
+
+
+== Installation
+
+=== Archive Installation
+
+	rake install
+
+=== Gem Installation
+
+	gem install net-irc
+
+
+== Features/Problems
+
+* IRC client (for bot)
+* IRC server (for gateway to webservices)
+
+== Synopsis
+
+=== Client
+
+	require "net/irc"
+
+	class SimpleClient < Net::IRC::Client
+		def on_privmsg(m)
+			super
+			channel, message = *m
+			if message =~ /Hello/
+				post NOTICE, channel, "Hello!"
+			end
+		end
+	end
+
+Net::IRC::Client manages channel status and the information is set in @channels.
+So, be careful to use @channels instance variable and call super surely.
+
+=== Server
+
+see example/lig.rb
+
+
+== IRC Gateways
+
+There are some gateways connecting to webservices.
+
+* Lingr
+* Twitter
+* Wassr
+
+If you want to run it, type following:
+
+	$ cd `ruby -rubygems -e 'print Gem.searcher.find("net/irc").full_gem_path+"/examples"'`
+
+Lingr:
+	$ sudo gem install pit # for configuration
+	$ ./lig.rb
+
+Twitter:
+	$ ./tig.rb
+
+Wassr:
+	$ ./wig.rb
+
+Run as daemon in default. If you want to help:
+
+	$ ./lig.rb --help
+	Usage: ./lig.rb [opts]
+	
+	
+	Options:
+	    -p, --port [PORT=16669]          listen port number
+	    -h, --host [HOST=localhost]      listen host
+	    -l, --log LOG                    log file
+	    -a, --api_key API_KEY            Your api key on Lingr
+	        --debug                      Enable debug mode
+
+
+== Copyright
+
+This library is based on RICE ( http://arika.org/ruby/rice ) written by akira yamada.
+
+Author::    cho45 <cho45@lowreal.net>
+Copyright:: Copyright (c) 2008 cho45
+License::   Ruby's

data/Rakefile

@@ -0,0 +1,131 @@
+require 'rubygems'
+require "shipit"
+require 'rake'
+require 'rake/clean'
+require 'rake/packagetask'
+require 'rake/gempackagetask'
+require 'rake/rdoctask'
+require 'rake/contrib/rubyforgepublisher'
+require 'rake/contrib/sshpublisher'
+require 'fileutils'
+require 'spec/rake/spectask'
+
+include FileUtils
+
+$LOAD_PATH.unshift "lib"
+require "net/irc"
+
+NAME              = "net-irc"
+AUTHOR            = "cho45"
+EMAIL             = "cho45@lowreal.net"
+DESCRIPTION       = ""
+RUBYFORGE_PROJECT = "lowreal"
+HOMEPATH          = "http://#{RUBYFORGE_PROJECT}.rubyforge.org"
+BIN_FILES         = %w(  )
+VERS              = Net::IRC::VERSION
+
+REV = File.read(".svn/entries")[/committed-rev="(d+)"/, 1] rescue nil
+CLEAN.include ['**/.*.sw?', '*.gem', '.config']
+RDOC_OPTS = [
+	'--title', "#{NAME} documentation",
+	"--charset", "utf-8",
+	"--opname", "index.html",
+	"--line-numbers",
+	"--main", "README",
+	"--inline-source",
+]
+
+task :default => [:spec]
+task :package => [:clean]
+
+Spec::Rake::SpecTask.new do |t|
+	t.spec_opts = ['--options', "spec/spec.opts"]
+	t.spec_files = FileList['spec/*_spec.rb']
+end
+
+spec = Gem::Specification.new do |s|
+	s.name              = NAME
+	s.version           = VERS
+	s.platform          = Gem::Platform::RUBY
+	s.has_rdoc          = true
+	s.extra_rdoc_files  = ["README", "ChangeLog"]
+	s.rdoc_options     += RDOC_OPTS + ['--exclude', '^(examples|extras)/']
+	s.summary           = DESCRIPTION
+	s.description       = DESCRIPTION
+	s.author            = AUTHOR
+	s.email             = EMAIL
+	s.homepage          = HOMEPATH
+	s.executables       = BIN_FILES
+	s.rubyforge_project = RUBYFORGE_PROJECT
+	s.bindir            = "bin"
+	s.require_path      = "lib"
+	s.autorequire       = ""
+
+	#s.add_dependency('activesupport', '>=1.3.1')
+	#s.required_ruby_version = '>= 1.8.2'
+
+	s.files = %w(README ChangeLog Rakefile) +
+		Dir.glob("{bin,doc,test,lib,templates,generator,extras,website,script}/**/*") + 
+		Dir.glob("ext/**/*.{h,c,rb}") +
+		Dir.glob("examples/**/*.rb") +
+		Dir.glob("tools/*.rb")
+
+	s.extensions = FileList["ext/**/extconf.rb"].to_a
+end
+
+Rake::GemPackageTask.new(spec) do |p|
+	p.need_tar = true
+	p.gem_spec = spec
+end
+
+task :install do
+	name = "#{NAME}-#{VERS}.gem"
+	sh %{rake package}
+	sh %{sudo gem install pkg/#{name}}
+end
+
+task :uninstall => [:clean] do
+	sh %{sudo gem uninstall #{NAME}}
+end
+
+
+Rake::RDocTask.new do |rdoc|
+	rdoc.rdoc_dir = 'html'
+	rdoc.options += RDOC_OPTS
+	rdoc.template = "resh"
+	#rdoc.template = "#{ENV['template']}.rb" if ENV['template']
+	if ENV['DOC_FILES']
+		rdoc.rdoc_files.include(ENV['DOC_FILES'].split(/,\s*/))
+	else
+		rdoc.rdoc_files.include('README', 'ChangeLog')
+		rdoc.rdoc_files.include('lib/**/*.rb')
+		rdoc.rdoc_files.include('ext/**/*.c')
+	end
+end
+
+desc "Publish to RubyForge"
+task :rubyforge => [:rdoc, :package] do
+	require 'rubyforge'
+	@local_dir = "html"
+	@host = "cho45@rubyforge.org"
+	@remote_dir = "/var/www/gforge-projects/#{RUBYFORGE_PROJECT}/#{NAME}"
+	sh %{rsync -r --delete --verbose #{@local_dir}/ #{@host}:#{@remote_dir}}
+end
+
+Rake::ShipitTask.new do |s|
+	s.Step.new {
+		system("svn", "up")
+	}.and {}
+	s.Step.new {
+		raise "changelog-with-hatenastar.rb is not found" unless system("which", "changelog-with-hatenastar.rb")
+	}.and {
+		system("changelog-with-hatenastar.rb > ChangeLog")
+	}
+	s.ChangeVersion "lib/net/irc.rb", "VERSION"
+	s.Commit
+	s.Task :clean, :package
+	s.RubyForge
+	s.Tag
+	s.Twitter
+	s.Task :rubyforge
+end

data/examples/lig.rb

@@ -0,0 +1,276 @@
+#!/usr/bin/env ruby
+
+$LOAD_PATH << "lib"
+$LOAD_PATH << "../lib"
+
+require "rubygems"
+
+# http://svn.lingr.com/api/toolkits/ruby/infoteria/api_client.rb
+begin
+	require "api_client"
+rescue LoadError
+	require "net/http"
+	require "uri"
+	File.open("api_client.rb", "w") do |f|
+		f.puts Net::HTTP.get(URI("http://svn.lingr.com/api/toolkits/ruby/infoteria/api_client.rb"))
+	end
+	require "api_client"
+end
+
+require "net/irc"
+require "pit"
+
+
+class LingrIrcGateway < Net::IRC::Server::Session
+	def server_name
+		"lingrgw"
+	end
+
+	def server_version
+		"0.0.0"
+	end
+
+	def initialize(*args)
+		super
+		@channels = {}
+	end
+
+	def on_user(m)
+		super
+		@real, @copts = @real.split(/\s/)
+		@copts ||= []
+
+		log "Hello #{@nick}, this is Lingr IRC Gateway."
+		log "Client Option: #{@copts.join(", ")}"
+		@log.info "Client Option: #{@copts.join(", ")}"
+		@log.info "Client initialization is completed."
+
+		@lingr = Lingr::ApiClient.new(@opts.api_key)
+		@lingr.create_session('human')
+		@lingr.login(@real, @pass)
+		@user_info = @lingr.get_user_info[:response]
+	end
+
+	def on_privmsg(m)
+		target, message = *m.params
+		@lingr.say(@channels[target.downcase][:ticket], message)
+	end
+
+	def on_whois(m)
+		nick = m.params[0]
+		# TODO
+	end
+
+	def on_who(m)
+		channel = m.params[0]
+		info    = @channels[channel.downcase]
+		res = @lingr.get_room_info(info[:chan_id], nil, info[:password])
+		if res[:succeeded]
+			res = res[:response]
+			res["occupants"].each do |o|
+				u_id, o_id, nick = *make_ids(o)
+				post nil, RPL_WHOREPLY, channel, o_id, "lingr.com", "lingr.com", nick, "H", "0 #{o["description"].to_s.gsub(/\s+/, " ")}"
+			end
+			post nil, RPL_ENDOFWHO, channel
+		else
+			log "Maybe gateway don't know password for channel #{channel}. Please part and join."
+		end
+	end
+
+	def on_join(m)
+		channels = m.params[0].split(/\s*,\s*/)
+		password = m.params[1]
+		channels.each do |channel|
+			next if @channels.key? channel.downcase
+			@log.debug "Enter room -> #{channel}"
+			res = @lingr.enter_room(channel.sub(/^#/, ""), @nick, password)
+			if res[:succeeded]
+				res[:response]["password"] = password
+				o_id = res[:response]["occupant_id"]
+				post "#{@nick}!#{o_id}@lingr.com", JOIN, channel
+				create_observer(channel, res[:response])
+			else
+				log "Error: #{(res && rese['error']) ? res[:response]["error"]["message"] : "socket error"}"
+			end
+		end
+	end
+
+	def on_part(m)
+		channel = m.params[0]
+		info = @channels[channel].downcase
+
+		if info
+			info[:observer].kill
+			@lingr.exit_room(info[:ticket])
+			@channels.delete(channel.downcase)
+			post @nick, PART, channel, "Parted"
+		end
+	end
+
+	private
+
+	def create_observer(channel, response)
+		Thread.start(channel, response) do |chan, res|
+			begin
+				post server_name, TOPIC, chan, "#{res["room"]["url"]} #{res["room"]["description"]}"
+				@channels[chan.downcase] = {
+					:ticket   => res["ticket"],
+					:counter  => res["counter"],
+					:o_id     => res["occupant_id"],
+					:chan_id  => res["room"]["id"],
+					:password => res["password"],
+					:hcounter => 0,
+					:observer => Thread.current,
+				}
+				first = true
+				while true
+					info = @channels[chan.downcase]
+					res = @lingr.observe_room info[:ticket], info[:counter]
+					@log.debug "observe_room returned"
+					if res[:succeeded]
+						info[:counter] = res[:response]["counter"] if res[:response]["counter"]
+						(res[:response]["messages"] || []).each do |m|
+							next if m["id"].to_i <= info[:hcounter]
+
+							u_id, o_id, nick = *make_ids(m)
+
+							case m["type"]
+							when "user"
+								if first
+									post nick, NOTICE, chan, m["text"]
+								else
+									post nick, PRIVMSG, chan, m["text"] unless info[:o_id] == o_id
+								end
+							when "private"
+								# TODO
+								post nick, PRIVMSG, chan, "\x01ACTION Sent private: #{m["text"]}\x01" unless info[:o_id] == o_id
+							when "system:enter"
+								post "#{nick}!#{o_id}@lingr.com", JOIN, chan unless nick == @nick
+							when "system:leave"
+								#post "#{nick}!#{o_id}@lingr.com", PART, chan unless nick == @nick
+							when "system:nickname_change"
+								post nick, NOTICE, chan, m["text"]
+							when "system:broadcast"
+								post nil,  NOTICE, chan, m["text"]
+							end
+
+							info[:hcounter] = m["id"].to_i if m["id"]
+						end
+
+						if res["occupants"]
+							res["occupants"].each do |o|
+								# new_roster[o["id"]] = o["nickname"]
+								if o["nickname"]
+									nick = o["nickname"]
+									o_id = m["occupant_id"]
+									post "#{nick}!#{o_id}@lingr.com", JOIN, chan
+								end
+							end
+						end
+					else
+						@log.debug "observe failed : #{res[:response].inspect}"
+						log "Error: #{(res && res['error']) ? res[:response]["error"]["message"] : "socket error"}"
+					end
+					first = false
+				end
+			rescue Exception => e
+				puts e
+				puts e.backtrace
+			end
+		end
+	end
+
+	def log(str)
+		str.gsub!(/\s/, " ")
+		post nil, NOTICE, @nick, str
+	end
+
+	def make_ids(o)
+		u_id = o["user_id"]
+		o_id = o["occupant_id"] || o["id"]
+		nick = o["nickname"].gsub(/\s+/, "") + "^#{u_id || "anon"}"
+		[u_id, o_id, nick]
+	end
+end
+
+
+if __FILE__ == $0
+	require "rubygems"
+	require "optparse"
+	require "pit"
+
+	opts = {
+		:port   => 16669,
+		:host   => "localhost",
+		:debug  => false,
+		:log    => nil,
+		:debug  => false,
+	}
+
+	OptionParser.new do |parser|
+		parser.instance_eval do
+			self.banner  = <<-EOB.gsub(/^\t+/, "")
+				Usage: #{$0} [opts]
+
+			EOB
+
+			separator ""
+
+			separator "Options:"
+			on("-p", "--port [PORT=#{opts[:port]}]", "listen port number") do |port|
+				opts[:port] = port
+			end
+
+			on("-h", "--host [HOST=#{opts[:host]}]", "listen host") do |host|
+				opts[:host] = host
+			end
+
+			on("-l", "--log LOG", "log file") do |log|
+				opts[:log] = log
+			end
+
+			on("-a", "--api_key API_KEY", "Your api key on Lingr") do |key|
+				opts[:api_key] = key
+			end
+
+			on("--debug", "Enable debug mode") do |debug|
+				opts[:log]   = $stdout
+				opts[:debug] = true
+			end
+
+			parse!(ARGV)
+		end
+	end
+
+	opts[:logger] = Logger.new(opts[:log], "daily")
+	opts[:logger].level = opts[:debug] ? Logger::DEBUG : Logger::INFO
+
+	def daemonize(debug=false)
+		return yield if $DEBUG || debug
+		Process.fork do
+			Process.setsid
+			Dir.chdir "/"
+			trap("SIGINT")  { exit! 0 }
+			trap("SIGTERM") { exit! 0 }
+			trap("SIGHUP")  { exit! 0 }
+			File.open("/dev/null") {|f|
+				STDIN.reopen  f
+				STDOUT.reopen f
+				STDERR.reopen f
+			}
+			yield
+		end
+		exit! 0
+	end
+
+	opts[:api_key] = Pit.get("lig.rb", :require => {
+		"api_key" => "API key of lingr"
+	})["api_key"] unless opts[:api_key]
+
+	daemonize(opts[:debug]) do
+		Net::IRC::Server.new(opts[:host], opts[:port], LingrIrcGateway, opts).start
+	end
+
+end
+
+