cinch-imap 0.0.7 → 0.0.8

data/CHANGES.md

@@ -1,4 +1,8 @@
 # CHANGES
+## 0.0.8
+- autostart option added
+- test command added
+- improved status output
 
 ## 0.0.7
 - Documentation cleanup

data/README.md

@@ -14,27 +14,31 @@ The password
 
 ## Optional Configuration
 
-The IMAP port. Default is 143.
 ### :port
-Use SSL? Default is false.
+The IMAP port. Default is 143.
 ### :ssl
-Number of seconds between polling. Default is 300.
+Use SSL? Default is false.
 ### :interval
-Sets the IMAP :Seen flag on polled messages. Default is true.
+Number of seconds between polling. Default is 300.
 ### :mark_as_read
+Sets the IMAP :Seen flag on polled messages. Default is true.
+### :autostart
+The bot will start polling when it joins the channel
 
 ## Commands
 
-Enable/disable IMAP polling
     !monitor on/off
-Outputs status information to the channel   
+Enable/disable IMAP polling
     !monitor status
-Reset the number of messages seen to 0
+Outputs status information to the channel   
     !monitor clear
-Set polling interval in seconds. Default is 300.
+Reset the number of messages seen to 0
     !monitor interval [n]
-Outputs configuration to channel. The password attribute is skipped.
+Set polling interval in seconds. Default is 300.
     !monitor showconfig
+Outputs configuration to channel. The password attribute is skipped.
+	!monitor test
+Poll the IMAP mailbox
   
 ## Example Configuration
 
@@ -49,7 +53,8 @@ Outputs configuration to channel. The password attribute is skipped.
 >     c.channels         = ["#mychannel"]
 >     c.plugins.plugins  = [Cinch::Plugins::Imap]
 > 		c.plugins.options[Cinch::Plugins::Imap] = {
->			  :host => 'my.imapserver.tld',
+		:autostart => true,
+> 		:host => 'my.imapserver.tld',
 >       :user => 'me@fqdn.tld',
 >       :password => "l3tm3out",
 >       :port => 993,
@@ -78,4 +83,3 @@ eyes only.
 
 ## TODO
 
-- Figure out how to auto-start this thing

data/lib/cinch/plugins/imap.rb

@@ -4,11 +4,14 @@ module Cinch
 	module Plugins
 		class Imap
 
-			PLUGIN_VERSION='0.0.7'
+			PLUGIN_VERSION='0.0.8'
 
 			include Cinch::Plugin
 
-			match /monitor (on|off)/
+			listen_to :join
+
+			match /monitor (on|off)/, method: :monitor
+			match /monitor test/, method: :imap_test
 			match /monitor status/, method: :status
 			match /monitor showconfig/, method: :showconfig
 			match /monitor clear/, method: :clear
@@ -30,17 +33,22 @@ module Cinch
 				@from_rewrites = config[:from_rewrites] || {}
 				@messages_seen = 0
 				@started = Time.now
+				@monitor = config[:autostart] || false
 			end
 
 			def about(m) 
 				m.reply "Looks like I'm on #{PLUGIN_VERSION} #{m.user.nick}"
 			end
 
-			def interval (seconds)
-				@interval = seconds
+			def interval(m, seconds)
+				@interval = seconds.to_i
 				@monitor = @interval > 0
 			end
 
+			def monitor(m, option)
+				@monitor = option == "on"
+			end
+
 			def clear
 				@messages_seen = 0
 			end
@@ -56,14 +64,30 @@ module Cinch
 				days = ((now - @started)/(3600 * 24)).to_i
 				hours = ((now - @started)/3600).to_i
 				minutes = ((now - @started)/60).to_i
-				m.reply "Uptime: #{days} days, #{hours}:#{minutes} | Monitor: #{@monitor ? 'enabled' : 'disabled'} | Frequency: #{@interval.to_s} | Messages: #{@messages_seen}"
+				m.reply "Poller: #{@monitor ? 'on' : 'off'} | Uptime: #{days} days, #{hours}:#{minutes} | Interval: #{@interval.to_s} | # Seen: #{@messages_seen}"
 			end
 
 			def usage(m)
 				m.user.send "Usage: !monitor <command>"
-				m.user.send "Commands: on, off, status, clear, interval"
+				m.user.send "Commands: on, off, test, status, clear, interval <seconds>"
 			end
 
+			def imap_test(m)
+				begin
+					imap = imap_connect
+					unseen = imap.search(["UNSEEN"]).length
+					old = imap.search(["NOT", "NEW"]).length
+					m.reply "Old: #{old} Unseen: #{unseen}"
+					imap.disconnect
+				end
+			end
+			def listen(m)
+				background_job do 
+					imap = imap_connect
+					imap_poll(m, imap)
+					imap.disconnect
+				end if (@monitor && m.user == @bot)
+			end
 			def get_messages(conn)
 				conn.search(["UNSEEN"]).each do |message_id|
 					envelope = conn.fetch(message_id, "ENVELOPE")[0].attr["ENVELOPE"]
@@ -77,24 +101,22 @@ module Cinch
 					yield from, subj 
 				end
 			end
-
 			def background_job
 				loop do
 					before = Time.now
 					yield if @monitor
-					interval = @interval - (Time.now - before)
-					sleep(interval) if interval > 0
+					remaining = @interval - (Time.now - before)
+					sleep(remaining) if remaining > 0
 				end
 			end
-
-			def execute(m, option)
-				@monitor = option == "on" 
-
-				background_job do 
-					imap = Net::IMAP.new(@mail_host, @mail_port, @mail_ssl)
-					imap.login(@mail_user, @mail_password)
-					imap.select(@mail_folder)
-					get_messages(imap) do |from, subj| 
+			def imap_connect
+					connection = Net::IMAP.new(@mail_host, @mail_port, @mail_ssl)
+					connection.login(@mail_user, @mail_password)
+					connection.select(@mail_folder)
+					return connection
+			end
+			def imap_poll(m, connection)
+					get_messages(connection) do |from, subj| 
 						message_from, message_prefix = from, nil
 						@from_rewrites.each do |k, v|
 								message_from = "#{v}" if from =~ /#{k}/
@@ -104,8 +126,6 @@ module Cinch
 						end
 						m.reply "#{message_prefix} #{message_from}: #{subj}"
 					end
-					imap.disconnect
-				end if @monitor
 			end
 		end
 	end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 0
-  - 7
-  version: 0.0.7
+  - 8
+  version: 0.0.8
 platform: ruby
 authors: 
 - windowsrefund
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-02-03 00:00:00 -05:00
+date: 2011-02-14 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency