catfriend 0.0 → 0.1

data/bin/catfriend

@@ -1 +1,108 @@
 #!/usr/bin/env ruby
+
+# Program for reading IMAP servers and creating desktop notifications when
+# new e-mail arrives.
+#
+# Author:: James Pike (mailto:catfriend@chilon.net)
+# Copyright:: Copyright (c) 2011 James Pike
+# License:: MIT
+module Catfriend
+
+require 'imap'
+require 'net/imap'
+
+# xdg is optional. it outputs to stderr, so i redirect it for a while.
+stderr_bak = $stderr.dup
+$stderr.reopen '/dev/null', 'w'
+begin
+    require 'xdg'
+rescue LoadError ; end
+$stderr = stderr_bak # restore stderr
+
+# Reads a simple configuration format and returns an array of servers.
+def self.parse_config
+    # xdg is optional
+    begin
+        config_file = XDG['CONFIG'].find 'catfriend'
+    rescue NameError ; end
+    config_file ||= "#{ENV['HOME']}/.config/catfriend"
+
+    # for location of certificate file
+    Dir.chdir File.dirname(config_file)
+
+    servers = []
+    current = {}
+    defaults = {}
+
+    File.foreach(config_file) do |line|
+        tokens = line.sub(/#.*/, '').scan(/\S+/)
+
+        # parse tokens so use ugly loop instead of functional loop
+        until tokens.empty?
+            field = tokens.shift
+
+            # obviously assigning it in a loop like this is slow but hey it's
+            # only run-once config and ruby people say DRY a lot.
+            shift_tokens = lambda do
+                if tokens.empty? then
+                    raise ConfigError,
+                        "field #{field} requires parameter"
+                end
+                return tokens.shift
+            end
+
+            case field
+            when "host","imap"
+                # host is deprecated
+                if not current.empty? then
+                    servers << ImapServer.new(current)
+                    current = {}
+                end
+                current[:host] = shift_tokens.call
+            when "notificationTimeout", "errorTimeout", "socketTimeout"
+                # convert from camelCase to camel_case
+                clean_field =
+                    field.gsub(/([a-z])([A-Z])/) { "#{$1}_#{$2.downcase}" }
+                defaults[clean_field] = shift_tokens.call
+            when "checkInterval"
+                shift_tokens.call # deprecated, ignore parameter
+            when "cert_file"
+                cert_file = shift_tokens.call
+                unless File.exists? cert_file
+                    raise ConfigError,
+                          "non-existant SSL certificate `#{cert_file}'" +
+                          ", search path: #{File.dirname(config_file)}/"
+                end
+                current[:cert_file] = cert_file
+            when "mailbox", "id", "user", "password"
+                current[field] = shift_tokens.call
+            when "nossl"
+                current[:no_ssl] = true
+            else
+                raise ConfigError,
+                    "invalid config parameter '#{field}': #{line}"
+            end
+        end
+    end
+
+    servers << ImapServer.new(current) unless current.empty?
+
+    servers
+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
+    begin
+        servers = parse_config
+        servers.each { |s| s.start }
+        servers.each { |s| s.join }
+    rescue ConfigError => e
+        puts "misconfiguration: " + e.message
+    end
+end
+
+end ########################### end module
+
+Catfriend.main

data/lib/imap.rb

@@ -0,0 +1,86 @@
+require 'server'
+
+# This class represents a thread capable of checking and creating
+# notifications for a single mailbox on a single IMAP server.
+class ImapServer
+    include ThreadMixin
+    include AccessorsFromHash
+
+    # Create new IMAP server with optional full configuration hash.
+    # If the hash is not supplied at construction a further call must be
+    # made to #configure before #start is called to start the thread.
+    def initialize(args = nil)
+        configure args if args
+    end
+
+    # Configure all attributes based on hash then make sure this
+    # represents a total valid configuration.
+    def configure args
+        super args
+
+        if not @user
+            raise ConfigError, "imap user not set"
+        end
+        if not @host
+            raise ConfigError, "imap host not set"
+        end
+        if not @password
+            raise ConfigError, "imap password not set"
+        end
+
+        @id = @host unless @id
+    end
+
+    # The id is a token which represents this server when displaying
+    # notifications and is set to the host unless over-ridden by the
+    # configuration file
+    def id ; @id || @host ; end
+
+    # Raise an error related to this particular server.
+    def error message
+        # consider raising notification instead?
+        puts "#{id}: #{message}"
+    end
+
+    # ThreadMixin interface. This connects to the mailserver and then
+    # runs #check_loop to do the e-mail checking if the connection
+    # succeeds.
+    def run
+        # connect and go
+        begin
+            connect
+        rescue OpenSSL::SSL::SSLError
+            error "try providing ssl certificate"
+        rescue Net::IMAP::NoResponseError
+            error "no response to connect, try ssl"
+        else
+            check_loop
+        end
+    end
+
+    # Continually waits for new e-mail raising notifications when new
+    # e-mail arrives or when error conditions happen. This methods only exits
+    # on an unrecoverable error.
+    def check_loop
+        #
+    end
+
+    # Connect to the configured IMAP server.
+    def connect
+        args = nil
+        if not @no_ssl then
+            if @cert_file then
+                args = { :ssl => { :ca_file => @cert_file } }
+            else
+                args = { :ssl => true }
+            end
+        end
+        @imap = Net::IMAP.new(@host, args)
+        @imap.login(@user, @password)
+        puts @imap.select(@mailbox || "INBOX")
+    end
+
+    private :connect, :check_loop, :run, :error
+    attr_writer :host, :password, :id, :user, :no_ssl, :cert_file, :mailbox
+end
+

data/lib/server.rb

@@ -0,0 +1,24 @@
+# Mixin this module and define "run" for a simple runnable/joinable thread
+module ThreadMixin
+    # Call to start a thread running via the start method.
+    def start ; @thread = Thread.new { run } ; end
+
+    # Join thread started with start.
+    def join ; @thread.join ; end
+end
+
+# Mixin to provide #configure which allows all instance variables with write
+# accessors declared to be set from a hash.
+module AccessorsFromHash
+    # Call this to tranfer the hash data to corresponding attributes. Any
+    # hash keys that do not have a corresponding write accessor in the
+    # class are silently ignored.
+    def configure args
+        args.each do |opt, val|
+            instance_variable_set("@#{opt}", val) if respond_to? "#{opt}="
+        end
+    end
+end
+
+# This class is used to signal the user made an error in their configuration.
+class ConfigError < Exception ; end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: catfriend
 version: !ruby/object:Gem::Version
-  version: '0.0'
+  version: '0.1'
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-12-23 00:00:00.000000000 Z
+date: 2011-12-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ruby-libnotify
-  requirement: &23635720 !ruby/object:Gem::Requirement
+  requirement: &9103360 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,8 +21,19 @@ dependencies:
         version: '0.5'
   type: :runtime
   prerelease: false
-  version_requirements: *23635720
-description: Based on libnotify, Does not punish the fearless.
+  version_requirements: *9103360
+- !ruby/object:Gem::Dependency
+  name: xdg
+  requirement: &9102900 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: *9102900
+description: E-mail checker with libnotify desktop notifications.
 email:
 - catfriend@chilon.net
 executables:
@@ -31,9 +42,12 @@ extensions: []
 extra_rdoc_files: []
 files:
 - LICENSE
+- lib/imap.rb
+- lib/server.rb
 - bin/catfriend
-homepage: http://chilon.net/catfriend
-licenses: []
+homepage: https://github.com/nuisanceofcats/catfriend
+licenses:
+- Expat
 post_install_message: 
 rdoc_options: []
 require_paths: