mail_engine 0.0.1

data/app/controllers/mail_engine/mail_schedules_controller.rb

@@ -0,0 +1,56 @@
+class MailEngine::MailSchedulesController < MailEngine::ApplicationController
+  before_filter :find_model
+
+  def index
+    @mail_schedules = MailSchedule.paginate :page => params[:page], :per_page => 20
+  end
+
+  def show
+  end
+
+  def destroy
+    @mail_schedule.destroy
+    redirect_to mail_schedules_path
+  end
+
+  def create
+    @mail_schedule = MailSchedule.new(params[:mail_engine_mail_schedule].merge(:payload => params[:mail_engine_mail_schedule][:payload].try(:join, ',')))
+
+    if @mail_schedule.save
+      redirect_to mail_schedule_path(@mail_schedule), :notice => 'Mail schedule was successfully created.'
+    else
+      render "new"
+    end
+  end
+
+  def new
+    if MailTemplate.for_marketing.count == 0
+      flash[:notice] = "Add Marketing mail template first."
+      redirect_to :action => :index
+    end
+    @mail_schedule = MailSchedule.new
+  end
+
+  def update
+    if @mail_schedule.update_attributes(params[:mail_engine_mail_schedule].merge(:payload => params[:mail_engine_mail_schedule][:payload].join(',')))
+      redirect_to mail_schedule_path(@mail_schedule), :notice => 'Mail schedule was successfully updated.'
+    else
+      render "new"
+    end
+  end
+
+  def edit
+  end
+
+  def send_test_mail
+    @mail_schedule.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
+    @mail_schedule = MailSchedule.find(params[:id]) if params[:id]
+  end
+end

data/app/controllers/mail_engine/mail_template_files_controller.rb

@@ -0,0 +1,46 @@
+class MailEngine::MailTemplateFilesController < MailEngine::ApplicationController
+  layout :false
+  before_filter :find_model
+
+  def index
+  end
+
+  def new
+    @mail_template_file = @mail_template.mail_template_files.new
+  end
+
+  def create
+    @mail_template_file = @mail_template.mail_template_files.new(params[:mail_engine_mail_template_file])
+    if @mail_template_file.save
+      redirect_to edit_mail_template_path(@mail_template)
+    else
+      render :new
+    end
+  end
+
+  def edit
+  end
+
+  def update
+    if @mail_template_file.update_attributes(params[:mail_engine_mail_template_file])
+      redirect_to edit_mail_template_path(@mail_template)
+    else
+      render :edit
+    end
+  end
+
+  def destroy
+    @mail_template_file.destroy
+    render :text => "window.location.reload()"
+  end
+
+  def show
+  end
+
+  private
+
+  def find_model
+    @mail_template = MailTemplate.find(params[:mail_template_id]) if params[:mail_template_id].present?
+    @mail_template_file = MailTemplateFile.find(params[:id]) if params[:id].present?
+  end
+end

data/app/controllers/mail_engine/mail_templates_controller.rb

@@ -0,0 +1,141 @@
+class MailEngine::MailTemplatesController < MailEngine::ApplicationController
+  before_filter :find_model
+
+  def index
+    @mail_templates = case params[:type]
+                      when "marketing"
+                        MailEngine::MailTemplate.for_marketing
+                      when "system"
+                        MailEngine::MailTemplate.for_system
+                      when "partial"
+                        MailEngine::MailTemplate.partial
+                      else
+                        redirect_to mail_templates_path(:type => "system")
+                        return
+                      end
+
+    @mail_templates = @mail_templates.group("path").paginate :page => params[:page], :per_page => 20
+  end
+
+  def show
+  end
+
+  def preview
+    @mail_template = MailEngine::MailTemplate.new if @mail_template.blank?
+    @mail_template.body = params[:new_body] if params[:new_body]
+    render :layout => false
+  end
+
+  def body
+    I18n.with_locale(@mail_template.locale) {
+      if @mail_template.partial?
+        render :partial => @mail_template.path,
+               :layout => false,
+               :content_type => Mime[@mail_template.format].to_s
+      else
+        # set @footer or @header
+        related_partial_paths = {}
+        @mail_template.template_partials.each { |tmp| related_partial_paths["#{tmp.placeholder_name}_path".to_sym] = tmp.partial.path }
+        render :template => @mail_template.path,
+               :layout => "layouts/mail_engine/mail_template_layouts/#{@mail_template.layout}",
+               :locals => related_partial_paths
+      end
+    }
+  end
+
+  def duplicate
+    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])
+        return
+      end
+    else
+      @duplicated_mail_template = @mail_template
+    end
+
+    render :layout => false
+  end
+
+  def destroy
+    if @mail_template.partial_in_use?
+      flash[:notice] = "Partial##{@mail_template.id} is in use, so can't be destroyed."
+    else
+      @mail_template.destroy
+    end
+    redirect_to mail_templates_path(:type => params[:type])
+  end
+
+  def create
+    @mail_template = MailTemplate.new(params[:mail_engine_mail_template])
+    if @mail_template.save
+      redirect_to mail_template_path(@mail_template), :notice => 'Mail template was successfully created.'
+    else
+      render "new"
+    end
+  end
+
+  def new
+    @mail_template = MailTemplate.new :layout => 'none'
+  end
+
+  def new_by_upload
+    @mail_template = MailTemplate.new :layout => 'none', :format => 'html'
+  end
+
+  def create_by_upload
+    @mail_template = MailTemplate.new(params[:mail_engine_mail_template])
+    if @mail_template.save
+      redirect_to mail_template_path(@mail_template), :notice => 'Mail template was successfully created.'
+    else
+      render "new_by_upload"
+    end
+  end
+
+  def partial_options
+    @tmp_mail_template = MailTemplate.new
+
+    if @mail_template and @mail_template.persisted?
+      @tmp_mail_template.layout = @mail_template.try(:layout)
+      @tmp_mail_template.template_partials = @mail_template.try(:template_partials)
+    end
+
+    if params[:layout] != @tmp_mail_template.layout || @tmp_mail_template.template_partials.blank?
+      @tmp_mail_template.template_partials.delete_if {|tmp| tmp.persisted?}
+      case params[:layout]
+      when 'none'
+      when 'only_footer'
+        @tmp_mail_template.template_partials.build :placeholder_name => 'footer'
+      when 'header_and_footer'
+        @tmp_mail_template.template_partials.build :placeholder_name => 'header'
+        @tmp_mail_template.template_partials.build :placeholder_name => 'footer'
+      else
+      end
+    end
+
+    render :layout => false
+  end
+
+  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.'
+    else
+      render "edit"
+    end
+  end
+
+  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
+
+  private
+  def find_model
+    @mail_template = MailTemplate.find(params[:id]) if params[:id].present?
+  end
+end

data/app/controllers/mail_engine/reports_controller.rb

@@ -0,0 +1,34 @@
+class MailEngine::ReportsController < MailEngine::ApplicationController
+  def index
+    @pie_chart_columns = ["bounces", "unique_opens", "spamreports", "blocks", "unopened"]
+    @stat_columns = [
+      "requests",
+      "delivered",
+      "blocks",
+      "invalid_email",
+      "clicks",
+      "unique_clicks",
+      "opens",
+      "unique_opens",
+      "bounces",
+      "repeat_bounces",
+      "spamreports",
+      "repeat_spamreports",
+      "unsubscribes",
+      "repeat_unsubscribes"
+    ]
+
+    @stats_data = MailEngine::Sendgrid::RestApi.stats(:days => 6)
+    @data_of_today = @stats_data.last
+  end
+
+  def chart
+    if ['bounces', 'blocks', 'spamreports', 'invalidemails'].include?(params[:type])
+      @result = Array.wrap(MailEngine::Sendgrid::RestApi.send(params[:type], :date => 1)) || []
+      render "mail_engine/reports/charts/#{params[:type]}"
+    else
+      flash[:notice] = "Error chart type."
+      redirect_to :back
+    end
+  end
+end

data/app/helpers/mail_engine/mail_engine_helper.rb

@@ -0,0 +1,30 @@
+module MailEngine
+  module MailEngineHelper
+
+    def show_no_record collection, &block
+      if collection.blank?
+        return raw("<div class='notice' style='margin-top:10px'>No Record</div>")
+      else
+        block.call
+        return ""
+      end
+    end
+
+    def show_percentage reality, total
+      return "-" if total <= 0
+      percentage = (reality / total) * 100
+      return "#{percentage.round(2)}%"
+    end
+
+    def mail_template_list_title type
+      case type
+      when "partial"
+        "Mail Template Partial"
+      when "system", "marketing"
+        "#{type.try(:capitalize)} Mail Template"
+      else
+        "Mail Template"
+      end
+    end
+  end
+end

data/app/mailers/mail_engine/mail_dispatcher.rb

