cinch-imap 0.0.6 → 0.0.7

data/CHANGES.md

@@ -0,0 +1,17 @@
+# CHANGES
+
+## 0.0.7
+- Documentation cleanup
+## 0.0.6
+- Documentation cleanup
+## 0.0.5
+- Fixed bug where polling was interupted because of unknown variable
+## 0.0.4
+- from_rewrites config option added
+- showconfig command added
+## 0.0.3
+- subject_match config option added
+- mark_as_read config option added
+## 0.0.2
+- Initial upload
+

data/README.md

@@ -1,47 +1,42 @@
-" vim:nu:ai:si:et:ts=2:sw=2
-Cinch-Imap 
-==========
+# Cinch-Imap 
+
 The Cinch Imap Plugin. Poll an IMAP mailbox at a defined interval.
 
-Change Log
-----------
-0.0.6
-  * documentation improvements
-0.0.5
-  * bug fixes
-0.0.4 
-  * from_rewrites configuration option added
-  * !monitor showconfig command added
-0.0.3 
-	* Added configurable prefix based on subject match.
-	* Moved "mark messages read" to a configurable option.
+## Required Configuration
 
-Required Configuration
-----------------------
+### :host
+The IMAP server
+### :user
+The user id
+### :password
+The password
 
-	* :host 					- The IMAP server
-	* :user 					- The user id
-	* :password 			- The password
 
-Optional Configuration
-----------------------
+## Optional Configuration
 
-	* :port 					- The IMAP port. Default to 143.
-	* :ssl 					  - Use ssl? Default is false.
-	* :interval 			- Number of seconds between polling. Default is 300.
-	* :mark_as_read		- Sets the IMAP :Seen flag on polled messages. Default is true.
+The IMAP port. Default is 143.
+### :port
+Use SSL? Default is false.
+### :ssl
+Number of seconds between polling. Default is 300.
+### :interval
+Sets the IMAP :Seen flag on polled messages. Default is true.
+### :mark_as_read
 
-Commands
---------
+## Commands
 
-	* !monitor on/off 		- Enable/Disable IMAP polling
-	* !monitor status 		- Issues a status report to the channel
-	* !monitor clear 			- Resets the number of "messages seen" to 0
-	* !monitor interval [n] 	- Set polling interval to n second
-	* !monitor showconfig 	- shows all config options other than password
+Enable/disable IMAP polling
+    !monitor on/off
+Outputs status information to the channel   
+    !monitor status
+Reset the number of messages seen to 0
+    !monitor clear
+Set polling interval in seconds. Default is 300.
+    !monitor interval [n]
+Outputs configuration to channel. The password attribute is skipped.
+    !monitor showconfig
   
-Example Configuration
----------------------
+## Example Configuration
 
 > # mybot.rb
 > require 'cinch'
@@ -74,15 +69,13 @@ Now, run your bot.
 
 >	ruby mybot.rb
 
-WARNING
--------
+## WARNING
 
 When enabled, this plugin will output message sender and subject data to the
 channel. Do not enable this plugin on bots that are connected to public
 channels if your email data is something you consider to meant for your
 eyes only.
 
-TODO
-----
+## TODO
 
-	* Figure out how to auto-start this thing
+- Figure out how to auto-start this thing

data/lib/cinch/plugins/imap.rb

@@ -3,9 +3,10 @@ require 'net/imap'
 module Cinch
 	module Plugins
 		class Imap
-			include Cinch::Plugin
 
-			VERSION='0.0.5'
+			PLUGIN_VERSION='0.0.7'
+
+			include Cinch::Plugin
 
 			match /monitor (on|off)/
 			match /monitor status/, method: :status
@@ -32,7 +33,7 @@ module Cinch
 			end
 
 			def about(m) 
-				m.reply "Looks like I'm on #{VERSION} #{m.user.nick}"
+				m.reply "Looks like I'm on #{PLUGIN_VERSION} #{m.user.nick}"
 			end
 
 			def interval (seconds)

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 0
-  - 6
-  version: 0.0.6
+  - 7
+  version: 0.0.7
 platform: ruby
 authors: 
 - windowsrefund
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-02-02 00:00:00 -05:00
+date: 2011-02-03 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -44,6 +44,7 @@ files:
 - LICENSE
 - gpl.txt
 - README.md
+- CHANGES.md
 - lib/cinch/plugins/imap.rb
 has_rdoc: true
 homepage: