catfriend 0.12 → 0.13

data/bin/catfriend

@@ -9,6 +9,7 @@
 require 'catfriend/filetokenstack'
 require 'catfriend/imap'
 require 'net/imap'
+require 'optparse'
 
 module Catfriend
 
@@ -77,14 +78,16 @@ def self.parse_config
             current[field] = shift_tokens.call
         when "nossl"
             current[:no_ssl] = true
+        when "work"
+            current[:work_account] = true
         else
             raise ConfigError,
-                "invalid config parameter '#{field}': #{line}"
+                "invalid config parameter '#{field}'"
         end
     end
 
     servers << ImapServer.new(current) unless current.empty?
-    @@notification_timeout = (defaults["notification_timeout"] or 60).to_i
+    Catfriend.notification_timeout = (defaults["notification_timeout"] or 60).to_i
 
     servers
 end
@@ -92,24 +95,41 @@ end
 # Main interface to the application. Reads all servers from config then runs
 # each one in a thread. The program exits when all threads encounter an
 # unrecoverable error. Perhaps I should make it exit if any thread exits.
-def self.main
+def self.main args
+    work_accounts = false
+    Catfriend.verbose = false
     begin
+        OptionParser.new do |opts|
+            opts.banner = "usage: #{APP_NAME} [options]"
+
+            opts.on("-w", "--work", "enable work accounts") do
+                work_accounts = true
+            end
+            opts.on("-v", "--verbose", "verbose output to console") do
+                Catfriend.verbose = true
+            end
+        end.parse!
+
         servers = parse_config
-    rescue ConfigError => e
-        puts "misconfiguration: #{e.message}"
-    end
+        servers.reject! { |s| s.work_account } unless work_accounts
+        raise ConfigError, "no servers to check" if servers.empty?
 
-    begin
         # todo: daemonize here unless certain command line argument given
         servers.each { |s| s.start }
         servers.each { |s| s.join }
+    rescue ConfigError => e
+        puts "misconfiguration: #{e.message}"
     rescue Interrupt
         servers.each { |s| s.kill }
     rescue => e
         puts "unknown error #{e.message}\n#{e.backtrace.join("\n")}"
+    else
+        return 0
     end
+
+    1
 end
 
 end ########################### end module
 
-Catfriend.main
+exit Catfriend.main ARGV

data/catfriend.example

@@ -1,13 +1,16 @@
-host secure.work.com
-    user      bossman@work.com
-    password  secure
-    nossl # turn off ssl, it is on by default
+# copy to ~/.config/catfriend
 
 host imap.gmail.com
     id        fun  # used instead of host in nofifications when available
     user      friend@gmail.com
     password  faptap
-    cert_file server.pem  # path relative to config file
+    cert_file server.pem  # path relative to config file i.e. ~/.config
+
+host insecure.work.com
+    user      bossman@work.com
+    password  insecure
+    nossl # turn off ssl, it is on by default
+    work  # mark as work account, -w command-line argument enables it
 
 # time notification remains on screen in milliseconds
 notificationTimeout    10000

data/lib/catfriend/imap.rb

@@ -1,5 +1,5 @@
+require 'libnotify'
 require 'catfriend/server'
-require 'catfriend/notify'
 require 'catfriend/thread'
 
 module Catfriend
@@ -72,7 +72,7 @@ class ImapServer
     # on an unrecoverable error.
     def check_loop
         @imap.idle do |r|
-            # puts "#{id}: #{r}" # debug code
+            Catfriend.whisper "#{id}: #{r}"
             next if r.instance_of? Net::IMAP::ContinuationRequest
 
             if r.instance_of? Net::IMAP::UntaggedResponse
@@ -90,7 +90,7 @@ class ImapServer
             end
         end
 
-        # puts "idle loop over" # debug code
+        Catfriend.whisper "idle loop over"
     rescue Net::IMAP::Error, IOError
         # reconnect and carry on
         reconnect unless stopped?
