net-irc 0.0.4 → 0.0.5

data/ChangeLog

@@ -1,9 +1,25 @@
+2008-07-06  SATOH Hiroh <cho45@lowreal.net>
+
+	* [interface]:
+		Removed around @channels and separeted to
+		Net::IRC::Client::ChannelManager as just a sample of managing
+		channels.
+	* [release]:
+		Released 0.0.5
+
+2008-07-06 Satoshi Nakagawa <psychs@limechat.net>
+
+	* [new]:
+		Added a mode parser which can be configured automatically from 005 replies.
+
 2008-06-28 cho45
 
 	* [interface]:
 		Change mode character to symbol.
 	* [new]:
 		Seperate each class to some files.
+	* [release]:
+		Released 0.0.4
 
 2008-06-14 cho45
 

data/Rakefile

@@ -18,7 +18,7 @@ require "net/irc"
 NAME              = "net-irc"
 AUTHOR            = "cho45"
 EMAIL             = "cho45@lowreal.net"
-DESCRIPTION       = ""
+DESCRIPTION       = "library for implementing IRC server and client"
 RUBYFORGE_PROJECT = "lowreal"
 HOMEPATH          = "http://#{RUBYFORGE_PROJECT}.rubyforge.org"
 BIN_FILES         = %w(  )

data/examples/nig.rb

@@ -73,6 +73,10 @@ class NowaIrcGateway < TwitterIrcGateway
 	def jabber_bot_id
 		nil
 	end
+
+	def hourly_limit
+		30
+	end
 end
 
 if __FILE__ == $0

data/examples/tig.rb

@@ -8,7 +8,7 @@ Ruby version of TwitterIrcGateway
 
 ## Launch
 
-	$ ruby tig.rb # daemonized
+	$ ruby tig.rb
 
 If you want to help:
 
