imap_notifier 0.2.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    MDNjNzY3MjU5YjZhMDcyMzY5OWQ5YmQxZTc3ODViNzJmZmM3NzU1MQ==
+  data.tar.gz: !binary |-
+    NWE5YmNiYTdhNzk1Y2I1YjI0YzdlMGQxZmQyYmEzZjEwNDY3ZDdiMw==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    NTNhY2ZlYTdjMTVmNTFiNWI5NjA4NWY0N2E4ZTIzNzgxMGZmYzNiYzE5YmI3
+    ZDhkMTA4ZTA4YmMxZTJmOWQyNDhjMDc1OWE2YTA4MDU4ZTA4Zjc1NWIzYzMw
+    YTcyMTAwNDQ4Y2JmYTgzZWUwMjFhMDJmNzE4MjZlZDgwNWZiMjg=
+  data.tar.gz: !binary |-
+    NmYzN2ZkZDE3MDY4OTUwYTkxYTIzZGRlM2YwYzRjZGM3Y2M3ZjJkNjgwMGNi
+    YjgxNTU5OTFiY2FkMDM3NTQzOTkzZDM0OGZlM2ZmODU0MzBiNjNkYTUzZjE3
+    NWNkMWJiYmYxMjE5YjBkNjlmZDFjOTk1NDVjMzFjY2VjNDA1OTc=

data/.gitignore

@@ -0,0 +1,18 @@
+*~
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,16 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in imap_notifier.gemspec
+gemspec
+
+if `uname`.strip == 'Darwin'
+   if `sw_vers -productVersion`.strip >= '10.8'
+     gem 'terminal-notifier'
+   else
+     gem 'ruby-growl'
+   end
+else
+  raise "You must be running Mac OS X for imap_notifier to work!"
+end
+
+gem 'highline'

data/Gemfile.lock

@@ -0,0 +1,31 @@
+PATH
+  remote: .
+  specs:
+    imap_notifier (0.2.1)
+      highline
+      ruby-growl
+      terminal-notifier
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    highline (1.6.19)
+    macaddr (1.6.1)
+      systemu (~> 2.5.0)
+    rake (10.1.0)
+    ruby-growl (4.0)
+      uuid (~> 2.3, >= 2.3.5)
+    systemu (2.5.2)
+    terminal-notifier (1.4.2)
+    uuid (2.3.7)
+      macaddr (~> 1.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.3)
+  highline
+  imap_notifier!
+  rake
+  terminal-notifier

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 David Campbell
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,46 @@
+IMAP Notifier
+=============
+
+Notification of new, unread email via IMAP using Ruby, [Highline](http://highline.rubyforge.org/doc/), [Net/IMAP](http://ruby-doc.org/stdlib-1.9.3/libdoc/net/imap/rdoc/Net/IMAP.html), and [terminal-notifier](https://github.com/alloy/terminal-notifier)/[ruby-growl](https://github.com/drbrain/ruby-growl).
+
+If you're running Max OSX > 10.8, [terminal-notifier](https://github.com/alloy/terminal-notifier) is required, otherwise [ruby-growl](https://github.com/drbrain/ruby-growl) and [Growl](http://growl.info/) is required.
+
+Setup
+--------
+Configure your .imap_notifier config file in your homedir or specific the flags via the command line.   Your config file must have permissions of 600, thus allowing you to put in your password if you so choose.  The config file is in YAML format and should be read in as a hash.
+
+
+Example ~/.imap_notifier file
+
+    folders:
+     - INBOX
+     - Monitoring
+     - Commits
+     - Team+Status
+    user:  'han.solo'
+    domain: 'example.org'
+    password: "1H@t3BuG$!"
+    max: 10
+
+Usage
+---------
+
+    $ ./bin/imap_notifier   -h
+      Usage: imap_notifier [OPTIONS]
+      Options:
+       -h, --help                      Display this message
+       -V, --version                   Display 'IMAP Notifier 0.2.0' and exit
+       -v, --debug                     Write debug output into /tmp/imap_notifier.debug
+       -f, --file FILE                 Read configuration file. [DEFAULT: ~/.imap_notifier]
+       -s, --server STR                Specify imap server. [Default: imap.gmail.com]
+       -d, --domain STR                Specify email domain. [Default: gmail.com]
+       -u, --user STR                  Specify user login. [Default: ENV['USER']]
+       -m, --max INT                   Max mail mentioned before grouping them together. [Default: 5]
+       -k, --kill                      Kill currently running IMAP Notifier process with SIGINT
+
+
+Tips
+------
+
+* User name is pulled from your environment via ```ruby ENV['USER'] ```
+* If the root domain of your IMAP server is the same as your email domain (i.e. imap._gmail.com_ IS the same as user@_gmail.com_) then you only need to specify the IMAP server.

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/imap_notifier

@@ -0,0 +1,69 @@
+#!/usr/bin/env ruby
+
+$:.unshift File.expand_path('../../lib', __FILE__)
+require 'imap_notifier'
+require 'optparse'
+
+opts = {}
+
+opt_parser = OptionParser.new do |opt|
+  opt.banner   = "Usage: #{opt.program_name} [OPTIONS]"
+  opt.program_name = "IMAP Notifier"
+  opt.separator  "Options:"
+  opt.on('-h', '--help', 'Display this message') do
+    puts opt_parser
+    exit
+  end
+
+  opt.on('-V', '--version', "Display '#{opt.program_name} #{IMAP_Notifier::VERSION}' and exit") do
+    puts opt.program_name << ' ' << IMAP_Notifier::VERSION
+    exit
+  end
+
+  opt.on('-v', '--debug', "Write debug output into #{DEBUGFILE}") do
+    opts[:debug] = true
+  end
+
+  opt.on('-f', '--file FILE', "Read configuration file. [DEFAULT: ~/.imap_notifier]") do |c|
+    opts[:config] = c
+  end
+
+  opt.on('-s','--server STR', "Specify imap server. [Default: #{$imap_server}]") do |s|
+    $imap_server = s
+  end
+
+  opt.on('-d','--domain STR',
+      "Specify email domain. [Default: #{$imap_server.split('.').pop(2).join('.')}]") do |d|
+    opts[:domain] = d.gsub('@','')
+  end
+
+  opt.on('-u','--user STR', "Specify user login. [Default: ENV['USER']]") do |d|
+    opts[:domain] = d.gsub('@','')
+  end
+
+  opt.on('-m','--max INT', "Max mail mentioned before grouping them together. [Default: #{MAX_MAIL}]") do |m|
+    opts[:max] = m.to_i
+  end
+
+  opt.on('-k', '--kill', "Kill currently running #{opt.program_name} process with SIGINT") do
+    begin
+      pid = IO.readlines(PIDFILE).first.to_i
+      puts "Killing PID: #{pid}"
+      Process.kill("SIGINT", pid)
+    rescue Errno::ESRCH, Errno::ENOENT => e
+      puts "#{e.message} - Exiting..."
+    ensure
+      File.delete(PIDFILE) if File.exists?(PIDFILE)
+    end
+    exit
+  end
+end
+
+opt_parser.parse!
+
+if File.exists?(PIDFILE) && IO.readlines(PIDFILE).any?
+  puts "#{PIDFILE} already exists -- Exiting..."
+  exit -1
+end
+
+IMAP_Notifier.new(opts)

data/imap_notifier.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'imap_notifier/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "imap_notifier"
+  spec.version       = IMAP_Notifier::VERSION
+  spec.author        = "David Campbell"
+  spec.email         = "david@mrcampbell.org"
+  spec.description   = %q{Notification of new, unread email via IMAP}
+  spec.summary       = %q{Notification of new, unread email via IMAP using Ruby, Highline, Net/IMAP, and terminal-notifier/ruby-growl.
+
+If you're running Max OSX > 10.8, terminal-notifier is required, otherwise ruby-growl and Growl is required.}
+  spec.homepage      = "https://github.com/dacamp/imap_notifier"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_dependency "highline"
+  spec.add_dependency "ruby-growl"
+  spec.add_dependency "terminal-notifier"
+end

data/lib/imap_notifier/base.rb

@@ -0,0 +1,81 @@
+class IMAP_Notifier
+  def initialize(opts={})
+    config opts
+    @notifier = IMAP_Notifier::Alert.new
+
+    pid = fork do
+      $stderr.reopen(ERRFILE, 'w')
+      if @debug
+        $stdout.reopen(DEBUGFILE, 'w')
+        @notifier.alert("DEBUG MODE ENABLED", "DEBUG LOGFILE: #{DEBUGFILE}")
+      end
+      run
+    end
+    File.open(PIDFILE, 'w') { |f| f.write pid }
+  end
+
+  def imap
+    @imap ||= _imap
+  end
+
+  def run
+    begin
+      @folders.each do |f, ids|
+        imap.examine("#{f}")
+
+        p "Mailbox: #{f}" if @debug
+        unseen          = imap.search(["UNSEEN"])
+        ungrowled       = unseen - ids
+        ungrowled_count = ungrowled.length
+        p "All unseen mail ids: #{unseen}",
+        "All ungrowled mail ids: #{ungrowled}",
+        "Ungrowled count: #{ungrowled_count}" if @debug
+
+        if ungrowled_count > @max_mail
+          p "New Mail in #{f}!",
+          "New: #{ungrowled_count}\nTotal: #{unseen.length}" if @debug
+          @notifier.alert("New Mail in #{f}!", "New: #{ungrowled_count}")
+        else
+          ungrowled.each do |msg_id|
+            msg = imap.fetch(msg_id, "ENVELOPE")[0].attr["ENVELOPE"]
+            next if ids.include?(msg.message_id)
+            p "Growled about #{msg.message_id}" if @debug
+            @notifier.alert("Mail from #{msg.sender.first.mailbox}", "#{msg.subject}")
+          end
+        end
+        @folders[f] = unseen
+      end
+      sleep SLEEP
+    rescue Interrupt
+      @notifier.alert("Goodbye!", '')
+      raise
+    rescue EOFError
+      imap.login(@user, @password)
+    rescue Exception => err
+      p "Class: #{err.class}",
+      "Message: #{err.message}",
+      "See #{ERRFILE} for more info." if @debug
+      @notifier.alert(err.class, err.message)
+
+      warn Time.now
+      warn @user
+      warn $imap_server
+      warn err.class
+      warn err.message
+      err.backtrace.map{ |e| warn e }
+      raise
+    end while true
+  end
+
+  private
+  def get_password(prompt="Enter Password: ")
+    ask(prompt) { |q| q.echo = false }
+  end
+
+  def _imap
+    imap = Net::IMAP.new($imap_server, { :port => 993, :ssl => true } )
+    imap.login(@user, @password)
+    @notifier.alert("User connected to #{@domain}!", "USER: #{@user}")
+    return imap
+  end
+end

data/lib/imap_notifier/config.rb

@@ -0,0 +1,21 @@
+class IMAP_Notifier
+  def config(opts={})
+    file = File.expand_path("~#{opts[:user]}/.imap_notifier")
+    if File.exists? file
+      m =  sprintf("%o", File.stat(file).mode).split('').last(3).join().to_i
+      if m != 600
+        warn "#{file} must have permissions 0644, not #{m}"
+        exit 1
+      end
+      YAML.load(File.open(file)).each do |k,v|
+        opts[k.to_sym] ||= v
+      end
+    end
+    @domain   = opts[:domain] || $imap_server.split('.').pop(2).join('.')
+    @user     = "#{opts[:user] || ENV['USER']}@#{@domain}"
+    @password = opts[:password] || get_password
+    @folders  = Hash[(opts[:folders] || ['INBOX']).map{ |f| [f,Array.new] }]
+    @debug    = opts[:debug] || false
+    @max_mail = opts[:max] || MAX_MAIL
+  end
+end

data/lib/imap_notifier/growler.rb

@@ -0,0 +1,13 @@
+require 'ruby-growl'
+
+class IMAP_Notifier::Alert < Growl
+  def initialize
+    super("localhost", ::IMAP_Notifier::VERSION)
+  end
+
+  def alert(title, body)
+    add_notification ::IMAP_Notifier::VERSION
+    notify ::IMAP_Notifier::VERSION, title, body
+  end
+
+end

data/lib/imap_notifier/notifier.rb

@@ -0,0 +1,9 @@
+require 'terminal-notifier'
+
+class IMAP_Notifier::Alert
+  include TerminalNotifier
+
+  def alert(title,body)
+    notify(body, :title => title)
+  end
+end

data/lib/imap_notifier/version.rb

@@ -0,0 +1,3 @@
+class IMAP_Notifier
+  VERSION='0.2.1'
+end

data/lib/imap_notifier.rb

@@ -0,0 +1,26 @@
+require 'yaml'
+require 'net/imap'
+require 'highline/import'
+
+require 'imap_notifier/version'
+require 'imap_notifier/config'
+require 'imap_notifier/base'
+
+
+MAX_MAIL    = 5 # Max new mails mentioned before they
+                # are grouped together
+SLEEP       = 30
+ERRFILE     = '/tmp/imap_notifier.err'
+DEBUGFILE   = '/tmp/imap_notifier.debug'
+PIDFILE     = '/tmp/imap_notifier.pid'
+$imap_server = "imap.gmail.com" # could be anything with tweaks
+
+if `uname`.strip == 'Darwin'
+  if (OSX_VERSION = `sw_vers -productVersion`.strip) >= '10.8'
+    require 'imap_notifier/notifier'
+  else
+    require 'imap_notifier/growler'
+  end
+else
+  raise "You must be running Mac OS X for imap_notifier to work!"
+end

metadata

@@ -0,0 +1,130 @@
+--- !ruby/object:Gem::Specification
+name: imap_notifier
+version: !ruby/object:Gem::Version
+  version: 0.2.1
+platform: ruby
+authors:
+- David Campbell
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-08-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: highline
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: ruby-growl
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: terminal-notifier
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Notification of new, unread email via IMAP
+email: david@mrcampbell.org
+executables:
+- imap_notifier
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/imap_notifier
+- imap_notifier.gemspec
+- lib/imap_notifier.rb
+- lib/imap_notifier/base.rb
+- lib/imap_notifier/config.rb
+- lib/imap_notifier/growler.rb
+- lib/imap_notifier/notifier.rb
+- lib/imap_notifier/version.rb
+homepage: https://github.com/dacamp/imap_notifier
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.6
+signing_key: 
+specification_version: 4
+summary: Notification of new, unread email via IMAP using Ruby, Highline, Net/IMAP,
+  and terminal-notifier/ruby-growl.  If you're running Max OSX > 10.8, terminal-notifier
+  is required, otherwise ruby-growl and Growl is required.
+test_files: []