mail_engine 0.0.1

data/.yardoc/checksums

@@ -0,0 +1,17 @@
+lib/mail_engine/generators/create_migration.rb 668a6289313667bb5bd3a4e3bf9a9109fbd8da79
+lib/mail_engine/sendgrid.rb 9ddb5014301ea6c90f51c53a8f491b81d4fe2e13
+lib/mail_engine/version.rb ef61db17982e6fe17b507089a3bc407c2c511669
+lib/mail_engine/base.rb b973fb0c7c6219333f3cd957d62a71ffb021d8fa
+lib/mail_engine/engine.rb 0708eca7318ec379a9a1e1f8a589e9d8d6c7bc46
+lib/mail_engine/action_mailer_patch.rb 243bfccaeb9cd7e5f9fa75894f2260f73be6698d
+lib/mail_engine/generators/create_config.rb 05cbb67778c9094bf60469ccf32401360d599265
+lib/mail_engine/sendgrid/rest_api.rb 7245e928594306c21d9cbf6f8173d06f0f430e7a
+lib/mail_engine/sendgrid/base.rb 3b5a99c4157a654de4f0888a2b8185c80b4e49f7
+lib/mail_engine/configuration.rb bbe48fd2a4c121b95717c97a79dc8cfe7f1f07e0
+lib/mail_engine/zip_processor.rb 042c1ea78c968b0043cebc21de0c2ed0b66635b2
+lib/mail_engine/mail_log_subscriber.rb a2962e2a22b022d364fcf190ee88f20315be5739
+lib/mail_engine/html_document_assets_replacer.rb 4017f6533368b7cec110cc630d7c5235e0d46ebe
+lib/mail_engine/acts_as_mail_receiver.rb a675dbc5dbdb6701bb60753a19033b272a832237
+lib/mail_engine/sendgrid/smtp_api.rb 36e3486fd4df48866b94f8865ade269295a4cabb
+lib/mail_engine/placeholders_in_layout.rb 5047c9952ab86bf201a523a2cf1db3f442f2531c
+lib/mail_engine.rb 32b4284d58e00764358d9005828dcae9bb9c2647

data/Gemfile

@@ -0,0 +1,36 @@
+source "http://rubygems.org"
+
+gem "rails", "3.0.3"
+gem 'mysql'
+gem "liquid", :git => "git://github.com/hlxwell/liquid.git"
+gem "httparty"
+gem 'will_paginate', '~> 3.0.pre2'
+gem "carrierwave"
+gem 'nokogiri'
+gem 'deep_cloneable'
+
+# gem "sqlite3-ruby", :require => "sqlite3"
+# gem "mustache"
+
+# To use debugger (ruby-debug for Ruby 1.8.7+, ruby-debug19 for Ruby 1.9.2+)
+# gem 'ruby-debug'
+# gem 'ruby-debug19'
+
+group :development do
+  gem "yard"
+  gem "bundler"
+  gem "jeweler"
+  gem "rcov"
+  gem "reek"
+end
+
+group :test do
+  gem 'timecop'
+  gem "capybara", ">= 0.4.0"
+  gem "mocha", :require => "mocha"
+  gem "fakeweb"
+  gem "factory_girl", :require => 'factory_girl', :git => "git://github.com/thoughtbot/factory_girl.git"
+  gem "shoulda", :require => 'shoulda'
+  gem 'test_benchmarker'
+  gem "rack-test", :require => "rack/test"
+end

data/Gemfile.lock

