baconmail 0.9.0

data/.gitignore

@@ -0,0 +1,10 @@
+.idea/.name
+.idea/.rakeTasks
+.idea/encodings.xml
+.idea/misc.xml
+.idea/modules.xml
+.idea/scopes/scope_settings.xml
+.idea/src.iml
+.idea/vcs.xml
+.idea/workspace.xml
+.rvmrc

data/Gemfile

@@ -0,0 +1,12 @@
+source "http://rubygems.org"
+
+gem "aws-s3"
+gem "gmail"
+
+group :development do
+  gem "shoulda"
+  gem "bundler"
+  gem "pry"
+end
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,62 @@
+PATH
+  remote: .
+  specs:
+    baconmail (0.9.0)
+      aws-s3
+      gmail (>= 0.4.0)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activesupport (3.2.9)
+      i18n (~> 0.6)
+      multi_json (~> 1.0)
+    aws-s3 (0.6.3)
+      builder
+      mime-types
+      xml-simple
+    builder (3.1.4)
+    coderay (1.0.8)
+    gmail (0.4.0)
+      gmail_xoauth (>= 0.3.0)
+      mail (>= 2.2.1)
+      mime (>= 0.1)
+    gmail_xoauth (0.4.1)
+      oauth (>= 0.3.6)
+    i18n (0.6.1)
+    mail (2.5.2)
+      i18n (>= 0.4.0)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    method_source (0.8.1)
+    mime (0.1)
+    mime-types (1.19)
+    multi_json (1.3.7)
+    oauth (0.4.7)
+    polyglot (0.3.3)
+    pry (0.9.10)
+      coderay (~> 1.0.5)
+      method_source (~> 0.8)
+      slop (~> 3.3.1)
+    shoulda (3.3.2)
+      shoulda-context (~> 1.0.1)
+      shoulda-matchers (~> 1.4.1)
+    shoulda-context (1.0.1)
+    shoulda-matchers (1.4.1)
+      activesupport (>= 3.0.0)
+    slop (3.3.3)
+    treetop (1.4.12)
+      polyglot
+      polyglot (>= 0.3.1)
+    xml-simple (1.1.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  aws-s3
+  baconmail!
+  bundler
+  gmail
+  pry
+  shoulda

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 rodrigo franco (caffo)
+
+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.rdoc

@@ -0,0 +1,66 @@
+= Baconmail
+
+By Rodrigo Franco and Marcos Tapajos
+
+The original {Otherinbox Defender}[http://mashable.com/2008/09/08/otherinbox/] is no more. Sadly, the current version is subpar and do not meet my needs. This project attempts to reproduce the core functionalities of OIB Defender using a GMail account. As of right now, the following functionalities are implemented:
+
+* Emails are automatically labeled by mailbox name
+* First email sent to a new mailbox is forwarded to your personal email address
+* Daily digest sent to your personal email address, with the list of emails received the day before
+* Emails previews can be generated, so you can easily see yesterday messages without login into your baconmail mailbox. (Optional)
+
+== Getting started (Pre-requisites)
+
+* {Create a new google apps account}[http://www.google.com/apps/intl/en/business/index.html] (using a new domain is highly recommended)
+* Setup one email account on it
+* {Configure the email account}[http://www.google.com/support/a/bin/answer.py?hl=en&answer=33962] as catch all. Make sure everything works properly
+* Enable the ‘Hide Read Labels’ labs feature
+* Make sure you disable the ‘Nested Labels’ labs feature – its know to generate performance issues if you have a lot of labels
+* To better replicate the defender concept, disable the spam filter following {this instructions}[http://www.mydigitallife.info/2008/11/24/how-to-disable-and-deactivate-spam-filter-protection-in-gmail-or-google-mail/]
+
+== Setup instructions
+* Install the gem as usual:
+
+    $ gem install baconmail
+
+* Create a .baconmail file in your home directory. It should look like this:
+
+    accounts:
+      - username: caconmail@gmail.com
+        password:  password42
+        email:  personal@email.com
+
+      - username: anotherbaconmail@gmail.com
+        password:  password42!
+        email:  personal2@email.com
+
+    config:
+      use_preview: false
+      bucket: baconmail.amazon.bucket
+      aws_key: KEY-GOES-HERE
+      aws_secret: SECRET-GOES-HERE
+
+* Just one account is required, but you can have more than one if you want.
+* To enable the digest previews, change use_preview to true and enter your AWS credentials (and bucket name).
+
+* Add the following lines to your cron tab:
+
+    */5  * * * * baconmail process
+    55 04 * * * baconmail digest
+
+That will ensure the script organizes your mailbox each 5 minutes. It will also send you the daily digest at 04:55am.
+
+== Contributing to baconmail
+
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2011 rodrigo franco (caffo). See LICENSE.txt for further details.
+

data/Rakefile

@@ -0,0 +1,21 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rake'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+task :default => :spec
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.rcov = true
+end
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "redfinger #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/baconmail.gemspec

@@ -0,0 +1,23 @@
+$:.unshift File.expand_path("../lib", __FILE__)
+require "version"
+
+Gem::Specification.new do |s|
+  s.name             = 'baconmail'
+  s.version          = Baconmail::VERSION
+  s.platform         = Gem::Platform::RUBY
+
+  s.authors          = ["rodrigo franco (caffo)"]
+  s.email            = ['baconmail@caffo.me']
+  s.homepage         = 'http://github.com/caffo/baconmail'
+  s.summary          = 'gmail based otherinbox defender alternative'
+  s.description      = 'The original Otherinbox Defender is no more. Sadly, the newest version is subpar and do not meet my needs. This project attempts to reproduce the core functionalities of OIB Defender using a GMail account.'
+
+  s.files            = `git ls-files`.split("\n")
+  s.executables      = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.extra_rdoc_files = %w[ LICENSE.txt README.rdoc ]
+  s.require_paths    = %w[ lib ]
+
+  s.add_runtime_dependency 'gmail', ">= 0.4.0"
+  s.add_runtime_dependency 'aws-s3'
+end
+

data/bin/baconmail

@@ -0,0 +1,28 @@
+#!/usr/bin/env ruby
+# encoding: UTF-8
+$:.unshift(File.dirname(__FILE__) + '/../lib')
+
+require 'rubygems'
+require 'yaml'
+require 'baconmail'
+
+if ARGV[0]
+  settings  =  YAML::load(File.open("#{ENV['HOME']}/.baconmail"))
+  case ARGV[0]
+  when "process"
+    settings["accounts"].each do |s|
+      Baconmail.process_inbox!(s["username"],
+                                  s["password"],
+                                  s["email"])
+    end
+  when "digest"
+     settings["accounts"].each do |s|
+      Baconmail.daily_digest(s["username"],
+                                s["password"],
+                                s["email"],
+                                settings["config"])
+    end
+  end
+else
+  puts "baconmail [process | digest]"
+end

data/lib/baconmail.rb

@@ -0,0 +1,132 @@
+# encoding: UTF-8
+require 'rubygems'
+require 'gmail'
+require 'logger'
+require 'date'
+require 'digest/sha1'
+require 'aws/s3'
+
+class Baconmail < Object
+  def self.process_inbox!(email_address, password, target_email)
+    log = Logger.new(STDOUT)
+    log.info("Account: #{email_address}")
+    Gmail.new(email_address, password) do |gmail|
+      gmail.inbox.emails(:unread).each do |email|
+        mailbox = email[:to].detect{|mail| mail.host == email_address.split("@").last}.mailbox.downcase rescue "unknown"
+        gmail.labels.new(mailbox)
+        if gmail.mailbox(mailbox).count == 0
+          log.info("First email for [#{gmail.mailbox(mailbox)}], forwarding..")
+          fwd                 = gmail.message
+          fwd.to              = target_email
+          fwd.subject         = "New Sender: #{email.subject}"
+          fwd.content_type    = "text/html"
+          body                = email.parts.last.body.to_s rescue nil
+          body              ||= email.body.to_s
+          fwd.body            = "-------------------------- BACONMAIL ----------------------------------<br/>
+          You have received a message from : #{mailbox}<br/>
+          We have created a new label : #{mailbox}<br/>
+          -------------------------- BACONMAIL ----------------------------------<br/><br/>" + body
+          fwd.deliver!
+        end
+        email.label(mailbox)
+        email.unread!
+        email.archive!
+        log.info("\tProcessing #{email[:subject]}")
+      end
+    end
+    log.info("Process finished")
+  end
+
+  def self.daily_digest(email_address, password, target_email, configs)
+    log         = Logger.new(STDOUT)
+    emails      = []
+    aib_domain  = email_address.split("@")[1]
+
+    log.info("Account: #{email_address}")
+
+    Gmail.new(email_address, password) do |gmail|
+      gmail.mailbox('[Gmail]/All Mail').emails(:on => (Date.today - 1)).each do |email|
+       
+        next if email.subject.match("Daily Digest for") rescue nil
+        next if "#{email.from[0]['mailbox']}@#{email.from[0]['host']}" == email_address
+        
+        mailbox = email[:to][0].mailbox.downcase rescue "unknown"
+        body    = email.html_part.nil? ? email.body : email.html_part.body
+        emails << [mailbox, email.subject, body]
+      end
+
+      if emails.size > 0
+            if configs["use_preview"]
+              log.info("Generating previews...")
+              self.generate_previews(emails, configs, email_address)
+            end
+
+            log.info("Sending daily digest with #{emails.size} entries..")
+            digest                 = gmail.message
+            digest.to              = target_email
+            digest.subject         = "[#{aib_domain}] Bacon Mail for #{(Date.today - 1)}"
+            digest.content_type    = "text/html"
+            digest.body            = self.email_template(emails, aib_domain, configs, email_address)
+            digest.deliver!
+      end
+    end
+    log.info("Process finished")
+  end
+
+  def self.email_template(new_messages, account, configs, email_address)
+      # we all know, inline styles sucks. sadly, it's the
+      # only way to get them into gmail.
+      response = ""
+      response += "<h1 style='margin-left: 40px; color: #DC6582;'>Bacon Mail for #{(Date.today - 1)}</h1>"
+      response += "<h3 style='color: #F59FAC; margin-left: 40px; margin-top: -10px; margin-bottom: 30px;'>for <a href='http://#{account}' style='color: #F59FAC;'>#{account}</a></h3>"
+      response += "<ul style='width: 90%;'>"
+
+      new_messages.sort_by{|x| x[0]}.each do |m|
+        response += "<li style='margin-bottom: 10px; list-style: none; color: #DC6582; border-bottom: 1px dotted #ccc; padding-bottom: 10px; font-weight: bold;'>"
+        response += m[0]
+        response += ": <strong style='color: #000000; font-weight: normal;'>"
+
+        if configs["use_preview"]
+          response += "<a href='http://"
+          response += configs["bucket"]
+          response += ".s3.amazonaws.com/"
+          response += email_address.gsub("@", "_").gsub(".", "_")
+          response += "_"
+          response += Digest::SHA1.hexdigest(m[1])
+          response += ".html' style='color: #000;'>#{m[1]}</a>"
+        else
+          response += m[1]
+        end
+
+        response += "</li>"
+      end
+
+      response += "</ul>"
+      return response
+  end
+
+  def self.generate_previews(new_messages, configs, email_address)
+      AWS::S3::Base.establish_connection!(
+        :access_key_id     => configs["aws_key"],
+        :secret_access_key => configs["aws_secret"]
+      )
+
+      # set file prefix. useful when we have more than one
+      # baconmail account running in the same script instance
+      prefix   = email_address.gsub("@", "_").gsub(".", "_")
+      
+      #binding.pry
+      
+      # cleanup the bucket
+      while (AWS::S3::Bucket.objects(configs["bucket"], :prefix => prefix).size > 0) do
+        AWS::S3::Bucket.objects(configs["bucket"]).each do |file|
+            file.delete if file.key.match(prefix)
+        end
+      end
+      
+      new_messages.sort_by{|x| x[0]}.each do |m|
+        filename = Digest::SHA1.hexdigest(m[1])
+        AWS::S3::S3Object.store("#{prefix}_#{filename}.html", m[2].to_s, configs["bucket"], :access => :public_read)
+      end
+  end
+end

data/lib/version.rb

@@ -0,0 +1,3 @@
+module Baconmail
+  VERSION = "0.9.0"  
+end  

data/test/helper.rb

@@ -0,0 +1,18 @@
+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 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'baconmail'
+
+class Test::Unit::TestCase
+end

data/test/test_baconmail.rb

@@ -0,0 +1,7 @@
+require 'helper'
+
+class TestBaconMail < Test::Unit::TestCase
+  should "probably rename this file and start testing for real" do
+    flunk "hey buddy, you should probably rename this file and start testing for real"
+  end
+end

metadata

@@ -0,0 +1,94 @@
+--- !ruby/object:Gem::Specification
+name: baconmail
+version: !ruby/object:Gem::Version
+  version: 0.9.0
+  prerelease: 
+platform: ruby
+authors:
+- rodrigo franco (caffo)
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-01-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: gmail
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.4.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.4.0
+- !ruby/object:Gem::Dependency
+  name: aws-s3
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: The original Otherinbox Defender is no more. Sadly, the newest version
+  is subpar and do not meet my needs. This project attempts to reproduce the core
+  functionalities of OIB Defender using a GMail account.
+email:
+- baconmail@caffo.me
+executables:
+- baconmail
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.rdoc
+files:
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- baconmail.gemspec
+- bin/baconmail
+- lib/baconmail.rb
+- lib/version.rb
+- test/helper.rb
+- test/test_baconmail.rb
+homepage: http://github.com/caffo/baconmail
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: gmail based otherinbox defender alternative
+test_files: []