@@ -103,8 +103,8 @@ class ImapServer
     end
 
     def notify_message message
-        @notification.update { |n| n.summary = "#{id}: #{message}" }
-        # puts @notification.summary # debug code
+        @notification.update :summary => "#{id}: #{message}"
+        Catfriend.whisper @notification.summary
     end
 
     def kill
@@ -130,7 +130,7 @@ class ImapServer
 
     def reconnect
         # todo: log an error unless this completes within a short time
-        # puts "#{id}: reconnecting" # debug code
+        Catfriend.whisper "#{id}: reconnecting"
         new_count = connect
         notify_message(new_count) if new_count != @message_count
         @message_count = new_count
@@ -140,7 +140,9 @@ class ImapServer
 
     private :connect, :disconnect, :reconnect,
             :check_loop, :run, :error, :notify_message
+
     attr_writer :host, :password, :id, :user, :no_ssl, :cert_file, :mailbox
+    attr_accessor :work_account
 end
 
 end # end module

data/lib/catfriend/server.rb

@@ -1,7 +1,12 @@
 module Catfriend
 
-def self.notification_timeout
-    @@notification_timeout
+class << self
+    attr_accessor :notification_timeout, :verbose
+
+    # puts something if -v was used
+    def whisper *args
+        puts *args if verbose
+    end
 end
 
 # Mixin to provide #configure which allows all instance variables with write

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: catfriend
 version: !ruby/object:Gem::Version
-  version: '0.12'
+  version: '0.13'
   prerelease: 
 platform: ruby
 authors:
@@ -13,15 +13,15 @@ date: 2012-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: libnotify
-  requirement: &10675900 !ruby/object:Gem::Requirement
+  requirement: &9300880 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: '0.6'
+        version: '0.7'
   type: :runtime
   prerelease: false
-  version_requirements: *10675900
+  version_requirements: *9300880
 description: E-mail checker with libnotify desktop notifications.
 email:
 - catfriend@chilon.net
@@ -33,7 +33,6 @@ files:
 - LICENSE
 - catfriend.example
 - lib/catfriend/server.rb
-- lib/catfriend/notify.rb
 - lib/catfriend/filetokenstack.rb
 - lib/catfriend/thread.rb
 - lib/catfriend/imap.rb

data/lib/catfriend/notify.rb

@@ -1,50 +0,0 @@
-require 'libnotify'
-
-# Patch libnotify to add notification updating support. I have pushed
-# this patch to the libnotify project and it should drop with 0.7
-module Libnotify
-  # Re-open to import notification update.
-  module FFI
-    class << self
-        alias_method :orig_attach_functions!, :attach_functions!
-    end
-    def self.attach_functions!
-      attach_function :notify_notification_update,
-                      [:pointer, :string, :string, :string, :pointer],
-                      :pointer
-      orig_attach_functions!
-    end
-  end
-
-  # Re-open and add update method.
-  class API
-    # Rewrite show to store notification in an instance variable.
-    def show!
-      notify_init(self.class.to_s) or raise "notify_init failed"
-      @notification = notify_notification_new(summary, body, icon_path, nil)
-      notify_notification_set_urgency(@notification, lookup_urgency(urgency))
-      notify_notification_set_timeout(@notification, timeout || -1)
-      if append
-        notify_notification_set_hint_string(@notification, "x-canonical-append", "")
-        notify_notification_set_hint_string(@notification, "append", "")
-      end
-      if transient
-        notify_notification_set_hint_uint32(@notification, "transient", 1)
-      end
-      notify_notification_show(@notification, nil)
-    ensure
-      notify_notification_clear_hints(@notification) if (append || transient)
-    end
-
-    # Updates a previously shown notification.
-    def update(&block)
-      yield(self) if block_given?
-      if @notification
-        notify_notification_update(@notification, summary, body, icon_path, nil)
-        notify_notification_show(@notification, nil)
-      else
-        show!
-      end
-    end
-  end
-end