@@ -0,0 +1,159 @@
+GIT
+  remote: git://github.com/hlxwell/liquid.git
+  revision: d70ed7582215507a579fee8b5e5b3269600f3fb3
+  specs:
+    liquid (2.2.2)
+
+GIT
+  remote: git://github.com/thoughtbot/factory_girl.git
+  revision: a7f7e85187e9178f4da2db1b87fa38aec6a96178
+  specs:
+    factory_girl (2.0.0.beta1)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    abstract (1.0.0)
+    actionmailer (3.0.3)
+      actionpack (= 3.0.3)
+      mail (~> 2.2.9)
+    actionpack (3.0.3)
+      activemodel (= 3.0.3)
+      activesupport (= 3.0.3)
+      builder (~> 2.1.2)
+      erubis (~> 2.6.6)
+      i18n (~> 0.4)
+      rack (~> 1.2.1)
+      rack-mount (~> 0.6.13)
+      rack-test (~> 0.5.6)
+      tzinfo (~> 0.3.23)
+    activemodel (3.0.3)
+      activesupport (= 3.0.3)
+      builder (~> 2.1.2)
+      i18n (~> 0.4)
+    activerecord (3.0.3)
+      activemodel (= 3.0.3)
+      activesupport (= 3.0.3)
+      arel (~> 2.0.2)
+      tzinfo (~> 0.3.23)
+    activeresource (3.0.3)
+      activemodel (= 3.0.3)
+      activesupport (= 3.0.3)
+    activesupport (3.0.3)
+    arel (2.0.4)
+    builder (2.1.2)
+    capybara (0.4.0)
+      celerity (>= 0.7.9)
+      culerity (>= 0.2.4)
+      mime-types (>= 1.16)
+      nokogiri (>= 1.3.3)
+      rack (>= 1.0.0)
+      rack-test (>= 0.5.4)
+      selenium-webdriver (>= 0.0.27)
+      xpath (~> 0.1.2)
+    carrierwave (0.5.1)
+      activesupport (~> 3.0)
+    celerity (0.8.4)
+    childprocess (0.1.4)
+      ffi (~> 0.6.3)
+    crack (0.1.8)
+    culerity (0.2.12)
+    deep_cloneable (1.2.1)
+    erubis (2.6.6)
+      abstract (>= 1.0.0)
+    fakeweb (1.3.0)
+    ffi (0.6.3)
+      rake (>= 0.8.7)
+    git (1.2.5)
+    httparty (0.6.1)
+      crack (= 0.1.8)
+    i18n (0.4.2)
+    jeweler (1.5.2)
+      bundler (~> 1.0.0)
+      git (>= 1.2.5)
+      rake
+    json_pure (1.4.6)
+    mail (2.2.14)
+      activesupport (>= 2.3.6)
+      i18n (>= 0.4.0)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    mime-types (1.16)
+    mocha (0.9.10)
+      rake
+    mysql (2.8.1)
+    nokogiri (1.4.4)
+    polyglot (0.3.1)
+    rack (1.2.1)
+    rack-mount (0.6.13)
+      rack (>= 1.0.0)
+    rack-test (0.5.7)
+      rack (>= 1.0)
+    rails (3.0.3)
+      actionmailer (= 3.0.3)
+      actionpack (= 3.0.3)
+      activerecord (= 3.0.3)
+      activeresource (= 3.0.3)
+      activesupport (= 3.0.3)
+      bundler (~> 1.0)
+      railties (= 3.0.3)
+    railties (3.0.3)
+      actionpack (= 3.0.3)
+      activesupport (= 3.0.3)
+      rake (>= 0.8.7)
+      thor (~> 0.14.4)
+    rake (0.8.7)
+    rcov (0.9.9)
+    reek (1.2.8)
+      ruby2ruby (~> 1.2)
+      ruby_parser (~> 2.0)
+      sexp_processor (~> 3.0)
+    ruby2ruby (1.2.5)
+      ruby_parser (~> 2.0)
+      sexp_processor (~> 3.0)
+    ruby_parser (2.0.6)
+      sexp_processor (~> 3.0)
+    rubyzip (0.9.4)
+    selenium-webdriver (0.1.0)
+      childprocess (= 0.1.4)
+      ffi (~> 0.6.3)
+      json_pure
+      rubyzip
+    sexp_processor (3.0.5)
+    shoulda (2.11.3)
+    test_benchmarker (1.2.1)
+    thor (0.14.6)
+    timecop (0.3.5)
+    treetop (1.4.9)
+      polyglot (>= 0.3.1)
+    tzinfo (0.3.23)
+    will_paginate (3.0.pre2)
+    xpath (0.1.2)
+      nokogiri (~> 1.3)
+    yard (0.6.4)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler
+  capybara (>= 0.4.0)
+  carrierwave
+  deep_cloneable
+  factory_girl!
+  fakeweb
+  httparty
+  jeweler
+  liquid!
+  mocha
+  mysql
+  nokogiri
+  rack-test
+  rails (= 3.0.3)
+  rcov
+  reek
+  shoulda
+  test_benchmarker
+  timecop
+  will_paginate (~> 3.0.pre2)
+  yard

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2011 YOURNAME
+
+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.mkd