@@ -23,7 +23,7 @@ Configuration example for Tiarra ( http://coderepos.org/share/wiki/Tiarra ).
 	twitter {
 		host: localhost
 		port: 16668
-		name: username@example.com athack jabber=username@example.com:jabberpasswd tid=10
+		name: username@example.com athack jabber=username@example.com:jabberpasswd tid=10 ratio=32:1 replies=6
 		password: password on Twitter
 		in-encoding: utf8
 		out-encoding: utf8
@@ -34,7 +34,7 @@ Configuration example for Tiarra ( http://coderepos.org/share/wiki/Tiarra ).
 If `athack` client option specified,
 all nick in join message is leading with @.
 
-So if you complemente nicks (ex. Irssi),
+So if you complemente nicks (e.g. Irssi),
 it's good for Twitter like reply command (@nick).
 
 In this case, you will see torrent of join messages after connected,
@@ -61,7 +61,7 @@ Apply id to each message for make favorites by CTCP ACTION.
 	10 => teal
 	11 => lightcyan    cyan aqua
 	12 => lightblue    royal
-	13 => pink         lightpurple  fuchsia
+	13 => pink         lightpurple fuchsia
 	14 => grey
 	15 => lightgrey    silver
 
@@ -72,7 +72,7 @@ If `jabber=<jid>:<pass>` option specified,
 use jabber to get friends timeline.
 
 You must setup im notifing settings in the site and
-install 'xmpp4r-simple' gem.
+install "xmpp4r-simple" gem.
 
 	$ sudo gem install xmpp4r-simple
 
@@ -80,10 +80,15 @@ Be careful for managing password.
 
 ### alwaysim
 
-Use IM instead of any APIs (ex. post)
+Use IM instead of any APIs (e.g. post)
 
+### ratio=<timeline>:<friends>
 
-## Licence
+### replies[=<ratio>]
+
+### checkrls[=<interval seconds>]
+
+## License
 
 Ruby's by cho45
 
@@ -134,6 +139,10 @@ class TwitterIrcGateway < Net::IRC::Server::Session
 		"twitter@twitter.com"
 	end
 
+	def hourly_limit
+		20
+	end
+
 	class ApiFailed < StandardError; end
 
 	def initialize(*args)
@@ -153,13 +162,13 @@ class TwitterIrcGateway < Net::IRC::Server::Session
 
 		@real, *@opts = @opts.name || @real.split(/\s+/)
 		@opts = @opts.inject({}) {|r,i|
-			key, value = i.split(/=/)
+			key, value = i.split("=")
 			r.update(key => value)
 		}
-		@tmap   = TypableMap.new
+		@tmap = TypableMap.new
 
 		if @opts["jabber"]
-			jid, pass = @opts["jabber"].split(/:/, 2)
+			jid, pass = @opts["jabber"].split(":", 2)
 			@opts["jabber"].replace("jabber=#{jid}:********")
 			if jabber_bot_id
 				begin
@@ -167,7 +176,7 @@ class TwitterIrcGateway < Net::IRC::Server::Session
 					start_jabber(jid, pass)
 				rescue LoadError
 					log "Failed to start Jabber."
-					log "Installl 'xmpp4r-simple' gem or check your id/pass."
+					log 'Installl "xmpp4r-simple" gem or check your id/pass.'
 					finish
 				end
 			else
@@ -179,6 +188,32 @@ class TwitterIrcGateway < Net::IRC::Server::Session
 		log "Client Options: #{@opts.inspect}"
 		@log.info "Client Options: #{@opts.inspect}"
 
+		@hourly_limit = hourly_limit
+		@check_rate_limit_thread = Thread.start do
+			loop do
+				begin
+					check_rate_limit
+				rescue ApiFailed => e
+					@log.error e.inspect
+				rescue Exception => e
+					@log.error e.inspect
+					e.backtrace.each do |l|
+						@log.error "\t#{l}"
+					end
+				end
+				sleep @opts["checkrls"] || 3600 # 1 time / hour
+			end
+		end
+		sleep 5
+
+		timeline_ratio, friends_ratio = (@opts["ratio"] || "10:3").split(":").map {|ratio| ratio.to_i }
+		footing = (timeline_ratio + friends_ratio).to_f
+
+		if @opts.key?("replies")
+			replies_ratio ||= (@opts["replies"] || 5).to_i
+			footing += replies_ratio
+		end
+
 		@timeline = []
 		@check_friends_thread = Thread.start do
 			loop do
@@ -192,13 +227,13 @@ class TwitterIrcGateway < Net::IRC::Server::Session
 						@log.error "\t#{l}"
 					end
 				end
-				sleep 10 * 60 # 6 times/hour
+				sleep freq(friends_ratio / footing)
 			end
 		end
-		sleep 3
 
 		return if @opts["jabber"]
 
+		sleep 3
 		@check_timeline_thread = Thread.start do
 			loop do
 				begin
@@ -212,16 +247,37 @@ class TwitterIrcGateway < Net::IRC::Server::Session
 						@log.error "\t#{l}"
 					end
 				end
-				sleep 180 # 20 times/hour
+				sleep freq(timeline_ratio / footing)
+			end
+		end
+
+		return unless @opts.key?("replies")
+
+		sleep 10
+		@check_replies_thread = Thread.start do
+			loop do
+				begin
+					check_replies
+				rescue ApiFailed => e
+					@log.error e.inspect
+				rescue Exception => e
+					@log.error e.inspect
+					e.backtrace.each do |l|
+						@log.error "\t#{l}"
+					end
+				end
+				sleep freq(replies_ratio / footing)
 			end
 		end
 	end
 
 	def on_disconnected
-		@check_friends_thread.kill  rescue nil
-		@check_timeline_thread.kill rescue nil
-		@im_thread.kill             rescue nil
-		@im.disconnect              rescue nil
+		@check_friends_thread.kill    rescue nil
+		@check_replies_thread.kill    rescue nil
+		@check_timeline_thread.kill   rescue nil
+		@check_rate_limit_thread.kill rescue nil
+		@im_thread.kill               rescue nil
+		@im.disconnect                rescue nil
 	end
 
 	def on_privmsg(m)
@@ -241,7 +297,7 @@ class TwitterIrcGateway < Net::IRC::Server::Session
 				# direct message
 				ret = api("direct_messages/new", {"user" => target, "text" => message})
 			end
-			raise ApiFailed, "api failed" unless ret
+			raise ApiFailed, "API failed" unless ret
 			log "Status Updated"
 		rescue => e
 			@log.error [retry_count, e.inspect].inspect
@@ -261,7 +317,7 @@ class TwitterIrcGateway < Net::IRC::Server::Session
 		when "list"
 			nick = args[0]
 			@log.debug([ nick, message ])
-			res = api('statuses/user_timeline', { 'id' => nick }).reverse_each do |s|
+			res = api("statuses/user_timeline", { "id" => nick }).reverse_each do |s|
 				@log.debug(s)
 				post nick, NOTICE, main_channel, "#{generate_status_message(s)}"
 			end
@@ -389,7 +445,7 @@ class TwitterIrcGateway < Net::IRC::Server::Session
 			id = s["id"] || s["rid"]
 			next if id.nil? || @timeline.include?(id)
 			@timeline << id
-			nick = s["user_login_id"] || s["user"]["screen_name"] # it may be better to use user_login_id in Wassr
+			nick = s["user"]["screen_name"]
 			mesg = generate_status_message(s)
 
 			tid = @tmap.push(s)
@@ -420,26 +476,37 @@ class TwitterIrcGateway < Net::IRC::Server::Session
 		mesg = s["text"]
 		@log.debug(mesg)
 
-		# added @user in no use @user reply message ( Wassr only )
-		if s.has_key?('reply_status_url') and s['reply_status_url'] and s['text'] !~ /^@.*/ and %r{([^/]+)/statuses/[^/]+}.match(s['reply_status_url'])
-			reply_user_id = $1
-			mesg = "@#{reply_user_id} #{mesg}"
-		end
-		# display area name(Wassr only)
-		if s.has_key?('areaname') and s["areaname"]
-			mesg += " L: #{s['areaname']}"
-		end
-		# display photo url(Wassr only)
-		if s.has_key?('photo_url') and s["photo_url"]
-			mesg += " #{s['photo_url']}"
-		end
-
 		# time = Time.parse(s["created_at"]) rescue Time.now
 		m = { "&quot;" => "\"", "&lt;"=> "<", "&gt;"=> ">", "&amp;"=> "&", "\n" => " "}
 		mesg.gsub!(/(#{m.keys.join("|")})/) { m[$1] }
 		mesg
 	end
 
+	def check_replies
+		@prev_time_r ||= Time.now
+		api("statuses/replies").reverse_each do |s|
+			id = s["id"] || s["rid"]
+			next if id.nil? || @timeline.include?(id)
+			time = Time.parse(s["created_at"]) rescue next
+			next if time < @prev_time_r
+			@timeline << id
+			nick = s["user_login_id"] || s["user"]["screen_name"]
+			mesg = generate_status_message(s)
+
+			tid = @tmap.push(s)
+
+			@log.debug [id, nick, mesg]
+			if @opts["tid"]
+				message(nick, main_channel, "%s \x03%s [%s]" % [mesg, @opts["tid"], tid])
+			else
+				message(nick, main_channel, "%s" % mesg)
+			end
+		end
+		@log.debug "@timeline.size = #{@timeline.size}"
+		@timeline    = @timeline.last(100)
+		@prev_time_r = Time.now
+	end
+
 	def check_direct_messages
 		@prev_time_d ||= Time.now
 		api("direct_messages", {"since" => @prev_time_d.httpdate}).reverse_each do |s|
@@ -464,7 +531,7 @@ class TwitterIrcGateway < Net::IRC::Server::Session
 			prv_friends = @friends.map {|i| i["screen_name"] }
 			now_friends = friends.map {|i| i["screen_name"] }
 
-			# twitter api bug?
+			# Twitter API bug?
 			return if !first && (now_friends.length - prv_friends.length).abs > 10
 
 			(now_friends - prv_friends).each do |join|
@@ -479,6 +546,23 @@ class TwitterIrcGateway < Net::IRC::Server::Session
 		end
 	end
 
+	def check_rate_limit
+		@log.debug rate_limit = api("account/rate_limit_status")
+		if @hourly_limit != rate_limit["hourly_limit"]
+			log "Rate limit changed: #{@hourly_limit} to #{rate_limit["hourly_limit"]}"
+			@log.info "Rate limit changed: #{@hourly_limit} to #{rate_limit["hourly_limit"]}"
+			@hourly_limit = rate_limit["hourly_limit"]
+		end
+		# rate_limit["remaining_hits"] < 1
+		# rate_limit["reset_time_in_seconds"] - Time.now.to_i
+	end
+
+	def freq(ratio)
+		ret = 3600 / (@hourly_limit * ratio).round
+		@log.debug "Frequency: #{ret}"
+		ret
+	end
+
 	def start_jabber(jid, pass)
 		@log.info "Logging-in with #{jid} -> jabber_bot_id: #{jabber_bot_id}"
 		@im = Jabber::Simple.new(jid, pass)
@@ -490,7 +574,6 @@ class TwitterIrcGateway < Net::IRC::Server::Session
 						@log.debug [msg.from, msg.body]
 						if msg.from.strip == jabber_bot_id
 							# Twitter -> 'id: msg'
-							# Wassr   -> 'nick(id): msg'
 							body = msg.body.sub(/^(.+?)(?:\((.+?)\))?: /, "")
 							if Regexp.last_match
 								nick, id = Regexp.last_match.captures
@@ -531,14 +614,11 @@ class TwitterIrcGateway < Net::IRC::Server::Session
 
 	def api(path, q={})
 		ret     = {}
-		header = {
-			"User-Agent"               => @user_agent,
-			"Authorization"            => "Basic " + ["#{@real}:#{@pass}"].pack("m"),
-#			"X-Twitter-Client"         => api_source,
-#			"X-Twitter-Client-Version" => server_version,
-#			"X-Twitter-Client-URL"     => "http://coderepos.org/share/browser/lang/ruby/misc/tig.rb",
+		headers = {
+			"User-Agent"    => @user_agent,
+			"Authorization" => "Basic " + ["#{@real}:#{@pass}"].pack("m"),
 		}
-		header["If-Modified-Since"]    =  q["since"] if q.key?("since")
+		headers["If-Modified-Since"] = q["since"] if q.key?("since")
 
 		q["source"] ||= api_source
 		q = q.inject([]) {|r,(k,v)| v.inject(r) {|r,i| r << "#{k}=#{URI.escape(i, /[^-.!~*'()\w]/n)}" } }.join("&")
@@ -556,9 +636,9 @@ class TwitterIrcGateway < Net::IRC::Server::Session
 		http.start do
 			case uri.path
 			when "/statuses/update.json", "/direct_messages/new.json"
-				ret = http.post(uri.request_uri, q, header)
+				ret = http.post(uri.request_uri, q, headers)
 			else
-				ret = http.get(uri.request_uri, header)
+				ret = http.get(uri.request_uri, headers)
 			end
 		end
 
@@ -571,7 +651,7 @@ class TwitterIrcGateway < Net::IRC::Server::Session
 			[]
 		when Net::HTTPBadRequest # 400
 			# exceeded the rate limitation
-			raise ApiFailed, "#{ret.code}: #{ret["error"]}"
+			raise ApiFailed, "#{ret.code}: #{ret.message}"
 		else
 			raise ApiFailed, "Server Returned #{ret.code} #{ret.message}"
 		end
@@ -609,14 +689,21 @@ class TwitterIrcGateway < Net::IRC::Server::Session
 	end
 
 	class TypableMap < Hash
-		Roma = "a i u e o k g s z t d n h b p m y r w j v l q".split(/ /).map {|k|
-			%w|a i u e o|.map {|v| "#{k}#{v}" }
+		Roma = %w|k g ky gy s z sh j t d ch n ny h b p hy by py m my y r ry w v q|.unshift("").map {|consonant|
+			case
+			when consonant.size > 1, consonant == "y"
+				%w|a u o|
+			when consonant == "q"
+				%w|a i e o|
+			else
+				%w|a i u e o|
+			end.map {|vowel| "#{consonant}#{vowel}" }
 		}.flatten
 
 		def initialize(size=1)
-			@seq = Roma
-			@map = {}
-			@n   = 0
+			@seq  = Roma
+			@map  = {}
+			@n    = 0
 			@size = size
 		end
 
@@ -663,7 +750,7 @@ if __FILE__ == $0
 
 	OptionParser.new do |parser|
 		parser.instance_eval do
-			self.banner  = <<-EOB.gsub(/^\t+/, "")
+			self.banner = <<-EOB.gsub(/^\t+/, "")
 				Usage: #{$0} [opts]
 
 			EOB
@@ -704,27 +791,27 @@ if __FILE__ == $0
 	opts[:logger] = Logger.new(opts[:log], "daily")
 	opts[:logger].level = opts[:debug] ? Logger::DEBUG : Logger::INFO
 
-	def daemonize(foreground=false)
-		trap("SIGINT")  { exit! 0 }
-		trap("SIGTERM") { exit! 0 }
-		trap("SIGHUP")  { exit! 0 }
-		return yield if $DEBUG || foreground
-		Process.fork do
-			Process.setsid
-			Dir.chdir "/"
-			File.open("/dev/null") {|f|
-				STDIN.reopen  f
-				STDOUT.reopen f
-				STDERR.reopen f
-			}
-			yield
-		end
-		exit! 0
-	end
+#	def daemonize(foreground=false)
+#		trap("SIGINT")  { exit! 0 }
+#		trap("SIGTERM") { exit! 0 }
+#		trap("SIGHUP")  { exit! 0 }
+#		return yield if $DEBUG || foreground
+#		Process.fork do
+#			Process.setsid
+#			Dir.chdir "/"
+#			File.open("/dev/null") {|f|
+#				STDIN.reopen  f
+#				STDOUT.reopen f
+#				STDERR.reopen f
+#			}
+#			yield
+#		end
+#		exit! 0
+#	end
 
-	daemonize(opts[:debug] || opts[:foreground]) do
+#	daemonize(opts[:debug] || opts[:foreground]) do
 		Net::IRC::Server.new(opts[:host], opts[:port], TwitterIrcGateway, opts).start
-	end
+#	end
 end
 
 # Local Variables: