rb-mailnotify 0.1 → 0.3

data/README.rdoc

@@ -0,0 +1,27 @@
+= rb-mailnotify
+
+== Summary
+
+Two simple tools.
+* riff - a biff like utility to show new mail in all maildir sub-directories of ~/Maildir/
+* mailnotify - an inotify watcher that will send libnotify events for new email in all of ~/Maildir/ (and subdirs)
+
+== Options
+currently only responds to a '-d' or '--debug' to show debug output
+
+
+== Troubleshooting
+If you get an exception the there is no room left on device, run:
+ $> echo 100000 | sudo tee /proc/sys/fs/inotify/max_user_watches
+
+== License
+
+Copyright (c) 2012, Vincent Batts, Raleigh, NC
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+
+Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+

data/bin/mailnotify

@@ -1,21 +1,64 @@
 #!/usr/bin/env ruby
 
+require 'optparse'
+
 require 'rubygems'
 require 'rb-mailnotify'
 
-def main
+$PROGRAM_NAME = "mailnotify"
+DEFAULT_MAILDIR = File.join(ENV["HOME"], "Maildir")
+
+def parse_args(args)
+  options = {
+    :maildir => DEFAULT_MAILDIR,
+    }
+  opts = OptionParser.new do |opts|
+    opts.on("-m MAILDIR", "--maildir", "use alternate maildir directory (default #{DEFAULT_MAILDIR}") do |o|
+      options[:maildir] = o
+    end
+    opts.on("-d", "--debug","enable debugging output") do |o|
+      options[:debug] = o
+    end
+    opts.on("-B","--background", "fork into the background") do |o|
+      options[:background] = o
+    end
+  end
+
+  begin
+    opts.parse!(args)
+  rescue OptionParser::InvalidOption => ex
+    puts ex
+    puts opts
+    abort
+  end
+
+
+  return options
+end
+
+def main(opts)
   # First: build list of maildirs. use 'find' and build that list
-  maildirs = find_maildirs(File.join(ENV["HOME"], "Maildir"))
+  maildirs = find_maildirs(opts[:maildir])
 
   # Second: setup inotify watchers on those directories
   #   if there are new events in the "new" directories,
   #   then trigger the libnotify for that subdir
   notifier = INotify::Notifier.new
+  times = {}
+  wait = 10
   maildirs.each do |mdir|
+    times[mdir] = Time.now # Start off with a timestamp
+
+    # The following block is storing a callback in the notifier
     notifier.watch(File.join(mdir, 'new'), :create, :moved_to) do |path|
-      check_maildir(mdir) do |new_mails|
-        @log.debug("notifying about #{new_mails.length} emails in #{File.basename(mdir)}")
-        notify_new_mail(File.basename(mdir), new_mails.length)
+      if (times[mdir] + wait) < Time.now
+        check_maildir(mdir) do |new_mails,old_mails|
+          @log.debug("notifying about #{new_mails.length} emails in #{File.basename(mdir)}")
+          notify_new_mail(File.basename(mdir), new_mails.length)
+          times[mdir] = Time.now
+        end
+      else
+        @log.debug("too soon, waiting a couple of seconds for the dust to settle")
       end
     end
   end
@@ -28,10 +71,14 @@ def main
   end
 end
 
-if ARGV.include?("-d") or ARGV.include?("--debug")
-  @log.level = Logger::DEBUG
-end
+@options = parse_args(ARGV)
+@log.level = Logger::DEBUG if @options[:debug]
 
-main
+if @options[:background]
+  pid = Kernel.fork { main(@options) }
+  puts "Running in background pid #{pid} ..."
+else
+  main(@options)
+end
 
 # vim:set sw=2 sts=2 et:

data/bin/riff

@@ -8,11 +8,18 @@ def main
   maildirs = find_maildirs(File.join(ENV["HOME"], "Maildir"))
 
   # Second: show the stats
+  total_unread = 0
+  total_dirs = 0
   maildirs.each do |mdir|
-    check_maildir(mdir) do |new_mails|
-      puts "#{File.basename(mdir)}: #{new_mails.length}"
+    check_maildir(mdir) do |new_mails, old_mails|
+      puts "#{File.basename(mdir)}: #{new_mails.length} new, #{old_mails.length} current"
+      if new_mails.length > 0
+        total_unread += new_mails.length
+        total_dirs += 1
+      end
     end
   end
+  puts "Total Unread: #{total_unread} in #{total_dirs} directories"
 end
 
 

data/lib/rb-mailnotify.rb

@@ -1,3 +1,13 @@
+=begin
+Copyright (c) 2012, Vincent Batts, Raleigh, NC
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+
+Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+=end
 
 require 'find'
 require 'logger'
@@ -53,9 +63,11 @@ def check_maildir(path, &block)
   @log.debug(mdir)
 
   new_mail = mdir.list(:new)
+  cur_mail = mdir.list(:cur)
   @log.debug(new_mail)
+  @log.debug(cur_mail)
 
-  yield(new_mail)
+  yield(new_mail,cur_mail)
 
   @log.debug("nil out the vars, for good measure")
   mdir = new_mail = nil

metadata

@@ -1,108 +1,88 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: rb-mailnotify
-version: !ruby/object:Gem::Version 
-  hash: 9
+version: !ruby/object:Gem::Version
+  version: '0.3'
   prerelease: 
-  segments: 
-  - 0
-  - 1
-  version: "0.1"
 platform: ruby
-authors: 
+authors:
 - Vincent Batts
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2012-02-10 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2012-09-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: libnotify
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: &17516420 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: maildir
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: *17516420
+- !ruby/object:Gem::Dependency
+  name: maildir
+  requirement: &17515760 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: rb-inotify
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  version_requirements: *17515760
+- !ruby/object:Gem::Dependency
+  name: rb-inotify
+  requirement: &17515280 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
-  version_requirements: *id003
-description: "mail notification-ish tools "
-email: vbatts@redhat.com
-executables: 
+  prerelease: false
+  version_requirements: *17515280
+description: ! 'mail notification-ish tools '
+email: vbatts@hashbangbash.com
+executables:
 - riff
 - mailnotify
 extensions: []
-
-extra_rdoc_files: []
-
-files: 
+extra_rdoc_files:
+- README.rdoc
+files:
 - bin/riff
 - bin/mailnotify
 - lib/rb-mailnotify.rb
-homepage: 
+- README.rdoc
+homepage: https://github.com/vbatts/rb-mailnotify/
 licenses: []
-
 post_install_message: 
-rdoc_options: []
-
-require_paths: 
+rdoc_options:
+- --main=README.rdoc
+- --line-numbers
+- --inline-source
+- --title=rb-mailnotify 0.3 Documentation
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.8.11
+rubygems_version: 1.8.17
 signing_key: 
 specification_version: 3
 summary: mail notification-ish tools
 test_files: []
-