@@ -0,0 +1,152 @@
+Why Mail Engine
+===============
+1. Don't need to export and import your system data to any other mail systems(like mailchimp, mad_mimi).
+2. Allow user to edit all email templates directly in system admin, save the time of developer to participate in.
+3. Allow user to add mail sending schedule directly in system admin, don't need developer to add
+them into code or deploy crontab at server each time when client have new request.
+4. Fully take advantage of the convenience of loading any system data to mail template. In the past,
+like using mailchimp, you have to store everything into user list, then you are able to load that into
+mail template, it increased the complexity of maintaining information in another system.
+5. If you want to trace your mail, like open rate, click rate and unsubscribe rate, we provide Sendgrid
+integration configuration to take advantage that system. (More information at http://sendgrid.com)
+6. Allow logging all sent mails, you can check which mail been sent to which user.
+7. You can know send the email to the active users, so that you don't need to waste your credits of sendgrid or amazon.
+
+Problem when using third part mail system
+=========================================
+We are using mailchimp mostly for the newsletter solution, but it's has many problems that we have to make a new mail engine
+to fit our needs in real project:
+
+1. It is only one newsletter or marketing mail solution, so for system mail, it can do nothing, so for system mail we still go the original way (put them in the rails project.)
+2. Mailchimp don't support other encode for mail, when sending japanese or chinese mail it will be failed.
+3. It doesn't support localization, so different language is different campaign, you need to set a lot config for each of them.
+4. Manage user list is awkward, it even can't create list by API, so you have to create list one by one by hand.
+5. It can't load other user personal or customized data from system into mail, like latest unchecked news or messages, it's very limited to load info from user list record.
+6. It doesn't support reusable partials, which like you hope to put a fixed content of footer or header.
+7. It doesn't support recurring mail sending.
+
+Installation
+============
+** Step 1: **
+
+    gem install mail_engine
+
+** Step 2: **
+
+Add below line to the crontab list of your sever:
+
+    ### check mail schedule for every 15 minutes ###
+    */4 * * * * sh -c "cd /path/to/your/system && rake mail_engine:sendmail RAILS_ENV=production"
+
+
+Usage
+=====
+** For System Mail: **
+
+Due to the sender of system mail is ActionMailer, so you just need to set template physical store path (e.g. user_mailer/notify)
+as the mailer template load path, system will load it from database. (Notice, database template will
+override your file template.)
+
+Mail Engine use Liquid template engine, so you can read the Liquid Reference at http://www.liquidmarkup.org/
+
+Steps:
+
+1. Just create a template in mail engine.
+
+** For Marketing Mail: **
+
+For normal marketing mails are quite simple in logic, so don't need logic code in the mail template.
+So we provide a mail dispatcher which allows user can send marketing mail only by providing the template and
+select the data pre-defined in system to the mail template, don't need developer to do anything like adding mailer file.
+
+Steps:
+
+1. Create a mail tempate in mail engine.
+2. Create a sending schedule record. (You can specify the users to receive this mail, total sending count,
+sending period, when start to deliver the first mail and load which data into this template, You also can set
+condition for the scheduler, like if no specified data in collection, don't send the mail.)
+
+You also can send mail in your program by using:
+MailEngine::MailDispatcher.{your marketing mail template name}(:to => "Michael he <hlxwell@gmail.com>", :values => {:username => "Michael He"}).deliver
+
+Screenshots
+===========
+
+Dashboard
+---------
+Shows the latest report.
+
+![Dashboard](https://github.com/hlxwell/mail-engine/raw/master/screenshots/dashboard.png "Dashboard")
+
+
+Template Management
+-------------------
+You can manage the template used in your system, including:
+
+1. System mail, has it's own action mailer file.
+2. Marketing mail, simple logic and without it's own action mailer.
+3. Partials, you can reused it in any other templates.
+
+![Template Management](https://github.com/hlxwell/mail-engine/raw/master/screenshots/templates.png "Template Management")
+
+
+Template editing Page
+---------------------
+You can see here are many details you can change:
+
+1. Template Path, system action mailer can find it when lookup mail template.
+2. Locale
+3. Format
+4. Layout
+5. Files will used in the template.
+6. Zip File when you used at creating this template.
+7. Preview template in time.
+
+![Template editing Preview](https://github.com/hlxwell/mail-engine/raw/master/screenshots/editing_mail_template.png "Template editing Preview")
+
+
+Upload html template with image in a zip file
+---------------------------------------------
+You can create a template by uplaoding a zip file including one html and other images or css files.
+
+![Upload html template with image in a zip file.")](https://github.com/hlxwell/mail-engine/raw/master/screenshots/new_by_upload.png "Upload html template with image in a zip file.")
+
+
+Partial and Layout selection
+----------------------------
+![Partial and Layout selection](https://github.com/hlxwell/mail-engine/raw/master/screenshots/select_layout_partial.png "Partial and Layout selection")
+
+
+Mail Schedule
+-------------
+You can set a mail sending schedule, here are some useful setting items:
+
+1. Marketing Mail Template.
+2. User Group will be received this mail.
+3. Total send count.
+4. Already send count.
+5. Sending Period.
+6. Payloads which load from user model and send to template when sending.
+7. First send date time, this date will indicate when this mail will be send first time, and according to the seding period it will resend at the same time after one period.
+8. You can set requirements, which been predefined in the system, let the mail not been sent if the requirements is unreached.
+
+![Mail Schedule](https://github.com/hlxwell/mail-engine/raw/master/screenshots/schedule.png "Mail Schedule")
+
+
+Mail Logs
+---------
+It will log all mails' content been sent, you can turn it off in config file.
+
+![Mail Logs](https://github.com/hlxwell/mail-engine/raw/master/screenshots/logs.png "Mail Logs")
+
+
+Report
+------
+Shows detail chart and data list of mail sending stats.
+
+![Report](https://github.com/hlxwell/mail-engine/raw/master/screenshots/reports.png "Report")
+
+
+Bounce Report
+-------------
+![Bounce Report](https://github.com/hlxwell/mail-engine/raw/master/screenshots/bounce_report.png "Bounce Report")

data/Rakefile

@@ -0,0 +1,57 @@
+# encoding: UTF-8
+require 'rubygems'
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rake'
+require 'rake/rdoctask'
+require 'rake/testtask'
+
+# jeweler
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "mail_engine"
+  gem.homepage = "http://github.com/hlxwell/mail-engine"
+  gem.license = "MIT"
+  gem.summary = %Q{Mail Management Solution}
+  gem.description = %Q{Rails system mail management solution.}
+  gem.email = "hlxwell@gmail.com"
+  gem.authors = ["michael he"]
+  # Include your dependencies below. Runtime dependencies are required when using your gem,
+  # and development dependencies are only needed for development (ie running rake tasks, tests, etc)
+  #  gem.add_runtime_dependency 'jabber4r', '> 0.1'
+  #  gem.add_development_dependency 'rspec', '> 1.2.3'
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+# Rcov
+require 'rcov/rcovtask'
+Rcov::RcovTask.new do |test|
+  test.libs << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+# Reek tasks
+require 'reek/rake/task'
+Reek::Rake::Task.new do |t|
+  t.fail_on_error = true
+  t.verbose = false
+  t.source_files = 'lib/**/*.rb'
+end
+
+# test tasks
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib' << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+task :default => :test
+
+# yard tasks
+require 'yard'
+YARD::Rake::YardocTask.new

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/app/controllers/mail_engine/application_controller.rb

@@ -0,0 +1,7 @@
+class MailEngine::ApplicationController < ActionController::Base
+  prepend_view_path MailEngine::MailTemplate::Resolver.instance
+
+  layout 'mail_engine/mail_engine'
+  include MailEngine
+  helper MailEngine::MailEngineHelper
+end

data/app/controllers/mail_engine/dashboard_controller.rb

@@ -0,0 +1,9 @@
+class MailEngine::DashboardController < MailEngine::ApplicationController
+  def index
+    @pie_chart_columns = ["bounces", "unique_opens", "spamreports", "blocks", "unopened"]
+
+    @stats_data = MailEngine::Sendgrid::RestApi.stats(:days => 6)
+    @data_of_today = @stats_data.last
+    @data_of_today.merge!("unopened" => (@data_of_today["delivered"].to_i - @data_of_today["unique_opens"].to_i))
+  end
+end

data/app/controllers/mail_engine/mail_logs_controller.rb

@@ -0,0 +1,20 @@
+class MailEngine::MailLogsController < MailEngine::ApplicationController
+  before_filter :find_model
+
+  def index
+    @mail_logs = MailLog.order("created_at desc").paginate :page => params[:page], :per_page => 20
+  end
+
+  def show
+  end
+
+  def destroy
+    @mail_log.destroy
+    redirect_to mail_logs_path
+  end
+
+  private
+  def find_model
+    @mail_log = MailLog.find(params[:id]) if params[:id].present?
+  end
+end