bcbiff 0.2.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/Gemfile

@@ -0,0 +1,11 @@
+source "http://rubygems.org"
+
+gem "mail"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.6.4"
+  gem "rcov", ">= 0"
+end

data/Gemfile.lock

@@ -0,0 +1,29 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    git (1.2.5)
+    i18n (0.6.0)
+    jeweler (1.6.4)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+    mail (2.3.0)
+      i18n (>= 0.4.0)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    mime-types (1.16)
+    polyglot (0.3.2)
+    rake (0.9.2)
+    rcov (0.9.10)
+    treetop (1.4.10)
+      polyglot
+      polyglot (>= 0.3.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0.0)
+  jeweler (~> 1.6.4)
+  mail
+  rcov

data/LICENSE.txt

@@ -0,0 +1,24 @@
+Copyright (c) 2011 Akinori MUSHA
+
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions
+are met:
+1. Redistributions of source code must retain the above copyright
+   notice, this list of conditions and the following disclaimer.
+2. 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 AUTHOR 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 AUTHOR 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/README.md

@@ -0,0 +1,103 @@
+# bcbiff
+
+## NAME
+
+`bcbiff(1) - Boxcar based IMAP biff`
+
+## SYNOPSIS
+
+`bcbiff`
+
+## DESCRIPTION
+
+Bcbiff checks the Inbox folder on an IMAP server for unread mails and
+sends a notification mail for each.
+
+This tool was made to send push notification to your iPhone via Boxcar
+when you have received a mail in Inbox on an IMAP server, primarily
+with Gmail in mind.  Bcbiff composes a notification mail that has
+From, Date and Subject header fields copied from the original, with
+other fields and the body part removed.
+
+Simple mail forwarding using a filter on Gmail has a couple of
+problems.  First, there is no easy way to write a filter that only
+matches mails that will be dropping in Inbox.  Second, mail bodies and
+sensitive header fields will be leaked.  Bcbiff solves both.
+
+Bcbiff caches the Message-Id's of the latest 100 unread mails so that
+you get just one notification per mail, even if you leave a mail
+unread despite a notification.
+
+## FILES
+
+* `~/.bcbiff`
+
+    User configuration file that would look like below.
+
+        ---
+        :accounts:
+        - :host: imap.gmail.com
+          :port: 993
+          :ssl: true
+          :username: "account1"
+          :password: "********"
+          :mailto: "******.*******@push.boxcar.io"
+        - :host: imap.gmail.com
+          :port: 993
+          :ssl: true
+          :username: "account2@your.domain"
+          :password: "********"
+          :mailto: "******.*******@push.boxcar.io"
+          :folders:
+          - Inbox
+          - work/important
+
+    You can list as many account entries as you want.  The server
+    needs not be of Gmail, and the mailto address needs not be of
+    Boxcar.
+
+    If you want to check folders other than the default of `Inbox`,
+    specify them in the `:folders` field, in which case you need to
+    specify `Inbox` if you want it checked.
+
+* `~/Maildir/idcache.*.yml`
+
+    Message-Id cache files, one for each notification account.
+
+## USAGE
+
+Prepare your `~/.bcbiff`, adjust constants defined in `bcbiff` for
+your system and run bcbiff once a minute or so.
+
+## REQUIREMENTS
+
+Bcbiff will run with Ruby 1.8.7+ and 1.9.2+.
+
+See `Gemfile` for dependency.  Run `bundle install` to install what's
+missing.
+
+Bcbiff calls the `sendmail` command to send a mail.  Sendmail (or any
+compatible software such as qmail or Postfix) must be properly
+configured.
+
+To use SSL connections, you must have the certificates file/directory
+configured.  Some of the common paths are determined by default, but
+if bcbiff(1) fails to locate the one on your system, follow the
+instruction displayed, and let me know if it's pretty much common on
+the platform.
+
+## SEE ALSO
+
+* [Boxcar](http://boxcar.io/)
+
+* [Gmail](https://mail.google.com/)
+
+## AUTHOR
+
+Copyright (c) 2011 Akinori MUSHA.
+
+Licensed under the 2-clause BSD license.  See `LICENSE.txt` for
+details.
+
+Visit [GitHub Repository](https://github.com/knu/bcbiff) for the
+latest information and feedback.

data/Rakefile

@@ -0,0 +1,65 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  eval File.read('./lib/bcbiff.rb').lines.find { |line|
+    /BCBIFF_VERSION/ =~ line
+  } if !defined?(BCBIFF_VERSION)
+
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "bcbiff"
+  gem.homepage = "http://github.com/knu/bcbiff"
+  gem.license = "2-clause BSDL"
+  gem.summary = %Q{bcbiff(1) - Boxcar based IMAP biff}
+  gem.description = <<-'EOS'
+Bcbiff checks the Inbox folder on an IMAP server for unread mails and
+sends a notification for each.  Ideal for enabling push notification
+for your Gmail account using Boxcar.
+  EOS
+  gem.email = "knu@idaemons.org"
+  gem.authors = ["Akinori MUSHA"]
+  gem.executables = ["bcbiff"]
+  gem.version = BCBIFF_VERSION
+
+  gem.required_ruby_version = Gem::Requirement.new(">= 1.8.7")
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+require 'rcov/rcovtask'
+Rcov::RcovTask.new do |test|
+  test.libs << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+  test.rcov_opts << '--exclude "gems/*"'
+end
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "bcbiff #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/bcbiff.gemspec

@@ -0,0 +1,59 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "bcbiff"
+  s.version = "0.2.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Akinori MUSHA"]
+  s.date = "2011-09-26"
+  s.description = "Bcbiff checks the Inbox folder on an IMAP server for unread mails and\nsends a notification for each.  Ideal for enabling push notification\nfor your Gmail account using Boxcar.\n"
+  s.email = "knu@idaemons.org"
+  s.executables = ["bcbiff"]
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.md"
+  ]
+  s.files = [
+    ".document",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.md",
+    "Rakefile",
+    "bcbiff.gemspec",
+    "bin/bcbiff",
+    "lib/bcbiff.rb"
+  ]
+  s.homepage = "http://github.com/knu/bcbiff"
+  s.licenses = ["2-clause BSDL"]
+  s.require_paths = ["lib"]
+  s.required_ruby_version = Gem::Requirement.new(">= 1.8.7")
+  s.rubygems_version = "1.8.10"
+  s.summary = "bcbiff(1) - Boxcar based IMAP biff"
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<mail>, [">= 0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.6.4"])
+      s.add_development_dependency(%q<rcov>, [">= 0"])
+    else
+      s.add_dependency(%q<mail>, [">= 0"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
+      s.add_dependency(%q<rcov>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<mail>, [">= 0"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
+    s.add_dependency(%q<rcov>, [">= 0"])
+  end
+end
+

data/bin/bcbiff

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+
+begin
+  require 'bcbiff'
+rescue LoadError
+  require 'rubygems'
+  require 'bcbiff'
+end
+
+main(ARGV)

data/lib/bcbiff.rb

@@ -0,0 +1,170 @@
+#!/usr/bin/env ruby
+# -*- mode: ruby; coding: utf-8 -*-
+#
+# bcbiff(1) - Boxcar based IMAP biff
+#
+# Copyright (c) 2011 Akinori MUSHA
+#
+# All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions
+# are met:
+# 1. Redistributions of source code must retain the above copyright
+#    notice, this list of conditions and the following disclaimer.
+# 2. 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 AUTHOR 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 AUTHOR 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.
+
+require 'rubygems'
+require 'net/imap'
+require 'yaml'
+require 'mail'
+require 'shellwords'
+
+BCBIFF_VERSION = '0.2.0'
+
+CERTS_PATHS   = [
+  '/etc/ssl/cert.pem',		# FreeBSD
+  '/etc/ssl/certs',		# Ubuntu
+  '/usr/share/ssl/certs',	# RHEL4
+  '/etc/pki/tls/certs',		# RHEL5
+  '/opt/local/share/curl/curl-ca-bundle.crt',	# OS X; MacPorts
+]
+CERTS_PATH   = CERTS_PATHS.find { |f| File.exist?(f) }
+IDCACHE_FILE = '~/Maildir/idcache.%s.yml'
+IDCACHE_SIZE = 100
+BCBIFF_FILE  = '~/.bcbiff'
+
+def main(argv)
+  accounts = config[:accounts]
+
+  maildir = File.dirname(File.expand_path(IDCACHE_FILE))
+  Dir.mkdir(maildir, 0700) unless File.directory?(maildir)
+
+  if accounts.any? { |account| account[:ssl] } && !certs_path
+    STDERR.print <<-EOS
+The system path for SSL certificates is not found.
+Install SSL certificates in one of the following locations:
+    EOS
+    CERTS_PATHS.each { |path|
+      STDERR.puts "\t#{path}"
+    }
+    STDERR.print <<-EOS if RUBY_PLATFORM =~ /darwin/
+
+If you are on OS X and have MacPorts installed, running the
+following command is an easy way to have one installed:
+\tport install curl-ca-bundle
+    EOS
+    STDERR.print <<-EOS
+
+Otherwise, refer to the following site and place the pem
+file somewhere:
+\thttp://curl.haxx.se/docs/caextract.html
+
+Then add `:certs_path: /path/to/pem` to #{BCBIFF_FILE}.
+    EOS
+    exit 1
+  end
+
+  accounts.each { |options|
+    check_mails(options)
+  }
+end
+
+def config
+  $config ||=
+    begin
+      value = YAML.load_file(File.expand_path(BCBIFF_FILE))
+      raise unless value.is_a?(Hash) && value.key?(:accounts)
+      value
+    end
+rescue
+  STDERR.puts "Put your configuration in #{BCBIFF_FILE} that looks like below.", ''
+  STDERR.print YAML.dump({
+    :accounts => [
+        {
+          :host => 'imap.gmail.com',
+          :port => 993,
+          :ssl  => true,
+          :username => 'your.account',
+          :password => 'password1',
+          :mailto => 'dead.beef@push.boxcar.io',
+        },
+        {
+          :host => 'imap.gmail.com',
+          :port => 993,
+          :ssl  => true,
+          :username => 'you@your.domain',
+          :password => 'password2',
+          :mailto => 'feed.babe@push.boxcar.io',
+          :folders => %w[Inbox work/important],
+        }
+    ]
+  })
+  exit 1
+end
+
+def certs_path
+  $certs_path ||= config[:certs_path] || CERTS_PATH
+end
+
+def check_mails(options)
+  #Net::IMAP.debug = true
+  mailto = options[:mailto]
+  msgids_file = File.expand_path(IDCACHE_FILE % mailto)
+
+  File.open(msgids_file, File::RDWR | File::CREAT, 0600) {|f|
+    f.flock(File::LOCK_EX | File::LOCK_NB) or break
+
+    imap = Net::IMAP.new(options[:host], options[:port], options[:ssl], certs_path, true)
+    imap.login(options[:username], options[:password])
+    folders = options[:folders] || ['Inbox']
+    unseen = folders.inject([]) { |unseen, folder|
+      imap.select(folder)
+      unseen.concat(imap.search('UNSEEN'))
+    }
+    return if unseen.empty?
+
+    msgids = YAML.load(f) || []
+
+    imap.fetch(unseen, item = 'RFC822.HEADER').each { |data|
+      mail = Mail.read_from_string(data.attr[item])
+      msgid = mail.message_id
+      next if msgids.include?(msgid)
+      msgids << msgid
+
+      (header = mail.header).fields.each { |field|
+        case name = field.name
+        when /\A(From|Subject|Date)\z/i
+          # preserve
+        else
+          header[name] = nil
+        end
+      }
+
+      open("| sendmail #{mailto.shellescape}", 'w') { |sendmail|
+        sendmail.print mail.encoded
+      }
+    }
+    msgids.slice!(0...-IDCACHE_SIZE) if msgids.size > IDCACHE_SIZE
+
+    f.rewind
+    f.print YAML.dump(msgids)
+    f.truncate(f.pos)
+  }
+end
+
+main(ARGV) if $0 == __FILE__

metadata

@@ -0,0 +1,139 @@
+--- !ruby/object:Gem::Specification 
+name: bcbiff
+version: !ruby/object:Gem::Version 
+  hash: 23
+  prerelease: 
+  segments: 
+  - 0
+  - 2
+  - 0
+  version: 0.2.0
+platform: ruby
+authors: 
+- Akinori MUSHA
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-09-26 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  version_requirements: *id001
+  name: mail
+  prerelease: false
+  type: :runtime
+- !ruby/object:Gem::Dependency 
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  version_requirements: *id002
+  name: bundler
+  prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency 
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 1
+        - 6
+        - 4
+        version: 1.6.4
+  version_requirements: *id003
+  name: jeweler
+  prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency 
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  version_requirements: *id004
+  name: rcov
+  prerelease: false
+  type: :development
+description: |
+  Bcbiff checks the Inbox folder on an IMAP server for unread mails and
+  sends a notification for each.  Ideal for enabling push notification
+  for your Gmail account using Boxcar.
+
+email: knu@idaemons.org
+executables: 
+- bcbiff
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.md
+files: 
+- .document
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bcbiff.gemspec
+- bin/bcbiff
+- lib/bcbiff.rb
+homepage: http://github.com/knu/bcbiff
+licenses: 
+- 2-clause BSDL
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 57
+      segments: 
+      - 1
+      - 8
+      - 7
+      version: 1.8.7
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: bcbiff(1) - Boxcar based IMAP biff
+test_files: []
+