mail_engine 0.0.1 → 0.1.0

data/README.mkd

@@ -12,7 +12,7 @@ integration configuration to take advantage that system. (More information at ht
 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
+Problem when using third party 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:
@@ -33,6 +33,18 @@ Installation
 
 ** Step 2: **
 
+Add management page needed javascript lib and css files, migration files and mail_engine_config.yml under config directory.
+
+    rails g mail_engine:install
+
+** Step 3: **
+
+Run migration.
+
+    rake db:migrate
+
+** Step 4: **
+
 Add below line to the crontab list of your sever:
 
     ### check mail schedule for every 15 minutes ###
@@ -51,7 +63,7 @@ Mail Engine use Liquid template engine, so you can read the Liquid Reference at
 
 Steps:
 
-1. Just create a template in mail engine.
+1. Create a template in mail engine.
 
 ** For Marketing Mail: **
 

data/VERSION

@@ -1 +1 @@
-0.0.1
+0.1.0

data/app/controllers/mail_engine/application_controller.rb

@@ -4,4 +4,8 @@ class MailEngine::ApplicationController < ActionController::Base
   layout 'mail_engine/mail_engine'
   include MailEngine
   helper MailEngine::MailEngineHelper
+  
+  def close_modal_and_refresh
+    render :text => "<script>parent.$.fancybox.close();parent.window.location.reload();</script>"
+  end
 end

data/app/controllers/mail_engine/mail_logs_controller.rb

@@ -2,7 +2,7 @@ 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
+    @mail_logs = MailLog.order("created_at desc").page(params[:page]).per(20)
   end
 
   def show

data/app/controllers/mail_engine/mail_schedules_controller.rb

@@ -2,7 +2,7 @@ class MailEngine::MailSchedulesController < MailEngine::ApplicationController
   before_filter :find_model
 
   def index
-    @mail_schedules = MailSchedule.paginate :page => params[:page], :per_page => 20
+    @mail_schedules = MailSchedule.order("created_at desc").page(params[:page]).per(20)
   end
 
   def show
@@ -43,10 +43,10 @@ class MailEngine::MailSchedulesController < MailEngine::ApplicationController
   end
 
   def send_test_mail
-    @mail_schedule.send_test_mail_to!(params[:recipient])
-    render :text => "alert('Test Mail sent to #{params[:recipient]}'); $('#recipient').val('');"
+    @mail_schedule.send_test_mail_to!(params[:recipient], params[:sample_user_id])
+    render :text => %Q{alert("Test Mail sent to #{params[:recipient]}"); $('#recipient').val('');}
   rescue => e
-    render :text => "alert('Test Mail failed to send to #{params[:recipient]}, due to #{e.to_s}'); $('#recipient').val('');"
+    render :text => %Q{alert("Test Mail failed to send to #{params[:recipient]}, due to #{e.to_s}"); $('#recipient').val('');}
   end
 
   private

data/app/controllers/mail_engine/mail_template_files_controller.rb

@@ -1,5 +1,5 @@
 class MailEngine::MailTemplateFilesController < MailEngine::ApplicationController
-  layout :false
+  layout "mail_engine/simple"
   before_filter :find_model
 
   def index
@@ -10,9 +10,9 @@ class MailEngine::MailTemplateFilesController < MailEngine::ApplicationControlle
   end
 
   def create
-    @mail_template_file = @mail_template.mail_template_files.new(params[:mail_engine_mail_template_file])
+    @mail_template_file = @mail_template.mail_template_files.build(params[:mail_engine_mail_template_file])
     if @mail_template_file.save
-      redirect_to edit_mail_template_path(@mail_template)
+      close_modal_and_refresh
     else
       render :new
     end
@@ -23,7 +23,7 @@ class MailEngine::MailTemplateFilesController < MailEngine::ApplicationControlle
 
   def update
     if @mail_template_file.update_attributes(params[:mail_engine_mail_template_file])
-      redirect_to edit_mail_template_path(@mail_template)
+      close_modal_and_refresh
     else
       render :edit
     end

data/app/controllers/mail_engine/mail_templates_controller.rb

@@ -14,7 +14,7 @@ class MailEngine::MailTemplatesController < MailEngine::ApplicationController
                         return
                       end
 
-    @mail_templates = @mail_templates.group("path").paginate :page => params[:page], :per_page => 20
+    @mail_templates = @mail_templates.group("path").page(params[:page]).per(20)
   end
 
   def show
@@ -47,14 +47,14 @@ class MailEngine::MailTemplatesController < MailEngine::ApplicationController
     if request.put?
       @duplicated_mail_template = @mail_template.duplicate(params[:mail_engine_mail_template])
       if @duplicated_mail_template.errors.blank?
-        redirect_to mail_templates_path(:type => params[:type])
+        close_modal_and_refresh
         return
       end
     else
       @duplicated_mail_template = @mail_template
     end
 
-    render :layout => false
+    render :layout => "mail_engine/simple"
   end
 
   def destroy
@@ -76,7 +76,12 @@ class MailEngine::MailTemplatesController < MailEngine::ApplicationController
   end
 
   def new
-    @mail_template = MailTemplate.new :layout => 'none'
+    @mail_template = MailTemplate.new :layout => 'none', :partial => params[:type] == 'partial'
+  end
+
+  def get_existed_subject
+    subject = MailTemplate.get_subject_from_bother_template(params[:path], params[:locale], params[:for_marketing] == 'true')
+    render :text => %Q{#{subject}}
   end
 
   def new_by_upload
@@ -118,7 +123,7 @@ class MailEngine::MailTemplatesController < MailEngine::ApplicationController
 
   def update
     if @mail_template.update_attributes(params[:mail_engine_mail_template])
-      redirect_to mail_template_path(@mail_template), :notice => 'Mail template was successfully created.'
+      redirect_to mail_template_path(@mail_template), :notice => 'Mail template was successfully updated.'
     else
       render "edit"
     end
@@ -127,12 +132,12 @@ class MailEngine::MailTemplatesController < MailEngine::ApplicationController
   def edit
   end
 
-  def send_test_mail
-    @mail_template.send_test_mail_to!(params[:recipient])
-    render :text => "alert('Test Mail sent to #{params[:recipient]}'); $('#recipient').val('');"
-  rescue => e
-    render :text => "alert(\"Test Mail failed to send to #{params[:recipient]}, due to #{e.to_s}\"); $('#recipient').val('');"
-  end
+  # def send_test_mail
+  #   @mail_template.send_test_mail_to!(params[:recipient])
+  #   render :text => "alert('Test Mail sent to #{params[:recipient]}'); $('#recipient').val('');"
+  # rescue => e
+  #   render :text => "alert(\"Test Mail failed to send to #{params[:recipient]}, due to #{e.to_s}\"); $('#recipient').val('');"
+  # end
 
   private
   def find_model

data/app/controllers/mail_engine/reports_controller.rb

@@ -18,7 +18,11 @@ class MailEngine::ReportsController < MailEngine::ApplicationController
       "repeat_unsubscribes"
     ]
 
-    @stats_data = MailEngine::Sendgrid::RestApi.stats(:days => 6)
+    @stats_data = if params[:report] and params[:report][:from] and params[:report][:to]
+                    MailEngine::Sendgrid::RestApi.stats(:start_date => params[:report][:from], :end_date => params[:report][:to])
+                  else
+                    MailEngine::Sendgrid::RestApi.stats(:days => 6)
+                  end
     @data_of_today = @stats_data.last
   end
 

data/app/helpers/mail_engine/mail_engine_helper.rb

@@ -2,7 +2,7 @@ module MailEngine
   module MailEngineHelper
 
     def show_no_record collection, &block
-      if collection.blank?
+      if collection.all.blank?
         return raw("<div class='notice' style='margin-top:10px'>No Record</div>")
       else
         block.call

data/app/mailers/mail_engine/mail_dispatcher.rb

@@ -1,7 +1,7 @@
 class MailEngine::MailDispatcher < ActionMailer::Base
   default :from => "info@itjob.fm"
   sendgrid_header do
-    category "itjob_test"
+    category MailEngine::Base.current_config["sendgrid_category"]
 
     filters {
       opentrack "enable" => 1
@@ -14,26 +14,33 @@ class MailEngine::MailDispatcher < ActionMailer::Base
 
   protected
 
+  ###
+  # MailEngine::MailDispatcher.{any template name}(
+  #   :subject => 'hello',
+  #   :to => 'm@theplant.jp',
+  #   :values => {:username => @user.name}
+  # ).deliver
+  #
   def self.method_missing(method, *args)
     return super if respond_to?(method) # basically it won't unless subclass
 
+    options = args.dup.extract_options!
+    options[:locale] ||= I18n.locale
+
     # TODO if template file exists, don't need to exam the db.
-    templates = MailEngine::MailTemplate.where(:path => method).order('format desc').all
+    templates = MailEngine::MailTemplate.where(:path => method, :locale => options[:locale], :for_marketing => true, :partial => false).order('format desc').all
     raise "No Template added." if templates.blank?
 
+    subject = templates.first.subject
     formats = templates.map {|t| "format.#{t.format}" }.sort.reverse
 
-    ###
-    # MailEngine::MailDispatcher.{any template name}(
-    #   :subject => 'hello',
-    #   :to => 'm@theplant.jp',
-    #   :values => {:username => @user.name}
-    # ).deliver
-    #
+    # generate the method for db template.
     class_eval <<-METHOD
       def #{method} options
         ### extract mail options, used for mail method.
         mail_options = {}
+        mail_options[:subject] = "#{%Q{#{subject}}}"
+
         options.delete_if {|key, value|
           if [:subject, :to, :from, :cc, :bcc, :reply_to, :date].include?(key.to_sym)
             mail_options[key] = value

data/app/models/mail_engine/mail_log.rb

@@ -1,4 +1,4 @@
-class MailEngine::MailLog < ActiveRecord::Base
+class MailEngine::MailLog < ActiveRecord::Base  
   validates_presence_of :mail_template_path
 
   # Callback of Mail gem when delivering mails

data/app/models/mail_engine/mail_schedule.rb

@@ -1,9 +1,14 @@
 class MailEngine::MailSchedule < ActiveRecord::Base
   validates_presence_of :name, :user_group, :mail_template_id, :period, :count, :first_send_at
   belongs_to :mail_template
-
   scope :available, where("sent_count < count OR count = 0")
 
+  # list mail log with the same mail_template_path to current mail_template's path
+  def logs(count = 10)
+    MailEngine::MailLog.where(:mail_template_path => self.mail_template.actual_path).order("id desc").limit(count)
+  end
+  
+  # load user info into payload hash used at mail template.
   def load_payload user
     payload_hash = {}
     self.payload.split(",").each do |col|
@@ -12,17 +17,13 @@ class MailEngine::MailSchedule < ActiveRecord::Base
     payload_hash
   end
 
-  def send_test_mail_to!(recipient)
-    # raise "Wrong email format." if recipient.blank? or recipient !~ /^([^@\s]+)@((?:[-a-z0-9]+\.)+[a-z]{2,})$/i
-    sample_user = User.send(self.user_group.to_sym).first
-    raise "Can not find any user in group #{self.user_group}" if sample_user.blank?
+  # send test mail to specific recipient email address, with loading sample_user's data.
+  def send_test_mail_to!(recipient, sample_user_id)
+    raise "Wrong email format." if recipient.blank? or recipient !~ /^([^@\s]+)@((?:[-a-z0-9]+\.)+[a-z]{2,})$/i
+    sample_user = MailEngine::USER_MODEL.find(sample_user_id)
 
     I18n.with_locale(mail_template.locale) do
-      MailEngine::MailDispatcher.send(
-        mail_template.template_name.to_sym,
-        :to => recipient,
-        :values => self.load_payload(sample_user)
-      ).deliver
+      MailEngine::MailDispatcher.send( mail_template.template_name.to_sym, :to => recipient, :values => self.load_payload(sample_user) ).deliver
     end
   end
 
@@ -50,15 +51,16 @@ class MailEngine::MailSchedule < ActiveRecord::Base
     ready_to_send or (not_sent_mail_within_15_minutes and result_by_period)
   end
 
+  # used in Rake task, the main mail sending method.
   def sendmail
-    puts "---> Schedule: '#{self.name}'"
+    puts "---> Schedule: '#{self.name}'" if Rails.env != 'test'
 
     unless ready_to_send?
       puts "---> not ready"
       return false
     end
 
-    User.send(self.user_group.to_sym).each do |user|
+    MailEngine::USER_MODEL.send(self.user_group.to_sym).each do |user|
       puts "-> sending mail to #{user.email}"
       MailEngine::MailDispatcher.send(mail_template.template_name.to_sym, :to => user.email, :values => self.load_payload(user) ).deliver
     end

data/app/models/mail_engine/mail_template.rb

@@ -4,19 +4,20 @@ class MailEngine::MailTemplate < ActiveRecord::Base
   mount_uploader :zip_file, MailEngine::ZipFileUploader
 
   validates :name, :path, :presence => true
+  validates :subject, :presence => true, :if => Proc.new { |template| !template.partial? }
   validates :locale, :inclusion => I18n.available_locales.map(&:to_s)
   validates :format, :inclusion => Mime::SET.symbols.map(&:to_s)
   validates :layout, :presence => true, :if => Proc.new {|template| !template.partial? }
   validates :body, :presence => true, :if => Proc.new {|template| template.create_by_upload.blank? }
   validates :zip_file, :presence => true, :if => Proc.new {|template| template.create_by_upload.present? }
   validates :path, :format => { :with => /([^\/]+\/)+/i, :message => "path should looks like 'controller/action'" }, :if => Proc.new { |template| !template.for_marketing? }
+  validates :path, :format => { :with => /^[a-z\_]+$/i, :message => "path should be consisted of english character and underscore." }, :if => Proc.new { |template| template.for_marketing? }
   # validates :handler, :inclusion => ActionView::Template::Handlers.extensions.map(&:to_s)
   validates_uniqueness_of :path, :scope => [:locale, :handler, :format, :partial]
-
   after_validation :check_placeholders_for_layout
   before_validation :check_zip_file, :if => Proc.new {|template| template.create_by_upload.present? }
 
-  has_many :mail_schedules
+  has_many :mail_schedules, :dependent => :nullify
   has_many :template_partials, :dependent => :destroy
   has_many :partials, :through => :template_partials
   has_many :mail_template_files
@@ -34,25 +35,53 @@ class MailEngine::MailTemplate < ActiveRecord::Base
 
   after_create :process_zip_file
   before_save :delete_partials_if_new_partials_added
-
   after_save do
-    MailEngine::MailTemplate::Resolver.instance.clear_cache # clear cached paths
+    # clear cached paths
+    MailEngine::MailTemplate::Resolver.instance.clear_cache
+
+    # update subject
+    MailEngine::MailTemplate.update_all(["subject=?", self.subject], ["path = ? AND locale = ?", self.path, self.locale])
+  end
+
+  # class methods
+  class << self
+    def get_subject_from_bother_template(path, locale, for_marketing)
+      return nil if path.blank?
+      MailEngine::MailTemplate.where(:path => path, :locale => locale, :for_marketing => for_marketing, :partial => false).select("subject").first.try(:subject)
+    end
   end
 
+  # detect if current partial template is used by other templates.
   def partial_in_use?
     self.partial? and self.mail_templates.count > 0
   end
 
+  # list the templates with same path, but different locale and format
   def variations
-    self.class.where(:path => self.path).order("locale, format")
+    existed_variations = self.class.where(:path => self.path, :partial => false).order("locale, format")
+
+    all_variation_codes = I18n.available_locales.product([:html, :text])
+    existed_variation_codes = existed_variations.map do |template|
+                                [template.locale.to_sym, template.format.to_sym]
+                              end
+    missing_variations = (all_variation_codes - existed_variation_codes).map do |locale, format|
+      MailEngine::MailTemplate.new :locale => locale.to_s, :format => format.to_s
+    end
+
+    missing_variations + existed_variations
+  end
+
+  def actual_path
+    return "mail_engine/mail_dispatcher/#{self.path}" if self.for_marketing?
+    self.path
   end
 
   # has_many :logs, :class_name => "MailEngine::MailLog", :conditions => {:mail_template_path => self.path}
   def logs
-    MailEngine::MailLog.where(:mail_template_path => self.path)
+    MailEngine::MailLog.where(:mail_template_path => self.actual_path).order("id desc").limit(10)
   end
 
-  # TODOS: if no changes just keep the same, it sill will remove the template partial and add a new one
+  # FIXME: if no changes just keep the same, it sill will remove the template partial and add a new one
   def delete_partials_if_new_partials_added
     if self.template_partials.detect {|tmp| !tmp.persisted? }.present? || self.layout == 'none' # has new partials selected
       MailEngine::TemplatePartial.destroy_all(:mail_template_id => self) # remove previous partials
@@ -115,6 +144,7 @@ class MailEngine::MailTemplate < ActiveRecord::Base
     return 'marketing' if self.for_marketing?
   end
 
+  # controller/action_name => for get the action_name
   def template_name
     self.path.scan(/[^\/]+$/).first
   end
@@ -133,23 +163,16 @@ class MailEngine::MailTemplate < ActiveRecord::Base
     "#{filename}.#{self.locale}.#{self.format}.#{self.handler}"
   end
 
-  # return one clone version of self
+  # return one clone version of self with all duplicated relations.
   def duplicate merge_options = {}
-    ### create dictionary for custom cloning file object.
-    # dict = { :mail_template_files => {} }
-    # self.mail_template_files.each{ |f|
-    #   clone_file = f.clone
-    #   clone_file.file = File.open(f.file.path)
-    #   dict[:mail_template_files][f] = clone_file
-    # }
-
     # start to clone
     duplicated_obj = self.clone :except => [:zip_file], :include => [:template_partials, :mail_template_files]
-    duplicated_obj.zip_file = File.open(self.zip_file.path) if self.zip_file.path
-    duplicated_obj.attributes = merge_options if merge_options.is_a? Hash
+    duplicated_obj.zip_file = File.open(self.zip_file.path) if self.zip_file.path # it will make a copy version of zipfile
+    duplicated_obj.attributes = merge_options if merge_options.is_a? Hash # merge custom options
     # without saving can't not create files. so save it first.
     duplicated_obj.save
 
+    ### below code is used to clone mail_template_files and replace the new url for cloned template body.
     # pair the mail_template_files and insert into substitution_array.
     substitution_pair_array = []
     self.mail_template_files.each_with_index do |origin_file, index|
@@ -160,52 +183,55 @@ class MailEngine::MailTemplate < ActiveRecord::Base
     original_body = self.body
 
     substitution_pair_array.each do |origin_file, new_file|
-      original_body = MailEngine::HtmlDocumentAssetsReplacer.replace_resource_url_in_html(
+      original_body = MailEngine::HtmlDocumentAssetsReplacer.replace_resource_in_html(
         original_body,
         origin_file.file.url,
-        new_file.file.url
+        new_file.file.url,
+        :url
       )
     end
 
-    # FIXME save twice here. but if not save the resource won't get correct url.
+    # write back the new body with cloned resource urls.
     duplicated_obj.update_attributes :body => original_body
     duplicated_obj
   end
 
-  def send_test_mail_to!(recipient)
-    # raise "Wrong email format." if recipient.blank? or recipient !~ /^([^@\s]+)@((?:[-a-z0-9]+\.)+[a-z]{2,})$/i
-    raise "Can not find any user." if (sample_user = User.first).blank?
-
-    ### 3 conditions
-    # 1. action - marketing mail only have one action
-    # 2. controler/action
-    # 3. namespace/namespace/controller/action
-    #
-    path_sections = self.path.split("/")
-
-    if self.for_marketing?
-      action_name = path_sections.last
-      mailer_class_name = "MailEngine::MailDispatcher"
-    else
-      mailer_name = path_sections[-2]
-      action_name = path_sections[-1]
-      namespaces = path_sections - Array.wrap(path_sections[-2..-1])
-
-      if namespaces.present?
-        mailer_class_name = namespaces.map(&:classify).join("::")
-        mailer_class_name += "::#{mailer_name.classify}"
-      else
-        mailer_class_name = "#{mailer_name.classify}"
-      end
-    end
-
-    I18n.with_locale(self.locale) do
-      mailer_class_name.constantize.send(
-        action_name.to_sym,
-        :to => recipient
-      ).deliver
-    end
-  end
+  # def send_test_mail_to!(recipient)
+  #   # raise "Wrong email format." if recipient.blank? or recipient !~ /^([^@\s]+)@((?:[-a-z0-9]+\.)+[a-z]{2,})$/i
+  #   raise "Can not find any user." if (sample_user = MailEngine::USER_MODEL.first).blank?
+  #
+  #   ### 3 conditions
+  #   # 1. action - marketing mail only have one action
+  #   # 2. controler/action
+  #   # 3. namespace/namespace/controller/action
+  #   #
+  #   path_sections = self.path.split("/")
+  #
+  #   # marketing mail
+  #   if self.for_marketing?
+  #     action_name = path_sections.last
+  #     mailer_class_name = "MailEngine::MailDispatcher"
+  #   else
+  #     mailer_name = path_sections[-2]
+  #     action_name = path_sections[-1]
+  #     namespaces = path_sections - Array.wrap(path_sections[-2..-1])
+  #
+  #     if namespaces.present?
+  #       mailer_class_name = namespaces.map(&:classify).join("::")
+  #       mailer_class_name += "::#{mailer_name.classify}"
+  #     else
+  #       mailer_class_name = "#{mailer_name.classify}"
+  #     end
+  #   end
+  #
+  #   # send mail.
+  #   I18n.with_locale(self.locale) do
+  #     mailer_class_name.constantize.send(
+  #       action_name.to_sym,
+  #       :to => recipient
+  #     ).deliver
+  #   end
+  # end
 
 
   ###############################