@@ -0,0 +1,59 @@
+class MailEngine::MailDispatcher < ActionMailer::Base
+  default :from => "info@itjob.fm"
+  sendgrid_header do
+    category "itjob_test"
+
+    filters {
+      opentrack "enable" => 1
+      clicktrack "enable" => 1
+      subscriptiontrack "enable" => 0
+      template "enable" => 0
+      footer "enable" => 0
+    }
+  end
+
+  protected
+
+  def self.method_missing(method, *args)
+    return super if respond_to?(method) # basically it won't unless subclass
+
+    # TODO if template file exists, don't need to exam the db.
+    templates = MailEngine::MailTemplate.where(:path => method).order('format desc').all
+    raise "No Template added." if templates.blank?
+
+    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
+    #
+    class_eval <<-METHOD
+      def #{method} options
+        ### extract mail options, used for mail method.
+        mail_options = {}
+        options.delete_if {|key, value|
+          if [:subject, :to, :from, :cc, :bcc, :reply_to, :date].include?(key.to_sym)
+            mail_options[key] = value
+            true
+          else
+            false
+          end
+        }
+
+        ### store :values to instance value
+        (options[:values]||[]).each do |key, value|
+          instance_variable_set "@" + key.to_s, value
+        end
+
+        mail mail_options do |format|
+          #{formats.join(';')}
+        end
+      end
+    METHOD
+
+    new(method, *args).message
+  end
+end

data/app/models/mail_engine/mail_log.rb

@@ -0,0 +1,36 @@
+class MailEngine::MailLog < ActiveRecord::Base
+  validates_presence_of :mail_template_path
+
+  # Callback of Mail gem when delivering mails
+  def self.delivering_email mail
+    # pp email.body.raw_source
+    # pp email.to
+    # pp email.from
+    # pp email.subject
+    # pp email.mime_type
+
+    ##################
+    # pp mail.mime_type
+    # pp mail.content_type
+    # pp mail.from            #=> ['mikel@test.lindsaar.net', 'ada@test.lindsaar.net']
+    # pp mail.to              #=> 'bob@test.lindsaar.net'
+    # pp mail.subject         #=> "This is the subject"
+    # pp mail.body.decoded    #=> 'This is the body of the email...
+    ###################
+
+    # pp mail.parts.map { |p| p.content_type }  #=> ['text/plain', 'application/pdf']
+    # pp mail.parts.map { |p| p.class }         #=> [Mail::Message, Mail::Message]
+    # pp mail.parts[0].content_type_parameters  #=> {'charset' => 'ISO-8859-1'}
+    # pp mail.parts[1].content_type_parameters  #=> {'name' => 'my.pdf'}
+
+    # mail_type = email.header["X-mail-type"].value
+    # record = create! :recipient => email.to.join(","), :mail_type => mail_type
+    # email.encoded # kick email to set content_transfer_encoding
+    # # The new body needs to be already encoded, as Mail expects the body to be encoded already (after calling #encoded)
+    # encoding = Mail::Encodings.get_encoding email.content_transfer_encoding
+    # new_body = encoding.encode email.body.to_s.sub("/t/id.gif", "/t/#{record.open_token}.gif")
+    # email.body(new_body)
+    #
+    # record.update_attributes! :body => email.body.to_s, :raw_text => email.encoded
+  end
+end

data/app/models/mail_engine/mail_schedule.rb

@@ -0,0 +1,70 @@
+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")
+
+  def load_payload user
+    payload_hash = {}
+    self.payload.split(",").each do |col|
+      payload_hash[col] = user.send(col)
+    end
+    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?
+
+    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
+    end
+  end
+
+  # If execute sendmail twice very soon(within 14 minutes), it should not be able to send mail again.
+  def ready_to_send?
+    # check if send count reached the total count.
+    return false if (sent_count >= count and count != 0)
+    # only send once.
+    return sent_count < 1 if period == 'once'
+
+    # why 15 minutes? for tolerance.
+    not_sent_mail_within_15_minutes = last_sent_at.nil? || ((Time.now.to_i - last_sent_at.to_i).abs >= 60*15)
+    ready_to_send = not_sent_mail_within_15_minutes and (Time.now.to_i - first_send_at.to_i).abs < 60*15
+    result_by_period = case period
+                       when 'daily'
+                         1.days.ago.to_i <= last_sent_at.to_i
+                       when 'weekly'
+                         1.week.ago.to_i <= last_sent_at.to_i
+                       when 'monthly'
+                         1.month.ago.to_i <= last_sent_at.to_i
+                       else
+                         false
+                       end
+
+    ready_to_send or (not_sent_mail_within_15_minutes and result_by_period)
+  end
+
+  def sendmail
+    puts "---> Schedule: '#{self.name}'"
+
+    unless ready_to_send?
+      puts "---> not ready"
+      return false
+    end
+
+    User.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
+
+    self.last_sent_at = Time.now
+    self.sent_count += 1
+    self.save
+  end
+end